browser.gcm

Açıklama

Uygulamaların ve uzantıların Firebase Cloud Messaging (FCM) üzerinden mesaj gönderip almasını sağlamak için chrome.gcm politikasını kullanın.

İzinler

gcm

Özellikler

MAX_MESSAGE_SIZE

Bir mesajdaki tüm anahtar/değer çiftlerinin maksimum boyutu (bayt cinsinden).

Değer

4096

Yöntemler

register()

browser.gcm.register(
  senderIds: string[],
): Promise<string>

Uygulamayı FCM'ye kaydeder. Kayıt kimliği callback tarafından döndürülür. register aynı senderIds listesiyle tekrar çağrılırsa aynı kayıt kimliği döndürülür.

Parametreler

• senderIds

  string[]

  Uygulamaya mesaj göndermesine izin verilen sunucu kimliklerinin listesi. En az bir, en fazla 100 gönderen kimliği içermelidir.

İadeler

• Promise<string>

  Chrome 116 ve sonraki sürümler Chrome 148'den itibaren browser.*

  Kayıt tamamlandığında çözümlenir.

send()

browser.gcm.send(
  message: object,
): Promise<string>

İçeriğine göre mesaj gönderir.

Parametreler

• mesaj

  nesne

  FCM üzerinden diğer tarafa gönderilecek mesaj.

  • veri

    nesne

    Sunucuya gönderilecek mesaj verileri. Büyük/küçük harfe duyarlı olmayan goog. ve google ile büyük/küçük harfe duyarlı collapse_key, anahtar ön ekleri olarak kullanılamaz. Tüm anahtar/değer çiftlerinin toplamı gcm.MAX_MESSAGE_SIZE değerini aşmamalıdır.

  • destinationId

    dize

    Mesajın gönderileceği sunucunun Google API Konsolu tarafından atanan kimliği.

  • messageId

    dize

    Mesajın kimliği. Uygulamalar kapsamındaki her mesaj için benzersiz olmalıdır. Kimlik seçme ve işleme ile ilgili öneriler için Cloud Messaging belgelerini inceleyin.

  • timeToLive

    number isteğe bağlı

    Mesajın saniye cinsinden geçerlilik süresi. İletinin bu süre içinde gönderilmesi mümkün değilse onSendError etkinliği tetiklenir. 0 değerindeki bir yaşam süresi, mesajın hemen gönderilmesi gerektiğini veya mümkün değilse başarısız olması gerektiğini gösterir. Geçerlilik süresinin varsayılan değeri 86.400 saniye (1 gün), maksimum değeri ise 2.419.200 saniyedir (28 gün).

İadeler

• Promise<string>

  Chrome 116 ve sonraki sürümler Chrome 148'den itibaren browser.*

  Mesaj, gönderilmek üzere başarıyla sıraya alındıktan sonra çözümlenir. Hata oluşursa promise reddedilir.

unregister()

browser.gcm.unregister(): Promise<void>

Uygulamanın FCM kaydını iptal eder.

İadeler

• Promise<void>

  Chrome 116 ve sonraki sürümler Chrome 148'den itibaren browser.*

  Kaydı iptal etme işlemi tamamlandıktan sonra çözümlenir. Promise reddedilmezse kayıt iptali başarılı olmuştur.

Etkinlikler

onMessage

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

FCM üzerinden bir mesaj alındığında tetiklenir.

Parametreler

• callback

  işlev

  callback parametresi şu şekilde görünür:

  (message: object) => void

  • mesaj

    nesne

    • collapseKey

      string isteğe bağlı

      Mesajın daraltma anahtarı. Ayrıntılar için Daraltılamayan ve daraltılabilir mesajlar bölümüne bakın.

    • veri

      nesne

      Mesaj verileri.

    • başlangıç fiyatı:

      string isteğe bağlı

      Mesajı gönderen kişi.

onMessagesDeleted

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

Bir FCM sunucusunun, uygulama sunucusu tarafından uygulamaya gönderilen mesajları silmesi gerektiğinde tetiklenir. Bu etkinliğin işlenmesiyle ilgili ayrıntılar için Mesajın kullanım ömrü başlıklı makaleyi inceleyin.

Parametreler

• callback

  işlev

  callback parametresi şu şekilde görünür:

  () => void

onSendError

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

FCM sunucusuna mesaj gönderilemediğinde tetiklenir.

Parametreler

• callback

  işlev

  callback parametresi şu şekilde görünür:

  (error: object) => void

  • hata

    nesne

    • ayrıntılar

      nesne

      Varsa hatayla ilgili ek ayrıntılar.

    • errorMessage

      dize

      Sorunu açıklayan hata mesajı.

    • messageId

      string isteğe bağlı

      Hata belirli bir mesajla ilgiliyse bu hatayı içeren mesajın kimliği.