chrome.notifications

Deskripsi

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

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

    Mask ikon aplikasi tidak terlihat oleh pengguna Mac OS X.

    URL ke mask ikon aplikasi. URL memiliki pembatasan yang sama dengan iconUrl.

    Mask ikon aplikasi harus dalam saluran alfa, karena hanya saluran alfa gambar yang akan dipertimbangkan.

  • tombol

    NotificationButton[] opsional

    Teks dan ikon untuk hingga dua tombol tindakan notifikasi.

  • contextMessage

    string opsional

    Konten notifikasi alternatif dengan font tebal.

  • eventTime

    angka opsional

    Stempel waktu yang terkait dengan notifikasi, dalam milidetik setelah epoch (misalnya, Date.now() + n).

  • iconUrl

    string opsional

    URL ke avatar, ikon aplikasi, atau thumbnail pengirim 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 59

    Gambar tidak terlihat oleh pengguna Mac OS X.

    URL ke thumbnail gambar untuk notifikasi jenis gambar. URL memiliki pembatasan 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 Mac OS X hanya melihat item pertama.

  • pesan

    string opsional

    Konten notifikasi utama.

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

  • prioritas

    angka opsional

    Rentang prioritas adalah -2 hingga 2. -2 adalah prioritas terendah. 2 adalah yang tertinggi. Nol adalah default. Pada platform yang tidak mendukung pusat notifikasi (Windows, Linux & Mac), -2 dan -1 menyebabkan error karena notifikasi dengan prioritas tersebut tidak akan ditampilkan sama sekali.

  • progres

    angka opsional

    Rentang progres saat ini adalah 0 hingga 100.

  • requireInteraction

    boolean opsional

    Chrome 50 dan yang lebih baru

    Menunjukkan bahwa notifikasi harus tetap terlihat di layar sampai pengguna mengaktifkan atau menolak notifikasi. Nilai defaultnya adalah false (salah).

  • senyap

    boolean opsional

    Chrome 70 dan yang lebih baru

    Menunjukkan bahwa tidak boleh ada suara atau getaran yang dihasilkan saat notifikasi ditampilkan. Nilai defaultnya adalah false (salah).

  • judul

    string opsional

    Judul notifikasi (mis. nama pengirim untuk email).

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

  • jenis

    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, diluaskanMessage, dan hingga dua tombol.

"image"
Berisi ikon, judul, pesan, extendedMessage, gambar, dan maksimal dua tombol.

"daftar"
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 maksimal dua tombol.

Metode

clear()

Janji 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

Menghapus notifikasi yang ditentukan.

Parameter

  • notificationId

    string

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

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (wasCleared: boolean) => void

    • wasCleared

      boolean

Hasil

  • Promise<boolean>

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

create()

Janji 
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 otomatis dibuat. Jika cocok dengan notifikasi yang ada, metode ini akan menghapus notifikasi tersebut terlebih dahulu sebelum melanjutkan operasi buat. ID tidak boleh lebih dari 500 karakter.

    Parameter notificationId diperlukan sebelum Chrome 42.

  • Isi notifikasi.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (notificationId: string) => void

    • notificationId

      string

Hasil

  • Promise<string>

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

getAll()

Janji 
chrome.notifications.getAll(
  callback?: function,
)

Mengambil semua notifikasi aplikasi atau ekstensi ini.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (notifications: object) => void

    • notifikasi

      objek

Hasil

  • Promise&lt;object&gt;

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

getPermissionLevel()

Janji 
chrome.notifications.getPermissionLevel(
  callback?: function,
)

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

Parameter

Hasil

  • Promise&lt;PermissionLevel&gt;

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

update()

Janji 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

Memperbarui notifikasi yang ada.

Parameter

  • notificationId

    string

    ID notifikasi yang akan diperbarui. Kolom ini ditampilkan oleh metode notifications.create.

  • Konten notifikasi yang akan diperbarui.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (wasUpdated: boolean) => void

    • wasUpdated

      boolean

Hasil

  • Promise&lt;boolean&gt;

    Chrome 116 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

Acara

onButtonClicked

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

Pengguna menekan tombol di notifikasi.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (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 ini: 

    (notificationId: string) => void

    • notificationId

      string

onClosed

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

Notifikasi ditutup, baik oleh sistem atau tindakan pengguna.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (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 mengirim 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 mengirim peristiwa ini. Mulai Chrome 65, UI tersebut juga telah dihapus dari ChromeOS.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    () => void