Descrizione
Utilizza il tag webview
per caricare attivamente contenuti dal vivo dal web tramite la rete e incorporarli nella tua app Chrome. La tua app può controllare l'aspetto di webview
e interagire con i contenuti web, avviare navigazioni in una pagina web incorporata, reagire agli eventi di errore che si verificano al suo interno e altro ancora (vedi Utilizzo).
Autorizzazioni
webview
Tipi
ClearDataOptions
Opzioni che determinano quali dati devono essere cancellati da clearData
.
Proprietà
-
da
number facoltativo
Cancella i dati accumulati a partire da questa data, rappresentati in millisecondi dall'epoca (accessibili tramite il metodo getTime dell'oggetto
Date
JavaScript). Se non presente, il valore predefinito è0
(che rimuove tutti i dati di navigazione).
ClearDataTypeSet
Un insieme di tipi di dati. Le proprietà mancanti vengono interpretate come false
.
Proprietà
-
appcache
booleano facoltativo
Appcache dei siti web.
-
cache
booleano facoltativo
Chrome 44 e versioni successiveDa Chrome 43. La cache del browser. Nota: quando rimuovi i dati, viene cancellata l'intera cache; non è limitata all'intervallo specificato.
-
cookie
booleano facoltativo
I cookie della partizione.
-
fileSystems
booleano facoltativo
File system dei siti web.
-
indexedDB
booleano facoltativo
Dati IndexedDB dei siti web.
-
localStorage
booleano facoltativo
Dati di archiviazione locale dei siti web.
-
persistentCookies
booleano facoltativo
Chrome 58 e versioni successiveI cookie permanenti della partizione.
-
sessionCookies
booleano facoltativo
Chrome 58 e versioni successiveI cookie di sessione della partizione.
-
webSQL
booleano facoltativo
Dati WebSQL dei siti web.
ContentScriptDetails
Dettagli dello script di contenuti da inserire. Per ulteriori dettagli, consulta la documentazione relativa agli script dei contenuti.
Proprietà
-
all_frames
booleano facoltativo
Se
all_frames
ètrue
, significa che il codice JavaScript o CSS deve essere inserito in tutti i frame della pagina corrente. Per impostazione predefinita,all_frames
èfalse
e il codice JavaScript o CSS viene inserito solo nel frame superiore. -
css
InjectionItems facoltativo
Il codice CSS o un elenco di file CSS da iniettare nelle pagine corrispondenti. Vengono inseriti nell'ordine in cui vengono visualizzati, prima che venga creato o visualizzato il DOM per la pagina.
-
exclude_globs
stringa[] facoltativo
Viene applicato dopo le corrispondenze per escludere gli URL corrispondenti a questo pattern generico. Destinato a emulare la parola chiave @exclude di Greasemonkey.
-
exclude_matches
stringa[] facoltativo
Esclude le pagine in cui altrimenti verrebbe inserito questo script dei contenuti.
-
include_globs
stringa[] facoltativo
Viene applicato dopo le corrispondenze per includere solo gli URL che corrispondono anche a questo pattern generico. Destinato a emulare la parola chiave @include di Greasemonkey.
-
js
InjectionItems facoltativo
Il codice JavaScript o un elenco di file JavaScript da iniettare nelle pagine corrispondenti. Questi vengono inseriti nell'ordine in cui appaiono.
-
match_about_blank
booleano facoltativo
Indica se inserire lo script dei contenuti in about:blank e about:srcdoc. Gli script dei contenuti verranno iniettati nelle pagine solo quando il loro URL ereditato corrisponde a uno dei pattern dichiarati nel campo corrispondenze. L'URL di ereditarietà è l'URL del documento che ha creato il frame o la finestra. Gli script dei contenuti non possono essere inseriti in frame in sandbox.
-
corrisponde a
stringa[]
Specifica le pagine in cui verrà inserito questo script dei contenuti.
-
nome
stringa
Il nome dello script dei contenuti da iniettare.
-
run_at
RunAt facoltativo
Il momento più rapido in cui il codice JavaScript o CSS verrà inserito nella scheda. Il valore predefinito è "document_idle".
ContentWindow
Gestire i messaggi in una finestra ospite.
Proprietà
-
postMessage
nullo
Pubblica un messaggio nei contenuti web incorporati, a condizione che questi ultimi mostrino una pagina dell'origine di destinazione. Questo metodo è disponibile al termine del caricamento della pagina. Ascolta l'evento
contentload
e poi chiama il metodo.L'invitato potrà inviare risposte all'utente che ha eseguito l'embed pubblicando un messaggio per
event.source
nell'evento di messaggio che riceve.Questa API è identica all'API postMessage di HTML5 per la comunicazione tra pagine web. L'utente che ha eseguito l'embed può ascoltare le risposte aggiungendo un listener di eventi
message
al proprio frame.La funzione
postMessage
ha il seguente aspetto:(message: any, targetOrigin: string) => {...}
-
messaggio
qualsiasi
Oggetto del messaggio da inviare all'ospite.
-
targetOrigin
stringa
Specifica l'origine della finestra ospite per l'invio dell'evento.
-
ContextMenuCreateProperties
Proprietà
-
selezionato
booleano facoltativo
Lo stato iniziale di un elemento di casella di controllo o pulsante di opzione: true per selezionato e false per deselezionato. In un determinato gruppo di elementi di tipo radio è possibile selezionare un solo elemento alla volta.
-
contesti
[ContextType, ...ContextType[]] facoltativo
Elenco dei contesti in cui verrà visualizzata questa voce di menu. Se non specificato, il valore predefinito è ['page'].
-
documentUrlPatterns
stringa[] facoltativo
Ti consente di limitare l'applicazione dell'elemento solo ai documenti il cui URL corrisponde a uno dei pattern specificati. (Questo vale anche per i frame). Per informazioni dettagliate sul formato di un pattern, vedi Pattern di corrispondenza.
-
abilitata
booleano facoltativo
Indica se questa voce del menu contestuale è attivata o disattivata. Il valore predefinito è
true
. -
id
stringa facoltativa
L'ID univoco da assegnare a questo elemento. Obbligatorio per le pagine degli eventi. Non può essere uguale a un altro ID per questa estensione.
-
parentId
stringa | numero facoltativo
L'ID di un elemento di menu principale, che rende l'elemento un elemento secondario di un elemento aggiunto in precedenza.
-
targetUrlPatterns
stringa[] facoltativo
Simile a documentUrlPatterns, ma consente di filtrare in base all'attributo
src
dei tag img/audio/video e all'attributohref
dei tag anchor. -
titolo
stringa facoltativa
Il testo da visualizzare nell'elemento. Questo valore è obbligatorio, a meno che
type
non sia "separatore". Quando il contesto è "selection", puoi utilizzare%s
all'interno della stringa per mostrare il testo selezionato. Ad esempio, se il valore di questo parametro è "Traduci "%s" in dialetto rumeno" e l'utente seleziona la parola "cool", l'elemento del menu contestuale per la selezione è "Traduci "cool" in dialetto rumeno". -
tipo
ItemType facoltativo
Il tipo di voce di menu. Se non specificato, il valore predefinito è "normale".
-
onclick
void optional
Una funzione che verrà richiamata quando viene fatto clic sulla voce di menu.
La funzione
onclick
ha il seguente aspetto:(info: OnClickData) => {...}
-
informazioni
Informazioni sull'elemento su cui è stato fatto clic e sul contesto in cui si è verificato il clic.
-
ContextMenus
Proprietà
-
onShow
Event<functionvoidvoid>
Viene attivato prima di mostrare un menu contestuale su questo
webview
. Può essere utilizzato per disattivare questo menu contestuale chiamandoevent.preventDefault()
.La funzione
onShow.addListener
ha il seguente aspetto:(callback: function) => {...}
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(event: object) => void
-
evento
oggetto
-
preventDefault
nullo
Chiama questa funzione per impedire la visualizzazione del menu contestuale.
La funzione
preventDefault
ha il seguente aspetto:() => {...}
-
-
-
-
create
nullo
Crea un nuovo elemento del menu contestuale. Tieni presente che, se si verifica un errore durante la creazione, potresti non accorgertene finché non viene attivato il callback di creazione (i dettagli saranno in
runtime.lastError
).La funzione
create
ha il seguente aspetto:(createProperties: object, callback?: function) => {...}
-
createProperties
oggetto
Le proprietà utilizzate per creare l'elemento
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:() => void
-
returns
stringa | numero
L'ID dell'elemento appena creato.
-
-
rimuovi
nullo
Rimuove un elemento del menu contestuale.
La funzione
remove
ha il seguente aspetto:(menuItemId: string | number, callback?: function) => {...}
-
stringa | numero
L'ID dell'elemento del menu contestuale da rimuovere.
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:() => void
-
-
removeAll
nullo
Rimuove tutti gli elementi del menu contestuale aggiunti a questo
webview
.La funzione
removeAll
ha il seguente aspetto:(callback?: function) => {...}
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:() => void
-
-
update
nullo
Aggiorna un elemento del menu contestuale creato in precedenza.
La funzione
update
ha il seguente aspetto:(id: string | number, updateProperties: object, callback?: function) => {...}
-
id
stringa | numero
L'ID dell'elemento da aggiornare.
-
updateProperties
oggetto
Le proprietà da aggiornare. Accetta gli stessi valori della funzione create.
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:() => void
-
ContextMenuUpdateProperties
Proprietà
-
selezionato
booleano facoltativo
Lo stato di un elemento di casella di controllo o pulsante di opzione: true per selezionato e false per deselezionato. In un determinato gruppo di elementi di tipo radio è possibile selezionare un solo elemento alla volta.
-
contesti
[ContextType, ...ContextType[]] facoltativo
Elenco dei contesti in cui verrà visualizzata questa voce di menu.
-
documentUrlPatterns
stringa[] facoltativo
Ti consente di limitare l'applicazione dell'elemento solo ai documenti il cui URL corrisponde a uno dei pattern specificati. (Questo vale anche per i frame). Per informazioni dettagliate sul formato di un pattern, vedi Pattern di corrispondenza.
-
abilitata
booleano facoltativo
Indica se questa voce del menu contestuale è attivata o disattivata.
-
parentId
stringa | numero facoltativo
L'ID di un elemento di menu principale, che rende l'elemento un elemento secondario di un elemento aggiunto in precedenza. Nota:non puoi modificare un elemento in modo che sia un elemento secondario di uno dei suoi discendenti.
-
targetUrlPatterns
stringa[] facoltativo
Simile a documentUrlPatterns, ma consente di filtrare in base all'attributo
src
dei tag img/audio/video e all'attributohref
dei tag anchor. -
titolo
stringa facoltativa
Il testo da visualizzare nell'elemento
-
tipo
ItemType facoltativo
Il tipo di voce di menu.
-
onclick
void optional
Una funzione che verrà richiamata quando viene fatto clic sulla voce di menu.
La funzione
onclick
ha il seguente aspetto:(info: OnClickData) => {...}
-
informazioni
Informazioni sull'elemento su cui è stato fatto clic e sul contesto in cui si è verificato il clic.
-
ContextType
I diversi contesti in cui può essere visualizzato un menu. La specifica di "all" è equivalente alla combinazione di tutti gli altri contesti.
Enum
"all"
"page"
"frame"
"selection"
"link"
"editable"
"image"
"video"
"audio"
DialogController
Interfaccia collegata agli eventi DOM di dialog
.
Proprietà
-
annulla
nullo
Rifiutare la finestra di dialogo. È equivalente a fare clic su Annulla in una finestra di dialogo
confirm
oprompt
.La funzione
cancel
ha il seguente aspetto:() => {...}
-
ok
nullo
Accetta la finestra di dialogo. È equivalente a fare clic su OK in una finestra di dialogo
alert
,confirm
oprompt
.La funzione
ok
ha il seguente aspetto:(response?: string) => {...}
-
risposta
stringa facoltativa
La stringa di risposta da fornire all'ospite quando accetta una finestra di dialogo
prompt
.
-
DownloadPermissionRequest
Il tipo di oggetto request
che accompagna un evento DOM download
permissionrequest
.
Proprietà
-
requestMethod
stringa
Il tipo di richiesta HTTP (ad es.
GET
) associato alla richiesta di download. -
url
stringa
L'URL di download richiesto.
-
allow
nullo
Consenti la richiesta di autorizzazione.
La funzione
allow
ha il seguente aspetto:() => {...}
-
deny
nullo
Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato
allow
.La funzione
deny
ha il seguente aspetto:() => {...}
FileSystemPermissionRequest
Il tipo di oggetto request
che accompagna un evento DOM filesystem
permissionrequest
.
Proprietà
-
url
stringa
L'URL del frame che richiede l'accesso al file system locale.
-
allow
nullo
Consenti la richiesta di autorizzazione.
La funzione
allow
ha il seguente aspetto:() => {...}
-
deny
nullo
Rifiutare la richiesta di autorizzazione.
La funzione
deny
ha il seguente aspetto:() => {...}
FindCallbackResults
Contiene tutti i risultati della richiesta di ricerca.
Proprietà
-
activeMatchOrdinal
numero
Il numero ordinale della partita corrente.
-
annullati
booleano
Indica se questa richiesta di ricerca è stata annullata.
-
numberOfMatches
numero
Il numero di volte in cui
searchText
è stato trovato nella pagina. -
selectionRect
Descrive un rettangolo attorno alla corrispondenza attiva nelle coordinate dello schermo.
FindOptions
Opzioni per la richiesta di ricerca.
Proprietà
-
Indietro
booleano facoltativo
Seleziona per trovare le corrispondenze in ordine inverso. Il valore predefinito è
false
. -
matchCase
booleano facoltativo
Indicatore per la corrispondenza con sensibilità alle maiuscole. Il valore predefinito è
false
.
FullscreenPermissionRequest
Il tipo di oggetto request
che accompagna un evento DOM fullscreen
permissionrequest
.
Proprietà
-
origine
stringa
L'origine del frame all'interno di
webview
che ha avviato la richiesta a schermo intero. -
allow
nullo
Consenti la richiesta di autorizzazione.
La funzione
allow
ha il seguente aspetto:() => {...}
-
deny
nullo
Rifiutare la richiesta di autorizzazione.
La funzione
deny
ha il seguente aspetto:() => {...}
GeolocationPermissionRequest
Il tipo di oggetto request
che accompagna un evento DOM geolocation
permissionrequest
.
Proprietà
-
url
stringa
L'URL del frame che richiede l'accesso ai dati sulla geolocalizzazione.
-
allow
nullo
Consenti la richiesta di autorizzazione.
La funzione
allow
ha il seguente aspetto:() => {...}
-
deny
nullo
Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato
allow
.La funzione
deny
ha il seguente aspetto:() => {...}
HidPermissionRequest
Il tipo di oggetto request
che accompagna un evento DOM hid
permissionrequest
.
Proprietà
-
url
stringa
L'URL del frame che richiede l'accesso all'API HID.
-
allow
nullo
Consenti la richiesta di autorizzazione.
La funzione
allow
ha il seguente aspetto:() => {...}
-
deny
nullo
Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato
allow
.La funzione
deny
ha il seguente aspetto:() => {...}
InjectDetails
Dettagli dello script o del CSS da iniettare. È necessario impostare il codice o la proprietà file, ma non entrambi contemporaneamente.
Proprietà
-
codice
stringa facoltativa
Codice JavaScript o CSS da iniettare.
Avviso: fai attenzione quando utilizzi il parametro
code
. L'utilizzo errato potrebbe esporre la tua app ad attacchi di cross-site scripting. -
file
stringa facoltativa
File JavaScript o CSS da iniettare.
InjectionItems
Il tipo di elemento di iniezione: codice o un insieme di file.
Proprietà
-
codice
stringa facoltativa
Codice JavaScript o CSS da iniettare nelle pagine corrispondenti.
-
file
stringa[] facoltativo
L'elenco dei file JavaScript o CSS da iniettare nelle pagine corrispondenti. Questi vengono inseriti nell'ordine in cui appaiono in questo array.
LoadPluginPermissionRequest
Il tipo di oggetto request
che accompagna un evento DOM loadplugin
permissionrequest
.
Proprietà
-
identificatore
stringa
La stringa di identificatore del plug-in.
-
nome
stringa
Il nome visualizzato del plug-in.
-
allow
nullo
Consenti la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato
deny
.La funzione
allow
ha il seguente aspetto:() => {...}
-
deny
nullo
Rifiutare la richiesta di autorizzazione.
La funzione
deny
ha il seguente aspetto:() => {...}
MediaPermissionRequest
Il tipo di oggetto request
che accompagna un evento DOM media
permissionrequest
.
Proprietà
-
url
stringa
L'URL del frame che richiede l'accesso ai contenuti multimediali dell'utente.
-
allow
nullo
Consenti la richiesta di autorizzazione.
La funzione
allow
ha il seguente aspetto:() => {...}
-
deny
nullo
Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato
allow
.La funzione
deny
ha il seguente aspetto:() => {...}
NewWindow
Interfaccia collegata agli eventi DOM di newwindow
.
Proprietà
-
allegare
nullo
Collega la pagina di destinazione richiesta a un elemento
webview
esistente.La funzione
attach
ha il seguente aspetto:(webview: object) => {...}
-
webview
oggetto
L'elemento
webview
a cui deve essere collegata la pagina di destinazione.
-
-
Annulla
nullo
Annulla la richiesta della nuova finestra.
La funzione
discard
ha il seguente aspetto:() => {...}
PointerLockPermissionRequest
Il tipo di oggetto request
che accompagna un evento DOM pointerLock
permissionrequest
.
Proprietà
-
lastUnlockedBySelf
booleano
Indica se il frame richiedente è stato il client più recente ad avere il blocco del cursore.
-
url
stringa
L'URL del frame che richiede il blocco del cursore.
-
userGesture
booleano
Indica se il blocco del cursore è stato richiesto o meno a seguito di un gesto di input dell'utente.
-
allow
nullo
Consenti la richiesta di autorizzazione.
La funzione
allow
ha il seguente aspetto:() => {...}
-
deny
nullo
Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato
allow
.La funzione
deny
ha il seguente aspetto:() => {...}
SelectionRect
Descrive un rettangolo nelle coordinate dello schermo.
La semantica del contenimento è simile a quella di un array, ovvero la coordinata (left, top)
è considerata contenuta nel rettangolo, ma non la coordinata (left + width, top)
.
Proprietà
-
altezza
numero
Altezza del rettangolo.
-
a sinistra
numero
Distanza dal bordo sinistro dello schermo al bordo sinistro del rettangolo.
-
in alto
numero
Distanza dal bordo superiore dello schermo al bordo superiore del rettangolo.
-
larghezza
numero
Larghezza del rettangolo.
WebRequestEventInterface
Interfaccia che fornisce l'accesso agli eventi webRequest nella pagina ospite. Consulta l'API per le estensioni chrome.webRequest per informazioni dettagliate sul ciclo di vita di webRequest e sui concetti correlati. Nota: l'evento chrome.webRequest.onActionIgnored non è supportato per le webview.
Per illustrare la differenza di utilizzo rispetto all'API webRequest delle estensioni, considera il seguente codice di esempio che blocca tutte le richieste degli ospiti per gli URL corrispondenti a *://www.evil.com/*
:
webview.request.onBeforeRequest.addListener(
function(details) { return {cancel: true}; },
{urls: ["*://www.evil.com/*"]},
["blocking"]);
Inoltre, questa interfaccia supporta le regole webRequest dichiarative tramite gli eventi onRequest
e onMessage
. Per informazioni dettagliate sull'API, consulta declarativeWebRequest
.
Tieni presente che le condizioni e le azioni per le richieste web declarative webview devono essere create dalle relative controparti chrome.webViewRequest.*
. Il seguente codice di esempio blocca in modo dichiarativo tutte le richieste a "example.com"
nella webview myWebview
:
var rule = {
conditions: [
new chrome.webViewRequest.RequestMatcher({ url: { hostSuffix: 'example.com' } })
],
actions: [ new chrome.webViewRequest.CancelRequest() ]
};
myWebview.request.onRequest.addRules([rule]);
ZoomMode
Definisce il modo in cui lo zoom viene gestito nel webview
.
Enum
"Per origine"
Le modifiche allo zoom rimarranno nell'origine della pagina visualizzata ingrandita, ovvero tutte le altre visualizzazioni web nella stessa partizione che rimandano alla stessa origine verranno ingrandite. Inoltre, per-origin
le modifiche allo zoom vengono salvate con l'origine, il che significa che quando passi ad altre pagine nella stessa origine, tutte avranno lo stesso fattore di zoom.
"Per visualizzazione"
Le modifiche allo zoom vengono applicate solo in questa visualizzazione web e le modifiche allo zoom in altre visualizzazioni web non influiscono sullo zoom di questa visualizzazione web. Inoltre, per-view
le modifiche allo zoom vengono reimpostate durante la navigazione; la navigazione in una visualizzazione web caricherà sempre le pagine con i relativi fattori di zoom per origine (nell'ambito della partizione).
"disabled"
Disattiva tutto lo zoom nella visualizzazione web. I contenuti torneranno al livello di zoom predefinito e tutte le modifiche allo zoom tentate verranno ignorate.
Proprietà
contentWindow
Riferimento all'oggetto che può essere utilizzato per pubblicare messaggi nella pagina ospite.
Tipo
contextMenus
Simile all'API ContextMenus di Chrome, ma si applica a webview
anziché al browser. Utilizza l'API webview.contextMenus
per aggiungere elementi al menu contestuale di webview
. Puoi scegliere a quali tipi di oggetti applicare le aggiunte al menu contestuale, ad esempio immagini, link ipertestuali e pagine.
Tipo
request
Interfaccia che fornisce l'accesso agli eventi webRequest nella pagina ospite.
Metodi
addContentScripts()
chrome.webviewTag.addContentScripts(
contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)
Aggiunge regole di inserimento di script di contenuti a webview
. Quando webview
passa a una pagina corrispondente a una o più regole, gli script associati vengono iniettati. Puoi aggiungere regole o aggiornare quelle esistenti tramite programmazione.
L'esempio seguente aggiunge due regole 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';
Puoi posticipare la chiamata addContentScripts finché non devi iniettare gli script.
L'esempio seguente mostra come sovrascrivere una regola esistente.
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
è stato navigato all'origine (ad es. foo.com) e chiama webview.addContentScripts
per aggiungere "myRule", devi attendere la navigazione successiva per eseguire l'iniezione degli script. Se vuoi un'iniezione immediata, executeScript
farà la cosa giusta.
Le regole vengono conservate anche se il processo guest si arresta in modo anomalo o viene interrotto o anche se il webview
viene assegnato a un nuovo utente principale.
Per ulteriori dettagli, consulta la documentazione relativa agli script dei contenuti.
Parametri
-
contentScriptList
Dettagli degli script di contenuti da aggiungere.
back()
chrome.webviewTag.back(
callback?: function,
)
Se possibile, torna indietro di una voce della cronologia. Equivalente a go(-1)
.
Parametri
-
callback
function facoltativa
Chrome 44 e versioni successiveIl parametro
callback
ha il seguente aspetto:(success: boolean) => void
-
operazione riuscita
booleano
Indica se la navigazione è andata a buon fine.
-
canGoBack()
chrome.webviewTag.canGoBack()
Indica se è possibile o meno scorrere la cronologia all'indietro. Lo stato di questa funzione viene memorizzato nella cache e aggiornato prima di ogni loadcommit
, quindi il posto migliore per chiamarla è loadcommit
.
Resi
-
booleano
canGoForward()
chrome.webviewTag.canGoForward()
Indica se è possibile scorrere in avanti nella cronologia. Lo stato di questa funzione viene memorizzato nella cache e aggiornato prima di ogni loadcommit
, quindi il posto migliore per chiamarla è loadcommit
.
Resi
-
booleano
captureVisibleRegion()
chrome.webviewTag.captureVisibleRegion(
options?: ImageDetails,
callback: function,
)
Acquisisce la regione visibile della visualizzazione web.
Parametri
-
opzioni
ImageDetails facoltativo
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(dataUrl: string) => void
-
dataUrl
stringa
Un URL dati che codifica un'immagine dell'area visibile della scheda acquisita. Può essere assegnato alla proprietà "src" di un elemento immagine HTML per la visualizzazione.
-
clearData()
chrome.webviewTag.clearData(
options: ClearDataOptions,
types: ClearDataTypeSet,
callback?: function,
)
Cancella i dati di navigazione per la partizione webview
.
Parametri
-
opzioni
Opzioni che determinano quali dati cancellare.
-
tipi
I tipi di dati da cancellare.
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:() => void
executeScript()
chrome.webviewTag.executeScript(
details: InjectDetails,
callback?: function,
)
Inserisce codice JavaScript nella pagina ospite.
Il seguente codice di esempio utilizza l'iniezione di script per impostare il colore di sfondo della pagina ospite su rosso:
webview.executeScript({ code: "document.body.style.backgroundColor = 'red'" });
Parametri
-
dettagli
Dettagli dello script da eseguire.
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:(result?: any[]) => void
-
risultato
any[] facoltativo
Il risultato dello script in ogni frame inserito.
-
find()
chrome.webviewTag.find(
searchText: string,
options?: FindOptions,
callback?: function,
)
Avvia una richiesta di ricerca nella pagina.
Parametri
-
searchText
stringa
La stringa da trovare nella pagina.
-
opzioni
FindOptions facoltativo
Opzioni per la richiesta di ricerca.
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:(results?: FindCallbackResults) => void
-
risultati
FindCallbackResults facoltativo
Contiene tutti i risultati della richiesta di ricerca.
results
può essere omesso se non viene utilizzato nel corpo della funzione di callback, ad esempio se il callback viene utilizzato solo per capire quando è stata completata la richiesta di ricerca.
-
forward()
chrome.webviewTag.forward(
callback?: function,
)
Se possibile, passa alla voce successiva della cronologia. Equivalente a go(1)
.
Parametri
-
callback
function facoltativa
Chrome 44 e versioni successiveIl parametro
callback
ha il seguente aspetto:(success: boolean) => void
-
operazione riuscita
booleano
Indica se la navigazione è andata a buon fine.
-
getAudioState()
chrome.webviewTag.getAudioState(
callback: function,
)
Esegue query sullo stato dell'audio.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(audible: boolean) => void
-
audible
booleano
-
getProcessId()
chrome.webviewTag.getProcessId()
Restituisce l'ID processo interno di Chrome per il processo corrente della pagina web ospite, consentendo agli inserzionisti di sapere quanti ospiti verrebbero interessati dall'interruzione del processo. Due ospiti condivideranno un processo solo se appartengono alla stessa app e hanno lo stesso ID partizione dello spazio di archiviazione. La chiamata è sincrona e restituisce la nozione memorizzata nella cache dell'ID processo corrente dell'inserzionista. L'ID processo non è uguale all'ID processo del sistema operativo.
Resi
-
numero
getUserAgent()
chrome.webviewTag.getUserAgent()
Restituisce la stringa user agent utilizzata da webview
per le richieste di pagine guest.
Resi
-
stringa
getZoom()
chrome.webviewTag.getZoom(
callback: function,
)
Recupera il fattore di zoom attuale.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(zoomFactor: number) => void
-
zoomFactor
numero
Il fattore di zoom attuale.
-
getZoomMode()
chrome.webviewTag.getZoomMode(
callback: function,
)
Recupera la modalità di zoom corrente.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(ZoomMode: ZoomMode) => void
-
ZoomMode
La modalità di zoom corrente di
webview
.
-
go()
chrome.webviewTag.go(
relativeIndex: number,
callback?: function,
)
Consente di passare a una voce della cronologia utilizzando un indice della cronologia relativo alla navigazione corrente. Se la navigazione richiesta non è possibile, questo metodo non ha alcun effetto.
Parametri
-
relativeIndex
numero
Indice della cronologia relativa a cui deve essere eseguito il passaggio con
webview
. Ad esempio, un valore2
consente di avanzare di 2 voci nella cronologia, se possibile, mentre un valore-3
consente di tornare indietro di 3 voci. -
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:(success: boolean) => void
-
operazione riuscita
booleano
Indica se la navigazione è andata a buon fine.
-
insertCSS()
chrome.webviewTag.insertCSS(
details: InjectDetails,
callback?: function,
)
Inserisce il CSS nella pagina ospite.
Parametri
-
dettagli
Dettagli del CSS da inserire.
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:() => void
isAudioMuted()
chrome.webviewTag.isAudioMuted(
callback: function,
)
Esegue query per verificare se l'audio è disattivato.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(muted: boolean) => void
-
audio disattivato
booleano
-
isSpatialNavigationEnabled()
chrome.webviewTag.isSpatialNavigationEnabled(
callback: function,
)
Esegue query per verificare se la navigazione spaziale è attivata per il componente WebView.
Parametri
-
funzione
Il parametro
callback
ha il seguente aspetto:(enabled: boolean) => void
-
booleano
-
isUserAgentOverridden()
chrome.webviewTag.isUserAgentOverridden()
Indica se la stringa user agent di webview
è stata sostituita o meno da webviewTag.setUserAgentOverride
.
loadDataWithBaseUrl()
chrome.webviewTag.loadDataWithBaseUrl(
dataUrl: string,
baseUrl: string,
virtualUrl?: string,
)
Carica un URL di dati con un URL di base specificato utilizzato per i link relativi. Se vuoi, puoi fornire un URL virtuale da mostrare all'utente anziché l'URL dei dati.
Parametri
-
dataUrl
stringa
L'URL dei dati da caricare.
-
baseUrl
stringa
L'URL di base che verrà utilizzato per i link relativi.
-
virtualUrl
stringa facoltativa
L'URL che verrà mostrato all'utente (nella barra degli indirizzi).
print()
chrome.webviewTag.print()
Stampa i contenuti dell'elemento webview
. Ciò equivale a chiamare la funzione di stampa basata su script dal webview
stesso.
reload()
chrome.webviewTag.reload()
Ricarica la pagina di primo livello corrente.
removeContentScripts()
chrome.webviewTag.removeContentScripts(
scriptNameList?: string[],
)
Rimuove gli script di contenuti da un webview
.
L'esempio seguente rimuove "myRule", che è stato aggiunto in precedenza.
webview.removeContentScripts(['myRule']);
Puoi rimuovere tutte le regole chiamando:
webview.removeContentScripts();
Parametri
-
scriptNameList
stringa[] facoltativo
Un elenco di nomi di script di contenuti che verranno rimossi. Se l'elenco è vuoto, tutti gli script di contenuti aggiunti a
webview
verranno rimossi.
setAudioMuted()
chrome.webviewTag.setAudioMuted(
mute: boolean,
)
Imposta lo stato di disattivazione dell'audio della visualizzazione web.
Parametri
-
disattiva l'audio
booleano
Valore di disattivazione audio
setSpatialNavigationEnabled()
chrome.webviewTag.setSpatialNavigationEnabled(
enabled: boolean,
)
Imposta lo stato di navigazione spaziale della webview.
Parametri
-
booleano
Valore dello stato di navigazione spaziale.
setUserAgentOverride()
chrome.webviewTag.setUserAgentOverride(
userAgent: string,
)
Sostituisci la stringa dello user agent utilizzata da webview
per le richieste di pagine guest. La sostituzione comporterà che i valori dell'intestazione del client hint User-Agent e i valori restituiti da navigator.userAgentData
siano vuoti per le richieste di pagine guest a cui viene applicata la sostituzione.
Parametri
-
userAgent
stringa
La stringa user agent da utilizzare.
setZoom()
chrome.webviewTag.setZoom(
zoomFactor: number,
callback?: function,
)
Modifica il fattore di zoom della pagina. L'ambito e la persistenza di questa modifica sono determinati dall'attuale modalità di zoom della visualizzazione web (vedi webviewTag.ZoomMode
).
Parametri
-
zoomFactor
numero
Il nuovo fattore di zoom.
-
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:() => void
setZoomMode()
chrome.webviewTag.setZoomMode(
ZoomMode: ZoomMode,
callback?: function,
)
Imposta la modalità di zoom del webview
.
Parametri
-
ZoomMode
Definisce in che modo viene gestito lo zoom in
webview
. -
callback
function facoltativa
Il parametro
callback
ha il seguente aspetto:() => void
stop()
chrome.webviewTag.stop()
Interrompe il caricamento della navigazione webview
corrente, se in corso.
stopFinding()
chrome.webviewTag.stopFinding(
action?: "clear"
| "keep"
| "activate"
,
)
Termina la sessione di ricerca corrente (cancellando tutti gli evidenziamenti) e annulla tutte le richieste di ricerca in corso.
Parametri
-
azione
"clear"
| "keep"
| "activate"
facoltativoDetermina cosa fare con la corrispondenza attiva al termine della sessione di ricerca.
clear
elimina l'evidenziazione della corrispondenza attiva;keep
mantiene evidenziata la corrispondenza attiva;activate
mantiene evidenziata la corrispondenza attiva e simula un clic dell'utente sulla corrispondenza. L'azione predefinita èkeep
.
terminate()
chrome.webviewTag.terminate()
Interrompe forzatamente il processo del renderer della pagina web ospite. Ciò potrebbe influire su più tag webview
nell'app corrente se condividono lo stesso processo, ma non influirà sui tag webview
in altre app.
Eventi
close
chrome.webviewTag.close.addListener(
callback: function,
)
Viene attivato quando la finestra ospite tenta di chiudersi.
Il seguente codice di esempio passa da webview
a about:blank
quando l'ospite tenta di chiudersi.
webview.addEventListener('close', function() {
webview.src = 'about:blank';
});
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:() => void
consolemessage
chrome.webviewTag.consolemessage.addListener(
callback: function,
)
Viene attivato quando la finestra ospite registra un messaggio della console.
Il seguente codice di esempio inoltra tutti i messaggi di log alla console dell'utente che ha incorporato il video, indipendentemente dal livello del log o da altre proprietà.
webview.addEventListener('consolemessage', function(e) {
console.log('Guest page logged a message: ', e.message);
});
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(level: number, message: string, line: number, sourceId: string) => void
-
livello
numero
-
messaggio
stringa
-
linea
numero
-
sourceId
stringa
-
contentload
chrome.webviewTag.contentload.addListener(
callback: function,
)
Viene attivato quando la finestra ospite attiva un evento load
, ovvero quando viene caricato un nuovo documento. Non sono inclusi la navigazione tra le pagine all'interno del documento corrente o i caricamenti di risorse asincrone.
Il seguente codice di esempio modifica le dimensioni del carattere predefinite dell'elemento body
dell'ospite dopo il caricamento della pagina:
webview.addEventListener('contentload', function() {
webview.executeScript({ code: 'document.body.style.fontSize = "42px"' });
});
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:() => void
dialog
chrome.webviewTag.dialog.addListener(
callback: function,
)
Viene attivato quando la finestra ospite tenta di aprire una finestra di dialogo modale tramite window.alert
, window.confirm
o window.prompt
.
La gestione di questo evento bloccherà il processo guest finché ogni listener di eventi non restituisce un valore o l'oggetto dialog
non diventa irraggiungibile (se è stato chiamato preventDefault()
).
Il comportamento predefinito è annullare la finestra di dialogo.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(messageType: "alert"
| "confirm"
| "prompt"
, messageText: string, dialog: DialogController) => void-
messageType
"alert"
| "confirm"
| "prompt"
-
messageText
stringa
-
finestra di dialogo
-
exit
chrome.webviewTag.exit.addListener(
callback: function,
)
Viene attivato quando il processo di rendering dei contenuti web ospite è terminato.
Il seguente codice di esempio mostra un messaggio di saluto ogni volta che la pagina ospite si arresta in modo anomalo:
webview.addEventListener('exit', function(e) {
if (e.reason === 'crash') {
webview.src = 'data:text/plain,Goodbye, world!';
}
});
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(processID: number, reason: "normal"
| "abnormal"
| "crash"
| "kill"
) => void-
processID
numero
-
motivo
"normal"
| "abnormal"
| "crash"
| "kill"
-
findupdate
chrome.webviewTag.findupdate.addListener(
callback: function,
)
Viene attivato quando sono disponibili nuovi risultati di ricerca per una richiesta di ricerca attiva. Ciò può accadere più volte per una singola richiesta di ricerca man mano che vengono trovate le corrispondenze.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(searchText: string, numberOfMatches: number, activeMatchOrdinal: number, selectionRect: SelectionRect, canceled: boolean, finalUpdate: string) => void
-
searchText
stringa
-
numberOfMatches
numero
-
activeMatchOrdinal
numero
-
selectionRect
-
annullati
booleano
-
finalUpdate
stringa
-
loadabort
chrome.webviewTag.loadabort.addListener(
callback: function,
)
Viene attivato quando un caricamento di primo livello è stato interrotto senza commit. Nella console verrà stampato un messaggio di errore, a meno che l'evento non sia impedito per impostazione predefinita.
Nota: quando il caricamento di una risorsa viene interrotto, un evento loadabort
viene infine seguito da un evento loadstop
, anche se tutti i caricamenti confermati dall'ultimo evento loadstop
(se presente) sono stati interrotti.
Nota:quando il caricamento di un URL about o di un URL JavaScript viene interrotto, viene attivato loadabort
e poi webview
viene indirizzato a "about:blank".
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(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
stringa
-
isTopLevel
booleano
-
codice
numero
-
motivo
"ERR_ABORTED"
| "ERR_INVALID_URL"
| "ERR_DISALLOWED_URL_SCHEME"
| "ERR_BLOCKED_BY_CLIENT"
| "ERR_ADDRESS_UNREACHABLE"
| "ERR_EMPTY_RESPONSE"
| "ERR_FILE_NOT_FOUND"
| "ERR_UNKNOWN_URL_SCHEME"
-
loadcommit
chrome.webviewTag.loadcommit.addListener(
callback: function,
)
Viene attivato quando un caricamento è stato eseguito. Sono inclusi la navigazione all'interno del documento corrente e i caricamenti a livello di documento del frame secondario, ma non sono inclusi i caricamenti di risorse asincrone.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(url: string, isTopLevel: boolean) => void
-
url
stringa
-
isTopLevel
booleano
-
loadredirect
chrome.webviewTag.loadredirect.addListener(
callback: function,
)
Viene attivato quando una richiesta di caricamento di primo livello viene reindirizzata a un URL diverso.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(oldUrl: string, newUrl: string, isTopLevel: boolean) => void
-
oldUrl
stringa
-
newUrl
stringa
-
isTopLevel
booleano
-
loadstart
chrome.webviewTag.loadstart.addListener(
callback: function,
)
Viene attivato quando inizia un caricamento.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(url: string, isTopLevel: boolean) => void
-
url
stringa
-
isTopLevel
booleano
-
loadstop
chrome.webviewTag.loadstop.addListener(
callback: function,
)
Viene attivato al termine di tutti i caricamenti a livello di frame in una pagina ospite (inclusi tutti i relativi frame secondari). Sono inclusi la navigazione all'interno del documento corrente e i caricamenti a livello di documento del frame secondario, ma non sono inclusi i caricamenti di risorse asincrone. Questo evento viene attivato ogni volta che il numero di caricamenti a livello di documento passa da uno (o più) a zero. Ad esempio, se una pagina di cui è già stato completato il caricamento (ovvero loadstop
è già stato attivato una volta) crea un nuovo iframe che carica una pagina, quindi viene attivato un secondo loadstop
al termine del caricamento della pagina dell'iframe. Questo modello viene comunemente osservato nelle pagine che caricano gli annunci.
Nota: quando un caricamento confermato viene interrotto, un evento loadstop
seguirà eventualmente un evento loadabort
, anche se tutti i caricamenti confermati dall'ultimo evento loadstop
(se presente) sono stati interrotti.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:() => void
newwindow
chrome.webviewTag.newwindow.addListener(
callback: function,
)
Viene attivato quando la pagina ospite tenta di aprire una nuova finestra del browser.
Il seguente codice di esempio crea e naviga in un nuovo webview
nell'embedder per ogni nuova finestra richiesta:
webview.addEventListener('newwindow', function(e) {
var newWebview = document.createElement('webview');
document.body.appendChild(newWebview);
e.window.attach(newWebview);
});
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(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-
finestra
-
targetUrl
stringa
-
initialWidth
numero
-
initialHeight
numero
-
nome
stringa
-
windowOpenDisposition
"ignore"
| "save_to_disk"
| "current_tab"
| "new_background_tab"
| "new_foreground_tab"
| "new_window"
| "new_popup"
-
permissionrequest
chrome.webviewTag.permissionrequest.addListener(
callback: function,
)
Viene attivato quando la pagina ospite deve richiedere un'autorizzazione speciale all'utente che ha eseguito l'embed.
Il seguente codice di esempio concederà alla pagina ospite l'accesso all'API webkitGetUserMedia
. Tieni presente che un'app che utilizza questo codice di esempio deve specificare le autorizzazioni manifest audioCapture
e/o videoCapture
:
webview.addEventListener('permissionrequest', function(e) {
if (e.permission === 'media') {
e.request.allow();
}
});
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(permission: "media"
| "geolocation"
| "pointerLock"
| "download"
| "loadplugin"
| "filesystem"
| "fullscreen"
| "hid"
, request: object) => void-
autorizzazione
"media"
| "geolocation"
| "pointerLock"
| "download"
| "loadplugin"
| "filesystem"
| "fullscreen"
| "hid"
-
richiesta
oggetto
-
responsive
chrome.webviewTag.responsive.addListener(
callback: function,
)
Viene attivato quando il processo di rendering dei contenuti web degli ospiti è tornato a essere reattivo dopo essere stato non reattivo.
Il seguente codice di esempio attenua o aumenta l'elemento webview
man mano che diventa reattivo o non reattivo:
webview.style.webkitTransition = 'opacity 250ms';
webview.addEventListener('unresponsive', function() {
webview.style.opacity = '0.5';
});
webview.addEventListener('responsive', function() {
webview.style.opacity = '1';
});
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(processID: number) => void
-
processID
numero
-
sizechanged
chrome.webviewTag.sizechanged.addListener(
callback: function,
)
Viene attivato quando le dimensioni dei contenuti web incorporati sono state modificate tramite autosize
. Viene attivato solo se autosize
è attivato.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(oldWidth: number, oldHeight: number, newWidth: number, newHeight: number) => void
-
oldWidth
numero
-
oldHeight
numero
-
newWidth
numero
-
newHeight
numero
-
unresponsive
chrome.webviewTag.unresponsive.addListener(
callback: function,
)
Viene attivato quando il processo di rendering dei contenuti web degli ospiti non risponde. Questo evento verrà generato una volta con un evento di risposta corrispondente se l'ospite inizia a rispondere di nuovo.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(processID: number) => void
-
processID
numero
-
zoomchange
chrome.webviewTag.zoomchange.addListener(
callback: function,
)
Viene attivato quando cambia lo zoom della pagina.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(oldZoomFactor: number, newZoomFactor: number) => void
-
oldZoomFactor
numero
-
newZoomFactor
numero
-