Messaging class

Layanan perpesanan terikat ke aplikasi yang disediakan.

Tanda tangan:

export declare class Messaging 

Properti

Properti Pengubah Jenis Keterangan
aplikasi Aplikasi Aplikasi yang terkait dengan contoh layanan Messaging saat ini.

Metode

metode Pengubah Keterangan
kirim (pesan, dryRun) Mengirim pesan yang diberikan melalui FCM.
sendAll(pesan, dryRun) Mengirimkan semua pesan dalam array tertentu melalui Firebase Cloud Messaging. Menggunakan batching untuk mengirim seluruh daftar sebagai satu panggilan RPC. Dibandingkan dengan metode send() , metode ini jauh lebih efisien untuk mengirim banyak pesan. Daftar tanggapan yang diperoleh dari nilai kembalian sesuai dengan urutan token di MulticastMessage . Kesalahan dari cara ini menunjukkan kegagalan total, artinya tidak ada satu pun pesan dalam daftar yang dapat terkirim. Kegagalan sebagian ditunjukkan dengan nilai pengembalian BatchResponse .
sendEach(pesan, dryRun) Mengirim setiap pesan dalam larik tertentu melalui Firebase Cloud Messaging. Berbeda dengan Pesan.sendAll() , metode ini membuat satu panggilan RPC untuk setiap pesan dalam larik tertentu. Daftar tanggapan yang diperoleh dari nilai kembalian sesuai dengan urutan messages . Kesalahan dari metode ini atau BatchResponse dengan semua kegagalan menunjukkan kegagalan total, artinya tidak ada pesan dalam daftar yang dapat dikirim. Kegagalan sebagian atau tidak ada kegagalan hanya ditunjukkan oleh nilai pengembalian BatchResponse .
sendEachForMulticast(pesan, dryRun) Mengirimkan pesan multicast yang diberikan ke semua token pendaftaran FCM yang ditentukan di dalamnya. Metode ini menggunakan API Messaging.sendEach() untuk mengirim pesan tertentu ke semua penerima target. Daftar tanggapan yang diperoleh dari nilai kembalian sesuai dengan urutan token di MulticastMessage . Kesalahan dari metode ini atau BatchResponse dengan semua kegagalan menunjukkan kegagalan total, artinya pesan dalam daftar dapat terkirim. Kegagalan atau kegagalan sebagian hanya ditunjukkan oleh nilai pengembalian BatchResponse .
sendMulticast(pesan, dryRun) Mengirimkan pesan multicast yang diberikan ke semua token pendaftaran FCM yang ditentukan di dalamnya. Metode ini menggunakan API sendAll() untuk mengirim pesan tertentu ke semua penerima target. Daftar tanggapan yang diperoleh dari nilai kembalian sesuai dengan urutan token di MulticastMessage . Kesalahan dari metode ini menunjukkan kegagalan total, artinya pesan tidak terkirim ke token mana pun dalam daftar. Kegagalan sebagian ditunjukkan dengan nilai pengembalian BatchResponse .
sendToCondition(kondisi, muatan, opsi) Mengirim pesan FCM ke suatu kondisi. Lihat Kirim ke ketentuan untuk contoh kode dan dokumentasi terperinci.
sendToDevice(registrationTokenOrTokens, payload, opsi) Mengirim pesan FCM ke satu perangkat yang sesuai dengan token pendaftaran yang disediakan. Lihat Mengirim ke masing-masing perangkat untuk contoh kode dan dokumentasi terperinci. Mengambil registrationToken untuk dikirim ke satu perangkat atau parameter registrationTokens yang berisi serangkaian token untuk dikirim ke beberapa perangkat.
sendToDeviceGroup(notificationKey, payload, opsi) Mengirim pesan FCM ke grup perangkat yang sesuai dengan kunci notifikasi yang disediakan. Lihat Mengirim ke grup perangkat untuk contoh kode dan dokumentasi mendetail.
sendToTopic (topik, payload, opsi) Mengirim pesan FCM ke suatu topik. Lihat Mengirim ke topik untuk contoh kode dan dokumentasi mendetail.
berlanggananToTopic(registrationTokenOrTokens, topik) Melanggankan perangkat ke topik FCM. Lihat Berlangganan topik untuk contoh kode dan dokumentasi mendetail. Secara opsional, Anda dapat menyediakan serangkaian token untuk berlangganan beberapa perangkat.
berhenti berlanggananFromTopic(registrationTokenOrTokens, topik) Membatalkan langganan perangkat dari topik FCM. Lihat Berhenti berlangganan topik untuk contoh kode dan dokumentasi mendetail. Secara opsional, Anda dapat menyediakan serangkaian token untuk berhenti berlangganan beberapa perangkat.

