AndroidNotification interface

Merepresentasikan opsi notifikasi khusus Android yang dapat disertakan dalam AndroidConfig.

Tanda Tangan:

export interface AndroidNotification

Properti

Properti Jenis Deskripsi
isi string Isi notifikasi Android. Jika disediakan, mengganti isi yang ditetapkan melalui admin.messaging.Notification.
bodyLocArgs {i>string<i}[] Array kunci resource yang akan digunakan sebagai pengganti penentu format di bodyLocKey.
bodyLocKey string Kunci string isi dalam resource string aplikasi yang akan digunakan untuk melokalkan teks isi.
channelId string ID saluran notifikasi Android (baru di Android O). Aplikasi harus membuat saluran dengan ID saluran ini sebelum notifikasi dengan ID saluran ini dapat diterima. Jika Anda tidak mengirim ID saluran ini dalam permintaan, atau jika ID saluran yang disediakan belum dibuat oleh aplikasi, FCM akan menggunakan ID saluran yang ditentukan dalam manifes aplikasi.
clickAction string Tindakan yang terkait dengan klik pengguna pada notifikasi. Jika ditentukan, aktivitas dengan Filter Intent yang cocok akan diluncurkan ketika pengguna mengklik notifikasi.
warna string Warna ikon notifikasi dalam format #rrggbb.
defaultLightSettings boolean Jika disetel ke true, gunakan setelan lampu LED default framework Android untuk notifikasi. Nilai default ditentukan dalam config.xml. Jika default_light_settings ditetapkan ke true dan light_settings juga ditetapkan, light_settings yang ditentukan pengguna akan digunakan, bukan nilai default.
Suara default boolean Jika disetel ke true, gunakan suara default framework Android untuk notifikasi. Nilai default ditentukan dalam config.xml.
defaultGetTimings boolean Jika disetel ke true, gunakan pola getar default framework Android untuk notifikasi. Nilai default ditentukan dalam config.xml. Jika default_vibrate_timings ditetapkan ke true dan vibrate_timings juga ditetapkan, nilai default akan digunakan, bukan vibrate_timings yang ditentukan pengguna.
eventStempel Waktu Tanggal Untuk notifikasi yang memberi tahu pengguna tentang peristiwa dengan referensi waktu absolut, menetapkan waktu terjadinya peristiwa dalam notifikasi tersebut. Notifikasi di panel diurutkan menurut waktu ini.
ikon string Resource ikon untuk notifikasi Android.
URL gambar string URL gambar yang akan ditampilkan di notifikasi.
lightSettings Setelan Cahaya Setelan untuk mengontrol warna dan tingkat kedipan LED notifikasi jika LED tersedia di perangkat. Total waktu kedipan dikontrol oleh OS.
localOnly boolean Menetapkan apakah notifikasi ini hanya relevan untuk perangkat saat ini atau tidak. Beberapa notifikasi dapat dihubungkan ke perangkat lain untuk tampilan jarak jauh, seperti smartwatch Wear OS. Petunjuk ini dapat disetel agar notifikasi ini tidak dihubungkan. Lihat panduan Wear OS.
jumlahnotifikasi angka Menetapkan jumlah item yang diwakili oleh notifikasi ini. Dapat ditampilkan sebagai jumlah badge untuk Peluncur yang mendukung badge. Lihat NotificationBadge. Misalnya, hal ini mungkin berguna jika Anda hanya menggunakan satu notifikasi untuk merepresentasikan beberapa pesan baru, tetapi Anda ingin penghitungan di sini mewakili jumlah total pesan baru. Jika nol atau tidak ditentukan, sistem yang mendukung badge akan menggunakan setelan default, yaitu menaikkan angka yang ditampilkan pada menu tekan lama setiap kali notifikasi baru masuk.
prioritas ('min' | 'rendah' | 'default' | 'tinggi' | 'maks') Menetapkan prioritas relatif untuk notifikasi ini. Notifikasi prioritas rendah mungkin disembunyikan dari pengguna dalam situasi tertentu. Perlu diperhatikan bahwa prioritas ini berbeda dengan AndroidMessagePriority. Prioritas ini diproses oleh klien setelah pesan dikirim. Sedangkan AndroidMessagePriority adalah konsep FCM yang mengontrol kapan pesan dikirimkan.
suara string Nama file suara yang akan diputar saat perangkat menerima notifikasi.
melekat boolean Jika disetel ke false atau tidak disetel, notifikasi akan otomatis ditutup saat pengguna mengkliknya di panel. Jika disetel ke true, notifikasi akan tetap ada bahkan saat pengguna mengkliknya.
tag string Tag notifikasi. Ini adalah ID yang digunakan untuk menggantikan notifikasi yang ada di panel samping notifikasi. Jika tidak ditentukan, setiap permintaan akan membuat notifikasi baru.
ticker string Menetapkan "ticker" Teks, yang dikirim ke layanan aksesibilitas. Sebelum API level 21 (Lollipop), menyetel teks yang ditampilkan di bilah status saat notifikasi pertama kali masuk.
title string Judul notifikasi Android. Jika disediakan, judul akan diganti melalui admin.messaging.Notification.
titleLocArgs {i>string<i}[] Array kunci resource yang akan digunakan sebagai pengganti penentu format di titleLocKey.
titleLocKey string Kunci string judul dalam resource string aplikasi yang akan digunakan untuk melokalkan teks judul.
vibrateTimingsMillis angka[] Menyetel pola getaran yang akan digunakan. Teruskan array milidetik untuk mengaktifkan atau menonaktifkan vibrator. Nilai pertama menunjukkan durasi tunggu sebelum mengaktifkan vibrator. Nilai berikutnya menunjukkan durasi untuk membuat vibrator tetap aktif. Nilai berikutnya bergantian antara durasi untuk menonaktifkan vibrator dan mengaktifkan vibrator. Jika vibrate_timings ditetapkan dan default_vibrate_timings ditetapkan ke true, nilai default akan digunakan, bukan vibrate_timings yang ditentukan pengguna.
visibilitas ('private' | 'publik' | 'rahasia') Menetapkan visibilitas notifikasi. Harus private, public, atau secret. Jika tidak ditentukan, defaultnya adalah private.

