chrome.webviewTag

Descrição

Use a tag webview para carregar ativamente conteúdo ao vivo da Web pela rede e incorporá-lo ao app do Chrome. O app pode controlar a aparência da webview e interagir com o conteúdo da Web, iniciar navegações em uma página da Web incorporada, reagir a eventos de erro que ocorrem nela e muito mais. Consulte Uso.

Permissões

webview

Tipos

ClearDataOptions

Opções que determinam quais dados devem ser limpos por clearData.

Propriedades

  • desde

    número opcional

    Limpa os dados acumulados nessa data ou depois dela, representados em milissegundos desde o período (acessível pelo método getTime do objeto Date do JavaScript). Se não houver, o padrão será 0, o que remove todos os dados de navegação.

ClearDataTypeSet

Um conjunto de tipos de dados. As propriedades ausentes são interpretadas como false.

Propriedades

  • appcache

    booleano opcional

    Appcaches de sites.

  • cache

    booleano opcional

    Chrome 44 e versões mais recentes

    Desde o Chrome 43. O cache do navegador. Observação: ao remover dados, todo o cache é limpo, não apenas o intervalo especificado.

  • cookies

    booleano opcional

    Os cookies da partição.

  • fileSystems

    booleano opcional

    Sistemas de arquivos de sites.

  • indexedDB

    booleano opcional

    Dados IndexedDB dos sites.

  • localStorage

    booleano opcional

    Dados de armazenamento local dos sites.

  • persistentCookies

    booleano opcional

    Chrome 58 ou mais recente

    Os cookies permanentes da partição.

  • sessionCookies

    booleano opcional

    Chrome 58 ou mais recente

    Os cookies de sessão da partição.

  • webSQL

    booleano opcional

    Dados do WebSQL dos sites.

ContentScriptDetails

Chrome 44 e versões mais recentes

Detalhes do script de conteúdo a ser injetado. Consulte a documentação de scripts de conteúdo para mais detalhes.

Propriedades

  • all_frames

    booleano opcional

    Se all_frames for true, isso implica que o JavaScript ou o CSS precisa ser injetado em todos os frames da página atual. Por padrão, all_frames é false, e o JavaScript ou CSS é injetado apenas no frame superior.

  • css

    InjectionItems opcional

    O código CSS ou uma lista de arquivos CSS a serem injetados nas páginas correspondentes. Eles são injetados na ordem em que aparecem, antes que qualquer DOM seja construído ou exibido para a página.

  • exclude_globs

    string[] opcional

    Aplicado após correspondências para excluir URLs que correspondem a esse glob. Destina-se a emular a palavra-chave @exclude do Greasemonkey.

  • exclude_matches

    string[] opcional

    Exclui as páginas em que esse script de conteúdo seria injetado.

  • include_globs

    string[] opcional

    É aplicado após as correspondências para incluir apenas os URLs que também correspondem a esse glob. Destinado a emular a palavra-chave @include do Greasemonkey.

  • js

    InjectionItems opcional

    O código JavaScript ou uma lista de arquivos JavaScript a serem injetados nas páginas correspondentes. Eles são injetados na ordem em que aparecem.

  • match_about_blank

    booleano opcional

    Define se o script de conteúdo será inserido em about:blank e about:srcdoc. Os scripts de conteúdo só serão injetados nas páginas quando o URL herdado for correspondido por um dos padrões declarados no campo de correspondências. O URL de herança é o URL do documento que criou o frame ou a janela. Os scripts de conteúdo não podem ser inseridos em frames em sandbox.

  • correspondências

    string[]

    Especifica em quais páginas esse script de conteúdo será injetado.

  • nome

    string

    O nome do script de conteúdo a ser injetado.

  • run_at

    RunAt opcional

    O mais cedo que o JavaScript ou o CSS será injetado na guia. O padrão é "document_idle".

ContentWindow

Gerenciador de mensagens para uma janela de visitante.

Propriedades

  • postMessage

    void

    Envia uma mensagem para o conteúdo da Web incorporado, desde que ele esteja exibindo uma página da origem de destino. Esse método fica disponível quando a página termina de carregar. Ouça o evento contentload e chame o método.

    O convidado poderá enviar respostas ao incorporador postando a mensagem para event.source no evento de mensagem recebido.

    Essa API é idêntica à API postMessage do HTML5 para comunicação entre páginas da Web. O incorporador pode detectar respostas adicionando um listener de eventos message ao próprio frame.

    A função postMessage é semelhante a esta: 

    (message: any, targetOrigin: string) => {...}

    • mensagem

      qualquer um

      Objeto de mensagem a ser enviado ao convidado.

    • targetOrigin

      string

      Especifica qual deve ser a origem da janela de convidado para que o evento seja enviado.

ContextMenuCreateProperties

Chrome 44 e versões mais recentes

