chrome.extension

Descrição

A API chrome.extension tem utilitários que podem ser usados por qualquer página de extensão. Isso inclui suporte para 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 de extensão.

Enumeração

"tab"

"popup"

Propriedades

inIncognitoContext

Verdadeiro para scripts de conteúdo executados em guias anônimas e para páginas de extensão executadas em um processo anônimo. O último se aplica apenas a extensões com incognito_behavior "split".

Tipo

booleano

Métodos

getBackgroundPage()

Somente em primeiro plano 
chrome.extension.getBackgroundPage(): Window | undefined

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

Retorna

  • Window | undefined

getViews()

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

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

      number optional

      Chrome 54 ou mais recente

      Encontra uma visualização de acordo com um ID de guia. Se este 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 páginas e guias em segundo plano).

    • windowId

      number optional

      A janela em que a pesquisa será restrita. Se omitido, retorna todas as visualizações.

Retorna

  • Window[]

    Matriz de objetos globais

isAllowedFileSchemeAccess()

Promise 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
): Promise<boolean>

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 em cada extensão, acessível 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 esquema "file://". Caso contrário, será falso.

Retorna

  • Promise<boolean>

    Chrome 99+

isAllowedIncognitoAccess()

Promise 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
): Promise<boolean>

Recupera o estado do 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 e acessível na página chrome://extensions.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

      True se a extensão tiver acesso ao modo incógnito. Caso contrário, false.

Retorna

  • Promise<boolean>

    Chrome 99+

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
): void

Define o valor do parâmetro CGI 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