Messaging class

An die bereitgestellte App gebundener Messaging-Dienst.

Unterschrift:

export declare class Messaging 

Eigenschaften

Eigentum	Modifikatoren	Typ	Beschreibung
App		App	Die App , die der aktuellen Messaging Dienstinstanz zugeordnet ist.

Methoden

Methode	Modifikatoren	Beschreibung
send(Nachricht, dryRun)		Sendet die angegebene Nachricht über FCM.
sendAll(messages, dryRun)		Sendet alle Nachrichten im angegebenen Array über Firebase Cloud Messaging. Verwendet Batchverarbeitung, um die gesamte Liste als einen einzigen RPC-Aufruf zu senden. Im Vergleich zur send() Methode ist diese Methode eine deutlich effizientere Möglichkeit, mehrere Nachrichten zu versenden. Die aus dem Rückgabewert erhaltene Antwortliste entspricht der Reihenfolge der Token in der MulticastMessage . Ein Fehler dieser Methode weist auf einen Totalausfall hin, d. h. keine der Nachrichten in der Liste konnte gesendet werden. Teilfehler werden durch einen BatchResponse Rückgabewert angezeigt.
sendEach(messages, dryRun)		Sendet jede Nachricht im angegebenen Array über Firebase Cloud Messaging. Im Gegensatz zu Messaging.sendAll() , führt diese Methode einen einzelnen RPC-Aufruf für jede Nachricht im angegebenen Array durch. Die aus dem Rückgabewert erhaltene Antwortliste entspricht der Reihenfolge der messages . Ein Fehler dieser Methode oder eine BatchResponse mit allen Fehlern weist auf einen Totalfehler hin, was bedeutet, dass keine der Nachrichten in der Liste gesendet werden konnte. Teilweise Fehler oder keine Fehler werden nur durch einen BatchResponse Rückgabewert angezeigt.
sendEachForMulticast(message, dryRun)		Sendet die angegebene Multicast-Nachricht an alle darin angegebenen FCM-Registrierungstoken. Diese Methode verwendet die unter der Haube liegende Messaging.sendEach()- API, um die angegebene Nachricht an alle Zielempfänger zu senden. Die aus dem Rückgabewert erhaltene Antwortliste entspricht der Reihenfolge der Token in der MulticastMessage . Ein Fehler dieser Methode oder eine BatchResponse mit allen Fehlern weist auf einen Totalfehler hin, was bedeutet, dass die Nachrichten in der Liste gesendet werden konnten. Teilfehler oder Ausfälle werden nur durch einen BatchResponse Rückgabewert angezeigt.
sendMulticast(Nachricht, dryRun)		Sendet die angegebene Multicast-Nachricht an alle darin angegebenen FCM-Registrierungstoken. Diese Methode verwendet die sendAll() -API unter der Haube, um die gegebene Nachricht an alle Zielempfänger zu senden. Die aus dem Rückgabewert erhaltene Antwortliste entspricht der Reihenfolge der Token in der MulticastMessage . Ein Fehler dieser Methode weist auf einen Totalfehler hin, was bedeutet, dass die Nachricht an keinen der Token in der Liste gesendet wurde. Teilfehler werden durch einen BatchResponse Rückgabewert angezeigt.
sendToCondition(Bedingung, Nutzlast, Optionen)		Sendet eine FCM-Nachricht an eine Bedingung. Codebeispiele und ausführliche Dokumentation finden Sie unter An eine Bedingung senden .
sendToDevice(registrationTokenOrTokens, Nutzlast, Optionen)		Sendet eine FCM-Nachricht an ein einzelnes Gerät, das dem bereitgestellten Registrierungstoken entspricht. Codebeispiele und ausführliche Dokumentation finden Sie unter An einzelne Geräte senden . Akzeptiert entweder ein registrationToken zum Senden an ein einzelnes Gerät oder einen registrationTokens Parameter, der ein Array von Token zum Senden an mehrere Geräte enthält.
sendToDeviceGroup(notificationKey, Nutzlast, Optionen)		Sendet eine FCM-Nachricht an eine Gerätegruppe, die dem bereitgestellten Benachrichtigungsschlüssel entspricht. Codebeispiele und ausführliche Dokumentation finden Sie unter An eine Gerätegruppe senden .
sendToTopic(Thema, Nutzlast, Optionen)		Sendet eine FCM-Nachricht an ein Thema. Codebeispiele und ausführliche Dokumentation finden Sie unter An ein Thema senden .
subscribeToTopic(registrationTokenOrTokens, Thema)		Abonniert ein Gerät für ein FCM-Thema. Codebeispiele und ausführliche Dokumentation finden Sie unter Abonnieren eines Themas . Optional können Sie ein Array von Token bereitstellen, um mehrere Geräte zu abonnieren.
unsubscribeFromTopic(registrationTokenOrTokens, Thema)		Meldet ein Gerät von einem FCM-Thema ab. Codebeispiele und ausführliche Dokumentation finden Sie unter Abmelden von einem Thema . Optional können Sie eine Reihe von Token bereitstellen, um mehrere Geräte abzumelden.

