Les fonctions
| Fonction | Description |
|---|---|
| fonction(application, ...) | |
| getMessaging (application) | Récupère une instance Firebase Cloud Messaging. |
| fonction(messagerie, ...) | |
| deleteToken (messagerie) | Supprime le jeton d'enregistrement associé à cette instance de messagerie et désabonne l'instance de messagerie de l'abonnement push. |
| getToken (messagerie, options) | Abonne l'instance de messagerie aux notifications push. Renvoie un jeton d'enregistrement Firebase Cloud Messaging qui peut être utilisé pour envoyer des messages push à cette instance de messagerie . Si l’autorisation de notification n’est pas déjà accordée, cette méthode demande l’autorisation à l’utilisateur. La promesse renvoyée est rejetée si l'utilisateur n'autorise pas l'application à afficher des notifications. |
| onMessage (messagerie, nextOrObserver) | Lorsqu'un message push est reçu et que l'utilisateur se trouve actuellement sur une page correspondant à votre origine, le message est transmis à la page et un événement onMessage() est distribué avec la charge utile du message push. |
| fonction() | |
| est pris en charge() | Vérifie si toutes les API requises existent dans le navigateur. |
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 getMessagingInWindow(app?: FirebaseApp): Messaging;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| application | FirebaseApp |
Retour:
L'instance Firebase Cloud Messaging associée à l'application Firebase fournie.
fonction(messagerie, ...)
deleteToken (messagerie)
Supprime le jeton d'enregistrement associé à cette instance de messagerie et désabonne l'instance de messagerie de l'abonnement push.
Signature:
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| Messagerie | Messagerie | L'instance de messagerie . |
Retour:
Promesse<booléen>
La promesse est résolue lorsque le jeton a été supprimé avec succès.
getToken (messagerie, options)
Abonne l'instance de messagerie aux notifications push. Renvoie un jeton d'enregistrement Firebase Cloud Messaging qui peut être utilisé pour envoyer des messages push à cette instance de messagerie .
Si l’autorisation de notification n’est pas déjà accordée, cette méthode demande l’autorisation à l’utilisateur. La promesse renvoyée est rejetée si l'utilisateur n'autorise pas l'application à afficher des notifications.
Signature:
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| Messagerie | Messagerie | L'instance de messagerie . |
| choix | GetTokenOptions | Fournit une clé vapid facultative et une inscription facultative du travailleur de service. |
Retour:
Promesse<string>
La promesse est résolue avec un jeton d'enregistrement FCM.
onMessage (messagerie, nextOrObserver)
Lorsqu'un message push est reçu et que l'utilisateur se trouve actuellement sur une page correspondant à votre origine, le message est transmis à la page et un événement onMessage() est distribué avec la charge utile du message push.
Signature:
export declare function onMessage(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'utilisateur consulte actuellement votre page. |
Retour:
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 le navigateur.
Signature:
export declare function isWindowSupported(): Promise<boolean>;
Retour:
Promesse<booléen>
une promesse qui se résout en un booléen.