NotificationMessagePayload interface

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“ .

Unterschrift:

export interface NotificationMessagePayload 

Eigenschaften

Eigentum Typ Beschreibung
Abzeichen Zeichenfolge Der Wert des Abzeichens auf dem App-Symbol auf dem Startbildschirm. Wenn nicht angegeben, wird das Abzeichen nicht geändert. Bei der Einstellung 0 wird das Abzeichen entfernt. **Plattformen:** iOS
Körper Zeichenfolge Der Textkörper der Benachrichtigung. **Plattformen:** iOS, Android, Web
bodyLocArgs Zeichenfolge Variable Zeichenfolgenwerte, die anstelle der Formatbezeichner in body_loc_key verwendet werden, um den Textkörper an die aktuelle Lokalisierung des Benutzers zu lokalisieren. Der Wert sollte ein stringifiziertes JSON-Array sein. **iOS:** Entspricht loc-args in der APNs-Nutzlast. Weitere Informationen finden Sie unter Payload Key Reference und Localizing the Content of Your Remote Notifications . **Android:** Weitere Informationen finden Sie unter Formatierung und Stil . **Plattformen:** iOS, Android
bodyLockKey Zeichenfolge Der Schlüssel zur Textzeichenfolge in den Zeichenfolgenressourcen der App, der zum Lokalisieren des Textkörpers an die aktuelle Lokalisierung des Benutzers verwendet werden soll. **iOS:** Entspricht dem loc-key in der APNs-Nutzlast. Weitere Informationen finden Sie unter Payload Key Reference und Localizing the Content of Your Remote Notifications . **Android:** Weitere Informationen finden Sie unter String-Ressourcen . **Plattformen:** iOS, Android
clickAction Zeichenfolge Aktion, die mit einem Benutzerklick auf die Benachrichtigung verknüpft ist. Wenn angegeben, wird eine Aktivität mit einem passenden Absichtsfilter gestartet, wenn ein Benutzer auf die Benachrichtigung klickt. * **Plattformen:** Android
Farbe Zeichenfolge Die Farbe des Benachrichtigungssymbols, ausgedrückt im #rrggbb Format. **Plattformen:** Android
Symbol Zeichenfolge Das Symbol der Benachrichtigung. **Android:** Setzt das Benachrichtigungssymbol für die zeichnbare Ressource myicon auf myicon . Wenn Sie diesen Schlüssel nicht in der Anfrage senden, zeigt FCM das in Ihrem App-Manifest angegebene Launcher-Symbol an. **Web:** Die URL, die für das Benachrichtigungssymbol verwendet werden soll. **Plattformen:** Android, Web
Klang Zeichenfolge Der Ton, der abgespielt werden soll, wenn das Gerät eine Benachrichtigung empfängt. Unterstützt „Standard“ für den Standardbenachrichtigungston des Geräts oder den Dateinamen einer in der App gebündelten Soundressource. Sounddateien müssen sich in /res/raw/ befinden. **Plattformen:** Android
Etikett Zeichenfolge Bezeichner, der zum Ersetzen vorhandener Benachrichtigungen in der Benachrichtigungsleiste verwendet wird. Wenn nicht angegeben, erstellt jede Anfrage eine neue Benachrichtigung. Wenn angegeben und bereits eine Benachrichtigung mit demselben Tag angezeigt wird, ersetzt die neue Benachrichtigung die vorhandene in der Benachrichtigungsleiste. **Plattformen:** Android
Titel Zeichenfolge Der Titel der Benachrichtigung. **Plattformen:** iOS, Android, Web
titleLocArgs Zeichenfolge Variable Zeichenfolgenwerte, die anstelle der Formatbezeichner in title_loc_key verwendet werden, um den Titeltext an die aktuelle Lokalisierung des Benutzers zu lokalisieren. Der Wert sollte ein stringifiziertes JSON-Array sein. **iOS:** Entspricht title-loc-args in der APNs-Nutzlast. Weitere Informationen finden Sie unter Payload Key Reference und Localizing the Content of Your Remote Notifications . **Android:** Weitere Informationen finden Sie unter Formatierung und Stil . **Plattformen:** iOS, Android
titleLockKey Zeichenfolge Der Schlüssel zur Titelzeichenfolge in den Zeichenfolgenressourcen der App, der zum Lokalisieren des Titeltexts an die aktuelle Lokalisierung des Benutzers verwendet werden soll. **iOS:** Entspricht dem title-loc-key in der APNs-Nutzlast. Weitere Informationen finden Sie unter Payload Key Reference und Localizing the Content of Your Remote Notifications . **Android:** Weitere Informationen finden Sie unter String-Ressourcen . **Plattformen:** iOS, Android

NotificationMessagePayload.badge

Der Wert des Abzeichens auf dem App-Symbol auf dem Startbildschirm.

Wenn nicht angegeben, wird das Abzeichen nicht geändert.

