@firebase/messaging/sw

Les fonctions

Fonction Description
fonction(application, ...)
getMessaging (application) Récupère une instance Firebase Cloud Messaging.
fonction(messagerie, ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled (messagerie, activation) Active ou désactive l'exportation des métriques de diffusion des messages Firebase Cloud Messaging vers BigQuery. Par défaut, les métriques de diffusion des messages ne sont pas exportées vers BigQuery. Utilisez cette méthode pour activer ou désactiver l'exportation au moment de l'exécution.
onBackgroundMessage (messagerie, nextOrObserver) Appelé lorsqu'un message est reçu alors que l'application est en arrière-plan. Une application est considérée comme étant en arrière-plan si aucune fenêtre active n'est affichée.
fonction()
est pris en charge() Vérifie si toutes les API requises existent dans SW Context

Interfaces

Interface Description
OptionsFcm Options pour les fonctionnalités fournies par le SDK FCM pour le Web. Voir WebpushFcmOptions .
GetTokenOptions Options pour getToken() .
MessagePayload Charge utile de message contenant la charge utile de notification représentée par NotificationPayload et la charge utile de données contenant un nombre arbitraire de paires clé-valeur envoyées par les développeurs via l' API Send. .
Messagerie Interface publique du SDK Firebase Cloud Messaging.
Charge utile de notification Afficher les détails de la notification. Les détails sont envoyés via l' API Send .

fonction(application, ...)

getMessaging (application)

Récupère une instance Firebase Cloud Messaging.

Signature:

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

Paramètres

Paramètre Taper Description
application FirebaseApp

Retour:

Messagerie

L'instance Firebase Cloud Messaging associée à l'application Firebase fournie.

fonction(messagerie, ...)

experimentalSetDeliveryMetricsExportedToBigQueryEnabled (messagerie, activation)

Active ou désactive l'exportation des métriques de diffusion des messages Firebase Cloud Messaging vers BigQuery. Par défaut, les métriques de diffusion des messages ne sont pas exportées vers BigQuery. Utilisez cette méthode pour activer ou désactiver l'exportation au moment de l'exécution.

Signature:

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

Paramètres

Paramètre Taper Description
Messagerie Messagerie L'instance FirebaseMessaging .
activer booléen Indique si Firebase Cloud Messaging doit exporter les métriques de diffusion des messages vers BigQuery.

Retour:

vide

onBackgroundMessage (messagerie, nextOrObserver)

Appelé lorsqu'un message est reçu alors que l'application est en arrière-plan. Une application est considérée comme étant en arrière-plan si aucune fenêtre active n'est affichée.

Signature:

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

Paramètres

Paramètre Taper Description
Messagerie Messagerie L'instance de messagerie .
suivantOuObservateur SuivantFn < Charge de message > | Observateur < Charge de message > Cette fonction, ou objet observateur avec next défini, est appelée lorsqu'un message est reçu et que l'application est actuellement en arrière-plan.

Retour:

Se désabonner

Pour arrêter d'écouter les messages, exécutez cette fonction renvoyée

fonction()

est pris en charge()

Vérifie si toutes les API requises existent dans SW Context

Signature:

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

Retour:

Promesse<booléen>

une promesse qui se résout en un booléen.