chrome.gcm

Deskripsi

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

Izin

gcm

Properti

MAX_MESSAGE_SIZE

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

Nilai

4096

Metode

register()

Promise

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

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. ID pengirim harus berisi setidaknya satu dan tidak lebih dari 100 ID pengirim.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (registrationId: string)=>void

  • registrationId

    string

    ID pendaftaran yang ditetapkan untuk aplikasi oleh FCM.

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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

send()

Promise

chrome.gcm.send(
  message: object,
  callback?: function,
)

Mengirim pesan sesuai dengan kontennya.

Parameter

• pesan

  objek

  Pesan yang akan dikirim ke pihak lain melalui FCM.

  • data

    objek

    Data pesan yang akan dikirimkan ke server. goog. dan google yang tidak peka huruf besar/kecil, serta collapse_key yang peka huruf besar/kecil tidak diizinkan sebagai awalan utama. Jumlah semua key-value pair tidak boleh lebih dari gcm.MAX_MESSAGE_SIZE.

  • destinationId

    string

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

  • messageId

    string

    ID pesan. ID ini harus unik untuk setiap pesan dalam cakupan aplikasi. Lihat dokumentasi Cloud Messaging untuk mendapatkan saran tentang cara 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 yang bernilai 0 menunjukkan bahwa pesan harus dikirim segera atau gagal jika tidak memungkinkan. Nilai default time to live adalah 86.400 detik (1 hari) dan nilai maksimum adalah 2.419.200 detik (28 hari).

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (messageId: string)=>void

  • messageId

    string

    ID pesan yang menerima callback.

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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

unregister()

Promise

chrome.gcm.unregister(
  callback?: function,
)

Membatalkan pendaftaran aplikasi dari FCM.

Parameter

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

Peristiwa

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 tidak dapat diciutkan dan pesan yang dapat diciutkan untuk mengetahui detailnya.

    • data

      objek

      Data pesan.

    • dari

      string opsional

      Pengirim yang mengeluarkan 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 dengan error ini, jika error terkait dengan pesan tertentu.