Messagerie cloud Firebase (FCM).
Les fonctions
| Fonction | Description |
|---|---|
| getMessaging (application) | Obtient le service de messagerie pour l’application par défaut ou une application donnée. admin.messaging() peut être appelé sans argument pour accéder au service Messaging de l'application par défaut ou en tant que admin.messaging(app) pour accéder au service Messaging associé à une application spécifique. |
Des classes
| Classe | Description |
|---|---|
| Messagerie | Service de messagerie lié à l'application fournie. |
Interfaces
| Interface | Description |
|---|---|
| AndroidConfig | Représente les options spécifiques à Android qui peuvent être incluses dans un message . |
| AndroidFcmOptions | Représente les options des fonctionnalités fournies par le SDK FCM pour Android. |
| AndroidNotification | Représente les options de notification spécifiques à Android qui peuvent être incluses dans AndroidConfig . |
| ApnsConfig | Représente les options spécifiques aux APN qui peuvent être incluses dans un message . Reportez-vous à la documentation Apple pour connaître les différents en-têtes et champs de charge utile pris en charge par les APN. |
| ApnsFcmOptions | Représente les options des fonctionnalités fournies par le SDK FCM pour iOS. |
| Charge utile Apns | Représente la charge utile d'un message APNs. Se compose principalement du dictionnaire aps . Mais peut également contenir d'autres clés personnalisées arbitraires. |
| Aps | Représente le dictionnaire aps qui fait partie des messages APN. |
| Alerte Aps | |
| Message de base | |
| Réponse par lots | Interface représentant la réponse du serveur des méthodes Messaging.sendAll() et Messaging.sendMulticast() . |
| Message de condition | |
| CritiqueSon | Représente une configuration sonore critique qui peut être incluse dans le dictionnaire aps d'une charge utile APN. |
| DataMessagePayload | Interface représentant une charge utile de message de données d'API héritée FCM. Les messages de données permettent aux développeurs d'envoyer jusqu'à 4 Ko de paires clé-valeur personnalisées. Les clés et les valeurs doivent toutes deux être des chaînes. Les clés peuvent être n'importe quelle chaîne personnalisée, à l'exception des chaînes réservées suivantes :
|
| OptionsFcm | Représente les options indépendantes de la plate-forme pour les fonctionnalités fournies par les SDK FCM. |
| Paramètres d'éclairage | Représente les paramètres permettant de contrôler le voyant de notification pouvant être inclus dans AndroidNotification. . |
| MessagerieConditionRéponse | Interface représentant la réponse du serveur de la méthode héritée Messaging.sendToCondition() . Consultez Envoyer à une condition pour obtenir des exemples de code et une documentation détaillée. |
| MessagingDeviceGroupResponse | Interface représentant la réponse du serveur de la méthode Messaging.sendToDeviceGroup() . Consultez Envoyer des messages aux groupes de périphériques pour obtenir des exemples de code et une documentation détaillée. |
| MessagingDeviceResult | Charge utile de réponse d'état individuelle à partir d'appareils uniques |
| MessagerieAppareilsRéponse | Interface représentant l'état d'un message envoyé à un appareil individuel via les anciennes API FCM. Voir Envoyer à des appareils individuels pour obtenir des exemples de code et une documentation détaillée. |
| Options de messagerie | Interface représentant les options pouvant être fournies lors de l'envoi d'un message via les anciennes API FCM. Consultez Créer des demandes d’envoi pour obtenir des exemples de code et une documentation détaillée. |
| Charge utile de messagerie | Interface représentant une charge utile de message Firebase Cloud Messaging. Une ou les deux clés de data et notification sont requises. Consultez Créer des demandes d’envoi pour obtenir des exemples de code et une documentation détaillée. |
| MessagerieSujetGestionRéponse | Interface représentant la réponse du serveur des méthodes Messaging.subscribeToTopic() et Messaging.unsubscribeFromTopic() . Consultez Gérer les sujets à partir du serveur pour obtenir des exemples de code et une documentation détaillée. |
| MessagerieSujetRéponse | Interface représentant la réponse du serveur de la méthode héritée Messaging.sendToTopic() . Consultez Envoyer à une rubrique pour obtenir des exemples de code et une documentation détaillée. |
| Message multidiffusion | Charge utile pour la méthode Messaging.sendMulticast() . La charge utile contient tous les champs du type BaseMessage et une liste de jetons. |
| Notification | Une notification pouvant être incluse dans Message . |
| NotificationMessagePayload | Interface représentant une charge utile de message de notification d'API héritée FCM. Les messages de notification permettent aux développeurs d'envoyer jusqu'à 4 Ko de paires clé-valeur prédéfinies. Les clés acceptées sont décrites ci-dessous. Consultez Créer des demandes d’envoi pour obtenir des exemples de code et une documentation détaillée. |
| Envoyer une réponse | Interface représentant l'état d'un message individuel envoyé dans le cadre d'une demande par lots. |
| Message de jeton | |
| SujetMessage | |
| WebpushConfig | Représente les options du protocole WebPush qui peuvent être incluses dans un message . |
| WebpushFcmOptions | Représente les options des fonctionnalités fournies par le SDK FCM pour le Web (qui ne font pas partie de la norme Webpush). |
| WebpushNotification | Représente les options de notification spécifiques à WebPush qui peuvent être incluses dans WebpushConfig . Cela prend en charge la plupart des options standard telles que définies dans la spécification Web Notification. . |
Tapez les alias
| Tapez l'alias | Description |
|---|---|
| Message | Charge utile pour l’opération Messaging.send() . La charge utile contient tous les champs du type BaseMessage, et exactement un champ parmi un jeton, un sujet ou une condition. |
getMessaging()
Obtient le service de messagerie pour l’application par défaut ou une application donnée.
admin.messaging() peut être appelé sans argument pour accéder au service Messaging de l'application par défaut ou en tant que admin.messaging(app) pour accéder au service Messaging associé à une application spécifique.
Signature:
export declare function getMessaging(app?: App): Messaging;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| application | Application | Application facultative dont le service Messaging doit être renvoyé. S’il n’est pas fourni, le service Messaging par défaut sera renvoyé. |
Retour:
Le service Messaging par défaut si aucune application n'est fournie ou le service Messaging associé à l'application fournie.
Exemple 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
Exemple 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
Message
Charge utile pour l’opération Messaging.send() . La charge utile contient tous les champs du type BaseMessage, et exactement un champ parmi un jeton, un sujet ou une condition.
Signature:
export type Message = TokenMessage | TopicMessage | ConditionMessage;