chrome.webviewTag

Descrição

Use a tag webview para carregar ativamente conteúdo ao vivo da Web pela rede e incorporá-lo ao seu app do Chrome. Seu app pode controlar a aparência do 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 acontecem 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 optional

    Limpa os dados acumulados nessa data ou depois dela, representados em milissegundos desde o período (acessíveis pelo método getTime do objeto JavaScript Date). Se estiver ausente, o padrão será 0, 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 ou mais recente

    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 do 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 WebSQL de sites.

ContentScriptDetails

Chrome 44 ou mais recente

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

Propriedades

  • all_frames

    booleano opcional

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

  • css

    InjectionItems opcional

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

  • exclude_globs

    string[] opcional

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

  • exclude_matches

    string[] opcional

    Exclui páginas em que o 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 em 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 em páginas quando o URL herdado for correspondido por um dos padrões declarados no campo "matches". O URL de herança é o URL do documento que criou o frame ou a janela. Não é possível inserir scripts de conteúdo em frames isolados.

  • correspondências

    string[]

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

  • nome

    string

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

  • run_at

    RunAt opcional

    O momento mais próximo em que o JavaScript ou CSS será injetado na guia. O padrão é "document_idle".

ContentWindow

Gerenciador de mensagens para uma janela de convidado.

Propriedades

  • postMessage

    void

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

    O convidado poderá enviar respostas ao incorporador postando uma mensagem para event.source no evento de mensagem que receber.

    Essa API é idêntica à API HTML5 postMessage 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 é assim: 

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

    • mensagem

      qualquer

      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 ou mais recente

Propriedades

  • checked

    booleano opcional

    O estado inicial de uma caixa de seleção ou um item de opção: verdadeiro para selecionado e falso para não selecionado. Só é possível selecionar um item por vez em um determinado grupo de opções.

  • contexts

    [ContextType, ...ContextType[]] opcional

    Lista de contextos em que este item de menu vai aparecer. O padrão é ['page'] se não 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 aos frames. Para detalhes sobre o formato de um padrão, consulte Padrões de correspondência.

  • ativado

    booleano opcional

    Se este 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. Isso faz com que o item seja filho de um item adicionado anteriormente.

  • targetUrlPatterns

    string[] opcional

    Semelhante a "documentUrlPatterns", mas permite filtrar com base no atributo src das tags img/audio/video e no href das tags de âncora.

  • título

    string opcional

    O texto a ser exibido no item. Isso é obrigatório, a menos que type seja "separator". Quando o contexto é "selection", você pode 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".

  • type

    ItemType opcional

    O tipo de item de menu. O padrão é "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 é assim: 

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

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

ContextMenus

Chrome 44 ou mais recente

