chrome.gcm

Açıklama

Uygulamaları ve uzantıları Firebase Cloud Messaging (FCM) üzerinden mesaj gönderip alacak şekilde etkinleştirmek için chrome.gcm kullanın.

İzinler

gcm

Özellikler

MAX_MESSAGE_SIZE

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

Değer

4.096

Yöntemler

register()

Söz 'nı inceleyin.
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

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

    dize[]

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

  • geri çağırma

    işlev isteğe bağlı

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

    (registrationId: string) => void

    • registrationId

      dize

      FCM tarafından uygulamaya atanan kayıt kimliği.

İadeler

  • Promise<dize>

    Chrome 116 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

send()

Söz 'nı inceleyin.
chrome.gcm.send(
  message: object,
  callback?: function,
)

İletiyi içeriğine göre gönderir.

Parametreler

  • mesaj

    nesne

    Diğer tarafa FCM aracılığıyla gönderilecek mesaj.

    • veri

      nesne

      Sunucuya gönderilecek ileti verileri. Büyük/küçük harfe duyarlı olmayan goog. ve google ile büyük/küçük harfe duyarlı collapse_key anahtar öneklerine izin verilmez. Tüm anahtar/değer çiftlerinin toplamı gcm.MAX_MESSAGE_SIZE değerini aşmamalıdır.

    • destinationId

      dize

      Google API Konsolu tarafından atandığı şekilde, mesajın gönderileceği sunucunun kimliği.

    • messageId

      dize

      İletinin kimliği. Uygulamaların kapsamındaki her mesaj için benzersiz olmalıdır. Kimlik seçme ve yönetme önerileri için Cloud Messaging belgelerine bakın.

    • timeToLive

      sayı isteğe bağlı

      Mesajın saniye cinsinden geçerlilik süresi. Bu süre içinde ileti gönderilemezse onSendError etkinliği oluşturulur. Geçerlilik süresinin 0 olması, iletinin hemen gönderilmesi gerektiğini veya bu mümkün değilse başarısız olduğunu gösterir. Varsayılan geçerlilik süresi 86.400 saniye (1 gün) ve maksimum değer 2.419.200 saniyedir (28 gün).

  • geri çağırma

    işlev isteğe bağlı

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

    (messageId: string) => void

    • messageId

      dize

      Geri çağırmanın yapıldığı mesajın kimliği.

İadeler

  • Promise<dize>

    Chrome 116 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

unregister()

Söz 'nı inceleyin.
chrome.gcm.unregister(
  callback?: function,
)

Uygulamanın FCM kaydını iptal eder.

Parametreler

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Chrome 116 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

Etkinlikler

onMessage

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

FCM aracılığıyla bir mesaj alındığında tetiklenir.

Parametreler

  • geri çağırma

    işlev

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

    (message: object) => void

    • mesaj

      nesne

      • collapseKey

        dize isteğe bağlı

        İletinin daraltma anahtarı. Ayrıntılar için Daraltılamayan ve daraltılabilir mesajlar bölümüne göz atın.

      • veri

        nesne

        Mesaj verileri.

      • şuradan

        dize isteğe bağlı

        İletiyi veren gönderen.

onMessagesDeleted

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

Bir uygulama sunucusu tarafından uygulamaya gönderilen mesajları FCM sunucusunun silmesi gerektiğinde tetiklenir. Bu etkinliğin işlenmesiyle ilgili ayrıntılar için Bir iletinin kullanım süresi sayfasına göz atın.

Parametreler

  • geri çağırma

    işlev

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

    () => void

onSendError

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

FCM sunucusuna mesaj gönderilemediğinde tetiklenir.

Parametreler

  • geri çağırma

    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

        Sorunun açıklandığı hata mesajı.

      • messageId

        dize isteğe bağlı

        Hata belirli bir iletiyle ilgiliyse bu hatayı içeren iletinin kimliği.