Messaging class

Sağlanan uygulamaya bağlı mesajlaşma hizmeti.

İmza:

export declare class Messaging 

Özellikler

Mülk Değiştiriciler Tip Tanım
uygulama Uygulama Geçerli Messaging hizmeti örneğiyle ilişkili Uygulama .

Yöntemler

Yöntem Değiştiriciler Tanım
gönder(mesaj, DryRun) Verilen mesajı FCM aracılığıyla gönderir.
sendAll(mesajlar, DryRun) Verilen dizideki tüm mesajları Firebase Cloud Messaging aracılığıyla gönderir. Listenin tamamını tek bir RPC çağrısı olarak göndermek için toplu işlem kullanır. send() yöntemiyle karşılaştırıldığında bu yöntem, birden fazla ileti göndermenin çok daha etkili bir yoludur. Dönüş değerinden elde edilen yanıt listesi, MulticastMessage belirteçlerin sırasına karşılık gelir. Bu yöntemden kaynaklanan bir hata, tam bir başarısızlığı gösterir; bu, listedeki iletilerden hiçbirinin gönderilemediği anlamına gelir. Kısmi hatalar BatchResponse dönüş değeriyle gösterilir.
sendEach(mesajlar, DryRun) Verilen dizideki her mesajı Firebase Cloud Messaging aracılığıyla gönderir. Messaging.sendAll()' ın aksine , bu yöntem verilen dizideki her ileti için tek bir RPC çağrısı yapar. Dönen değerden elde edilen yanıt listesi messages sırasına karşılık gelir. Bu yöntemden kaynaklanan bir hata veya tüm hataları içeren bir BatchResponse , tam bir başarısızlığa işaret eder; bu, listedeki mesajların hiçbirinin gönderilemediği anlamına gelir. Kısmi arızalar veya hiç arıza olmaması yalnızca BatchResponse dönüş değeriyle gösterilir.
sendEachForMulticast(mesaj, DryRun) Verilen çok noktaya yayın mesajını, içinde belirtilen tüm FCM kayıt belirteçlerine gönderir. Bu yöntem, verilen mesajı tüm hedef alıcılara göndermek için Messaging.sendEach() API'sini kullanır. Dönüş değerinden elde edilen yanıt listesi, MulticastMessage belirteçlerin sırasına karşılık gelir. Bu yöntemden kaynaklanan bir hata veya tüm hataları içeren bir BatchResponse , tam bir başarısızlığa işaret eder; bu, listedeki mesajların gönderilebileceği anlamına gelir. Kısmi hatalar veya hatalar yalnızca BatchResponse dönüş değeriyle gösterilir.
sendMulticast(mesaj, DryRun) Verilen çok noktaya yayın mesajını, içinde belirtilen tüm FCM kayıt belirteçlerine gönderir. Bu yöntem, verilen mesajı tüm hedef alıcılara göndermek için sendAll() API'sini kullanır. Dönüş değerinden elde edilen yanıt listesi, MulticastMessage belirteçlerin sırasına karşılık gelir. Bu yöntemden kaynaklanan bir hata, tam bir başarısızlığı gösterir; bu, mesajın listedeki belirteçlerden hiçbirine gönderilmediği anlamına gelir. Kısmi hatalar BatchResponse dönüş değeriyle gösterilir.
sendToCondition(koşul, yük, seçenekler) Bir koşula FCM mesajı gönderir. Kod örnekleri ve ayrıntılı belgeler için bkz . Koşula gönderme .
sendToDevice(registrationTokenOrTokens, yük, seçenekler) Sağlanan kayıt belirtecine karşılık gelen tek bir cihaza bir FCM mesajı gönderir. Kod örnekleri ve ayrıntılı belgeler için Ayrı cihazlara gönderme konusuna bakın. Tek bir cihaza gönderilecek bir registrationToken veya birden fazla cihaza gönderilecek bir dizi belirteç içeren bir registrationTokens parametresini alır.
sendToDeviceGroup(notificationKey, veri, seçenekler) Sağlanan bildirim anahtarına karşılık gelen cihaz grubuna bir FCM mesajı gönderir. Kod örnekleri ve ayrıntılı belgeler için bkz . Cihaz grubuna gönderme .
sendToTopic(konu, veri, seçenekler) Bir konuya FCM mesajı gönderir. Kod örnekleri ve ayrıntılı belgeler için Bir konuya gönderme konusuna bakın.
aboneToTopic(registrationTokenOrTokens, konu) Bir cihazı bir FCM konusuna abone eder. Kod örnekleri ve ayrıntılı belgeler için Bir konuya abone olma konusuna bakın. İsteğe bağlı olarak, birden fazla cihaza abone olmak için bir dizi belirteç sağlayabilirsiniz.
unsubscribeFromTopic(registrationTokenOrTokens, konu) Bir cihazın FCM konusundaki aboneliğini iptal eder. Kod örnekleri ve ayrıntılı belgeler için Bir konunun aboneliğinden çıkma konusuna bakın. İsteğe bağlı olarak, birden fazla cihazın aboneliğini iptal etmek için bir dizi belirteç sağlayabilirsiniz.

