chrome.extension

Descrição

A API chrome.extension tem utilitários que podem ser usados por qualquer página de extensão. Ele inclui suporte para a troca de mensagens entre uma extensão e os scripts de conteúdo ou entre extensões, conforme descrito em detalhes em Transmissão de mensagens.

Tipos

ViewType

Chrome 44 e versões mais recentes

O tipo de visualização da extensão.

Enumeração

"tab"

"popup"

Propriedades

inIncognitoContext

Verdadeiro para scripts de conteúdo em execução em guias anônimas e para páginas de extensão em execução em um processo anônimo. O segundo só se aplica a extensões com incognito_behavior "split".

Tipo

booleano

Métodos

getBackgroundPage()

Somente em primeiro plano 
chrome.extension.getBackgroundPage()

Retorna o objeto "window" do JavaScript para a página em segundo plano em execução dentro da extensão atual. Retorna nulo se a extensão não tiver uma página em segundo plano.

Retorna

  • Janela | indefinido

getViews()

Somente em primeiro plano 
chrome.extension.getViews(
  fetchProperties?: object,
)

Retorna uma matriz dos objetos "window" do JavaScript para cada uma das páginas em execução na extensão atual.

Parâmetros

  • fetchProperties

    objeto opcional

    • tabId

      número opcional

      Chrome 54 ou mais recente

      Encontrar uma visualização de acordo com um ID de guia. Se esse campo for omitido, todas as visualizações serão retornadas.

    • tipo

      ViewType opcional

      O tipo de visualização a ser recebido. Se omitido, retorna todas as visualizações (incluindo páginas e guias em segundo plano).

    • windowId

      número opcional

      A janela para restringir a pesquisa. Se omitido, retorna todas as visualizações.

Retorna

  • Janela[]

    Matriz de objetos globais

isAllowedFileSchemeAccess()

Promessa 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

Recupera o estado do acesso da extensão ao esquema "file://". Isso corresponde à configuração "Permitir acesso a URLs de arquivo" controlada pelo usuário por extensão, acessível na página chrome://extensions.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

      Verdadeiro se a extensão puder acessar o esquema "file://". Caso contrário, será falso.

Retorna

  • Promise<boolean>

    Chrome 99 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os 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 transmitido para o callback.

isAllowedIncognitoAccess()

Promessa 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

Recupera o estado do acesso da extensão ao modo de navegação anônima. Isso corresponde à configuração "Permitido na navegação anônima" por extensão controlada pelo usuário, acessível na página chrome://extensions.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

      Verdadeiro se a extensão tiver acesso ao modo de navegação anônima. Caso contrário, será falso.

Retorna

  • Promise<boolean>

    Chrome 99 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os 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 transmitido para o callback.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

Define o valor do parâmetro CGI do AP usado no URL de atualização da extensão. Esse valor é ignorado para extensões hospedadas na Galeria de extensões do Chrome.

Parâmetros

  • dados

    string

Eventos