Wenn auf 0 gesetzt , wird das Abzeichen entfernt.

**Plattformen:** iOS

Unterschrift:

badge?: string;

NotificationMessagePayload.body

Der Textkörper der Benachrichtigung.

**Plattformen:** iOS, Android, Web

Unterschrift:

body?: string;

NotificationMessagePayload.bodyLocArgs

Variable Zeichenfolgenwerte, die anstelle der Formatbezeichner in body_loc_key verwendet werden, um den Textkörper an die aktuelle Lokalisierung des Benutzers zu lokalisieren.

Der Wert sollte ein stringifiziertes JSON-Array sein.

**iOS:** Entspricht loc-args in der APNs-Nutzlast. Weitere Informationen finden Sie unter Payload Key Reference und Localizing the Content of Your Remote Notifications .

**Android:** Weitere Informationen finden Sie unter Formatierung und Stil .

**Plattformen:** iOS, Android

Unterschrift:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

Der Schlüssel zur Textzeichenfolge in den Zeichenfolgenressourcen der App, der zum Lokalisieren des Textkörpers an die aktuelle Lokalisierung des Benutzers verwendet werden soll.

**iOS:** Entspricht dem loc-key in der APNs-Nutzlast. Weitere Informationen finden Sie unter Payload Key Reference und Localizing the Content of Your Remote Notifications .

**Android:** Weitere Informationen finden Sie unter String-Ressourcen .

**Plattformen:** iOS, Android

Unterschrift:

bodyLocKey?: string;

NotificationMessagePayload.clickAction

Aktion, die mit einem Benutzerklick auf die Benachrichtigung verknüpft ist. Wenn angegeben, wird eine Aktivität mit einem passenden Absichtsfilter gestartet, wenn ein Benutzer auf die Benachrichtigung klickt.

* **Plattformen:** Android

Unterschrift:

clickAction?: string;

NotificationMessagePayload.color

Die Farbe des Benachrichtigungssymbols, ausgedrückt im #rrggbb Format.

**Plattformen:** Android

Unterschrift:

color?: string;

NotificationMessagePayload.icon

Das Symbol der Benachrichtigung.

**Android:** Setzt das Benachrichtigungssymbol für die zeichnbare Ressource myicon auf „myicon myicon . . Wenn Sie diesen Schlüssel nicht in der Anfrage senden, zeigt FCM das in Ihrem App-Manifest angegebene Launcher-Symbol an.

**Web:** Die URL, die für das Benachrichtigungssymbol verwendet werden soll.

**Plattformen:** Android, Web

Unterschrift:

icon?: string;

NotificationMessagePayload.sound

Der Ton, der abgespielt werden soll, wenn das Gerät eine Benachrichtigung empfängt. Unterstützt „Standard“ für den Standardbenachrichtigungston des Geräts oder den Dateinamen einer in der App gebündelten Soundressource. Sounddateien müssen sich in /res/raw/ befinden. .

**Plattformen:** Android

Unterschrift:

sound?: string;

NotificationMessagePayload.tag

Bezeichner, der zum Ersetzen vorhandener Benachrichtigungen in der Benachrichtigungsleiste verwendet wird.

Wenn nicht angegeben, erstellt jede Anfrage eine neue Benachrichtigung.

Wenn angegeben und bereits eine Benachrichtigung mit demselben Tag angezeigt wird, ersetzt die neue Benachrichtigung die vorhandene in der Benachrichtigungsleiste.

**Plattformen:** Android

Unterschrift:

tag?: string;

NotificationMessagePayload.title

Der Titel der Benachrichtigung.

**Plattformen:** iOS, Android, Web

Unterschrift:

title?: string;

NotificationMessagePayload.titleLocArgs

Variable Zeichenfolgenwerte, die anstelle der Formatbezeichner in title_loc_key verwendet werden, um den Titeltext an die aktuelle Lokalisierung des Benutzers zu lokalisieren.

Der Wert sollte ein stringifiziertes JSON-Array sein.

**iOS:** Entspricht title-loc-args in der APNs-Nutzlast. Weitere Informationen finden Sie unter Payload Key Reference und Localizing the Content of Your Remote Notifications .

**Android:** Weitere Informationen finden Sie unter Formatierung und Stil .

**Plattformen:** iOS, Android

Unterschrift:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

Der Schlüssel zur Titelzeichenfolge in den Zeichenfolgenressourcen der App, der zum Lokalisieren des Titeltexts an die aktuelle Lokalisierung des Benutzers verwendet werden soll.

**iOS:** Entspricht dem title-loc-key in der APNs-Nutzlast. Weitere Informationen finden Sie unter Payload Key Reference und Localizing the Content of Your Remote Notifications .

**Android:** Weitere Informationen finden Sie unter String-Ressourcen .

**Plattformen:** iOS, Android

Unterschrift:

titleLocKey?: string;