chrome.webviewTag

Description

Utilisez la balise webview pour charger activement du contenu en direct depuis le Web sur le réseau et l'intégrer à votre application Chrome. Votre application peut contrôler l'apparence de la webview et interagir avec le contenu Web, lancer des navigations dans une page Web intégrée, réagir aux événements d'erreur qui se produisent sur celle-ci, etc. (voir la section Utilisation).

Autorisations

webview

Types

ClearDataOptions

Options qui déterminent quelles données doivent être effacées par clearData.

Propriétés

• depuis

  numéro facultatif

  Efface les données accumulées à partir de cette date, représentées en millisecondes écoulées depuis l'epoch (accessible via la méthode getTime de l'objet JavaScript Date). Si ce champ n'est pas renseigné, la valeur par défaut est 0 (toutes les données de navigation sont alors supprimées).

ClearDataTypeSet

Un ensemble de types de données Les propriétés manquantes sont interprétées comme false.

Propriétés

• cache d'application

  Booléen facultatif

  Caches d'application des sites Web

• cache

  Booléen facultatif

  Chrome 44 ou version ultérieure

  Depuis Chrome 43. Cache du navigateur Remarque: Lorsque vous supprimez des données, la totalité du cache est effacée. Les données ne sont pas limitées à la plage que vous spécifiez.

• cookies

  Booléen facultatif

  Cookies de la partition.

• fileSystems

  Booléen facultatif

  Les systèmes de fichiers des sites Web.

• indexedDB

  Booléen facultatif

  Données IndexedDB des sites Web.

• localStorage

  Booléen facultatif

  Données de stockage local des sites Web.

• persistentCookies

  Booléen facultatif

  Chrome 58 ou version ultérieure

  Les cookies persistants de la partition.

• sessionCookies

  Booléen facultatif

  Chrome 58 ou version ultérieure

  Cookies de session de la partition.

• webSQL

  Booléen facultatif

  Données WebSQL des sites Web.

ContentScriptDetails

Chrome 44 ou version ultérieure

Détails du script de contenu à injecter. Pour en savoir plus, consultez la documentation sur les scripts de contenu.

Propriétés

• all_frames

  Booléen facultatif

  Si all_frames est défini sur true, cela signifie que le code JavaScript ou CSS doit être injecté dans tous les frames de la page actuelle. Par défaut, all_frames est défini sur false, et le code JavaScript ou CSS n'est injecté que dans le frame supérieur.

• css

  InjectionItems facultatifs

  Code CSS ou liste de fichiers CSS à injecter dans les pages correspondantes. Ces éléments sont injectés dans l'ordre dans lequel ils apparaissent, avant la construction ou l'affichage des DOM sur la page.

• exclude_globs

  string[] facultatif

  Appliqué après les correspondances pour exclure les URL qui correspondent à ce glob. Destiné à émuler le mot clé @excluded Greasemonkey.

• exclude_matches

  string[] facultatif

  Exclut les pages dans lesquelles ce script de contenu serait autrement injecté.

• include_globs

  string[] facultatif

  Appliqué après les correspondances pour inclure uniquement les URL qui correspondent également à ce glob. Destiné à émuler le mot clé @include Greasemonkey.

• js

  InjectionItems facultatifs

  Code JavaScript ou liste de fichiers JavaScript à injecter dans les pages correspondantes. Celles-ci sont injectées dans l'ordre dans lequel elles apparaissent.

• match_about_blank

  Booléen facultatif

  Indique si le script de contenu doit être inséré dans about:blank et about:srcdoc. Les scripts de contenu ne sont injectés sur les pages que lorsque leur URL héritée correspond à l'un des formats déclarés dans le champ des correspondances. L'URL héritée est l'URL du document qui a créé le cadre ou la fenêtre. Il n'est pas possible d'insérer des scripts de contenu dans des cadres en bac à sable.

• correspondances

  chaîne[]

  Spécifie les pages dans lesquelles ce script de contenu sera injecté.

• name

  chaîne

  Nom du script de contenu à injecter.

• run_at

  RunAt facultatif

  Valeur la plus proche à laquelle le code JavaScript ou CSS sera injecté dans l'onglet. La valeur par défaut est "document_idle".

ContentWindow

Gestionnaire de messagerie vers une fenêtre d'invité.

Propriétés

• postMessage

  void

  Poste un message sur le contenu Web intégré à condition que le contenu intégré affiche une page provenant de l'origine cible. Cette méthode est disponible une fois le chargement de la page terminé. Écoutez l'événement contentload, puis appelez la méthode.

  L'invité pourra envoyer des réponses à l'outil d'intégration en publiant un message sur event.source lors de l'événement de message reçu.

  Cette API est identique à l'API postMessage HTML5 pour la communication entre les pages Web. L'outil d'intégration peut écouter les réponses en ajoutant un écouteur d'événements message à sa propre image.

  La fonction postMessage se présente comme suit :

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

  • message

    toutes

    Objet Message à envoyer à l'invité.

  • targetOrigin

    chaîne

    Spécifie l'origine de la fenêtre d'invité pour que l'événement soit déclenché.

ContextMenuCreateProperties

