@firebase/messaging

Fungsi

Fungsi Keterangan
fungsi(aplikasi, ...)
dapatkan Pesan (aplikasi) Mengambil instance Firebase Cloud Messaging.
fungsi (pesan, ...)
deleteToken (pesan) Menghapus token pendaftaran yang terkait dengan instans Perpesanan ini dan berhenti berlangganan instans Perpesanan dari langganan push.
getToken (pesan, opsi) Berlangganan instance Messaging ke notifikasi push. Mengembalikan token pendaftaran Firebase Cloud Messaging yang dapat digunakan untuk mengirim pesan push ke instance Messaging tersebut. Jika izin notifikasi belum diberikan, metode ini akan meminta izin pengguna. Janji yang dikembalikan ditolak jika pengguna tidak mengizinkan aplikasi menampilkan notifikasi.
onMessage(pesan, nextOrObserver) Ketika pesan push diterima dan pengguna saat ini berada di halaman asal Anda, pesan tersebut diteruskan ke halaman tersebut dan peristiwa onMessage() dikirimkan bersama payload pesan push.
fungsi()
didukung() Memeriksa apakah semua API yang diperlukan ada di browser.

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 getMessagingInWindow(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, ...)

deleteToken (pesan)

Menghapus token pendaftaran yang terkait dengan instans Perpesanan ini dan berhenti berlangganan instans Perpesanan dari langganan push.

Tanda tangan:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Parameter

Parameter Jenis Keterangan
pesan Pesan Contoh Pesan .

Pengembalian:

Janji<boolean>

Janji tersebut terselesaikan ketika token telah berhasil dihapus.

getToken (pesan, opsi)

Berlangganan instance Messaging ke notifikasi push. Mengembalikan token pendaftaran Firebase Cloud Messaging yang dapat digunakan untuk mengirim pesan push ke instance Messaging tersebut.

Jika izin notifikasi belum diberikan, metode ini akan meminta izin pengguna. Janji yang dikembalikan ditolak jika pengguna tidak mengizinkan aplikasi menampilkan notifikasi.

Tanda tangan:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Parameter

Parameter Jenis Keterangan
pesan Pesan Contoh Pesan .
pilihan DapatkanTokenOptions Memberikan kunci kosong opsional dan pendaftaran pekerja layanan opsional.

Pengembalian:

Janji<string>

Janji tersebut diselesaikan dengan token pendaftaran FCM.

onMessage(pesan, nextOrObserver)

Ketika pesan push diterima dan pengguna saat ini berada di halaman asal Anda, pesan tersebut diteruskan ke halaman tersebut dan peristiwa onMessage() dikirimkan bersama payload pesan push.

Tanda tangan:

export declare function onMessage(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 pengguna sedang melihat halaman Anda.

Pengembalian:

Berhenti berlangganan

Untuk berhenti mendengarkan pesan, jalankan fungsi yang dikembalikan ini.

fungsi()

didukung()

Memeriksa apakah semua API yang diperlukan ada di browser.

Tanda tangan:

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

Pengembalian:

Janji<boolean>

sebuah Janji yang menghasilkan boolean.