chrome.devtools.inspectedWindow

Descrizione

Utilizza l'API chrome.devtools.inspectedWindow per interagire con la finestra ispezionata: ottieni l'ID scheda della pagina ispezionata, valuta il codice nel contesto della finestra ispezionata, ricarica la pagina o ottieni l'elenco delle risorse all'interno della pagina.

Per un'introduzione generale all'utilizzo delle API degli Strumenti per sviluppatori, consulta il riepilogo delle API degli Strumenti per sviluppatori.

La proprietà tabId fornisce l'identificatore della scheda che puoi utilizzare con le chiamate API chrome.tabs.*. Tuttavia, tieni presente che l'API chrome.tabs.* non è esposta alle pagine delle estensioni degli Strumenti per sviluppatori per motivi di sicurezza. Dovrai passare l'ID scheda alla pagina di sfondo e richiamare le funzioni API chrome.tabs.* da lì.

Il metodo reload può essere utilizzato per ricaricare la pagina ispezionata. Inoltre, il chiamante può specificare una sostituzione per la stringa dello user agent, uno script che verrà inserito all'inizio del caricamento pagina o un'opzione per forzare il ricaricamento delle risorse memorizzate nella cache.

Utilizza la chiamata getResources e l'evento onResourceContent per ottenere l'elenco delle risorse (documenti, fogli di stile, script, immagini e così via) all'interno della pagina ispezionata. I metodi getContent e setContent della classe Resource, insieme all'evento onResourceContentCommitted, possono essere utilizzati per supportare la modifica dei contenuti delle risorse, ad esempio da un editor esterno.

Manifest

Per utilizzare questa API, è necessario dichiarare le seguenti chiavi nel manifest.

"devtools_page"

Esegui il codice nella finestra ispezionata

Il metodo eval consente alle estensioni di eseguire codice JavaScript nel contesto della pagina ispezionata. Questo metodo è efficace se utilizzato nel contesto giusto e pericoloso se utilizzato in modo inappropriato. Utilizza il metodo tabs.executeScript a meno che tu non abbia bisogno della funzionalità specifica fornita dal metodo eval.

Di seguito sono riportate le principali differenze tra i metodi eval e tabs.executeScript:

  • Il metodo eval non utilizza un mondo isolato per il codice valutato, quindi il codice può accedere allo stato JavaScript della finestra ispezionata. Utilizza questo metodo quando è necessario accedere allo stato JavaScript della pagina ispezionata.
  • Il contesto di esecuzione del codice valutato include l'API della console degli Strumenti per sviluppatori. Ad esempio, il codice può utilizzare inspect e $0.
  • Il codice valutato può restituire un valore che viene passato al callback dell'estensione. Il valore restituito deve essere un oggetto JSON valido (può contenere solo tipi JavaScript primitivi e riferimenti aciclici ad altri oggetti JSON). Presta particolare attenzione all'elaborazione dei dati ricevuti dalla pagina ispezionata: il contesto di esecuzione è essenzialmente controllato dalla pagina ispezionata; una pagina dannosa può influire sui dati restituiti all'estensione.

Tieni presente che una pagina può includere più contesti di esecuzione JavaScript diversi. Ogni frame ha il proprio contesto, oltre a un contesto aggiuntivo per ogni estensione che esegue script di contenuti in quel frame.

Per impostazione predefinita, il metodo eval viene eseguito nel contesto del frame principale della pagina ispezionata.

Il metodo eval accetta un secondo argomento facoltativo che puoi utilizzare per specificare il contesto in cui viene valutato il codice. Questo oggetto options può contenere una o più delle seguenti chiavi:

frameURL
Utilizza per specificare un frame diverso dal frame principale della pagina ispezionata.
contextSecurityOrigin
Utilizza per selezionare un contesto all'interno del frame specificato in base alla sua origine web.
useContentScriptContext
Se il valore è true, esegui lo script nello stesso contesto degli script di contenuti dell'estensione. (Equivalente a specificare l'origine web dell'estensione come origine di sicurezza del contesto.) Può essere utilizzato per scambiare dati con lo script di contenuti.

Esempi

Il seguente codice verifica la versione di jQuery utilizzata dalla pagina ispezionata:

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

Per provare questa API, installa gli esempi di API degli Strumenti per sviluppatori dal repository chrome-extension-samples.

Tipi

Resource

Una risorsa all'interno della pagina ispezionata, ad esempio un documento, uno script o un'immagine.

Proprietà

  • url

    stringa

    L'URL della risorsa.

  • getContent

    void

    Ottiene i contenuti della risorsa.

    La funzione getContent ha il seguente aspetto: 

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

    • callback

      funzione

      Il parametro callback ha il seguente aspetto: 

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

      • content

        stringa

        Contenuti della risorsa (potenzialmente codificati).

      • encoding

        stringa

        Vuoto se i contenuti non sono codificati, altrimenti nome della codifica. Al momento è supportata solo la codifica base64.

  • setContent

    void

    Imposta i contenuti della risorsa.

    La funzione setContent ha il seguente aspetto: 

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

    • content

      stringa

      Nuovi contenuti della risorsa. Al momento sono supportate solo le risorse di tipo testo.

    • commit

      booleano

      True se l'utente ha terminato di modificare la risorsa e i nuovi contenuti della risorsa devono essere mantenuti; false se si tratta di una modifica minore inviata durante la modifica della risorsa da parte dell'utente.

    • callback

      funzione facoltativa

      Il parametro callback ha il seguente aspetto: 

      (error?: object) => void

      • error

        oggetto facoltativo

        Impostato su undefined se i contenuti della risorsa sono stati impostati correttamente; altrimenti descrive l'errore.

