chrome.instanceID

Descrição

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

Permissões

gcm

Disponibilidade

Chrome 44 ou mais recente

Métodos

deleteID()

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

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

Parâmetros

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 96 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

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 mais recente

      A entidade autorizada usada para receber o token.

    • escopo

      string

      Chrome 46 ou mais recente

      O escopo usado para receber o token.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 96 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

getCreationTime()

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

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

Parâmetros

  • callback

    função optional

    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

  • Prometer<número>

    Chrome 96 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

getID()

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

Recupera um identificador para a instância do app. O ID da instância será retornado pelo callback. O mesmo ID vai ser retornado se a identidade do aplicativo não tiver sido revogada nem expirar.

Parâmetros

  • callback

    função optional

    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 mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

getToken()

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

Retorne 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 ou mais recente

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

    • opções

      objeto opcional

      Chrome 46 ou mais recente 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 mais recente

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

  • callback

    função optional

    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 mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

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