AndroidNotification interface

Stellt die Android-spezifischen Benachrichtigungsoptionen dar, die in AndroidConfig einbezogen werden können .

Unterschrift:

export interface AndroidNotification 

Eigenschaften

AndroidNotification.body

Text der Android-Benachrichtigung. Wenn bereitgestellt, überschreibt es den über admin.messaging.Notification festgelegten Text .

Unterschrift:

body?: string;

AndroidNotification.bodyLocArgs

Ein Array von Ressourcenschlüsseln, die anstelle der Formatspezifizierer in bodyLocKey verwendet werden .

Unterschrift:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

Schlüssel der Textzeichenfolge in der Zeichenfolgenressource der App, der zum Lokalisieren des Textkörpers verwendet werden soll.

Unterschrift:

bodyLocKey?: string;

AndroidNotification.channelId

Die Android-Benachrichtigungskanal-ID (neu in Android O). Die App muss einen Kanal mit dieser Kanal-ID erstellen, bevor eine Benachrichtigung mit dieser Kanal-ID empfangen werden kann. Wenn Sie diese Kanal-ID nicht in der Anfrage senden oder die bereitgestellte Kanal-ID noch nicht von der App erstellt wurde, verwendet FCM die im App-Manifest angegebene Kanal-ID.

Unterschrift:

channelId?: string;

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

Unterschrift:

clickAction?: string;

AndroidNotification.color

Farbe des Benachrichtigungssymbols im #rrggbb -Format.

Unterschrift:

color?: string;

AndroidNotification.defaultLightSettings

Wenn auf true gesetzt , verwenden Sie für die Benachrichtigung die Standard-LED-Lichteinstellungen des Android-Frameworks. Standardwerte werden in config.xml angegeben . Wenn default_light_settings auf true gesetzt ist und „ light_settings ebenfalls festgelegt ist, werden die vom Benutzer angegebenen light_settings anstelle des Standardwerts verwendet.

Unterschrift:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

Wenn auf true gesetzt , verwenden Sie den Standardton des Android-Frameworks für die Benachrichtigung. Standardwerte werden in config.xml angegeben .

Unterschrift:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

Wenn auf true gesetzt , verwenden Sie das Standardvibrationsmuster des Android-Frameworks für die Benachrichtigung. Standardwerte werden in config.xml angegeben . Wenn default_vibrate_timings auf true gesetzt ist und vibrate_timings ebenfalls festgelegt ist, wird der Standardwert anstelle der vom Benutzer angegebenen vibrate_timings verwendet .

Unterschrift:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

Legt bei Benachrichtigungen, die Benutzer über Ereignisse mit absolutem Zeitbezug informieren, den Zeitpunkt fest, zu dem das Ereignis in der Benachrichtigung aufgetreten ist. Benachrichtigungen im Panel werden nach dieser Zeit sortiert.

Unterschrift:

eventTimestamp?: Date;

AndroidNotification.icon

Symbolressource für die Android-Benachrichtigung.

Unterschrift:

icon?: string;

AndroidNotification.imageUrl

URL eines Bildes, das in der Benachrichtigung angezeigt werden soll.

Unterschrift:

imageUrl?: string;

AndroidNotification.lightSettings

Einstellungen zur Steuerung der LED-Blinkrate und -Farbe der Benachrichtigung, wenn eine LED auf dem Gerät verfügbar ist. Die Gesamtblinkzeit wird vom Betriebssystem gesteuert.

Unterschrift:

lightSettings?: LightSettings;

AndroidNotification.localOnly

Legt fest, ob diese Benachrichtigung nur für das aktuelle Gerät relevant ist oder nicht. Einige Benachrichtigungen können zur Fernanzeige auf andere Geräte übertragen werden, beispielsweise auf eine Wear OS-Uhr. Dieser Hinweis kann so eingestellt werden, dass empfohlen wird, diese Benachrichtigung nicht zu überbrücken. Siehe Wear OS-Anleitungen .

Unterschrift:

localOnly?: boolean;

AndroidNotification.notificationCount