Messaging.app

Geçerli Messaging hizmeti örneğiyle ilişkili Uygulama .

İmza:

get app(): App;

Örnek

var app = messaging.app;

Mesajlaşma.send()

Verilen mesajı FCM aracılığıyla gönderir.

İmza:

send(message: Message, dryRun?: boolean): Promise<string>;

Parametreler

Parametre Tip Tanım
İleti İleti Mesaj yükü.
kuru Çalıştır boolean Mesajın deneme (yalnızca doğrulama) modunda gönderilip gönderilmeyeceği.

İadeler:

Söz<string>

Mesajın teslim edilmek üzere FCM hizmetine başarılı bir şekilde teslim edilmesinin ardından benzersiz bir mesaj kimlik dizesiyle yerine getirilen söz.

Messaging.sendAll()

Bunun yerine Messaging.sendEach() işlevini kullanın.

Verilen dizideki tüm mesajları Firebase Cloud Messaging aracılığıyla gönderir. Listenin tamamını tek bir RPC çağrısı olarak göndermek için toplu işlem kullanır. send() yöntemiyle karşılaştırıldığında bu yöntem, birden fazla ileti göndermenin çok daha etkili bir yoludur.

Dönüş değerinden elde edilen yanıt listesi, MulticastMessage belirteçlerin sırasına karşılık gelir. . Bu yöntemden kaynaklanan bir hata, tam bir başarısızlığı gösterir; bu, listedeki iletilerden hiçbirinin gönderilemediği anlamına gelir. Kısmi hatalar BatchResponse dönüş değeriyle gösterilir.

İmza:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Parametreler

Parametre Tip Tanım
mesajlar İleti [] En fazla 500 ileti içeren, boş olmayan bir dizi.
kuru Çalıştır boolean Mesajların deneme (yalnızca doğrulama) modunda gönderilip gönderilmeyeceği.

İadeler:

Söz < Toplu Yanıt >

Gönderme işleminin sonucunu temsil eden bir nesneyle yerine getirilen bir Söz.

Messaging.sendEach()

Verilen dizideki her mesajı Firebase Cloud Messaging aracılığıyla gönderir.

Messaging.sendAll()' ın aksine , bu yöntem verilen dizideki her ileti için tek bir RPC çağrısı yapar.

Dönen değerden elde edilen yanıt listesi messages sırasına karşılık gelir . Bu yöntemden kaynaklanan bir hata veya tüm hataları içeren bir BatchResponse , tam bir başarısızlığa işaret eder; bu, listedeki mesajların hiçbirinin gönderilemediği anlamına gelir. Kısmi arızalar veya hiç arıza olmaması yalnızca BatchResponse dönüş değeriyle gösterilir.

İmza:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Parametreler

Parametre Tip Tanım
mesajlar İleti [] En fazla 500 ileti içeren, boş olmayan bir dizi.
kuru Çalıştır boolean Mesajların deneme (yalnızca doğrulama) modunda gönderilip gönderilmeyeceği.

İadeler:

Söz < Toplu Yanıt >

Gönderme işleminin sonucunu temsil eden bir nesneyle yerine getirilen bir Söz.

Messaging.sendEachForMulticast()

Verilen çok noktaya yayın mesajını, içinde belirtilen tüm FCM kayıt belirteçlerine gönderir.

Bu yöntem, verilen mesajı tüm hedef alıcılara göndermek için Messaging.sendEach() API'sini kullanır. Dönüş değerinden elde edilen yanıt listesi, MulticastMessage belirteçlerin sırasına karşılık gelir. . Bu yöntemden kaynaklanan bir hata veya tüm hataları içeren bir BatchResponse , tam bir başarısızlığa işaret eder; bu, listedeki mesajların gönderilebileceği anlamına gelir. Kısmi hatalar veya hatalar yalnızca BatchResponse dönüş değeriyle gösterilir.

İmza:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Parametreler

Parametre Tip Tanım
İleti Çoklu YayınMesajı En fazla 500 jeton içeren çok noktaya yayın mesajı.
kuru Çalıştır boolean Mesajın deneme (yalnızca doğrulama) modunda gönderilip gönderilmeyeceği.

İadeler:

Söz < Toplu Yanıt >

Gönderme işleminin sonucunu temsil eden bir nesneyle yerine getirilen bir Söz.

Messaging.sendMulticast()

Bunun yerine Messaging.sendEachForMulticast() işlevini kullanın.

Verilen çok noktaya yayın mesajını, içinde belirtilen tüm FCM kayıt belirteçlerine gönderir.

Bu yöntem, verilen mesajı tüm hedef alıcılara göndermek için sendAll() API'sini kullanır. Dönüş değerinden elde edilen yanıt listesi, MulticastMessage belirteçlerin sırasına karşılık gelir. . Bu yöntemden kaynaklanan bir hata, tam bir başarısızlığı gösterir; bu, mesajın listedeki belirteçlerden hiçbirine gönderilmediği anlamına gelir. Kısmi hatalar BatchResponse dönüş değeriyle gösterilir.

