MessagingOptions interface

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.

Signature:

export interface MessagingOptions 

Propriétés

MessagingOptions.collapseKey

Chaîne identifiant un groupe de messages (par exemple, « Mises à jour disponibles ») qui peut être réduit, de sorte que seul le dernier message soit envoyé lorsque la livraison peut reprendre. Ceci est utilisé pour éviter d'envoyer trop de messages identiques lorsque l'appareil revient en ligne ou devient actif.

Il n'y a aucune garantie quant à l'ordre dans lequel les messages sont envoyés.

Un maximum de quatre clés de réduction différentes est autorisé à un moment donné. Cela signifie que le serveur FCM peut stocker simultanément quatre messages d'envoi à synchronisation différents par application client. Si vous dépassez ce nombre, il n'y a aucune garantie quant aux quatre clés de réduction que le serveur FCM conservera.

**Valeur par défaut :** Aucune

Signature:

collapseKey?: string;

MessagingOptions.contentAvailable

Sur iOS, utilisez ce champ pour représenter content-available dans la charge utile APN. Lorsqu'une notification ou un message de données est envoyé et que cela est défini sur true , une application client inactive est réveillée. Sur Android, les messages de données réveillent l'application par défaut. Sur Chrome, cet indicateur n'est actuellement pas pris en charge.

**Valeur par défaut :** false

Signature:

contentAvailable?: boolean;

MessagingOptions.dryRun

Si le message doit réellement être envoyé ou non. Lorsqu'il est défini sur true , permet aux développeurs de tester une requête sans réellement envoyer de message. Lorsqu'il est défini sur false , le message sera envoyé.

**Valeur par défaut :** false

Signature:

dryRun?: boolean;

MessagingOptions.mutableContent

Sur iOS, utilisez ce champ pour représenter mutable-content dans la charge utile APN. Lorsqu'une notification est envoyée et que cela est défini sur true , le contenu de la notification peut être modifié avant son affichage, à l'aide d'une extension de l'application Notification Service. .

Sur Android et Web, ce paramètre sera ignoré.

**Valeur par défaut :** false

Signature:

mutableContent?: boolean;

Options de messagerie.priority

La priorité du message. Les valeurs valides sont "normal" et "high". Sur iOS, ceux-ci correspondent aux priorités des APN 5 et 10 .

Par défaut, les messages de notification sont envoyés avec une priorité élevée et les messages de données avec une priorité normale. La priorité normale optimise la consommation de la batterie de l'application client et doit être utilisée sauf si une livraison immédiate est requise. Pour les messages avec une priorité normale, l'application peut recevoir le message avec un délai indéterminé.

Lorsqu'un message est envoyé avec une priorité élevée, il est envoyé immédiatement et l'application peut réveiller un appareil en veille et ouvrir une connexion réseau à votre serveur.

Pour plus d'informations, voir Définir la priorité d'un message .

**Valeur par défaut :** "high" pour les messages de notification, "normal" pour les messages de données

Signature:

priority?: string;

MessagingOptions.restrictedPackageName

Le nom du package de l’application auquel les jetons d’enregistrement doivent correspondre pour recevoir le message.

**Valeur par défaut :** Aucune

Signature:

restrictedPackageName?: string;

Options de messagerie.timeToLive

Combien de temps (en secondes) le message doit être conservé dans le stockage FCM si l'appareil est hors ligne. La durée maximale de vie prise en charge est de quatre semaines, et la valeur par défaut est également de quatre semaines. Pour plus d'informations, consultez Définir la durée de vie d'un message. .

**Valeur par défaut :** 2419200 (représentant quatre semaines, en secondes)

Signature:

timeToLive?: number;