Messaging class

Layanan pesan terikat ke aplikasi yang disediakan.

Tanda Tangan:

export declare class Messaging 

Properti

Properti Pengubah Jenis Deskripsi
app Aplikasi Aplikasi yang terkait dengan instance layanan Messaging saat ini.

Metode

Metode Pengubah Deskripsi
enableLegacyHttpTransport() Mengaktifkan penggunaan transport HTTP/1.1 lama untuk sendEach() dan sendEachForMulticast().
send(pesan, dryRun) Mengirim pesan yang diberikan melalui FCM.
sendAll(pesan, dryRun) Mengirim semua pesan dalam array yang diberikan melalui Firebase Cloud Messaging. Menggunakan batch untuk mengirim seluruh daftar sebagai satu panggilan RPC. Dibandingkan dengan metode send(), metode ini merupakan cara yang jauh lebih efisien untuk mengirim beberapa pesan.Daftar respons yang diperoleh dari nilai yang ditampilkan sesuai dengan urutan token di MulticastMessage. Error dari metode ini menunjukkan kegagalan total, yang berarti bahwa tidak ada pesan dalam daftar yang dapat dikirim. Kegagalan sebagian ditunjukkan dengan nilai yang ditampilkan BatchResponse.
sendSetiap(pesan, dryRun) Mengirim setiap pesan dalam array yang ditentukan melalui Firebase Cloud Messaging.Tidak seperti Messaging.sendAll(), metode ini membuat satu panggilan RPC untuk setiap pesan dalam array tertentu.Daftar respons yang diperoleh dari nilai yang ditampilkan sesuai dengan urutan messages. Error dari metode ini atau BatchResponse dengan semua kegagalan menunjukkan kegagalan total, yang berarti tidak ada pesan dalam daftar yang dapat dikirim. Kegagalan sebagian atau tidak ada kegagalan hanya ditunjukkan dengan nilai yang ditampilkan BatchResponse.
sendSetiapForMulticast(pesan, dryRun) Mengirim pesan multicast yang diberikan ke semua token pendaftaran FCM yang ditentukan di dalamnya.Metode ini menggunakan Messaging.sendSetiap() API di balik layar untuk mengirim pesan yang diberikan ke semua penerima target. Daftar respons yang diperoleh dari nilai yang ditampilkan sesuai dengan urutan token di MulticastMessage. Error dari metode ini atau BatchResponse dengan semua kegagalan menunjukkan kegagalan total, yang berarti bahwa pesan dalam daftar dapat dikirim. Kegagalan atau kegagalan sebagian hanya ditunjukkan dengan nilai yang ditampilkan BatchResponse.
sendMulticast(pesan, dryRun) Mengirim pesan multicast yang diberikan ke semua token pendaftaran FCM yang ditentukan di dalamnya.Metode ini menggunakan sendAll() API di balik layar untuk mengirim pesan yang diberikan ke semua penerima target. Daftar respons yang diperoleh dari nilai yang ditampilkan sesuai dengan urutan token di MulticastMessage. Error dari metode ini menunjukkan kegagalan total, yang berarti bahwa pesan tidak dikirim ke token mana pun dalam daftar. Kegagalan sebagian ditunjukkan dengan nilai yang ditampilkan BatchResponse.
sendToCondition(kondisi, payload, opsi) Mengirim pesan FCM ke suatu kondisi.Lihat Mengirim ke kondisi untuk mengetahui contoh kode dan dokumentasi mendetail.
sendToDevice(registrationTokenOrTokens, payload, opsi) Mengirim pesan FCM ke satu perangkat yang sesuai dengan token pendaftaran yang diberikan.Lihat Mengirim ke perangkat individual untuk melihat contoh kode dan dokumentasi mendetail. Memerlukan registrationToken untuk dikirim ke satu perangkat atau parameter registrationTokens yang berisi array token untuk dikirim ke beberapa perangkat.
sendToDeviceGroup(notificationKey, payload, opsi) Mengirim pesan FCM ke grup perangkat yang sesuai dengan kunci notifikasi yang diberikan.Lihat Mengirim ke grup perangkat untuk melihat contoh kode dan dokumentasi mendetail.
sendToTopic(topik, payload, opsi) Mengirim pesan FCM ke topik.Lihat Mengirim ke topik untuk mengetahui contoh kode dan dokumentasi mendetail.
subscribeToTopic(signupTokenOrTokens, topik) Menyertakan perangkat ke topik FCM.Lihat Berlangganan topik untuk melihat contoh kode dan dokumentasi mendetail. Secara opsional, Anda dapat menyediakan array token untuk membuat beberapa perangkat berlangganan.
unsubscribeFromTopic(registrationTokenOrTokens, topik) Menghentikan langganan perangkat dari topik FCM.Lihat Berhenti berlangganan dari sebuah topik untuk mengetahui contoh kode dan dokumentasi mendetail. Secara opsional, Anda dapat memberikan array token untuk menghentikan langganan beberapa perangkat.

