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 à troca de mensagens entre uma extensão e os scripts de conteúdo dela ou entre extensões, conforme descrito em detalhes em Transmissão de mensagens.

Tipos

ViewType

Chrome 44 ou mais recente

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

Tipo enumerado

Propriedades

inIncognitoContext

Verdadeiro para scripts de conteúdo executados em guias anônimas e para páginas de extensão em execução em um processo de navegação anônima. Essa última configuração só se aplica a extensões com o comportamento anonymous "split".

Tipo

boolean

lastError

≤ MV2 Descontinuado desde o Chrome 58

Use runtime.lastError.

Definido para o ciclo de vida de um callback se uma API de extensão ansiosa resultar em erro. Se nenhum erro tiver ocorrido, lastError será undefined.

Tipo

objeto

Propriedades

  • mensagem

    string

    Descrição do erro ocorrido.

Métodos

getBackgroundPage()

Apenas em primeiro plano 
chrome.extension.getBackgroundPage()

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

Retorna

  • Janela|indefinida

getExtensionTabs()

≤ MV2 Somente em primeiro plano Descontinuado
chrome.extension.getExtensionTabs(
  windowId?: number,
)

Use extension.getViews {type: "tab"}.

Retorna uma matriz dos objetos JavaScript da 'janela' para cada uma das guias em execução na extensão atual. Se windowId for especificado, retorna apenas os objetos "window" das guias anexadas à janela especificada.

Parâmetros

  • windowId

    número opcional

Retorna

  • Janela[]

    Matriz de objetos de janela globais

getURL()

≤ MV2 Descontinuado desde o Chrome 58
chrome.extension.getURL(
  path: string,
)

Use runtime.getURL.

Converte um caminho relativo dentro de um diretório de instalação de extensão em um URL totalmente qualificado.

Parâmetros

  • caminho

    string

    Um caminho para um recurso dentro de uma extensão expresso em relação ao diretório de instalação.

Retorna

  • string

    O URL totalmente qualificado do recurso.

getViews()

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

Retorna uma matriz dos objetos JavaScript 'window' para cada uma das páginas executadas na extensão atual.

Parâmetros

  • fetchProperties

    objeto opcional

    • tabId

      número opcional

      Chrome 54 ou mais recente

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

    • digitar

      ViewType opcional

      O tipo de visualização que você quer receber. Se omitido, retorna todas as visualizações (incluindo páginas e guias de segundo plano).

    • windowId

      número opcional

      A janela à qual a pesquisa será restringida. Se omitido, retorna todas as visualizações.

Retorna

  • Janela[]

    Matriz de objetos globais

isAllowedFileSchemeAccess()

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

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

Parâmetros

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

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

Retorna

  • Promise<boolean>

    Chrome 99 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.

isAllowedIncognitoAccess()

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

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

Parâmetros

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

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

Retorna

  • Promise<boolean>

    Chrome 99 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.

sendRequest()

Promise &leq; MV2 descontinuado
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

Use runtime.sendMessage.

Envia uma única solicitação a outros listeners dentro da extensão. Semelhante a runtime.connect, mas envia apenas uma solicitação com uma resposta opcional. O evento extension.onRequest é disparado em cada página da extensão.

Parâmetros

  • extensionId

    string opcional

    O ID da extensão à qual você quer se conectar. Se omitido, o padrão é sua própria extensão.

  • request

    qualquer um

  • callback

    função optional

    Chrome 99 ou mais recente

    O parâmetro callback tem esta aparência: 

    (response: any)=>void

    • resposta

      qualquer um

      O objeto de resposta JSON enviado pelo gerenciador da solicitação. Se ocorrer um erro durante a conexão com a extensão, o callback será chamado sem argumentos, e runtime.lastError será definido como a mensagem de erro.

Retorna

  • Prometa<qualquer>

    Chrome 99 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.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

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

Parâmetros

  • dados

    string

Eventos

onRequest

&leq; MV2 descontinuado
chrome.extension.onRequest.addListener(
  callback: function,
)

Use runtime.onMessage.

Disparado quando uma solicitação é enviada de um processo de extensão ou um script de conteúdo.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (request: any,sender: runtime.MessageSender,sendResponse: function)=>void

    • request

      qualquer um

    • sendResponse

      função

      O parâmetro sendResponse tem esta aparência: 

      ()=>void

onRequestExternal

&leq; MV2 descontinuado
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Use runtime.onMessageExternal.

Disparado quando uma solicitação é enviada por outra extensão.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (request: any,sender: runtime.MessageSender,sendResponse: function)=>void

    • request

      qualquer um

    • sendResponse

      função

      O parâmetro sendResponse tem esta aparência: 

      ()=>void