Firebase Bulut Mesajlaşma (FCM).
Fonksiyonlar
İşlev | Tanım |
---|---|
getMessaging(uygulama) | Varsayılan uygulama veya belirli bir uygulama için Mesajlaşma hizmetini alır. admin.messaging() varsayılan uygulamanın Messaging hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkili Messaging hizmetine erişmek için admin.messaging(app) olarak çağrılabilir. |
Sınıflar
Sınıf | Tanım |
---|---|
Mesajlaşma | Sağlanan uygulamaya bağlı mesajlaşma hizmeti. |
Arayüzler
Arayüz | Tanım |
---|---|
AndroidYapılandırması | Bir Mesaja eklenebilecek Android'e özgü seçenekleri temsil eder . |
AndroidFcmSeçenekler | Android için FCM SDK tarafından sağlanan özelliklere ilişkin seçenekleri temsil eder. |
Android Bildirimi | AndroidConfig'e eklenebilecek Android'e özgü bildirim seçeneklerini temsil eder . |
ApnsYapılandırması | Bir Mesaja dahil edilebilecek APN'lere özgü seçenekleri temsil eder . APN'ler tarafından desteklenen çeşitli başlıklar ve yük alanları için Apple belgelerine bakın. |
ApnsFcmSeçenekler | İOS için FCM SDK'sı tarafından sağlanan özelliklere yönelik seçenekleri temsil eder. |
ApnsYükü | Bir APN mesajının yükünü temsil eder. Esas olarak aps sözlüğünden oluşur. Ancak başka isteğe bağlı özel anahtarlar da içerebilir. |
Aps | APN mesajlarının parçası olan aps sözlüğünü temsil eder. |
Aps Uyarısı | |
Temel Mesaj | |
Toplu Yanıt | Messaging.sendAll() ve Messaging.sendMulticast() yöntemlerinden gelen sunucu yanıtını temsil eden arayüz. |
DurumMesajı | |
Kritik Ses | Bir APN yükünün aps sözlüğüne eklenebilecek kritik bir ses yapılandırmasını temsil eder. |
VeriMesajYükü | FCM eski API veri mesajı yükünü temsil eden arayüz. Veri mesajları, geliştiricilerin 4 KB'a kadar özel anahtar/değer çifti göndermesine olanak tanır. Anahtarların ve değerlerin her ikisi de dize olmalıdır. Anahtarlar, aşağıdaki ayrılmış dizeler dışında herhangi bir özel dize olabilir:
|
FcmSeçenekleri | FCM SDK'ları tarafından sağlanan özelliklere yönelik platformdan bağımsız seçenekleri temsil eder. |
IşıkAyarları | AndroidNotification'a dahil edilebilecek bildirim LED'ini kontrol etmeye yönelik ayarları temsil eder . |
MesajlaşmaDurumuYanıt | Eski Messaging.sendToCondition() yönteminden gelen sunucu yanıtını temsil eden arayüz. Kod örnekleri ve ayrıntılı belgeler için bkz . Koşula gönderme . |
MesajlaşmaCihazGrubuYanıt | Messaging.sendToDeviceGroup() yönteminden gelen sunucu yanıtını temsil eden arayüz. Kod örnekleri ve ayrıntılı belgeler için bkz. Cihaz gruplarına mesaj gönderme . |
MesajlaşmaCihazSonucu | Tek cihazlardan bireysel durum yanıtı yükü |
MesajlaşmaCihazlarıYanıt | FCM'nin eski API'leri aracılığıyla ayrı bir cihaza gönderilen bir mesajın durumunu temsil eden arayüz. Kod örnekleri ve ayrıntılı belgeler için Ayrı cihazlara gönderme konusuna bakın. |
MesajlaşmaSeçenekleri | Eski FCM API'leri aracılığıyla mesaj gönderilirken sağlanabilecek seçenekleri temsil eden arayüz. Kod örnekleri ve ayrıntılı belgeler için gönderme istekleri oluşturma konusuna bakın. |
MesajlaşmaYük | Firebase Cloud Messaging mesaj yükünü temsil eden arayüz. data ve notification anahtarlarından biri veya her ikisi gereklidir. Kod örnekleri ve ayrıntılı belgeler için gönderme istekleri oluşturma konusuna bakın. |
MesajlaşmaKonuYönetimYanıt | Messaging.subscribeToTopic() ve Messaging.unsubscribeFromTopic() yöntemlerinden gelen sunucu yanıtını temsil eden arayüz. Kod örnekleri ve ayrıntılı belgeler için Konuları sunucudan yönetme konusuna bakın. |
MesajlaşmaKonuYanıt | Eski Messaging.sendToTopic() yönteminden gelen sunucu yanıtını temsil eden arayüz. Kod örnekleri ve ayrıntılı belgeler için Bir konuya gönderme konusuna bakın. |
Çoklu YayınMesajı | Messaging.sendMulticast() yönteminin yükü. Veri, BaseMessage türündeki tüm alanları ve belirteçlerin bir listesini içerir. |
Bildiri | Mesaja eklenebilecek bir bildirim . |
BildirimMesajYük | FCM eski API bildirim mesajı yükünü temsil eden arayüz. Bildirim mesajları, geliştiricilerin 4 KB'a kadar önceden tanımlanmış anahtar/değer çifti göndermesine olanak tanır. Kabul edilen anahtarlar aşağıda özetlenmiştir. Kod örnekleri ve ayrıntılı belgeler için gönderme istekleri oluşturma konusuna bakın. |
Cevap Gönder | Toplu isteğin parçası olarak gönderilen tek bir mesajın durumunu temsil eden arayüz. |
JetonMesajı | |
KonuMesaj | |
WebpushYapılandırması | Bir Mesaja dahil edilebilecek WebPush protokolü seçeneklerini temsil eder . |
WebpushFcmSeçenekler | Web için FCM SDK'sı tarafından sağlanan (Webpush standardının parçası olmayan) özelliklere yönelik seçenekleri temsil eder. |
Webpush Bildirimi | WebpushConfig'e dahil edilebilecek WebPush'a özgü bildirim seçeneklerini temsil eder . Bu, Web Bildirimi spesifikasyonunda tanımlanan standart seçeneklerin çoğunu destekler . |
Takma Adları Yazın
Takma Ad yazın | Tanım |
---|---|
İleti | Messaging.send() işlemine ilişkin yük. Veri, BaseMessage türündeki tüm alanları ve tam olarak belirteç, konu veya koşuldan birini içerir. |
getMessaging()
Varsayılan uygulama veya belirli bir uygulama için Mesajlaşma hizmetini alır.
admin.messaging()
varsayılan uygulamanın Messaging
hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkili Messaging
hizmetine erişmek için admin.messaging(app)
olarak çağrılabilir.
İmza:
export declare function getMessaging(app?: App): Messaging;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
uygulama | Uygulama | Messaging hizmetinin geri döndürüleceği isteğe bağlı uygulama. Sağlanmazsa, varsayılan Messaging hizmetine geri dönülecektir. |
İadeler:
Hiçbir uygulama sağlanmadıysa varsayılan Messaging
hizmeti veya sağlanan uygulamayla ilişkili Messaging
hizmeti.
örnek 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
Örnek 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
İleti
Messaging.send() işlemine ilişkin yük. Veri, BaseMessage türündeki tüm alanları ve tam olarak belirteç, konu veya koşuldan birini içerir.
İmza:
export type Message = TokenMessage | TopicMessage | ConditionMessage;