Propriedades

  • marcado

    booleano opcional

    O estado inicial de uma caixa de seleção ou um botão de opção: "true" para selecionado e "false" para desmarcado. Só é possível selecionar um item de cada vez em um determinado grupo de itens de opção.

  • contexts

    [ContextType, ...ContextType[]] opcional

    Lista de contextos em que o item de menu vai aparecer. O padrão será ['page'] se nada for especificado.

  • documentUrlPatterns

    string[] opcional

    Permite restringir o item para que ele seja aplicado apenas a documentos cujo URL corresponda a um dos padrões fornecidos. Isso também se aplica a frames. Para mais detalhes sobre o formato de um padrão, consulte Padrões de correspondência.

  • ativado

    booleano opcional

    Indica se o item do menu de contexto está ativado ou desativado. O valor padrão é true.

  • id

    string opcional

    O ID exclusivo a ser atribuído a este item. Obrigatório para páginas de eventos. Não pode ser igual a outro ID para essa extensão.

  • parentId

    string | número opcional

    O ID de um item de menu principal, que torna o item filho de um item adicionado anteriormente.

  • targetUrlPatterns

    string[] opcional

    Semelhante a "documentUrlPatterns", mas permite filtrar com base no atributo src de tags de imagem/áudio/vídeo e no href de tags de âncora.

  • título

    string opcional

    O texto a ser mostrado no item. É obrigatório, a menos que type seja "separator". Quando o contexto é "selection", é possível usar %s na string para mostrar o texto selecionado. Por exemplo, se o valor desse parâmetro for "Traduzir "%s" para Pig Latin" e o usuário selecionar a palavra "legal", o item do menu de contexto para a seleção será "Traduzir "legal" para Pig Latin".

  • tipo

    ItemType opcional

    O tipo de item de menu. O padrão será "normal" se não for especificado.

  • onclick

    void optional

    Uma função que será chamada quando o item de menu for clicado.

    A função onclick é semelhante a esta: 

    (info: OnClickData) => {...}

    • informações

      OnClickData

      Informações sobre o item clicado e o contexto em que o clique ocorreu.

ContextMenus

Chrome 44 e versões mais recentes

Propriedades

  • onShow

    Evento<functionvoidvoid>

    É acionado antes de mostrar um menu de contexto neste webview. Pode ser usado para desativar esse menu de contexto chamando event.preventDefault().

    A função onShow.addListener é semelhante a esta: 

    (callback: function) => {...}

    • callback

      função

      O parâmetro callback tem este formato: 

      (event: object) => void

      • evento

        objeto

        • preventDefault

          void

          Chame esse método para impedir a exibição do menu de contexto.

          A função preventDefault é semelhante a esta: 

          () => {...}

  • create

    void

    Cria um novo item de menu de contexto. Se ocorrer um erro durante a criação, talvez você não saiba até que o callback de criação seja acionado. Os detalhes estarão em runtime.lastError.

    A função create é semelhante a esta: 

    (createProperties: object, callback?: function) => {...}

    • createProperties

      objeto

      As propriedades usadas para criar o item

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      () => void

    • retorna

      string | número

      O ID do item recém-criado.

  • remover

    void

    Remove um item do menu de contexto.

    A função remove é semelhante a esta: 

    (menuItemId: string | number, callback?: function) => {...}

    • menuItemId

      string | número

      O ID do item do menu de contexto a ser removido.

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      () => void

  • removeAll

    void

    Remove todos os itens do menu de contexto adicionados a este webview.

    A função removeAll é semelhante a esta: 

    (callback?: function) => {...}

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      () => void

  • update

    void

    Atualiza um item de menu de contexto criado anteriormente.

    A função update é semelhante a esta: 

    (id: string | number, updateProperties: object, callback?: function) => {...}

    • id

      string | número

      O ID do item a ser atualizado.

    • updateProperties

      objeto

      As propriedades a serem atualizadas. Aceita os mesmos valores da função de criação.

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      () => void

ContextMenuUpdateProperties

Chrome 44 e versões mais recentes

Propriedades

  • marcado

    booleano opcional

    O estado de uma caixa de seleção ou de opção: "true" para selecionado e "false" para não selecionado. Só é possível selecionar um item de cada vez em um determinado grupo de itens de opção.

  • contexts

    [ContextType, ...ContextType[]] opcional

    Lista de contextos em que o item de menu vai aparecer.

  • documentUrlPatterns

    string[] opcional

    Permite restringir o item para que ele seja aplicado apenas a documentos cujo URL corresponda a um dos padrões fornecidos. Isso também se aplica a frames. Para mais detalhes sobre o formato de um padrão, consulte Padrões de correspondência.

  • ativado

    booleano opcional

    Indica se o item do menu de contexto está ativado ou desativado.

  • parentId

    string | número opcional

    O ID de um item de menu principal, que torna o item filho de um item adicionado anteriormente. Observação:não é possível mudar um item para que ele seja filho de um dos próprios descendentes.

  • targetUrlPatterns

    string[] opcional

    Semelhante a "documentUrlPatterns", mas permite filtrar com base no atributo src de tags de imagem/áudio/vídeo e no href de tags de âncora.

  • título

    string opcional

    O texto a ser exibido no item

  • tipo

    ItemType opcional

    O tipo de item de menu.

  • onclick

    void optional

    Uma função que será chamada quando o item de menu for clicado.

    A função onclick é semelhante a esta: 

    (info: OnClickData) => {...}

    • informações

      OnClickData

      Informações sobre o item clicado e o contexto em que o clique ocorreu.

ContextType

Chrome 44 e versões mais recentes

Os diferentes contextos em que um menu pode aparecer. Especificar "all" é equivalente à combinação de todos os outros contextos.

Enumeração

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

Interface anexada aos eventos DOM dialog.

