chrome.gcm

Deskripsi

Gunakan chrome.gcm untuk mengizinkan aplikasi dan ekstensi mengirim dan menerima pesan melalui Firebase Cloud Messaging (FCM).

Izin

gcm

Properti

MAX_MESSAGE_SIZE

Ukuran maksimum (dalam byte) semua key-value pair dalam pesan.

Nilai

4096

Metode

register()

Janji

chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

Mendaftarkan aplikasi ke FCM. ID pendaftaran akan ditampilkan oleh callback. Jika register dipanggil lagi dengan daftar senderIds yang sama, ID pendaftaran yang sama akan ditampilkan.

Parameter

• senderIds

  string[]

  Daftar ID server yang diizinkan untuk mengirim pesan ke aplikasi. File harus berisi minimal satu dan maksimal 100 ID pengirim.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (registrationId: string) => void

  • registrationId

    string

    ID pendaftaran yang ditetapkan ke aplikasi oleh FCM.

Hasil

• Promise<string>

  Chrome 116+

  Diselesaikan saat pendaftaran selesai.

  Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

send()

Janji

chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

Mengirim pesan sesuai dengan isinya.

Parameter

• pesan

  objek

  Pesan yang akan dikirim ke pihak lain melalui FCM.

  • data

    objek

    Data pesan yang akan dikirim ke server. goog. dan google yang tidak peka huruf besar/kecil, serta collapse_key yang peka huruf besar/kecil tidak diizinkan sebagai awalan kunci. Jumlah semua pasangan kunci/nilai tidak boleh melebihi gcm.MAX_MESSAGE_SIZE.

  • destinationId

    string

    ID server yang akan dikirimi pesan sebagaimana ditetapkan oleh Konsol API Google.

  • messageId

    string

    ID pesan. ID ini harus unik untuk setiap pesan dalam cakupan aplikasi. Lihat dokumentasi Cloud Messaging untuk mengetahui saran dalam memilih dan menangani ID.

  • timeToLive

    nomor opsional

    Time-to-live pesan dalam detik. Jika pesan tidak dapat dikirim dalam jangka waktu tersebut, peristiwa onSendError akan muncul. Time-to-live 0 menunjukkan bahwa pesan harus segera dikirim atau gagal jika tidak memungkinkan. Nilai default time-to-live adalah 86.400 detik (1 hari) dan nilai maksimumnya adalah 2.419.200 detik (28 hari).

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (messageId: string) => void

  • messageId

    string

    ID pesan yang memicu callback.

Hasil

• Promise<string>

  Chrome 116+

  Diselesaikan setelah pesan berhasil dimasukkan dalam antrean untuk dikirim. Jika terjadi error, promise akan ditolak.

  Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

unregister()

Janji

chrome.gcm.unregister(
  callback?: function,
): Promise<void>

Membatalkan pendaftaran aplikasi dari FCM.

Parameter

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

Hasil

• Promise<void>

  Chrome 116+

  Diselesaikan setelah pembatalan pendaftaran selesai. Pembatalan pendaftaran berhasil jika promise tidak ditolak.

  Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

Acara

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

Diaktifkan saat pesan diterima melalui FCM.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (message: object) => void

  • pesan

    objek

    • collapseKey

      string opsional

      Kunci penciutan pesan. Lihat Pesan yang dapat dan tidak dapat diciutkan untuk mengetahui detailnya.

    • data

      objek

      Data pesan.

    • dari

      string opsional

      Pengirim yang mengirimkan pesan.

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

Diaktifkan saat server FCM harus menghapus pesan yang dikirim oleh server aplikasi ke aplikasi. Lihat Masa aktif pesan untuk mengetahui detail tentang cara menangani peristiwa ini.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

Diaktifkan saat pesan tidak dapat dikirim ke server FCM.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (error: object) => void

  • error

    objek

    • detail

      objek

      Detail tambahan terkait error, jika tersedia.

    • errorMessage

      string

      Pesan error yang menjelaskan masalah.

    • messageId

      string opsional

      ID pesan yang mengalami error ini, jika error terkait dengan pesan tertentu.