Perpesanan.aplikasi

Aplikasi yang terkait dengan contoh layanan Messaging saat ini.

Tanda tangan:

get app(): App;

Contoh

var app = messaging.app;

Pesan.kirim()

Mengirim pesan yang diberikan melalui FCM.

Tanda tangan:

send(message: Message, dryRun?: boolean): Promise<string>;

Parameter

Parameter Jenis Keterangan
pesan Pesan Muatan pesan.
lari kering boolean Apakah akan mengirim pesan dalam mode uji coba (hanya validasi).

Pengembalian:

Janji<string>

Janji dipenuhi dengan string ID pesan unik setelah pesan berhasil diserahkan ke layanan FCM untuk dikirimkan.

Pesan.kirimSemua()

Gunakan Messaging.sendEach() sebagai gantinya.

Mengirimkan semua pesan dalam array tertentu melalui Firebase Cloud Messaging. Menggunakan batching untuk mengirim seluruh daftar sebagai satu panggilan RPC. Dibandingkan dengan metode send() , metode ini jauh lebih efisien untuk mengirim banyak pesan.

Daftar tanggapan yang diperoleh dari nilai kembalian sesuai dengan urutan token di MulticastMessage . Kesalahan dari cara ini menunjukkan kegagalan total, artinya tidak ada satu pun pesan dalam daftar yang dapat terkirim. Kegagalan sebagian ditunjukkan dengan nilai pengembalian BatchResponse .

Tanda tangan:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Parameter

Parameter Jenis Keterangan
pesan Pesan [] Array tidak kosong yang berisi hingga 500 pesan.
lari kering boolean Apakah akan mengirim pesan dalam mode uji coba (hanya validasi).

Pengembalian:

Janji< BatchResponse >

Janji dipenuhi dengan objek yang mewakili hasil operasi pengiriman.

Pesan.sendEach()

Mengirim setiap pesan dalam larik tertentu melalui Firebase Cloud Messaging.

Berbeda dengan Pesan.sendAll() , metode ini membuat satu panggilan RPC untuk setiap pesan dalam larik tertentu.

Daftar tanggapan yang diperoleh dari nilai kembalian sesuai dengan urutan messages . Kesalahan dari metode ini atau BatchResponse dengan semua kegagalan menunjukkan kegagalan total, artinya tidak ada pesan dalam daftar yang dapat dikirim. Kegagalan sebagian atau tidak ada kegagalan hanya ditunjukkan oleh nilai pengembalian BatchResponse .

Tanda tangan:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Parameter

Parameter Jenis Keterangan
pesan Pesan [] Array tidak kosong yang berisi hingga 500 pesan.
lari kering boolean Apakah akan mengirim pesan dalam mode uji coba (hanya validasi).

Pengembalian:

Janji< BatchResponse >

Janji dipenuhi dengan objek yang mewakili hasil operasi pengiriman.

Pesan.sendEachForMulticast()

Mengirimkan pesan multicast yang diberikan ke semua token pendaftaran FCM yang ditentukan di dalamnya.

Metode ini menggunakan API Messaging.sendEach() untuk mengirim pesan tertentu ke semua penerima target. Daftar tanggapan yang diperoleh dari nilai kembalian sesuai dengan urutan token di MulticastMessage . Kesalahan dari metode ini atau BatchResponse dengan semua kegagalan menunjukkan kegagalan total, artinya pesan dalam daftar dapat terkirim. Kegagalan atau kegagalan sebagian hanya ditunjukkan oleh nilai pengembalian BatchResponse .

Tanda tangan:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Parameter

Parameter Jenis Keterangan
pesan Pesan Multicast Pesan multicast yang berisi hingga 500 token.
lari kering boolean Apakah akan mengirim pesan dalam mode uji coba (hanya validasi).

Pengembalian:

Janji< BatchResponse >

Janji dipenuhi dengan objek yang mewakili hasil operasi pengiriman.

Pesan.sendMulticast()

Gunakan Messaging.sendEachForMulticast() sebagai gantinya.

Mengirimkan pesan multicast yang diberikan ke semua token pendaftaran FCM yang ditentukan di dalamnya.

Metode ini menggunakan API sendAll() untuk mengirim pesan tertentu ke semua penerima target. Daftar tanggapan yang diperoleh dari nilai kembalian sesuai dengan urutan token di MulticastMessage . Kesalahan dari metode ini menunjukkan kegagalan total, artinya pesan tidak terkirim ke token mana pun dalam daftar. Kegagalan sebagian ditunjukkan dengan nilai pengembalian BatchResponse .

