Firebase Cloud Messaging (FCM).
Funktionen
| Funktion | Beschreibung |
|---|---|
| getMessaging(app) | Ruft den Messaging- Dienst für die Standard-App oder eine bestimmte App ab. admin.messaging() kann ohne Argumente aufgerufen werden, um auf den Messaging Dienst der Standard-App zuzugreifen, oder als admin.messaging(app) um auf den Messaging Dienst zuzugreifen, der einer bestimmten App zugeordnet ist. |
Klassen
| Klasse | Beschreibung |
|---|---|
| Nachrichten | An die bereitgestellte App gebundener Messaging-Dienst. |
Schnittstellen
| Schnittstelle | Beschreibung |
|---|---|
| AndroidConfig | Stellt die Android-spezifischen Optionen dar, die in eine Nachricht eingefügt werden können . |
| AndroidFcmOptions | Stellt Optionen für Funktionen dar, die vom FCM SDK für Android bereitgestellt werden. |
| AndroidNotification | Stellt die Android-spezifischen Benachrichtigungsoptionen dar, die in AndroidConfig einbezogen werden können . |
| ApnsConfig | Stellt die APNs-spezifischen Optionen dar, die in eine Nachricht aufgenommen werden können . Informationen zu verschiedenen von APNs unterstützten Headern und Nutzlastfeldern finden Sie in der Apple-Dokumentation . |
| ApnsFcmOptions | Stellt Optionen für Funktionen dar, die vom FCM SDK für iOS bereitgestellt werden. |
| ApnsPayload | Stellt die Nutzlast einer APNs-Nachricht dar. Besteht hauptsächlich aus dem aps Wörterbuch. Kann aber auch andere beliebige benutzerdefinierte Schlüssel enthalten. |
| Aps | Stellt das APS-Wörterbuch dar, das Teil der APNs-Nachrichten ist. |
| ApsAlert | |
| BaseMessage | |
| BatchResponse | Schnittstelle, die die Serverantwort der Methoden Messaging.sendAll() und Messaging.sendMulticast() darstellt. |
| Bedingungsnachricht | |
| CriticalSound | Stellt eine kritische Soundkonfiguration dar, die in das aps Wörterbuch einer APNs-Nutzlast aufgenommen werden kann. |
| DataMessagePayload | Schnittstelle, die eine FCM-Legacy-API-Datennachrichtennutzlast darstellt. Mit Datennachrichten können Entwickler bis zu 4 KB benutzerdefinierte Schlüssel-Wert-Paare senden. Sowohl die Schlüssel als auch die Werte müssen Zeichenfolgen sein. Schlüssel können beliebige benutzerdefinierte Zeichenfolgen sein, mit Ausnahme der folgenden reservierten Zeichenfolgen:
|
| FcmOptions | Stellt plattformunabhängige Optionen für Funktionen dar, die von den FCM SDKs bereitgestellt werden. |
| Lichteinstellungen | Stellt Einstellungen zur Steuerung der Benachrichtigungs-LED dar, die in AndroidNotification enthalten sein können . |
| MessagingConditionResponse | Schnittstelle, die die Serverantwort von der alten Messaging.sendToCondition() -Methode darstellt. Codebeispiele und ausführliche Dokumentation finden Sie unter An eine Bedingung senden . |
| MessagingDeviceGroupResponse | Schnittstelle, die die Serverantwort von der Methode Messaging.sendToDeviceGroup() darstellt. Codebeispiele und ausführliche Dokumentation finden Sie unter Senden von Nachrichten an Gerätegruppen . |
| MessagingDeviceResult | Individuelle Statusantwort-Payload von einzelnen Geräten |
| MessagingDevicesResponse | Schnittstelle, die den Status einer Nachricht darstellt, die über die FCM-Legacy-APIs an ein einzelnes Gerät gesendet wird. Codebeispiele und ausführliche Dokumentation finden Sie unter An einzelne Geräte senden . |
| MessagingOptionen | Schnittstelle, die die Optionen darstellt, die beim Senden einer Nachricht über die FCM-Legacy-APIs bereitgestellt werden können. Codebeispiele und ausführliche Dokumentation finden Sie unter „Sendeanforderungen erstellen“ . |
| MessagingPayload | Schnittstelle, die eine Firebase Cloud Messaging-Nachrichtennutzlast darstellt. Einer oder beide der data und notification sind erforderlich. Codebeispiele und ausführliche Dokumentation finden Sie unter „Sendeanforderungen erstellen“ . |
| MessagingTopicManagementResponse | Schnittstelle, die die Serverantwort der Methoden Messaging.subscribeToTopic() und Messaging.unsubscribeFromTopic() darstellt. Codebeispiele und ausführliche Dokumentation finden Sie unter Themen vom Server aus verwalten . |
| MessagingTopicResponse | Schnittstelle, die die Serverantwort von der alten Messaging.sendToTopic() -Methode darstellt. Codebeispiele und ausführliche Dokumentation finden Sie unter An ein Thema senden . |
| MulticastMessage | Nutzlast für die Messaging.sendMulticast()- Methode. Die Nutzlast enthält alle Felder im Typ BaseMessage und eine Liste von Tokens. |
| Benachrichtigung | Eine Benachrichtigung, die in die Nachricht eingefügt werden kann . |
| NotificationMessagePayload | Schnittstelle, die eine Nutzlast einer FCM-Legacy-API-Benachrichtigungsnachricht darstellt. Mit Benachrichtigungsnachrichten können Entwickler bis zu 4 KB vordefinierter Schlüssel-Wert-Paare senden. Die akzeptierten Schlüssel sind unten aufgeführt. Codebeispiele und ausführliche Dokumentation finden Sie unter „Sendeanforderungen erstellen“ . |
| Antwort senden | Schnittstelle, die den Status einer einzelnen Nachricht darstellt, die als Teil einer Batch-Anfrage gesendet wurde. |
| TokenMessage | |
| ThemaNachricht | |
| WebpushConfig | Stellt die WebPush-Protokolloptionen dar, die in eine Nachricht eingefügt werden können . |
| WebpushFcmOptions | Stellt Optionen für Funktionen dar, die vom FCM SDK für Web bereitgestellt werden (die nicht Teil des Webpush-Standards sind). |
| WebpushBenachrichtigung | Stellt die WebPush-spezifischen Benachrichtigungsoptionen dar, die in WebpushConfig enthalten sein können . Dies unterstützt die meisten Standardoptionen, wie in der Web Notification- Spezifikation definiert . |
Geben Sie Aliase ein
| Geben Sie Alias ein | Beschreibung |
|---|---|
| Nachricht | Nutzlast für den Messaging.send() -Vorgang. Die Nutzlast enthält alle Felder im Typ BaseMessage und genau eines von Token, Thema oder Bedingung. |
getMessaging()
Ruft den Messaging- Dienst für die Standard-App oder eine bestimmte App ab.
admin.messaging() kann ohne Argumente aufgerufen werden, um auf den Messaging Dienst der Standard-App zuzugreifen, oder als admin.messaging(app) um auf den Messaging Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
Unterschrift:
export declare function getMessaging(app?: App): Messaging;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| App | App | Optionale App, deren Messaging Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der Standard- Messaging Dienst zurückgegeben. |
Kehrt zurück:
Der Standard- Messaging Dienst, wenn keine App bereitgestellt wird, oder der Messaging Dienst, der mit der bereitgestellten App verknüpft ist.
Beispiel 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
Beispiel 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
Nachricht
Nutzlast für den Messaging.send() -Vorgang. Die Nutzlast enthält alle Felder im Typ BaseMessage und genau eines von Token, Thema oder Bedingung.
Unterschrift:
export type Message = TokenMessage | TopicMessage | ConditionMessage;