Propriedades

  • onShow

    Event<functionvoidvoid>

    Disparado 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 é assim: 

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

    • callback

      função

      O parâmetro callback tem esta aparência: 

      (event: object) => void

      • evento

        objeto

        • preventDefault

          void

          Chame isso para evitar mostrar o menu de contexto.

          A função preventDefault é assim: 

          () => {...}

  • create

    void

    Cria um novo item de menu de contexto. Se ocorrer um erro durante a criação, talvez você só descubra quando o callback de criação for acionado. Os detalhes vão estar em runtime.lastError.

    A função create é assim: 

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

    • createProperties

      objeto

      As propriedades usadas para criar o item

    • callback

      função opcional

      O parâmetro callback tem esta aparência: 

      () => 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 é assim: 

    (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 esta aparência: 

      () => void

  • removeAll

    void

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

    A função removeAll é assim: 

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

    • callback

      função opcional

      O parâmetro callback tem esta aparência: 

      () => void

  • update

    void

    Atualiza um item de menu de contexto criado anteriormente.

    A função update é assim: 

    (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 esta aparência: 

      () => void

ContextMenuUpdateProperties

Chrome 44 ou mais recente

Propriedades

  • checked

    booleano opcional

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

  • contexts

    [ContextType, ...ContextType[]] opcional

    Lista de contextos em que este 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 aos frames. Para detalhes sobre o formato de um padrão, consulte Padrões de correspondência.

  • ativado

    booleano opcional

    Se este item do menu de contexto está ativado ou desativado.

  • parentId

    string | número opcional

    O ID de um item de menu principal. Isso faz com que o item seja 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 das tags img/audio/video e no href das 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 é assim: 

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

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

ContextType

Chrome 44 ou mais recente

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 a 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 é assim: 

    () => {...}

  • 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 é assim: 

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

    • resposta

      string opcional

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

DialogMessageType

Pendente

O tipo de caixa de diálogo modal solicitada pelo visitante.

Enumeração

"alert"

"confirm"

"prompt"

DownloadPermissionRequest

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

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 é assim: 

    () => {...}

  • deny

    void

    Negue o pedido de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é assim: 

    () => {...}

ExitReason

Pendente

String que indica o motivo da saída.

Enumeração

"normal"

"abnormal"

"falhou"

"killed"

"oom killed"

"oom"

"não foi possível iniciar"

"falha de integridade"

FileSystemPermissionRequest

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

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 é assim: 

    () => {...}

  • deny

    void

    Negue o pedido de permissão.

    A função deny é assim: 

    () => {...}

FindCallbackResults

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

Propriedades

  • activeMatchOrdinal

    número

    O número ordinal da partida atual.

  • cancelada

    booleano

    Indica se esta solicitação de localização foi cancelada.

  • numberOfMatches

    número

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

  • selectionRect

    SelectionRect

    Descreve um retângulo ao redor da correspondência ativa em coordenadas de tela.

FindOptions

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

Propriedades

  • backward (para trás)

    booleano opcional

    Flag para encontrar correspondências em ordem inversa. O valor padrão é false.

  • matchCase

    booleano opcional

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

FullscreenPermissionRequest

Chrome 43 ou mais recente

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

Propriedades

  • origem

    string

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

  • allow

    void

    Permita a solicitação de permissão.

    A função allow é assim: 

    () => {...}

  • deny

    void

    Negue o pedido de permissão.

    A função deny é assim: 

    () => {...}

GeolocationPermissionRequest

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

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 é assim: 

    () => {...}

  • deny

    void

    Negue o pedido de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é assim: 

    () => {...}

HidPermissionRequest

Chrome 125 ou mais recente

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

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 é assim: 

    () => {...}

  • deny

    void

    Negue o pedido de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é assim: 

    () => {...}

InjectDetails

Detalhes do script ou CSS a ser injetado. É necessário definir o código ou a propriedade do arquivo, mas não ambos 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 abrir seu app para ataques de scripting entre sites.

  • arquivo

    string opcional

    Arquivo JavaScript ou CSS a ser injetado.

InjectionItems

Chrome 44 ou mais recente

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

LoadAbortReason

Pendente

String que indica o tipo de interrupção que ocorreu. Não há garantia de que essa string não vai manter a compatibilidade com versões anteriores entre os lançamentos. Não analise nem aja com base no conteúdo dele. Também é possível que, em alguns casos, um erro não listado aqui seja informado.

Enumeração

"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"

LoadPluginPermissionRequest

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

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 é assim: 

    () => {...}

  • deny

    void

    Negue o pedido de permissão.

    A função deny é assim: 

    () => {...}

MediaPermissionRequest

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

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 é assim: 

    () => {...}

  • deny

    void

    Negue o pedido de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é assim: 

    () => {...}

NewWindow

Interface anexada a eventos DOM newwindow.

Propriedades

  • anexar

    void

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

    A função attach é assim: 

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

    • webview

      objeto

      O elemento webview a que a página de destino deve ser anexada.

  • descartar

    void

    Cancele a solicitação de nova janela.

    A função discard é assim: 

    () => {...}

PermissionType

Pendente

O tipo de permissão que está sendo solicitada.

Enumeração

"media"

"geolocation"

"pointerLock"

"download"

"loadplugin"

"filesystem"

"fullscreen"

"hid"

PointerLockPermissionRequest

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

Propriedades

  • lastUnlockedBySelf

    booleano

    Se o frame solicitante era o cliente mais recente a manter o bloqueio 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 é assim: 

    () => {...}

  • deny

    void

    Negue o pedido de permissão. Esse é o comportamento padrão se allow não for chamado.

    A função deny é assim: 

    () => {...}

SelectionRect

Descreve um retângulo em coordenadas de 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

    número

    Altura do retângulo.

  • esquerda

    número

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

  • superior

    número

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

  • largura

    número

    Largura do retângulo.

StopFindingAction

Pendente

Determina o que fazer com a partida ativa após o término da sessão de busca. clear vai limpar o destaque da 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.

Enumeração

"clear"

"keep"

"ativar"

WebRequestEventInterface

Chrome 44 ou mais recente

Interface que fornece acesso a eventos webRequest na página do convidado. Consulte a API de extensões chrome.webRequest para detalhes sobre o ciclo de vida do webRequest e conceitos relacionados. Observação: o evento chrome.webRequest.onActionIgnored não é compatível com visualizações da Web.

Para ilustrar como o uso difere da API webRequest de extensões, considere o exemplo de código a seguir, 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 mais detalhes sobre a API.

As condições e ações para webRequests de webview declarativas precisam ser instanciadas das contrapartes chrome.webViewRequest.*. O exemplo de código a seguir 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]);