Propriedades

  • cancelar

    void

    Rejeite a caixa de diálogo. Equivalente a clicar em "Cancelar" em uma caixa de diálogo confirm ou prompt.

    A função cancel é semelhante a esta: 

    () => {...}

  • ok

    void

    Aceite a caixa de diálogo. Equivalente a clicar em "OK" em uma caixa de diálogo alert, confirm ou prompt.

    A função ok é semelhante a esta: 

    (response?: string) => {...}

    • resposta

      string opcional

      A string de resposta a ser fornecida ao convidado ao aceitar uma caixa de diálogo prompt.

DownloadPermissionRequest

O tipo de objeto request que acompanha um evento DOM download permissionrequest.

Propriedades

  • requestMethod

    string

    O tipo de solicitação HTTP (por exemplo, GET) associado à solicitação de download.

  • url

    string

    O URL de download solicitado.

  • allow

    void

    Permita a solicitação de permissão.

    A função allow é semelhante a esta: 

    () => {...}

  • deny

    void

    Negue a solicitação de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é semelhante a esta: 

    () => {...}

FileSystemPermissionRequest

O tipo de objeto request que acompanha um evento DOM filesystem permissionrequest.

Propriedades

  • url

    string

    O URL do frame que solicita acesso ao sistema de arquivos local.

  • allow

    void

    Permita a solicitação de permissão.

    A função allow é semelhante a esta: 

    () => {...}

  • deny

    void

    Negue a solicitação de permissão.

    A função deny é semelhante a esta: 

    () => {...}

FindCallbackResults

Contém todos os resultados da solicitação de busca.

Propriedades

  • activeMatchOrdinal

    number

    O número ordinal da correspondência atual.

  • cancelada

    booleano

    Indica se a solicitação de busca foi cancelada.

  • numberOfMatches

    number

    O número de vezes que searchText foi correspondido na página.

  • selectionRect

    SelectionRect

    Descreve um retângulo em torno da correspondência ativa nas coordenadas da tela.

FindOptions

Opções para a solicitação de busca.

Propriedades

  • para trás

    booleano opcional

    Sinaliza para encontrar correspondências na ordem inversa. O valor padrão é false.

  • matchCase

    booleano opcional

    Flag para corresponder à diferenciação entre maiúsculas e minúsculas. O valor padrão é false.

FullscreenPermissionRequest

Chrome 43 e versões mais recentes

O tipo de objeto request que acompanha um evento DOM fullscreen permissionrequest.

Propriedades

  • origem

    string

    A origem do frame dentro do webview que iniciou a solicitação em tela cheia.

  • allow

    void

    Permita a solicitação de permissão.

    A função allow é semelhante a esta: 

    () => {...}

  • deny

    void

    Negue a solicitação de permissão.

    A função deny é semelhante a esta: 

    () => {...}

GeolocationPermissionRequest

O tipo de objeto request que acompanha um evento DOM geolocation permissionrequest.

Propriedades

  • url

    string

    O URL do frame que solicita acesso aos dados de geolocalização.

  • allow

    void

    Permita a solicitação de permissão.

    A função allow é semelhante a esta: 

    () => {...}

  • deny

    void

    Negue a solicitação de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é semelhante a esta: 

    () => {...}

HidPermissionRequest

Chrome 125+

O tipo de objeto request que acompanha um evento DOM hid permissionrequest.

Propriedades

  • url

    string

    O URL do frame que solicita acesso à API HID.

  • allow

    void

    Permita a solicitação de permissão.

    A função allow é semelhante a esta: 

    () => {...}

  • deny

    void

    Negue a solicitação de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é semelhante a esta: 

    () => {...}

InjectDetails

Detalhes do script ou CSS a ser injetado. O código ou a propriedade do arquivo precisam ser definidos, mas não ao mesmo tempo.

Propriedades

  • código

    string opcional

    Código JavaScript ou CSS a ser injetado.

    Aviso:tenha cuidado ao usar o parâmetro code. O uso incorreto pode expor seu app a ataques de scripting em vários sites.

  • arquivo

    string opcional

    Arquivo JavaScript ou CSS a ser injetado.

InjectionItems

Chrome 44 e versões mais recentes

O tipo de item de injeção: código ou um conjunto de arquivos.

Propriedades

  • código

    string opcional

    Código JavaScript ou CSS a ser injetado nas páginas correspondentes.

  • arquivos

    string[] opcional

    A lista de arquivos JavaScript ou CSS a serem injetados nas páginas correspondentes. Eles são injetados na ordem em que aparecem nessa matriz.

LoadPluginPermissionRequest

O tipo de objeto request que acompanha um evento DOM loadplugin permissionrequest.

Propriedades

  • identificador

    string

    A string de identificador do plug-in.

  • nome

    string

    O nome de exibição do plug-in.

  • allow

    void

    Permita a solicitação de permissão. Esse é o comportamento padrão se deny não for chamado.

    A função allow é semelhante a esta: 

    () => {...}

  • deny

    void

    Negue a solicitação de permissão.

    A função deny é semelhante a esta: 

    () => {...}

MediaPermissionRequest

O tipo de objeto request que acompanha um evento DOM media permissionrequest.

Propriedades

  • url

    string

    O URL do frame que solicita acesso à mídia do usuário.

  • allow

    void

    Permita a solicitação de permissão.

    A função allow é semelhante a esta: 

    () => {...}

  • deny

    void

    Negue a solicitação de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é semelhante a esta: 

    () => {...}

