firebase-admin.messaging package

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şkilendirilmiş 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, PrefixedFirebaseError uzantısını genişletir.
Mesajlaşma Mesajlaşma hizmeti, sağlanan uygulamaya bağlıdır.
MessagingClientErrorCode Mesajlaşma istemcisi hata kodları ve varsayılan mesajları.

Arayüzler

Arayüz Açıklama
AndroidConfig İleti'ye eklenebilecek Android'e özel seçenekleri temsil eder.
AndroidFcmOptions Android için FCM SDK'sı tarafından sağlanan özelliklerle ilgili seçenekleri temsil eder.
Android Bildirimi AndroidConfig'e dahil edilebilecek Android'e özel bildirim seçeneklerini temsil eder.
ApnsConfig Bir Mesaja dahil edilebilecek APN'lere özel seçenekleri temsil eder. APN'ler tarafından desteklenen çeşitli başlıklar ve yük alanları için Apple belgelerine bakın.
ApnsFcmOptions iOS için FCM SDK'sı tarafından sağlanan özelliklerle ilgili seçenekleri temsil eder.
ApnsYük Bir APNs mesajının yükünü temsil eder. Çoğunlukla aps sözlüğünden oluşur. Ancak rastgele başka özel anahtarlar da içerebilir.
Uygulama sayısı APNs mesajlarının bir parçası olan aps sözlüğünü temsil eder.
ApsAlert
BaseMessage
BatchResponse Messaging.sendAll() ve Messaging.sendMulticast() yöntemlerinden gelen sunucu yanıtını temsil eden arayüz.
ConditionMessage (Koşul İletisi)
CriticalSes APNs yükünün aps sözlüğüne dahil edilebilecek kritik bir ses yapılandırmasını temsil eder.
DataMessagePayload FCM'nin 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 hariç herhangi bir özel dize olabilir:
  • from
  • google. ile başlayan her şey
Kod örnekleri ve ayrıntılı belgeler için Derleme istekleri oluşturma bölümüne bakın.
FcmOptions FCM SDK'ları tarafından sağlanan özellikler için platformdan bağımsız seçenekleri temsil eder.
Işık Ayarları AndroidBildirimi işlevine 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.
MessagingDeviceGroupResponse Messaging.sendToDeviceGroup() yönteminden sunucu yanıtını temsil eden arayüz.Kod örnekleri ve ayrıntılı dokümanlar için Cihaz gruplarına mesaj gönderme başlıklı makaleyi inceleyin.
MessagingDeviceResult Tek cihazlardan gelen bağımsız durum yanıt yükü
MessagingDevicesResponse FCM'nin eski API'leri aracılığıyla tek bir cihaza gönderilen mesajın durumunu temsil eden arayüz.Kod örnekleri ve ayrıntılı belgeler için Cihazlara tek tek gönderme bölümüne bakın.
MessagingOptions FCM'nin eski API'leri aracılığıyla mesaj gönderirken kullanılabilecek seçenekleri temsil eden arayüz.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 gereklidir.Kod örnekleri ve ayrıntılı belgeler için Derleme istekleri bölümüne bakın.
MessagingTopicManagementResponse 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 Sunucudan konuları yönetme başlıklı makaleye bakın.
Mesaj Konusu Yanıtı Eski Messaging.sendToTopic() yönteminden 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.
MulticastMessage Messaging.sendMulticast() yöntemi için yük. Yük, BaseMessage türündeki tüm alanları ve bir jeton listesini içerir.
Bildirim Mesaj'a eklenebilecek bir bildirim.
BildirimMesajı Payı FCM'nin 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ünü inceleyin.
SendResponse Toplu isteğin bir parçası olarak gönderilen tek bir mesajın durumunu temsil eden arayüz.
TokenMessage
Konu Mesajı
WebpushConfig İleti'ye dahil edilebilecek WebPush protokol seçeneklerini temsil eder.
WebpushFcmOptions Web için FCM SDK'sı (Webpush standardının parçası olmayan) tarafından sağlanan özelliklere ilişkin seçenekleri temsil eder.
WebpushNotification WebpushConfig'e dahil edilebilecek WebPush'a özel bildirim seçeneklerini temsil eder. Bu destek, Web Bildirimi spesifikasyonunda tanımlanan standart seçeneklerin çoğunu destekler.

Tür Takma Adları

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 jeton, konu veya koşuldan birini 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şkilendirilmiş 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 Uygulama Messaging hizmeti iade edilecek isteğe bağlı uygulama. Sağlanmazsa varsayılan Messaging hizmeti döndürülür.

Şunu döndürür:

Mesajlaşma

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);

Mesaj

Messaging.send() işlemi için yük. Yük, BaseMessage türündeki tüm alanları ve tam olarak jeton, konu veya koşuldan birini içerir.

İmza:

export type Message = TokenMessage | TopicMessage | ConditionMessage;