WindowOpenDisposition

Pendente

A disposição solicitada da nova janela.

Enumeração

"ignore"

"save_to_disk"

"current_tab"

"new_background_tab"

"new_foreground_tab"

"new_window"

"new_popup"

ZoomMode

Chrome 43 ou mais recente

Define como o zoom é processado no webview.

Enumeração

As mudanças de zoom por origem
serão mantidas na origem da página com zoom. Ou seja, todas as outras webviews na mesma partição que forem navegadas até essa mesma origem também terão zoom. Além disso, as mudanças de zoom per-originsão salvas com a origem. Isso significa que, ao navegar para outras páginas na mesma origem, todas serão ampliadas com o mesmo fator de zoom.

"por visualização"
As mudanças de zoom só entram em vigor nesta WebView, e as mudanças de zoom em outras WebViews não afetam o zoom desta WebView. Além disso, as mudanças de zoom per-view são redefinidas na navegação. Navegar em uma WebView sempre carrega páginas com os fatores de zoom por origem (no escopo da partição).

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

Propriedades

contentWindow

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

Tipo

ContentWindow

contextMenus

Chrome 44 ou mais recente

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 de webview. Você pode escolher a quais tipos de objetos suas adições ao menu de contexto se aplicam, como imagens, hiperlinks e páginas.

Tipo

ContextMenus

request

Interface que fornece acesso a eventos webRequest na página do convidado.

Tipo

WebRequestEventInterface

Métodos

addContentScripts()

Chrome 44 ou mais recente 
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
): void

Adiciona regras de injeção de script de conteúdo ao webview. Quando o webview navega até uma página que corresponde a uma ou mais regras, os scripts associados são injetados. É possível adicionar regras ou atualizar as atuais de forma programática.

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';

Você pode adiar a chamada addContentScripts até precisar 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 navegado até a origem (por exemplo, foo.com) e chamar webview.addContentScripts para adicionar "myRule", aguarde a próxima navegação para injetar os scripts. Se você quiser injeção imediata, executeScript vai fazer a coisa certa.

As regras são preservadas mesmo que o processo convidado falhe ou seja encerrado ou mesmo que o webview seja reassociado.

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

Parâmetros

back()

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

Navega para trás uma entrada do histórico, se possível. É equivalente a go(-1).

Parâmetros

  • callback

    função opcional

    Chrome 44 ou mais recente

    O parâmetro callback tem esta aparência: 

    (success: boolean) => void

    • sucesso

      booleano

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

canGoBack()

chrome.webviewTag.canGoBack(): boolean

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(): boolean

Indica se é possível navegar para frente 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,
): void

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

Parâmetros

  • opções

    ImageDetails opcional

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (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,
): void

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 esta aparência: 

    () => void

executeScript()

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

Injeta código JavaScript na página do visitante.

