chrome.webviewTag

Descrição

Use a tag webview para carregar ativamente conteúdo ativo 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 ocorrem nele e muito mais. Consulte Uso.

Permissões

webview

Tipos

ClearDataOptions

Opções que determinam quais dados serão apagados pelo clearData.

Propriedades

  • desde que

    número opcional

    Limpa os dados acumulados a partir dessa data, representados em milissegundos desde a época (acessível pelo método getTime do objeto JavaScript Date). Se ausente, o padrão é 0 (o que remove todos os dados de navegação).

ClearDataTypeSet

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

Propriedades

  • cache de app

    booleano opcional

    Sites caches de aplicativos.

  • cache

    booleano opcional

    Chrome 44 ou superior

    Desde o Chrome 43. O cache do navegador. Observação: ao remover dados, todo o cache será limpo. ele não se limita ao intervalo que você especifica.

  • cookies

    booleano opcional

    Os cookies da partição.

  • fileSystems

    booleano opcional

    Sites nos sistemas de arquivos.

  • indexedDB

    booleano opcional

    Sites Dados do IndexedDB.

  • localStorage

    booleano opcional

    Sites dados de armazenamento local.

  • persistentCookies

    booleano opcional

    Chrome 58 ou superior

    Os cookies persistentes da partição.

  • sessionCookies

    booleano opcional

    Chrome 58 ou superior

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

  • webSQL

    booleano opcional

    Sites dados do WebSQL.

ContentScriptDetails

Chrome 44 ou superior

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

  • 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 de qualquer DOM ser construído ou exibido para a página.

  • exclude_globs

    string[] opcional

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

  • exclude_matches

    string[] opcional

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

  • include_globs

    string[] opcional

    Aplicado após as correspondências para incluir apenas os URLs que também correspondem a este glob. que serve para emular a palavra-chave @include 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 corresponder a um dos padrões declarados no campo de correspondências. O URL herdado é o URL do documento que criou o frame ou a janela. Não é possível inserir scripts de conteúdo em frames no modo 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

    Assim que o JavaScript ou CSS for injetado na guia o mais rápido possível. O padrão é "document_idle".

ContentWindow

Identificador de mensagens para uma janela de visitante.

Propriedades

  • postMessage

    void

    Posta uma mensagem no conteúdo da Web incorporado, desde que esse conteúdo mostre uma página da origem de destino. Esse método estará disponível após a conclusão do carregamento da página. Detecte o evento contentload e chame o método.

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

    Essa API é idêntica à API HTML5 postMessage (link em inglês) 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 tem esta aparência:

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

    • mensagem

      qualquer um

      Objeto de mensagem a ser enviado ao convidado.

    • targetOrigin

      string

      Especifica a origem da janela de convidados para que o evento seja despachado.

ContextMenuCreateProperties

Chrome 44 ou superior

Propriedades

  • marcado

    booleano opcional

    O estado inicial de uma caixa de seleção ou item de opção: "true" para os selecionados e "false" para os não selecionados. Somente um item de opção pode ser selecionado por vez em um determinado grupo de itens de opção.

  • contexts

    [ContextType, ...ContextType[]] opcional

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

  • documentUrlPatterns

    string[] opcional

    Permite que você restrinja o item para que seja aplicado apenas a documentos com um URL que corresponda a um dos padrões fornecidos. Isso também se aplica a frames. Para detalhes sobre o formato de um padrão, consulte Corresponder padrões.

  • ativado

    booleano opcional

    Indica se esse 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 desta extensão.

  • parentId

    string | número opcional

    O ID de um item de menu pai. isso torna o item um item 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 âncora.

  • título

    string opcional

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

  • tipo

    ItemType opcional

    Tipo de item de menu. O padrão é "normal" caso não seja especificado.

  • clique

    void opcional

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

    A função onclick tem esta aparência:

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

    • informações

      As informações sobre o item clicado e o contexto em que ele ocorreu.

ContextMenus

Chrome 44 ou superior

