Açıklama
Firebase Cloud Messaging (FCM) üzerinden mesaj gönderip almak üzere uygulama ve uzantıları etkinleştirmek için chrome.gcm
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()
chrome.gcm.register(
senderIds: string[],
callback?: function,
)
Uygulamayı FCM'ye kaydeder. Kayıt kimliği, callback
tarafından gönderilecektir. 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. İleti en az bir, en fazla 100 gönderen kimliği içermelidir.
-
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(registrationId: string) => void
-
registrationId
dize
Uygulamaya FCM tarafından atanan kayıt kimliği.
-
İlerlemeler
-
Söz<dize>
Chrome 116 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
send()
chrome.gcm.send(
message: object,
callback?: function,
)
İletiyi içeriğine göre gönderir.
Parametreler
-
mesaj
nesne
FCM aracılığıyla diğer tarafa gönderilecek bir mesaj.
-
veri
nesne
Sunucuya gönderilecek mesaj verileri. Büyük/küçük harfe duyarlı olmayan
goog.
vegoogle
ile büyük/küçük harfe duyarlıcollapse_key
'ye anahtar ön ek olarak izin verilmez. Tüm anahtar/değer çiftlerinin toplamı en fazlagcm.MAX_MESSAGE_SIZE
olmalıdır. -
destinationId
dize
İletinin 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şlemeyle ilgili öneriler için Cloud Messaging belgelerine bakın.
-
timeToLive
numara isteğe bağlı
İletinin geçerlilik süresi (saniye cinsinden). Bu süre içinde ileti gönderilemezse bir onSendError etkinliği oluşturulur. 0 olan geçerlilik süresi, iletinin hemen gönderilmesi gerektiğini veya mümkün değilse başarısız olduğunu belirtir. 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
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(messageId: string) => void
-
messageId
dize
Geri arama için gönderilen iletinin kimliği.
-
İlerlemeler
-
Söz<dize>
Chrome 116 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
unregister()
chrome.gcm.unregister(
callback?: function,
)
Uygulamanın FCM kaydını iptal eder.
Parametreler
-
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:() => void
İlerlemeler
-
Promise<void>
Chrome 116 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
Etkinlikler
onMessage
chrome.gcm.onMessage.addListener(
callback: function,
)
FCM üzerinden bir ileti alındığında tetiklenir.
Parametreler
-
geri çağırma
işlev
callback
parametresi şu şekilde görünür:(message: object) => void
-
mesaj
nesne
-
collapseKey
string isteğe bağlı
Bir iletinin daraltma anahtarı. Ayrıntılar için Daraltılamaz ve daraltılabilir iletiler başlıklı makaleye bakın.
-
veri
nesne
Mesaj verileri.
-
şuradan
string isteğe bağlı
İletiyi yayınlayan gönderen.
-
-
onMessagesDeleted
chrome.gcm.onMessagesDeleted.addListener(
callback: function,
)
FCM sunucusunun, bir uygulama sunucusu tarafından uygulamaya gönderilen iletileri silmesi gerektiğinde tetiklenir. Bu etkinliğin işlenmesiyle ilgili ayrıntılar için Bir iletinin kullanım süresi bölümüne bakı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 ileti gönderilemediğinde tetiklendi.
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
Sorunu açıklayan hata mesajı.
-
messageId
string isteğe bağlı
Hata belirli bir iletiyle ilgiliyse, bu hatayı içeren iletinin kimliği.
-
-