chrome.webviewTag

Descrizione

Usa il tag webview per caricare attivamente contenuti live dal web sulla rete e incorporarli nell'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 a 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 entro il giorno clearData.

Proprietà

  • da

    numero facoltativo

    Cancella i dati accumulati a partire da questa data, rappresentati in millisecondi a partire dall'epoca (accessibile tramite il metodo getTime dell'oggetto JavaScript Date). Se non è presente, il valore predefinito è 0 (che rimuove tutti i dati di navigazione).

ClearDataTypeSet

Un insieme di tipi di dati. Le proprietà mancanti sono interpretate come false.

Proprietà

  • appcache

    booleano facoltativo

    Siti web appcache.

  • cache

    booleano facoltativo

    Chrome 44 e versioni successive .

    Da Chrome 43. La cache del browser. Nota: quando rimuovi i dati, viene svuotata l'intera cache. non si limita all'intervallo specificato.

  • cookie

    booleano facoltativo

    I cookie della partizione.

  • fileSystems

    booleano facoltativo

    Siti web tra i file system.

  • indexedDB

    booleano facoltativo

    Siti web Dati IndexedDB.

  • localStorage

    booleano facoltativo

    Siti web di archiviazione locale.

  • persistentCookies

    booleano facoltativo

    Chrome 58 e versioni successive .

    I cookie permanenti della partizione.

  • sessionCookies

    booleano facoltativo

    Chrome 58 e versioni successive .

    I cookie di sessione della partizione.

  • webSQL

    booleano facoltativo

    Siti web Dati WebSQL.

ContentScriptDetails

Chrome 44 e versioni successive .

Dettagli dello script dei contenuti da inserire. Per ulteriori dettagli, consulta la documentazione relativa agli script di 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, il valore di all_frames è false e il codice JavaScript o CSS viene inserito soltanto nel frame superiore.

  • css

    InjectionItems facoltativo

    Il codice CSS o un elenco di file CSS da inserire nelle pagine corrispondenti. Questi vengono inseriti nell'ordine in cui appaiono, prima che qualsiasi DOM venga creato o visualizzato per la pagina.

  • exclude_globs

    string[] facoltativo

    Applicato dopo le corrispondenze per escludere gli URL che corrispondono a questo glob. Ha lo scopo di emulare la parola chiave @exclusion Greasemonkey.

  • exclude_matches

    string[] facoltativo

    Esclude le pagine in cui verrebbe altrimenti inserito questo script di contenuti.

  • include_globs

    string[] facoltativo

    Applicato dopo le corrispondenze per includere solo gli URL che corrispondono a questo glob. Ha lo scopo di emulare la parola chiave @include Greasemonkey.

  • js

    InjectionItems facoltativo

    Il codice JavaScript o un elenco di file JavaScript da inserire nelle pagine corrispondenti. che 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 di contenuti vengono inseriti nelle pagine solo quando il loro URL eredita una corrispondenza con uno dei pattern dichiarati nel campo delle corrispondenze. L'URL Eredita è l'URL del documento che ha creato il frame o la finestra. Gli script di contenuti non possono essere inseriti in frame con sandbox.

  • corrisponde a

    stringa[]

    Specifica le pagine in cui verrà inserito questo script di contenuti.

  • nome

    stringa

    Il nome dello script di contenuti da inserire.

  • run_at

    RunAt facoltativo

    Il codice JavaScript o CSS verrà inserito prima nella scheda. Il valore predefinito è "document_idle".

ContentWindow

Handle di messaggistica a una finestra Ospite.

