chrome.gcm

Description

Utilisez chrome.gcm pour permettre aux applications et aux extensions d'envoyer et de recevoir des messages via Firebase Cloud Messaging (FCM).

Autorisations

gcm

Propriétés

MAX_MESSAGE_SIZE

Taille maximale (en octets) de l'ensemble des paires clé/valeur d'un message.

Valeur

4096

Méthodes

register()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

Enregistre l'application auprès de FCM. L'ID d'enregistrement sera renvoyé par callback. Si register est appelé à nouveau avec la même liste de senderIds, le même ID d'enregistrement est renvoyé.

Paramètres

  • senderIds

    chaîne[]

    Liste des ID de serveur autorisés à envoyer des messages à l'application. Il doit contenir entre un et 100 ID d'expéditeur.

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    (registrationId: string) => void

    • registrationId

      chaîne

      ID d'enregistrement attribué à l'application par FCM.

Renvoie

  • Promise&lt;string&gt;

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

send()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.gcm.send(
  message: object,
  callback?: function,
)

Envoie un message en fonction de son contenu.

Paramètres

  • message

    objet

    Message à envoyer à l'autre partie via FCM.

    • données

      objet

      Données de message à envoyer au serveur. goog. et google non sensibles à la casse, ainsi que collapse_key sensibles à la casse ne sont pas autorisés en tant que préfixes de clé. La somme de toutes les paires clé/valeur ne doit pas dépasser gcm.MAX_MESSAGE_SIZE.

    • destinationId

      chaîne

      ID du serveur auquel envoyer le message, tel qu'attribué par la console Google APIs.

    • messageId

      chaîne

      ID du message. Il doit être unique pour chaque message dans le champ d'application des applications. Consultez la documentation Cloud Messaging pour savoir comment choisir et gérer un ID.

    • timeToLive

      numéro facultatif

      Valeur TTL (Time To Live) du message en secondes. S'il n'est pas possible d'envoyer le message dans ce délai, un événement onSendError est déclenché. Une valeur TTL (Time To Live) égale à 0 indique que le message doit être envoyé immédiatement ou échouer si cela n'est pas possible. La valeur par défaut est de 86 400 secondes (1 jour) et la valeur maximale est de 2 419 200 secondes (28 jours).

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    (messageId: string) => void

    • messageId

      chaîne

      ID du message pour lequel le rappel a été émis.

Renvoie

  • Promise&lt;string&gt;

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

unregister()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.gcm.unregister(
  callback?: function,
)

Annule l'enregistrement de l'application dans FCM.

Paramètres

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

Déclenché lorsqu'un message est reçu via FCM.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (message: object) => void

    • message

      objet

      • collapseKey

        chaîne facultatif

        Clé de réduction d'un message. Pour en savoir plus, consultez l'article Messages non réductibles et réductibles.

      • données

        objet

        Données du message.

      • de

        chaîne facultatif

        Expéditeur qui a envoyé le message.

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

Déclenché lorsqu'un serveur FCM a dû supprimer les messages envoyés par un serveur d'applications à l'application. Pour en savoir plus sur la gestion de cet événement, consultez la section Durée de vie d'un message.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

Déclenché lorsque l'envoi d'un message au serveur FCM était impossible.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (error: object) => void

    • erreur

      objet

      • détails

        objet

        Informations supplémentaires concernant l'erreur, si disponibles.

      • Message d'erreur

        chaîne

        Message d'erreur décrivant le problème.

      • messageId

        chaîne facultatif

        ID du message contenant cette erreur, si celle-ci est liée à un message spécifique.