Deskripsi
Gunakan chrome.notifications
API untuk membuat notifikasi lengkap menggunakan template dan menampilkan notifikasi ini kepada pengguna di baki sistem.
Izin
notifications
Jenis
NotificationBitmap
NotificationButton
Properti
-
iconUrl
string opsional
Tidak digunakan lagi sejak Chrome 59Ikon tombol tidak terlihat oleh pengguna Mac OS X.
-
title
string
NotificationItem
Properti
-
pesan
string
Detail tambahan tentang item ini.
-
title
string
Judul satu item notifikasi daftar.
NotificationOptions
Properti
-
appIconMaskUrl
string opsional
Tidak digunakan lagi sejak Chrome 59Mask ikon aplikasi tidak terlihat oleh pengguna Mac OS X.
URL ke mask ikon aplikasi. URL memiliki pembatasan yang sama seperti iconUrl.
Mask ikon aplikasi harus ada di saluran alfa, karena hanya saluran alfa gambar yang akan dipertimbangkan.
-
tombol
NotificationButton[] opsional
Teks dan ikon untuk maksimal dua tombol tindakan notifikasi.
-
contextMessage
string opsional
Konten notifikasi alternatif dengan font berbobot lebih rendah.
-
eventTime
nomor opsional
Stempel waktu yang terkait dengan notifikasi, dalam milidetik setelah epoch (misalnya,
Date.now() + n
). -
iconUrl
string opsional
URL ke avatar pengirim, ikon aplikasi, atau thumbnail untuk notifikasi gambar.
URL dapat berupa URL data, URL blob, atau URL yang terkait dengan resource dalam file .crx ekstensi ini
**Catatan:**Nilai ini diperlukan untuk metode
notifications.create
()
. -
imageUrl
string opsional
Tidak digunakan lagi sejak Chrome 59Gambar tidak terlihat untuk pengguna Mac OS X.
URL ke thumbnail gambar untuk notifikasi jenis gambar. URL memiliki pembatasan yang sama seperti iconUrl.
-
isClickable
boolean opsional
Tidak digunakan lagi sejak Chrome 67Petunjuk UI ini diabaikan mulai Chrome 67
-
items
NotificationItem[] opsional
Item untuk notifikasi multi-item. Pengguna di Mac OS X hanya melihat item pertama.
-
pesan
string opsional
Konten notifikasi utama.
**Catatan:**Nilai ini diperlukan untuk metode
notifications.create
()
. -
prioritas
nomor opsional
Rentang prioritas dari -2 sampai 2. -2 adalah prioritas terendah. 2 adalah yang tertinggi. Nol secara default. Pada platform yang tidak mendukung pusat notifikasi (Windows, Linux & Mac), -2 dan -1 menghasilkan error karena notifikasi dengan prioritas tersebut tidak akan ditampilkan sama sekali.
-
progres
nomor opsional
Progres saat ini berkisar dari 0 hingga 100.
-
requireInteraction
boolean opsional
Chrome 50 dan yang lebih baruMenunjukkan bahwa notifikasi harus tetap terlihat di layar hingga pengguna mengaktifkan atau menolak notifikasi. Nilai defaultnya adalah salah (false).
-
senyap
boolean opsional
Chrome 70 dan yang lebih baruMenunjukkan bahwa tidak ada suara atau getaran yang harus dibuat saat notifikasi ditampilkan. Nilai defaultnya adalah salah (false).
-
title
string opsional
Judul notifikasi (misalnya nama pengirim untuk email).
**Catatan:**Nilai ini diperlukan untuk metode
notifications.create
()
. -
tipe
TemplateType opsional
Jenis notifikasi yang akan ditampilkan. Wajib untuk metode
notifications.create
.
PermissionLevel
Enum
"granted"
Menentukan bahwa pengguna telah memilih untuk menampilkan notifikasi dari aplikasi atau ekstensi. Ini adalah setelan default pada waktu penginstalan.
"denied"
Menentukan bahwa pengguna telah memilih untuk tidak menampilkan notifikasi dari aplikasi atau ekstensi.
TemplateType
Enum
"basic"
Berisi ikon, judul, pesan, extendedMessage, dan maksimal dua tombol.
"image"
Berisi ikon, judul, pesan, extendedMessage, gambar, dan maksimal dua tombol.
"list"
Berisi ikon, judul, pesan, item, dan maksimal dua tombol. Pengguna di Mac OS X hanya melihat item pertama.
"progress"
Berisi ikon, judul, pesan, progres, dan maksimal dua tombol.
Metode
clear()
chrome.notifications.clear(
notificationId: string,
callback?: function,
)
Menghapus notifikasi tertentu.
Parameter
-
notificationId
string
ID notifikasi yang akan dihapus. Ini ditampilkan oleh metode
notifications.create
. -
callback
fungsi opsional
Parameter
callback
terlihat seperti:(wasCleared: boolean) => void
-
wasCleared
boolean
-
Hasil
-
Promise<boolean>
Chrome 116 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
create()
chrome.notifications.create(
notificationId?: string,
options: NotificationOptions,
callback?: function,
)
Membuat dan menampilkan notifikasi.
Parameter
-
notificationId
string opsional
ID notifikasi. Jika tidak disetel atau kosong, ID akan dibuat secara otomatis. Jika cocok dengan notifikasi yang ada, metode ini akan menghapus notifikasi tersebut terlebih dahulu sebelum melanjutkan dengan operasi pembuatan. ID tidak boleh lebih dari 500 karakter.
Parameter
notificationId
diperlukan sebelum Chrome 42. -
opsi
Konten notifikasi.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(notificationId: string) => void
-
notificationId
string
-
Hasil
-
Promise<string>
Chrome 116 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
getAll()
chrome.notifications.getAll(
callback?: function,
)
Mengambil semua notifikasi aplikasi atau ekstensi ini.
Parameter
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(notifications: object) => void
-
notifikasi
objek
-
Hasil
-
Promise<object>
Chrome 116 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
getPermissionLevel()
chrome.notifications.getPermissionLevel(
callback?: function,
)
Mengambil apakah pengguna telah mengaktifkan notifikasi dari aplikasi atau ekstensi ini.
Parameter
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(level: PermissionLevel) => void
-
yaitu tingkat klik
-
Hasil
-
Promise<PermissionLevel>
Chrome 116 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
update()
chrome.notifications.update(
notificationId: string,
options: NotificationOptions,
callback?: function,
)
Memperbarui notifikasi yang ada.
Parameter
-
notificationId
string
ID notifikasi yang akan diperbarui. Ini ditampilkan oleh metode
notifications.create
. -
opsi
Konten notifikasi yang akan diperbarui.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(wasUpdated: boolean) => void
-
wasUpdated
boolean
-
Hasil
-
Promise<boolean>
Chrome 116 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
Acara
onButtonClicked
chrome.notifications.onButtonClicked.addListener(
callback: function,
)
Pengguna menekan tombol dalam notifikasi.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(notificationId: string, buttonIndex: number) => void
-
notificationId
string
-
buttonIndex
angka
-
onClicked
chrome.notifications.onClicked.addListener(
callback: function,
)
Pengguna mengklik di area non-tombol notifikasi.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(notificationId: string) => void
-
notificationId
string
-
onClosed
chrome.notifications.onClosed.addListener(
callback: function,
)
Notifikasi ditutup oleh sistem atau tindakan pengguna.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(notificationId: string, byUser: boolean) => void
-
notificationId
string
-
byUser
boolean
-
onPermissionLevelChanged
chrome.notifications.onPermissionLevelChanged.addListener(
callback: function,
)
Pengguna mengubah level izin. Mulai Chrome 47, hanya ChromeOS yang memiliki UI yang mengirimkan peristiwa ini.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(level: PermissionLevel) => void
-
yaitu tingkat klik
-
onShowSettings
chrome.notifications.onShowSettings.addListener(
callback: function,
)
Tombol setelan notifikasi kustom tidak lagi didukung.
Pengguna mengklik link untuk setelan notifikasi aplikasi. Mulai Chrome 47, hanya ChromeOS yang memiliki UI yang mengirimkan peristiwa ini. Mulai Chrome 65, UI tersebut juga telah dihapus dari ChromeOS.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:() => void