Descrição
Use a tag webview
para carregar ativamente conteúdo ao vivo da Web pela rede e incorporá-lo ao app do Chrome. O app pode controlar a aparência da webview
e interagir com o conteúdo da Web, iniciar navegações em uma página da Web incorporada, reagir a eventos de erro que acontecem nela e muito mais. Consulte Uso.
Permissões
webview
Tipos
ClearDataOptions
Opções que determinam quais dados precisam ser apagados por clearData
.
Propriedades
-
desde
número opcional
Limpa os dados acumulados nessa data ou depois, representados em milissegundos desde o período (acessível pelo método getTime do objeto JavaScript
Date
). Se ausente, o padrão será0
(que removeria todos os dados de navegação).
ClearDataTypeSet
Um conjunto de tipos de dados. As propriedades ausentes são interpretadas como false
.
Propriedades
-
cache de app
booleano opcional
Caches de apps dos sites.
-
cache
booleano opcional
Chrome 44 ou mais recenteDesde o Chrome 43. O cache do navegador. Observação: ao remover dados, isso limpa todo o cache. Isso não se limita ao intervalo que você especificar.
-
cookies
booleano opcional
Os cookies da partição.
-
fileSystems
booleano opcional
Sistemas de arquivos dos sites.
-
indexedDB
booleano opcional
Dados do IndexedDB de sites.
-
localStorage
booleano opcional
Dados de armazenamento local de sites.
-
persistentCookies
booleano opcional
Chrome 58 ou mais recenteOs cookies persistentes da partição.
-
sessionCookies
booleano opcional
Chrome 58 ou mais recenteCookies de sessão da partição.
-
webSQL
booleano opcional
Dados do WebSQL de sites.
ContentScriptDetails
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
fortrue
, significa que o JavaScript ou o CSS precisa ser injetado em todos os frames da página atual. Por padrão,all_frames
éfalse
, e o JavaScript ou CSS só é injetado no frame superior. -
css
InjectionItems opcional
O código CSS ou uma lista de arquivos CSS a serem injetados nas páginas correspondentes. Eles são injetados na ordem em que aparecem, antes que qualquer DOM seja construído ou exibido para a página.
-
exclude_globs
string[] opcional
Aplicado após 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.
-
include_globs
string[] opcional
Aplicado após correspondências para incluir apenas os URLs que também correspondem a este glob. Destina-se a emular a palavra-chave @include Greasemonkey.
-
js
InjectionItems opcional
O código JavaScript ou uma lista de arquivos JavaScript a serem injetados nas páginas correspondentes. Eles são injetados na ordem em que aparecem.
-
match_about_blank
booleano opcional
Define se o script de conteúdo deve ser inserido em about:blank e about:srcdoc. Os scripts de conteúdo só serão injetados nas 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. Os scripts de conteúdo não podem ser inseridos em frames em sandbox.
-
correspondências
string[]
Especifica em quais páginas este script de conteúdo será injetado.
-
nome
string
Nome do script de conteúdo a ser injetado.
-
run_at
RunAt opcional
Assim que o JavaScript ou CSS será injetado na guia. O padrão é "document_idle".
ContentWindow
Manipulador de mensagens para uma janela de visitante.
Propriedades
-
postMessage
void
Publica uma mensagem no conteúdo incorporado da Web desde que ele mostre uma página da origem de destino. Esse método fica disponível assim que o carregamento da página é concluído. Detecte o evento
contentload
e, em seguida, chame o método.O convidado poderá enviar respostas ao incorporador postando uma mensagem para
event.source
no evento de mensagem que ele 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
tem esta aparência:(message: any, targetOrigin: string) => {...}
-
mensagem
qualquer um
Objeto de mensagem a ser enviado ao convidado.
-
targetOrigin
string
Especifica qual origem da janela de convidado precisa ser para o evento ser enviado.
-
ContextMenuCreateProperties
Propriedades
-
marcado
booleano opcional
O estado inicial de uma caixa de seleção ou um item de opção: "true" para selecionados e "false" para 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 será exibido. Se nada for especificado, o padrão será [page'].
-
documentUrlPatterns
string[] opcional
Permite que você restrinja o item para que ele seja aplicado somente a documentos com URL que corresponda a um dos padrões fornecidos. Isso também se aplica a frames. Para mais detalhes sobre o formato de um padrão, consulte Padrões de correspondência.
-
ativado
booleano opcional
Indica se o item de menu de contexto está ativado ou desativado. O valor padrão é
true
. -
id
string opcional
O ID exclusivo a ser atribuído a esse item. Obrigatório para páginas de eventos. Não pode ser igual a outro código desta extensão.
-
parentId
string | number opcional
O ID de um item de menu pai; o item o torna 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 nohref
das tags âncora. -
title
string opcional
O texto a ser exibido no item. É obrigatório, a menos que
type
seja "separador". Quando o contexto é "seleção", é possível usar%s
na string para mostrar o texto selecionado. Por exemplo, se o valor desse parâmetro for "Traduzir '%s' para o Pig Latin" e o usuário selecionar a palavra "frio", o item do menu de contexto da seleção será "Traduzir 'legal' para o latino do Pig". -
Tipo
ItemType opcional
O tipo de item de menu. Se nada for especificado, o padrão será "normal".
-
onclick
void optional
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
Informações sobre o item clicado e o contexto em que o clique aconteceu.
-
ContextMenus
Propriedades
-
onShow
Evento<functionvoid>
Disparado antes de mostrar um menu de contexto neste
webview
. Pode ser usado para desativar esse menu de contexto chamandoevent.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
-
event
objeto
-
preventDefault
void
Chame esse parâmetro 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 optional
O parâmetro
callback
tem esta aparência:() => void
-
retorna
string | número
ID do item recém-criado.
-
-
remove
void
Remove um item de menu de contexto.
A função
remove
tem esta aparência:(menuItemId: string | number, callback?: function) => {...}
-
string | número
O ID do item do menu de contexto a ser removido.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
-
-
removeAll
void
Remove todos os itens de menu de contexto adicionados a esta
webview
.A função
removeAll
tem esta aparência:(callback?: function) => {...}
-
callback
função optional
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
Propriedades a serem atualizadas. Aceita os mesmos valores que a função create.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
-
ContextMenuUpdateProperties
Propriedades
-
marcado
booleano opcional
O estado de uma caixa de seleção ou um item de opção: "true" para selecionados e "false" para 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 será exibido.
-
documentUrlPatterns
string[] opcional
Permite que você restrinja o item para que ele seja aplicado somente a documentos com URL que corresponda a um dos padrões fornecidos. Isso também se aplica a frames. Para mais detalhes sobre o formato de um padrão, consulte Padrões de correspondência.
-
ativado
booleano opcional
Indica se o item de menu de contexto está ativado ou desativado.
-
parentId
string | number opcional
O ID de um item de menu pai; o item o torna 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 nohref
das tags âncora. -
title
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 de volta quando o item de menu for clicado.
A função
onclick
tem esta aparência:(info: OnClickData) => {...}
-
informações
Informações sobre o item clicado e o contexto em que o clique aconteceu.
-
ContextType
Os diferentes contextos em que um menu pode aparecer. Especificar "all" é equivalente à combinação de todos os outros contextos.
Tipo enumerado
"frame"
"link"
DialogController
Interface anexada a eventos do DOM dialog
.
Propriedades
-
cancelar
void
Rejeite a caixa de diálogo. Equivalente a clicar em "Cancel" em uma caixa de diálogo
confirm
ouprompt
.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
ouprompt
.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
Permita a solicitação de permissão.
A função
allow
tem esta aparência:() => {...}
-
deny
void
Negue a solicitação de permissão. Esse é o comportamento padrão quando
allow
não é 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
Permita 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
boolean
Indica se essa solicitação de localização foi cancelada.
-
numberOfMatches
number
Número de vezes que houve correspondência com
searchText
na página. -
selectionRect
Descreve um retângulo em torno 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
Sinalize para diferenciar maiúsculas de minúsculas. O valor padrão é
false
.
FullscreenPermissionRequest
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
Permita 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
Permita a solicitação de permissão.
A função
allow
tem esta aparência:() => {...}
-
deny
void
Negue a solicitação de permissão. Esse é o comportamento padrão quando
allow
não é chamado.A função
deny
tem esta aparência:() => {...}
HidPermissionRequest
O tipo de objeto request
que acompanha um evento hid
permissionrequest
DOM.
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
tem esta aparência:() => {...}
-
deny
void
Negue a solicitação de permissão. Esse é o comportamento padrão quando
allow
não é chamado.A função
deny
tem esta aparência:() => {...}
InjectDetails
Detalhes do script ou CSS a ser injetado. O código ou a propriedade do arquivo precisam ser definidos, mas não podem ser definidos ao mesmo tempo.
Propriedades
-
código
string opcional
Código CSS ou JavaScript a ser injetado.
Aviso:tenha cuidado ao usar o parâmetro
code
. O uso incorreto delas pode deixar seu app suscetível a ataques de scripting em vários locais. -
arquivo
string opcional
Arquivo JavaScript ou CSS a ser injetado.
InjectionItems
O tipo de item de injeção: código ou um conjunto de arquivos.
Propriedades
-
código
string opcional
código JavaScript ou CSS a ser injetado nas páginas correspondentes.
-
arquivos
string[] opcional
A lista de arquivos JavaScript ou CSS a serem injetados nas páginas correspondentes. Eles são injetados na ordem em que aparecem nesta matriz.
LoadPluginPermissionRequest
O tipo de objeto request
que acompanha um evento DOM loadplugin
permissionrequest
.
Propriedades
-
identificador
string
A string do 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 quando
deny
não é 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
Permita a solicitação de permissão.
A função
allow
tem esta aparência:() => {...}
-
deny
void
Negue a solicitação de permissão. Esse é o comportamento padrão quando
allow
não é chamado.A função
deny
tem esta aparência:() => {...}
NewWindow
Interface anexada a eventos do DOM newwindow
.
Propriedades
-
anexar
void
Anexe 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 precisa ser anexada.
-
-
descartar
void
Cancelar 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
boolean
Se o frame solicitante foi o cliente mais recente a manter o bloqueio do ponteiro.
-
url
string
O URL do frame que solicita o bloqueio do ponteiro.
-
userGesture
boolean
Se o bloqueio do ponteiro foi solicitado ou não como resultado de um gesto de entrada do usuário.
-
allow
void
Permita a solicitação de permissão.
A função
allow
tem esta aparência:() => {...}
-
deny
void
Negue a solicitação de permissão. Esse é o comportamento padrão quando
allow
não é 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 à de uma matriz. Ou seja, a coordenada (left, top)
é considerada contida pelo retângulo, mas a coordenada (left + width, top)
não.
Propriedades
-
height
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 à borda superior do retângulo.
-
width
number
Largura do retângulo.
WebRequestEventInterface
Interface que fornece acesso a eventos webRequest na página de 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 webRequest por meio de eventos onRequest
e onMessage
. Consulte declarativeWebRequest
para mais detalhes sobre a API.
As condições e ações para webRequests declarativas de WebView precisam ser instanciadas a partir de suas contrapartes chrome.webViewRequest.*
. O código de exemplo abaixo bloqueia todas as solicitações para "example.com"
na WebView myWebview
de maneira declarativa:
var rule = {
conditions: [
new chrome.webViewRequest.RequestMatcher({ url: { hostSuffix: 'example.com' } })
],
actions: [ new chrome.webViewRequest.CancelRequest() ]
};
myWebview.request.onRequest.addRules([rule]);
ZoomMode
Define como o zoom é processado no webview
.
Tipo enumerado
"per-origin"
As mudanças 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 vão ser ampliadas. Além disso, as mudanças de zoom de per-origin
são salvas com a origem, o que significa que, ao navegar para outras páginas na mesma origem, todas vão ter o zoom aplicado ao mesmo fator de zoom.
"por visualização"
As mudanças de zoom só têm efeito nessa visualização da Web, e as alterações em outras visualizações não afetam o zoom dessa visualização. Além disso, as mudanças de zoom de per-view
são redefinidas na navegação. A navegação em uma visualização da Web sempre carrega páginas com os fatores de zoom por origem (dentro do escopo da partição).
"desativado"
Desativa todo o zoom na visualização da Web. 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.
Tipo
contextMenus
Semelhante à API ContextMenus do Chrome, mas se aplica ao webview
em vez do navegador. Use a API webview.contextMenus
para adicionar itens ao menu de contexto da webview
. Escolha a que tipos de objetos as adições do menu de contexto se aplicam, como imagens, hiperlinks e páginas.
Tipo
request
Interface que fornece acesso a eventos webRequest na página de visitante.
Métodos
addContentScripts()
chrome.webviewTag.addContentScripts(
contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)
Adiciona regras de injeção de script de conteúdo ao webview
. Quando o webview
navega para uma página correspondente a uma ou mais regras, os scripts associados são injetados. É possível 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';
Você pode adiar a chamada de addContentScripts até que precise injetar scripts.
O exemplo a seguir mostra como substituir uma regra atual.
webview.addContentScripts([{
name: 'rule',
matches: ['http://www.foo.com/*'],
js: { files: ['scriptA.js'] },
run_at: 'document_start'}]);
// Do something.
webview.src = 'http://www.foo.com/*';
...
// Overwrite 'rule' defined before.
webview.addContentScripts([{
name: 'rule',
matches: ['http://www.bar.com/*'],
js: { files: ['scriptB.js'] },
run_at: 'document_end'}]);
Se webview
tiver sido redirecionado 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 os scripts injetados. Se você quiser uma injeção imediata, o executeScript
fará a escolha certa.
As regras são preservadas mesmo se o processo do convidado falhar, for encerrado ou mesmo se o webview
for definido de novo.
Consulte a documentação sobre scripts de conteúdo para mais detalhes.
Parâmetros
-
contentScriptList
Detalhes dos scripts de conteúdo a serem adicionados.
back()
chrome.webviewTag.back(
callback?: function,
)
Volta uma entrada do histórico, se possível. É equivalente a go(-1)
.
Parâmetros
-
callback
função optional
Chrome 44 ou mais recenteO parâmetro
callback
tem esta aparência:(success: boolean) => void
-
sucesso
boolean
Indica se a navegação foi bem-sucedida.
-
canGoBack()
chrome.webviewTag.canGoBack()
Indica se é possível voltar no histórico. O estado dessa função é armazenado em cache e atualizado antes de cada loadcommit
. Portanto, o melhor lugar para chamá-la é em loadcommit
.
Retorna
-
boolean
canGoForward()
chrome.webviewTag.canGoForward()
Indica se é possível avançar no histórico. O estado dessa função é armazenado em cache e atualizado antes de cada loadcommit
. Portanto, o melhor lugar para chamá-la é em loadcommit
.
Retorna
-
boolean
captureVisibleRegion()
chrome.webviewTag.captureVisibleRegion(
options?: ImageDetails,
callback: function,
)
Captura a região visível do WebView.
Parâmetros
-
do modelo.
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,
)
Limpa os dados de navegação da partição webview
.
Parâmetros
-
do modelo.
Opções que determinam quais dados serão apagados.
-
Tipos
Os tipos de dados a serem apagados.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
executeScript()
chrome.webviewTag.executeScript(
details: InjectDetails,
callback?: function,
)
Injeta o 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 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 optional
O parâmetro
callback
tem esta aparência:(result?: any[]) => void
-
resultado
qualquer[] opcional
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.
-
do modelo.
FindOptions opcional
Opções para a solicitação de localização.
-
callback
função optional
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
poderá ser omitido se não for utilizado no corpo da função de callback. Por exemplo, se o callback for usado apenas para discernir quando a solicitação de localização foi concluída.
-
forward()
chrome.webviewTag.forward(
callback?: function,
)
Avança uma entrada do histórico, se possível. É equivalente a go(1)
.
Parâmetros
-
callback
função optional
Chrome 44 ou mais recenteO parâmetro
callback
tem esta aparência:(success: boolean) => void
-
sucesso
boolean
Indica se a navegação foi bem-sucedida.
-
getAudioState()
chrome.webviewTag.getAudioState(
callback: function,
)
Consulta o estado do áudio.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(audible: boolean) => void
-
Audible
boolean
-
getProcessId()
chrome.webviewTag.getProcessId()
Retorna o ID de processo interno do Chrome referente ao processo atual da página da Web de visitante. Isso permite que os incorporados saibam quantos convidados seriam afetados se o processo fosse encerrado. Dois convidados vão compartilhar um processo somente se pertencerem ao mesmo app e tiverem o mesmo ID da partição de armazenamento. A chamada é síncrona e retorna a noção em cache do incorporador do ID do processo atual. O ID de processo não é igual ao ID de processo do sistema operacional.
Retorna
-
number
getUserAgent()
chrome.webviewTag.getUserAgent()
Retorna a string do user agent usada por webview
para solicitações de página de visitante.
Retorna
-
string
getZoom()
chrome.webviewTag.getZoom(
callback: function,
)
Recebe o fator de zoom atual.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(zoomFactor: number) => void
-
zoomFactor
number
O fator de zoom atual.
-
getZoomMode()
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 de histórico relativo à navegação atual. Se a navegação solicitada for impossível, esse método não terá efeito.
Parâmetros
-
relativeIndex
number
Índice do histórico relativo para onde o
webview
precisa ser navegado. Por exemplo, um valor2
avançará duas entradas do histórico, se possível, e um valor-3
navegará para trás 3 entradas. -
callback
função optional
O parâmetro
callback
tem esta aparência:(success: boolean) => void
-
sucesso
boolean
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 optional
O parâmetro
callback
tem esta aparência:() => void
isAudioMuted()
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
boolean
-
isSpatialNavigationEnabled()
chrome.webviewTag.isSpatialNavigationEnabled(
callback: function,
)
Consulta se a navegação espacial está ativada para o WebView.
Parâmetros
-
função
O parâmetro
callback
tem esta aparência:(enabled: boolean) => void
-
boolean
-
isUserAgentOverridden()
chrome.webviewTag.isUserAgentOverridden()
Indica se a string do user agent de webview
foi substituída por webviewTag.setUserAgentOverride
.
loadDataWithBaseUrl()
chrome.webviewTag.loadDataWithBaseUrl(
dataUrl: string,
baseUrl: string,
virtualUrl?: string,
)
Carrega um URL de dados com um URL de base especificado usado para links relativos. Opcionalmente, um URL virtual pode ser fornecido para ser mostrado ao usuário em vez do URL de dados.
Parâmetros
-
dataUrl
string
URL de dados a ser carregado.
-
baseUrl
string
O URL base que será usado para links relativos.
-
virtualUrl
string opcional
O URL que será exibido para o usuário (na barra de endereço).
print()
chrome.webviewTag.print()
Mostra o conteúdo de webview
. Isso é equivalente a chamar a função de impressão com script no próprio webview
.
reload()
chrome.webviewTag.reload()
Recarrega a página de nível superior atual.
removeContentScripts()
chrome.webviewTag.removeContentScripts(
scriptNameList?: string[],
)
Remove scripts de conteúdo de um webview
.
O exemplo a seguir remove "myRule", que foi adicionada anteriormente.
webview.removeContentScripts(['myRule']);
É possível remover todas as regras chamando:
webview.removeContentScripts();
Parâmetros
-
scriptNameList
string[] opcional
Uma lista dos 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.webviewTag.setAudioMuted(
mute: boolean,
)
Define o estado de mudo do áudio do WebView.
Parâmetros
-
desativar som
boolean
Valor do recurso de desativar som
setSpatialNavigationEnabled()
chrome.webviewTag.setSpatialNavigationEnabled(
enabled: boolean,
)
Define o estado da navegação espacial do WebView.
Parâmetros
-
boolean
Valor do estado de navegação espacial.
setUserAgentOverride()
chrome.webviewTag.setUserAgentOverride(
userAgent: string,
)
Modifique a string do user agent usada pelo webview
para solicitações de páginas de convidados. A substituição vai fazer com que os valores do cabeçalho da dica do cliente do user agent e os valores retornados por navigator.userAgentData
fiquem vazios para as solicitações da página de visitante em que essa substituição é aplicada.
Parâmetros
-
userAgent
string
String do user agent a ser usada.
setZoom()
chrome.webviewTag.setZoom(
zoomFactor: number,
callback?: function,
)
Muda o fator de zoom da página. O escopo e a persistência dessa mudança são determinados pelo modo de zoom atual da visualização da Web (consulte webviewTag.ZoomMode
).
Parâmetros
-
zoomFactor
number
O novo fator de zoom.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
setZoomMode()
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 optional
O parâmetro
callback
tem esta aparência:() => void
stop()
chrome.webviewTag.stop()
Interrompe o carregamento da navegação atual do webview
se 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
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 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()
Exclui à força o processo do renderizador da página da web do convidado. Isso poderá 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 visitante tenta se fechar.
O código de exemplo abaixo navega da 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 incorporado sem levar em consideração 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
-
line
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 via window.alert
, window.confirm
ou window.prompt
.
O processamento desse evento bloqueará o processo de 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
"alert"
| "confirmar"
| "comando"
-
messageText
string
-
caixa de diálogo
-
exit
chrome.webviewTag.exit.addListener(
callback: function,
)
Disparado quando o processo que renderiza o conteúdo da Web de convidado é 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"
| "anormal"
| "falha"
| "kill"
-
findupdate
chrome.webviewTag.findupdate.addListener(
callback: function,
)
Disparado quando novos resultados de busca estão disponíveis para uma solicitação de localização 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
number
-
activeMatchOrdinal
number
-
selectionRect
-
cancelada
boolean
-
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 "about" ou de um JavaScript é cancelado, loadabort
é acionado e 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
boolean
-
código
number
-
reason
"ERR_ABORTED"
| "ERR_INVALID_URL"
| "ERR_DISALLOWED_URL_SCHEME"
| "ERR_BLOCKED_BY_CLIENT"
| "ERR_ADDRESS_UNREACHABLE"
| "ERR_EMPTYERR_RESPOSTA"
"
-
loadcommit
chrome.webviewTag.loadcommit.addListener(
callback: function,
)
Disparado quando uma carga é confirmada. Isso inclui a navegação no documento atual e carregamentos de subframes no nível do documento, mas não inclui os 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
boolean
-
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
boolean
-
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
boolean
-
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 e carregamentos de subframes no nível do documento, mas não inclui os carregamentos de recursos assíncronos. Este 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á concluiu o carregamento (ou seja, loadstop
já disparado uma vez) cria um novo iframe que carrega uma página, e um segundo loadstop
é disparado quando o carregamento da página do iframe é concluído. Esse padrão costuma ser observado em páginas que carregam anúncios.
Observação:quando um carregamento confirmado é cancelado, um evento loadstop
acaba depois de 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 por uma nova 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
-
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
. Observe que um app que usa esse código de exemplo precisa especificar as permissões de manifesto audioCapture
e/ou videoCapture
:
webview.addEventListener('permissionrequest', function(e) {
if (e.permission === 'media') {
e.request.allow();
}
});
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(permission: "media"
| "geolocation"
| "pointerLock"
| "download"
| "loadplugin"
| "filesystem"
| "fullscreen"
| "hid"
, request: object) => void-
permissão
"media"
| "Geolocation"
| "pointerLock"
| "download"
| "loadplugin"
| "filesystem"
| "fullscreen"
| "hid"
-
request
objeto
-
responsive
chrome.webviewTag.responsive.addListener(
callback: function,
)
Disparado quando o processo que renderiza o conteúdo da Web de convidado volta a responder após não responder.
O código de exemplo a seguir esmaece o elemento webview
conforme ele se torna responsivo ou não responde:
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 por autosize
. Só é disparado se a autosize
estiver ativada.
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 que renderiza o conteúdo da Web de convidado não responde. 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
-