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 toutes les paires clé/valeur d'un message.

Valeur

4096

Méthodes

register()

Promise 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

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 au moins un et pas plus de 100 ID d'expéditeur.

  • callback

    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<string>

    Chrome 116 et versions ultérieures

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

send()

Promise 
chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

Envoie un message en fonction de son contenu.

Paramètres

  • message

    objet

    Message à envoyer à l'autre partie via FCM.

    • données

      objet

      Données du message à envoyer au serveur. Les préfixes de clé goog. et google (insensibles à la casse), ainsi que collapse_key (sensible à la casse) ne sont pas autorisés. 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 concerné par les applications. Consultez la documentation Cloud Messaging pour obtenir des conseils sur le choix et la gestion d'un ID.

    • timeToLive

      number facultatif

      Durée de vie du message en secondes. Si le message ne peut pas être envoyé dans ce délai, un événement onSendError est déclenché. Un délai de vie de 0 indique que le message doit être envoyé immédiatement ou échouer si ce n'est pas possible. La valeur par défaut de la durée de vie est de 86 400 secondes (un jour), et la valeur maximale est de 2 419 200 secondes (28 jours).

  • callback

    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<string>

    Chrome 116 et versions ultérieures

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

unregister()

Promise 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

Désenregistre l'application auprès de FCM.

Paramètres

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les 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

  • callback

    fonction

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

    (message: object) => void

    • message

      objet

      • collapseKey

        chaîne facultative

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

      • données

        objet

        Données du message.

      • de

        chaîne facultative

        Expéditeur du message.

onMessagesDeleted

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

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

Paramètres

  • callback

    fonction

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

    () => void

onSendError

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

Déclenché lorsqu'il n'a pas été possible d'envoyer un message au serveur FCM.

Paramètres

  • callback

    fonction

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

    (error: object) => void

    • erreur

      objet

      • détails

        objet

        Informations supplémentaires sur l'erreur, le cas échéant.

      • errorMessage

        chaîne

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

      • messageId

        chaîne facultative

        ID du message comportant cette erreur, si l'erreur est liée à un message spécifique.