AndroidNotification interface

Représente les options de notification spécifiques à Android qui peuvent être incluses dans AndroidConfig .

Signature:

export interface AndroidNotification 

Propriétés

AndroidNotification.body

Corps de la notification Android. Lorsqu'il est fourni, remplace le corps défini via admin.messaging.Notification .

Signature:

body?: string;

AndroidNotification.bodyLocArgs

Un tableau de clés de ressources qui seront utilisées à la place des spécificateurs de format dans bodyLocKey .

Signature:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

Clé de la chaîne du corps dans la ressource chaîne de l'application à utiliser pour localiser le corps du texte.

Signature:

bodyLocKey?: string;

AndroidNotification.channelId

L'ID du canal de notification Android (nouveau dans Android O). L'application doit créer une chaîne avec cet ID de chaîne avant qu'une notification avec cet ID de chaîne puisse être reçue. Si vous n'envoyez pas cet ID de canal dans la demande, ou si l'ID de canal fourni n'a pas encore été créé par l'application, FCM utilise l'ID de canal spécifié dans le manifeste de l'application.

Signature:

channelId?: string;

AndroidNotification.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.

Signature:

clickAction?: string;

AndroidNotification.color

Couleur de l’icône de notification au format #rrggbb .

Signature:

color?: string;

AndroidNotification.defaultLightSettings

Si défini sur true , utilisez les paramètres d'éclairage LED par défaut du framework Android pour la notification. Les valeurs par défaut sont spécifiées dans config.xml . Si default_light_settings est défini sur true et light_settings est également défini, le light_settings spécifié par l'utilisateur est utilisé à la place de la valeur par défaut.

Signature:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

Si défini sur true , utilisez le son par défaut du framework Android pour la notification. Les valeurs par défaut sont spécifiées dans config.xml .

Signature:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

Si défini sur true , utilisez le modèle de vibration par défaut du framework Android pour la notification. Les valeurs par défaut sont spécifiées dans config.xml . Si default_vibrate_timings est défini sur true et vibrate_timings est également défini, la valeur par défaut est utilisée à la place de vibrate_timings spécifié par l'utilisateur. .

Signature:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

Pour les notifications qui informent les utilisateurs sur des événements avec une référence temporelle absolue, définit l'heure à laquelle l'événement dans la notification s'est produit. Les notifications dans le panneau sont triées selon cette heure.

Signature:

eventTimestamp?: Date;

AndroidNotification.icon

Ressource d'icône pour la notification Android.

Signature:

icon?: string;

AndroidNotification.imageUrl

URL d'une image à afficher dans la notification.

Signature:

imageUrl?: string;

AndroidNotification.lightSettings

Paramètres permettant de contrôler le taux de clignotement et la couleur de la LED de notification si la LED est disponible sur l'appareil. Le temps de clignotement total est contrôlé par le système d'exploitation.

Signature:

lightSettings?: LightSettings;

AndroidNotification.localOnly

Définit si cette notification concerne uniquement l'appareil actuel. Certaines notifications peuvent être reliées à d'autres appareils pour un affichage à distance, comme une montre Wear OS. Cet indice peut être défini pour recommander que cette notification ne soit pas pontée. Consultez les guides Wear OS .

Signature:

localOnly?: boolean;

AndroidNotification.notificationCount

Définit le nombre d’éléments représentés par cette notification. Peut être affiché sous forme de nombre de badges pour les lanceurs prenant en charge les badges. Voir NotificationBadge . Par exemple, cela peut être utile si vous utilisez une seule notification pour représenter plusieurs nouveaux messages mais que vous souhaitez que le nombre ici représente le nombre total de nouveaux messages. S'il est nul ou non spécifié, les systèmes prenant en charge les badges utilisent la valeur par défaut, qui consiste à incrémenter un nombre affiché dans le menu enfoncé à chaque fois qu'une nouvelle notification arrive.

Signature:

notificationCount?: number;

AndroidNotification.priority

Définit la priorité relative de cette notification. Les notifications de faible priorité peuvent être masquées à l'utilisateur dans certaines situations. Notez que cette priorité diffère de AndroidMessagePriority . Cette priorité est traitée par le client après la remise du message. Alors AndroidMessagePriority est un concept FCM qui contrôle le moment où le message est remis.

Signature:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.sound

Nom de fichier du son à jouer lorsque l'appareil reçoit la notification.

Signature:

sound?: string;

AndroidNotification.sticky

Lorsqu'elle est définie sur false ou non définie, la notification est automatiquement ignorée lorsque l'utilisateur clique dessus dans le panneau. Lorsqu'il est défini sur true , la notification persiste même lorsque l'utilisateur clique dessus.

Signature:

sticky?: boolean;

AndroidNotification.tag

Balise de notification. Il s'agit d'un identifiant utilisé pour remplacer les notifications existantes dans le tiroir de notifications. Si non spécifié, chaque demande crée une nouvelle notification.

Signature:

tag?: string;

AndroidNotification.ticker

Définit le texte du « ticker » qui est envoyé aux services d'accessibilité. Avant le niveau d'API 21 (Lollipop), définit le texte affiché dans la barre d'état lorsque la notification arrive pour la première fois.

Signature:

ticker?: string;

AndroidNotification.titre

Titre de la notification Android. Lorsqu'il est fourni, remplace le titre défini via admin.messaging.Notification .

Signature:

title?: string;

AndroidNotification.titleLocArgs

Un tableau de clés de ressources qui seront utilisées à la place des spécificateurs de format dans titleLocKey .

Signature:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

Clé de la chaîne de titre dans la ressource chaîne de l'application à utiliser pour localiser le texte du titre.

Signature:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

Définit le modèle de vibration à utiliser. Passez quelques millisecondes pour allumer ou éteindre le vibrateur. La première valeur indique la durée à attendre avant d'allumer le vibreur. La valeur suivante indique la durée pendant laquelle le vibrateur reste allumé. Les valeurs suivantes alternent entre la durée pour éteindre le vibrateur et pour allumer le vibrateur. Si vibrate_timings est défini et default_vibrate_timings est défini sur true , la valeur par défaut est utilisée à la place du vibrate_timings spécifié par l'utilisateur .

Signature:

vibrateTimingsMillis?: number[];

AndroidNotification.visibilité

Définit la visibilité de la notification. Doit être soit private , public , ou secret . Si non spécifié, la valeur par défaut est private .

Signature:

visibility?: ('private' | 'public' | 'secret');