Messaging.app

Die App , die der aktuellen Messaging Dienstinstanz zugeordnet ist.

Unterschrift:

get app(): App;

Beispiel

var app = messaging.app;

Messaging.send()

Sendet die angegebene Nachricht über FCM.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Nachricht	Nachricht	Die Nachrichtennutzlast.
Probelauf	Boolescher Wert	Ob die Nachricht im Probelaufmodus (nur Validierung) gesendet werden soll.

Kehrt zurück:

Versprechen<string>

Ein Versprechen, das mit einer eindeutigen Nachrichten-ID-Zeichenfolge erfüllt wird, nachdem die Nachricht erfolgreich zur Zustellung an den FCM-Dienst übergeben wurde.

Messaging.sendAll()

Warnung: Diese API ist jetzt veraltet.

Verwenden Sie stattdessen Messaging.sendEach() .

Sendet alle Nachrichten im angegebenen Array über Firebase Cloud Messaging. Verwendet Batchverarbeitung, um die gesamte Liste als einen einzigen RPC-Aufruf zu senden. Im Vergleich zur send() Methode ist diese Methode eine deutlich effizientere Möglichkeit, mehrere Nachrichten zu versenden.

Die aus dem Rückgabewert erhaltene Antwortliste entspricht der Reihenfolge der Token in der MulticastMessage . Ein Fehler dieser Methode weist auf einen Totalausfall hin, d. h. keine der Nachrichten in der Liste konnte gesendet werden. Teilfehler werden durch einen BatchResponse Rückgabewert angezeigt.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Mitteilungen	Nachricht []	Ein nicht leeres Array mit bis zu 500 Nachrichten.
Probelauf	Boolescher Wert	Ob die Nachrichten im Probelaufmodus (nur Validierung) gesendet werden sollen.

Kehrt zurück:

Versprechen< BatchResponse >

Ein Versprechen, das mit einem Objekt erfüllt wird, das das Ergebnis des Sendevorgangs darstellt.

Messaging.sendEach()

Sendet jede Nachricht im angegebenen Array über Firebase Cloud Messaging.

Im Gegensatz zu Messaging.sendAll() , führt diese Methode einen einzelnen RPC-Aufruf für jede Nachricht im angegebenen Array durch.

Die aus dem Rückgabewert erhaltene Antwortliste entspricht der Reihenfolge der messages . Ein Fehler dieser Methode oder eine BatchResponse mit allen Fehlern weist auf einen Totalfehler hin, was bedeutet, dass keine der Nachrichten in der Liste gesendet werden konnte. Teilweise Fehler oder keine Fehler werden nur durch einen BatchResponse Rückgabewert angezeigt.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Mitteilungen	Nachricht []	Ein nicht leeres Array mit bis zu 500 Nachrichten.
Probelauf	Boolescher Wert	Ob die Nachrichten im Probelaufmodus (nur Validierung) gesendet werden sollen.

Kehrt zurück:

Versprechen< BatchResponse >

Ein Versprechen, das mit einem Objekt erfüllt wird, das das Ergebnis des Sendevorgangs darstellt.

Messaging.sendEachForMulticast()

Sendet die angegebene Multicast-Nachricht an alle darin angegebenen FCM-Registrierungstoken.

Diese Methode verwendet die unter der Haube liegende Messaging.sendEach()- API, um die angegebene Nachricht an alle Zielempfänger zu senden. Die aus dem Rückgabewert erhaltene Antwortliste entspricht der Reihenfolge der Token in der MulticastMessage . Ein Fehler dieser Methode oder eine BatchResponse mit allen Fehlern weist auf einen Totalfehler hin, was bedeutet, dass die Nachrichten in der Liste gesendet werden konnten. Teilfehler oder Ausfälle werden nur durch einen BatchResponse Rückgabewert angezeigt.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Nachricht	MulticastMessage	Eine Multicast-Nachricht mit bis zu 500 Token.
Probelauf	Boolescher Wert	Ob die Nachricht im Probelaufmodus (nur Validierung) gesendet werden soll.

Kehrt zurück:

Versprechen< BatchResponse >

Ein Versprechen, das mit einem Objekt erfüllt wird, das das Ergebnis des Sendevorgangs darstellt.

Messaging.sendMulticast()

Warnung: Diese API ist jetzt veraltet.

Verwenden Sie stattdessen Messaging.sendEachForMulticast() .

Sendet die angegebene Multicast-Nachricht an alle darin angegebenen FCM-Registrierungstoken.

Diese Methode verwendet die sendAll() -API unter der Haube, um die gegebene Nachricht an alle Zielempfänger zu senden. Die aus dem Rückgabewert erhaltene Antwortliste entspricht der Reihenfolge der Token in der MulticastMessage . Ein Fehler dieser Methode weist auf einen Totalfehler hin, was bedeutet, dass die Nachricht an keinen der Token in der Liste gesendet wurde. Teilfehler werden durch einen BatchResponse Rückgabewert angezeigt.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Nachricht	MulticastMessage	Eine Multicast-Nachricht mit bis zu 500 Token.
Probelauf	Boolescher Wert	Ob die Nachricht im Probelaufmodus (nur Validierung) gesendet werden soll.

