Firebase Cloud Messaging (FCM).
İşlevler
İşlev | Açıklama |
---|---|
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 | Açıklama |
---|---|
FirebaseMessagingError | Firebase Messaging hata kodu yapısı. Bu işlem PrefixedFirebaseError'u genişletir. |
Mesajlaşma | Sağlanan uygulamaya bağlı mesajlaşma hizmeti. |
MesajlaşmaClientErrorCode | Mesajlaşma istemcisi hata kodları ve varsayılan mesajları. |
Arayüzler
Arayüz | Açıklama |
---|---|
AndroidConfig | Bir İletiye eklenebilecek Android'e özel seçenekleri temsil eder. |
AndroidFcmOptions | Android için FCM SDK'sı tarafından sağlanan özelliklere ilişkin seçenekleri gösterir. |
AndroidBildirim | AndroidConfig'e dahil edilebilecek, Android'e özel bildirim seçeneklerini temsil eder. |
ApnsConfig | Bir İletiye dahil edilebilecek, APN'lere özel seçenekleri temsil eder. APN'lerin desteklediği çeşitli başlıklar ve yük alanları için Apple dokümanlarına bakın. |
ApnsFcmOptions | iOS için FCM SDK'sı tarafından sağlanan özelliklere ilişkin seçenekleri gösterir. |
ApnsPayload | Bir APNs mesajının yükünü temsil eder. Esas olarak aps sözlüğünden oluşur. Ancak rastgele başka özel anahtarlar da içerebilir. |
Ap'ler | APNs mesajlarının parçası olan uygulamalar sözlüğünü temsil eder. |
Aps Uyarısı | |
TemelMesaj | |
Toplu Yanıt | Messaging.sendAll() ve Messaging.sendMulticast() yöntemlerinden sunucu yanıtını temsil eden arayüz. |
KoşulMesajı | |
CriticalSes | Bir APNs yükünün aps sözlüğüne dahil edilebilecek kritik bir ses yapılandırmasını temsil eder. |
DataMessagePayload | FCM eski API veri mesajı yükünü temsil eden arayüz. Veri mesajları, geliştiricilerin 4 KB'a kadar özel anahtar/değer çiftleri göndermesine olanak tanır. Hem anahtarlar hem de değerler dize olmalıdır. Anahtarlar, aşağıdaki ayrılmış dizeler haricinde, herhangi bir özel dize olabilir:
|
FcmOptions | FCM SDK'ları tarafından sağlanan özellikler için platformdan bağımsız seçenekleri temsil eder. |
LightSettings | AndroidNotification'a dahil edilebilecek bildirim LED'ini kontrol etmek için kullanılan ayarları temsil eder. |
MessagingConditionResponse | Eski Messaging.sendToCondition() yönteminden sunucu yanıtını temsil eden arayüz.Kod örnekleri ve ayrıntılı belgeler için Bir koşula gönderme bölümüne bakın. |
MesajlaşmaCihaz Grubu Yanıtı | Messaging.sendToDeviceGroup() yönteminden alınan sunucu yanıtını temsil eden arayüz.Kod örnekleri ve ayrıntılı dokümanlar için Cihaz gruplarına ileti gönderme sayfasına göz atın. |
MesajlaşmaCihazSonucu | Tek cihazlardan gelen bağımsız durum yanıtı yükü |
MesajlaşmaCihazlar Yanıtı | FCM'nin eski API'leri aracılığıyla tek bir cihaza gönderilen mesajın durumunu gösteren arayüzdür.Kod örnekleri ve ayrıntılı dokümanlar için Ayrı cihazlara gönderme bölümüne bakın. |
MessagingOptions | Arayüz, eski FCM API'leri aracılığıyla mesaj gönderirken sağlanabilecek seçenekleri temsil eder.Kod örnekleri ve ayrıntılı belgeler için Gönderme istekleri oluşturma bölümüne bakın. |
Mesajlaşma Yükü | Firebase Cloud Messaging mesaj yükünü temsil eden arayüz. data ve notification anahtarlarından biri veya her ikisi de gerekli.Kod örnekleri ve ayrıntılı belgeler için Derleme istekleri oluşturma bölümüne bakın. |
MesajlaşmaTopicYönetimi | 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 başlıklı makaleyi inceleyin. |
MesajlaşmaKonuYanıtı | Eski Messaging.sendToTopic() yöntemine ait sunucu yanıtını temsil eden arayüz.Kod örnekleri ve ayrıntılı belgeler için Bir konuya gönderme bölümüne bakın. |
Çoklu YayınMesaj | Messaging.sendMulticast() yöntemi için yük. Yük, BaseMessage türündeki tüm alanları ve bir jeton listesini içerir. |
Bildirim | İletiye eklenebilecek bir bildirim. |
NotificationMessagePayload | 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 çiftleri göndermesine olanak tanır. Kabul edilen anahtarlar aşağıda özetlenmiştir.Kod örnekleri ve ayrıntılı belgeler için Derleme istekleri oluşturma bölümüne bakın. |
Yanıt Gönder | Toplu isteğin bir parçası olarak gönderilen bağımsız bir mesajın durumunu gösteren arayüz. |
TokenMessage | |
KonuMesajı | |
WebpushConfig | Bir İletiye eklenebilecek WebPush protokol seçeneklerini temsil eder. |
WebpushFcmOptions | Web için FCM SDK'sı (Webpush standardının bir parçası olmayan) tarafından sağlanan özelliklere ilişkin seçenekleri gösterir. |
WebpushBildirim | WebpushConfig'e dahil edilebilen WebPush'a özel 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 | Açıklama |
---|---|
Mesaj | Messaging.send() işlemi için yük. Yük, BaseMessage türündeki tüm alanları ve tam olarak bir jeton, konu veya koşul içerir. |
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.
İmza:
export declare function getMessaging(app?: App): Messaging;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
uygulama | Uygulamaya | Messaging hizmetinin iade edileceği isteğe bağlı uygulama. Sağlanmazsa varsayılan Messaging hizmeti döndürülür. |
İadeler:
Uygulama sağlanmamışsa varsayılan Messaging
hizmeti veya sağlanan uygulamayla ilişkili Messaging
hizmeti.
1. örnek
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
2. örnek
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
Message
Messaging.send() işlemi için yük. Yük, BaseMessage türündeki tüm alanları ve tam olarak bir jeton, konu veya koşul içerir.
İmza:
export type Message = TokenMessage | TopicMessage | ConditionMessage;