chrome.instanceID

Descrição

Use chrome.instanceID para acessar o serviço de ID da instância.

Permissões

gcm

Disponibilidade

Chrome 44 ou superior

Métodos

deleteID()

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

Redefine o identificador da instância do aplicativo e revoga todos os tokens associados a ele.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

deleteToken()

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

Revoga um token concedido.

Parâmetros

  • deleteTokenParams

    objeto

    Parâmetros para deleteToken.

    • authorizedEntity

      string

      Chrome 46 ou superior

      A entidade autorizada usada para receber o token.

    • escopo

      string

      Chrome 46 ou superior

      O escopo usado para receber o token.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

getCreationTime()

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

Recupera o horário em que o InstanceID é gerado. O horário da criação vai ser retornado pelo callback.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (creationTime: number) => void

    • creationTime

      number

      A hora em que o ID da instância foi gerado, representado em milissegundos desde o período.

Retorna

  • Promise&lt;number&gt;

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

getID()

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

Recupera um identificador para a instância do app. O ID da instância será retornado por callback. O mesmo ID será retornado desde que a identidade do aplicativo não tenha sido revogada ou tenha expirado.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (instanceID: string) => void

    • instanceID

      string

      Um ID de instância atribuído à instância do app.

Retorna

  • Promessa<string>

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

getToken()

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

Retorne um token que permita que a entidade autorizada acesse o serviço definido pelo escopo.

Parâmetros

  • getTokenParams

    objeto

    Parâmetros para getToken.

    • authorizedEntity

      string

      Chrome 46 ou superior

      Identifica a entidade que está autorizada a acessar recursos associados a esse ID de instância. Pode ser um ID do projeto do Google Developers Console.

    • opções

      objeto opcional

      Chrome 46 ou superior Descontinuado desde o Chrome 89

      estão obsoletas e serão ignoradas.

      Permite incluir um pequeno número de pares de chave-valor de string que serão associados ao token e poderão ser usados no processamento da solicitação.

    • escopo

      string

      Chrome 46 ou superior

      Identifica ações autorizadas que a entidade autorizada pode realizar. Por exemplo: para enviar mensagens do GCM, use o escopo GCM.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (token: string) => void

    • token

      string

      Um token atribuído pelo serviço solicitado.

Retorna

  • Promessa<string>

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

Eventos

onTokenRefresh

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

Disparado quando todos os tokens concedidos precisam ser atualizados.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    () => void