Proprietà

  • postMessage

    null

    Pubblica un messaggio nei contenuti web incorporati purché questi mostrino una pagina dall'origine di destinazione. Questo metodo è disponibile al termine del caricamento della pagina. Ascolta l'evento contentload e chiama il metodo.

    L'ospite potrà inviare risposte all'autore dell'incorporamento pubblicando un messaggio su event.source nell'evento del messaggio che riceve.

    Questa API è identica all'API postMessage di HTML5 per la comunicazione tra le pagine web. L'incorporamento può ascoltare le risposte aggiungendo un listener di eventi message al proprio frame.

    La funzione postMessage ha questo aspetto:

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

    • messaggio

      qualsiasi

      Oggetto messaggio da inviare all'invitato.

    • targetOrigin

      stringa

      Specifica quale deve essere l'origine della finestra degli invitati affinché l'evento venga inviato.

ContextMenuCreateProperties

Chrome 44 e versioni successive .

Proprietà

  • selezionato

    booleano facoltativo

    Lo stato iniziale di una casella di controllo o di una voce di opzione: vero per selezionato e falso per deselezionato. È possibile selezionare un solo elemento di opzione alla volta in un determinato gruppo di elementi di opzione.

  • contesti

    [ContextType, ...ContextType[]] facoltativo

    Elenco dei contesti in cui verrà visualizzata questa voce di menu. Se non specificato, il valore predefinito è ['page'].

  • documentUrlPatterns

    string[] facoltativo

    Consente di limitare l'applicazione dell'elemento solo a documenti il cui URL corrisponde a uno dei pattern specificati. Questo vale anche per i frame. Per maggiori dettagli sul formato di un pattern, consulta Pattern di corrispondenza.

  • abilitata

    booleano facoltativo

    Indica se questa voce del menu contestuale è attivata o disattivata. Il valore predefinito è true.

  • id

    stringa facoltativo

    L'ID univoco da assegnare all'elemento. Obbligatorio per le pagine degli eventi. Non può essere uguale a un altro ID di questa estensione.

  • parentId

    string | numero facoltativo

    L'ID di una voce di menu principale. l'elemento diventa quindi secondario rispetto a un altro elemento aggiunto in precedenza.

  • targetUrlPatterns

    string[] facoltativo

    Simile a documentUrlPatterns, ma consente di filtrare in base all'attributo src dei tag img/audio/video e al href di anchor tag.

  • titolo

    stringa facoltativo

    Il testo da visualizzare nell'elemento; questo è obbligatorio a meno che type non sia "separatore". Quando il contesto è "selezione", puoi utilizzare %s all'interno della stringa per mostrare il testo selezionato. Ad esempio, se il valore di questo parametro è "Traduci '%s'" "pig Latin" e l'utente seleziona la parola "freddo", la voce del menu contestuale per la selezione è "Traduci 'freddo'' al latino Pig".

  • tipo

    ItemType facoltativo

    Il tipo di voce di menu. Il valore predefinito è "normale" se non specificato.

  • onclick

    void facoltativo

    Una funzione che verrà richiamata quando l'utente fa clic sulla voce di menu.

    La funzione onclick ha questo aspetto:

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

    • informazioni

      Informazioni sull'articolo su cui è stato fatto clic e il contesto in cui è avvenuto il clic.

ContextMenus

Chrome 44 e versioni successive .