Propriedades

  • onShow

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

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

    • callback

      função

      O parâmetro callback tem esta aparência:

      (event: object) => void

      • evento

        objeto

        • preventDefault

          void

          Chame essa função para evitar a exibição do menu de contexto.

          A função preventDefault tem esta aparência:

          () => {...}

  • create

    void

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

    A função create tem esta aparência:

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

    • createProperties

      objeto

      Propriedades usadas para criar o item.

    • callback

      função opcional

      O parâmetro callback tem esta aparência:

      () => void

    • retorna

      string | número

      ID do item recém-criado.

  • remover

    void

    Remove um item de menu de contexto.

    A função remove tem esta aparência:

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

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

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

    • id

      string | número

      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 superior

Propriedades

  • marcado

    booleano opcional

    O estado de uma caixa de seleção ou item de opção: "true" para os selecionados e "false" para os não selecionados. Somente um item de opção pode ser selecionado por vez em um determinado grupo de itens de opção.

  • contexts

    [ContextType, ...ContextType[]] opcional

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

  • documentUrlPatterns

    string[] opcional

    Permite que você restrinja o item para que seja aplicado apenas a documentos com um URL que corresponda a um dos padrões fornecidos. Isso também se aplica a frames. Para detalhes sobre o formato de um padrão, consulte Corresponder padrões.

  • ativado

    booleano opcional

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

  • parentId

    string | número opcional

    O ID de um item de menu pai. isso torna o item um item filho de um item adicionado anteriormente. Observação:não é possível alterar um item para ser 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 âncora.

  • título

    string opcional

    O texto a ser exibido no item

  • tipo

    ItemType opcional

    Tipo de item de menu.

  • clique

    void opcional

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

    A função onclick tem esta aparência:

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

    • informações

      As informações sobre o item clicado e o contexto em que ele ocorreu.

ContextType

Chrome 44 ou superior

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

Enumeração

"todos"

"página"

"frame"

"seleção"

"link"

"editável"

"imagem"

"vídeo"

"áudio"

DialogController

Interface anexada a eventos DOM de dialog.