NewWindow

Interface anexada aos eventos DOM newwindow.

Propriedades

  • anexar

    void

    Anexe a página de destino solicitada a um elemento webview existente.

    A função attach é semelhante a esta: 

    (webview: object) => {...}

    • WebView

      objeto

      O elemento webview ao qual a página de destino precisa ser anexada.

  • descartar

    void

    Cancele a solicitação de nova janela.

    A função discard é semelhante a esta: 

    () => {...}

PointerLockPermissionRequest

O tipo de objeto request que acompanha um evento DOM pointerLock permissionrequest.

Propriedades

  • lastUnlockedBySelf

    booleano

    Se o frame de solicitação foi o cliente mais recente a manter a trava do ponteiro.

  • url

    string

    O URL do frame que solicita o bloqueio do ponteiro.

  • userGesture

    booleano

    Indica se o bloqueio do ponteiro foi solicitado como resultado de um gesto de entrada do usuário.

  • allow

    void

    Permita a solicitação de permissão.

    A função allow é semelhante a esta: 

    () => {...}

  • deny

    void

    Negue a solicitação de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é semelhante a esta: 

    () => {...}

SelectionRect

Descreve um retângulo em coordenadas da tela.

A semântica de contenção é semelhante a uma matriz, ou seja, a coordenada (left, top) é considerada contida pelo retângulo, mas a coordenada (left + width, top) não.

Propriedades

  • altura

    number

    Altura do retângulo.

  • esquerda

    number

    Distância da borda esquerda da tela até a borda esquerda do retângulo.

  • superior

    number

    Distância da borda superior da tela até a borda superior do retângulo.

  • largura

    number

    Largura do retângulo.

WebRequestEventInterface

Chrome 44 e versões mais recentes

Interface que fornece acesso aos eventos de webRequest na página de convidados. Consulte a API de extensões chrome.webRequest para saber mais sobre o ciclo de vida da webRequest e conceitos relacionados. Observação: o evento chrome.webRequest.onActionIgnored não tem suporte para visualizações da Web.

Para ilustrar como o uso é diferente da API Extensions WebRequest, considere o seguinte exemplo de código que bloqueia solicitações de visitantes para URLs que correspondem a *://www.evil.com/*:

webview.request.onBeforeRequest.addListener(
  function(details) { return {cancel: true}; },
  {urls: ["*://www.evil.com/*"]},
  ["blocking"]);

Além disso, essa interface oferece suporte a regras declarativas de webRequest usando eventos onRequest e onMessage. Consulte declarativeWebRequest para conferir detalhes da API.

As condições e ações para solicitações da Web declarativas da WebView precisam ser instanciadas a partir das contrapartes chrome.webViewRequest.*. O exemplo de código abaixo bloqueia de forma declarativa todas as solicitações para "example.com" na webview myWebview:

var rule = {
  conditions: [
    new chrome.webViewRequest.RequestMatcher({ url: { hostSuffix: 'example.com' } })
  ],
  actions: [ new chrome.webViewRequest.CancelRequest() ]
};
myWebview.request.onRequest.addRules([rule]);

ZoomMode

Chrome 43 e versões mais recentes

Define como o zoom é processado na webview.

Enumeração

"per-origin"
As mudanças de zoom vão persistir na origem da página com zoom, ou seja, todas as outras visualizações da Web na mesma partição que forem navegadas para essa mesma origem também terão zoom. Além disso, as mudanças de zoom per-origin são salvas com a origem, o que significa que, ao navegar para outras páginas na mesma origem, todas elas terão o mesmo nível de zoom.

"por visualização"
As mudanças de zoom só têm efeito nessa visualização da Web, e as mudanças de zoom em outras visualizações da Web não afetam o zoom dessa visualização. Além disso, as mudanças de zoom da per-view são redefinidas na navegação. A navegação em uma webview sempre carrega páginas com os fatores de zoom por origem (dentro do escopo da partição).

"disabled"
Desativa todo o zoom na visualização da Web. O conteúdo vai voltar ao nível de zoom padrão, e todas as tentativas de mudança de zoom serão ignoradas.

Propriedades

contentWindow

Referência de objeto que pode ser usada para postar mensagens na página de visitantes.

Tipo

ContentWindow

contextMenus

Chrome 44 e versões mais recentes

Semelhante à API ContextMenus do Chrome, mas se aplica a webview em vez do navegador. Use a API webview.contextMenus para adicionar itens ao menu de contexto do webview. Você pode escolher os tipos de objetos aos quais as adições do menu de contexto se aplicam, como imagens, hiperlinks e páginas.

Tipo

ContextMenus

request

Interface que fornece acesso aos eventos de webRequest na página de convidados.

Tipo

WebRequestEventInterface

Métodos

addContentScripts()

Chrome 44 e versões mais recentes 
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)

Adiciona regras de injeção de script de conteúdo ao webview. Quando o webview navega para uma página que corresponde a uma ou mais regras, os scripts associados são injetados. É possível adicionar regras ou atualizar regras existentes por programação.

O exemplo a seguir adiciona duas regras ao webview: "myRule" e "anotherRule".

webview.addContentScripts([
  {
    name: 'myRule',
    matches: ['http://www.foo.com/*'],
    css: { files: ['mystyles.css'] },
    js: { files: ['jquery.js', 'myscript.js'] },
    run_at: 'document_start'
  },
  {
    name: 'anotherRule',
    matches: ['http://www.bar.com/*'],
    js: { code: "document.body.style.backgroundColor = 'red';" },
    run_at: 'document_end'
  }]);
 ...