Proprietà

  • onShow

    Evento<functionvoidvoid>

    Attivato prima di mostrare un menu contestuale su questo webview. Può essere utilizzato per disattivare questo menu contestuale chiamando event.preventDefault().

    La funzione onShow.addListener ha questo aspetto:

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

    • callback

      funzione

      Il parametro callback ha il seguente aspetto:

      (event: object) => void

      • evento

        oggetto

        • preventDefault

          null

          Chiama questa opzione per impedire la visualizzazione del menu contestuale.

          La funzione preventDefault ha questo aspetto:

          () => {...}

  • create

    null

    Crea una nuova voce del menu contestuale. Tieni presente che se si verifica un errore durante la creazione, potresti non saperlo fino a quando non viene attivato il callback di creazione (i dettagli saranno in runtime.lastError).

    La funzione create ha questo aspetto:

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

    • createProperties

      oggetto

      Le proprietà utilizzate per creare l'elemento

    • callback

      funzione facoltativa

      Il parametro callback ha il seguente aspetto:

      () => void

    • returns

      string | numero

      L'ID dell'elemento appena creato.

  • rimuovi

    null

    Rimuove una voce del menu contestuale.

    La funzione remove ha questo aspetto:

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

    • menuItemId

      string | numero

      L'ID della voce del menu contestuale da rimuovere.

    • callback

      funzione facoltativa

      Il parametro callback ha il seguente aspetto:

      () => void

  • removeAll

    null

    Rimuove tutte le voci del menu contestuale aggiunte a questo webview.

    La funzione removeAll ha questo aspetto:

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

    • callback

      funzione facoltativa

      Il parametro callback ha il seguente aspetto:

      () => void

  • update

    null

    Consente di aggiornare una voce del menu contestuale creata in precedenza.

    La funzione update ha questo aspetto:

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

    • id

      string | numero

      L'ID dell'articolo da aggiornare.

    • updateProperties

      oggetto

      Le proprietà da aggiornare. Accetta gli stessi valori della funzione di creazione.

    • callback

      funzione facoltativa

      Il parametro callback ha il seguente aspetto:

      () => void

ContextMenuUpdateProperties

Chrome 44 e versioni successive .

Proprietà

  • selezionato

    booleano facoltativo

    Lo stato di una casella di controllo o di una voce di opzione: true per la selezione e false per quella non selezionata. È possibile selezionare un solo elemento di opzione alla volta in un determinato gruppo di elementi di opzione.

  • contesti

    [ContextType, ...ContextType[]] facoltativo

    Elenco dei contesti in cui verrà visualizzata questa voce di menu.

  • documentUrlPatterns

    string[] facoltativo

    Consente di limitare l'applicazione dell'elemento solo a documenti il cui URL corrisponde a uno dei pattern specificati. Questo vale anche per i frame. Per maggiori dettagli sul formato di un pattern, consulta Pattern di corrispondenza.

  • abilitata

    booleano facoltativo

    Indica se questa voce del menu contestuale è attivata o disattivata.

  • parentId

    string | numero facoltativo

    L'ID di una voce di menu principale. l'elemento diventa quindi secondario rispetto a un altro elemento aggiunto in precedenza. Nota: non puoi cambiare un elemento come elemento secondario di uno dei suoi discendenti.

  • targetUrlPatterns

    string[] facoltativo

    Simile a documentUrlPatterns, ma consente di filtrare in base all'attributo src dei tag img/audio/video e al href di anchor tag.

  • titolo

    stringa facoltativo

    Il testo da visualizzare nell'elemento

  • tipo

    ItemType facoltativo

    Il tipo di voce di menu.

  • onclick

    void facoltativo

    Una funzione che verrà richiamata quando l'utente fa clic sulla voce di menu.

    La funzione onclick ha questo aspetto:

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

    • informazioni

      Informazioni sull'articolo su cui è stato fatto clic e il contesto in cui è avvenuto il clic.

ContextType

Chrome 44 e versioni successive .

I diversi contesti in cui può apparire un menu. Specificare "tutti" equivale alla combinazione di tutti gli altri contesti.

Enum

"tutti"

"pagina"

"frame"

"selezione"

"link"

"modificabile"

"image"

"video"

"audio"

DialogController

Interfaccia collegata a dialog eventi DOM.

Proprietà

  • annulla

    null

    Rifiuta la finestra di dialogo. Equivale a fare clic su Annulla in una finestra di dialogo confirm o prompt.

    La funzione cancel ha questo aspetto:

    () => {...}

  • ok

    null

    Accetta la finestra di dialogo. Equivale a fare clic su OK in una finestra di dialogo alert, confirm o prompt.

    La funzione ok ha questo aspetto:

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

    • risposta

      stringa facoltativo

      La stringa di risposta da fornire all'invitato 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

    null

    Consenti la richiesta di autorizzazione.

    La funzione allow ha questo aspetto:

    () => {...}

  • deny

    null

    Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato allow.

    La funzione deny ha questo 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

    null

    Consenti la richiesta di autorizzazione.

    La funzione allow ha questo aspetto:

    () => {...}

  • deny

    null

    Rifiutare la richiesta di autorizzazione.

    La funzione deny ha questo aspetto:

    () => {...}