Kehrt zurück:

Versprechen< BatchResponse >

Ein Versprechen, das mit einem Objekt erfüllt wird, das das Ergebnis des Sendevorgangs darstellt.

Messaging.sendToCondition()

Sendet eine FCM-Nachricht an eine Bedingung.

Codebeispiele und ausführliche Dokumentation finden Sie unter An eine Bedingung senden .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Zustand	Zeichenfolge	Die Bedingung, die bestimmt, an welche Themen die Nachricht gesendet werden soll.
Nutzlast	MessagingPayload	Die Nachrichtennutzlast.
Optionen	MessagingOptionen	Optionale Optionen zum Ändern der Nachricht.

Kehrt zurück:

Versprechen< MessagingConditionResponse >

Ein Versprechen, das mit der Antwort des Servers erfüllt wird, nachdem die Nachricht gesendet wurde.

Messaging.sendToDevice()

Warnung: Diese API ist jetzt veraltet.

Verwenden Sie stattdessen Messaging.send() .

Sendet eine FCM-Nachricht an ein einzelnes Gerät, das dem bereitgestellten Registrierungstoken entspricht.

Codebeispiele und ausführliche Dokumentation finden Sie unter An einzelne Geräte senden . Akzeptiert entweder ein registrationToken zum Senden an ein einzelnes Gerät oder einen registrationTokens Parameter, der ein Array von Token zum Senden an mehrere Geräte enthält.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
RegistrationTokenOrTokens	Zeichenfolge | string[]
Nutzlast	MessagingPayload	Die Nachrichtennutzlast.
Optionen	MessagingOptionen	Optionale Optionen zum Ändern der Nachricht.

Kehrt zurück:

Versprechen< MessagingDevicesResponse >

Ein Versprechen, das mit der Antwort des Servers erfüllt wird, nachdem die Nachricht gesendet wurde.

Messaging.sendToDeviceGroup()

Warnung: Diese API ist jetzt veraltet.

Verwenden Sie stattdessen Messaging.send() .

Sendet eine FCM-Nachricht an eine Gerätegruppe, die dem bereitgestellten Benachrichtigungsschlüssel entspricht.

Codebeispiele und ausführliche Dokumentation finden Sie unter An eine Gerätegruppe senden .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Benachrichtigungsschlüssel	Zeichenfolge	Der Benachrichtigungsschlüssel für die Gerätegruppe, an die die Nachricht gesendet werden soll.
Nutzlast	MessagingPayload	Die Nachrichtennutzlast.
Optionen	MessagingOptionen	Optionale Optionen zum Ändern der Nachricht.

Kehrt zurück:

Versprechen< MessagingDeviceGroupResponse >

Ein Versprechen, das mit der Antwort des Servers erfüllt wird, nachdem die Nachricht gesendet wurde.

Messaging.sendToTopic()

Sendet eine FCM-Nachricht an ein Thema.

Codebeispiele und ausführliche Dokumentation finden Sie unter An ein Thema senden .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Thema	Zeichenfolge	Das Thema, an das die Nachricht gesendet werden soll.
Nutzlast	MessagingPayload	Die Nachrichtennutzlast.
Optionen	MessagingOptionen	Optionale Optionen zum Ändern der Nachricht.

Kehrt zurück:

Versprechen< MessagingTopicResponse >

Ein Versprechen, das mit der Antwort des Servers erfüllt wird, nachdem die Nachricht gesendet wurde.

Messaging.subscribeToTopic()

Abonniert ein Gerät für ein FCM-Thema.

Codebeispiele und ausführliche Dokumentation finden Sie unter Abonnieren eines Themas . Optional können Sie ein Array von Token bereitstellen, um mehrere Geräte zu abonnieren.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
RegistrationTokenOrTokens	Zeichenfolge | string[]
Thema	Zeichenfolge	Das Thema, das abonniert werden soll.

Kehrt zurück:

Versprechen< MessagingTopicManagementResponse >

Ein Versprechen, das mit der Antwort des Servers erfüllt wird, nachdem das Gerät das Thema abonniert hat.

Messaging.unsubscribeFromTopic()

Meldet ein Gerät von einem FCM-Thema ab.

Codebeispiele und ausführliche Dokumentation finden Sie unter Abmelden von einem Thema . Optional können Sie eine Reihe von Token bereitstellen, um mehrere Geräte abzumelden.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
RegistrationTokenOrTokens	Zeichenfolge | string[]
Thema	Zeichenfolge	Das Thema, von dem Sie sich abmelden möchten.

Kehrt zurück:

Versprechen< MessagingTopicManagementResponse >

Ein Versprechen, das mit der Antwort des Servers erfüllt wird, nachdem das Gerät vom Thema abgemeldet wurde.