chrome.instanceID

Description

Utilisez chrome.instanceID pour accéder au service d'ID d'instance.

Autorisations

gcm

Garantie de disponibilité

Chrome 44 ou version ultérieure

Méthodes

deleteID()

Promesse 
chrome.instanceID.deleteID(
  callback?: function,
)

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

Paramètres

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les 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.

deleteToken()

Promesse 
chrome.instanceID.deleteToken(
  deleteTokenParams: object,
  callback?: function,
)

Révoque un jeton accordé.

Paramètres

  • deleteTokenParams

    objet

    Paramètres pour deleteToken.

    • authorizedEntity

      chaîne

      Chrome 46 ou version ultérieure

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

    • champ d'application

      chaîne

      Chrome 46 ou version ultérieure

      Champ d'application utilisé pour obtenir le jeton.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les 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.

getCreationTime()

Promesse 
chrome.instanceID.getCreationTime(
  callback?: function,
)

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

Paramètres

  • rappel

    fonction facultative

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

    (creationTime: number)=>void

    • creationTime

      number

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

Renvoie

  • Promesse<number>

    Chrome 96 et versions ultérieures

    Les 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.

getID()

Promesse 
chrome.instanceID.getID(
  callback?: function,
)

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

Paramètres

  • rappel

    fonction facultative

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

    (instanceID: string)=>void

    • instanceID

      chaîne

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

Renvoie

  • Promesse<chaîne>

    Chrome 96 et versions ultérieures

    Les 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.

getToken()

Promesse 
chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
)

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 de getToken.

    • authorizedEntity

      chaîne

      Chrome 46 ou version ultérieure

      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 Google Play Console.

    • options

      objet facultatif

      Chrome 46 ou version ultérieure 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 peuvent être utilisées dans le traitement de la requête.

    • champ d'application

      chaîne

      Chrome 46 ou version ultérieure

      Identifie les actions autorisées que l'entité autorisée peut effectuer. Par exemple, pour envoyer des messages GCM, vous devez utiliser le champ d'application GCM.

  • rappel

    fonction facultative

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

    (token: string)=>void

    • jeton

      chaîne

      Jeton attribué par le service demandé.

Renvoie

  • Promesse<chaîne>

    Chrome 96 et versions ultérieures

    Les 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

onTokenRefresh

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

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

Paramètres

  • rappel

    function

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

    ()=>void