browser.instanceID

Descrição

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

Permissões

gcm

Disponibilidade

Chrome 44+ browser.* desde o Chrome 148

Métodos

deleteID()

browser.instanceID.deleteID(): Promise<void>

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

Retorna

  • Promessa<void>

    Chrome 96+ browser.* desde o Chrome 148

    É resolvida quando a exclusão é concluída. O identificador de instância será revogado se a promessa não for rejeitada.

deleteToken()

browser.instanceID.deleteToken(
  deleteTokenParams: object,
): Promise<void>

Revoga um token concedido.

Parâmetros

  • deleteTokenParams

    objeto

    Parâmetros para deleteToken.

    • authorizedEntity

      string

      Chrome 46+ browser.* desde o Chrome 148

      A entidade autorizada usada para receber o token.

    • escopo

      string

      Chrome 46+ browser.* desde o Chrome 148

      O escopo usado para receber o token.

Retorna

  • Promessa<void>

    Chrome 96+ browser.* desde o Chrome 148

    É resolvida quando a exclusão do token é concluída. O token foi revogado com sucesso se a promessa não for rejeitada.

getCreationTime()

browser.instanceID.getCreationTime(): Promise<number>

Recupera o horário em que o InstanceID foi gerado. O horário de criação será retornado pelo callback.

Retorna

  • Promise<number>

    Chrome 96+ browser.* desde o Chrome 148

    É resolvida quando a recuperação é concluída.

getID()

browser.instanceID.getID(): Promise<string>

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

Retorna

  • Promise<string>

    Chrome 96+ browser.* desde o Chrome 148

    É resolvida quando a recuperação é concluída.

getToken()

browser.instanceID.getToken(
  getTokenParams: object,
): Promise<string>

Retorna um token que permite que a entidade autorizada acesse o serviço definido pelo escopo.

Parâmetros

  • getTokenParams

    objeto

    Parâmetros para getToken.

    • authorizedEntity

      string

      Chrome 46+ browser.* desde o Chrome 148

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

    • opções

      objeto optional

      Chrome 46+ browser.* desde o Chrome 148 Descontinuado desde o Chrome 89

      foram descontinuadas 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+ browser.* desde o Chrome 148

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

Retorna

  • Promise<string>

    Chrome 96+ browser.* desde o Chrome 148

    É resolvida quando a recuperação é concluída.

Eventos

onTokenRefresh

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

Acionado quando todos os tokens concedidos precisam ser atualizados.

Parâmetros

  • callback

    função

    O parâmetro callback é semelhante a: 

    () => void