WebpushNotification interface

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 .

Unterschrift:

export interface WebpushNotification

Eigenschaften

Eigentum Typ Beschreibung
Aktionen Array<{ action: string; Symbol?: Zeichenfolge; Titel: Zeichenfolge; }> Ein Array von Benachrichtigungsaktionen, die die Aktionen darstellen, die dem Benutzer zur Verfügung stehen, wenn die Benachrichtigung angezeigt wird.
Abzeichen Zeichenfolge URL des Bildes, das zur Darstellung der Benachrichtigung verwendet wird, wenn nicht genügend Platz für die Anzeige der Benachrichtigung selbst vorhanden ist.
Körper Zeichenfolge Haupttext der Benachrichtigung.
Daten beliebig Beliebige Daten, die Sie mit der Benachrichtigung verknüpfen möchten. Dies kann ein beliebiger Datentyp sein.
dir 'auto' | 'ltr' | 'rtl' Die Richtung, in der die Benachrichtigung angezeigt werden soll. Muss entweder auto , ltr oder rtl sein.
Symbol Zeichenfolge URL zum Benachrichtigungssymbol.
Bild Zeichenfolge URL eines Bildes, das in der Benachrichtigung angezeigt werden soll.
lang Zeichenfolge Die Sprache der Benachrichtigung als BCP 47-Sprachtag.
erneut anmelden Boolescher Wert Ein boolescher Wert, der angibt, ob der Benutzer benachrichtigt werden soll, nachdem eine neue Benachrichtigung eine alte ersetzt. Der Standardwert ist „false“.
erfordernInteraktion Boolescher Wert Gibt an, dass eine Benachrichtigung aktiv bleiben soll, bis der Benutzer darauf klickt oder sie schließt, anstatt automatisch zu schließen. Der Standardwert ist „false“.
still Boolescher Wert Ein boolescher Wert, der angibt, ob die Benachrichtigung still sein soll. Der Standardwert ist „false“.
Etikett Zeichenfolge Ein identifizierendes Tag für die Benachrichtigung.
Zeitstempel Nummer Zeitstempel der Benachrichtigung. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/notification/timestamp.
Titel Zeichenfolge Titeltext der Benachrichtigung.
vibrieren Nummer | Nummer[] Ein Vibrationsmuster, das die Vibrationshardware des Geräts aussendet, wenn die Benachrichtigung ausgelöst wird.

WebpushNotification.actions

Ein Array von Benachrichtigungsaktionen, die die Aktionen darstellen, die dem Benutzer zur Verfügung stehen, wenn die Benachrichtigung angezeigt wird.

Unterschrift:

actions?: Array<{
        action: string;
        icon?: string;
        title: string;
    }>;

WebpushNotification.badge

URL des Bildes, das zur Darstellung der Benachrichtigung verwendet wird, wenn nicht genügend Platz für die Anzeige der Benachrichtigung selbst vorhanden ist.

Unterschrift:

badge?: string;

WebpushNotification.body

Haupttext der Benachrichtigung.

Unterschrift:

body?: string;

WebpushNotification.data

Beliebige Daten, die Sie mit der Benachrichtigung verknüpfen möchten. Dies kann ein beliebiger Datentyp sein.

Unterschrift:

data?: any;

WebpushNotification.dir

Die Richtung, in der die Benachrichtigung angezeigt werden soll. Muss ein auto sein , ltr oder rtl .

Unterschrift:

dir?: 'auto' | 'ltr' | 'rtl';

WebpushNotification.icon

URL zum Benachrichtigungssymbol.

Unterschrift:

icon?: string;

WebpushNotification.image

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

Unterschrift:

image?: string;

WebpushNotification.lang

Die Sprache der Benachrichtigung als BCP 47-Sprachtag.

Unterschrift:

lang?: string;

WebpushNotification.renotify

Ein boolescher Wert, der angibt, ob der Benutzer benachrichtigt werden soll, nachdem eine neue Benachrichtigung eine alte ersetzt. Der Standardwert ist „false“.

Unterschrift:

renotify?: boolean;

WebpushNotification.requireInteraction

Gibt an, dass eine Benachrichtigung aktiv bleiben soll, bis der Benutzer darauf klickt oder sie schließt, anstatt automatisch zu schließen. Der Standardwert ist „false“.

Unterschrift:

requireInteraction?: boolean;

WebpushNotification.silent

Ein boolescher Wert, der angibt, ob die Benachrichtigung still sein soll. Der Standardwert ist „false“.

Unterschrift:

silent?: boolean;

WebpushNotification.tag

Ein identifizierendes Tag für die Benachrichtigung.

Unterschrift:

tag?: string;

WebpushNotification.timestamp

Zeitstempel der Benachrichtigung. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/notification/timestamp.

Unterschrift:

timestamp?: number;

WebpushNotification.title

Titeltext der Benachrichtigung.

Unterschrift:

title?: string;

WebpushNotification.vibrate

Ein Vibrationsmuster, das die Vibrationshardware des Geräts aussendet, wenn die Benachrichtigung ausgelöst wird.

Unterschrift:

vibrate?: number | number[];