chrome.webviewTag

Description

Utilisez la balise webview pour charger activement du contenu en direct à partir du Web via le réseau et l'intégrer à votre application Chrome. Votre application peut contrôler l'apparence de 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 au sein de celle-ci, et plus encore (voir 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

  Effacez les données accumulées à cette date ou après, représentées en millisecondes 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 (ce qui entraîne la suppression de toutes les données de navigation).

ClearDataTypeSet

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

  Sites Web caches d'application.

• cache

  Booléen facultatif

  Chrome (version 44 ou ultérieure)

  Depuis Chrome 43. Cache du navigateur Remarque: La suppression de données vide l'intégralité du cache. elle n'est pas limitée à la plage spécifiée.

• cookies

  Booléen facultatif

  Cookies de la partition.

• fileSystems

  Booléen facultatif

  Sites Web systèmes de fichiers.

• indexedDB

  Booléen facultatif

  Sites Web Données IndexedDB

• localStorage

  Booléen facultatif

  Sites Web des données stockées en local.

• persistentCookies

  Booléen facultatif

  Chrome (version 58 ou ultérieure)

  Cookies persistants de la partition.

• sessionCookies

  Booléen facultatif

  Chrome (version 58 ou ultérieure)

  Cookies de session de la partition.

• webSQL

  Booléen facultatif

  Sites Web Données WebSQL.

ContentScriptDetails

Chrome (version 44 ou 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 cadres de la page actuelle. Par défaut, all_frames est false, et le code JavaScript ou CSS n'est injecté que dans le cadre supérieur.

• css

  InjectionItems facultatif

  Code CSS ou liste de fichiers CSS à injecter dans les pages correspondantes. Ceux-ci sont injectés dans l'ordre dans lequel ils apparaissent, avant qu'un DOM ne soit construit ou affiché pour la page.

• exclude_globs

  string[] facultatif

  Appliqué après les correspondances pour exclure les URL qui correspondent à ce schéma 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 n'inclure que les URL qui correspondent également à ce globe. Destiné à émuler le mot clé @include Greasemonkey.

• js

  InjectionItems facultatif

  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é sur 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 correspond à l'URL du document qui a créé le cadre ou la fenêtre. Impossible d'insérer des scripts de contenu dans des frames en bac à sable.

• correspond à

  chaîne[]

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

• nom

  chaîne

  Nom du script de contenu à injecter.

• run_at

  RunAt facultatif

  Au plus tôt le moment où le code JavaScript ou CSS sera injecté dans l'onglet. La valeur par défaut est "document_idle".

ContentWindow

Identifiant de messagerie vers une fenêtre Invité.

Propriétés

• postMessage

  vide

  Publie un message dans le contenu Web intégré, à condition que ce contenu affiche une page à partir 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'intégrateur en publiant un message sur event.source dans 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 à son propre frame.

  La fonction postMessage se présente comme suit:

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

  • message

    tous

    Objet Message à envoyer à l'invité.

  • targetOrigin

    chaîne

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

ContextMenuCreateProperties

Chrome (version 44 ou 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" dans le cas contraire. Vous ne pouvez sélectionner qu'une case d'option à la fois dans un groupe donné d'options.

• 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 limiter l'application de l'élément aux documents dont l'URL correspond à l'un des formats indiqués. (Cela s'applique également aux cadres.) Pour en savoir plus sur le format des motifs, consultez la section Modèles 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

  chaîne facultatif

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

• parentId

  string | numéro facultatif

  ID d'un élément de menu parent. cela fait de l'élément un 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 balises img/audio/video et du href des balises d'ancrage.

• titre

  chaîne facultatif

  Texte à afficher dans l'élément. ceci est obligatoire, sauf si type est "séparateur". Lorsque le contexte est "sélection", 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' à Pig Latin". et que l'utilisateur sélectionne le mot "cool", l'élément de menu contextuel pour la sélection est "Traduire 'cool'" à Pig Latin".

• type

  ItemType facultatif

  Type d'élément de menu. La valeur par défaut est "normal". s'il n'est pas spécifié.

• 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 où il s'est produit.

ContextMenus

Chrome (version 44 ou ultérieure)

Propriétés

• onShow

  Événement<functionvoid>

  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

    fonction

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

    (event: object) => void

    • événement

      objet

      • preventDefault

        vide

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

        La fonction preventDefault se présente comme suit:

        () => {...}

• create

  vide

  Crée un élément de menu contextuel. Notez que si une erreur se produit lors de la création, vous ne la découvrirez peut-être pas avant que le rappel de création ne se déclenche (les détails seront disponibles dans runtime.lastError).

  La fonction create se présente comme suit:

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

  • createProperties

    objet

    Propriétés utilisées pour créer l'élément

  • rappel

    function facultatif

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

    () => void

  • retours

    string | numéro

    Identifiant de l'élément nouvellement créé.

• supprimer

  vide

  Supprime un élément de menu contextuel.

  La fonction remove se présente comme suit:

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

  • menuItemId

    string | numéro

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

  • rappel

    function facultatif

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

    () => void

• removeAll

  vide

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

  La fonction removeAll se présente comme suit:

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

  • rappel

    function facultatif

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

    () => void

• update

  vide

  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 | numéro

    Identifiant de l'élément à mettre à jour.

  • updateProperties

    objet

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

  • rappel

    function facultatif

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

    () => void

ContextMenuUpdateProperties

Chrome (version 44 ou 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 les éléments non sélectionnés. Vous ne pouvez sélectionner qu'une case d'option à la fois dans un groupe donné d'options.

• contexts

  [ContextType, ...ContextType[]] facultatif

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

• documentUrlPatterns

  string[] facultatif

  Permet de limiter l'application de l'élément aux documents dont l'URL correspond à l'un des formats indiqués. (Cela s'applique également aux cadres.) Pour en savoir plus sur le format des motifs, consultez la section Formats de correspondance.

• activé

  Booléen facultatif

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

• parentId

  string | numéro facultatif

  ID d'un élément de menu parent. cela fait de l'élément un enfant d'un élément ajouté précédemment. Remarque:Vous ne pouvez pas modifier un élément pour en faire 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 balises img/audio/video et du href des balises d'ancrage.

• titre

  chaîne 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 où il s'est produit.

ContextType

Chrome (version 44 ou ultérieure)

Les différents contextes dans lesquels un menu peut s'afficher. Spécifier "all" équivaut à la combinaison de tous les autres contextes.

Énumération

"tous"

"page"

"cadre"

"selection"

"lien"

"modifiable"

"image"

"vidéo"

"audio"

DialogController

Interface associée à des événements DOM dialog.

Propriétés

• annuler

  vide

  Rejeter 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

  vide

  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

    chaîne facultatif

    Chaîne de réponse à fournir à l'invité lorsqu'il accepte une boîte de dialogue prompt.

DownloadPermissionRequest

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

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

  vide

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit:

  () => {...}

• deny

  vide

  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 filesystem permissionrequest.

Propriétés

• url

  chaîne

  URL du frame demandant l'accès au système de fichiers local.

• allow

  vide

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit:

  () => {...}

• deny

  vide

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

• annulée

  booléen

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

• numberOfMatches

  Nombre

  Nombre de fois où searchText a été mis en correspondance sur la page.

• selectionRect

  SelectionRect

  Décrit un rectangle autour de la correspondance active avec les coordonnées à l'écran.

FindOptions

Options pour la requête de recherche.

Propriétés

• vers l'arrière

  Booléen facultatif

  Marquez l'élément 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 ou version ultérieure

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

Propriétés

• origine

  chaîne

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

• allow

  vide

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit:

  () => {...}

• deny

  vide

  Refusez la demande d'autorisation.

  La fonction deny se présente comme suit:

  () => {...}

GeolocationPermissionRequest

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

Propriétés

• url

  chaîne

  URL du frame demandant l'accès aux données de géolocalisation.

• allow

  vide

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit:

  () => {...}

• deny

  vide

  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

Chrome 125 ou version ultérieure

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

Propriétés

• url

  chaîne

  URL du frame demandant l'accès à l'API HID.

• allow

  vide

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit:

  () => {...}

• deny

  vide

  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 Vous devez définir soit le code, soit la propriété du fichier, mais vous ne pouvez pas les définir en même temps.

Propriétés

• code

  chaîne facultatif

  Code JavaScript ou CSS à injecter.

  Avertissement: Utilisez le paramètre code avec prudence. Une utilisation incorrecte peut exposer votre application à des attaques par cross-site scripting.

• fichier

  chaîne facultatif

  JavaScript ou fichier CSS à injecter.

InjectionItems

Chrome (version 44 ou ultérieure)

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

Propriétés

• code

  chaîne facultatif

  Code JavaScript ou CSS à injecter dans les pages correspondantes.

• fichiers

  string[] facultatif

  Liste des fichiers JavaScript ou CSS à injecter dans les pages correspondantes. Celles-ci sont injectées dans l'ordre dans lequel elles apparaissent dans le tableau.

LoadPluginPermissionRequest

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

Propriétés

• identifiant

  chaîne

  Chaîne d'identifiant du plug-in.

• nom

  chaîne

  Nom à afficher du plug-in.

• allow

  vide

  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

  vide

  Refusez la demande d'autorisation.

  La fonction deny se présente comme suit:

  () => {...}

MediaPermissionRequest

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

Propriétés

• url

  chaîne

  URL du frame demandant l'accès aux contenus multimédias de l'utilisateur.

• allow

  vide

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit:

  () => {...}

• deny

  vide

  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 à des événements DOM newwindow.

Propriétés

• joindre

  vide

  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

  vide

  Annulez la demande de nouvelle période.

  La fonction discard se présente comme suit:

  () => {...}

PointerLockPermissionRequest

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

Propriétés

• lastUnlockedBySelf

  booléen

  Indique si le frame à l'origine de la demande était le client le plus récent pour maintenir le verrouillage du pointeur.

• url

  chaîne

  URL du frame demandant le verrouillage du pointeur.

• userGesture

  booléen

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

• allow

  vide

  Autorisez la demande d'autorisation.

  La fonction allow se présente comme suit:

  () => {...}

• deny

  vide

  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 est semblable à un tableau. Autrement dit, 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

• hauteur

  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 (version 44 ou 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 en quoi l'utilisation diffère de l'API des extensions webRequest, prenons l'exemple de code suivant, qui bloque toutes les requêtes des invités pour les URL qui correspondent à *://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. Consultez declarativeWebRequest pour en savoir plus sur l'API.

Notez que les conditions et les actions pour les webRequests webviews 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 WebView myWebview:

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

ZoomMode

Chrome 43 ou version ultérieure

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

Énumération

"per-origin"
Les modifications apportées à Zoom seront conservées dans l'origine de la page sur laquelle vous avez effectué un zoom, c'est-à-dire que toutes les autres WebViews de la même partition qui accèdent à la même origine seront également zoomées. De plus, les modifications de zoom per-origin sont enregistrées avec l'origine, ce qui signifie que lorsque vous naviguez vers d'autres pages avec la même origine, un zoom est effectué sur le même facteur de zoom.

"per-view"
Les modifications de zoom ne prennent effet que dans cette WebView. Les modifications de zoom dans les autres WebViews n'affectent pas le zoom de cette WebView. De plus, les changements de zoom de per-view sont réinitialisés lors de la navigation. Lorsque vous naviguez dans une WebView, les pages sont toujours chargées avec leurs facteurs de zoom par origine (dans le cadre de la partition).

"disable"
Désactive tous les zooms dans WebView. Le contenu revient au niveau de zoom par défaut, et toutes les tentatives de modification de zoom sont 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 (version 44 ou 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 éléments 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 (version 44 ou ultérieure)

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

Il 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 à 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 souhaitez une injection immédiate, executeScript fera ce qu'il faut.

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

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

  function facultatif

  Chrome (version 44 ou ultérieure)

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

  (success: boolean) => void

  • success

    booléen

    Indique si la navigation a réussi.

canGoBack()

chrome.webviewTag.canGoBack()

Indique s'il est possible 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

• booléen

canGoForward()

chrome.webviewTag.canGoForward()

Indique s'il est possible d'avancer 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

• booléen

captureVisibleRegion()

Chrome (version 50 ou ultérieure)

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

Capture la zone visible de WebView.

Paramètres

• options

  ImageDetails facultatif

• rappel

  fonction

  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é à l'attribut "src" d'un élément HTML Image à 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 quelles données effacer.

• Types

  ClearDataTypeSet

  Types de données à effacer.

• rappel

  function facultatif

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

  () => void

executeScript()

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

Il injecte du code JavaScript dans la page d'invité.

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

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

Paramètres

• détails

  InjectDetails

  Détails du script à exécuter.

• rappel

  function facultatif

  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 sur la page.

• options

  FindOptions facultatif

  Options pour la requête de recherche.

• rappel

  function facultatif

  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. C'est le cas, par exemple, si le rappel sert uniquement à discerner lorsque la requête de recherche est terminée.

forward()

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

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

Paramètres

• rappel

  function facultatif

  Chrome (version 44 ou ultérieure)

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

  (success: boolean) => void

  • success

    booléen

    Indique si la navigation a réussi.

getAudioState()

Chrome (version 62 ou ultérieure)

chrome.webviewTag.getAudioState(
  callback: function,
)

État de l'audio de la requête.

Paramètres

• rappel

  fonction

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

  (audible: boolean) => void

  • audible

    booléen

getProcessId()

chrome.webviewTag.getProcessId()

Renvoie l'ID de processus interne de Chrome pour le processus actuel de la page Web invitée, ce qui permet aux intégrateurs de savoir combien d'invités seraient affectés par l'arrêt du processus. Deux invités ne peuvent partager un processus que s'ils appartiennent à la même application et disposent du même ID de partition de stockage. L'appel est synchrone et renvoie la notion mise en cache de l'outil d'intégration de l'ID de processus actuel. L'identifiant de processus est différent de 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

  fonction

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

  (zoomFactor: number) => void

  • zoomFactor

    Nombre

    Facteur de zoom actuel.

getZoomMode()

Chrome 43 ou version ultérieure

chrome.webviewTag.getZoomMode(
  callback: function,
)

Récupère le mode de zoom actuel.

Paramètres

• rappel

  fonction

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

  (ZoomMode: ZoomMode) => void

  • ZoomMode

    ZoomMode

    Mode de zoom actuel du webview.

go()

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

Accède à une entrée d'historique à l'aide d'un index d'historique relatif à la navigation actuelle. Si la navigation demandée est impossible, cette méthode n'a aucun effet.

Paramètres

• relativeIndex

  Nombre

  Index de l'historique relatif vers lequel accéder à webview. Par exemple, la valeur 2 permet d'avancer de deux entrées d'historique si possible. La valeur -3 permet de revenir en arrière de trois entrées.

• rappel

  function facultatif

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

  (success: boolean) => void

  • success

    booléen

    Indique si la navigation a réussi.

insertCSS()

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

Il injecte du code CSS dans la page d'invité.

Paramètres

• détails

  InjectDetails

  Détails du CSS à insérer.

• rappel

  function facultatif

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

  () => void

isAudioMuted()

Chrome (version 62 ou ultérieure)

chrome.webviewTag.isAudioMuted(
  callback: function,
)

Demande si le son est coupé.

Paramètres

• rappel

  fonction

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

  (muted: boolean) => void

  • son coupé

    booléen

isSpatialNavigationEnabled()

Chrome 71 ou version ultérieure

chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

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

Paramètres

• rappel

  fonction

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

  (enabled: boolean) => void

  • activé

    booléen

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

Indique si la chaîne user-agent de webview a été remplacée 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. Vous pouvez éventuellement fournir une URL virtuelle à présenter à 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

  chaîne 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 de webview.

reload()

chrome.webviewTag.reload()

Actualise la page de premier niveau actuelle.

removeContentScripts()

Chrome (version 44 ou ultérieure)

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

Supprime les scripts de contenu d'un webview.

L'exemple suivant supprime "myRule" qui a été ajoutée précédemment.

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 sont supprimés.

setAudioMuted()

Chrome (version 62 ou ultérieure)

chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

Définit l'état de désactivation du son de WebView.

Paramètres

• couper le son

  booléen

  Valeur de désactivation du son

setSpatialNavigationEnabled()

Chrome 71 ou version ultérieure

chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

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

Paramètres

• activé

  booléen

  Valeur de l'état de la navigation spatiale.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

Remplacez la chaîne user-agent utilisée par webview pour les requêtes de page d'invité. Si vous remplacez la valeur, les valeurs d'en-tête du hints client user-agent et les valeurs renvoyées par navigator.userAgentData seront vides pour les requêtes de page d'invité auxquelles ce remplacement 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. La portée et la persistance de cette modification sont déterminées par le mode de zoom actuel de la WebView (voir webviewTag.ZoomMode).

Paramètres

• zoomFactor

  Nombre

  Nouveau facteur de zoom.

• rappel

  function facultatif

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

  () => void

setZoomMode()

Chrome 43 ou version ultérieure

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

  function facultatif

  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 (en supprimant toute la mise en surbrillance) et annule toutes les demandes de recherche en cours.

Paramètres

• action

  "clear"
   | "keep"
   | "activate"
   facultatif

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

terminate()

chrome.webviewTag.terminate()

Arrête de force le processus de moteur 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.

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

  fonction

  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é consigne un message de console.

L'exemple de code suivant transmet tous les messages de journal à la console de l'intégrateur sans tenir compte du niveau de journalisation ou des autres propriétés.

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

Paramètres

• rappel

  fonction

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

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

  • level

    Nombre

  • message

    chaîne

  • ligne

    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 actuel 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é après le chargement de la page:

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

Paramètres

• rappel

  fonction

  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.

Le traitement de cet événement bloquera 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

  fonction

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

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

  • messageType

    "alerte"
     | "confirm"
     | "requête"
    

  • 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 été interrompu.

L'exemple de code suivant permet d'afficher un message d'adieu en cas de plantage de la page d'invité:

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

Paramètres

• rappel

  fonction

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

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

  • processID

    Nombre

  • reason

    "normal"
     | "anormal"
     | "crash"
     | "kill"
    

findupdate

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

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

Paramètres

• rappel

  fonction

  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

    booléen

  • finalUpdate

    chaîne

loadabort

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

Déclenché lorsqu'un chargement de niveau supérieur est annulé sans commit. Un message d'erreur s'affichera dans la console, sauf si l'événement n'est pas évité par défaut.

Remarque:Lorsqu'un chargement de ressource est annulé, un événement loadabort est suivi d'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

  fonction

  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

    booléen

  • code

    Nombre

  • reason

    "ERR_ABORTED"
     | &quot;ERR_INVALID_URL&quot;
     | &quot;ERR_DISALLOWED_URL_SCHEME&quot;
     | &quot;ERR_BLOCKED_BY_CLIENT&quot;
     | "ERR_ADDRESS_UNREACHABLE"
     | &quot;ERR_EMPTY_RESPONSE&quot;
     | &quot;ERR_FILE_NOT_FOUND&quot;
     | &quot;ERR_UNKNOWN_URL_SCHEME&quot;
    

loadcommit

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

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

Paramètres

• rappel

  fonction

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

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

  • url

    chaîne

  • isTopLevel

    booléen

loadredirect

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

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

Paramètres

• rappel

  fonction

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

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

  • oldUrl

    chaîne

  • newUrl

    chaîne

  • isTopLevel

    booléen

loadstart

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

Déclenché au début du chargement.

Paramètres

• rappel

  fonction

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

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

  • url

    chaîne

  • isTopLevel

    booléen

loadstop

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

Déclenché lorsque tous les chargements au niveau du cadre dans 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 de sous-cadre au niveau du document, 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 de un (ou plusieurs) à zéro. Par exemple, si le chargement d'une page est déjà terminé ( 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é. Cette tendance est fréquemment observée sur les pages qui chargent des annonces.

Remarque:Lorsqu'une charge validée est annulée, un événement loadstop finira 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

  fonction

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

  () => void

newwindow

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

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

L'exemple de code suivant permet de créer et de parcourir un nouveau webview dans l'intégrateur 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

  fonction

  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

  • nom

    chaîne

  • windowOpenDisposition

    "ignorer"
     | "save_to_disk"
     | "current_tab"
     | &quot;new_background_tab&quot;
     | "new_foreground_tab"
     | "nouvelle_fenêtre"
     | "new_popup"
    

permissionrequest

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

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

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

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

Paramètres

• rappel

  fonction

  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"
     | "télécharger"
     | "loadplugin"
     | "filesystem"
     | "plein écran"
     | "hid"
    

  • request

    objet

responsive

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

Déclenché lorsque le processus d'affichage du contenu Web de l'invité est devenu de nouveau actif après avoir cessé de répondre.

L'exemple de code suivant permet d'afficher ou de masquer l'élément webview 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

  fonction

  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

  fonction

  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 d'affichage du 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é recommence à répondre.

Paramètres

• rappel

  fonction

  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 niveau de zoom de la page change.

Paramètres

• rappel

  fonction

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

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

  • oldZoomFactor

    Nombre

  • newZoomFactor

    Nombre