FindCallbackResults

Contiene tutti i risultati della richiesta di ricerca.

Proprietà

  • activeMatchOrdinal

    numero

    Il numero ordinale della corrispondenza corrente.

  • annullati

    booleano

    Indica se questa richiesta di ricerca è stata annullata.

  • numberOfMatches

    numero

    Il numero di volte in cui searchText è stata trovata nella pagina.

  • selectionRect

    Descrive un rettangolo attorno alla corrispondenza attiva nelle coordinate sullo schermo.

FindOptions

Opzioni per la richiesta di ricerca.

Proprietà

  • indietro

    booleano facoltativo

    Segnala per trovare corrispondenze in ordine inverso. Il valore predefinito è false.

  • matchCase

    booleano facoltativo

    Contrassegno da abbinare alla sensibilità alle maiuscole. Il valore predefinito è false.

FullscreenPermissionRequest

Chrome 43 e versioni successive .

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

    null

    Consenti la richiesta di autorizzazione.

    La funzione allow ha questo aspetto:

    () => {...}

  • deny

    null

    Rifiutare la richiesta di autorizzazione.

    La funzione deny ha questo 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 di geolocalizzazione.

  • allow

    null

    Consenti la richiesta di autorizzazione.

    La funzione allow ha questo aspetto:

    () => {...}

  • deny

    null

    Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato allow.

    La funzione deny ha questo aspetto:

    () => {...}

HidPermissionRequest

Chrome 125 e versioni successive .

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

    null

    Consenti la richiesta di autorizzazione.

    La funzione allow ha questo aspetto:

    () => {...}

  • deny

    null

    Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato allow.

    La funzione deny ha questo aspetto:

    () => {...}

InjectDetails

Dettagli dello script o del CSS da inserire. È necessario impostare il codice o la proprietà del file, ma non possono essere impostati entrambi contemporaneamente.

Proprietà

  • codice

    stringa facoltativo

    codice JavaScript o CSS da inserire.

    Avviso: Fai attenzione a utilizzare il parametro code. Un uso non corretto dello stesso potrebbe esporre l'app ad attacchi cross-site scripting.

  • file

    stringa facoltativo

    JavaScript o CSS da inserire.

InjectionItems

Chrome 44 e versioni successive .

Il tipo di elemento di inserimento: codice o un insieme di file.

Proprietà

  • codice

    stringa facoltativo

    di codice JavaScript o CSS da inserire nelle pagine corrispondenti.

  • file

    string[] facoltativo

    L'elenco di file JavaScript o CSS da inserire nelle pagine corrispondenti. che 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 identificatore del plug-in.

  • nome

    stringa

    Il nome visualizzato del plug-in.

  • allow

    null

    Consenti la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato deny.

    La funzione allow ha questo aspetto:

    () => {...}

  • deny

    null

    Rifiutare la richiesta di autorizzazione.

    La funzione deny ha questo 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

    null

    Consenti la richiesta di autorizzazione.

    La funzione allow ha questo aspetto:

    () => {...}

  • deny

    null

    Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato allow.

    La funzione deny ha questo aspetto:

    () => {...}

NewWindow

Interfaccia collegata a newwindow eventi DOM.