// Navigates webview.
webview.src = 'http://www.foo.com';

É possível adiar a chamada de addContentScripts até que seja necessário injetar scripts.

O exemplo a seguir mostra como substituir uma regra.

webview.addContentScripts([{
    name: 'rule',
    matches: ['http://www.foo.com/*'],
    js: { files: ['scriptA.js'] },
    run_at: 'document_start'}]);

// Do something.
webview.src = 'http://www.foo.com/*';
 ...
// Overwrite 'rule' defined before.
webview.addContentScripts([{
    name: 'rule',
    matches: ['http://www.bar.com/*'],
    js: { files: ['scriptB.js'] },
    run_at: 'document_end'}]);

Se webview tiver sido navegado até a origem (por exemplo, foo.com) e chamar webview.addContentScripts para adicionar "myRule", será necessário aguardar a próxima navegação para que os scripts sejam injetados. Se você quiser injetar imediatamente, executeScript vai fazer a coisa certa.

As regras são preservadas mesmo se o processo convidado falhar ou for encerrado ou mesmo se o webview for substituído.

Consulte a documentação de scripts de conteúdo para mais detalhes.

Parâmetros

back()

chrome.webviewTag.back(
  callback?: function,
)

Volta uma entrada de histórico, se possível. É equivalente a go(-1).

Parâmetros

  • callback

    função opcional

    Chrome 44 e versões mais recentes

    O parâmetro callback tem este formato: 

    (success: boolean) => void

    • sucesso

      booleano

      Indica se a navegação foi bem-sucedida.

canGoBack()

chrome.webviewTag.canGoBack()

Indica se é possível voltar no histórico. O estado dessa função é armazenado em cache e atualizado antes de cada loadcommit. Portanto, o melhor lugar para chamá-la é em loadcommit.

Retorna

  • booleano

canGoForward()

chrome.webviewTag.canGoForward()

Indica se é possível avançar no histórico. O estado dessa função é armazenado em cache e atualizado antes de cada loadcommit. Portanto, o melhor lugar para chamá-la é em loadcommit.

Retorna

  • booleano

captureVisibleRegion()

Chrome 50 ou mais recente 
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)

Captura a região visível da visualização da Web.

Parâmetros

  • opções

    ImageDetails opcional

  • callback

    função

    O parâmetro callback tem este formato: 

    (dataUrl: string) => void

    • dataUrl

      string

      Um URL de dados que codifica uma imagem da área visível da guia capturada. Pode ser atribuído à propriedade "src" de um elemento de imagem HTML para exibição.

clearData()

chrome.webviewTag.clearData(
  options: ClearDataOptions,
  types: ClearDataTypeSet,
  callback?: function,
)

Limpa os dados de navegação da partição webview.

Parâmetros

  • opções

    ClearDataOptions

    Opções que determinam quais dados serão limpos.

  • Os tipos de dados a serem limpos.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

executeScript()

chrome.webviewTag.executeScript(
  details: InjectDetails,
  callback?: function,
)

Injeta o código JavaScript na página de visitante.

O exemplo de código abaixo usa a injeção de script para definir a cor de plano de fundo da página de visitante como vermelho:

webview.executeScript({ code: "document.body.style.backgroundColor = 'red'" });

Parâmetros

  • detalhes

    InjectDetails

    Detalhes do script a ser executado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result?: any[]) => void

    • resultado

      any[] opcional

      O resultado do script em cada frame injetado.

find()

chrome.webviewTag.find(
  searchText: string,
  options?: FindOptions,
  callback?: function,
)

Inicia uma solicitação de busca na página.

Parâmetros

  • searchText

    string

    A string a ser encontrada na página.

  • opções

    FindOptions opcional

    Opções para a solicitação de busca.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (results?: FindCallbackResults) => void

    • resultados

      FindCallbackResults opcional

      Contém todos os resultados da solicitação de busca. results pode ser omitido se não for usado no corpo da função de callback. Por exemplo, se o callback for usado apenas para discernir quando a solicitação de busca for concluída.

forward()

chrome.webviewTag.forward(
  callback?: function,
)

Navegue para frente uma entrada do histórico, se possível. É equivalente a go(1).

Parâmetros

  • callback

    função opcional

    Chrome 44 e versões mais recentes

    O parâmetro callback tem este formato: 

    (success: boolean) => void

    • sucesso

      booleano

      Indica se a navegação foi bem-sucedida.

getAudioState()

Chrome 62 ou mais recente 
chrome.webviewTag.getAudioState(
  callback: function,
)

Consulta o estado do áudio.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (audible: boolean) => void

    • Audible

      booleano

getProcessId()

chrome.webviewTag.getProcessId()

Retorna o ID de processo interno do Chrome para o processo atual da página da Web do visitante, permitindo que os incorporadores saibam quantos visitantes seriam afetados pelo encerramento do processo. Dois convidados vão compartilhar um processo somente se pertencerem ao mesmo app e tiverem o mesmo ID da partição de armazenamento. A chamada é síncrona e retorna a noção em cache do ID do processo atual do incorporador. O ID do processo não é o mesmo que o ID do processo do sistema operacional.

