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

lastError

≤ MV2 Suspensa desde o Chrome 58

Use runtime.lastError.

É definido para o ciclo de vida de um callback se uma API de extensão assíncrona resultar em um erro. Se nenhum erro ocorrer, o lastError será undefined.

Tipo

objeto

Propriedades

  • mensagem

    string

    Descrição do erro que ocorreu.

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

getExtensionTabs()

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

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

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

Parâmetros

  • windowId

    número opcional

Retorna

  • Janela[]

    Matriz de objetos de janela global

getURL()

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

Use runtime.getURL.

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

Parâmetros

  • caminho

    string

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

Retorna

  • string

    O URL totalmente qualificado para o recurso.

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 apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

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 apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

sendRequest()

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

Use runtime.sendMessage.

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

Parâmetros

  • extensionId

    string opcional

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

  • solicitação

    qualquer um

  • callback

    função opcional

    Chrome 99 e versões mais recentes

    O parâmetro callback tem este formato: 

    (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

  • Promise<any>

    Chrome 99 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

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

onRequest

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

Use runtime.onMessage.

É acionado 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 este formato: 

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

    • solicitação

      qualquer um

    • sendResponse

      função

      O parâmetro sendResponse tem este formato: 

      () => void

onRequestExternal

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

Use runtime.onMessageExternal.

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

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

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

    • solicitação

      qualquer um

    • sendResponse

      função

      O parâmetro sendResponse tem este formato: 

      () => void