AndroidNotification interface

Mewakili opsi notifikasi khusus Android yang dapat disertakan dalam AndroidConfig .

Tanda tangan:

export interface AndroidNotification 

Properti

Properti Jenis Keterangan
tubuh rangkaian Isi notifikasi Android. Jika disediakan, ganti kumpulan isi melalui admin.messaging.Notification .
bodyLocArgs rangkaian[] Serangkaian kunci sumber daya yang akan digunakan sebagai pengganti penentu format di bodyLocKey .
bodyLockKey rangkaian Kunci string isi di sumber daya string aplikasi yang akan digunakan untuk melokalkan teks isi.
saluranId rangkaian ID saluran notifikasi Android (baru di Android O). Aplikasi harus membuat saluran dengan ID saluran ini sebelum pemberitahuan apa pun dengan ID saluran ini dapat diterima. Jika Anda tidak mengirimkan ID saluran ini dalam permintaan, atau jika ID saluran yang diberikan belum dibuat oleh aplikasi, FCM akan menggunakan ID saluran yang ditentukan dalam manifes aplikasi.
klikAksi rangkaian Tindakan yang terkait dengan pengguna mengklik notifikasi. Jika ditentukan, aktivitas dengan Filter Intent yang cocok akan diluncurkan saat pengguna mengklik notifikasi.
warna rangkaian Warna ikon notifikasi dalam format #rrggbb .
pengaturan cahaya default boolean Jika disetel ke true , gunakan setelan lampu LED default framework Android untuk notifikasi. Nilai default ditentukan di config.xml . Jika default_light_settings disetel ke true dan light_settings juga disetel, light_settings yang ditentukan pengguna akan digunakan sebagai pengganti nilai default.
suara default boolean Jika disetel ke true , gunakan suara default framework Android untuk notifikasi. Nilai default ditentukan di config.xml .
defaultVibrateTimings boolean Jika disetel ke true , gunakan pola getar default framework Android untuk notifikasi. Nilai default ditentukan di config.xml . Jika default_vibrate_timings disetel ke true dan vibrate_timings juga disetel, nilai default akan digunakan, bukan vibrate_timings yang ditentukan pengguna.
stempel waktu acara Tanggal Untuk notifikasi yang memberi tahu pengguna tentang peristiwa dengan referensi waktu absolut, setel waktu terjadinya peristiwa dalam notifikasi. Notifikasi di panel diurutkan berdasarkan waktu ini.
ikon rangkaian Sumber daya ikon untuk notifikasi Android.
imageUrl rangkaian URL gambar yang akan ditampilkan di notifikasi.
pengaturan cahaya Pengaturan Cahaya Pengaturan untuk mengontrol kecepatan dan warna kedipan LED notifikasi jika LED tersedia di perangkat. Total waktu berkedip dikontrol oleh OS.
Hanya lokal boolean Menyetel apakah notifikasi ini hanya relevan pada perangkat saat ini atau tidak. Beberapa notifikasi dapat dihubungkan ke perangkat lain untuk tampilan jarak jauh, seperti jam tangan Wear OS. Petunjuk ini dapat diatur untuk merekomendasikan agar notifikasi ini tidak dijembatani. Lihat panduan Wear OS .
jumlah notifikasi nomor Menetapkan jumlah item yang diwakili oleh notifikasi ini. Dapat ditampilkan sebagai jumlah lencana untuk Peluncur yang mendukung pemberian lencana. Lihat Lencana Pemberitahuan . Misalnya, ini mungkin berguna jika Anda hanya menggunakan satu notifikasi untuk mewakili beberapa pesan baru, namun Anda ingin penghitungan di sini mewakili jumlah total pesan baru. Jika nol atau tidak ditentukan, sistem yang mendukung badge menggunakan default, yaitu menambah angka yang ditampilkan pada menu tekan lama setiap kali ada notifikasi baru yang masuk.
prioritas ('min' | 'rendah' ​​| 'default' | 'tinggi' | 'maks') Menetapkan prioritas relatif untuk notifikasi ini. Notifikasi berprioritas rendah mungkin disembunyikan dari pengguna dalam situasi tertentu. Perhatikan bahwa prioritas ini berbeda dengan AndroidMessagePriority . Prioritas ini diproses oleh klien setelah pesan terkirim. Sedangkan AndroidMessagePriority merupakan konsep FCM yang mengontrol kapan pesan terkirim.
suara rangkaian Nama file suara yang akan diputar saat perangkat menerima notifikasi.
lengket boolean Jika disetel ke false atau tidak disetel, notifikasi otomatis ditutup saat pengguna mengkliknya di panel. Jika disetel ke true , notifikasi tetap ada meskipun pengguna mengkliknya.
menandai rangkaian Tag pemberitahuan. Ini adalah pengidentifikasi yang digunakan untuk menggantikan notifikasi yang ada di panel samping notifikasi. Jika tidak ditentukan, setiap permintaan akan membuat notifikasi baru.
jantung rangkaian Menyetel teks "ticker", yang dikirim ke layanan aksesibilitas. Sebelum API level 21 (Lollipop), menyetel teks yang ditampilkan di bilah status saat notifikasi pertama kali masuk.
judul rangkaian Judul notifikasi Android. Jika disediakan, ganti judul yang disetel melalui admin.messaging.Notification .
judulLocArgs rangkaian[] Serangkaian kunci sumber daya yang akan digunakan sebagai pengganti penentu format di titleLocKey .
judulLocKey rangkaian Kunci string judul di sumber daya string aplikasi yang digunakan untuk melokalkan teks judul.
getarTimingsMillis nomor[] Mengatur pola getaran yang akan digunakan. Masukkan serangkaian milidetik untuk menghidupkan atau mematikan vibrator. Nilai pertama menunjukkan durasi menunggu sebelum menyalakan vibrator. Nilai berikutnya menunjukkan durasi vibrator tetap menyala. Nilai berikutnya bergantian antara durasi untuk mematikan vibrator dan menghidupkan vibrator. Jika vibrate_timings disetel dan default_vibrate_timings disetel ke true , nilai default akan digunakan, bukan vibrate_timings yang ditentukan pengguna.
visibilitas ('pribadi' | 'publik' | 'rahasia') Mengatur visibilitas notifikasi. Harus bersifat private , public , atau secret . Jika tidak ditentukan, defaultnya adalah private .

