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

Tipos

ViewType

Chrome 44 ou superior

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

Enumeração

"guia"

"popup"

Propriedades

inIncognitoContext

Verdadeiro para scripts de conteúdo executados em guias anônimas e para páginas de extensão em execução dentro de um processo de navegação anônima. O último se aplica somente a extensões com "dividir" comportamento_de_navegação anônima.

Tipo

booleano

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 assíncrona tiver resultado em erro. Se nenhum erro tiver ocorrido, lastError será undefined.

Tipo

objeto

Propriedades

  • mensagem

    string

    Descrição do erro ocorrido.

Métodos

getBackgroundPage()

Somente primeiro plano 
chrome.extension.getBackgroundPage()

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

Retorna

  • Janela | indefinido

getExtensionTabs()

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

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

Retorna uma matriz da "janela" do JavaScript objetos para cada uma das guias executadas dentro da extensão atual. Se windowId for especificado, retornará apenas o valor "window". objetos de guias anexados à janela especificada.

Parâmetros

  • windowId

    número opcional

Retorna

  • Janela[]

    Matriz de objetos de janela global

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 relativo ao respectivo diretório de instalação.

Retorna

  • string

    O URL totalmente qualificado para o recurso.

getViews()

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

Retorna uma matriz da "janela" do JavaScript para cada uma das páginas executadas na extensão atual.

Parâmetros

  • fetchProperties

    objeto opcional

    • tabId

      número opcional

      Chrome 54 ou superior

      Encontre 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 recebida. Se omitido, retorna todas as visualizações (incluindo guias e páginas de fundo).

    • windowId

      número opcional

      A janela à qual a pesquisa será restrita. 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 arquivo "file://" esquema. Isso corresponde à extensão 'Permitir acesso a URLs de arquivo' por extensão, controlada pelo usuário que pode ser acessada na página chrome://extensions.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

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

Retorna

  • Promise<boolean>

    Chrome 99 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

isAllowedIncognitoAccess()

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

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

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

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

Retorna

  • Promise<boolean>

    Chrome 99 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

sendRequest()

Promessa ≤ 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 somente 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.

  • solicitação

    qualquer um

  • callback

    função opcional

    Chrome 99 ou versão 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 ao se conectar à extensão, o callback será chamado sem argumentos, e runtime.lastError será definido como a mensagem de erro.

Retorna

  • Promessa<qualquer>

    Chrome 99 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

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

Parâmetros

  • dados

    string

Eventos

onRequest

&amp;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 de 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

    • solicitação

      qualquer um

    • sendResponse

      função

      O parâmetro sendResponse tem esta aparência: 

      () => void

onRequestExternal

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

Use runtime.onMessageExternal.

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

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

    • solicitação

      qualquer um

    • sendResponse

      função

      O parâmetro sendResponse tem esta aparência: 

      () => void