chrome.webviewTag

Description

Utilisez la balise webview pour charger activement du contenu en direct à partir du Web sur le réseau et l'intégrer dans 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 dans celle-ci, etc. (voir la section Utilisation).

Autorisations

webview

Types

ClearDataOptions

Options qui déterminent les données à effacer par clearData.

Propriétés

  • depuis

    number facultatif

    Efface les données accumulées à partir de cette date, représentées en millisecondes depuis l'époque (accessibles via la méthode getTime de l'objet JavaScript Date). Si elle est absente, la valeur par défaut est 0 (ce qui supprime 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

  • appcache

    booléen facultatif

    Les 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, l'intégralité du cache est effacée. Cela n'est pas limité à la plage que vous spécifiez.

  • cookies

    booléen facultatif

    Cookies de la partition.

  • fileSystems

    booléen facultatif

    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

    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 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 frame supérieur.

  • css

    InjectionItems facultatif

    Code CSS ou liste de fichiers CSS à injecter dans les pages correspondantes. Ils 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 correspondant à ce glob. Permet d'émuler le mot clé Greasemonkey @exclude.

  • exclude_matches

    string[] facultatif

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

  • include_globs

    string[] facultatif

    S'applique après les correspondances pour n'inclure que les URL qui correspondent également à ce glob. Destiné à émuler le mot clé Greasemonkey @include.

  • js

    InjectionItems facultatif

    Code JavaScript ou liste de fichiers JavaScript à injecter dans les pages correspondantes. Ils sont injectés dans l'ordre dans lequel ils 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 "Correspondances". L'URL d'héritage correspond à l'URL du document ayant créé le frame ou la fenêtre. Les scripts de contenu ne peuvent pas être insérés dans des cadres en bac à sable.

  • correspond à

    chaîne[]

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

  • nom

    chaîne

    Nom du script de contenu à injecter.

  • run_at

    RunAt facultatif

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

ContentWindow

Identificateur de messagerie pour une fenêtre invitée.

Propriétés

  • postMessage

    vide

    Publie un message dans le contenu Web intégré tant que le contenu intégré affiche une page 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'utilisateur invité pourra envoyer des réponses à l'intégrateur en publiant un message sur event.source lors de l'événement de message qu'il reçoit.

    Cette API est identique à l'API postMessage HTML5 pour la communication entre les pages Web. L'intégrateur 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 du message à envoyer à l'invité.

    • targetOrigin

      chaîne

      Indique l'origine de la fenêtre invitée pour que l'événement soit distribué.

ContextMenuCreateProperties

Chrome 44 ou version ultérieure

Propriétés

  • coché

    booléen facultatif

    État initial d'une case à cocher ou d'un bouton d'option : "true" pour la case cochée et "false" pour la case non cochée. Vous ne pouvez sélectionner qu'un seul élément radio à la fois dans un groupe donné.

  • contexts

    [ContextType, ...ContextType[]] facultatif

    Liste des contextes dans lesquels cet élément de menu s'affichera. Si ce champ n'est pas spécifié, la valeur par défaut est ['page'].

  • documentUrlPatterns

    string[] facultatif

    Permet de limiter l'élément à n'appliquer qu'aux documents dont l'URL correspond à l'un des formats donnés. (Cela s'applique également aux cadres.) Pour en savoir plus sur le format d'un modèle, 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

    chaîne facultatif

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

  • parentId

    chaîne | nombre facultatif

    ID d'un élément de menu parent, ce qui en fait un enfant d'un élément précédemment ajouté.

  • targetUrlPatterns

    string[] facultatif

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

  • titre

    chaîne facultatif

    Texte à afficher dans l'élément. Obligatoire, sauf si type est défini sur "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 "Traduire "%s" en langage argotique" et que l'utilisateur sélectionne le mot "cool", l'élément du menu contextuel correspondant est "Traduire "cool" en langage argotique".

  • type

    ItemType facultatif

    Type d'élément de menu. La valeur par défaut est "normal" si aucune valeur n'est spécifiée.

  • onclick

    void facultatif

    Fonction qui sera appelée en cas de clic 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 sur le contexte dans lequel le clic s'est produit.

ContextMenus

Chrome 44 ou version ultérieure