Chrome 44 ou version ultérieure

Propriétés

• coché

  Booléen facultatif

  État initial d'une case à cocher ou d'une case d'option: true pour les éléments sélectionnés et false pour les éléments non sélectionnés. Vous ne pouvez sélectionner qu'une seule case d'option à la fois dans un groupe d'options donné.

• contexts

  [ContextType,...ContextType[]] facultatif

  Liste des contextes dans lesquels cet élément de menu apparaîtra. Si aucune valeur n'est spécifiée, la valeur par défaut est ['page'].

• documentUrlPatterns

  string[] facultatif

  Permet de restreindre l'application de l'élément uniquement aux documents dont l'URL correspond à l'un des formats donnés. Cela s'applique également aux frames. Pour en savoir plus sur le format d'un format, consultez Formats de correspondance.

• activé

  Booléen facultatif

  Indique si cet élément de menu contextuel est activé ou désactivé. La valeur par défaut est true.

• id

  string facultatif

  Identifiant unique à attribuer à cet élément. Obligatoire pour les pages d'événement. Cet ID ne peut pas être identique à un autre pour cette extension.

• parentId

  chaîne|nombre facultatif

  Identifiant d'un élément de menu parent. Cet élément devient l'enfant d'un élément ajouté précédemment.

• targetUrlPatterns

  string[] facultatif

  Semblable à documentUrlPatterns, mais permet de filtrer en fonction de l'attribut src des tags img/audio/video et du href des tags d'ancrage.

