Service de messagerie lié à l'application fournie.
Signature:
export declare class Messaging
Propriétés
| Propriété | Modificateurs | Taper | Description |
|---|---|---|---|
| application | Application | L' application associée à l'instance actuelle du service Messaging . |
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| envoyer (message, dryRun) | Envoie le message donné via FCM. | |
| sendAll (messages, dryRun) | Envoie tous les messages du tableau donné via Firebase Cloud Messaging. Utilise le traitement par lots pour envoyer la liste entière en un seul appel RPC. Comparée à la méthode send() , cette méthode est un moyen nettement plus efficace d’envoyer plusieurs messages. La liste de réponses obtenue à partir de la valeur de retour correspond à l'ordre des jetons dans le MulticastMessage . Une erreur de cette méthode indique un échec total, ce qui signifie qu'aucun des messages de la liste n'a pu être envoyé. Les échecs partiels sont indiqués par une valeur de retour BatchResponse . | |
| sendEach (messages, dryRun) | Envoie chaque message du tableau donné via Firebase Cloud Messaging. Contrairement à Messaging.sendAll() , cette méthode effectue un seul appel RPC pour chaque message du tableau donné. La liste des réponses obtenues à partir de la valeur de retour correspond à l'ordre des messages . Une erreur de cette méthode ou une BatchResponse avec tous les échecs indique un échec total, ce qui signifie qu'aucun des messages de la liste n'a pu être envoyé. Les échecs partiels ou l'absence d'échec sont uniquement indiqués par une valeur de retour BatchResponse . | |
| sendEachForMulticast (message, dryRun) | Envoie le message de multidiffusion donné à tous les jetons d'enregistrement FCM qui y sont spécifiés. Cette méthode utilise l'API Messaging.sendEach() sous le capot pour envoyer le message donné à tous les destinataires cibles. La liste de réponses obtenue à partir de la valeur de retour correspond à l'ordre des jetons dans le MulticastMessage . Une erreur de cette méthode ou une BatchResponse avec tous les échecs indique un échec total, ce qui signifie que les messages de la liste ont pu être envoyés. Les échecs partiels ou les échecs sont uniquement indiqués par une valeur de retour BatchResponse . | |
| sendMulticast (message, dryRun) | Envoie le message de multidiffusion donné à tous les jetons d'enregistrement FCM qui y sont spécifiés. Cette méthode utilise l'API sendAll() sous le capot pour envoyer le message donné à tous les destinataires cibles. La liste de réponses obtenue à partir de la valeur de retour correspond à l'ordre des jetons dans le MulticastMessage . Une erreur de cette méthode indique un échec total, ce qui signifie que le message n’a été envoyé à aucun des jetons de la liste. Les échecs partiels sont indiqués par une valeur de retour BatchResponse . | |
| sendToCondition (condition, charge utile, options) | Envoie un message FCM à une condition. Consultez Envoyer à une condition pour obtenir des exemples de code et une documentation détaillée. | |
| sendToDevice (registrationTokenOrTokens, charge utile, options) | Envoie un message FCM à un seul appareil correspondant au jeton d'enregistrement fourni. Voir Envoyer à des appareils individuels pour obtenir des exemples de code et une documentation détaillée. Prend soit un registrationToken à envoyer à un seul appareil, soit un paramètre registrationTokens contenant un tableau de jetons à envoyer à plusieurs appareils. | |
| sendToDeviceGroup (notificationKey, charge utile, options) | Envoie un message FCM à un groupe de périphériques correspondant à la clé de notification fournie. Consultez Envoyer à un groupe de périphériques pour obtenir des exemples de code et une documentation détaillée. | |
| sendToTopic (sujet, charge utile, options) | Envoie un message FCM à un sujet. Consultez Envoyer à une rubrique pour obtenir des exemples de code et une documentation détaillée. | |
| SubscribeToTopic(registrationTokenOrTokens, sujet) | Abonne un appareil à une rubrique FCM. Voir S'abonner à une rubrique pour obtenir des exemples de code et une documentation détaillée. En option, vous pouvez fournir une gamme de jetons pour abonner plusieurs appareils. | |
| unsubscribeFromTopic(registrationTokenOrTokens, sujet) | Désabonne un appareil d’un sujet FCM. Consultez Se désabonner d’une rubrique pour obtenir des exemples de code et une documentation détaillée. En option, vous pouvez fournir une gamme de jetons pour désabonner plusieurs appareils. |
Messagerie.app
L' application associée à l'instance actuelle du service Messaging .
Signature:
get app(): App;
Exemple
var app = messaging.app;
Messagerie.send()
Envoie le message donné via FCM.
Signature:
send(message: Message, dryRun?: boolean): Promise<string>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| message | Message | La charge utile du message. |
| Exécution à sec | booléen | Indique s'il faut envoyer le message en mode essai à sec (validation uniquement). |
Retour:
Promesse<string>
Promesse remplie avec une chaîne d'ID de message unique une fois que le message a été transmis avec succès au service FCM pour livraison.
Messagerie.sendAll()
Utilisez plutôt Messaging.sendEach() .
Envoie tous les messages du tableau donné via Firebase Cloud Messaging. Utilise le traitement par lots pour envoyer la liste entière en un seul appel RPC. Comparée à la méthode send() , cette méthode est un moyen nettement plus efficace d’envoyer plusieurs messages.
La liste des réponses obtenues à partir de la valeur de retour correspond à l'ordre des jetons dans le MulticastMessage . Une erreur de cette méthode indique un échec total, ce qui signifie qu'aucun des messages de la liste n'a pu être envoyé. Les échecs partiels sont indiqués par une valeur de retour BatchResponse .
Signature:
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| messages | Message [] | Un tableau non vide contenant jusqu'à 500 messages. |
| Exécution à sec | booléen | Indique s'il faut envoyer les messages en mode essai à sec (validation uniquement). |
Retour:
Promesse < BatchResponse >
Une promesse remplie avec un objet représentant le résultat de l'opération d'envoi.
Messagerie.sendEach()
Envoie chaque message du tableau donné via Firebase Cloud Messaging.
Contrairement à Messaging.sendAll() , cette méthode effectue un seul appel RPC pour chaque message du tableau donné.
La liste des réponses obtenue à partir de la valeur de retour correspond à l'ordre des messages . Une erreur de cette méthode ou une BatchResponse avec tous les échecs indique un échec total, ce qui signifie qu'aucun des messages de la liste n'a pu être envoyé. Les échecs partiels ou l'absence d'échec sont uniquement indiqués par une valeur de retour BatchResponse .
Signature:
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| messages | Message [] | Un tableau non vide contenant jusqu'à 500 messages. |
| Exécution à sec | booléen | Indique s'il faut envoyer les messages en mode essai à sec (validation uniquement). |
Retour:
Promesse < BatchResponse >
Une promesse remplie avec un objet représentant le résultat de l'opération d'envoi.
Messagerie.sendEachForMulticast()
Envoie le message de multidiffusion donné à tous les jetons d'enregistrement FCM qui y sont spécifiés.
Cette méthode utilise l'API Messaging.sendEach() sous le capot pour envoyer le message donné à tous les destinataires cibles. La liste des réponses obtenues à partir de la valeur de retour correspond à l'ordre des jetons dans le MulticastMessage . Une erreur de cette méthode ou une BatchResponse avec tous les échecs indique un échec total, ce qui signifie que les messages de la liste ont pu être envoyés. Les échecs partiels ou les échecs sont uniquement indiqués par une valeur de retour BatchResponse .
Signature:
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| message | Message multidiffusion | Un message multidiffusion contenant jusqu'à 500 jetons. |
| Exécution à sec | booléen | Indique s'il faut envoyer le message en mode essai à sec (validation uniquement). |
Retour:
Promesse < BatchResponse >
Une promesse remplie avec un objet représentant le résultat de l'opération d'envoi.
Messagerie.sendMulticast()
Utilisez plutôt Messaging.sendEachForMulticast() .
Envoie le message de multidiffusion donné à tous les jetons d'enregistrement FCM qui y sont spécifiés.
Cette méthode utilise l'API sendAll() sous le capot pour envoyer le message donné à tous les destinataires cibles. La liste des réponses obtenues à partir de la valeur de retour correspond à l'ordre des jetons dans le MulticastMessage . Une erreur de cette méthode indique un échec total, ce qui signifie que le message n’a été envoyé à aucun des jetons de la liste. Les échecs partiels sont indiqués par une valeur de retour BatchResponse .
Signature:
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| message | Message multidiffusion | Un message multidiffusion contenant jusqu'à 500 jetons. |
| Exécution à sec | booléen | Indique s'il faut envoyer le message en mode essai à sec (validation uniquement). |
Retour:
Promesse < BatchResponse >
Une promesse remplie avec un objet représentant le résultat de l'opération d'envoi.
Messagerie.sendToCondition()
Envoie un message FCM à une condition.
Consultez Envoyer à une condition pour obtenir des exemples de code et une documentation détaillée.
Signature:
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| condition | chaîne | La condition déterminant à quels sujets envoyer le message. |
| charge utile | Charge utile de messagerie | La charge utile du message. |
| choix | Options de messagerie | Options facultatives pour modifier le message. |
Retour:
Promesse < MessagingConditionResponse >
Une promesse tenue avec la réponse du serveur après l'envoi du message.
Messagerie.sendToDevice()
Utilisez plutôt Messaging.send() .
Envoie un message FCM à un seul appareil correspondant au jeton d'enregistrement fourni.
Voir Envoyer à des appareils individuels pour obtenir des exemples de code et une documentation détaillée. Prend soit un registrationToken à envoyer à un seul appareil, soit un paramètre registrationTokens contenant un tableau de jetons à envoyer à plusieurs appareils.
Signature:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| enregistrementTokenOrTokens | chaîne | chaîne[] | |
| charge utile | Charge utile de messagerie | La charge utile du message. |
| choix | Options de messagerie | Options facultatives pour modifier le message. |
Retour:
Promesse < MessagingDevicesResponse >
Une promesse tenue avec la réponse du serveur après l'envoi du message.
Messagerie.sendToDeviceGroup()
Utilisez plutôt Messaging.send() .
Envoie un message FCM à un groupe de périphériques correspondant à la clé de notification fournie.
Consultez Envoyer à un groupe de périphériques pour obtenir des exemples de code et une documentation détaillée.
Signature:
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| clé de notification | chaîne | Clé de notification du groupe de périphériques auquel envoyer le message. |
| charge utile | Charge utile de messagerie | La charge utile du message. |
| choix | Options de messagerie | Options facultatives pour modifier le message. |
Retour:
Promesse < MessagingDeviceGroupResponse >
Une promesse tenue avec la réponse du serveur après l'envoi du message.
Messagerie.sendToTopic()
Envoie un message FCM à un sujet.
Consultez Envoyer à une rubrique pour obtenir des exemples de code et une documentation détaillée.
Signature:
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| sujet | chaîne | Le sujet auquel envoyer le message. |
| charge utile | Charge utile de messagerie | La charge utile du message. |
| choix | Options de messagerie | Options facultatives pour modifier le message. |
Retour:
Promesse< MessagingTopicResponse >
Une promesse tenue avec la réponse du serveur après l'envoi du message.
Messagerie.subscribeToTopic()
Abonne un appareil à une rubrique FCM.
Voir S'abonner à une rubrique pour obtenir des exemples de code et une documentation détaillée. En option, vous pouvez fournir une gamme de jetons pour abonner plusieurs appareils.
Signature:
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| enregistrementTokenOrTokens | chaîne | chaîne[] | |
| sujet | chaîne | Le sujet auquel s'abonner. |
Retour:
Promesse < MessagingTopicManagementResponse >
Une promesse tenue avec la réponse du serveur une fois l'appareil abonné au sujet.
Messagerie.unsubscribeFromTopic()
Désabonne un appareil d’un sujet FCM.
Consultez Se désabonner d’une rubrique pour obtenir des exemples de code et une documentation détaillée. En option, vous pouvez fournir une gamme de jetons pour désabonner plusieurs appareils.
Signature:
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| enregistrementTokenOrTokens | chaîne | chaîne[] | |
| sujet | chaîne | Le sujet dont vous souhaitez vous désabonner. |
Retour:
Promesse < MessagingTopicManagementResponse >
Une promesse tenue avec la réponse du serveur après la désinscription de l'appareil du sujet.