AndroidNotification.body

Isi notifikasi Android. Jika disediakan, ganti kumpulan isi melalui admin.messaging.Notification .

Tanda tangan:

body?: string;

AndroidNotification.bodyLocArgs

Serangkaian kunci sumber daya yang akan digunakan sebagai pengganti penentu format di bodyLocKey .

Tanda tangan:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

Kunci string isi di sumber daya string aplikasi yang akan digunakan untuk melokalkan teks isi.

Tanda tangan:

bodyLocKey?: string;

AndroidNotification.channelId

ID saluran notifikasi Android (baru di Android O). Aplikasi harus membuat saluran dengan ID saluran ini sebelum pemberitahuan apa pun dengan ID saluran ini dapat diterima. Jika Anda tidak mengirimkan ID saluran ini dalam permintaan, atau jika ID saluran yang diberikan belum dibuat oleh aplikasi, FCM akan menggunakan ID saluran yang ditentukan dalam manifes aplikasi.

Tanda tangan:

channelId?: string;

AndroidNotification.clickAction

Tindakan yang terkait dengan pengguna mengklik notifikasi. Jika ditentukan, aktivitas dengan Filter Intent yang cocok akan diluncurkan saat pengguna mengklik notifikasi.

Tanda tangan:

clickAction?: string;

AndroidNotification.color

Warna ikon notifikasi dalam format #rrggbb .

Tanda tangan:

color?: string;

AndroidNotification.defaultLightSettings

Jika disetel ke true , gunakan pengaturan lampu LED default framework Android untuk notifikasi. Nilai default ditentukan di config.xml . Jika default_light_settings disetel ke true dan light_settings juga disetel, light_settings yang ditentukan pengguna akan digunakan sebagai pengganti nilai default.

Tanda tangan:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

Jika disetel ke true , gunakan suara default framework Android untuk notifikasi. Nilai default ditentukan di config.xml .

Tanda tangan:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

Jika disetel ke true , gunakan pola getar default framework Android untuk notifikasi. Nilai default ditentukan di config.xml . Jika default_vibrate_timings disetel ke true dan vibrate_timings juga disetel, nilai default akan digunakan, bukan vibrate_timings yang ditentukan pengguna .

Tanda tangan:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

Untuk notifikasi yang memberi tahu pengguna tentang peristiwa dengan referensi waktu absolut, setel waktu terjadinya peristiwa dalam notifikasi. Notifikasi di panel diurutkan berdasarkan waktu ini.

Tanda tangan:

eventTimestamp?: Date;

AndroidNotification.icon