• title

  string facultatif

  Texte à afficher dans l'élément. Ce champ est obligatoire, sauf si type est "séparateur". Lorsque le contexte est "selection", vous pouvez utiliser %s dans la chaîne pour afficher le texte sélectionné. Par exemple, si la valeur de ce paramètre est "Translate '%s' to Pig Latin" (Traduire '%s' en Pig latin') et que l'utilisateur sélectionne le mot "cool", l'élément de menu contextuel de la sélection est "Translate 'cool' to Pig Latin" (Traduire 'cool" en Pig Latin").

• Type

  ItemType facultatif

  Type d'élément de menu. En l'absence de spécification, la valeur par défaut est "normal".

• onclick

  vide facultatif

  Une fonction qui est rappelée lorsque l'utilisateur clique sur l'élément de menu.

  La fonction onclick se présente comme suit :

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

  • infos

    OnClickData

    Informations sur l'élément sur lequel l'utilisateur a cliqué et contexte dans lequel le clic s'est produit

ContextMenus

Chrome 44 ou version ultérieure

Propriétés

• onShow

  Événement<functionvoidvoid>

  Déclenché avant l'affichage d'un menu contextuel sur ce webview. Permet de désactiver ce menu contextuel en appelant event.preventDefault().

  La fonction onShow.addListener se présente comme suit :

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

  • rappel

    function

    Le paramètre callback se présente comme suit :

    (event: object)=>void

    • event

      objet

      • preventDefault

        void

        Appelez-le pour empêcher l'affichage du menu contextuel.

        La fonction preventDefault se présente comme suit :

        ()=> {...}

• créer

  void

  Crée un élément de menu contextuel. Notez que si une erreur se produit lors de la création, il se peut que vous ne le sachiez pas avant le déclenchement du rappel de création (les détails se trouvent dans runtime.lastError).

  La fonction create se présente comme suit :

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

  • createProperties

    objet

    Les propriétés utilisées pour créer l'élément

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit :

    ()=>void

  • retours

    string|number

    Identifiant du nouvel élément.

• remove

  void

  Supprime un élément de menu contextuel.

  La fonction remove se présente comme suit :

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

  • menuItemId

    string|number

    ID de l'élément de menu contextuel à supprimer.

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit :

    ()=>void

• removeAll

  void

  Supprime tous les éléments de menu contextuel ajoutés à ce webview.

  La fonction removeAll se présente comme suit :

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

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit :

    ()=>void

• update

  void

  Met à jour un élément de menu contextuel créé précédemment.

  La fonction update se présente comme suit :

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

  • id

    string|number

    Identifiant de l'article à mettre à jour.

  • updateProperties

    objet

    Propriétés à mettre à jour. Accepte les mêmes valeurs que la fonction "create".

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit :

    ()=>void

ContextMenuUpdateProperties

Chrome 44 ou version ultérieure

Propriétés

• coché

  Booléen facultatif

  État d'une case à cocher ou d'une case d'option : "true" pour les éléments sélectionnés et "false" pour ceux qui ne sont pas sélectionnés. Vous ne pouvez sélectionner qu'une seule case d'option à la fois dans un groupe d'options donné.

• contexts

  [ContextType,...ContextType[]] facultatif

  Liste des contextes dans lesquels cet élément de menu apparaîtra.

• documentUrlPatterns

  string[] facultatif

  Permet de restreindre l'application de l'élément uniquement aux documents dont l'URL correspond à l'un des formats donnés. Cela s'applique également aux frames. Pour en savoir plus sur le format d'un format, consultez Formats de correspondance.

• activé

  Booléen facultatif

  Indique si cet élément de menu contextuel est activé ou désactivé.

• parentId

  chaîne|nombre facultatif

  Identifiant d'un élément de menu parent. Cet élément devient l'enfant d'un élément ajouté précédemment. Remarque:Vous ne pouvez pas modifier un élément pour qu'il soit l'enfant de l'un de ses propres descendants.

• targetUrlPatterns

  string[] facultatif

  Semblable à documentUrlPatterns, mais permet de filtrer en fonction de l'attribut src des tags img/audio/video et du href des tags d'ancrage.

• title

  string facultatif

  Texte à afficher dans l'élément

• Type

  ItemType facultatif

  Type d'élément de menu.

• onclick

  vide facultatif

  Une fonction qui est rappelée lorsque l'utilisateur clique sur l'élément de menu.

  La fonction onclick se présente comme suit :

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

  • infos

    OnClickData

    Informations sur l'élément sur lequel l'utilisateur a cliqué et contexte dans lequel le clic s'est produit

ContextType

Chrome 44 ou version ultérieure

Les différents contextes dans lesquels un menu peut apparaître. Spécifier "all" équivaut à la combinaison de tous les autres contextes.

Enum

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

Interface associée aux événements DOM dialog.

Propriétés

• annuler

  void

  Rejetez la boîte de dialogue. Cela équivaut à cliquer sur "Annuler" dans une boîte de dialogue confirm ou prompt.

  La fonction cancel se présente comme suit :

  ()=> {...}

• ok

  void

  Acceptez la boîte de dialogue. Cela équivaut à cliquer sur OK dans une boîte de dialogue alert, confirm ou prompt.

  La fonction ok se présente comme suit :

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

  • réponse

    string facultatif

    Chaîne de réponse à fournir à l'invité lors de l'acceptation d'une boîte de dialogue prompt.

DownloadPermissionRequest

Type d'objet request qui accompagne un événement DOM permissionrequest download.

Propriétés

• requestMethod

  chaîne

  Type de requête HTTP (par exemple, GET) associé à la requête de téléchargement.

• url

  chaîne

  URL de téléchargement demandée.

• allow

  void

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit :

  ()=> {...}

• deny

  void

  Refusez la demande d'autorisation. Il s'agit du comportement par défaut si allow n'est pas appelé.

  La fonction deny se présente comme suit :

  ()=> {...}

FileSystemPermissionRequest

Type d'objet request qui accompagne un événement DOM permissionrequest filesystem.

Propriétés

• url

  chaîne

  URL de la trame demandant l'accès au système de fichiers local.

• allow

  void

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit :

  ()=> {...}

• deny

  void

  Refusez la demande d'autorisation.

  La fonction deny se présente comme suit :

  ()=> {...}

FindCallbackResults

Contient tous les résultats de la requête de recherche.

Propriétés

• activeMatchOrdinal

  Nombre

  Nombre ordinal de la correspondance en cours.

• annulée

  boolean

  Indique si cette demande de recherche a été annulée.

• numberOfMatches

  Nombre

  Nombre de fois où une correspondance a été établie avec searchText sur la page.

• selectionRect

  SelectionRect

  Décrit un rectangle autour de la correspondance active en coordonnées d'écran.

FindOptions

Options pour la requête de recherche.

Propriétés

• reculer

  Booléen facultatif

  Indicateur pour rechercher des correspondances dans l'ordre inverse. La valeur par défaut est false.

• matchCase

  Booléen facultatif

  Indicateur à mettre en correspondance avec la sensibilité à la casse. La valeur par défaut est false.

FullscreenPermissionRequest

Chrome 43 et versions ultérieures

Type d'objet request qui accompagne un événement DOM permissionrequest fullscreen.

Propriétés

• origine

  chaîne

  Origine du frame dans le webview qui a lancé la requête plein écran.

• allow

  void

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit :

  ()=> {...}

• deny

  void

  Refusez la demande d'autorisation.

  La fonction deny se présente comme suit :

  ()=> {...}

GeolocationPermissionRequest

Type d'objet request qui accompagne un événement DOM permissionrequest geolocation.

Propriétés

• url

  chaîne

  URL de la trame demandant l'accès aux données de géolocalisation.

• allow

  void

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit :

  ()=> {...}

• deny

  void

  Refusez la demande d'autorisation. Il s'agit du comportement par défaut si allow n'est pas appelé.

  La fonction deny se présente comme suit :

  ()=> {...}

HidPermissionRequest

En attente

Type d'objet request qui accompagne un événement DOM permissionrequest hid.

Propriétés

• url

  chaîne

  URL de la trame demandant l'accès à l'API HID.

• allow

  void

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit :

  ()=> {...}

• deny

  void

  Refusez la demande d'autorisation. Il s'agit du comportement par défaut si allow n'est pas appelé.

  La fonction deny se présente comme suit :

  ()=> {...}

InjectDetails

Détails du script ou du CSS à injecter. Le code ou la propriété de fichier doivent être définis, mais ils ne peuvent pas être définis en même temps.

Propriétés

• code

  string facultatif

  Code JavaScript ou CSS à injecter.

  Avertissement:Soyez prudent lorsque vous utilisez le paramètre code. Si vous ne l'utilisez pas correctement, votre application risque d'être victime d'attaques par script intersites.

• fichier

  string facultatif

  Fichier JavaScript ou CSS à injecter.

InjectionItems

Chrome 44 ou version ultérieure

Type d'élément d'injection: code ou ensemble de fichiers.

Propriétés

• code

  string facultatif

  Code JavaScript ou CSS à injecter dans les pages correspondantes.

• files

  string[] facultatif

  Liste des fichiers JavaScript ou CSS à injecter dans les pages correspondantes. Ces éléments sont injectés dans l'ordre dans lequel ils apparaissent dans ce tableau.

LoadPluginPermissionRequest

Type d'objet request qui accompagne un événement DOM permissionrequest loadplugin.

Propriétés

• identifier

  chaîne

  Chaîne d'identifiant du plug-in.

• name

  chaîne

  Nom à afficher du plug-in.

• allow

  void

  Autorisez la demande d'autorisation. Il s'agit du comportement par défaut si deny n'est pas appelé.

  La fonction allow se présente comme suit :

  ()=> {...}

• deny

  void

  Refusez la demande d'autorisation.

  La fonction deny se présente comme suit :

  ()=> {...}

MediaPermissionRequest

Type d'objet request qui accompagne un événement DOM permissionrequest media.

Propriétés

• url

  chaîne

  URL de la trame demandant l'accès au contenu multimédia de l'utilisateur.

• allow

  void

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit :

  ()=> {...}

• deny

  void

  Refusez la demande d'autorisation. Il s'agit du comportement par défaut si allow n'est pas appelé.

  La fonction deny se présente comme suit :

  ()=> {...}

NewWindow

Interface associée aux événements DOM newwindow.

Propriétés

• installer

  void

  Associez la page cible demandée à un élément webview existant.

  La fonction attach se présente comme suit :

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

  • webview

    objet

    Élément webview auquel la page cible doit être associée.

• supprimer

  void

  Annuler la demande de nouvelle fenêtre.

  La fonction discard se présente comme suit :

  ()=> {...}

PointerLockPermissionRequest

Type d'objet request qui accompagne un événement DOM permissionrequest pointerLock.

Propriétés

• lastUnlockedBySelf

  boolean

  Indique si le frame demandeur est le client le plus récent pour maintenir le verrouillage du pointeur.

• url

  chaîne

  URL du frame demandant le verrouillage du pointeur.

• userGesture

  boolean

  Indique si le verrouillage du pointeur a été demandé à la suite d'un geste d'entrée utilisateur.

• allow

  void

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit :

  ()=> {...}

• deny

  void

  Refusez la demande d'autorisation. Il s'agit du comportement par défaut si allow n'est pas appelé.

  La fonction deny se présente comme suit :

  ()=> {...}

SelectionRect

Décrit un rectangle en coordonnées à l'écran.

La sémantique de confinement ressemble à un tableau : la coordonnée (left, top) est considérée comme contenue dans le rectangle, mais pas la coordonnée (left + width, top).

Propriétés

• taille

  Nombre

  Hauteur du rectangle.

• gauche

  Nombre

  Distance entre le bord gauche de l'écran et le bord gauche du rectangle.

• top

  Nombre

  Distance entre le bord supérieur de l'écran et le bord supérieur du rectangle.

• largeur

  Nombre

  Largeur du rectangle.

WebRequestEventInterface

Chrome 44 ou version ultérieure

Interface permettant d'accéder aux événements webRequest sur la page d'invité. Consultez l'API des extensions chrome.webRequest pour en savoir plus sur le cycle de vie de webRequest et les concepts associés. Remarque: L'événement chrome.webRequest.onActionIgnored n'est pas compatible avec les WebViews.

Pour illustrer les différences d'utilisation avec l'API des extensions webRequest, prenons l'exemple de code suivant, qui bloque toutes les requêtes d'invités pour les URL correspondant à *://www.evil.com/*:

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

De plus, cette interface accepte les règles WebRequest déclaratives via les événements onRequest et onMessage. Pour en savoir plus sur l'API, consultez declarativeWebRequest.

Notez que les conditions et les actions des requêtes WebView déclaratives doivent être instanciées à partir de leurs équivalents chrome.webViewRequest.*. L'exemple de code suivant bloque de manière déclarative toutes les requêtes envoyées à "example.com" sur la myWebview de WebView:

var rule = {
  conditions: [
    new chrome.webViewRequest.RequestMatcher({ url: { hostSuffix: 'example.com' } })
  ],
  actions: [ new chrome.webViewRequest.CancelRequest() ]
};
myWebview.request.onRequest.addRules([rule]);

ZoomMode

Chrome 43 et versions ultérieures

Définit la manière dont le zoom est géré dans webview.

Enum

"per-origin"
Les modifications de zoom seront conservées sur l'origine de la page agrandie. Cela signifie que le zoom sera également appliqué à toutes les autres WebViews de la même partition qui sont redirigées vers la même origine. De plus, les modifications de zoom per-origin sont enregistrées avec l'origine, ce qui signifie que lorsque vous accédez à d'autres pages avec la même origine, elles seront toutes agrandies avec le même facteur de zoom.

"per-view"
Les modifications de zoom ne s'appliquent que dans cette WebView, et les modifications de zoom dans d'autres WebViews n'affecteront pas le zoom de cette WebView. De plus, les changements de zoom per-view sont réinitialisés lors de la navigation. Lors de la navigation dans une WebView, les pages sont toujours chargées avec leurs facteurs de zoom par origine (dans le champ d'application de la partition).