Proprietà

  • allegare

    null

    Collega la pagina di destinazione richiesta a un elemento webview esistente.

    La funzione attach ha questo aspetto:

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

    • WebView

      oggetto

      L'elemento webview a cui deve essere associata la pagina di destinazione.

  • Annulla

    null

    Annulla la richiesta della nuova finestra.

    La funzione discard ha questo 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 a tenere premuto il blocco del puntatore.

  • url

    stringa

    L'URL del frame che richiede il blocco del puntatore.

  • userGesture

    booleano

    Indica se il blocco del puntatore è stato richiesto o meno a seguito di un gesto di input dell'utente.

  • allow

    null

    Consenti la richiesta di autorizzazione.

    La funzione allow ha questo aspetto:

    () => {...}

  • deny

    null

    Rifiutare la richiesta di autorizzazione. Questo è il comportamento predefinito se non viene chiamato allow.

    La funzione deny ha questo aspetto:

    () => {...}

SelectionRect

Descrive un rettangolo nelle coordinate sullo schermo.

La semantica del contenimento è di tipo array; cioè la coordinata (left, top) viene considerata contenuta dal rettangolo, mentre la coordinata (left + width, top) non lo è.

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

Chrome 44 e versioni successive .

Interfaccia che consente di accedere agli eventi webRequest nella pagina ospite. Per informazioni dettagliate sul ciclo di vita di webRequest e sui concetti correlati, consulta l'API delle estensioni chrome.webRequest. Nota: l'evento chrome.webRequest.onActionIgnored non è supportato per le WebView.

Per illustrare le differenze di utilizzo con l'API webRequest delle estensioni, considera il codice di esempio che segue che blocca le richieste degli ospiti per gli URL che corrispondono a *://www.evil.com/*:

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

Inoltre, questa interfaccia supporta le regole dichiarative webRequest tramite eventi onRequest e onMessage. Consulta declarativeWebRequest per i dettagli delle API.

Tieni presente che le condizioni e le azioni per le richieste webView dichiarative devono essere create dalle rispettive 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

Chrome 43 e versioni successive .

Definisce la modalità di gestione dello zoom nell'elemento webview.

Enum

"per-origin"
Le modifiche dello zoom verranno mantenute nell'origine della pagina con zoom, ad esempio verranno ingrandite anche tutte le altre WebView nella stessa partizione che consentono di raggiungere quella stessa origine. Inoltre, le modifiche allo zoom di per-origin vengono salvate con l'origine, il che significa che quando si naviga su altre pagine nella stessa origine, verrà applicato lo stesso fattore di zoom su tutte le pagine.

"per visualizzazione"
Le modifiche allo zoom vengono applicate soltanto in questa WebView, mentre le modifiche allo zoom in altre WebView non influiscono sullo zoom di questa WebView. Inoltre, le modifiche allo zoom di per-view vengono reimpostate durante la navigazione. la navigazione in una WebView caricherà sempre le pagine con i relativi fattori di zoom per origine (nell'ambito della partizione).

"Disabled"
Disattiva tutti gli zoom nella WebView. Verrà ripristinato il livello di zoom predefinito e tutti i tentativi di modifica dello zoom verranno ignorati.

Proprietà

contentWindow

Riferimento oggetto che può essere utilizzato per pubblicare messaggi nella pagina ospite.

contextMenus

Chrome 44 e versioni successive .

Simile all'API ContextMenus di Chrome, ma si applica a webview anziché al browser. Usa l'API webview.contextMenus per aggiungere voci al menu contestuale di webview. Puoi scegliere i tipi di oggetti a cui applicare le aggiunte del menu contestuale, ad esempio immagini, link ipertestuali e pagine.

request

Interfaccia che consente di accedere agli eventi webRequest nella pagina ospite.

Metodi

addContentScripts()

Chrome 44 e versioni successive .
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)

Aggiunge regole di inserimento di script di contenuti a webview. Quando webview accede a una pagina che corrisponde a una o più regole, vengono inseriti gli script associati. Puoi aggiungere le regole in modo programmatico o aggiornare quelle esistenti.

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 rimandare la chiamata addContentScripts fino a quando non devi inserire 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 indirizzato all'origine (ad es. foo.com) e chiama webview.addContentScripts per aggiungere "myRule", devi attendere la navigazione successiva per inserire gli script. Se vuoi procedere subito con l'inserimento, executeScript farà la cosa giusta.

