MessagingOptions interface

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

Unterschrift:

export interface MessagingOptions 

Eigenschaften

MessagingOptions.collapseKey

Zeichenfolge, die eine Gruppe von Nachrichten identifiziert (z. B. „Updates verfügbar“), die reduziert werden können, sodass nur die letzte Nachricht gesendet wird, wenn die Zustellung wieder aufgenommen werden kann. Dies wird verwendet, um zu vermeiden, dass zu viele gleiche Nachrichten gesendet werden, wenn das Gerät wieder online geht oder aktiv wird.

Es gibt keine Garantie für die Reihenfolge, in der Nachrichten gesendet werden.

Es sind jeweils maximal vier verschiedene Minimierungsschlüssel zulässig. Das bedeutet, dass der FCM-Server pro Client-App gleichzeitig vier verschiedene Send-to-Sync-Nachrichten speichern kann. Wenn Sie diese Zahl überschreiten, gibt es keine Garantie dafür, welche vier Kollapsschlüssel der FCM-Server behält.

**Standardwert:** Keine

Unterschrift:

collapseKey?: string;

MessagingOptions.contentAvailable

Verwenden Sie unter iOS dieses Feld, um den in der APNs-Nutzlast content-available darzustellen. Wenn eine Benachrichtigung oder Datennachricht gesendet wird und diese auf true gesetzt ist , eine inaktive Client-App wird aktiviert. Unter Android wird die App standardmäßig durch Datennachrichten aktiviert. In Chrome wird dieses Flag derzeit nicht unterstützt.

**Standardwert:** false

Unterschrift:

contentAvailable?: boolean;

MessagingOptions.dryRun

Ob die Nachricht tatsächlich gesendet werden soll oder nicht. Wenn auf true gesetzt ermöglicht es Entwicklern, eine Anfrage zu testen, ohne tatsächlich eine Nachricht zu senden. Wenn auf false gesetzt , die Nachricht wird gesendet.

**Standardwert:** false

Unterschrift:

dryRun?: boolean;

MessagingOptions.mutableContent

Verwenden Sie unter iOS dieses Feld, um mutable-content in der APNs-Nutzlast darzustellen. Wenn eine Benachrichtigung gesendet wird und diese auf true gesetzt ist Mit einer Notification Service-App-Erweiterung kann der Inhalt der Benachrichtigung vor der Anzeige geändert werden .

Auf Android und Web wird dieser Parameter ignoriert.

**Standardwert:** false

Unterschrift:

mutableContent?: boolean;

MessagingOptions.priority

Die Priorität der Nachricht. Gültige Werte sind "normal" und "high". Unter iOS entsprechen diese den APN-Prioritäten 5 und 10 .

Standardmäßig werden Benachrichtigungsnachrichten mit hoher Priorität und Datennachrichten mit normaler Priorität gesendet. Die normale Priorität optimiert den Batterieverbrauch der Client-App und sollte verwendet werden, es sei denn, eine sofortige Lieferung ist erforderlich. Bei Nachrichten mit normaler Priorität empfängt die App die Nachricht möglicherweise mit unbestimmter Verzögerung.

Wenn eine Nachricht mit hoher Priorität gesendet wird, wird sie sofort gesendet und die App kann ein in den Ruhezustand versetztes Gerät wecken und eine Netzwerkverbindung zu Ihrem Server herstellen.

Weitere Informationen finden Sie unter Festlegen der Priorität einer Nachricht .

**Standardwert:** "high" für Benachrichtigungsnachrichten, "normal" für Datennachrichten

Unterschrift:

priority?: string;

MessagingOptions.restrictedPackageName

Der Paketname der Anwendung, mit dem die Registrierungstoken übereinstimmen müssen, um die Nachricht zu empfangen.

**Standardwert:** Keine

Unterschrift:

restrictedPackageName?: string;

MessagingOptions.timeToLive

Wie lange (in Sekunden) die Nachricht im FCM-Speicher aufbewahrt werden soll, wenn das Gerät offline ist. Die maximale unterstützte Lebensdauer beträgt vier Wochen, der Standardwert beträgt ebenfalls vier Wochen. Weitere Informationen finden Sie unter Festlegen der Lebensdauer einer Nachricht .

**Standardwert:** 2419200 (entspricht vier Wochen, in Sekunden)

Unterschrift:

timeToLive?: number;