İmza:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Parametreler

Parametre Tip Tanım
İleti Çoklu YayınMesajı En fazla 500 jeton içeren çok noktaya yayın mesajı.
kuru Çalıştır boolean Mesajın deneme (yalnızca doğrulama) modunda gönderilip gönderilmeyeceği.

İadeler:

Söz < Toplu Yanıt >

Gönderme işleminin sonucunu temsil eden bir nesneyle yerine getirilen bir Söz.

Messaging.sendToCondition()

Bir koşula FCM mesajı gönderir.

Kod örnekleri ve ayrıntılı belgeler için bkz . Koşula gönderme .

İmza:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

Parametreler

Parametre Tip Tanım
durum sicim Mesajın hangi konulara gönderileceğini belirleyen koşul.
yük MesajlaşmaYük Mesaj yükü.
seçenekler MesajlaşmaSeçenekleri Mesajı değiştirmek için isteğe bağlı seçenekler.

İadeler:

Söz< MessagingConditionResponse >

Mesaj gönderildikten sonra sunucunun yanıtıyla yerine getirilen bir söz.

Messaging.sendToDevice()

Bunun yerine Messaging.send() işlevini kullanın.

Sağlanan kayıt belirtecine karşılık gelen tek bir cihaza bir FCM mesajı gönderir.

Kod örnekleri ve ayrıntılı belgeler için Ayrı cihazlara gönderme konusuna bakın. Tek bir cihaza gönderilecek bir registrationToken veya birden fazla cihaza gönderilecek bir dizi belirteç içeren bir registrationTokens parametresini alır.

İmza:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

Parametreler

Parametre Tip Tanım
kayıtTokenOrTokens dize | sicim[]
yük MesajlaşmaYük Mesaj yükü.
seçenekler MesajlaşmaSeçenekleri Mesajı değiştirmek için isteğe bağlı seçenekler.

İadeler:

Promise< MessagingDevicesResponse >

Mesaj gönderildikten sonra sunucunun yanıtıyla yerine getirilen bir söz.

Messaging.sendToDeviceGroup()

Bunun yerine Messaging.send() işlevini kullanın.

Sağlanan bildirim anahtarına karşılık gelen cihaz grubuna bir FCM mesajı gönderir.

Kod örnekleri ve ayrıntılı belgeler için bkz . Cihaz grubuna gönderme .

İmza:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

Parametreler

Parametre Tip Tanım
bildirimAnahtarı sicim Mesajın gönderileceği cihaz grubuna ilişkin bildirim anahtarı.
yük MesajlaşmaYük Mesaj yükü.
seçenekler MesajlaşmaSeçenekleri Mesajı değiştirmek için isteğe bağlı seçenekler.

İadeler:

Promise< MessagingDeviceGroupResponse >

Mesaj gönderildikten sonra sunucunun yanıtıyla yerine getirilen bir söz.

Messaging.sendToTopic()

Bir konuya FCM mesajı gönderir.

Kod örnekleri ve ayrıntılı belgeler için Bir konuya gönderme konusuna bakın.

İmza:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

Parametreler

Parametre Tip Tanım
başlık sicim Mesajın gönderileceği konu.
yük MesajlaşmaYük Mesaj yükü.
seçenekler MesajlaşmaSeçenekleri Mesajı değiştirmek için isteğe bağlı seçenekler.

İadeler:

Söz< MesajlaşmaKonuYanıt >

Mesaj gönderildikten sonra sunucunun yanıtıyla yerine getirilen bir söz.

Messaging.subscribeToTopic()

Bir cihazı bir FCM konusuna abone eder.

Kod örnekleri ve ayrıntılı belgeler için Bir konuya abone olma konusuna bakın. İsteğe bağlı olarak, birden fazla cihaza abone olmak için bir dizi belirteç sağlayabilirsiniz.

İmza:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parametreler

Parametre Tip Tanım
kayıtTokenOrTokens dize | sicim[]
başlık sicim Abone olunacak konu.

İadeler:

Söz< MesajlaşmaKonuYönetimYanıt >

Cihaz konuya abone olduktan sonra sunucunun yanıtıyla yerine getirilen bir söz.

Messaging.unsubscribeFromTopic()

Bir cihazın FCM konusundaki aboneliğini iptal eder.

Kod örnekleri ve ayrıntılı belgeler için Bir konunun aboneliğinden çıkma konusuna bakın. İsteğe bağlı olarak, birden fazla cihazın aboneliğini iptal etmek için bir dizi belirteç sağlayabilirsiniz.

İmza:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parametreler

Parametre Tip Tanım
kayıtTokenOrTokens dize | sicim[]
başlık sicim Abonelikten çıkılacak konu.

İadeler:

Söz< MesajlaşmaKonuYönetimYanıt >

Cihazın konuya olan aboneliği iptal edildikten sonra sunucunun yanıtıyla yerine getirilen bir söz.