chrome.instanceID

Description

Utilisez chrome.instanceID pour accéder au service Instance ID.

Autorisations

gcm

Disponibilité

Chrome 44 et versions ultérieures

Méthodes

deleteID()

Promise 
chrome.instanceID.deleteID(
  callback?: function,
): Promise<void>

Réinitialise l'identifiant de l'instance d'application et révoque tous les jetons qui y sont associés.

Paramètres

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 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.

deleteToken()

Promise 
chrome.instanceID.deleteToken(
  deleteTokenParams: object,
  callback?: function,
): Promise<void>

Révoque un jeton accordé.

Paramètres

  • deleteTokenParams

    objet

    Paramètres pour deleteToken.

    • authorizedEntity

      chaîne

      Chrome 46 et versions ultérieures

      Entité autorisée utilisée pour obtenir le jeton.

    • champ d'application

      chaîne

      Chrome 46 et versions ultérieures

      Champ d'application utilisé pour obtenir le jeton.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 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.

getCreationTime()

Promise 
chrome.instanceID.getCreationTime(
  callback?: function,
): Promise<number>

Récupère l'heure à laquelle l'InstanceID a été généré. L'heure de création sera renvoyée par callback.

Paramètres

  • callback

    function facultatif

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

    (creationTime: number) => void

    • creationTime

      Total

      Heure à laquelle l'ID d'instance a été généré, représentée en millisecondes depuis l'epoch.

Renvoie

  • Promise<number>

    Chrome 96 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.

getID()

Promise 
chrome.instanceID.getID(
  callback?: function,
): Promise<string>

Récupère un identifiant pour l'instance d'application. L'ID d'instance sera renvoyé par callback. Le même ID sera renvoyé tant que l'identité de l'application n'aura pas été révoquée ou expirée.

Paramètres

  • callback

    function facultatif

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

    (instanceID: string) => void

    • instanceID

      chaîne

      ID d'instance attribué à l'instance d'application.

Renvoie

  • Promise<string>

    Chrome 96 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.

getToken()

Promise 
chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
): Promise<string>

Renvoie un jeton qui permet à l'entité autorisée d'accéder au service défini par le champ d'application.

Paramètres

  • getTokenParams

    objet

    Paramètres pour getToken.

    • authorizedEntity

      chaîne

      Chrome 46 et versions ultérieures

      Identifie l'entité autorisée à accéder aux ressources associées à cet ID d'instance. Il peut s'agir d'un ID de projet provenant de la console Google Developers.

    • options

      object facultatif

      Chrome 46 et versions ultérieures Obsolète depuis Chrome 89

      sont obsolètes et seront ignorées.

      Permet d'inclure un petit nombre de paires clé/valeur de chaîne qui seront associées au jeton et pourront être utilisées pour traiter la demande.

    • champ d'application

      chaîne

      Chrome 46 et versions ultérieures

      Identifie les actions autorisées que l'entité autorisée peut effectuer. Par exemple, pour envoyer des messages GCM, le champ d'application GCM doit être utilisé.

  • callback

    function facultatif

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

    (token: string) => void

    • jeton

      chaîne

      Jeton attribué par le service demandé.

Renvoie

  • Promise<string>

    Chrome 96 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

onTokenRefresh

chrome.instanceID.onTokenRefresh.addListener(
  callback: function,
)

Déclenché lorsque tous les jetons accordés doivent être actualisés.

Paramètres

  • callback

    fonction

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

    () => void