chrome.gcm

Açıklama

Uygulamaların ve uzantıların Firebase Cloud Messaging (FCM) üzerinden mesaj göndermesini ve almasını sağlamak 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

4096

Yöntemler

register()

Promise 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): 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.

  • callback

    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<string>

    Chrome 116 veya daha yeni bir sürüm

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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

send()

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

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

Parametreler

  • mesaj

    nesne

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

    • aktarma

      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ı olan collapse_key, anahtar öneki 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

      İletinin kimliği. Uygulamalar kapsamındaki her ileti için benzersiz olmalıdır. Kimlik seçme ve işleme konusunda tavsiye için Cloud Messaging belgelerine bakın.

    • timeToLive

      number isteğe bağlı

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

  • callback

    işlev isteğe bağlı

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

    (messageId: string) => void

    • messageId

      dize

      Geri aramanın yapıldığı mesajın kimliği.

İadeler

  • Promise<string>

    Chrome 116 veya daha yeni bir sürüm

    İleti gönderme için başarıyla sıraya alındıktan sonra çözülür. Bir hata oluşursa söz reddedilir.

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

unregister()

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

Uygulamanın FCM kaydını iptal eder.

Parametreler

  • callback

    işlev isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 116 veya daha yeni bir sürüm

    Kayıt iptali tamamlandıktan sonra çözülür. Promise reddedilmezse kaydı silme işlemi başarılı olur.

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

Etkinlikler

onMessage

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

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

Parametreler

  • callback

    işlev

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

    (message: object) => void

    • mesaj

      nesne

      • collapseKey

        dize isteğe bağlı

        Bir iletinin daraltma anahtarı. Ayrıntılar için Daraltılamayan ve daraltılabilen iletiler başlıklı makaleyi inceleyin.

      • aktarma

        nesne

        İleti verileri.

      • başlangıç fiyatı:

        dize isteğe bağlı

        Mesajı gönderen kişi.

onMessagesDeleted

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

Bir FCM sunucusu, uygulama sunucusu tarafından uygulamaya gönderilen mesajları silmek zorunda kaldığında tetiklenir. Bu etkinliğin işlenmesiyle ilgili ayrıntılar için İletinin kullanım ömrü başlıklı makaleyi inceleyin.

Parametreler

  • callback

    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

  • callback

    işlev

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

    (error: object) => void

    • hata

      nesne

      • ayrıntılar

        nesne

        Hatayla ilgili ek ayrıntılar (varsa).

      • errorMessage

        dize

        Sorunu açıklayan hata mesajı.

      • messageId

        dize isteğe bağlı

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