ฟังก์ชั่น
| การทำงาน | คำอธิบาย |
|---|---|
| ฟังก์ชั่น(แอพ, ...) | |
| รับข้อความ (แอป) | ดึงข้อมูลอินสแตนซ์ Firebase Cloud Messaging |
| ฟังก์ชั่น(ข้อความ, ...) | |
| ลบโทเค็น(การส่งข้อความ) | ลบโทเค็นการลงทะเบียนที่เกี่ยวข้องกับอิน สแตนซ์การส่งข้อความ นี้ และยกเลิกการสมัคร อินสแตนซ์การส่งข้อความ จากการสมัครสมาชิกแบบพุช |
| getToken(การส่งข้อความ ตัวเลือก) | สมัครสมาชิกอินสแตนซ์ การส่งข้อความ เพื่อแจ้งเตือนแบบพุช ส่งคืนโทเค็นการลงทะเบียน Firebase Cloud Messaging ที่สามารถใช้เพื่อส่งข้อความพุชไปยังอินสแตนซ์ Messaging นั้น หากไม่ได้รับอนุญาตการแจ้งเตือน วิธีการนี้จะขออนุญาตจากผู้ใช้ สัญญาที่ส่งคืนจะปฏิเสธหากผู้ใช้ไม่อนุญาตให้แอปแสดงการแจ้งเตือน |
| onMessage (การส่งข้อความ, nextOrObserver) | เมื่อได้รับข้อความพุชและผู้ใช้อยู่ในเพจสำหรับต้นทางของคุณ ข้อความจะถูกส่งไปยังเพจนั้นและเหตุการณ์ onMessage() จะถูกส่งไปพร้อมกับเพย์โหลดของข้อความพุช |
| การทำงาน() | |
| รองรับ() | ตรวจสอบว่ามี API ที่จำเป็นทั้งหมดอยู่ในเบราว์เซอร์หรือไม่ |
อินเทอร์เฟซ
| อินเตอร์เฟซ | คำอธิบาย |
|---|---|
| Fcmตัวเลือก | ตัวเลือกสำหรับคุณสมบัติที่มีให้โดย FCM SDK สำหรับเว็บ ดู WebpushFcmOptions . |
| GetTokenOptions | ตัวเลือกสำหรับ getToken() . |
| ข้อความเพย์โหลด | เพย์โหลดข้อความที่มีเพย์โหลดการแจ้งเตือนที่แสดงด้วย NotificationPayload และเพย์โหลดข้อมูลที่มีคู่คีย์-ค่าตามจำนวนที่กำหนดซึ่งนักพัฒนาส่งผ่าน Send API . |
| การส่งข้อความ | อินเทอร์เฟซสาธารณะของ Firebase Cloud Messaging SDK |
| การแจ้งเตือนเพย์โหลด | แสดงรายละเอียดการแจ้งเตือน รายละเอียดจะถูกส่งผ่าน Send API . |
ฟังก์ชั่น(แอพ, ...)
รับข้อความ (แอป)
ดึงข้อมูลอินสแตนซ์ Firebase Cloud Messaging
ลายเซ็น:
export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| แอป | แอป Firebase |
ผลตอบแทน:
อินสแตนซ์ Firebase Cloud Messaging ที่เชื่อมโยงกับแอป Firebase ที่ให้มา
ฟังก์ชั่น(ข้อความ, ...)
ลบโทเค็น(การส่งข้อความ)
ลบโทเค็นการลงทะเบียนที่เกี่ยวข้องกับอิน สแตนซ์การส่งข้อความ นี้ และยกเลิกการสมัคร อินสแตนซ์การส่งข้อความ จากการสมัครสมาชิกแบบพุช
ลายเซ็น:
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| การส่งข้อความ | การส่งข้อความ | อินสแตนซ์ การส่งข้อความ |
ผลตอบแทน:
สัญญา<บูลีน>
สัญญาจะได้รับการแก้ไขเมื่อโทเค็นถูกลบสำเร็จ
getToken(การส่งข้อความ ตัวเลือก)
สมัครสมาชิกอินสแตนซ์ การส่งข้อความ เพื่อแจ้งเตือนแบบพุช ส่งคืนโทเค็นการลงทะเบียน Firebase Cloud Messaging ที่สามารถใช้เพื่อส่งข้อความพุชไปยังอินสแตนซ์ Messaging นั้น
หากไม่ได้รับอนุญาตการแจ้งเตือน วิธีการนี้จะขออนุญาตจากผู้ใช้ สัญญาที่ส่งคืนจะปฏิเสธหากผู้ใช้ไม่อนุญาตให้แอปแสดงการแจ้งเตือน
ลายเซ็น:
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| การส่งข้อความ | การส่งข้อความ | อินสแตนซ์ การส่งข้อความ |
| ตัวเลือก | GetTokenOptions | จัดเตรียมคีย์ Vapid เสริมและการลงทะเบียนพนักงานบริการเสริม |
ผลตอบแทน:
สัญญา<สตริง>
คำสัญญาจะได้รับการแก้ไขด้วยโทเค็นการลงทะเบียน FCM
onMessage (การส่งข้อความ, nextOrObserver)
เมื่อได้รับข้อความพุชและผู้ใช้อยู่ในเพจสำหรับต้นทางของคุณ ข้อความจะถูกส่งไปยังเพจนั้นและเหตุการณ์ onMessage() จะถูกส่งไปพร้อมกับเพย์โหลดของข้อความพุช
ลายเซ็น:
export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| การส่งข้อความ | การส่งข้อความ | อินสแตนซ์ การส่งข้อความ |
| ถัดไปหรือผู้สังเกตการณ์ | ถัดไปFn < ข้อความเพย์โหลด > | ผู้สังเกตการณ์ < ข้อความเพย์โหลด > | ฟังก์ชันนี้หรือวัตถุผู้สังเกตการณ์ที่มีการกำหนดไว้ next จะถูกเรียกเมื่อได้รับข้อความและผู้ใช้กำลังดูเพจของคุณอยู่ |
ผลตอบแทน:
หากต้องการหยุดฟังข้อความให้รันฟังก์ชันที่ส่งคืนนี้
การทำงาน()
รองรับ()
ตรวจสอบว่ามี API ที่จำเป็นทั้งหมดอยู่ในเบราว์เซอร์หรือไม่
ลายเซ็น:
export declare function isWindowSupported(): Promise<boolean>;
ผลตอบแทน:
สัญญา<บูลีน>
สัญญาที่แก้ไขเป็นบูลีน