Retorna

  • number

getUserAgent()

chrome.webviewTag.getUserAgent()

Retorna a string do user agent usada pelo webview para solicitações de página de visitante.

Retorna

  • string

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

Recebe o fator de zoom atual.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (zoomFactor: number) => void

    • zoomFactor

      number

      O fator de zoom atual.

getZoomMode()

Chrome 43 e versões mais recentes 
chrome.webviewTag.getZoomMode(
  callback: function,
)

Recebe o modo de zoom atual.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      ZoomMode

      O modo de zoom atual do webview.

go()

chrome.webviewTag.go(
  relativeIndex: number,
  callback?: function,
)

Navegue até uma entrada do histórico usando um índice de histórico relativo à navegação atual. Se a navegação solicitada for impossível, esse método não terá efeito.

Parâmetros

  • relativeIndex

    number

    Índice de histórico relativo para o qual o webview precisa navegar. Por exemplo, um valor de 2 vai navegar para duas entradas de histórico à frente, se possível. Um valor de -3 vai navegar para três entradas à frente.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (success: boolean) => void

    • sucesso

      booleano

      Indica se a navegação foi bem-sucedida.

insertCSS()

chrome.webviewTag.insertCSS(
  details: InjectDetails,
  callback?: function,
)

Injeta CSS na página de visitante.

Parâmetros

  • detalhes

    InjectDetails

    Detalhes do CSS a ser inserido.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

isAudioMuted()

Chrome 62 ou mais recente 
chrome.webviewTag.isAudioMuted(
  callback: function,
)

Consulta se o áudio está silenciado.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (muted: boolean) => void

    • silenciado

      booleano

isSpatialNavigationEnabled()

Chrome 71 e versões mais recentes 
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

Consulta se a navegação espacial está ativada para a visualização da Web.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (enabled: boolean) => void

    • ativado

      booleano

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

Indica se a string do agente do usuário do webview foi substituída por webviewTag.setUserAgentOverride.

loadDataWithBaseUrl()

chrome.webviewTag.loadDataWithBaseUrl(
  dataUrl: string,
  baseUrl: string,
  virtualUrl?: string,
)

Carrega um URL de dados com um URL de base especificado usado para links relativos. Se preferir, um URL virtual pode ser fornecido para ser mostrado ao usuário em vez do URL de dados.

Parâmetros

  • dataUrl

    string

    O URL de dados a ser carregado.

  • baseUrl

    string

    O URL base que será usado para links relativos.

  • virtualUrl

    string opcional

    O URL que será exibido para o usuário (na barra de endereço).

print()

chrome.webviewTag.print()

Mostra o conteúdo de webview. Isso equivale a chamar a função de impressão com script do próprio webview.

reload()

chrome.webviewTag.reload()

Atualiza a página de nível superior atual.

removeContentScripts()

Chrome 44 e versões mais recentes 
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)

Remove scripts de conteúdo de um webview.

O exemplo a seguir remove "myRule", que foi adicionado antes.

webview.removeContentScripts(['myRule']);

É possível remover todas as regras chamando:

webview.removeContentScripts();

Parâmetros

  • scriptNameList

    string[] opcional

    Uma lista de nomes de scripts de conteúdo que serão removidos. Se a lista estiver vazia, todos os scripts de conteúdo adicionados ao webview serão removidos.

setAudioMuted()

Chrome 62 ou mais recente 
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

Define o estado de silenciamento de áudio da visualização da Web.

Parâmetros

  • desativar som

    booleano

    Desativar valor de áudio

setSpatialNavigationEnabled()

Chrome 71 e versões mais recentes 
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

Define o estado de navegação espacial da WebView.

Parâmetros

  • ativado

    booleano

    Valor do estado de navegação espacial.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

Substitua a string do user agent usada pelo webview para solicitações de página de visitante. A substituição vai fazer com que os valores do cabeçalho "User-Agent Client Hint" e os valores retornados por navigator.userAgentData fiquem vazios para as solicitações de página de visitante em que essa substituição é aplicada.

Parâmetros

  • userAgent

    string

    A string do user agent a ser usada.

setZoom()

chrome.webviewTag.setZoom(
  zoomFactor: number,
  callback?: function,
)

Muda o fator de zoom da página. O escopo e a persistência dessa mudança são determinados pelo modo de zoom atual da visualização da Web (consulte webviewTag.ZoomMode).

Parâmetros

  • zoomFactor

    number

    O novo fator de zoom.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

setZoomMode()

Chrome 43 e versões mais recentes 
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

Define o modo de zoom do webview.

Parâmetros

  • ZoomMode

    ZoomMode

    Define como o zoom é processado na webview.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

stop()

chrome.webviewTag.stop()

Interrompe o carregamento da navegação webview atual, se estiver em andamento.

stopFinding()

chrome.webviewTag.stopFinding(
  action?: "clear" 
  | "keep" 
  | "activate" 
 ,
)

Encerra a sessão de busca atual (limpando todos os destaques) e cancela todas as solicitações de busca em andamento.

Parâmetros

  • ação

    "clear"
     | "keep"
     | "activate"
     opcional

    Determina o que fazer com a correspondência ativa após o término da sessão de busca. clear vai limpar o destaque sobre a correspondência ativa. keep vai manter a correspondência ativa destacada. activate vai manter a correspondência ativa destacada e simular um clique do usuário nela. A ação padrão é keep.