AndroidNotification.body

Isi notifikasi Android. Jika disediakan, mengganti isi yang ditetapkan melalui admin.messaging.Notification.

Tanda Tangan:

body?: string;

AndroidNotification.bodyLocArgs

Array kunci resource yang akan digunakan sebagai pengganti penentu format di bodyLocKey.

Tanda Tangan:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

Kunci string isi dalam resource 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 notifikasi dengan ID saluran ini dapat diterima. Jika Anda tidak mengirim ID saluran ini dalam permintaan, atau jika ID saluran yang disediakan belum dibuat oleh aplikasi, FCM akan menggunakan ID saluran yang ditentukan dalam manifes aplikasi.

Tanda Tangan:

channelId?: string;

AndroidNotification.clickAction

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

Tanda Tangan:

clickAction?: string;

AndroidNotification.color

Warna ikon notifikasi dalam format #rrggbb.

Tanda Tangan:

color?: string;

AndroidNotification.defaultLightSettings

Jika ditetapkan ke true, gunakan setelan lampu LED default framework Android untuk notifikasi. Nilai default ditentukan dalam config.xml. Jika default_light_settings ditetapkan ke true dan light_settings juga ditetapkan, light_settings yang ditentukan pengguna akan digunakan, bukan nilai default.

Tanda Tangan:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

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

Tanda Tangan:

defaultSound?: boolean;

AndroidNotification.defaultGetTimings

Jika disetel ke true, gunakan pola getar default framework Android untuk notifikasi. Nilai default ditentukan dalam config.xml. Jika default_vibrate_timings ditetapkan ke true dan vibrate_timings juga ditetapkan, nilai default yang 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, menetapkan waktu terjadinya peristiwa dalam notifikasi tersebut. Notifikasi di panel diurutkan menurut waktu ini.

