Messaging class

Mesajlaşma hizmeti, sağlanan uygulamaya bağlıdır.

İmza:

export declare class Messaging 

Özellikler

Özellik	Değiştiriciler	Tür	Açıklama
uygulama		Uygulama	Geçerli Messaging hizmet örneğiyle ilişkilendirilmiş Uygulama.

Yöntemler

Yöntem	Değiştiriciler	Açıklama
enableLegacyHttpTransport()		sendEach() ve sendEachForMulticast() için eski HTTP/1.1 aktarımının kullanımını etkinleştirir.
send(message, dryRun)		Belirtilen mesajı FCM aracılığıyla gönderir.
sendAll(messages, dryRun)		Belirli bir dizideki tüm mesajları Firebase Cloud Messaging üzerinden gönderir. Listenin tamamını tek bir RPC çağrısı olarak göndermek için toplu işleme kullanır. Bu yöntem, send() yöntemine kıyasla birden fazla mesaj göndermenin önemli ölçüde daha verimli bir yoludur.Döndürülen değerden elde edilen yanıt listesi, MulticastMessage içindeki jeton sırasına karşılık gelir. Bu yöntemde alınan bir hata, toplam hata olduğunu gösterir. Diğer bir deyişle, listedeki hiçbir ileti gönderilemedi. Kısmi hatalar, BatchResponse değeri döndürerek gösterilir.
sendHer(messages, dryRun)		Belirtilen dizideki her mesajı Firebase Cloud Messaging aracılığıyla gönderir.Messaging.sendAll() yönteminin aksine bu yöntem, belirtilen dizideki her mesaj için tek bir RPC çağrısı yapar.Döndürülen 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, toplam hata olduğunu gösterir. Diğer bir deyişle, listedeki hiçbir ileti gönderilemez. Kısmi hatalar veya hiç hata yok, yalnızca BatchResponse değeri döndürerek gösterilir.
sendEveryForMulticast(mesaj, dryRun)		Belirtilen çoklu yayın mesajını, belirtilen tüm FCM kayıt jetonlarına gönderir.Bu yöntem, belirtilen mesajı tüm hedef alıcılara göndermek için arka planda Messaging.sendBefore() API'sini kullanır. Döndürülen değerden elde edilen yanıt listesi, MulticastMessage içindeki belirteçlerin sırasına karşılık gelir. Bu yöntemden kaynaklanan bir hata veya tüm hataları içeren bir BatchResponse, toplam hata olduğunu gösterir. Bu, listedeki iletilerin gönderilebileceği anlamına gelir. Kısmi arızalar yalnızca BatchResponse değeri döndürerek gösterilir.
sendMulticast(mesaj, dryRun)		Belirtilen çoklu yayın mesajını, belirtilen tüm FCM kayıt jetonlarına gönderir.Bu yöntemde, belirtilen mesajı tüm hedef alıcılara göndermek için arka planda sendAll() API kullanılır. Döndürülen değerden elde edilen yanıt listesi, MulticastMessage içindeki belirteçlerin sırasına karşılık gelir. Bu yöntemden kaynaklanan bir hata, toplam hata olduğunu gösterir. Yani ileti, listedeki hiçbir jetona gönderilmemiştir. Kısmi hatalar, BatchResponse değeri döndürerek gösterilir.
sendToCondition(condition, payload, options)		Bir koşula FCM mesajı gönderir.Kod örnekleri ve ayrıntılı belgeler için Bir koşula gönderme bölümüne bakın.
sendToDevice(registrationTokenOrTokens, payload, options)		Sağlanan kayıt jetonuna karşılık gelen tek bir cihaza FCM mesajı gönderir.Kod örnekleri ve ayrıntılı belgeler için Cihazlara ayrı ayrı gönderme başlıklı makaleyi inceleyin. Tek bir cihaza göndermek için registrationToken veya birden fazla cihaza gönderilecek jeton dizisi içeren bir registrationTokens parametresi alır.
sendToDeviceGroup(notificationKey, payload, options)		Sağlanan bildirim anahtarına karşılık gelen bir cihaz grubuna FCM mesajı gönderir.Kod örnekleri ve ayrıntılı belgeler için Cihaz grubuna gönderme bölümüne bakın.
sendToTopic(konu; yük, seçenekler)		Bir konuya FCM mesajı gönderir.Kod örnekleri ve ayrıntılı belgeler için Konuya gönderme bölümüne bakın.
subscribeToTopic(registrationTokenOrTokens, konu)		Bir cihazı bir FCM konusuna abone yapar.Kod örnekleri ve ayrıntılı belgeler için Bir konuya abone olma bölümüne bakın. İsteğe bağlı olarak, birden çok cihaza abone olmak için bir jeton dizisi sağlayabilirsiniz.
unsubscribeFromTopic(registrationTokenOrTokens, konu)		Bir cihazın, FCM konusundaki bir konunun aboneliğinden çıkarılmasını sağlar.Kod örnekleri ve ayrıntılı belgeler için Konu aboneliğinden çıkma bölümüne bakın. İsteğe bağlı olarak, birden fazla cihazın e-posta listesinden çıkmak için bir jeton dizisi sağlayabilirsiniz.