Messaging.app

Aplikasi yang terkait dengan instance layanan Messaging saat ini.

Tanda Tangan:

get app(): App;

Contoh

var app = messaging.app;

Messaging.enableLegacyHttpTransport()

Kebijakan ini akan dihapus saat implementasi transpor HTTP/2 mencapai stabilitas yang sama dengan implementasi HTTP/1.1 lama.

Mengaktifkan penggunaan transport HTTP/1.1 lama untuk sendEach() dan sendEachForMulticast().

Tanda Tangan:

enableLegacyHttpTransport(): void;

Hasil:

void

Contoh

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Messaging.send()

Mengirim pesan yang diberikan melalui FCM.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
message Kirim pesan Payload pesan.
uji coba boolean Apakah akan mengirim pesan dalam mode uji coba (hanya validasi).

Hasil:

Promise<string>

Promise dijalankan dengan string ID pesan unik setelah pesan berhasil diserahkan ke layanan FCM untuk dikirim.

Messaging.sendAll()

Sebagai gantinya, gunakan Messaging.sendSetiap().

Mengirim semua pesan dalam array yang diberikan melalui Firebase Cloud Messaging. Menggunakan batch untuk mengirim seluruh daftar sebagai satu panggilan RPC. Dibandingkan dengan metode send(), metode ini merupakan cara yang jauh lebih efisien untuk mengirim beberapa pesan.

Daftar respons yang diperoleh dari nilai yang ditampilkan sesuai dengan urutan token di MulticastMessage. Error dari metode ini menunjukkan kegagalan total, yang berarti bahwa tidak ada pesan dalam daftar yang dapat dikirim. Kegagalan sebagian ditunjukkan dengan nilai yang ditampilkan BatchResponse.

Tanda Tangan:

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

Parameter

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

Hasil:

Promise<BatchResponse>

Promise terpenuhi dengan objek yang mewakili hasil operasi pengiriman.

Messaging.sendSetiap()

Mengirim setiap pesan dalam array yang diberikan melalui Firebase Cloud Messaging.

Tidak seperti Messaging.sendAll(), metode ini membuat satu panggilan RPC untuk setiap pesan dalam array tertentu.

Daftar respons yang diperoleh dari nilai yang ditampilkan sesuai dengan urutan messages. Error dari metode ini atau BatchResponse dengan semua kegagalan menunjukkan kegagalan total, yang berarti tidak ada pesan dalam daftar yang dapat dikirim. Kegagalan sebagian atau tidak ada kegagalan hanya ditunjukkan dengan nilai yang ditampilkan BatchResponse.

Tanda Tangan:

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

Parameter

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

Hasil:

Promise<BatchResponse>

Promise terpenuhi dengan objek yang mewakili hasil operasi pengiriman.

Messaging.sendSetiapForMulticast()

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

Metode ini menggunakan API Messaging.sendSetiap() di balik layar untuk mengirim pesan yang diberikan ke semua penerima target. Daftar respons yang diperoleh dari nilai yang ditampilkan sesuai dengan urutan token di MulticastMessage. Error dari metode ini atau BatchResponse dengan semua kegagalan menunjukkan kegagalan total, yang berarti bahwa pesan dalam daftar dapat dikirim. Kegagalan atau kegagalan sebagian hanya ditunjukkan dengan nilai yang ditampilkan BatchResponse.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
message MulticastMessage Pesan multicast yang berisi hingga 500 token.
uji coba boolean Apakah akan mengirim pesan dalam mode uji coba (hanya validasi).

