ฟังก์ชัน
| ฟังก์ชัน | คำอธิบาย |
|---|---|
| ฟังก์ชัน(แอป, ...) | |
| getMessaging(แอป) | เรียกข้อมูลอินสแตนซ์ Firebase Cloud Messaging |
| ฟังก์ชัน(การรับส่งข้อความ, ...) | |
| experimentalSet DeliveryMetricsExportedToBigQueryEnabled(การรับส่งข้อความ เปิดใช้) | เปิดหรือปิดใช้การส่งออกเมตริกการส่งข้อความ Firebase Cloud Messaging ไปยัง BigQuery โดยค่าเริ่มต้น เมตริกการส่งข้อความจะไม่ส่งออกไปยัง BigQuery ใช้วิธีนี้เพื่อเปิดใช้หรือปิดใช้การส่งออกระหว่างรันไทม์ |
| onBackgroundMessage(การส่งข้อความ, nextOrObserver) | โทรเมื่อได้รับข้อความขณะที่แอปอยู่ในเบื้องหลัง ระบบจะถือว่าแอปทำงานอยู่เบื้องหลังหากไม่มีการแสดงหน้าต่างที่ใช้งานอยู่ |
| function() | |
| isSupported() | ตรวจสอบว่ามี API ที่จำเป็นทั้งหมดอยู่ในบริบท SW หรือไม่ |
อินเทอร์เฟซ
| อินเทอร์เฟซ | คำอธิบาย |
|---|---|
| ตัวเลือก Fcm | ตัวเลือกสำหรับฟีเจอร์ที่ FCM SDK สำหรับเว็บ โปรดดู WebpushFcmOptions |
| GetTokenOptions | ตัวเลือกสำหรับ getToken() |
| MessagePayload | เพย์โหลดข้อความที่มีเพย์โหลดการแจ้งเตือนที่แสดงด้วย NotificationPayload และเพย์โหลดข้อมูลที่มีจำนวนคู่คีย์-ค่าที่กำหนดเองซึ่งนักพัฒนาซอฟต์แวร์ส่งผ่าน Send API |
| การรับส่งข้อความ | อินเทอร์เฟซสาธารณะของ Firebase Cloud Messaging SDK |
| NotificationPayload | แสดงรายละเอียดการแจ้งเตือน ระบบจะส่งรายละเอียดผ่าน Send API |
ฟังก์ชัน(แอป, ...)
รับการรับส่งข้อความ(แอป)
เรียกข้อมูลอินสแตนซ์ Firebase Cloud Messaging
ลายเซ็น:
export declare function getMessagingInSw(app?: FirebaseApp): Messaging;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| แอป | แอป Firebase |
การคืนสินค้า:
อินสแตนซ์ Firebase Cloud Messaging ที่เชื่อมโยงกับแอป Firebase ที่ระบุ
ฟังก์ชัน(การรับส่งข้อความ, ...)
ExperimentSet DeliveryMetricsExportedToBigQueryEnabled(การรับส่งข้อความ เปิดใช้งาน)
เปิดหรือปิดใช้การส่งออกเมตริกการส่งข้อความ Firebase Cloud Messaging ไปยัง BigQuery โดยค่าเริ่มต้น เมตริกการส่งข้อความจะไม่ส่งออกไปยัง BigQuery ใช้วิธีนี้เพื่อเปิดใช้หรือปิดใช้การส่งออกระหว่างรันไทม์
ลายเซ็น:
export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| การรับส่งข้อความ | การรับส่งข้อความ | อินสแตนซ์ FirebaseMessaging |
| เปิดใช้ | boolean | ต้องการให้ Firebase Cloud Messaging ควรส่งออกเมตริกการส่งข้อความไปยัง BigQuery ไหม |
การคืนสินค้า:
เป็นโมฆะ
onBackgroundMessage(การส่งข้อความ, nextOrObserver)
โทรเมื่อได้รับข้อความขณะที่แอปอยู่ในเบื้องหลัง ระบบจะถือว่าแอปทำงานอยู่เบื้องหลังหากไม่มีการแสดงหน้าต่างที่ใช้งานอยู่
ลายเซ็น:
export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| การรับส่งข้อความ | การรับส่งข้อความ | อินสแตนซ์การรับส่งข้อความ |
| NextOrObserver | NextFn<MessagePayload> | Observer<MessagePayload> | ฟังก์ชันนี้หรือออบเจ็กต์สังเกตการณ์ที่กำหนด next ไว้จะถูกเรียกเมื่อได้รับข้อความและแอปทำงานอยู่ในเบื้องหลัง |
การคืนสินค้า:
หากต้องการหยุดฟังข้อความให้เรียกใช้ฟังก์ชันที่แสดงผลนี้
ฟังก์ชัน()
issupported()
ตรวจสอบว่ามี API ที่จำเป็นทั้งหมดอยู่ในบริบท SW หรือไม่
ลายเซ็น:
export declare function isSwSupported(): Promise<boolean>;
การคืนสินค้า:
Promise<boolean>
คำสัญญาที่ระบุค่าเป็นบูลีน