Propriétés

  • onShow

    Event<functionvoidvoid>

    Déclenché avant l'affichage d'un menu contextuel sur cette webview. Peut être utilisé pour 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 cette méthode 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 qu'en cas d'erreur lors de la création, vous ne le saurez peut-être 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

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

    • rappel

      fonction facultatif

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

      () => void

    • retours

      chaîne | nombre

      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

      chaîne | nombre

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

    • rappel

      fonction facultatif

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

      () => void

  • removeAll

    vide

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

    La fonction removeAll se présente comme suit : 

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

    • rappel

      fonction 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

      chaîne | nombre

      ID de l'article à mettre à jour.

    • updateProperties

      objet

      Propriétés à mettre à jour. Accepte les mêmes valeurs que la fonction de création.

    • rappel

      fonction facultatif

      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'un bouton radio : "true" pour la case cochée et "false" pour la case non cochée. Vous ne pouvez sélectionner qu'un seul élément radio à la fois dans un groupe donné.

  • contexts

    [ContextType, ...ContextType[]] facultatif

    Liste des contextes dans lesquels cet élément de menu s'affichera.

  • documentUrlPatterns

    string[] facultatif

    Permet de limiter l'élément à ne s'appliquer qu'aux documents dont l'URL correspond à l'un des formats donnés. (Cela s'applique également aux cadres.) Pour en savoir plus sur le format d'un modèle, 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

    ID d'un élément de menu parent, ce qui en fait un enfant d'un élément précédemment ajouté. Remarque:Vous ne pouvez pas définir un élément comme enfant de l'un de ses propres descendants.

  • targetUrlPatterns

    string[] facultatif

    Semblable à "documentUrlPatterns", mais vous permet de filtrer en fonction de l'attribut src des balises img/audio/video et de l'attribut 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

    void facultatif

    Fonction qui sera appelée en cas de clic 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 sur le contexte dans lequel le clic s'est produit.

ContextType

Chrome 44 ou version ultérieure

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

Énumération

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

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

Propriétés

  • annuler

    vide

    Refuser la boîte de dialogue. É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. É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'utilisateur invité lors de l'acceptation d'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

    Refuser 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

    Refuser 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

    Numéro ordinal de la correspondance actuelle.

  • annulée

    booléen

    Indique si cette requête de recherche a été annulée.

  • numberOfMatches

    Nombre

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

  • selectionRect

    SelectionRect

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

FindOptions

Options de la requête de recherche.

Propriétés

  • arrière

    booléen facultatif

    Indicateur permettant de trouver les correspondances dans l'ordre inverse. La valeur par défaut est false.

  • matchCase

    booléen facultatif

    Indicateur de correspondance sensible à 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 ayant déclenché la requête plein écran.

  • allow

    vide

    Autorisez la demande d'autorisation.

    La fonction allow se présente comme suit : 

    () => {...}

  • deny

    vide

    Refuser 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

    Refuser 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 et versions ultérieures

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

    Refuser 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 le code ou la propriété de fichier, mais pas les deux en même temps.

Propriétés

  • code

    chaîne facultatif

    Code JavaScript ou CSS à injecter.

    Avertissement:Utilisez le paramètre code avec précaution. Une utilisation incorrecte peut exposer votre application à des attaques de scripts intersites.

  • fichier

    chaîne 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

    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. Ils sont injectés dans l'ordre dans lequel ils apparaissent dans ce 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

    Refuser 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

    Refuser 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

  • 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 fenêtre.

    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 requête était le client le plus récent à verrouiller le pointeur.

  • url

    chaîne

    URL du frame demandant le verrouillage du pointeur.

  • userGesture

    booléen

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

  • allow

    vide

    Autorisez la demande d'autorisation.

    La fonction allow se présente comme suit : 

    () => {...}

  • deny

    vide

    Refuser 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 d'écran.

La sémantique de la structuration est semblable à celle d'un tableau. Autrement dit, la coordonnée (left, top) est considérée comme contenue par 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 44 ou version ultérieure

Interface qui permet d'accéder aux événements webRequest sur la page invitée. Pour en savoir plus sur le cycle de vie de webRequest et les concepts associés, consultez l'API d'extensions chrome.webRequest. Remarque: L'événement chrome.webRequest.onActionIgnored n'est pas compatible avec les WebView.

Pour illustrer les différences d'utilisation avec l'API webRequest des extensions, considérez l'exemple de code suivant, qui bloque toutes les requêtes invitées 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 est compatible avec 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 pour les requêtes Web de WebView déclaratives doivent être instanciées à partir de leurs homologues 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 façon dont le zoom est géré dans le webview.

Énumération

"par origine"
Les modifications de zoom persistent dans l'origine de la page agrandie. Autrement dit, toutes les autres vues Web de la même partition qui accèdent à cette même origine seront également agrandies. De plus, les modifications de zoom per-origin sont enregistrées avec l'origine. Par conséquent, lorsque vous accédez à d'autres pages de la même origine, elles sont toutes mises à l'échelle avec le même facteur de zoom.