Propriedades

  • cancelar

    void

    Rejeitar a caixa de diálogo. É equivalente a clicar em "Cancelar" em uma caixa de diálogo confirm ou prompt.

    A função cancel tem esta aparência:

    () => {...}

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

    (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

    Conceda a solicitação de permissão.

    A função allow tem esta aparência:

    () => {...}

  • deny

    void

    negue a solicitação de permissão. Esse será o comportamento padrão se allow não for chamado.

    A função deny tem esta aparência:

    () => {...}

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

    Conceda a solicitação de permissão.

    A função allow tem esta aparência:

    () => {...}

  • deny

    void

    negue a solicitação de permissão.

    A função deny tem esta aparência:

    () => {...}

FindCallbackResults

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

Propriedades

  • activeMatchOrdinal

    number

    O número ordinal da correspondência atual.

  • cancelada

    booleano

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

  • numberOfMatches

    number

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

  • selectionRect

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

FindOptions

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

Propriedades

  • para trás

    booleano opcional

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

  • matchCase

    booleano opcional

    Sinalização que corresponde à diferenciação entre maiúsculas e minúsculas. O valor padrão é false.

FullscreenPermissionRequest

Chrome 43 ou superior

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 de tela cheia.

  • allow

    void

    Conceda a solicitação de permissão.

    A função allow tem esta aparência:

    () => {...}

  • deny

    void

    negue a solicitação de permissão.

    A função deny tem esta aparência:

    () => {...}

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

    Conceda a solicitação de permissão.

    A função allow tem esta aparência:

    () => {...}

  • deny

    void

    negue a solicitação de permissão. Esse será o comportamento padrão se allow não for chamado.

    A função deny tem esta aparência:

    () => {...}

HidPermissionRequest

Chrome 125 ou versões mais recentes

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

    Conceda a solicitação de permissão.

    A função allow tem esta aparência:

    () => {...}

  • deny

    void

    negue a solicitação de permissão. Esse será o comportamento padrão se allow não for chamado.

    A função deny tem esta aparência:

    () => {...}

InjectDetails

Detalhes do script ou CSS a ser injetado É necessário definir o código ou a propriedade do arquivo, mas não é possível definir 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 dela pode deixar o app vulnerável a ataques de scripting em vários locais.

  • arquivo

    string opcional

    JavaScript ou CSS a ser injetado.

InjectionItems

Chrome 44 ou superior

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 em páginas correspondentes. Eles são injetados na ordem em que aparecem nesta matriz.

LoadPluginPermissionRequest

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

Propriedades

  • identificador

    string

    String do identificador do plug-in.

  • nome

    string

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

  • allow

    void

    Conceda a solicitação de permissão. Esse será o comportamento padrão se deny não for chamado.

    A função allow tem esta aparência:

    () => {...}

  • deny

    void

    negue a solicitação de permissão.

    A função deny tem esta aparência:

    () => {...}

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

    Conceda a solicitação de permissão.

    A função allow tem esta aparência:

    () => {...}

  • deny

    void

    negue a solicitação de permissão. Esse será o comportamento padrão se allow não for chamado.

    A função deny tem esta aparência:

    () => {...}

NewWindow

Interface anexada a eventos DOM de newwindow.

Propriedades

  • anexar

    void

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

    A função attach tem esta aparência:

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

    • WebView

      objeto

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

  • descartar

    void

    Cancele a solicitação de nova janela.

    A função discard tem esta aparência:

    () => {...}

PointerLockPermissionRequest

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

Propriedades

  • lastUnlockedBySelf

    booleano

    Se o frame solicitante foi ou não o cliente mais recente a manter o bloqueio de ponteiro.

  • url

    string

    O URL do frame que solicita o bloqueio do ponteiro.

  • userGesture

    booleano

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

  • allow

    void

    Conceda a solicitação de permissão.

    A função allow tem esta aparência:

    () => {...}

  • deny

    void

    negue a solicitação de permissão. Esse será o comportamento padrão se allow não for chamado.

    A função deny tem esta aparência:

    () => {...}

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

    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 ou superior

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

Para ilustrar como o uso difere da API de extensões webRequest, considere o código de exemplo a seguir, que bloqueia todas as solicitações de convidado para URLs correspondentes 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 os eventos onRequest e onMessage. Consulte declarativeWebRequest para ver os detalhes da API.

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

ZoomMode

Chrome 43 ou superior

Define como o zoom é processado no webview.

Enumeração

"per-origin"
As alterações de zoom vão persistir na origem da página ampliada, ou seja, todas as outras WebViews na mesma partição que forem navegadas para a mesma origem também serão ampliadas. Além disso, as alterações de zoom do per-origin são salvas com a origem, o que significa que, ao navegar para outras páginas na mesma origem, todas elas serão ampliadas para o mesmo fator de zoom.

"por visualização"
As alterações de zoom só entram em vigor nessa visualização da Web, e as alterações de zoom em outras visualizações não afetam o zoom dela. Além disso, per-view alterações de zoom são redefinidas durante a navegação. navegar por um WebView sempre carregará páginas com os fatores de zoom por origem (dentro do escopo da partição).

"desativado"
Desativa todo o zoom na WebView. O conteúdo será revertido para o 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 visitante.

contextMenus

Chrome 44 ou superior

Semelhante à API ContextMenus do Chrome, mas se aplica ao webview, e não ao navegador. Use a API webview.contextMenus para adicionar itens ao menu de contexto do webview. Escolha a quais tipos de objetos as adições do menu de contexto se aplicam, como imagens, hiperlinks e páginas.

request

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

Métodos

addContentScripts()

Chrome 44 ou superior
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)

Adiciona regras de injeção de script de conteúdo ao webview. Quando o webview navegar para uma página que corresponda a uma ou mais regras, os scripts associados serão injetados. Você pode adicionar regras programaticamente ou atualizar as existentes.

O exemplo a seguir adiciona duas regras a 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 você precise injetar scripts.

O exemplo a seguir mostra como substituir uma regra existente.

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 o método webview for direcionado para a origem (por exemplo, foo.com) e chamar webview.addContentScripts para adicionar "myRule", você vai precisar aguardar a próxima navegação para fazer a injeção dos scripts. Se você quiser a injeção imediata, o executeScript vai fazer a coisa certa.

As regras são preservadas mesmo se o processo do convidado falhar ou for encerrado, ou mesmo se o webview assumir um novo elemento pai.

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

Parâmetros

back()

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

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

Parâmetros

  • callback

    função opcional

    Chrome 44 ou superior

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

Indica se é possível ou não voltar no histórico. O estado dessa função é armazenado em cache e atualizado antes de cada loadcommit. Assim, 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. Assim, o melhor lugar para chamá-la é em loadcommit.

