browser.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

    Masker ikon aplikasi tidak terlihat oleh pengguna Mac OS X.

    URL ke mask 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

    Konten notifikasi alternatif dengan font yang lebih ringan.

  • eventTime

    number 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 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

    number 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

    number opsional

    Progres saat ini berkisar dari 0 hingga 100.

  • requireInteraction

    boolean opsional

    Chrome 50+ browser.* sejak Chrome 148

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

  • senyap

    boolean opsional

    Chrome 70+ browser.* sejak Chrome 148

    Menunjukkan bahwa tidak boleh ada suara atau getaran 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 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, expandedMessage, dan maksimal dua tombol.

"image"
Berisi ikon, judul, pesan, expandedMessage, 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()

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

Menghapus notifikasi yang ditentukan.

Parameter

  • notificationId

    string

    ID notifikasi yang akan dihapus. Ini ditampilkan oleh metode notifications.create.

Hasil

  • Promise<boolean>

    Chrome 116+ browser.* sejak Chrome 148

    Menampilkan Promise yang di-resolve untuk menunjukkan apakah ada notifikasi yang cocok.

create()

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

Membuat dan menampilkan notifikasi.

Parameter

  • notificationId

    string opsional

    ID notifikasi. Jika tidak ditetapkan atau kosong, ID akan otomatis dibuat. Jika cocok dengan notifikasi yang ada, metode ini akan menghapus notifikasi tersebut terlebih dahulu sebelum melanjutkan operasi pembuatan. ID tidak boleh lebih dari 500 karakter.

    Parameter notificationId diperlukan sebelum Chrome 42.

  • Konten notifikasi.

Hasil

  • Promise<string>

    Chrome 116+ browser.* sejak Chrome 148

    Menampilkan Promise yang di-resolve dengan ID notifikasi (yang disediakan atau dibuat) yang mewakili notifikasi yang dibuat.

getAll()

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

Mengambil semua notifikasi aplikasi atau ekstensi ini.

Hasil

  • Promise<object>

    Chrome 116+ browser.* sejak Chrome 148

    Menampilkan Promise yang di-resolve dengan kumpulan notification_id yang saat ini ada dalam sistem.

getPermissionLevel()

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

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

Hasil

  • Promise<PermissionLevel>

    Chrome 116+ browser.* sejak Chrome 148

    Menampilkan Promise yang di-resolve dengan tingkat izin saat ini.

update()

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

Memperbarui notifikasi yang ada.

Parameter

Hasil

  • Promise<boolean>

    Chrome 116+ browser.* sejak Chrome 148

    Menampilkan Promise yang di-resolve untuk menunjukkan apakah ada notifikasi yang cocok.

Acara

onButtonClicked

browser.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

browser.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

browser.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

browser.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
browser.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