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 Membangun permintaan kirim untuk mengetahui contoh kode dan dokumentasi mendetail.
Tanda Tangan:
export interface NotificationMessagePayload
Properti
| Properti | Jenis | Deskripsi |
|---|---|---|
| badge | string | Nilai badge pada ikon aplikasi layar utama.Jika tidak ditentukan, badge tidak berubah.Jika disetel ke 0, badge dihapus.**Platform:** iOS |
| isi | string | Teks isi notifikasi.**Platform:** iOS, Android, Web |
| bodyLocArgs | string | Nilai string variabel yang akan digunakan sebagai pengganti penentu format di body_loc_key untuk melokalkan teks isi ke pelokalan pengguna saat ini.Nilainya harus berupa array JSON string.**iOS:** Sesuai dengan loc-args dalam payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh untuk informasi selengkapnya.**Android:** Lihat Memformat dan Menata Gaya untuk informasi selengkapnya.**Platform:** iOS, Android |
| bodyLocKey | string | Kunci ke string isi di resource string aplikasi yang akan digunakan untuk melokalkan teks isi ke pelokalan pengguna saat ini.**iOS:** Sesuai dengan loc-key dalam payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh untuk informasi selengkapnya.**Android:** Lihat Resource String untuk informasi selengkapnya.**Platform:** iOS, Android |
| clickAction | string | Tindakan yang terkait dengan klik pengguna pada notifikasi. Jika ditentukan, aktivitas dengan Filter Intent yang cocok akan diluncurkan ketika pengguna mengklik notifikasi.* **Platform:** Android |
| warna | string | Warna ikon notifikasi, dinyatakan dalam format #rrggbb.**Platform:** Android |
| ikon | string | Ikon notifikasi.**Android:** Menyetel ikon notifikasi ke myicon untuk resource drawable myicon. Jika Anda tidak mengirim kunci ini dalam permintaan, FCM akan menampilkan ikon peluncur yang ditentukan dalam manifes aplikasi.**Web:** URL yang akan digunakan untuk ikon notifikasi.**Platform:** Android, Web |
| suara | string | Suara yang akan diputar saat perangkat menerima notifikasi. Mendukung "default" untuk suara notifikasi default perangkat atau nama file resource suara yang dipaketkan dalam aplikasi. File suara harus berada di /res/raw/.**Platform:** Android |
| tag | string | ID yang digunakan untuk menggantikan notifikasi yang ada di panel samping notifikasi.Jika tidak ditentukan, setiap permintaan akan membuat notifikasi baru.Jika ditetapkan dan notifikasi dengan tag yang sama sudah ditampilkan, notifikasi baru akan menggantikan notifikasi yang sudah ada di panel samping notifikasi.**Platform:** Android |
| title | string | Judul notifikasi.**Platform:** iOS, Android, Web |
| titleLocArgs | string | Nilai string variabel yang akan digunakan sebagai pengganti penentu format di title_loc_key untuk melokalkan teks judul ke pelokalan pengguna saat ini.Nilainya harus berupa array JSON string.**iOS:** Sesuai dengan title-loc-args dalam payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh untuk informasi selengkapnya.**Android:** Lihat Memformat dan Menata Gaya untuk informasi selengkapnya.**Platform:** iOS, Android |
| titleLocKey | string | Kunci untuk string judul di resource string aplikasi yang akan digunakan untuk melokalkan teks judul ke pelokalan pengguna saat ini.**iOS:** Sesuai dengan title-loc-key dalam payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh untuk informasi selengkapnya.**Android:** Lihat Resource String untuk informasi selengkapnya.**Platform:** iOS, Android |
NotificationMessagePayload.badge
Nilai badge pada ikon aplikasi layar utama.
Jika tidak ditentukan, badge tidak diubah.
Jika ditetapkan ke 0, badge akan dihapus.
**Platform:** iOS
Tanda Tangan:
badge?: string;
NotificationMessagePayload.body
Teks isi notifikasi.
**Platform:** iOS, Android, Web
Tanda Tangan:
body?: string;
NotificationMessagePayload.bodyLocArgs
Nilai string variabel yang akan digunakan sebagai pengganti penentu format dalam body_loc_key untuk melokalkan teks isi ke pelokalan pengguna saat ini.
Nilai harus berupa array JSON yang di-string.
**iOS:** Sesuai dengan loc-args dalam payload APN. Lihat Referensi Kunci Payload dan Melokalkan Isi Notifikasi Jarak Jauh untuk mengetahui informasi selengkapnya.
**Android:** Lihat Pemformatan dan Penataan Gaya untuk informasi selengkapnya.
**Platform:** iOS, Android
Tanda Tangan:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
Kunci untuk string isi di resource string aplikasi yang akan digunakan untuk melokalkan teks isi ke bahasa pengguna saat ini.
**iOS:** Sesuai dengan loc-key dalam payload APN. Lihat Referensi Kunci Payload dan Melokalkan Isi Notifikasi Jarak Jauh untuk mengetahui informasi selengkapnya.
**Android:** Lihat Sumber Daya String untuk informasi selengkapnya.
**Platform:** iOS, Android
Tanda Tangan:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
Tindakan yang terkait dengan klik pengguna pada notifikasi. Jika ditentukan, aktivitas dengan Filter Intent yang cocok akan diluncurkan ketika pengguna mengklik notifikasi.
* **Platform:** Android
Tanda Tangan:
clickAction?: string;
NotificationMessagePayload.color
Warna ikon notifikasi, dinyatakan dalam format #rrggbb.
**Platform:** Android
Tanda Tangan:
color?: string;
NotificationMessagePayload.icon
Ikon notifikasi.
**Android:** Menyetel ikon notifikasi ke myicon untuk resource drawable myicon. Jika Anda tidak mengirim kunci ini dalam permintaan, FCM akan menampilkan ikon peluncur yang ditentukan dalam manifes aplikasi.
**Web:** URL yang akan digunakan untuk ikon notifikasi.
**Platform:** Android, Web
Tanda Tangan:
icon?: string;
NotificationMessagePayload.sound
Suara yang akan diputar saat perangkat menerima notifikasi. Mendukung "default" untuk suara notifikasi default perangkat atau nama file resource suara yang dipaketkan dalam aplikasi. File suara harus berada di /res/raw/.
**Platform:** Android
Tanda Tangan:
sound?: string;
NotifikasiMessagePayload.tag
ID yang digunakan untuk mengganti notifikasi yang ada di panel samping notifikasi.
Jika tidak ditentukan, setiap permintaan akan membuat notifikasi baru.
Jika ditetapkan dan notifikasi dengan tag yang sama sudah ditampilkan, notifikasi yang baru akan menggantikan notifikasi lama di panel samping notifikasi.
**Platform:** Android
Tanda Tangan:
tag?: string;
NotificationMessagePayload.title
Judul notifikasi.
**Platform:** iOS, Android, Web
Tanda Tangan:
title?: string;
NotificationMessagePayload.titleLocArgs
Nilai string variabel yang akan digunakan sebagai pengganti penentu format dalam title_loc_key untuk melokalkan teks judul ke bahasa pengguna saat ini.
Nilai harus berupa array JSON yang di-string.
**iOS:** Sesuai dengan title-loc-args dalam payload APN. Lihat Referensi Kunci Payload dan Melokalkan Isi Notifikasi Jarak Jauh untuk mengetahui informasi selengkapnya.
**Android:** Lihat Pemformatan dan Penataan Gaya untuk informasi selengkapnya.
**Platform:** iOS, Android
Tanda Tangan:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
Kunci ke string judul di dalam resource string aplikasi yang akan digunakan untuk melokalkan teks judul ke pelokalan pengguna saat ini.
**iOS:** Sesuai dengan title-loc-key dalam payload APN. Lihat Referensi Kunci Payload dan Melokalkan Isi Notifikasi Jarak Jauh untuk mengetahui informasi selengkapnya.
**Android:** Lihat Sumber Daya String untuk informasi selengkapnya.
**Platform:** iOS, Android
Tanda Tangan:
titleLocKey?: string;