Retorna

  • booleano

captureVisibleRegion()

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

Captura a região visível da WebView.

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

    Opções que determinam quais dados limpar.

  • Os tipos de dados a serem apagados.

  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    () => void

executeScript()

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

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

O exemplo de código a seguir 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

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

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

  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    (results?: FindCallbackResults) => void

    • resultados

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

forward()

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

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

Parâmetros

  • callback

    função opcional

    Chrome 44 ou superior

    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 superior
chrome.webviewTag.getAudioState(
  callback: function,
)

Consulta o estado de áudio.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

    (audible: boolean) => void

    • Audible

      booleano

getProcessId()

chrome.webviewTag.getProcessId()

Retorna o ID do processo interno do Chrome referente ao processo atual da página da Web de visitante, permitindo que os incorporadores saibam quantos convidados seriam afetados pelo encerramento do processo. Dois convidados só compartilharão 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 do ID do processo atual. O ID do processo não é igual ao ID do sistema operacional.

Retorna

  • number

getUserAgent()

chrome.webviewTag.getUserAgent()

Retorna a string do user agent usada pelo webview para solicitações da 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 esta aparência:

    (zoomFactor: number) => void

    • zoomFactor

      number

      O fator de zoom atual.

getZoomMode()

Chrome 43 ou superior
chrome.webviewTag.getZoomMode(
  callback: function,
)

Recebe o modo de zoom atual.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      O modo de zoom atual do webview.

go()

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

Navega para uma entrada do histórico usando um índice do 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 onde o webview precisa ser navegado. Por exemplo, o valor 2 faz com que duas entradas do histórico sejam encaminhadas, se possível. um valor de -3 vai navegar pelas três entradas anteriores.

  • 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,
)

Injeta CSS na página de visitante.

Parâmetros

  • detalhes

    Detalhes do CSS a ser inserido.

  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    () => void

isAudioMuted()

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

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 superior
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

    (enabled: boolean) => void

    • ativado

      booleano

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

Indica se a string do user agent do webview foi substituída ou não por webviewTag.setUserAgentOverride.

loadDataWithBaseUrl()

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

Carrega um URL de dados com um URL base especificado usado para links relativos. Opcionalmente, um URL virtual pode ser fornecido para exibição ao usuário no lugar 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 do webview. Isso equivale a chamar a função de exibição com script da própria webview.

reload()

chrome.webviewTag.reload()

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

removeContentScripts()

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

Remove scripts de conteúdo de um webview.

O exemplo a seguir remove "myRule" que já foi adicionada.

webview.removeContentScripts(['myRule']);

É possível remover todas as regras chamando:

webview.removeContentScripts();

Parâmetros

  • scriptNameList

    string[] opcional

    Uma lista de nomes dos 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 superior
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

Define o estado mudo do WebView.

Parâmetros

  • desativar som

    booleano

    Valor do som do áudio

setSpatialNavigationEnabled()

Chrome 71 ou superior
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 por webview nas solicitações da página de visitante. A substituição vai fazer com que os valores de cabeçalho de dica de cliente do user agent e retornados por navigator.userAgentData fiquem vazios nas solicitações de página de visitante a 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,
)

Altera 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

    number

    O novo fator de zoom.

  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    () => void

setZoomMode()

Chrome 43 ou superior
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

Define o modo de zoom da webview.

Parâmetros

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

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

stopFinding()

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

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

Parâmetros

  • ação

    "limpar"
     | "manter"
     | "ativar"
     opcional

    Determina o que fazer com a correspondência ativa após o término da sessão de localização. clear vai limpar o destaque sobre a correspondência ativa. keep vai manter a correspondência ativa em destaque; 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()

Força o processo de renderização da página da Web convidada. Isso pode afetar várias tags webview no app atual se elas compartilharem o mesmo processo, mas não vai afetar as tags webview em outros apps.

Eventos

close

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

Disparado quando a janela de convidado tenta se fechar.

O código de exemplo a seguir navega o webview para 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 visitante registra uma mensagem do console.

O código de exemplo 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

      number

    • mensagem

      string

    • linha

      number

    • sourceId

      string

contentload

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

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

