chrome.devtools.inspectedWindow

Description

Utilisez l'API chrome.devtools.inspectedWindow pour interagir avec la fenêtre inspectée : obtenez l'ID de l'onglet de la page inspectée, évaluez le code dans le contexte de la fenêtre inspectée, rechargez la page ou obtenez la liste des ressources de la page.

Consultez Résumé des API DevTools pour obtenir une introduction générale à l'utilisation des API des outils de développement.

La propriété tabId fournit l'identifiant d'onglet que vous pouvez utiliser avec les appels d'API chrome.tabs.*. Toutefois, veuillez noter que l'API chrome.tabs.* n'est pas exposée aux pages de l'extension Outils pour les développeurs pour des raisons de sécurité. Vous devrez transmettre l'ID de l'onglet à la page d'arrière-plan et y appeler les fonctions de l'API chrome.tabs.*.

La méthode reload peut être utilisée pour recharger la page inspectée. L'appelant peut également spécifier un forçage pour la chaîne de l'agent utilisateur, un script qui sera injecté tôt lors du chargement de page ou une option permettant de forcer l'actualisation des ressources mises en cache.

Utilisez l'appel getResources et l'événement onResourceContent pour obtenir la liste des ressources (documents, feuilles de style, scripts, images, etc.) de la page inspectée. Les méthodes getContent et setContent de la classe Resource, ainsi que l'événement onResourceContentCommitted, peuvent être utilisées pour permettre la modification du contenu de la ressource, par exemple par un éditeur externe.

Fichier manifeste

Les clés suivantes doivent être déclarées dans le fichier manifeste pour utiliser cette API.

"devtools_page"

Exécuter du code dans la fenêtre inspectée

La méthode eval permet aux extensions d'exécuter du code JavaScript dans le contexte de la page inspectée. Cette méthode est puissante lorsqu'elle est utilisée dans le bon contexte et dangereuse lorsqu'elle est utilisée de manière inappropriée. Utilisez la méthode tabs.executeScript, sauf si vous avez besoin de la fonctionnalité spécifique fournie par la méthode eval.

Voici les principales différences entre les méthodes eval et tabs.executeScript :

  • La méthode eval n'utilise pas de monde isolé pour le code évalué. L'état JavaScript de la fenêtre inspectée est donc accessible au code. Utilisez cette méthode lorsque vous avez besoin d'accéder à l'état JavaScript de la page inspectée.
  • Le contexte d'exécution du code en cours d'évaluation inclut l'API de la console des outils de développement. Par exemple, le code peut utiliser inspect et $0.
  • Le code évalué peut renvoyer une valeur qui est transmise au rappel d'extension. La valeur renvoyée doit être un objet JSON valide (elle ne peut contenir que des types JavaScript primitifs et des références acycliques à d'autres objets JSON). Veuillez faire très attention lorsque vous traitez les données reçues de la page inspectée. Le contexte d'exécution est essentiellement contrôlé par la page inspectée. Une page malveillante peut affecter les données renvoyées à l'extension.

Notez qu'une page peut inclure plusieurs contextes d'exécution JavaScript différents. Chaque frame possède son propre contexte, ainsi qu'un contexte supplémentaire pour chaque extension dont les scripts de contenu s'exécutent dans ce frame.

Par défaut, la méthode eval s'exécute dans le contexte du frame principal de la page inspectée.

La méthode eval accepte un second argument facultatif que vous pouvez utiliser pour spécifier le contexte dans lequel le code est évalué. Cet objet options peut contenir une ou plusieurs des clés suivantes :

frameURL
Utilisez-le pour spécifier un frame autre que le frame principal de la page inspectée.
contextSecurityOrigin
Utilisez-le pour sélectionner un contexte dans le frame spécifié en fonction de son origine Web.
useContentScriptContext
Si la valeur est "true", exécute le script dans le même contexte que les scripts de contenu de l'extension. (Équivaut à spécifier la propre origine Web de l'extension comme origine de sécurité du contexte.) Il peut être utilisé pour échanger des données avec le script de contenu.

Exemples

Le code suivant vérifie la version de jQuery utilisée par la page inspectée :

chrome.devtools.inspectedWindow.eval(
  "jQuery.fn.jquery",
  function(result, isException) {
    if (isException) {
      console.log("the page is not using jQuery");
    } else {
      console.log("The page is using jQuery v" + result);
    }
  }
);

Pour essayer cette API, installez les exemples d'API DevTools à partir du dépôt chrome-extension-samples.

Types

Resource

Ressource de la page inspectée, telle qu'un document, un script ou une image.

Propriétés

  • url

    chaîne

    URL de la ressource.

  • getContent

    vide

    Récupère le contenu de la ressource.

    La fonction getContent se présente comme suit : 

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

    • callback

      fonction

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

      (content: string, encoding: string) => void

      • contenu

        chaîne

        Contenu de la ressource (potentiellement encodé).

      • encoding

        chaîne

        Vide si le contenu n'est pas encodé, nom de l'encodage dans le cas contraire. Pour le moment, seul le format base64 est accepté.

  • setContent

    vide

    Définit le contenu de la ressource.

    La fonction setContent se présente comme suit : 

    (content: string, commit: boolean, callback?: function) => {...}

    • contenu

      chaîne

      Nouveau contenu de la ressource. Seules les ressources de type texte sont actuellement acceptées.

    • commit

      booléen

      True si l'utilisateur a terminé de modifier la ressource et que le nouveau contenu de la ressource doit être conservé. False s'il s'agit d'une modification mineure envoyée en cours de modification de la ressource par l'utilisateur.

    • callback

      function facultatif

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

      (error?: object) => void

      • erreur

        objet facultatif

        Défini sur "undefined" si le contenu de la ressource a été défini correctement ; décrit l'erreur dans le cas contraire.