Hasil:

Promise<BatchResponse>

Promise terpenuhi dengan objek yang mewakili hasil operasi pengiriman.

Messaging.sendMulticast()

Gunakan Messaging.sendSetiapForMulticast() sebagai gantinya.

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

Pada prinsipnya, metode ini menggunakan sendAll() API untuk mengirim pesan yang diberikan ke semua penerima target. Daftar respons yang diperoleh dari nilai yang ditampilkan sesuai dengan urutan token di MulticastMessage. Error dari metode ini menunjukkan kegagalan total, yang berarti bahwa pesan tidak dikirim ke token mana pun dalam daftar. Kegagalan sebagian ditunjukkan dengan nilai yang ditampilkan BatchResponse.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
message MulticastMessage Pesan multicast yang berisi hingga 500 token.
uji coba boolean Apakah akan mengirim pesan dalam mode uji coba (hanya validasi).

Hasil:

Promise<BatchResponse>

Promise terpenuhi dengan objek yang mewakili hasil operasi pengiriman.

Messaging.sendToCondition()

Sebagai gantinya, gunakan Messaging.send().

Mengirim pesan FCM ke suatu kondisi.

Lihat Mengirim ke kondisi untuk mengetahui contoh kode dan dokumentasi mendetail.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
kondisi string Kondisi yang menentukan topik pesan yang akan dikirim.
payload MessagingPayload Payload pesan.
opsi Opsi Pesan Opsi opsional untuk mengubah pesan.

Hasil:

Promise<MessagingConditionResponse>

Promise terpenuhi dengan respons server setelah pesan dikirim.

Messaging.sendToDevice()

Sebagai gantinya, gunakan Messaging.send().

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

Lihat Mengirim ke perangkat individual untuk contoh kode dan dokumentasi mendetail. Memerlukan registrationToken untuk dikirim ke satu perangkat atau parameter registrationTokens yang berisi array token untuk dikirim ke beberapa perangkat.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RegistrationTokenOrTokens rangkaian | {i>string<i}[]
payload MessagingPayload Payload pesan.
opsi Opsi Pesan Opsi opsional untuk mengubah pesan.

Hasil:

Promise<MessagingDevicesResponse>

Promise terpenuhi dengan respons server setelah pesan dikirim.

Messaging.sendToDeviceGroup()

Sebagai gantinya, gunakan Messaging.send().

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

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

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
notifikasiKey string Kunci notifikasi untuk grup perangkat yang akan dikirimi pesan.
payload MessagingPayload Payload pesan.
opsi Opsi Pesan Opsi opsional untuk mengubah pesan.

Hasil:

Promise<MessagingDeviceGroupResponse>

Promise terpenuhi dengan respons server setelah pesan dikirim.

Messaging.sendToTopic()

Sebagai gantinya, gunakan Messaging.send().

Mengirim pesan FCM ke topik.

Lihat Mengirim ke topik untuk melihat contoh kode dan dokumentasi mendetail.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
topic string Topik yang akan dikirimi pesan.
payload MessagingPayload Payload pesan.
opsi Opsi Pesan Opsi opsional untuk mengubah pesan.

Hasil:

Promise<MessagingTopicResponse>

Promise terpenuhi dengan respons server setelah pesan dikirim.

Messaging.subscribeToTopic()

Menyertakan perangkat ke topik FCM.

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

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RegistrationTokenOrTokens rangkaian | {i>string<i}[]
topic string Topik yang dipilih untuk berlangganan.

Hasil:

Promise<MessagingTopicManagementResponse>

Promise terpenuhi dengan respons server setelah perangkat berlangganan topik.

Messaging.unsubscribeFromTopic()

Menghentikan langganan perangkat dari topik FCM.

Lihat Berhenti berlangganan topik untuk melihat contoh kode dan dokumentasi mendetail. Secara opsional, Anda dapat memberikan array token untuk menghentikan langganan beberapa perangkat.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RegistrationTokenOrTokens rangkaian | {i>string<i}[]
topic string Topik yang dipilih untuk berhenti berlangganan.

Hasil:

Promise<MessagingTopicManagementResponse>

Promise dipenuhi dengan respons server setelah perangkat berhenti berlangganan dari topik.