firebase-admin.messaging package

Pesan Cloud Firebase (FCM).

Fungsi

Fungsi Keterangan
dapatkan Pesan (aplikasi) Mendapatkan layanan Pesan 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

Kelas Keterangan
Pesan Layanan perpesanan terikat ke aplikasi yang disediakan.

Antarmuka

Antarmuka Keterangan
Konfigurasi Android Mewakili opsi khusus Android yang dapat disertakan dalam Pesan .
Opsi AndroidFcm Mewakili opsi fitur yang disediakan oleh FCM SDK untuk Android.
Pemberitahuan Android Mewakili opsi notifikasi khusus Android yang dapat disertakan dalam AndroidConfig .
Konfigurasi Apns Mewakili opsi khusus APN yang dapat disertakan dalam Pesan . Lihat dokumentasi Apple untuk berbagai kolom header dan payload yang didukung oleh APN.
Opsi ApnsFcm Mewakili opsi fitur yang disediakan oleh FCM SDK untuk iOS.
ApnsPayload Mewakili payload pesan APN. Terutama terdiri dari kamus aps . Namun mungkin juga berisi kunci khusus arbitrer lainnya.
Ap Mewakili kamus aps yang merupakan bagian dari pesan APN.
Peringatan Aps
Pesan Dasar
Respon Batch Antarmuka yang mewakili respons server dari metode Messaging.sendAll() dan Messaging.sendMulticast() .
KondisiPesan
Suara Kritis Mewakili konfigurasi suara penting yang dapat dimasukkan dalam kamus aps payload APN.
DataMessagePayload Antarmuka yang mewakili payload pesan data API lama FCM. Pesan data memungkinkan pengembang mengirimkan pasangan nilai kunci khusus hingga 4 KB. Kunci dan nilai keduanya harus berupa string. Kunci dapat berupa string khusus apa pun, kecuali string khusus berikut:
  • from
  • Segala sesuatu dimulai dengan google.
Lihat Membangun permintaan pengiriman untuk contoh kode dan dokumentasi terperinci.
Opsi Fcm Mewakili opsi platform-independen untuk fitur yang disediakan oleh FCM SDK.
Pengaturan Cahaya Merupakan pengaturan untuk mengontrol LED notifikasi yang dapat disertakan dalam AndroidNotification .
Respon Kondisi Pesan Antarmuka yang mewakili respons server dari metode Messaging.sendToCondition() yang lama. Lihat Kirim ke ketentuan untuk contoh kode dan dokumentasi terperinci.
Respons GrupPerangkat Pesan Antarmuka yang mewakili respons server dari metode Messaging.sendToDeviceGroup() . Lihat Mengirim pesan ke grup perangkat untuk contoh kode dan dokumentasi mendetail.
Hasil Perangkat Pesan Payload respons status individual dari satu perangkat
Respon Perangkat Pesan Antarmuka yang mewakili status pesan yang dikirim ke masing-masing perangkat melalui API lama FCM. Lihat Mengirim ke masing-masing perangkat untuk contoh kode dan dokumentasi terperinci.
Opsi Pesan Antarmuka yang mewakili opsi yang dapat diberikan saat mengirim pesan melalui API lama FCM. Lihat Membangun permintaan pengiriman untuk contoh kode dan dokumentasi terperinci.
PesanPayload Antarmuka yang mewakili payload pesan Firebase Cloud Messaging. Salah satu atau kedua kunci data dan notification diperlukan. Lihat Membangun permintaan pengiriman untuk contoh kode dan dokumentasi terperinci.
Respons Manajemen Topik Pesan Antarmuka yang mewakili respons server dari metode Messaging.subscribeToTopic() dan Messaging.unsubscribeFromTopic() . Lihat Mengelola topik dari server untuk contoh kode dan dokumentasi mendetail.
Respon Topik Pesan Antarmuka yang mewakili respons server dari metode Messaging.sendToTopic() lama. Lihat Mengirim ke topik untuk contoh kode dan dokumentasi mendetail.
Pesan Multicast Payload untuk metode Messaging.sendMulticast() . Payload berisi semua bidang dalam tipe BaseMessage, dan daftar token.
Pemberitahuan Pemberitahuan yang dapat disertakan dalam Pesan .
NotifikasiMessagePayload Antarmuka yang mewakili payload pesan notifikasi API lama FCM. Pesan notifikasi memungkinkan pengembang mengirimkan hingga 4 KB pasangan nilai kunci yang telah ditentukan sebelumnya. Kunci yang diterima diuraikan di bawah ini. Lihat Membangun permintaan pengiriman untuk contoh kode dan dokumentasi terperinci.
KirimRespon Antarmuka mewakili status pesan individual yang dikirim sebagai bagian dari permintaan batch.
Pesan Token
Pesan Topik
Konfigurasi Webpush Mewakili opsi protokol WebPush yang dapat disertakan dalam Pesan .
Opsi WebpushFcm Mewakili opsi untuk fitur yang disediakan oleh FCM SDK untuk Web (yang bukan merupakan bagian dari standar Webpush).
Pemberitahuan Webpush Mewakili opsi pemberitahuan khusus WebPush yang dapat disertakan dalam WebpushConfig . Ini mendukung sebagian besar opsi standar sebagaimana ditentukan dalam spesifikasi Pemberitahuan Web .

Ketik Alias

Ketik Alias Keterangan
Pesan Payload untuk operasi Messaging.send() . Payload berisi semua bidang dalam tipe BaseMessage, dan tepat satu token, topik, atau ketentuan.

dapatkan Pesan()

Mendapatkan layanan Pesan 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 Keterangan
aplikasi Aplikasi Aplikasi opsional yang layanan Messaging akan dikembalikan. Jika tidak disediakan, layanan Messaging default akan dikembalikan.

Pengembalian:

Pesan

Layanan Messaging default jika tidak ada aplikasi yang disediakan atau layanan Messaging terkait 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 bidang dalam tipe BaseMessage, dan tepat satu token, topik, atau ketentuan.

Tanda tangan:

export type Message = TokenMessage | TopicMessage | ConditionMessage;