O exemplo de código a seguir usa a injeção de script para definir a cor de fundo da página de convidado 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 esta aparência: 

    (result?: any[]) => void

    • resultado

      any[] opcional

      O resultado do script em cada frame injetado.

find()

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

Inicia uma solicitação de localizar 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 pesquisa.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (results?: FindCallbackResults) => void

    • resultados

      FindCallbackResults opcional

      Contém todos os resultados da solicitação de localização. 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,
): void

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

Parâmetros

  • callback

    função opcional

    Chrome 44 ou mais recente

    O parâmetro callback tem esta aparência: 

    (success: boolean) => void

    • sucesso

      booleano

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

getAudioState()

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

Consulta o estado do áudio.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (audible: boolean) => void

    • Audible

      booleano

getProcessId()

chrome.webviewTag.getProcessId(): number

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

Retorna

  • número

getUserAgent()

chrome.webviewTag.getUserAgent(): string

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

Retorna

  • string

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
): void

Recebe o fator de zoom atual.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (zoomFactor: number) => void

    • zoomFactor

      número

      O fator de zoom atual.

getZoomMode()

Chrome 43 ou mais recente 
chrome.webviewTag.getZoomMode(
  callback: function,
): void

Recebe o modo de zoom atual.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      ZoomMode

      O modo de zoom atual do webview.

go()

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

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

Parâmetros

  • relativeIndex

    número

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

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (success: boolean) => void

    • sucesso

      booleano

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

insertCSS()

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

Injeta CSS na página de convidado.

Parâmetros

  • detalhes

    InjectDetails

    Detalhes do CSS a ser inserido.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

isAudioMuted()

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

Consulta se o áudio está desativado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (muted: boolean) => void

    • silenciado

      booleano

isSpatialNavigationEnabled()

Chrome 71 ou mais recente 
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
): void

Consulta se a navegação espacial está ativada para a WebView.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (enabled: boolean) => void

    • ativado

      booleano

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden(): void

Indica se a string de user agent do webview foi substituída por webviewTag.setUserAgentOverride.

loadDataWithBaseUrl()

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

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

Parâmetros

  • dataUrl

    string

    O URL dos dados a serem carregados.

  • 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(): void

Mostra o conteúdo do webview. Isso é equivalente a chamar a função de impressão programada do próprio webview.

reload()

chrome.webviewTag.reload(): void

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

removeContentScripts()

Chrome 44 ou mais recente 
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
): void

Remove scripts de conteúdo de um webview.

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

webview.removeContentScripts(['myRule']);

Para remover todas as regras, chame:

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,
): void

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

Parâmetros

  • desativar som

    booleano

    Valor de áudio desativado

setSpatialNavigationEnabled()

Chrome 71 ou mais recente 
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
): void

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,
): void

Substitui a string do user agent usada pelo webview para solicitações de páginas de convidados. A substituição fará com que os valores do cabeçalho de dica do cliente User-Agent e os valores retornados por navigator.userAgentData fiquem vazios para solicitações de página de visitante a que essa substituição é aplicada.

Parâmetros

  • userAgent

    string

    A string de user agent a ser usada.

setZoom()

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

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 WebView (consulte webviewTag.ZoomMode).

Parâmetros

  • zoomFactor

    número

    O novo fator de zoom.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

setZoomMode()

Chrome 43 ou mais recente 
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
): void

Define o modo de zoom do webview.

Parâmetros

  • ZoomMode

    ZoomMode

    Define como o zoom é processado no webview.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

stop()

chrome.webviewTag.stop(): void

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

stopFinding()

chrome.webviewTag.stopFinding(
  action?: StopFindingAction,
): void

Encerra a sessão de pesquisa atual (limpando todo o destaque) e cancela todas as solicitações de pesquisa em andamento.

Parâmetros

  • ação

    StopFindingAction opcional

    Determina o que fazer com a partida ativa após o término da sessão de busca. clear vai limpar o destaque da 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(): void

Força o encerramento do 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 vai afetar tags webview em outros apps.

Eventos

close

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

Disparado quando a janela do convidado tenta se fechar.

O código de exemplo a seguir navega do webview para o about:blank quando o convidado tenta se fechar.

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    () => void