"désactivé"
Désactive tout zoom dans la WebView. Le niveau de zoom par défaut sera rétabli et toutes les tentatives de modification du zoom seront ignorées.

Propriétés

contentWindow

Référence d'objet pouvant être utilisée pour publier des messages sur la page d'invité.

Type

ContentWindow

contextMenus

Chrome 44 ou version ultérieure

Semblable à l' API ContextMenus de Chrome, mais s'applique à webview au lieu du navigateur. Utilisez l'API webview.contextMenus pour ajouter des éléments au menu contextuel de webview. Vous pouvez choisir les types d'objets auxquels s'appliquent les ajouts du menu contextuel, tels que des images, des liens hypertexte et des pages.

Type

ContextMenus

request

Interface permettant d'accéder aux événements webRequest sur la page d'invité.

Type

WebRequestEventInterface

Méthodes

addContentScripts()

Chrome 44 ou version ultérieure

chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails,...ContentScriptDetails[]],
)

Ajoute des règles d'injection de script de contenu à webview. Lorsque webview accède à une page correspondant à une ou plusieurs règles, les scripts associés sont injectés. Vous pouvez ajouter des règles par programmation ou mettre à jour des règles existantes.

L'exemple suivant ajoute deux règles à l'élément webview: "myRule" et "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';

