@firebase/messaging/sw

Funktionen

Funktion	Beschreibung
Funktion(App, ...)
getMessaging(app)	Ruft eine Firebase Cloud Messaging-Instanz ab.
Funktion (Messaging, ...)
experimentellSetDeliveryMetricsExportedToBigQueryEnabled(Messaging, aktivieren)	Aktiviert oder deaktiviert den Export von Nachrichtenübermittlungsmetriken von Firebase Cloud Messaging nach BigQuery. Standardmäßig werden Nachrichtenzustellungsmetriken nicht nach BigQuery exportiert. Mit dieser Methode können Sie den Export zur Laufzeit aktivieren oder deaktivieren.
onBackgroundMessage(messaging, nextOrObserver)	Wird aufgerufen, wenn eine Nachricht empfangen wird, während die App im Hintergrund läuft. Eine App gilt als im Hintergrund, wenn kein aktives Fenster angezeigt wird.
Funktion()
wird unterstützt()	Überprüft, ob alle erforderlichen APIs im SW-Kontext 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 getMessagingInSw(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, ...)

experimentellSetDeliveryMetricsExportedToBigQueryEnabled(Messaging, aktivieren)

Aktiviert oder deaktiviert den Export von Nachrichtenübermittlungsmetriken von Firebase Cloud Messaging nach BigQuery. Standardmäßig werden Nachrichtenzustellungsmetriken nicht nach BigQuery exportiert. Mit dieser Methode können Sie den Export zur Laufzeit aktivieren oder deaktivieren.

Unterschrift:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

Parameter

Parameter	Typ	Beschreibung
Nachrichtenübermittlung	Nachrichten	Die FirebaseMessaging Instanz.
aktivieren	Boolescher Wert	Ob Firebase Cloud Messaging Nachrichtenzustellungsmetriken nach BigQuery exportieren soll.

Kehrt zurück:

Leere

onBackgroundMessage(messaging, nextOrObserver)

Wird aufgerufen, wenn eine Nachricht empfangen wird, während die App im Hintergrund läuft. Eine App gilt als im Hintergrund, wenn kein aktives Fenster angezeigt wird.

Unterschrift:

export declare function onBackgroundMessage(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 sich die App derzeit im Hintergrund befindet.

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 SW-Kontext vorhanden sind

Unterschrift:

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

Kehrt zurück:

Versprechen<boolean>

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