O código de exemplo a seguir modifica o tamanho da fonte padrão do elemento body do convidado após o carregamento da página:

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 visitante tenta abrir uma caixa de diálogo modal usando window.alert, window.confirm ou window.prompt.

A manipulação desse evento bloqueia o processo do convidado até que cada listener de eventos retorne ou o objeto dialog se torne inacessível (se preventDefault() tiver sido chamado).

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

    • messageType

      "alerta"
       | "confirmar"
       | "prompt"

    • messageText

      string

    • caixa de diálogo

exit

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

Disparado quando o processo de renderização do conteúdo da Web para visitantes é encerrado.

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

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:

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

    • processID

      number

    • reason

      "normal"
       | "abnormal"
       | "falha"
       | "kill"

findupdate

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

Disparado quando novos resultados de pesquisa estão disponíveis para uma solicitação ativa. Isso pode acontecer várias vezes para uma única solicitação de localização à medida que 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

      number

    • activeMatchOrdinal

      number

    • selectionRect
    • cancelada

      booleano

    • finalUpdate

      string

loadabort

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

Disparado 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 impedido 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 "Sobre" ou de um JavaScript é cancelado, loadabort é acionado e, em seguida, webview é direcionado para "about:blank".

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

    (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"
       | &quot;ERR_INVALID_URL&quot;
       | &quot;ERR_DISALLOWED_URL_SCHEME&quot;
       | &quot;ERR_BLOCKED_BY_CLIENT&quot;
       | "ERR_ADDRESS_UNREACHABLE"
       | &quot;ERR_EMPTY_RESPONSE&quot;
       | &quot;ERR_FILE_NOT_FOUND&quot;
       | &quot;ERR_UNKNOWN_URL_SCHEME&quot;

loadcommit

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

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

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 redireciona 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 começa.

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

Disparado 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, bem como os carregamentos no nível do documento de subframes, mas não inclui carregamentos de recursos assíncronos. Este evento é disparado sempre que o número de carregamentos no nível do documento passar de um (ou mais) para zero. Por exemplo, se uma página que já terminou de carregar (ou seja, loadstop já disparado uma vez) cria um novo iframe que carrega uma página e, em seguida, um segundo loadstop é disparado quando o carregamento da página iframe é concluído. Esse padrão é comumente observado em páginas que carregam anúncios.

Observação:quando um carregamento confirmado é cancelado, um evento loadstop acaba seguindo um evento loadabort, mesmo que todos os carregamentos confirmados 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 de visitante tenta abrir uma nova janela do navegador.

O código de exemplo a seguir cria e navega 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: "ignore" 
     | "save_to_disk"
     | "current_tab"
     | "new_background_tab"
     | "new_foreground_tab"
     | "new_window"
     | "new_popup"
    ) => void

    • janela
    • targetUrl

      string

    • initialWidth

      number

    • initialHeight

      number

    • nome

      string

    • windowOpenDisposition

      "ignorar"
       | "save_to_disk"
       | "current_tab"
       | &quot;new_background_tab&quot;
       | "new_foreground_tab"
       | "new_window"
       | "new_popup"

permissionrequest

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

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

O código de exemplo a seguir concederá à página de visitante acesso à API webkitGetUserMedia. Um app que usa esse 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: "media" 
     | "geolocation"
     | "pointerLock"
     | "download"
     | "loadplugin"
     | "filesystem"
     | "fullscreen"
     | "hid"
    , request: object) => void

    • permissão

      "media"
       | "geolocalização"
       | "pointerLock"
       | "download"
       | "loadplugin"
       | "sistema de arquivos"
       | "tela cheia"
       | "oculto"

    • solicitação

      objeto

responsive

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

Disparado quando o processo de renderização do conteúdo da Web do convidado volta a responder após não responder.

O código de exemplo a seguir fará o elemento webview aparecer ou desaparecer gradualmente conforme ele se tornar responsivo ou não responder:

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

      number

sizechanged

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

Disparado quando o conteúdo da Web incorporado é redimensionado via autosize. Só disparar 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

      number

    • oldHeight

      number

    • newWidth

      number

    • newHeight

      number

unresponsive

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

Disparado quando o processo de renderização do conteúdo da Web do convidado deixa 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

      number

zoomchange

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

Disparado quando o zoom da página é alterado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

    • oldZoomFactor

      number

    • newZoomFactor

      number