terminate()

chrome.webviewTag.terminate()

Encerra forçosamente o processo do renderizador da página da Web para visitantes. Isso pode afetar várias tags webview no app atual se elas compartilharem o mesmo processo, mas não afetará as tags webview em outros apps.

Eventos

close

chrome.webviewTag.close.addListener(
  callback: function,
)

É acionado quando a janela de convidado tenta se fechar.

O exemplo de código abaixo navega da webview para a about:blank quando o convidado tenta fechar.

webview.addEventListener('close', function() {
  webview.src = 'about:blank';
});

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    () => void

consolemessage

chrome.webviewTag.consolemessage.addListener(
  callback: function,
)

É acionado quando a janela de convidado registra uma mensagem do console.

O exemplo de código a seguir encaminha todas as mensagens de registro para o console do incorporador, sem considerar o nível de registro ou outras propriedades.

webview.addEventListener('consolemessage', function(e) {
  console.log('Guest page logged a message: ', e.message);
});

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (level: number, message: string, line: number, sourceId: string) => void

    • level

      number

    • mensagem

      string

    • linha

      number

    • sourceId

      string

contentload

chrome.webviewTag.contentload.addListener(
  callback: function,
)

É acionado quando a janela de convidado aciona um evento load, ou seja, quando um novo documento é carregado. Isso não inclui a navegação de páginas no documento atual ou carregamentos de recursos assíncronos.

O exemplo de código a seguir modifica o tamanho da fonte padrão do elemento body do visitante depois que a página é carregada:

webview.addEventListener('contentload', function() {
  webview.executeScript({ code: 'document.body.style.fontSize = "42px"' });
});

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    () => void

dialog

chrome.webviewTag.dialog.addListener(
  callback: function,
)

É acionado quando a janela de visitante tenta abrir uma caixa de diálogo modal usando window.alert, window.confirm ou window.prompt.

O processamento desse evento bloqueia o processo do visitante até que cada listener de evento seja retornado ou o objeto dialog se torne inacessível (se preventDefault() for chamado).

O comportamento padrão é cancelar a caixa de diálogo.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (messageType: "alert" 
      | "confirm" 
      | "prompt" 
     , messageText: string, dialog: DialogController) => void

    • messageType

      "alert"
       | "confirm"
       | "prompt"

    • messageText

      string

    • caixa de diálogo

      DialogController

exit

chrome.webviewTag.exit.addListener(
  callback: function,
)

É acionado quando o processo de renderização do conteúdo da Web do visitante é encerrado.

O exemplo de código a seguir mostra uma mensagem de despedida sempre que a página de visitante falha:

webview.addEventListener('exit', function(e) {
  if (e.reason === 'crash') {
    webview.src = 'data:text/plain,Goodbye, world!';
  }
});

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (processID: number, reason: "normal" 
      | "abnormal" 
      | "crash" 
      | "kill" 
     ) => void

    • processID

      number

    • reason

      "normal"
       | "abnormal"
       | "crash"
       | "kill"

findupdate

chrome.webviewTag.findupdate.addListener(
  callback: function,
)

É disparado quando novos resultados de busca estão disponíveis para uma solicitação de busca ativa. Isso pode acontecer várias vezes para uma única solicitação de busca à medida que as correspondências são encontradas.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (searchText: string, numberOfMatches: number, activeMatchOrdinal: number, selectionRect: SelectionRect, canceled: boolean, finalUpdate: string) => void

    • searchText

      string

    • numberOfMatches

      number

    • activeMatchOrdinal

      number

    • selectionRect

      SelectionRect

    • cancelada

      booleano

    • finalUpdate

      string

loadabort

chrome.webviewTag.loadabort.addListener(
  callback: function,
)

Acionado quando uma carga de nível superior é abortada sem confirmação. Uma mensagem de erro será mostrada no console, a menos que o evento seja impedido por padrão.

Observação:quando um carregamento de recurso é interrompido, um evento loadabort é seguido por um evento loadstop, mesmo que todos os carregamentos confirmados desde o último evento loadstop (se houver) tenham sido interrompidos.

Observação:quando o carregamento de um URL "about" ou JavaScript é interrompido, o loadabort é acionado e o webview é direcionado para "about:blank".

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (url: string, isTopLevel: boolean, code: number, reason: "ERR_ABORTED" 
      | "ERR_INVALID_URL" 
      | "ERR_DISALLOWED_URL_SCHEME" 
      | "ERR_BLOCKED_BY_CLIENT" 
      | "ERR_ADDRESS_UNREACHABLE" 
      | "ERR_EMPTY_RESPONSE" 
      | "ERR_FILE_NOT_FOUND" 
      | "ERR_UNKNOWN_URL_SCHEME" 
     ) => void

    • url

      string

    • isTopLevel

      booleano

    • código

      number

    • reason

      "ERR_ABORTED"
       | "ERR_INVALID_URL"
       | "ERR_DISALLOWED_URL_SCHEME"
       | "ERR_BLOCKED_BY_CLIENT"
       | "ERR_ADDRESS_UNREACHABLE"
       | "ERR_EMPTY_RESPONSE"
       | "ERR_FILE_NOT_FOUND"
       | "ERR_UNKNOWN_URL_SCHEME"

loadcommit

chrome.webviewTag.loadcommit.addListener(
  callback: function,
)

