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.
Signature:
export interface NotificationMessagePayload
Propriétés
| Propriété | Taper | Description |
|---|---|---|
| badge | chaîne | La valeur du badge sur l'icône de l'application de l'écran d'accueil. S’il n’est pas précisé, le badge n’est pas modifié. S'il est défini sur 0 , le badge est supprimé. **Plateformes :** iOS |
| corps | chaîne | Le corps du texte de la notification. **Plateformes :** iOS, Android, Web |
| corpsLocArgs | chaîne | Valeurs de chaîne variable à utiliser à la place des spécificateurs de format dans body_loc_key à utiliser pour localiser le corps du texte selon la localisation actuelle de l'utilisateur. La valeur doit être un tableau JSON stringifié. **iOS :** Correspond aux loc-args dans la charge utile des APN. Voir Référence de clé de charge utile et Localisation du contenu de vos notifications à distance pour plus d'informations. **Android :** consultez la section Formatage et style pour plus d'informations. **Plateformes :** iOS, Android |
| clé de verrouillage du corps | chaîne | Clé de la chaîne de corps dans les ressources de chaîne de l'application à utiliser pour localiser le corps du texte selon la localisation actuelle de l'utilisateur. **iOS :** Correspond à loc-key dans la charge utile de l'APN. Voir Référence de clé de charge utile et Localisation du contenu de vos notifications à distance pour plus d'informations. **Android :** consultez les ressources de chaînes pour plus d'informations. **Plateformes :** iOS, Android |
| cliquez sur Action | chaîne | Action associée à un utilisateur cliquant sur la notification. Si spécifié, une activité avec un filtre d'intention correspondant est lancée lorsqu'un utilisateur clique sur la notification. * **Plateformes :** Android |
| couleur | chaîne | La couleur de l'icône de notification, exprimée au format #rrggbb . **Plateformes :** Android |
| icône | chaîne | L'icône de la notification. **Android :** Définit l'icône de notification sur myicon pour la ressource pouvant être dessinée myicon . Si vous n'envoyez pas cette clé dans la demande, FCM affiche l'icône du lanceur spécifiée dans le manifeste de votre application. **Web :** URL à utiliser pour l'icône de notification. **Plateformes :** Android, Web |
| son | chaîne | Le son à jouer lorsque l'appareil reçoit une notification. Prend en charge « par défaut » pour le son de notification par défaut de l'appareil ou le nom de fichier d'une ressource sonore fournie dans l'application. Les fichiers son doivent résider dans /res/raw/ . **Plateformes :** Android |
| étiqueter | chaîne | Identifiant utilisé pour remplacer les notifications existantes dans le tiroir de notifications. Si non spécifié, chaque demande crée une nouvelle notification. Si cela est spécifié et qu'une notification avec la même balise est déjà affichée, la nouvelle notification remplace celle existante dans le tiroir de notification. **Plateformes :** Android |
| titre | chaîne | Le titre de la notification. **Plateformes :** iOS, Android, Web |
| titreLocArgs | chaîne | Valeurs de chaîne variable à utiliser à la place des spécificateurs de format dans title_loc_key à utiliser pour localiser le texte du titre dans la localisation actuelle de l'utilisateur. La valeur doit être un tableau JSON stringifié. **iOS :** Correspond aux arguments title-loc-args dans la charge utile APN. Voir Référence de clé de charge utile et Localisation du contenu de vos notifications à distance pour plus d'informations. **Android :** consultez la section Formatage et style pour plus d'informations. **Plateformes :** iOS, Android |
| titreLocKey | chaîne | Clé de la chaîne de titre dans les ressources de chaîne de l'application à utiliser pour localiser le texte du titre dans la localisation actuelle de l'utilisateur. **iOS :** Correspond à title-loc-key dans la charge utile de l'APN. Voir Référence de clé de charge utile et Localisation du contenu de vos notifications à distance pour plus d'informations. **Android :** consultez les ressources de chaînes pour plus d'informations. **Plateformes :** iOS, Android |
NotificationMessagePayload.badge
La valeur du badge sur l'icône de l'application de l'écran d'accueil.
S’il n’est pas précisé, le badge n’est pas modifié.
Si réglé à 0 , le badge est supprimé.
**Plateformes :** iOS
Signature:
badge?: string;
NotificationMessagePayload.body
Le corps du texte de la notification.
**Plateformes :** iOS, Android, Web
Signature:
body?: string;
NotificationMessagePayload.bodyLocArgs
Valeurs de chaîne variable à utiliser à la place des spécificateurs de format dans body_loc_key à utiliser pour localiser le corps du texte selon la localisation actuelle de l'utilisateur.
La valeur doit être un tableau JSON stringifié.
**iOS :** Correspond aux loc-args dans la charge utile des APN. Voir Référence de clé de charge utile et Localisation du contenu de vos notifications à distance pour plus d'informations.
**Android :** consultez la section Formatage et style pour plus d'informations.
**Plateformes :** iOS, Android
Signature:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
Clé de la chaîne de corps dans les ressources de chaîne de l'application à utiliser pour localiser le corps du texte selon la localisation actuelle de l'utilisateur.
**iOS :** Correspond à loc-key dans la charge utile de l'APN. Voir Référence de clé de charge utile et Localisation du contenu de vos notifications à distance pour plus d'informations.
**Android :** consultez les ressources de chaînes pour plus d'informations.
**Plateformes :** iOS, Android
Signature:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
Action associée à un utilisateur cliquant sur la notification. Si spécifié, une activité avec un filtre d'intention correspondant est lancée lorsqu'un utilisateur clique sur la notification.
* **Plateformes :** Android
Signature:
clickAction?: string;
NotificationMessagePayload.color
La couleur de l'icône de notification, exprimée au format #rrggbb .
**Plateformes :** Android
Signature:
color?: string;
NotificationMessagePayload.icon
L'icône de la notification.
**Android :** Définit l'icône de notification sur myicon pour la ressource pouvant être dessinée myicon . Si vous n'envoyez pas cette clé dans la demande, FCM affiche l'icône du lanceur spécifiée dans le manifeste de votre application.
**Web :** URL à utiliser pour l'icône de notification.
**Plateformes :** Android, Web
Signature:
icon?: string;
NotificationMessagePayload.sound
Le son à jouer lorsque l'appareil reçoit une notification. Prend en charge « par défaut » pour le son de notification par défaut de l'appareil ou le nom de fichier d'une ressource sonore fournie dans l'application. Les fichiers son doivent résider dans /res/raw/ .
**Plateformes :** Android
Signature:
sound?: string;
NotificationMessagePayload.tag
Identifiant utilisé pour remplacer les notifications existantes dans le tiroir de notifications.
Si non spécifié, chaque demande crée une nouvelle notification.
Si cela est spécifié et qu'une notification avec la même balise est déjà affichée, la nouvelle notification remplace celle existante dans le tiroir de notification.
**Plateformes :** Android
Signature:
tag?: string;
NotificationMessagePayload.titre
Le titre de la notification.
**Plateformes :** iOS, Android, Web
Signature:
title?: string;
NotificationMessagePayload.titleLocArgs
Valeurs de chaîne variable à utiliser à la place des spécificateurs de format dans title_loc_key à utiliser pour localiser le texte du titre dans la localisation actuelle de l'utilisateur.
La valeur doit être un tableau JSON stringifié.
**iOS :** Correspond aux title-loc-args dans la charge utile APN. Voir Référence de clé de charge utile et Localisation du contenu de vos notifications à distance pour plus d'informations.
**Android :** consultez la section Formatage et style pour plus d'informations.
**Plateformes :** iOS, Android
Signature:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
Clé de la chaîne de titre dans les ressources de chaîne de l'application à utiliser pour localiser le texte du titre dans la localisation actuelle de l'utilisateur.
**iOS :** Correspond à title-loc-key dans la charge utile de l'APN. Voir Référence de clé de charge utile et Localisation du contenu de vos notifications à distance pour plus d'informations.
**Android :** consultez les ressources de chaînes pour plus d'informations.
**Plateformes :** iOS, Android
Signature:
titleLocKey?: string;