chrome.notifications

Deskripsi

Gunakan API chrome.notifications untuk membuat notifikasi lengkap menggunakan template dan menampilkan notifikasi ini kepada pengguna di area notifikasi sistem.

Izin

notifications

Jenis

NotificationBitmap

NotificationButton

Properti

  • iconUrl

    string opsional

    Tidak digunakan lagi sejak Chrome 59

    Ikon tombol tidak terlihat oleh pengguna Mac OS X.

  • judul

    string

NotificationItem

Properti

  • pesan

    string

    Detail tambahan tentang item ini.

  • judul

    string

    Judul satu item notifikasi daftar.

NotificationOptions

Properti

  • appIconMaskUrl

    string opsional

    Tidak digunakan lagi sejak Chrome 59

    Masker ikon aplikasi tidak terlihat oleh pengguna Mac OS X.

    URL untuk masker ikon aplikasi. URL memiliki batasan yang sama dengan iconUrl.

    Masker ikon aplikasi harus berada 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

    Ganti konten notifikasi dengan font yang lebih ringan.

  • 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 relatif terhadap resource dalam file .crx ekstensi ini

    **Catatan:**Nilai ini diperlukan untuk metode notifications.create().

  • imageUrl

    string opsional

    Tidak digunakan lagi sejak Chrome 59

    Gambar tidak terlihat oleh pengguna Mac OS X.

    URL ke thumbnail gambar untuk notifikasi jenis gambar. URL memiliki batasan yang sama dengan iconUrl.

  • isClickable

    boolean opsional

    Tidak digunakan lagi sejak Chrome 67

    Petunjuk UI ini diabaikan mulai Chrome 67

  • item

    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

    Prioritas berkisar dari -2 hingga 2. -2 adalah prioritas terendah. 2 adalah yang tertinggi. Nol adalah default. Di platform yang tidak mendukung pusat notifikasi (Windows, Linux & Mac), -2 dan -1 akan 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+

    Menunjukkan bahwa notifikasi harus tetap terlihat di layar hingga pengguna mengaktifkan atau menutup notifikasi. Nilai defaultnya adalah false.

  • senyap

    boolean opsional

    Chrome 70+

    Menunjukkan bahwa tidak ada suara atau getaran yang harus dibuat saat notifikasi ditampilkan. Nilai defaultnya adalah false.

  • judul

    string opsional

    Judul notifikasi (misalnya, nama pengirim untuk email).

    **Catatan:**Nilai ini diperlukan untuk metode notifications.create().

  • jenis

    TemplateType opsional

    Jenis notifikasi yang akan ditampilkan. Diperlukan untuk metode notifications.create.

PermissionLevel

Enum

"granted"
Menentukan bahwa pengguna telah memilih untuk menampilkan notifikasi dari aplikasi atau ekstensi. Ini adalah default saat waktu penginstalan.

"ditolak"
Menentukan bahwa pengguna telah memilih untuk tidak menampilkan notifikasi dari aplikasi atau ekstensi.

TemplateType

Enum

"basic"
Berisi ikon, judul, pesan, expandedMessage, dan hingga dua tombol.

"image"
Berisi ikon, judul, pesan, expandedMessage, gambar, dan hingga dua tombol.

"list"
Berisi ikon, judul, pesan, item, dan hingga dua tombol. Pengguna di Mac OS X hanya melihat item pertama.

"progress"
Berisi ikon, judul, pesan, progres, dan hingga dua tombol.

Metode

clear()

chrome.notifications.clear(
  notificationId: string,
): Promise<boolean>

Menghapus notifikasi yang ditentukan.

Parameter

  • notificationId

    string

    ID notifikasi yang akan dihapus. Nilai ini ditampilkan oleh metode notifications.create.

Hasil

  • Promise<boolean>

    Chrome 116+

create()

chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
): Promise<string>

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 operasi pembuatan. Panjang ID tidak boleh lebih dari 500 karakter.

    Parameter notificationId wajib ada sebelum Chrome 42.

  • Isi notifikasi.

Hasil

  • Promise<string>

    Chrome 116+

getAll()

chrome.notifications.getAll(): Promise<object>

Mengambil semua notifikasi aplikasi atau ekstensi ini.

Hasil

  • Promise<object>

    Chrome 116+

getPermissionLevel()

chrome.notifications.getPermissionLevel(): Promise<PermissionLevel>

Mengambil apakah pengguna telah mengaktifkan notifikasi dari aplikasi atau ekstensi ini.

Hasil

update()

chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): Promise<boolean>

Memperbarui notifikasi yang ada.

Parameter

Hasil

  • Promise<boolean>

    Chrome 116+

Acara

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

Pengguna menekan tombol di 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 area non-tombol pada notifikasi.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (notificationId: string) => void

    • notificationId

      string

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

Notifikasi ditutup, baik oleh sistem maupun oleh 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 tingkat izin. Mulai Chrome 47, hanya ChromeOS yang memiliki UI yang mengirimkan peristiwa ini.

Parameter

onShowSettings

Tidak digunakan lagi sejak Chrome 65
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