@firebase/messaging/sw

Fungsi

Fungsi Keterangan
fungsi(aplikasi, ...)
dapatkan Pesan (aplikasi) Mengambil instance Firebase Cloud Messaging.
fungsi (pesan, ...)
eksperimentalSetDeliveryMetricsExportedToBigQueryEnabled(pesan, aktifkan) Mengaktifkan atau menonaktifkan ekspor metrik pengiriman pesan Firebase Cloud Messaging ke BigQuery. Secara default, metrik pengiriman pesan tidak diekspor ke BigQuery. Gunakan metode ini untuk mengaktifkan atau menonaktifkan ekspor saat runtime.
onBackgroundMessage(perpesanan, nextOrObserver) Dipanggil ketika pesan diterima saat aplikasi berada di latar belakang. Suatu aplikasi dianggap berada di latar belakang jika tidak ada jendela aktif yang ditampilkan.
fungsi()
didukung() Memeriksa apakah semua API yang diperlukan ada dalam Konteks SW

Antarmuka

Antarmuka Keterangan
Opsi Fcm Opsi untuk fitur yang disediakan oleh FCM SDK untuk Web. Lihat Opsi WebpushFcm .
DapatkanTokenOptions Opsi untuk getToken() .
PesanPayload Payload pesan yang berisi payload notifikasi yang diwakili dengan NotificationPayload dan payload data yang berisi sejumlah pasangan nilai kunci yang dikirim oleh pengembang melalui Send API .
Pesan Antarmuka publik Firebase Cloud Messaging SDK.
NotifikasiPayload Tampilkan detail notifikasi. Detail dikirim melalui Send API .

fungsi(aplikasi, ...)

dapatkan Pesan (aplikasi)

Mengambil instance Firebase Cloud Messaging.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
aplikasi Aplikasi Firebase

Pengembalian:

Pesan

Instance Firebase Cloud Messaging yang terkait dengan aplikasi firebase yang disediakan.

fungsi (pesan, ...)

eksperimentalSetDeliveryMetricsExportedToBigQueryEnabled(pesan, aktifkan)

Mengaktifkan atau menonaktifkan ekspor metrik pengiriman pesan Firebase Cloud Messaging ke BigQuery. Secara default, metrik pengiriman pesan tidak diekspor ke BigQuery. Gunakan metode ini untuk mengaktifkan atau menonaktifkan ekspor saat runtime.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
pesan Pesan Contoh FirebaseMessaging .
memungkinkan boolean Apakah Firebase Cloud Messaging harus mengekspor metrik pengiriman pesan ke BigQuery.

Pengembalian:

ruang kosong

onBackgroundMessage(perpesanan, nextOrObserver)

Dipanggil ketika pesan diterima saat aplikasi berada di latar belakang. Suatu aplikasi dianggap berada di latar belakang jika tidak ada jendela aktif yang ditampilkan.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
pesan Pesan Contoh Pesan .
berikutnyaAtauObserver BerikutnyaFn < PesanPayload > | Pengamat < PesanPayload > Fungsi ini, atau objek pengamat yang next ditentukan, dipanggil ketika pesan diterima dan aplikasi sedang berjalan di latar belakang.

Pengembalian:

Berhenti berlangganan

Untuk berhenti mendengarkan pesan, jalankan fungsi yang dikembalikan ini

fungsi()

didukung()

Memeriksa apakah semua API yang diperlukan ada dalam Konteks SW

Tanda tangan:

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

Pengembalian:

Janji<boolean>

sebuah Janji yang menghasilkan boolean.