Sumber daya ikon untuk notifikasi Android.

Tanda tangan:

icon?: string;

AndroidNotification.imageUrl

URL gambar yang akan ditampilkan di notifikasi.

Tanda tangan:

imageUrl?: string;

AndroidNotification.lightSettings

Pengaturan untuk mengontrol kecepatan dan warna kedipan LED notifikasi jika LED tersedia di perangkat. Total waktu berkedip dikontrol oleh OS.

Tanda tangan:

lightSettings?: LightSettings;

AndroidNotification.localOnly

Menyetel apakah notifikasi ini hanya relevan pada perangkat saat ini atau tidak. Beberapa notifikasi dapat dihubungkan ke perangkat lain untuk tampilan jarak jauh, seperti jam tangan Wear OS. Petunjuk ini dapat diatur untuk merekomendasikan agar notifikasi ini tidak dijembatani. Lihat panduan Wear OS .

Tanda tangan:

localOnly?: boolean;

AndroidNotification.notificationCount

Menetapkan jumlah item yang diwakili oleh notifikasi ini. Dapat ditampilkan sebagai jumlah lencana untuk Peluncur yang mendukung pemberian lencana. Lihat Lencana Pemberitahuan . Misalnya, ini mungkin berguna jika Anda hanya menggunakan satu notifikasi untuk mewakili beberapa pesan baru, namun Anda ingin penghitungan di sini mewakili jumlah total pesan baru. Jika nol atau tidak ditentukan, sistem yang mendukung badge menggunakan default, yaitu menambah angka yang ditampilkan pada menu tekan lama setiap kali ada notifikasi baru yang masuk.

Tanda tangan:

notificationCount?: number;

AndroidNotification.prioritas

Menetapkan prioritas relatif untuk notifikasi ini. Notifikasi berprioritas rendah mungkin disembunyikan dari pengguna dalam situasi tertentu. Perhatikan bahwa prioritas ini berbeda dengan AndroidMessagePriority . Prioritas ini diproses oleh klien setelah pesan terkirim. Sedangkan AndroidMessagePriority merupakan konsep FCM yang mengontrol kapan pesan terkirim.

Tanda tangan:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.suara

Nama file suara yang akan diputar saat perangkat menerima notifikasi.

Tanda tangan:

sound?: string;

AndroidNotification.sticky

Jika disetel ke false atau tidak disetel, notifikasi otomatis ditutup saat pengguna mengkliknya di panel. Jika disetel ke true , notifikasi tetap ada meskipun pengguna mengkliknya.

Tanda tangan:

sticky?: boolean;

AndroidNotification.tag

Tag pemberitahuan. Ini adalah pengidentifikasi yang digunakan untuk menggantikan notifikasi yang ada di panel samping notifikasi. Jika tidak ditentukan, setiap permintaan akan membuat notifikasi baru.

Tanda tangan:

tag?: string;

AndroidNotification.ticker

Menyetel teks "ticker", yang dikirim ke layanan aksesibilitas. Sebelum API level 21 (Lollipop), menyetel teks yang ditampilkan di bilah status saat notifikasi pertama kali masuk.

Tanda tangan:

ticker?: string;

AndroidNotification.judul

Judul notifikasi Android. Jika disediakan, ganti kumpulan judul melalui admin.messaging.Notification .

Tanda tangan:

title?: string;

AndroidNotification.titleLocArgs

Serangkaian kunci sumber daya yang akan digunakan sebagai pengganti penentu format di titleLocKey .

Tanda tangan:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

Kunci string judul di sumber daya string aplikasi yang digunakan untuk melokalkan teks judul.

Tanda tangan:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

Mengatur pola getaran yang akan digunakan. Masukkan serangkaian milidetik untuk menghidupkan atau mematikan vibrator. Nilai pertama menunjukkan durasi menunggu sebelum menyalakan vibrator. Nilai berikutnya menunjukkan durasi vibrator tetap menyala. Nilai berikutnya bergantian antara durasi untuk mematikan vibrator dan menghidupkan vibrator. Jika vibrate_timings disetel dan default_vibrate_timings disetel ke true , nilai default digunakan sebagai pengganti vibrate_timings yang ditentukan pengguna .

Tanda tangan:

vibrateTimingsMillis?: number[];

AndroidNotification.visibilitas

Mengatur visibilitas notifikasi. Harus bersifat private , public , atau secret . Jika tidak ditentukan, defaultnya adalah private .

Tanda tangan:

visibility?: ('private' | 'public' | 'secret');