"par vue"
Les modifications de zoom ne prennent effet que dans cette WebView, et les modifications de zoom dans d'autres WebView n'affectent pas le zoom de cette WebView. De plus, les modifications de zoom per-view sont réinitialisées lors de la navigation. La navigation dans une vue Web charge toujours les pages avec leurs facteurs de zoom par origine (dans le champ d'application de la partition).

"disabled"
Désactive tout zoom dans la vue Web. Le contenu revient au niveau de zoom par défaut, et toutes les tentatives de modification du zoom sont ignorées.

Propriétés

contentWindow

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

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 les options ajoutées au menu contextuel s'appliquent, comme les images, les liens hypertextes et les pages.

Type

ContextMenus

request

Interface qui permet d'accéder aux événements webRequest sur la page invitée.

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 ou modifier des règles de manière programmatique.

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 deviez 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 accédé à l'origine (par exemple, foo.com) et appelle webview.addContentScripts pour ajouter "myRule", vous devez attendre la prochaine navigation pour que les scripts soient injectés. Si vous souhaitez une injection immédiate, executeScript s'en chargera.

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

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

Paramètres

back()

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

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

Paramètres

  • rappel

    fonction facultatif

    Chrome 44 ou version 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 si vous pouvez ou non revenir en arrière dans l'historique. L'état de cette fonction est mis en cache et mis à jour avant chaque loadcommit. Il est donc préférable de l'appeler sur loadcommit.

Renvoie

  • booléen

canGoForward()

chrome.webviewTag.canGoForward()

Indique si il est possible de faire défiler l'historique vers l'avant. L'état de cette fonction est mis en cache et mis à jour avant chaque loadcommit. Il est donc préférable de l'appeler sur loadcommit.

Renvoie

  • booléen

captureVisibleRegion()

Chrome 50 et versions ultérieures 
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)

Capture la région visible de la 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é à la propriété "src" d'un élément Image HTML pour l'affichage.

clearData()

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

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

Paramètres

  • Options permettant de déterminer les données à effacer.

  • Types de données à effacer.

  • rappel

    fonction facultatif

    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 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 requête de recherche dans la page.

Paramètres

  • searchText

    chaîne

    Chaîne à rechercher dans la page.

  • options

    FindOptions facultatif

    Options de la requête de recherche.

  • rappel

    fonction 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, par exemple si le rappel n'est utilisé que pour déterminer quand la requête de recherche est terminée.

forward()

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

Si possible, fait défiler l'historique d'une entrée. Équivaut à go(1).

Paramètres

  • rappel

    fonction facultatif

    Chrome 44 ou version 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 62 ou version ultérieure 
chrome.webviewTag.getAudioState(
  callback: function,
)

Interroge l'état audio.

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 partagent 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 de l'ID de processus actuel par l'intégrateur. L'ID de processus n'est pas identique à l'ID 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 pages invitées.

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 de webview.

go()

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

Accédez à une entrée de l'historique à l'aide d'un indice d'historique par rapport à 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 auquel webview doit être dirigé. Par exemple, une valeur de 2 permet de faire défiler l'historique de deux entrées vers l'avant, si possible. Une valeur de -3 permet de faire défiler l'historique de trois entrées vers l'arrière.

  • rappel

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

Injecte du CSS dans la page invité.

Paramètres

  • détails

    InjectDetails

    Informations sur le CSS à insérer.

  • rappel

    fonction facultatif

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

    () => void

isAudioMuted()

Chrome 62 ou version ultérieure 
chrome.webviewTag.isAudioMuted(
  callback: function,
)

Indique 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 et versions ultérieures 
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

Indique 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 d'agent utilisateur 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 à afficher à l'utilisateur à la place de l'URL de données.