Vous pouvez différer l'appel addContentScripts jusqu'à ce que vous ayez besoin d'injecter des scripts.

L'exemple suivant montre comment écraser une règle existante.

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'}]);

Si webview a été redirigé vers l'origine (par exemple, foo.com) et appelle webview.addContentScripts pour ajouter "myRule", vous devez attendre la prochaine navigation pour injecter les scripts. Si vous voulez une injection immédiate, executeScript s'adapte.

Les règles sont conservées même si le processus invité plante ou est arrêté, ou même si webview change de parent.

Pour en savoir plus, consultez la documentation sur les scripts de contenu.

Paramètres

• contentScriptList

  [ContentScriptDetails,...ContentScriptDetails[]]

  Détails des scripts de contenu à ajouter.

back()

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

Permet de revenir en arrière d'une entrée de l'historique, si possible. Équivaut à go(-1).

Paramètres

• rappel

  fonction facultative

  Chrome 44 ou version ultérieure

  Le paramètre callback se présente comme suit :

  (success: boolean)=>void

  • success

    boolean

    Indique si la navigation a abouti.

canGoBack()

chrome.webviewTag.canGoBack()

Indique s'il est possible ou non de revenir en arrière dans l'historique. L'état de cette fonction est mis en cache et mis à jour avant chaque loadcommit. Le meilleur endroit pour l'appeler est donc loadcommit.

Renvoie

• boolean

canGoForward()

chrome.webviewTag.canGoForward()

Indique s'il est possible ou non de parcourir l'historique. L'état de cette fonction est mis en cache et mis à jour avant chaque loadcommit. Le meilleur endroit pour l'appeler est donc loadcommit.

Renvoie

• boolean

captureVisibleRegion()

Chrome 50 et versions ultérieures

chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)

Capture la zone visible de la WebView.

Paramètres

• options

  ImageDetails facultatif

• rappel

  function

  Le paramètre callback se présente comme suit :

  (dataUrl: string)=>void

  • dataUrl

    chaîne

    URL de données qui encode une image de la zone visible de l'onglet capturé. Peut être attribué à la propriété "src" d'un élément "Image HTML" à afficher.

clearData()

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

Efface les données de navigation pour la partition webview.

Paramètres

• options

  ClearDataOptions

  Options déterminant les données à effacer.

• Types

  ClearDataTypeSet

  Types de données à effacer.

• rappel

  fonction facultative

  Le paramètre callback se présente comme suit :

  ()=>void

executeScript()

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

Injecte du code JavaScript dans la page invitée.

L'exemple de code suivant utilise l'injection de script pour définir la couleur d'arrière-plan de la page invitée sur rouge:

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

Paramètres

• détails

  InjectDetails

  Détails du script à exécuter.

• rappel

  fonction facultative

  Le paramètre callback se présente comme suit :

  (result?: any[])=>void

  • résultat

    any[] facultatif

    Résultat du script dans chaque frame injecté.

find()

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

Lance une demande de recherche sur la page.

Paramètres

• searchText

  chaîne

  Chaîne à rechercher dans la page.

• options

  FindOptions facultatif

  Options pour la requête de recherche.

• rappel

  fonction facultative

  Le paramètre callback se présente comme suit :

  (results?: FindCallbackResults)=>void

  • résultats

    FindCallbackResults facultatif

    Contient tous les résultats de la requête de recherche. results peut être omis s'il n'est pas utilisé dans le corps de la fonction de rappel (par exemple, si le rappel sert uniquement à détecter le moment où la requête de recherche est terminée).