consolemessage

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

Disparado 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 esta aparência: 

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

    • level

      número

    • mensagem

      string

    • linha

      número

    • sourceId

      string

contentload

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

Disparado quando a janela convidada dispara um evento load, ou seja, quando um novo documento é carregado. Isso não inclui a navegação de página no documento atual ou carregamentos assíncronos de recursos.

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 esta aparência: 

    () => void

dialog

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

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

O processamento desse evento vai bloquear o processo convidado até que cada listener de evento retorne ou o objeto dialog fique inacessível (se preventDefault() tiver sido chamado).

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

Parâmetros

exit

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

Disparado quando o processo que renderiza o conteúdo da Web do visitante é encerrado.

O exemplo de código a seguir mostra uma mensagem de despedida sempre que a página do convidado 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 esta aparência: 

    (details: object) => void

    • detalhes

      objeto

      • processID

        número

        ID interno do Chrome do processo que foi encerrado.

      • reason

        ExitReason

        String que indica o motivo da saída.

findupdate

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

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

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

    • searchText

      string

    • numberOfMatches

      número

    • activeMatchOrdinal

      número

    • selectionRect

      SelectionRect

    • cancelada

      booleano

    • finalUpdate

      string

loadabort

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

Acionado quando um carregamento de nível superior é cancelado sem confirmação. Uma mensagem de erro será impressa no console, a menos que o evento seja evitado por padrão.

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

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (url: string, isTopLevel: boolean, code: number, reason: LoadAbortReason) => void

loadcommit

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

Disparado quando um carregamento é concluído. Isso inclui a navegação no documento atual e os carregamentos no nível do documento do subframe, mas não inclui carregamentos assíncronos de recursos.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

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

    • url

      string

    • isTopLevel

      booleano

loadredirect

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

Disparado 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 esta aparência: 

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

    • oldUrl

      string

    • newUrl

      string

    • isTopLevel

      booleano

loadstart

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

Disparado quando um carregamento é iniciado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (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 convidada (incluindo todos os subframes) são concluídos. Isso inclui a navegação no documento atual e os carregamentos no nível do documento do subframe, mas não inclui carregamentos assíncronos de recursos. Esse evento é disparado sempre que o número de carregamentos no nível do documento passa de um (ou mais) para zero. Por exemplo, se uma página que já terminou de carregar (ou seja, loadstop já foi disparado uma vez) cria um novo iframe que carrega uma página. Em seguida, um segundo loadstop será disparado quando o carregamento da página do iframe for concluído. Esse padrão é comumente observado em páginas que carregam anúncios.

Observação:quando um commit de carga é cancelado, um evento loadstop acaba seguindo um evento loadabort, mesmo que todos os commits de carga desde o último evento loadstop (se houver) tenham sido cancelados.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    () => void

newwindow

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

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

O exemplo de código a seguir vai criar e navegar em um novo webview no incorporador 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 esta aparência: 

    (window: NewWindow, targetUrl: string, initialWidth: number, initialHeight: number, name: string, windowOpenDisposition: WindowOpenDisposition) => void

permissionrequest

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

Disparado quando a página convidada precisa solicitar permissão especial do incorporador.

O exemplo de código a seguir concede à página de convidado acesso à API webkitGetUserMedia. Um app que usa este exemplo de código 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 esta aparência: 

    (permission: PermissionType, request: object) => void

responsive

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

Disparado quando o processo que renderiza o conteúdo da Web do convidado volta a responder depois de ficar sem resposta.

O exemplo de código a seguir vai aumentar ou diminuir a opacidade do elemento webview conforme ele se torna responsivo ou não responsivo:

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 esta aparência: 

    (processID: number) => void

    • processID

      número

sizechanged

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

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

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

    • oldWidth

      número

    • oldHeight

      número

    • newWidth

      número

    • newHeight

      número

unresponsive

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

Disparado 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 esta aparência: 

    (processID: number) => void

    • processID

      número

zoomchange

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

Disparado quando o zoom da página muda.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

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

    • oldZoomFactor

      número

    • newZoomFactor

      número