Paramètres

  • dataUrl

    chaîne

    URL des données à charger.

  • baseUrl

    chaîne

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

  • virtualUrl

    chaîne facultatif

    URL qui s'affichera auprès de l'utilisateur (dans la barre d'adresse).

print()

chrome.webviewTag.print()

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

reload()

chrome.webviewTag.reload()

Actualise la page racine 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 "myRule", qui a été ajouté précédemment.

webview.removeContentScripts(['myRule']);

Vous pouvez supprimer toutes les règles en appelant:

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 de désactivation du son de la WebView.

Paramètres

  • couper le son

    booléen

    Valeur de la coupure du 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é

    booléen

    Valeur d'état de la navigation spatiale.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

Forcez la chaîne user-agent utilisée par webview pour les requêtes de pages invitées. En cas de forçage, les valeurs de l'en-tête User-Agent Client Hint et les valeurs renvoyées par navigator.userAgentData seront vides pour les requêtes de page invitée auxquelles ce forçage s'applique.

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. Le champ d'application et la persistance de cette modification sont déterminés par le mode de zoom actuel de la WebView (voir webviewTag.ZoomMode).

Paramètres

  • zoomFactor

    Nombre

    Nouveau facteur de zoom.

  • rappel

    fonction 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 l'webview.

Paramètres

  • ZoomMode

    ZoomMode

    Définit la gestion du zoom dans webview.

  • rappel

    fonction facultatif

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

    () => void

stop()

chrome.webviewTag.stop()

Arrête le chargement de la navigation webview en cours, le cas échéant.

stopFinding()

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

Met fin à la session de recherche en cours (en effaçant toutes les mises en surbrillance) et annule toutes les requêtes de recherche en cours.

Paramètres

  • action

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

    Détermine la procédure à suivre pour la correspondance active une fois la session de recherche terminée. clear supprime la mise en surbrillance de la correspondance active. keep conserve la mise en surbrillance de la correspondance active. activate conserve la mise en surbrillance de la correspondance active et simule un clic de l'utilisateur sur cette correspondance. L'action par défaut est keep.

terminate()

chrome.webviewTag.terminate()

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

L'exemple de code suivant transfère tous les messages de journalisation vers la console de l'intégrateur, sans tenir compte du niveau de journalisation ni d'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 invitée déclenche un événement load, c'est-à-dire lorsqu'un nouveau document est chargé. Cela n'inclut pas la navigation 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'utilisateur 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ée 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énement renvoie ou que l'objet dialog devienne inaccessible (si preventDefault() a été appelé).

Le comportement par défaut consiste à fermer 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

      "alert"
       | "confirm"
       | "prompt"

    • messageText

      chaîne

    • boîte de dialogue

      DialogController

exit

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

Déclenché lorsque le processus de rendu du contenu Web invité a terminé.

L'exemple de code suivant affiche un message d'adieu chaque fois que la page invité plante:

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"
       | "abnormal"
       | "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 à mesure que 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'une charge de niveau supérieur a été interrompue sans validation. Un message d'erreur s'affiche dans la console, sauf si l'événement est bloqué par défaut.

Remarque:Lorsqu'une charge de ressources est interrompue, un événement loadabort est éventuellement suivi d'un événement loadstop, même si toutes les charges validées depuis le dernier événement loadstop (le cas échéant) ont été interrompues.

Remarque:Lorsque le chargement d'une URL "about" ou d'une URL JavaScript est interrompu, 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"
       | "ERR_INVALID_URL"
       | "ERR_DISALLOWED_URL_SCHEME"
       | "ERR_BLOCKED_BY_CLIENT"
       | "ERR_ADDRESS_UNREACHABLE"
       | "ERR_EMPTY_RESPONSE"
       | "ERR_FILE_NOT_FOUND"
       | "ERR_UNKNOWN_URL_SCHEME"

loadcommit

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

Déclenché lorsqu'une charge a été validée. Cela inclut la navigation dans le document actuel, ainsi que les chargements au niveau du document des sous-cadres, 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 niveau supérieur a redirigé 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é lorsqu'un chargement a commencé.

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 toutes les charges au niveau des cadres d'une page invitée (y compris tous ses sous-cadres) sont terminées. Cela inclut la navigation dans le document actuel, ainsi que les chargements au niveau du document des sous-cadres, 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 plus) à zéro. Par exemple, si une page qui a déjà fini de se charger (c'est-à-dire, loadstop déjà déclenché une fois) crée un nouvel iFrame qui charge une page, puis un deuxième loadstop se déclenche lorsque le chargement de la page de l'iFrame est terminé. Ce modèle est couramment observé sur les pages qui chargent des annonces.

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

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 invité tente d'ouvrir une nouvelle fenêtre de navigateur.

L'exemple de code suivant crée et parcourt un nouvel élément webview 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

    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

      "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 à l'intégrateur.

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

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"
       | "download"
       | "loadplugin"
       | "filesystem"
       | "fullscreen"
       | "hid"

    • request

      objet

responsive

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

Déclenché lorsque le processus de rendu du contenu Web invité est à nouveau réactif après avoir été non réactif.

L'exemple de code suivant fera apparaître ou disparaître l'élément webview lorsqu'il devient ou cesse de répondre:

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. Ne se déclenche que 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 qui affiche le contenu Web invité ne répond plus. Cet événement sera généré une fois avec un événement de réponse correspondant si l'invité commence à répondre à nouveau.

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

Se déclenche lorsque le 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