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()

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

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

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

deleteToken()

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

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 opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getCreationTime()

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

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

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (creationTime: number) => void

    • creationTime

      número

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

Retorna

  • Promise<number>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getID()

Promise 
chrome.instanceID.getID(
  callback?: function,
): 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 enquanto a identidade do aplicativo não for revogada ou expirar.

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

  • Promise<string>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getToken()

Promise 
chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
): 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 ou mais recente

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

    • opções

      objeto opcional

      Chrome 46 ou mais recente Suspenso desde o Chrome 89

      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, 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

  • Promise<string>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

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