@firebase/messaging

Funktionen

Funktion	Beschreibung
Funktion(App, ...)
getMessaging(app)	Ruft eine Firebase Cloud Messaging-Instanz ab.
Funktion (Messaging, ...)
deleteToken(Messaging)	Löscht das dieser Messaging- Instanz zugeordnete Registrierungstoken und meldet das Push-Abonnement der Messaging- Instanz ab.
getToken(Messaging, Optionen)	Abonniert die Messaging- Instanz für Push-Benachrichtigungen. Gibt ein Firebase Cloud Messaging-Registrierungstoken zurück, das zum Senden von Push-Nachrichten an diese Messaging- Instanz verwendet werden kann. Wenn die Benachrichtigungsberechtigung noch nicht erteilt wurde, fragt diese Methode den Benutzer um Erlaubnis. Das zurückgegebene Versprechen wird abgelehnt, wenn der Benutzer nicht zulässt, dass die App Benachrichtigungen anzeigt.
onMessage(messaging, nextOrObserver)	Wenn eine Push-Nachricht empfangen wird und sich der Benutzer derzeit auf einer Seite Ihres Ursprungs befindet, wird die Nachricht an die Seite weitergeleitet und ein onMessage() Ereignis mit der Nutzlast der Push-Nachricht gesendet.
Funktion()
wird unterstützt()	Prüft, ob alle erforderlichen APIs im Browser vorhanden sind.

Schnittstellen

Schnittstelle	Beschreibung
FcmOptions	Optionen für Funktionen, die vom FCM SDK für Web bereitgestellt werden. Siehe WebpushFcmOptions .
GetTokenOptions	Optionen für getToken() .
Nachrichtennutzlast	Nachrichtennutzlast, die die Benachrichtigungsnutzlast enthält, die mit NotificationPayload dargestellt wird, und die Datennutzlast, die eine beliebige Anzahl von Schlüssel-Wert-Paaren enthält, die von Entwicklern über die Sende-API gesendet werden .
Nachrichten	Öffentliche Schnittstelle des Firebase Cloud Messaging SDK.
Benachrichtigungsnutzlast	Benachrichtigungsdetails anzeigen. Details werden über die Sende-API gesendet .

Funktion(App, ...)

getMessaging(app)

Ruft eine Firebase Cloud Messaging-Instanz ab.

Unterschrift:

export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;

Parameter

Parameter	Typ	Beschreibung
App	FirebaseApp

Kehrt zurück:

Nachrichten

Die Firebase Cloud Messaging-Instanz, die der bereitgestellten Firebase-App zugeordnet ist.

Funktion (Messaging, ...)

deleteToken(Messaging)

Löscht das dieser Messaging- Instanz zugeordnete Registrierungstoken und meldet das Push-Abonnement der Messaging- Instanz ab.

Unterschrift:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Parameter

Parameter	Typ	Beschreibung
Nachrichtenübermittlung	Nachrichten	Die Messaging- Instanz.

Kehrt zurück:

Versprechen<boolean>

Das Versprechen wird aufgelöst, wenn das Token erfolgreich gelöscht wurde.

getToken(Messaging, Optionen)

Abonniert die Messaging- Instanz für Push-Benachrichtigungen. Gibt ein Firebase Cloud Messaging-Registrierungstoken zurück, das zum Senden von Push-Nachrichten an diese Messaging- Instanz verwendet werden kann.

Wenn die Benachrichtigungsberechtigung noch nicht erteilt wurde, fragt diese Methode den Benutzer um Erlaubnis. Das zurückgegebene Versprechen wird abgelehnt, wenn der Benutzer nicht zulässt, dass die App Benachrichtigungen anzeigt.

Unterschrift:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Parameter

Parameter	Typ	Beschreibung
Nachrichtenübermittlung	Nachrichten	Die Messaging- Instanz.
Optionen	GetTokenOptions	Bietet einen optionalen Vapid-Schlüssel und eine optionale Registrierung für Servicemitarbeiter.

Kehrt zurück:

Versprechen<string>

Das Versprechen wird mit einem FCM-Registrierungstoken gelöst.

onMessage(messaging, nextOrObserver)

Wenn eine Push-Nachricht empfangen wird und sich der Benutzer derzeit auf einer Seite Ihres Ursprungs befindet, wird die Nachricht an die Seite weitergeleitet und ein onMessage() Ereignis mit der Nutzlast der Push-Nachricht gesendet.

Unterschrift:

export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

Parameter

Parameter	Typ	Beschreibung
Nachrichtenübermittlung	Nachrichten	Die Messaging- Instanz.
nextOrObserver	NextFn < MessagePayload > | Beobachter < MessagePayload >	Diese Funktion bzw. das Beobachterobjekt mit der Definition next wird aufgerufen, wenn eine Nachricht empfangen wird und der Benutzer gerade Ihre Seite anzeigt.

Kehrt zurück:

Abbestellen

Um das Abhören von Nachrichten zu beenden, führen Sie diese zurückgegebene Funktion aus.

Funktion()

wird unterstützt()

Überprüft, ob alle erforderlichen APIs im Browser vorhanden sind.

Unterschrift:

export declare function isWindowSupported(): Promise<boolean>;

Kehrt zurück:

Versprechen<boolean>

ein Versprechen, das in einen booleschen Wert aufgelöst wird.