@firebase/messaging

Functions

Fungsi	Deskripsi
fungsi(aplikasi, ...)
getMessaging(aplikasi)	Mengambil instance Firebase Cloud Messaging.
fungsi(pesan, ...)
deleteToken(pesan)	Menghapus token pendaftaran yang terkait dengan instance Messaging ini dan menghentikan langganan instance Messaging dari langganan push.
getToken(pesan, opsi)	Berlangganan instance Messaging untuk mendapatkan notifikasi push. Menampilkan 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 kepada pengguna. Promise yang ditampilkan akan menolak jika pengguna tidak mengizinkan aplikasi untuk menampilkan notifikasi.
onMessage(pesan, nextOrObserver)	Saat pesan push diterima dan pengguna saat ini berada di halaman untuk origin Anda, pesan tersebut akan diteruskan ke halaman dan peristiwa onMessage() dikirim dengan payload pesan push.
function()
isDidukung()	Memeriksa apakah semua API yang diperlukan ada di browser.

Antarmuka

Antarmuka	Deskripsi
FcmOptions	Opsi untuk fitur yang disediakan oleh FCM SDK untuk Web. Lihat WebpushFcmOptions.
GetTokenOptions	Opsi untuk getToken().
MessagePayload	Payload pesan yang berisi payload notifikasi yang direpresentasikan dengan NotificationPayload dan payload data yang berisi jumlah arbitrer key-value pair yang dikirim oleh developer melalui Send API.
Pesan	Antarmuka publik Firebase Cloud Messaging SDK.
NotificationPayload	Menampilkan detail notifikasi. Detail dikirim melalui Send API.

function(aplikasi, ...)

getMessaging(aplikasi)

Mengambil instance Firebase Cloud Messaging.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	AplikasiFirebase

Hasil:

Pesan

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

function(pesan, ...)

deleteToken(pesan)

Menghapus token pendaftaran yang terkait dengan instance Messaging ini dan menghentikan langganan instance Messaging dari langganan push.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
pesan	Pesan	Instance Messaging.

Hasil:

Promise<boolean>

Promise akan selesai saat token berhasil dihapus.

getToken(pesan, opsi)

Berlangganan instance Messaging untuk mendapatkan notifikasi push. Menampilkan 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 dari pengguna. Promise yang ditampilkan akan menolak jika pengguna tidak mengizinkan aplikasi untuk menampilkan notifikasi.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
pesan	Pesan	Instance Messaging.
opsi	GetTokenOptions	Menyediakan kunci vapid opsional dan pendaftaran pekerja layanan opsional.

Hasil:

Promise<string>

Promise di-resolve dengan token pendaftaran FCM.

onMessage(pesan, nextOrObserver)

Saat pesan push diterima dan pengguna saat ini berada di halaman untuk origin Anda, pesan tersebut akan diteruskan ke halaman dan peristiwa onMessage() dikirim dengan payload pesan push.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
pesan	Pesan	Instance Messaging.
nextOrObserver	NextFn<MessagePayload> | Pengamat<MessagePayload>	Fungsi ini, atau objek observer dengan next yang ditentukan, dipanggil saat pesan diterima dan pengguna sedang melihat halaman Anda.

Hasil:

Berhenti berlangganan

Untuk berhenti memproses pesan, jalankan fungsi yang ditampilkan ini.

function()

isDidukung()

Memeriksa apakah semua API yang diperlukan ada di browser.

Tanda Tangan:

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

Hasil:

Promise&lt;boolean&gt;

Promise yang me-resolve ke boolean.