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.
Tanda tangan:
export interface NotificationMessagePayload
Properti
Properti | Jenis | Keterangan |
---|---|---|
lencana | rangkaian | Nilai lencana pada ikon aplikasi layar beranda. Jika tidak ditentukan, lencana tidak diubah. Jika disetel ke 0 , lencana akan dihapus. **Platform:** iOS |
tubuh | rangkaian | Teks isi notifikasi. **Platform:** iOS, Android, Web |
bodyLocArgs | rangkaian | Nilai string variabel yang akan digunakan sebagai pengganti penentu format di body_loc_key yang akan digunakan untuk melokalisasi teks isi ke pelokalan pengguna saat ini. Nilainya harus berupa array JSON yang dirangkai. **iOS:** Sesuai dengan loc-args di payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh Anda untuk informasi lebih lanjut. **Android:** Lihat Pemformatan dan Gaya untuk informasi selengkapnya. **Platform:** iOS, Android |
bodyLockKey | rangkaian | Kunci string isi dalam sumber daya string aplikasi yang digunakan untuk melokalkan teks isi ke pelokalan pengguna saat ini. **iOS:** Sesuai dengan loc-key di payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh Anda untuk informasi lebih lanjut. **Android:** Lihat Sumber Daya String untuk informasi lebih lanjut. **Platform:** iOS, Android |
klikAksi | rangkaian | Tindakan yang terkait dengan pengguna mengklik notifikasi. Jika ditentukan, aktivitas dengan Filter Intent yang cocok akan diluncurkan saat pengguna mengklik notifikasi. * **Platform:** Android |
warna | rangkaian | Warna ikon notifikasi, dinyatakan dalam format #rrggbb . **Platform:** Android |
ikon | rangkaian | Ikon notifikasi. **Android:** Menyetel ikon notifikasi ke myicon untuk sumber daya drawable myicon . Jika Anda tidak mengirimkan kunci ini dalam permintaan, FCM akan menampilkan ikon peluncur yang ditentukan dalam manifes aplikasi Anda. **Web:** URL yang digunakan untuk ikon notifikasi. **Platform:** Android, Web |
suara | rangkaian | Suara yang akan diputar saat perangkat menerima notifikasi. Mendukung "default" untuk suara notifikasi default perangkat atau nama file sumber suara yang disertakan dalam aplikasi. File suara harus berada di /res/raw/ . **Platform:** Android |
menandai | rangkaian | Pengenal digunakan untuk menggantikan notifikasi yang ada di panel samping notifikasi. Jika tidak ditentukan, setiap permintaan akan membuat notifikasi baru. Jika ditentukan dan notifikasi dengan tag yang sama sudah ditampilkan, notifikasi baru akan menggantikan notifikasi yang sudah ada di panel samping notifikasi. **Platform:** Android |
judul | rangkaian | Judul notifikasi. **Platform:** iOS, Android, Web |
judulLocArgs | rangkaian | Nilai string variabel yang akan digunakan sebagai pengganti penentu format di title_loc_key yang akan digunakan untuk melokalisasi teks judul ke lokalisasi pengguna saat ini. Nilainya harus berupa array JSON yang dirangkai. **iOS:** Sesuai dengan title-loc-args di payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh Anda untuk informasi lebih lanjut. **Android:** Lihat Pemformatan dan Gaya untuk informasi selengkapnya. **Platform:** iOS, Android |
judulLocKey | rangkaian | Kunci string judul dalam sumber daya string aplikasi yang digunakan untuk melokalkan teks judul ke lokalisasi pengguna saat ini. **iOS:** Sesuai dengan title-loc-key di payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh Anda untuk informasi lebih lanjut. **Android:** Lihat Sumber Daya String untuk informasi lebih lanjut. **Platform:** iOS, Android |
NotifikasiMessagePayload.badge
Nilai lencana pada ikon aplikasi layar beranda.
Jika tidak ditentukan, lencana tidak diubah.
Jika disetel ke 0
, lencananya dihapus.
**Platform:** iOS
Tanda tangan:
badge?: string;
NotifikasiMessagePayload.body
Teks isi notifikasi.
**Platform:** iOS, Android, Web
Tanda tangan:
body?: string;
NotifikasiMessagePayload.bodyLocArgs
Nilai string variabel yang akan digunakan sebagai pengganti penentu format di body_loc_key
yang akan digunakan untuk melokalisasi teks isi ke pelokalan pengguna saat ini.
Nilainya harus berupa array JSON yang dirangkai.
**iOS:** Sesuai dengan loc-args
di payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh Anda untuk informasi lebih lanjut.
**Android:** Lihat Pemformatan dan Gaya untuk informasi selengkapnya.
**Platform:** iOS, Android
Tanda tangan:
bodyLocArgs?: string;
NotifikasiMessagePayload.bodyLocKey
Kunci string isi dalam sumber daya string aplikasi yang digunakan untuk melokalkan teks isi ke pelokalan pengguna saat ini.
**iOS:** Sesuai dengan loc-key
di payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh Anda untuk informasi lebih lanjut.
**Android:** Lihat Sumber Daya String untuk informasi lebih lanjut.
**Platform:** iOS, Android
Tanda tangan:
bodyLocKey?: string;
NotifikasiMessagePayload.clickAction
Tindakan yang terkait dengan pengguna mengklik notifikasi. Jika ditentukan, aktivitas dengan Filter Intent yang cocok akan diluncurkan saat pengguna mengklik notifikasi.
* **Platform:** Android
Tanda tangan:
clickAction?: string;
NotifikasiMessagePayload.color
Warna ikon notifikasi, dinyatakan dalam format #rrggbb
.
**Platform:** Android
Tanda tangan:
color?: string;
NotifikasiMessagePayload.icon
Ikon notifikasi.
**Android:** Menyetel ikon notifikasi ke myicon
untuk myicon
resource drawable . Jika Anda tidak mengirimkan kunci ini dalam permintaan, FCM akan menampilkan ikon peluncur yang ditentukan dalam manifes aplikasi Anda.
**Web:** URL yang digunakan untuk ikon notifikasi.
**Platform:** Android, Web
Tanda tangan:
icon?: string;
NotifikasiMessagePayload.suara
Suara yang akan diputar saat perangkat menerima notifikasi. Mendukung "default" untuk suara notifikasi default perangkat atau nama file sumber suara yang disertakan dalam aplikasi. File suara harus berada di /res/raw/
.
**Platform:** Android
Tanda tangan:
sound?: string;
NotifikasiMessagePayload.tag
Pengenal digunakan untuk menggantikan notifikasi yang ada di panel samping notifikasi.
Jika tidak ditentukan, setiap permintaan akan membuat notifikasi baru.
Jika ditentukan dan notifikasi dengan tag yang sama sudah ditampilkan, notifikasi baru akan menggantikan notifikasi yang sudah ada di panel samping notifikasi.
**Platform:** Android
Tanda tangan:
tag?: string;
NotifikasiMessagePayload.title
Judul notifikasi.
**Platform:** iOS, Android, Web
Tanda tangan:
title?: string;
NotifikasiMessagePayload.titleLocArgs
Nilai string variabel yang akan digunakan sebagai pengganti penentu format di title_loc_key
yang akan digunakan untuk melokalisasi teks judul ke lokalisasi pengguna saat ini.
Nilainya harus berupa array JSON yang dirangkai.
**iOS:** Sesuai dengan title-loc-args
di payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh Anda untuk informasi lebih lanjut.
**Android:** Lihat Pemformatan dan Gaya untuk informasi selengkapnya.
**Platform:** iOS, Android
Tanda tangan:
titleLocArgs?: string;
NotifikasiMessagePayload.titleLocKey
Kunci string judul dalam sumber daya string aplikasi yang digunakan untuk melokalkan teks judul ke lokalisasi pengguna saat ini.
**iOS:** Sesuai dengan title-loc-key
di payload APN. Lihat Referensi Kunci Payload dan Melokalkan Konten Notifikasi Jarak Jauh Anda untuk informasi lebih lanjut.
**Android:** Lihat Sumber Daya String untuk informasi lebih lanjut.
**Platform:** iOS, Android
Tanda tangan:
titleLocKey?: string;