Mesajlaşma.uygulama

Geçerli Messaging hizmet örneğiyle ilişkilendirilmiş Uygulama.

İmza:

get app(): App;

Örnek

var app = messaging.app;

Messaging.enableLegacyHttpTransport()

Uyarı: Bu API kullanımdan kaldırıldı.

HTTP/2 aktarımının uygulanması eski HTTP/1.1 uygulamasıyla aynı istikrara ulaştığında bu ayar kaldırılacaktır.

sendEach() ve sendEachForMulticast() için eski HTTP/1.1 aktarımının kullanımını etkinleştirir.

İmza:

enableLegacyHttpTransport(): void;

Şunu döndürür:

geçersiz

Örnek

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Messaging.send()

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

İmza:

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

Parametreler

Parametre	Tür	Açıklama
mesaj	Mesaj	Mesaj yükü.
Derleme Çalıştırma	boolean	Mesajın prova (yalnızca doğrulama) modunda gönderilip gönderilmeyeceğini belirler.

Şunu döndürür:

Promise<dize>

İleti, teslim edilmek üzere FCM hizmetine başarıyla teslim edildikten sonra benzersiz bir ileti kimliği dizesiyle gerçekleştirilmiş bir söz.

Messaging.sendAll()

Uyarı: Bu API kullanımdan kaldırıldı.

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

Belirli bir dizideki tüm mesajları Firebase Cloud Messaging üzerinden gönderir. Listenin tamamını tek bir RPC çağrısı olarak göndermek için toplu işleme kullanır. Bu yöntem, send() yöntemiyle karşılaştırıldığında birden fazla mesaj göndermenin çok daha verimli bir yoludur.

Döndürülen değerden elde edilen yanıt listesi, MulticastMessage tablosundaki jetonların sırasına karşılık gelir. Bu yöntemde alınan bir hata, toplam hata olduğunu gösterir. Diğer bir deyişle, listedeki hiçbir ileti gönderilemedi. Kısmi hatalar, BatchResponse değeri döndürerek gösterilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
mesajlar	Mesaj[]	En fazla 500 mesaj içeren boş olmayan bir dizi.
Derleme Çalıştırma	boolean	İletilerin prova (yalnızca doğrulama) modunda gönderilip gönderilmeyeceğini belirler.

Şunu döndürür:

Promise<BatchResponse>

Gönderme işleminin sonucunu temsil eden bir nesneyle birlikte yerine getirilen bir Promise.

Messaging.sendEvery()

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

Messaging.sendAll() yönteminin aksine bu yöntem, belirtilen dizideki her mesaj için tek bir RPC çağrısı yapar.

Döndürülen 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, toplam hata olduğunu gösterir. Diğer bir deyişle, listedeki hiçbir ileti gönderilemez. Kısmi hatalar veya hiç hata yok, yalnızca BatchResponse değeri döndürerek gösterilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
mesajlar	Mesaj[]	En fazla 500 mesaj içeren boş olmayan bir dizi.
Derleme Çalıştırma	boolean	İletilerin prova (yalnızca doğrulama) modunda gönderilip gönderilmeyeceğini belirler.

Şunu döndürür:

Promise<BatchResponse>

Gönderme işleminin sonucunu temsil eden bir nesneyle birlikte yerine getirilen bir Promise.

Messaging.sendEveryForMulticast()

Belirtilen çoklu yayın mesajını, belirtilen tüm FCM kayıt jetonlarına gönderir.

Bu yöntem, belirtilen iletiyi tüm hedef alıcılara göndermek için arka planda Messaging.sendEvery() API'sini kullanır. Döndürülen değerden elde edilen yanıt listesi, MulticastMessage tablosundaki jetonların sırasına karşılık gelir. Bu yöntemden kaynaklanan bir hata veya tüm hataları içeren bir BatchResponse, toplam hata olduğunu gösterir. Bu, listedeki iletilerin gönderilebileceği anlamına gelir. Kısmi arızalar yalnızca BatchResponse değeri döndürerek gösterilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
mesaj	MulticastMessage	En fazla 500 jeton içeren çoklu yayın mesajı.
Derleme Çalıştırma	boolean	Mesajın prova (yalnızca doğrulama) modunda gönderilip gönderilmeyeceğini belirler.

Şunu döndürür:

Promise<BatchResponse>

Gönderme işleminin sonucunu temsil eden bir nesneyle birlikte yerine getirilen bir Promise.

Messaging.sendMulticast()

Uyarı: Bu API kullanımdan kaldırıldı.

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

Belirtilen çoklu yayın mesajını, belirtilen tüm FCM kayıt jetonlarına gönderir.