forward()

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

Avance d'une entrée de l'historique, si possible. Équivaut à go(1).

Paramètres

• rappel

  fonction facultative

  Chrome 44 ou version ultérieure

  Le paramètre callback se présente comme suit :

  (success: boolean)=>void

  • success

    boolean

    Indique si la navigation a abouti.

getAudioState()

Chrome 62 ou version ultérieure

chrome.webviewTag.getAudioState(
  callback: function,
)

État de l'audio des requêtes.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (audible: boolean)=>void

  • audible

    boolean

getProcessId()

chrome.webviewTag.getProcessId()

Renvoie l'ID de processus interne de Chrome pour le processus en cours de la page Web invitée, ce qui permet aux outils d'intégration de savoir combien d'invités seraient affectés si l'arrêt du processus serait effectué. Deux invités ne peuvent partager un processus que s'ils appartiennent à la même application et ont le même ID de partition de stockage. L'appel est synchrone et renvoie la notion mise en cache par l'outil d'intégration de l'ID de processus actuel. L'identifiant de processus n'est pas le même que l'identifiant de processus du système d'exploitation.

Renvoie

• Nombre

getUserAgent()

chrome.webviewTag.getUserAgent()

Renvoie la chaîne user-agent utilisée par webview pour les requêtes de page d'invité.

Renvoie

• chaîne

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

Récupère le facteur de zoom actuel.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (zoomFactor: number)=>void

  • zoomFactor

    Nombre

    Facteur de zoom actuel.

getZoomMode()

Chrome 43 et versions ultérieures

chrome.webviewTag.getZoomMode(
  callback: function,
)

Récupère le mode de zoom actuel.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (ZoomMode: ZoomMode)=>void

  • ZoomMode

    ZoomMode

    Mode de zoom actuel de webview.

go()

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

Permet d'accéder à une entrée d'historique à l'aide d'un index d'historique associé à la navigation actuelle. Si la navigation demandée est impossible, cette méthode n'a aucun effet.

Paramètres

• relativeIndex

  Nombre

  Index d'historique relatif vers lequel naviguer dans webview Par exemple, la valeur 2 permet de faire avancer, si possible, deux entrées de l'historique. La valeur -3 permet de reculer de trois entrées.

• rappel

  fonction facultative

  Le paramètre callback se présente comme suit :

  (success: boolean)=>void

  • success

    boolean

    Indique si la navigation a abouti.

insertCSS()

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

Il injecte du code CSS dans la page invitée.

Paramètres

• détails

  InjectDetails

  Détails du CSS à insérer.

• rappel

  fonction facultative

  Le paramètre callback se présente comme suit :

  ()=>void

isAudioMuted()

Chrome 62 ou version ultérieure

chrome.webviewTag.isAudioMuted(
  callback: function,
)

Demande si le son est coupé.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (muted: boolean)=>void

  • son coupé

    boolean

isSpatialNavigationEnabled()

Chrome 71 et versions ultérieures

chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

Demande si la navigation spatiale est activée pour la WebView.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (enabled: boolean)=>void

  • activé

    boolean

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

Indique si la chaîne user-agent de webview a été remplacée ou non par webviewTag.setUserAgentOverride.

loadDataWithBaseUrl()

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

Charge une URL de données avec une URL de base spécifiée utilisée pour les liens relatifs. Si vous le souhaitez, vous pouvez fournir une URL virtuelle à l'utilisateur à la place de l'URL des données.

Paramètres

• dataUrl

  chaîne

  URL de données à charger.

• baseUrl

  chaîne

  URL de base qui sera utilisée pour les liens relatifs.

• virtualUrl

  string facultatif

  URL qui sera présentée à l'utilisateur (dans la barre d'adresse).

print()

chrome.webviewTag.print()

Affiche le contenu de webview. Cela équivaut à appeler une fonction d'impression scriptée à partir du webview lui-même.

reload()

chrome.webviewTag.reload()

Actualise la page de premier niveau actuelle.

removeContentScripts()

Chrome 44 ou version ultérieure

chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)

Supprime les scripts de contenu d'un webview.

L'exemple suivant supprime la règle "myRule" qui a déjà été ajoutée.

webview.removeContentScripts(['myRule']);

Vous pouvez supprimer toutes les règles en appelant la méthode suivante:

webview.removeContentScripts();

Paramètres

• scriptNameList

  string[] facultatif

  Liste des noms des scripts de contenu qui seront supprimés. Si la liste est vide, tous les scripts de contenu ajoutés à webview seront supprimés.

setAudioMuted()

Chrome 62 ou version ultérieure

chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

Définit l'état du son de la WebView.

Paramètres

• couper le son

  boolean

  Valeur "Couper le son"

setSpatialNavigationEnabled()

Chrome 71 et versions ultérieures

chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

Définit l'état de la navigation spatiale de la WebView.

Paramètres

• activé

  boolean

  Valeur de l'état de la navigation spatiale.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

