chrome.instanceID

Descripción

Usa chrome.instanceID para acceder al servicio de ID de instancia.

Permisos

gcm

Disponibilidad

Chrome 44 y versiones posteriores

Métodos

deleteID()

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

Restablece el identificador de la instancia de la app y revoca todos los tokens asociados a él.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera:

    () => void

Muestra

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

deleteToken()

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

Revoca un token otorgado.

Parámetros

  • deleteTokenParams

    objeto

    Parámetros de deleteToken.

    • authorizedEntity

      string

      Chrome 46 y versiones posteriores

      Es la entidad autorizada que se usa para obtener el token.

    • alcance

      string

      Chrome 46 y versiones posteriores

      Es el alcance que se usa para obtener el token.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera:

    () => void

Muestra

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getCreationTime()

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

Recupera la fecha y hora en que se generó el InstanceID. La hora de creación la devolverá el callback.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera:

    (creationTime: number) => void

    • creationTime

      número

      Es la fecha y hora en que se generó el ID de instancia, representada en milisegundos desde la época.

Muestra

  • Promise<number>

    Chrome 96 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getID()

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

Recupera un identificador para la instancia de la app. El callback devolverá el ID de la instancia. Se devolverá el mismo ID siempre que la identidad de la aplicación no se haya revocado ni haya vencido.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera:

    (instanceID: string) => void

    • instanceID

      string

      Es un ID de instancia asignado a la instancia de la app.

Muestra

  • Promise<string>

    Chrome 96 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getToken()

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

Devuelve un token que permite a la entidad autorizada acceder al servicio definido por el alcance.

Parámetros

  • getTokenParams

    objeto

    Parámetros de getToken.

    • authorizedEntity

      string

      Chrome 46 y versiones posteriores

      Identifica la entidad que está autorizada para acceder a los recursos asociados con este ID de instancia. Puede ser un ID de proyecto de la consola para desarrolladores de Google.

    • opciones

      objeto opcional

      Chrome 46 y versiones posteriores Obsoleto desde Chrome 89

      Las opciones están obsoletas y se ignorarán.

      Permite incluir una pequeña cantidad de pares clave-valor de cadenas que se asociarán con el token y se pueden usar para procesar la solicitud.

    • alcance

      string

      Chrome 46 y versiones posteriores

      Identifica las acciones autorizadas que puede realizar la entidad autorizada. Por ejemplo, para enviar mensajes de GCM, se debe usar el alcance GCM.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera:

    (token: string) => void

    • token

      string

      Es un token que asigna el servicio solicitado.

Muestra

  • Promise<string>

    Chrome 96 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

Eventos

onTokenRefresh

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

Se activa cuando se deben actualizar todos los tokens otorgados.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera:

    () => void