@firebase/messaging/sw

ฟังก์ชั่น

การทำงาน คำอธิบาย
ฟังก์ชั่น(แอพ, ...)
รับข้อความ (แอป) ดึงข้อมูลอินสแตนซ์ Firebase Cloud Messaging
ฟังก์ชั่น(ข้อความ, ...)
การทดลองSetDeliveryMetricsExportedToBigQueryEnabled (การส่งข้อความ เปิดใช้งาน) เปิดหรือปิดใช้การส่งออกเมตริกการส่งข้อความ Firebase Cloud Messaging ไปยัง BigQuery โดยค่าเริ่มต้น เมตริกการส่งข้อความจะไม่ส่งออกไปยัง BigQuery ใช้วิธีนี้เพื่อเปิดหรือปิดการส่งออกขณะรันไทม์
onBackgroundMessage (การส่งข้อความ, nextOrObserver) เรียกว่าเมื่อได้รับข้อความในขณะที่แอปอยู่ในพื้นหลัง แอปจะถือว่าอยู่ในพื้นหลังหากไม่มีหน้าต่างที่ใช้งานอยู่แสดงอยู่
การทำงาน()
รองรับ() ตรวจสอบว่า API ที่จำเป็นทั้งหมดมีอยู่ใน SW Context หรือไม่

อินเทอร์เฟซ

อินเตอร์เฟซ คำอธิบาย
Fcmตัวเลือก ตัวเลือกสำหรับคุณสมบัติที่มีให้โดย FCM SDK สำหรับเว็บ ดู WebpushFcmOptions .
GetTokenOptions ตัวเลือกสำหรับ getToken() .
ข้อความเพย์โหลด เพย์โหลดข้อความที่มีเพย์โหลดการแจ้งเตือนที่แสดงด้วย NotificationPayload และเพย์โหลดข้อมูลที่มีคู่คีย์-ค่าตามจำนวนที่กำหนดซึ่งนักพัฒนาส่งผ่าน Send API .
การส่งข้อความ อินเทอร์เฟซสาธารณะของ Firebase Cloud Messaging SDK
การแจ้งเตือนเพย์โหลด แสดงรายละเอียดการแจ้งเตือน รายละเอียดจะถูกส่งผ่าน Send API .

ฟังก์ชั่น(แอพ, ...)

รับข้อความ (แอป)

ดึงข้อมูลอินสแตนซ์ Firebase Cloud Messaging

ลายเซ็น:

export declare function getMessagingInSw(app?: FirebaseApp): Messaging;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
แอป แอป Firebase

ผลตอบแทน:

การส่งข้อความ

อินสแตนซ์ Firebase Cloud Messaging ที่เชื่อมโยงกับแอป Firebase ที่ให้มา

ฟังก์ชั่น(ข้อความ, ...)

การทดลองSetDeliveryMetricsExportedToBigQueryEnabled (การส่งข้อความ เปิดใช้งาน)

เปิดหรือปิดใช้การส่งออกเมตริกการส่งข้อความ Firebase Cloud Messaging ไปยัง BigQuery โดยค่าเริ่มต้น เมตริกการส่งข้อความจะไม่ส่งออกไปยัง BigQuery ใช้วิธีนี้เพื่อเปิดหรือปิดการส่งออกขณะรันไทม์

ลายเซ็น:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
การส่งข้อความ การส่งข้อความ อินสแตนซ์ FirebaseMessaging
เปิดใช้งาน บูลีน Firebase Cloud Messaging ควรส่งออกเมตริกการส่งข้อความไปยัง BigQuery หรือไม่

ผลตอบแทน:

เป็นโมฆะ

onBackgroundMessage (การส่งข้อความ, nextOrObserver)

เรียกว่าเมื่อได้รับข้อความในขณะที่แอปอยู่ในพื้นหลัง แอปจะถือว่าอยู่ในพื้นหลังหากไม่มีหน้าต่างที่ใช้งานอยู่แสดงอยู่

ลายเซ็น:

export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
การส่งข้อความ การส่งข้อความ อินสแตนซ์ การส่งข้อความ
ถัดไปหรือผู้สังเกตการณ์ ถัดไปFn < ข้อความเพย์โหลด > | ผู้สังเกตการณ์ < ข้อความเพย์โหลด > ฟังก์ชันนี้หรือวัตถุผู้สังเกตการณ์ที่กำหนดไว้ next จะถูกเรียกเมื่อได้รับข้อความและแอปอยู่ในเบื้องหลัง

ผลตอบแทน:

ยกเลิกการสมัคร

หากต้องการหยุดฟังข้อความให้รันฟังก์ชันที่ส่งคืนนี้

การทำงาน()

รองรับ()

ตรวจสอบว่า API ที่จำเป็นทั้งหมดมีอยู่ใน SW Context หรือไม่

ลายเซ็น:

export declare function isSwSupported(): Promise<boolean>;

ผลตอบแทน:

สัญญา<บูลีน>

สัญญาที่แก้ไขเป็นบูลีน