Ignorez la chaîne user-agent utilisée par webview pour les requêtes de page d'invité. Si vous effectuez cette opération, les valeurs d'en-tête des indicateurs client User-Agent ainsi que les valeurs renvoyées par navigator.userAgentData seront vides pour les requêtes de page d'invité auxquelles ce forçage est appliqué.

Paramètres

• userAgent

  chaîne

  Chaîne user-agent à utiliser.

setZoom()

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

Modifie le facteur de zoom de la page. L'étendue et la persistance de cette modification sont déterminées par le mode de zoom actuel de WebView (voir webviewTag.ZoomMode).

Paramètres

• zoomFactor

  Nombre

  Nouveau facteur de zoom.

• rappel

  fonction facultative

  Le paramètre callback se présente comme suit :

  ()=>void

setZoomMode()

Chrome 43 et versions ultérieures

chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

Définit le mode de zoom de webview.

Paramètres

• ZoomMode

  ZoomMode

  Définit la manière dont le zoom est géré dans webview.

• rappel

  fonction facultative

  Le paramètre callback se présente comme suit :

  ()=>void

stop()

chrome.webviewTag.stop()

Arrête le chargement de la navigation webview actuelle si elle est en cours.

stopFinding()

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

Met fin à la session de recherche en cours (suppression de toute la mise en surbrillance) et annule toutes les demandes de recherche en cours.

Paramètres

• action

   facultatif

  Détermine quoi faire avec la correspondance active une fois la session de recherche terminée. clear supprime la mise en surbrillance de la correspondance active ; keep maintient la mise en surbrillance de la correspondance active ; activate maintient la mise en surbrillance de la correspondance active et simule la mise en surbrillance d'un clic de l'utilisateur. L'action par défaut est keep.

terminate()

chrome.webviewTag.terminate()

Arrête de force le processus de rendu de la page Web invitée. Cela peut affecter plusieurs balises webview dans l'application actuelle si elles partagent le même processus, mais cela n'affectera pas les balises webview dans d'autres applications.

Événements

close

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

Déclenché lorsque la fenêtre de l'invité tente de se fermer automatiquement

L'exemple de code suivant redirige webview vers about:blank lorsque l'invité tente de se fermer.

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

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  ()=>void

consolemessage

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

Déclenché lorsque la fenêtre d'invité enregistre un message de console.

L'exemple de code suivant transfère tous les messages de journal à la console de l'outil d'intégration sans tenir compte du niveau de journalisation ni des autres propriétés.

webview.addEventListener('consolemessage', function(e) {
  console.log('Guest page logged a message: ', e.message);
});

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • level

    Nombre

  • message

    chaîne

  • line

    Nombre

  • sourceId

    chaîne

contentload

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

Déclenché lorsque la fenêtre de l'invité déclenche un événement load, c'est-à-dire lorsqu'un nouveau document est chargé. Cela n'inclut pas la navigation sur les pages dans le document en cours ni les chargements de ressources asynchrones.

L'exemple de code suivant modifie la taille de police par défaut de l'élément body de l'invité une fois la page chargée:

webview.addEventListener('contentload', function() {
  webview.executeScript({ code: 'document.body.style.fontSize = "42px"' });
});

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  ()=>void

dialog

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

Déclenché lorsque la fenêtre Invité tente d'ouvrir une boîte de dialogue modale via window.alert, window.confirm ou window.prompt.

La gestion de cet événement bloque le processus invité jusqu'à ce que chaque écouteur d'événements soit renvoyé ou que l'objet dialog devienne inaccessible (si preventDefault() a été appelé).

Le comportement par défaut consiste à annuler la boîte de dialogue.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • messageType

    "alert"
    |"confirmer"
    |"invite"
    

  • messageText

    chaîne

  • boîte de dialogue

    DialogController

exit

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

Déclenché lorsque le processus d'affichage du contenu Web invité a pris fin.

L'exemple de code suivant affiche un message d'adieu à chaque plantage de la page Invité:

webview.addEventListener('exit', function(e) {
  if (e.reason === 'crash') {
    webview.src = 'data:text/plain,Goodbye, world!';
  }
});

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • processID

    Nombre

  • reason

    "normal"
    |"abnormal"
    |"crash"
    |"kill"
    

findupdate

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

Déclenché lorsque de nouveaux résultats sont disponibles pour une requête de recherche active. Cela peut se produire plusieurs fois pour une même requête lorsque des correspondances sont trouvées.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • searchText

    chaîne

  • numberOfMatches

    Nombre

  • activeMatchOrdinal

    Nombre

  • selectionRect

    SelectionRect

  • annulée

    boolean

  • finalUpdate

    chaîne

loadabort

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

Déclenché lorsqu'un chargement de niveau supérieur a été abandonné sans validation. Un message d'erreur s'affiche dans la console, sauf si l'événement est bloqué par défaut.

Remarque:Lorsqu'un chargement de ressource est annulé, un événement loadabort finit par être suivi par un événement loadstop, même si tous les chargements validés depuis le dernier événement loadstop (le cas échéant) ont été annulés.

