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()
chrome.gcm.register(
senderIds: string[],
callback?: function,
)
Enregistre l'application auprès de FCM. L'ID d'enregistrement est 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
fonction facultative
Le paramètre
callback
se présente comme suit :(registrationId: string) => void
-
registrationId
chaîne
ID d'enregistrement attribué à l'application par FCM.
-
Renvoie
-
Promesse<chaîne>
Chrome 116 et versions ultérieuresLes promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.
send()
chrome.gcm.send(
message: object,
callback?: function,
)
Envoie un message en fonction de son contenu.
Paramètres
-
message
objet
Un message à envoyer à l'autre partie via FCM.
-
data
objet
Données de message à envoyer au serveur. Les préfixes de clé
goog.
etgoogle
non sensibles à la casse, ainsi quecollapse_key
sensibles à la casse, ne sont pas autorisés. La somme de toutes les paires clé/valeur ne doit pas dépassergcm.MAX_MESSAGE_SIZE
. -
destinationId
chaîne
ID du serveur auquel le message doit être envoyé, tel qu'il a été 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
numéro facultatif
Valeur TTL 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 de 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
fonction facultative
Le paramètre
callback
se présente comme suit :(messageId: string) => void
-
messageId
chaîne
Identifiant du message pour lequel le rappel a été émis.
-
Renvoie
-
Promesse<chaîne>
Chrome 116 et versions ultérieuresLes promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.
unregister()
chrome.gcm.unregister(
callback?: function,
)
Annule l'enregistrement de l'application dans FCM.
Paramètres
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :() => void
Renvoie
-
Promise<void>
Chrome 116 et versions ultérieuresLes promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.
Événements
onMessage
chrome.gcm.onMessage.addListener(
callback: function,
)
Déclenché lorsqu'un message est reçu via FCM.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(message: object) => void
-
message
objet
-
collapseKey
string facultatif
Clé de réduction d'un message. Pour en savoir plus, consultez Messages non réductibles et réductibles.
-
data
objet
Données du message.
-
Source :
string facultatif
Expéditeur du message.
-
-
onMessagesDeleted
chrome.gcm.onMessagesDeleted.addListener(
callback: function,
)
Déclenché lorsqu'un serveur FCM doit supprimer les messages envoyés par un serveur d'applications à l'application. Pour plus de détails sur la gestion de cet événement, consultez l'article Durée de vie des messages.
Paramètres
-
rappel
function
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
function
Le paramètre
callback
se présente comme suit :(error: object) => void
-
error
objet
-
détails
objet
Informations supplémentaires concernant l'erreur, lorsqu'elles sont disponibles.
-
errorMessage
chaîne
Message d'erreur décrivant le problème.
-
messageId
string facultatif
L'ID du message contenant cette erreur, si celle-ci est liée à un message spécifique.
-
-