Firebase Cloud Messaging (FCM).
Functions
| Fungsi | Deskripsi |
|---|---|
| getMessaging(aplikasi) | Mendapatkan layanan Messaging untuk aplikasi default atau aplikasi tertentu.admin.messaging() dapat dipanggil tanpa argumen untuk mengakses layanan Messaging aplikasi default atau sebagai admin.messaging(app) untuk mengakses layanan Messaging yang terkait dengan aplikasi tertentu. |
Kelas
| Class | Deskripsi |
|---|---|
| FirebaseMessagingError | Struktur kode error Firebase Messaging. Tindakan ini akan memperluas PrefixedFirebaseError. |
| Pesan | Layanan pesan terikat ke aplikasi yang disediakan. |
| MessagingClientErrorCode | Untuk mengirim pesan ke kode error klien dan pesan defaultnya. |
Antarmuka
| Antarmuka | Deskripsi |
|---|---|
| AndroidConfig | Merepresentasikan opsi khusus Android yang dapat disertakan dalam Message. |
| AndroidFcmOptions | Menampilkan opsi untuk fitur yang disediakan oleh FCM SDK untuk Android. |
| AndroidNotification | Merepresentasikan opsi notifikasi khusus Android yang dapat disertakan dalam AndroidConfig. |
| ApnsConfig | Merepresentasikan opsi khusus APN yang dapat disertakan dalam Pesan. Baca dokumentasi Apple untuk mengetahui berbagai kolom header dan payload yang didukung oleh APN. |
| ApnsFcmOptions | Merepresentasikan opsi untuk fitur yang disediakan oleh FCM SDK untuk iOS. |
| ApnsPayload | Mewakili payload pesan APN. Sebagian besar terdiri dari kamus aps. Namun, juga dapat berisi kunci kustom arbitrer lainnya. |
| Aps | Mewakili kamus aps yang merupakan bagian dari pesan APN. |
| ApsAlert | |
| BaseMessage | |
| BatchResponse | Antarmuka yang mewakili respons server dari metode Messaging.sendAll() dan Messaging.sendMulticast(). |
| ConditionMessage | |
| Suara Kritis | Mewakili konfigurasi suara penting yang dapat disertakan dalam kamus aps dari payload APN. |
| DataMessagePayload | Antarmuka yang mewakili payload pesan data API lama FCM. Pesan data memungkinkan developer mengirim hingga 4 KB key-value pair kustom. Kunci dan nilai harus berupa string. Kunci dapat berupa string kustom apa pun, kecuali untuk string dengan fungsi khusus berikut:
|
| FcmOptions | Merepresentasikan opsi yang tidak bergantung pada platform untuk fitur yang disediakan oleh FCM SDK. |
| Setelan Cahaya | Mewakili setelan untuk mengontrol LED notifikasi yang dapat disertakan dalam AndroidNotification. |
| MessagingConditionResponse | Antarmuka yang menampilkan respons server dari metode Messaging.sendToCondition() lama.Lihat Kirim ke kondisi untuk melihat contoh kode dan dokumentasi mendetail. |
| MessagingDeviceGroupResponse | Antarmuka yang mewakili respons server dari metode Messaging.sendToDeviceGroup().Lihat Mengirim pesan ke grup perangkat untuk melihat contoh kode dan dokumentasi mendetail. |
| MessagingDeviceResult | Payload respons status individual dari satu perangkat |
| MessagingDevicesResponse | Antarmuka yang menampilkan status pesan yang dikirim ke setiap perangkat melalui API lama FCM.Lihat Mengirim ke perangkat individual untuk mengetahui contoh kode dan dokumentasi mendetail. |
| Opsi Pesan | Antarmuka yang menampilkan opsi yang dapat diberikan ketika mengirim pesan melalui API lama FCM.Lihat Membuat permintaan kirim untuk mengetahui contoh kode dan dokumentasi mendetail. |
| MessagingPayload | Antarmuka yang mewakili payload pesan Firebase Cloud Messaging. Salah satu atau kedua kunci data dan notification diperlukan.Lihat Membuat permintaan kirim untuk mengetahui contoh kode dan dokumentasi mendetail. |
| MessagingTopicManagementResponse | Antarmuka yang mewakili respons server dari metode Messaging.subscribeToTopic() dan Messaging.unsubscribeFromTopic().Lihat Mengelola topik dari server untuk melihat contoh kode dan dokumentasi mendetail. |
| MessagingTopicResponse | Antarmuka yang menampilkan respons server dari metode Messaging.sendToTopic() lama.Lihat Mengirim ke topik untuk melihat contoh kode dan dokumentasi mendetail. |
| MulticastMessage | Payload untuk metode Messaging.sendMulticast(). Payload berisi semua kolom dalam jenis BaseMessage, dan daftar token. |
| Notifikasi | Notifikasi yang dapat disertakan dalam Pesan. |
| NotificationMessagePayload | Antarmuka yang mewakili payload pesan notifikasi API lama FCM. Pesan notifikasi memungkinkan developer mengirim hingga 4 KB pasangan nilai kunci standar. Kunci yang diterima diuraikan di bawah.Lihat Membuat permintaan pengiriman untuk mengetahui contoh kode dan dokumentasi mendetail. |
| SendResponse | Antarmuka yang menampilkan status setiap pesan yang dikirim sebagai bagian dari permintaan batch. |
| TokenMessage | |
| TopicMessage | |
| WebpushConfig | Merepresentasikan opsi protokol WebPush yang dapat disertakan dalam Message. |
| WebpushFcmOptions | Merepresentasikan opsi untuk fitur yang disediakan oleh FCM SDK untuk Web (yang bukan bagian dari standar Webpush). |
| WebpushNotification | Merepresentasikan opsi notifikasi khusus WebPush yang dapat disertakan dalam WebpushConfig. Tindakan ini mendukung sebagian besar opsi standar seperti yang ditentukan dalam spesifikasi Notifikasi Web. |
Ketik Alias
| Ketik Alias | Deskripsi |
|---|---|
| Kirim pesan | Payload untuk operasi Messaging.send(). Payload berisi semua kolom dalam jenis BaseMessage, dan tepat satu token, topik, atau kondisi. |
getMessaging(aplikasi)
Mendapatkan layanan Messaging untuk aplikasi default atau aplikasi tertentu.
admin.messaging() dapat dipanggil tanpa argumen untuk mengakses layanan Messaging aplikasi default atau sebagai admin.messaging(app) untuk mengakses layanan Messaging yang terkait dengan aplikasi tertentu.
Tanda Tangan:
export declare function getMessaging(app?: App): Messaging;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| aplikasi | Aplikasi | Aplikasi opsional yang layanan Messaging-nya akan ditampilkan. Jika tidak diberikan, layanan Messaging default akan ditampilkan. |
Hasil:
Layanan Messaging default jika tidak ada aplikasi yang disediakan atau layanan Messaging dikaitkan dengan aplikasi yang disediakan.
Contoh 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
Contoh 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
Pesan
Payload untuk operasi Messaging.send(). Payload berisi semua kolom dalam jenis BaseMessage, dan tepat satu token, topik, atau kondisi.
Tanda Tangan:
export type Message = TokenMessage | TopicMessage | ConditionMessage;