Remarque:Lorsque le chargement d'une URL "À propos" ou d'une URL JavaScript est annulé, loadabort est déclenché, puis webview est redirigé vers "about:blank".

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (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

    chaîne

  • isTopLevel

    boolean

  • code

    Nombre

  • reason

    "ERR_ABORTED"
    |"ERR_INVALID_URL"
    |"ERR_DISALLOWED_URL_SCHEME"
    |"ERR_BLOCKED_BY_CLIENT"
    |"ERR_ADDRESS_UNREACHABLE"
    |"ERR_EMPTY_response"|
    |"ERR_EMPTY_NOT_FOUND"
    
    

loadcommit

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

Déclenché lorsqu'un chargement est validé. Cela inclut la navigation dans le document actuel ainsi que les chargements au niveau du document du sous-frame, mais pas les chargements de ressources asynchrones.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • url

    chaîne

  • isTopLevel

    boolean

loadredirect

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

Déclenché lorsqu'une requête de chargement de premier niveau a redirigé vers une autre URL

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • oldUrl

    chaîne

  • newUrl

    chaîne

  • isTopLevel

    boolean

loadstart

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

Déclenché lorsqu'un chargement commence.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • url

    chaîne

  • isTopLevel

    boolean

loadstop

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

Déclenché lorsque tous les chargements au niveau de l'image d'une page invitée (y compris tous ses sous-cadres) sont terminés. Cela inclut la navigation dans le document actuel ainsi que les chargements au niveau du document du sous-frame, mais pas les chargements de ressources asynchrones. Cet événement se déclenche chaque fois que le nombre de chargements au niveau du document passe d'un (ou plusieurs) à zéro. Par exemple, si le chargement d'une page est déjà terminé (par exemple, loadstop déjà déclenché une fois) crée un iFrame qui charge une page, puis un second loadstop se déclenche une fois le chargement de la page iFrame terminé. Ce schéma est fréquemment observé sur les pages qui chargent des annonces.

Remarque:Lorsqu'un chargement validé est annulé, un événement loadstop finit par suivre un événement loadabort, même si tous les chargements validés depuis le dernier événement loadstop (le cas échéant) ont été annulés.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  ()=>void

newwindow

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

Déclenché lorsque la page invitée tente d'ouvrir une nouvelle fenêtre de navigateur.

L'exemple de code suivant crée une nouvelle webview et y navigue dans l'outil d'intégration pour chaque nouvelle fenêtre demandée:

webview.addEventListener('newwindow', function(e) {
  var newWebview = document.createElement('webview');
  document.body.appendChild(newWebview);
  e.window.attach(newWebview);
});

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (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

  • fenêtre

    NewWindow

  • targetUrl

    chaîne

  • initialWidth

    Nombre

  • initialHeight

    Nombre

  • name

    chaîne

  • windowOpenDisposition

    "ignore"
    |"save_to_disk"
    |"current_tab"
    |"new_background_tab"
    |"new_foreground_tab"
    |"new_window"
    |"new_popup"
    

permissionrequest

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

Déclenché lorsque la page invitée doit demander une autorisation spéciale de l'intégrateur.

L'exemple de code suivant accordera à la page invitée l'accès à l'API webkitGetUserMedia. Notez qu'une application qui utilise cet exemple de code doit spécifier elle-même les autorisations audioCapture et/ou videoCapture du fichier manifeste:

webview.addEventListener('permissionrequest', function(e) {
  if (e.permission === 'media') {
    e.request.allow();
  }
});

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (permission: "media" 
   |"geolocation" 
   |"pointerLock" 
   |"download" 
   |"loadplugin" 
   |"filesystem" 
   |"fullscreen" 
   |"hid" 
   ,request: object)=>void

  • autorisation

    "media"
    |"geolocation"
    |"pointerLock"
    |"download"
    |"loadplugin"
    |"filesystem"
    |"fullscreen"
    |"hid"
    

  • request

    objet

responsive

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

Déclenché lorsque le processus qui affiche le contenu Web de l'invité redevient responsif alors qu'il ne répond plus.

Dans l'exemple de code suivant, l'élément webview apparaît ou disparaît en fondu lorsqu'il devient responsif ou ne répond plus:

webview.style.webkitTransition = 'opacity 250ms';
webview.addEventListener('unresponsive', function() {
  webview.style.opacity = '0.5';
});
webview.addEventListener('responsive', function() {
  webview.style.opacity = '1';
});

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (processID: number)=>void

  • processID

    Nombre

sizechanged

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

Déclenché lorsque le contenu Web intégré a été redimensionné via autosize. Se déclenche uniquement si autosize est activé.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • oldWidth

    Nombre

  • oldHeight

    Nombre

  • newWidth

    Nombre

  • newHeight

    Nombre

unresponsive

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

Déclenché lorsque le processus qui affiche le contenu Web invité ne répond plus. Cet événement sera généré une fois avec un événement responsif correspondant si l'invité commence à répondre de nouveau.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

  (processID: number)=>void

  • processID

    Nombre

zoomchange

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

Déclenché lorsque le zoom de la page est modifié.

Paramètres

• rappel

  function

  Le paramètre callback se présente comme suit :

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

  • oldZoomFactor

    Nombre

  • newZoomFactor

    Nombre