Le regole vengono mantenute anche se il processo guest ha un arresto anomalo o si interrompe o l'webview viene reinserito come padre.

Per ulteriori dettagli, consulta la documentazione relativa agli script di contenuti.

Parametri

back()

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

Consente di tornare indietro di una voce della cronologia, se possibile. Equivalente a go(-1).

Parametri

  • callback

    funzione facoltativa

    Chrome 44 e versioni successive .

    Il parametro callback ha il seguente aspetto:

    (success: boolean) => void

    • operazione riuscita

      booleano

      Indica se la navigazione è riuscita.

canGoBack()

chrome.webviewTag.canGoBack()

Indica se è possibile ripercorrere o meno la cronologia. Lo stato di questa funzione viene memorizzato nella cache e aggiornato prima di ogni loadcommit, quindi il modo migliore per chiamarlo è loadcommit.

Resi

  • booleano

canGoForward()

chrome.webviewTag.canGoForward()

Indica se è possibile spostarsi nella cronologia o meno. Lo stato di questa funzione viene memorizzato nella cache e aggiornato prima di ogni loadcommit, quindi il modo migliore per chiamarlo è loadcommit.

Resi

  • booleano

captureVisibleRegion()

Chrome 50 e versioni successive .
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)

Acquisisce la regione visibile della WebView.

Parametri

  • opzioni

    ImageDetails facoltativo

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

    (dataUrl: string) => void

    • dataUrl

      stringa

      Un URL di dati che codifica un'immagine dell'area visibile della scheda acquisita. Può essere assegnato all'account "src" di un elemento HTML Image per la visualizzazione.

clearData()

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

Cancella i dati di navigazione per la partizione webview.

Parametri

  • Opzioni che determinano quali dati cancellare.

  • I tipi di dati da cancellare.

  • callback

    funzione 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 lo script injection per impostare su rosso il colore di sfondo della pagina ospite:

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

Parametri

  • dettagli

    Dettagli dello script da eseguire.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    (result?: any[]) => void

    • risultato

      qualsiasi[] facoltativo

      Il risultato dello script in ogni frame inserito.

find()

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

Avvia una richiesta Trova in-page.

Parametri

  • searchText

    stringa

    La stringa da trovare nella pagina.

  • opzioni

    FindOptions facoltativo

    Opzioni per la richiesta di ricerca.

  • callback

    funzione 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 distinguere quando la richiesta di ricerca è stata completata.

forward()

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

Ti consente di mandare avanti una voce della cronologia, se possibile. Equivalente a go(1).

Parametri

  • callback

    funzione facoltativa

    Chrome 44 e versioni successive .

    Il parametro callback ha il seguente aspetto:

    (success: boolean) => void

    • operazione riuscita

      booleano

      Indica se la navigazione è riuscita.

getAudioState()

Chrome 62 e versioni successive .
chrome.webviewTag.getAudioState(
  callback: function,
)

Stato dell'audio delle query.

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 incorporatori di sapere quanti ospiti sarebbero interessati dalla terminazione del processo. Due invitati condivideranno un processo solo se appartengono alla stessa app e hanno lo stesso ID partizione di archiviazione. La chiamata è sincrona e restituisce la nozione memorizzata nella cache dell'incorporamento dell'ID di processo corrente. L'ID di processo non corrisponde all'ID di processo del sistema operativo.

Resi

  • numero

getUserAgent()

chrome.webviewTag.getUserAgent()

Restituisce la stringa dello user agent utilizzata da webview per le richieste di pagina ospite.

Resi

  • stringa

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

Restituisce il fattore di zoom corrente.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

    (zoomFactor: number) => void

    • zoomFactor

      numero

      Il fattore di zoom corrente.

getZoomMode()

Chrome 43 e versioni successive .
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

      L'attuale modalità zoom del webview.

go()

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