Proprietà

tabId

L'ID della scheda ispezionata. Questo ID può essere utilizzato con chrome.tabs.* API.

Tipo

numero

Metodi

eval()

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

Valuta un'espressione JavaScript nel contesto del frame principale della pagina ispezionata. L'espressione deve restituire un oggetto conforme a JSON, altrimenti viene generata un'eccezione. La funzione eval può segnalare un errore lato Strumenti per sviluppatori o un'eccezione JavaScript che si verifica durante la valutazione. In entrambi i casi, il parametro result del callback è undefined. In caso di errore lato Strumenti per sviluppatori, il isException parametro non è null e ha isError impostato su true e code impostato su un codice di errore. In caso di errore JavaScript, isException è impostato su true e value è impostato sul valore stringa dell'oggetto generato.

Parametri

  • expression

    stringa

    Un'espressione da valutare.

  • options

    oggetto facoltativo

    Il parametro options può contenere una o più opzioni.

    • frameURL

      stringa facoltativa

      Se specificato, l'espressione viene valutata nell'iframe il cui URL corrisponde a quello specificato. Per impostazione predefinita, l'espressione viene valutata nel frame principale della pagina ispezionata.

    • scriptExecutionContext

      stringa facoltativa

      Chrome 107+

      Valuta l'espressione nel contesto di uno script di contenuti di un'estensione che corrisponde all'origine specificata. Se specificato, scriptExecutionContext sostituisce l'impostazione "true" di useContentScriptContext.

    • useContentScriptContext

      booleano facoltativo

      Valuta l'espressione nel contesto dello script di contenuti dell'estensione chiamante, a condizione che lo script di contenuti sia già inserito nella pagina ispezionata. In caso contrario, l'espressione non viene valutata e il callback viene richiamato con il parametro exception impostato su un oggetto con il campo isError impostato su true e il campo code impostato su E_NOTFOUND.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

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

    • result

      oggetto

      Il risultato della valutazione.

    • exceptionInfo

      oggetto

      Un oggetto che fornisce dettagli se si è verificata un'eccezione durante la valutazione dell'espressione.

      • code

        stringa

        Impostato se l'errore si è verificato lato Strumenti per sviluppatori prima della valutazione dell'espressione.

      • description

        stringa

        Impostato se l'errore si è verificato lato Strumenti per sviluppatori prima della valutazione dell'espressione.

      • details

        any[]

        Impostato se l'errore si è verificato lato Strumenti per sviluppatori prima della valutazione dell'espressione, contiene l'array dei valori che possono essere sostituiti nella stringa di descrizione per fornire maggiori informazioni sulla causa dell'errore.

      • isError

        booleano

        Impostato se l'errore si è verificato lato Strumenti per sviluppatori prima della valutazione dell'espressione.

      • isException

        booleano

        Impostato se il codice valutato genera un'eccezione non gestita.

      • value

        stringa

        Impostato se il codice valutato genera un'eccezione non gestita.

getResources()

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

Recupera l'elenco delle risorse dalla pagina ispezionata.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (resources: Resource[]) => void

    • resources

      Resource[]

      Le risorse all'interno della pagina.

reload()

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

Ricarica la pagina ispezionata.

Parametri

  • reloadOptions

    oggetto facoltativo

    • ignoreCache

      booleano facoltativo

      Se il valore è true, il caricatore ignorerà la cache per tutte le risorse della pagina ispezionata caricate prima dell'attivazione dell'evento load. L'effetto è simile a quello di premere Ctrl+Maiusc+R nella finestra ispezionata o nella finestra degli Strumenti per sviluppatori.

    • injectedScript

      stringa facoltativa

      Se specificato, lo script verrà inserito in ogni frame della pagina ispezionata immediatamente dopo il caricamento, prima di qualsiasi script del frame. Lo script non verrà inserito dopo i ricaricamenti successivi, ad esempio se l'utente preme Ctrl+R.

    • userAgent

      stringa facoltativa

      Se specificata, la stringa sostituirà il valore dell'intestazione HTTP User-Agent inviata durante il caricamento delle risorse della pagina ispezionata. La stringa sostituirà anche il valore della proprietà navigator.userAgent restituita a tutti gli script in esecuzione nella pagina ispezionata.

Eventi

onResourceAdded

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

Attivato quando viene aggiunta una nuova risorsa alla pagina ispezionata.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (resource: Resource) => void

onResourceContentCommitted

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

Attivato quando viene eseguito il commit di una nuova revisione della risorsa (ad es. l'utente salva una versione modificata della risorsa negli Strumenti per sviluppatori).

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

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