chrome.gcm

Deskripsi

Gunakan chrome.gcm untuk mengaktifkan aplikasi dan ekstensi guna 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,
)

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

Parameter

  • senderIds

    {i>string<i}[]

    Daftar ID server yang diizinkan untuk mengirim pesan ke aplikasi. ID pengirim harus berisi minimal satu dan tidak lebih dari 100 ID pengirim.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    (registrationId: string) => void

    • registrationId

      string

      ID pendaftaran yang ditetapkan ke aplikasi oleh FCM.

Hasil

  • Promise<string>

    Chrome 116 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

send()

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

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 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 dalam memilih dan menangani ID.

    • timeToLive

      angka opsional

      Waktu aktif pesan dalam hitungan detik. Jika pesan tidak dapat dikirim dalam jangka waktu tersebut, peristiwa onSendError akan dimunculkan. Time-to-live yang bernilai 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 ini:

    (messageId: string) => void

    • messageId

      string

      ID pesan yang menerima callback.

Hasil

  • Promise<string>

    Chrome 116 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

unregister()

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

Membatalkan pendaftaran aplikasi dari FCM.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    () => void

Hasil

  • Janji<void>

    Chrome 116 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

Acara

onMessage

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

Diaktifkan saat pesan diterima melalui FCM.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini:

    (message: object) => void

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

    () => void

onSendError

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

Diaktifkan jika pesan tidak dapat dikirim ke server FCM.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini:

    (error: object) => void

    • error

      objek

      • detail

        objek

        Detail tambahan yang terkait dengan error, jika tersedia.

      • errorMessage

        string

        Pesan error yang menjelaskan masalah.

      • messageId

        string opsional

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