Conduce 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 indirizzato webview. Ad esempio, il valore 2 sposterà in avanti due voci della cronologia, se possibile. un valore -3 sposterà indietro di 3 voci.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    (success: boolean) => void

    • operazione riuscita

      booleano

      Indica se la navigazione è riuscita.

insertCSS()

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

Inserisce il codice CSS nella pagina ospite.

Parametri

  • dettagli

    Dettagli del CSS da inserire.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

isAudioMuted()

Chrome 62 e versioni successive .
chrome.webviewTag.isAudioMuted(
  callback: function,
)

Chiede se l'audio è disattivato.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

    (muted: boolean) => void

    • audio disattivato

      booleano

isSpatialNavigationEnabled()

Chrome 71 e versioni successive .
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

Consente di chiedere se la navigazione spaziale è abilitata per la WebView.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

    (enabled: boolean) => void

    • abilitata

      booleano

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

Indica se la stringa dello 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. Facoltativamente, è possibile fornire un URL virtuale da mostrare all'utente al posto dell'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 facoltativo

    L'URL che verrà mostrato all'utente (nella barra degli indirizzi).

print()

chrome.webviewTag.print()

Stampa i contenuti dell'elemento webview. Equivale alla chiamata della funzione di stampa basata su script dal webview stesso.

reload()

chrome.webviewTag.reload()

Ricarica la pagina di primo livello corrente.

removeContentScripts()

Chrome 44 e versioni successive .
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)

Rimuove gli script di contenuti da un webview.

L'esempio seguente rimuove "myRule" aggiunta in precedenza.

webview.removeContentScripts(['myRule']);

Puoi rimuovere tutte le regole richiamando:

webview.removeContentScripts();

Parametri

  • scriptNameList

    string[] 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 62 e versioni successive .
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

Imposta lo stato di disattivazione audio della WebView.

Parametri

  • disattiva l'audio

    booleano

    Disattiva valore audio

setSpatialNavigationEnabled()

Chrome 71 e versioni successive .
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

Imposta lo stato della navigazione spaziale della WebView.

Parametri

  • abilitata

    booleano

    Valore dello stato della navigazione spaziale.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

Esegui l'override della stringa dello user agent utilizzata da webview per le richieste della pagina ospite. Se esegui l'override, i valori dell'intestazione User-Agent Client Hint e i valori restituiti da navigator.userAgentData saranno vuoti per le richieste di pagina ospite a cui viene applicato questo override.

Parametri

  • userAgent

    stringa

    La stringa dello 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 di WebView (vedi webviewTag.ZoomMode).

Parametri

  • zoomFactor

    numero

    Il nuovo fattore di zoom.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

setZoomMode()

Chrome 43 e versioni successive .
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

Consente di impostare la modalità di zoom dell'webview.

Parametri

  • ZoomMode

    Definisce la modalità di gestione dello zoom in webview.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

stop()

chrome.webviewTag.stop()

Interrompe il caricamento della navigazione webview attuale, se in corso.

stopFinding()

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

Termina la sessione di ricerca corrente (cancellando tutta l'evidenziazione) e annulla tutte le richieste di ricerca in corso.

Parametri

  • azione

    "cancella"
     | "keep"
     | "attivare"
     facoltativo

    Determina cosa fare con la corrispondenza attiva al termine della sessione di ricerca. clear cancellerà l'evidenziazione sulla corrispondenza attiva; keep manterrà evidenziata la corrispondenza attiva; activate manterrà evidenziata la corrispondenza attiva e simula il clic dell'utente su quella corrispondenza. L'azione predefinita è keep.

terminate()

chrome.webviewTag.terminate()

Interrompe forzatamente il processo di rendering 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 nelle altre app.

Eventi

close

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

Attivato quando la finestra ospite tenta di chiudersi.

Il codice di esempio seguente porta 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,
)

Attivato quando la finestra Ospite registra un messaggio della console.

Il codice di esempio seguente inoltra tutti i messaggi di log alla console dell'incorporamento senza tenere conto del livello di log o di 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,
)