Tanda Tangan:

eventTimestamp?: Date;

AndroidNotification.icon

Resource ikon untuk notifikasi Android.

Tanda Tangan:

icon?: string;

AndroidNotification.imageUrl

URL gambar yang akan ditampilkan di notifikasi.

Tanda Tangan:

imageUrl?: string;

AndroidNotification.lightSettings

Setelan untuk mengontrol warna dan tingkat kedipan LED notifikasi jika LED tersedia di perangkat. Total waktu kedipan dikontrol oleh OS.

Tanda Tangan:

lightSettings?: LightSettings;

AndroidNotification.localOnly

Menetapkan apakah notifikasi ini hanya relevan untuk perangkat saat ini atau tidak. Beberapa notifikasi dapat dihubungkan ke perangkat lain untuk tampilan jarak jauh, seperti smartwatch Wear OS. Petunjuk ini dapat disetel agar notifikasi ini tidak dihubungkan. Lihat panduan Wear OS.

Tanda Tangan:

localOnly?: boolean;

AndroidNotification.notificationCount

Menetapkan jumlah item yang diwakili oleh notifikasi ini. Dapat ditampilkan sebagai jumlah badge untuk Peluncur yang mendukung badge. Lihat NotificationBadge. Misalnya, hal ini mungkin berguna jika Anda hanya menggunakan satu notifikasi untuk merepresentasikan beberapa pesan baru, tetapi Anda ingin penghitungan di sini mewakili jumlah total pesan baru. Jika nol atau tidak ditentukan, sistem yang mendukung badge akan menggunakan setelan default, yaitu menaikkan angka yang ditampilkan pada menu tekan lama setiap kali notifikasi baru masuk.

Tanda Tangan:

notificationCount?: number;

AndroidNotification.priority

Menetapkan prioritas relatif untuk notifikasi ini. Notifikasi prioritas rendah mungkin disembunyikan dari pengguna dalam situasi tertentu. Perlu diperhatikan bahwa prioritas ini berbeda dengan AndroidMessagePriority. Prioritas ini diproses oleh klien setelah pesan dikirim. Sedangkan AndroidMessagePriority adalah konsep FCM yang mengontrol kapan pesan dikirimkan.

Tanda Tangan:

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

AndroidNotification.sound

Nama file suara yang akan diputar saat perangkat menerima notifikasi.

Tanda Tangan:

sound?: string;

AndroidNotification.sticky

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

Tanda Tangan:

sticky?: boolean;

AndroidNotification.tag

Tag notifikasi. Ini adalah ID 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

Menetapkan "ticker" Teks, 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.title

Judul notifikasi Android. Jika disediakan, judul akan diganti melalui admin.messaging.Notification.

Tanda Tangan:

title?: string;

AndroidNotification.titleLocArgs

Array kunci resource yang akan digunakan sebagai pengganti penentu format di titleLocKey.

Tanda Tangan:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

Kunci string judul dalam resource string aplikasi yang akan digunakan untuk melokalkan teks judul.

Tanda Tangan:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

Menyetel pola getaran yang akan digunakan. Teruskan array milidetik untuk mengaktifkan atau menonaktifkan vibrator. Nilai pertama menunjukkan durasi tunggu sebelum mengaktifkan vibrator. Nilai berikutnya menunjukkan durasi untuk membuat vibrator tetap aktif. Nilai berikutnya bergantian antara durasi untuk menonaktifkan vibrator dan mengaktifkan vibrator. Jika vibrate_timings ditetapkan dan default_vibrate_timings ditetapkan ke true, nilai default yang akan digunakan, bukan vibrate_timings yang ditentukan pengguna.

Tanda Tangan:

vibrateTimingsMillis?: number[];

AndroidNotification.visibilitas

Menetapkan visibilitas notifikasi. Harus berupa private, public, atau secret. Jika tidak ditentukan, defaultnya adalah private.

Tanda Tangan:

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