Tanda tangan:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Parameter

Parameter Jenis Keterangan
pesan Pesan Multicast Pesan multicast yang berisi hingga 500 token.
lari kering boolean Apakah akan mengirim pesan dalam mode uji coba (hanya validasi).

Pengembalian:

Janji< BatchResponse >

Janji dipenuhi dengan objek yang mewakili hasil operasi pengiriman.

Pesan.sendToCondition()

Mengirim pesan FCM ke suatu kondisi.

Lihat Kirim ke ketentuan untuk contoh kode dan dokumentasi terperinci.

Tanda tangan:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

Parameter

Parameter Jenis Keterangan
kondisi rangkaian Kondisi yang menentukan topik mana yang akan dikirimi pesan.
muatan PesanPayload Muatan pesan.
pilihan Opsi Pesan Opsi opsional untuk mengubah pesan.

Pengembalian:

Janji< MessagingConditionResponse >

Janji yang dipenuhi dengan respons server setelah pesan terkirim.

Pesan.sendToDevice()

Gunakan Messaging.send() sebagai gantinya.

Mengirim pesan FCM ke satu perangkat yang sesuai dengan token pendaftaran yang disediakan.

Lihat Mengirim ke masing-masing perangkat untuk contoh kode dan dokumentasi terperinci. Mengambil registrationToken untuk dikirim ke satu perangkat atau parameter registrationTokens yang berisi serangkaian token untuk dikirim ke beberapa perangkat.

Tanda tangan:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

Parameter

Parameter Jenis Keterangan
registrasiTokenOrToken tali | rangkaian[]
muatan PesanPayload Muatan pesan.
pilihan Opsi Pesan Opsi opsional untuk mengubah pesan.

Pengembalian:

Janji< MessagingDevicesResponse >

Janji yang dipenuhi dengan respons server setelah pesan terkirim.

Pesan.sendToDeviceGroup()

Gunakan Messaging.send() sebagai gantinya.

Mengirim pesan FCM ke grup perangkat yang sesuai dengan kunci notifikasi yang disediakan.

Lihat Mengirim ke grup perangkat untuk contoh kode dan dokumentasi mendetail.

Tanda tangan:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

Parameter

Parameter Jenis Keterangan
kunci notifikasi rangkaian Kunci notifikasi untuk grup perangkat yang akan dikirimi pesan.
muatan PesanPayload Muatan pesan.
pilihan Opsi Pesan Opsi opsional untuk mengubah pesan.

Pengembalian:

Janji< MessagingDeviceGroupResponse >

Janji yang dipenuhi dengan respons server setelah pesan terkirim.

Pesan.sendToTopic()

Mengirim pesan FCM ke suatu topik.

Lihat Mengirim ke topik untuk contoh kode dan dokumentasi mendetail.

Tanda tangan:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

Parameter

Parameter Jenis Keterangan
tema rangkaian Topik tujuan pengiriman pesan.
muatan PesanPayload Muatan pesan.
pilihan Opsi Pesan Opsi opsional untuk mengubah pesan.

Pengembalian:

Janji< MessagingTopicResponse >

Janji yang dipenuhi dengan respons server setelah pesan terkirim.

Pesan.subscribeToTopic()

Melanggankan perangkat ke topik FCM.

Lihat Berlangganan topik untuk contoh kode dan dokumentasi mendetail. Secara opsional, Anda dapat menyediakan serangkaian token untuk berlangganan beberapa perangkat.

Tanda tangan:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parameter

Parameter Jenis Keterangan
registrasiTokenOrToken tali | rangkaian[]
tema rangkaian Topik untuk berlangganan.

Pengembalian:

Janji< MessagingTopicManagementResponse >

Janji yang dipenuhi dengan respons server setelah perangkat berlangganan topik tersebut.

Perpesanan.berhenti berlanggananDariTopik()

Membatalkan langganan perangkat dari topik FCM.

Lihat Berhenti berlangganan topik untuk contoh kode dan dokumentasi mendetail. Secara opsional, Anda dapat menyediakan serangkaian token untuk berhenti berlangganan beberapa perangkat.

Tanda tangan:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parameter

Parameter Jenis Keterangan
registrasiTokenOrToken tali | rangkaian[]
tema rangkaian Topik untuk berhenti berlangganan.

Pengembalian:

Janji< MessagingTopicManagementResponse >

Janji yang dipenuhi dengan respons server setelah perangkat berhenti berlangganan topik.