Attivato quando la finestra ospite attiva un evento load, ad esempio quando viene caricato un nuovo documento. Non include la navigazione delle pagine all'interno del documento corrente o i caricamenti di risorse asincroni.

Il seguente codice di esempio modifica la dimensione predefinita del carattere 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,
)

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é non viene restituito ogni listener di eventi o fino a quando l'oggetto dialog non diventa raggiungibile (se è stato chiamato preventDefault()).

Il comportamento predefinito prevede l'annullamento della finestra di dialogo.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

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

    • messageType

      "avviso"
       | "conferma"
       | "prompt"

    • messageText

      stringa

    • finestra di dialogo

exit

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

Attivato quando si è chiuso il processo di rendering dei contenuti web ospite.

Il seguente codice di esempio mostrerà un messaggio di addio 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

      "normale"
       | "anormale"
       | "arresto anomalo"
       | "uccidi"

findupdate

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

Attivato quando sono disponibili nuovi risultati di ricerca per una richiesta di ricerca attiva. Questo può accadere più volte per una singola richiesta di ricerca man mano che vengono trovate 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,
)

Attivato quando un caricamento di primo livello si è interrotto senza commit. A meno che l'evento non sia impedito per impostazione predefinita, verrà stampato un messaggio di errore sulla console.

Nota: quando un carico di risorse viene interrotto, un evento loadabort alla fine sarà seguito da un evento loadstop, anche se tutti i caricamenti di cui è stato eseguito il commit dall'ultimo evento loadstop (se presenti) sono stati interrotti.

Nota: quando viene interrotto il caricamento di un URL informazioni o di un URL JavaScript, viene attivato loadabort e webview viene spostato in "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"
       | &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,
)

Attivato quando è stato confermato un carico. Ciò include la navigazione all'interno del documento corrente e i caricamenti a livello di documento del frame secondario, ma non include caricamenti di risorse asincroni.

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

Attivato quando una richiesta di caricamento di primo livello è stata 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,
)

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

Attivato quando tutti i caricamenti a livello di frame in una pagina ospite (inclusi tutti i relativi frame secondari) sono stati completati. Ciò include la navigazione all'interno del documento corrente e i caricamenti a livello di documento del frame secondario, ma non include caricamenti di risorse asincroni. 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 è già stata caricata (ad es. loadstop già attivato una volta) crea un nuovo iframe che carica una pagina, quindi viene attivato un secondo loadstop al termine del caricamento della pagina iframe. Questo schema si osserva di solito nelle pagine che caricano gli annunci.

Nota: quando un caricamento di cui è stato eseguito il commit viene interrotto, un evento loadstop verrà seguito da un evento loadabort, anche se tutti i caricamenti di cui è stato eseguito il commit dall'ultimo evento loadstop (se presenti) sono stati interrotti.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

    () => void

newwindow

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

Attivato quando la pagina ospite tenta di aprire una nuova finestra del browser.

Il seguente codice di esempio creerà e naviga in un nuovo webview nell'incorporamento 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"
       | &quot;new_background_tab&quot;
       | "new_foreground_tab"
       | "new_window"
       | "new_popup"

permissionrequest

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

Attivato quando la pagina ospite deve richiedere un'autorizzazione speciale all'autore dell'incorporamento.

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 del file 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"
       | "schermo intero"
       | "ha nascosto"

    • richiesta

      oggetto

responsive

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

Attivato quando il processo di rendering dei contenuti web dell'ospite torna di nuovo reattivo dopo l'assenza di risposta.

Nel seguente codice di esempio l'elemento webview verrà attenuato quando diventa adattabile o non risponde:

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

Attivato quando i contenuti web incorporati vengono ridimensionati tramite autosize. Si attiva solo se autosize è attivo.

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

Attivato quando il processo di rendering dei contenuti web ospite non risponde. Questo evento verrà generato una volta con un evento adattabile corrispondente se l'invitato 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,
)

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