Acionado quando uma carga é confirmada. Isso inclui a navegação no documento atual e as cargas no nível do documento do subframe, mas não inclui cargas de recursos assíncronas.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (url: string, isTopLevel: boolean) => void

    • url

      string

    • isTopLevel

      booleano

loadredirect

chrome.webviewTag.loadredirect.addListener(
  callback: function,
)

É acionado quando uma solicitação de carregamento de nível superior é redirecionada para um URL diferente.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (oldUrl: string, newUrl: string, isTopLevel: boolean) => void

    • oldUrl

      string

    • newUrl

      string

    • isTopLevel

      booleano

loadstart

chrome.webviewTag.loadstart.addListener(
  callback: function,
)

Disparado quando uma carga começa.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (url: string, isTopLevel: boolean) => void

    • url

      string

    • isTopLevel

      booleano

loadstop

chrome.webviewTag.loadstop.addListener(
  callback: function,
)

É acionado quando todos os carregamentos no nível do frame em uma página de visitante (incluindo todos os subframes) são concluídos. Isso inclui a navegação no documento atual e as cargas no nível do documento do subframe, mas não inclui cargas de recursos assíncronas. Esse evento é acionado sempre que o número de transições de carregamentos no nível do documento passa de um (ou mais) para zero. Por exemplo, se uma página já tiver terminado de carregar (ou seja, loadstop já acionado uma vez) cria um novo iframe que carrega uma página. Em seguida, um segundo loadstop é acionado quando o carregamento da página do iframe é concluído. Esse padrão é comum em páginas que carregam anúncios.

Observação:quando uma carga confirmada é abortada, um evento loadstop é gerado após um evento loadabort, mesmo que todas as cargas confirmadas desde o último evento loadstop (se houver) tenham sido abortadas.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    () => void

newwindow

chrome.webviewTag.newwindow.addListener(
  callback: function,
)

Acionado quando a página de visitante tenta abrir uma nova janela do navegador.

O exemplo de código abaixo vai criar e navegar por uma nova webview no embedder para cada nova janela solicitada:

webview.addEventListener('newwindow', function(e) {
  var newWebview = document.createElement('webview');
  document.body.appendChild(newWebview);
  e.window.attach(newWebview);
});

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (window: NewWindow, targetUrl: string, initialWidth: number, initialHeight: number, name: string, windowOpenDisposition: "ignore" 
      | "save_to_disk" 
      | "current_tab" 
      | "new_background_tab" 
      | "new_foreground_tab" 
      | "new_window" 
      | "new_popup" 
     ) => void

    • janela

      NewWindow

    • targetUrl

      string

    • initialWidth

      number

    • initialHeight

      number

    • nome

      string

    • windowOpenDisposition

      "ignore"
       | "save_to_disk"
       | "current_tab"
       | "new_background_tab"
       | "new_foreground_tab"
       | "new_window"
       | "new_popup"

permissionrequest

chrome.webviewTag.permissionrequest.addListener(
  callback: function,
)

É acionado quando a página de visitante precisa solicitar uma permissão especial ao incorporador.

O exemplo de código a seguir concede à página de visitante acesso à API webkitGetUserMedia. Um app que usa esse código de exemplo precisa especificar as permissões de manifesto audioCapture e/ou videoCapture:

webview.addEventListener('permissionrequest', function(e) {
  if (e.permission === 'media') {
    e.request.allow();
  }
});

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (permission: "media" 
      | "geolocation" 
      | "pointerLock" 
      | "download" 
      | "loadplugin" 
      | "filesystem" 
      | "fullscreen" 
      | "hid" 
     , request: object) => void

    • permissão

      "media"
       | "geolocation"
       | "pointerLock"
       | "download"
       | "loadplugin"
       | "filesystem"
       | "fullscreen"
       | "hid"

    • solicitação

      objeto

responsive

chrome.webviewTag.responsive.addListener(
  callback: function,
)

É acionado quando o processo de renderização do conteúdo da Web do visitante volta a responder depois de parar de responder.

O exemplo de código abaixo vai mostrar ou ocultar o elemento webview conforme ele se torna responsivo ou não:

webview.style.webkitTransition = 'opacity 250ms';
webview.addEventListener('unresponsive', function() {
  webview.style.opacity = '0.5';
});
webview.addEventListener('responsive', function() {
  webview.style.opacity = '1';
});

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (processID: number) => void

    • processID

      number

sizechanged

chrome.webviewTag.sizechanged.addListener(
  callback: function,
)

É acionado quando o conteúdo da Web incorporado é redimensionado por autosize. Só é acionado se autosize estiver ativado.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (oldWidth: number, oldHeight: number, newWidth: number, newHeight: number) => void

    • oldWidth

      number

    • oldHeight

      number

    • newWidth

      number

    • newHeight

      number

unresponsive

chrome.webviewTag.unresponsive.addListener(
  callback: function,
)

É acionado quando o processo de renderização do conteúdo da Web convidado para de responder. Esse evento será gerado uma vez com um evento responsivo correspondente se o convidado começar a responder novamente.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (processID: number) => void

    • processID

      number

zoomchange

chrome.webviewTag.zoomchange.addListener(
  callback: function,
)

É acionado quando o zoom da página muda.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (oldZoomFactor: number, newZoomFactor: number) => void

    • oldZoomFactor

      number

    • newZoomFactor

      number