Legt die Anzahl der Elemente fest, die diese Benachrichtigung darstellt. Kann als Badge-Anzahl für Launcher angezeigt werden, die Badges unterstützen. Siehe NotificationBadge . Dies kann beispielsweise nützlich sein, wenn Sie nur eine Benachrichtigung verwenden, um mehrere neue Nachrichten darzustellen, die Anzahl hier jedoch die Gesamtzahl der neuen Nachrichten darstellen soll. Wenn Null oder nicht angegeben, verwenden Systeme, die Badges unterstützen, die Standardeinstellung, die darin besteht, jedes Mal, wenn eine neue Benachrichtigung eintrifft, eine Zahl zu erhöhen, die im Menü für langes Drücken angezeigt wird.

Unterschrift:

notificationCount?: number;

AndroidNotification.priority

Legt die relative Priorität für diese Benachrichtigung fest. Benachrichtigungen mit niedriger Priorität können in bestimmten Situationen für den Benutzer verborgen bleiben. Beachten Sie, dass sich diese Priorität von AndroidMessagePriority unterscheidet . Diese Priorität wird vom Client verarbeitet, nachdem die Nachricht zugestellt wurde. AndroidMessagePriority hingegen ist ein FCM-Konzept, das steuert, wann die Nachricht zugestellt wird.

Unterschrift:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.sound

Dateiname des Sounds, der abgespielt werden soll, wenn das Gerät die Benachrichtigung empfängt.

Unterschrift:

sound?: string;

AndroidNotification.sticky

Wenn sie auf false oder nicht gesetzt gesetzt ist, wird die Benachrichtigung automatisch verworfen, wenn der Benutzer im Panel darauf klickt. Wenn auf true gesetzt , bleibt die Benachrichtigung bestehen, auch wenn der Benutzer darauf klickt.

Unterschrift:

sticky?: boolean;

AndroidNotification.tag

Benachrichtigungs-Tag. Dies ist eine Kennung, die zum Ersetzen vorhandener Benachrichtigungen in der Benachrichtigungsleiste verwendet wird. Wenn nicht angegeben, erstellt jede Anfrage eine neue Benachrichtigung.

Unterschrift:

tag?: string;

AndroidNotification.ticker

Legt den „Ticker“-Text fest, der an Barrierefreiheitsdienste gesendet wird. Legt vor API-Level 21 (Lollipop) den Text fest, der in der Statusleiste angezeigt wird, wenn die Benachrichtigung zum ersten Mal eintrifft.

Unterschrift:

ticker?: string;

AndroidNotification.title

Titel der Android-Benachrichtigung. Sofern angegeben, wird der über admin.messaging.Notification festgelegte Titel überschrieben .

Unterschrift:

title?: string;

AndroidNotification.titleLocArgs

Ein Array von Ressourcenschlüsseln, die anstelle der Formatspezifizierer in titleLocKey verwendet werden .

Unterschrift:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

Schlüssel der Titelzeichenfolge in der Zeichenfolgenressource der App, der zum Lokalisieren des Titeltexts verwendet werden soll.

Unterschrift:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

Legt das zu verwendende Vibrationsmuster fest. Verbringen Sie eine Reihe von Millisekunden, um den Vibrator ein- oder auszuschalten. Der erste Wert gibt die Wartezeit an, bevor der Vibrator eingeschaltet wird. Der nächste Wert gibt die Dauer an, für die der Vibrator eingeschaltet bleibt. Nachfolgende Werte wechseln zwischen der Dauer zum Ausschalten und Einschalten des Vibrators. Wenn vibrate_timings gesetzt ist und default_vibrate_timings auf true gesetzt ist , wird der Standardwert anstelle der vom Benutzer angegebenen vibrate_timings verwendet .

Unterschrift:

vibrateTimingsMillis?: number[];

AndroidNotification.visibility

Legt die Sichtbarkeit der Benachrichtigung fest. Muss entweder private sein , public , oder secret . Wenn nicht angegeben, wird standardmäßig private verwendet .

Unterschrift:

visibility?: ('private' | 'public' | 'secret');