Bu yöntemde, belirtilen mesajı tüm hedef alıcılara göndermek için arka planda sendAll() API kullanılır. Döndürülen değerden elde edilen yanıt listesi, MulticastMessage tablosundaki jetonların sırasına karşılık gelir. Bu yöntemden kaynaklanan bir hata, toplam hata olduğunu gösterir. Yani ileti, listedeki hiçbir jetona gönderilmemiştir. Kısmi hatalar, BatchResponse değeri döndürerek gösterilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
mesaj	MulticastMessage	En fazla 500 jeton içeren çoklu yayın mesajı.
Derleme Çalıştırma	boolean	Mesajın prova (yalnızca doğrulama) modunda gönderilip gönderilmeyeceğini belirler.

Şunu döndürür:

Promise<BatchResponse>

Gönderme işleminin sonucunu temsil eden bir nesneyle birlikte yerine getirilen bir Promise.

Messaging.sendToCondition()

Bir koşula FCM mesajı gönderir.

Kod örnekleri ve ayrıntılı belgeler için Bir koşula gönderme bölümüne bakın.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
koşul	dize	Mesajın hangi konulara gönderileceğini belirleyen koşul.
yük	Mesajlaşma yükü	Mesaj yükü.
seçenekler	MessagingOptions	Mesajı değiştirmek için sunulan isteğe bağlı seçenekler.

Şunu döndürür:

Promise<MessagingConditionResponse>

İleti gönderildikten sonra sunucunun yanıtıyla ilgili söz yerine getirildi.

Messaging.sendToDevice()

Uyarı: Bu API kullanımdan kaldırıldı.

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

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

Kod örnekleri ve ayrıntılı dokümanlar için Ayrı ayrı cihazlara gönderme başlıklı makaleye bakın. Tek bir cihaza göndermek için registrationToken veya birden fazla cihaza gönderilecek jeton dizisi içeren bir registrationTokens parametresi alır.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
kayıtTokenOrToken'ları	dize | dize[]
yük	Mesajlaşma yükü	Mesaj yükü.
seçenekler	MessagingOptions	Mesajı değiştirmek için sunulan isteğe bağlı seçenekler.

Şunu döndürür:

Promise<MessagingDevicesResponse>

İleti gönderildikten sonra sunucunun yanıtıyla ilgili söz yerine getirildi.

Messaging.sendToDeviceGroup()

Uyarı: Bu API kullanımdan kaldırıldı.

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

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

Kod örnekleri ve ayrıntılı dokümanlar için Cihaz grubuna gönderme başlıklı makaleye bakın.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
bildirim Anahtarı	dize	Mesajın gönderileceği cihaz grubunun bildirim anahtarı.
yük	Mesajlaşma yükü	Mesaj yükü.
seçenekler	MessagingOptions	Mesajı değiştirmek için sunulan isteğe bağlı seçenekler.

Şunu döndürür:

Promise<MessagingDeviceGroupResponse>

İleti gönderildikten sonra sunucunun yanıtıyla ilgili söz yerine getirildi.

Messaging.sendToTopic()

Bir konuya FCM mesajı gönderir.

Kod örnekleri ve ayrıntılı belgeler için Bir konuya gönderme bölümüne bakın.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
konu	dize	Mesajın gönderileceği konu.
yük	Mesajlaşma yükü	Mesaj yükü.
seçenekler	MessagingOptions	Mesajı değiştirmek için sunulan isteğe bağlı seçenekler.

Şunu döndürür:

Promise<MessagingTopicResponse>

İleti gönderildikten sonra sunucunun yanıtıyla ilgili söz yerine getirildi.

Messaging.subscribeToTopic()

Bir cihazı bir FCM konusuna kaydeder.

Kod örnekleri ve ayrıntılı belgeler için Bir konuya abone olma başlıklı makaleye bakın. İsteğe bağlı olarak, birden çok cihaza abone olmak için bir jeton dizisi sağlayabilirsiniz.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
kayıtTokenOrToken'ları	dize | dize[]
konu	dize	Abone olunacak konu.

Şunu döndürür:

Promise<MessagingTopicManagementResponse>

Cihaz konuya abone olduktan sonra sunucunun yanıtıyla birlikte taahhüt yerine getirildi.

Messaging.unsubscribeFromTopic()

Bir cihazın, FCM konusunun aboneliğinden çıkarır.

Kod örnekleri ve ayrıntılı belgeler için Bir konu aboneliğinden çıkma bölümüne bakın. İsteğe bağlı olarak, birden fazla cihazın e-posta listesinden çıkmak için bir jeton dizisi sağlayabilirsiniz.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
kayıtTokenOrToken'ları	dize | dize[]
konu	dize	Abonelikten çıkılacak konu.

Şunu döndürür:

Promise<MessagingTopicManagementResponse>

Cihazın konu aboneliğinden çıktıktan sonra sunucunun yanıtıyla birlikte verilen bir söz.