Propriétés

tabId

ID de l'onglet inspecté. Cet ID peut être utilisé avec chrome.tabs.* Compute Engine.

Type

nombre

Méthodes

eval()

chrome.devtools.inspectedWindow.eval(
  expression: string,
  options?: object,
  callback?: function,
): void

Évalue une expression JavaScript dans le contexte du frame principal de la page inspectée. L'expression doit être évaluée en tant qu'objet conforme à JSON. Dans le cas contraire, une exception est générée. La fonction eval peut signaler une erreur côté outils de développement ou une exception JavaScript qui se produit lors de l'évaluation. Dans les deux cas, le paramètre result du rappel est undefined. En cas d'erreur côté outils pour les développeurs, le paramètre isException n'est pas nul, et les valeurs isError et code sont respectivement définies sur "true" et sur un code d'erreur. En cas d'erreur JavaScript, isException est défini sur "true" et value est défini sur la valeur de chaîne de l'objet généré.

Paramètres

  • expression

    chaîne

    Expression à évaluer.

  • options

    objet facultatif

    Le paramètre "options" peut contenir une ou plusieurs options.

    • frameURL

      chaîne facultatif

      Si elle est spécifiée, l'expression est évaluée sur l'iFrame dont l'URL correspond à celle spécifiée. Par défaut, l'expression est évaluée dans le frame supérieur de la page inspectée.

    • scriptExecutionContext

      chaîne facultatif

      Chrome 107 et versions ultérieures

      Évalue l'expression dans le contexte d'un script de contenu d'une extension correspondant à l'origine spécifiée. Si elle est fournie, scriptExecutionContext remplace le paramètre "true" de useContentScriptContext.

    • useContentScriptContext

      booléen facultatif

      Évalue l'expression dans le contexte du script de contenu de l'extension appelante, à condition que le script de contenu soit déjà injecté dans la page inspectée. Dans le cas contraire, l'expression n'est pas évaluée et le rappel est appelé avec le paramètre d'exception défini sur un objet dont le champ isError est défini sur "true" et le champ code est défini sur E_NOTFOUND.

  • callback

    function facultatif

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

    (result: object, exceptionInfo: object) => void

    • résultat

      objet

      Résultat de l'évaluation.

    • exceptionInfo

      objet

      Objet fournissant des détails si une exception s'est produite lors de l'évaluation de l'expression.

      • code

        chaîne

        Indique si l'erreur s'est produite du côté des outils de développement avant l'évaluation de l'expression.

      • description

        chaîne

        Indique si l'erreur s'est produite du côté des outils de développement avant l'évaluation de l'expression.

      • détails

        any[]

        Défini si l'erreur s'est produite du côté des outils de développement avant l'évaluation de l'expression. Contient le tableau des valeurs qui peuvent être substituées dans la chaîne de description pour fournir plus d'informations sur la cause de l'erreur.

      • isError

        booléen

        Indique si l'erreur s'est produite du côté des outils de développement avant l'évaluation de l'expression.

      • isException

        booléen

        Défini si le code évalué produit une exception non gérée.

      • valeur

        chaîne

        Défini si le code évalué produit une exception non gérée.

getResources()

chrome.devtools.inspectedWindow.getResources(
  callback: function,
): void

Récupère la liste des ressources de la page inspectée.

Paramètres

  • callback

    fonction

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

    (resources: Resource[]) => void

    • ressources

      Ressource[]

      Ressources de la page.

reload()

chrome.devtools.inspectedWindow.reload(
  reloadOptions?: object,
): void

Actualise la page inspectée.

Paramètres

  • reloadOptions

    objet facultatif

    • ignoreCache

      booléen facultatif

      Si la valeur est "true", le chargeur contourne le cache pour toutes les ressources de page inspectées chargées avant le déclenchement de l'événement load. L'effet est semblable à celui obtenu en appuyant sur Ctrl+Maj+R dans la fenêtre inspectée ou dans la fenêtre des outils pour les développeurs.

    • injectedScript

      chaîne facultatif

      Si spécifié, le script sera injecté dans chaque frame de la page inspectée immédiatement après le chargement, avant tout script du frame. Le script ne sera pas injecté lors des rechargements suivants (par exemple, si l'utilisateur appuie sur Ctrl+R).

    • userAgent

      chaîne facultatif

      Si elle est spécifiée, la chaîne remplacera la valeur de l'en-tête HTTP User-Agent envoyé lors du chargement des ressources de la page inspectée. La chaîne remplacera également la valeur de la propriété navigator.userAgent renvoyée à tous les scripts exécutés sur la page inspectée.

Événements

onResourceAdded

chrome.devtools.inspectedWindow.onResourceAdded.addListener(
  callback: function,
)

Déclenché lorsqu'une nouvelle ressource est ajoutée à la page inspectée.

Paramètres

  • callback

    fonction

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

    (resource: Resource) => void

onResourceContentCommitted

chrome.devtools.inspectedWindow.onResourceContentCommitted.addListener(
  callback: function,
)

Déclenché lorsqu'une nouvelle révision de la ressource est validée (par exemple, lorsqu'un utilisateur enregistre une version modifiée de la ressource dans les outils pour les développeurs).

Paramètres

  • callback

    fonction

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

    (resource: Resource, content: string) => void