chrome.gcm

refresh date: 2026-09-25 robots: noindex

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

  • 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 ou version ultérieure

    Se résout lorsque l'enregistrement est terminé.

    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 (non sensibles à 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 dans le champ d'application des 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. S'il n'est pas possible d'envoyer le message dans ce délai, un événement onSendError est déclenché. Une durée 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 ou version ultérieure

    Se résout une fois que le message a bien été mis en file d'attente pour l'envoi. Si une erreur se produit, la promesse sera rejetée.

    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>

Annule l'enregistrement de 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 ou version ultérieure

    Se résout une fois la désinscription terminée. La désinscription est réussie si la promesse n'est pas rejetée.

    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 facultatif

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

      • données

        objet

        Données du message.

      • de

        chaîne facultatif

        L'expéditeur qui a envoyé le message.

onMessagesDeleted

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

Déclenché lorsqu'un serveur FCM a dû supprimer des messages envoyés par un serveur d'applications à 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 concernant l'erreur, le cas échéant.

      • errorMessage

        chaîne

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

      • messageId

        chaîne facultatif

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