chrome.devtools.inspectedWindow

Deskripsi

Gunakan chrome.devtools.inspectedWindow API untuk berinteraksi dengan jendela yang diperiksa: dapatkan ID tab untuk halaman yang diperiksa, evaluasi kode dalam konteks jendela yang diperiksa, muat ulang halaman, atau dapatkan daftar resource dalam halaman.

Lihat ringkasan DevTools API untuk pengantar umum tentang penggunaan API Alat Developer.

Properti tabId memberikan ID tab yang dapat Anda gunakan dengan panggilan chrome.tabs.* API. Namun, perhatikan bahwa chrome.tabs.* API tidak diekspos ke halaman ekstensi Alat Developer karena pertimbangan keamanan—Anda harus meneruskan ID tab ke halaman latar belakang dan memanggil fungsi chrome.tabs.* API dari sana.

Metode reload dapat digunakan untuk memuat ulang halaman yang diperiksa. Selain itu, pemanggil dapat menentukan penggantian untuk string agen pengguna, skrip yang akan dimasukkan lebih awal saat halaman dimuat, atau opsi untuk memuat ulang resource yang di-cache secara paksa.

Gunakan panggilan getResources dan peristiwa onResourceContent untuk mendapatkan daftar resource (dokumen, stylesheet, skrip, gambar, dll.) dalam halaman yang diperiksa. The getContent and setContent methods of the Resource class along with the onResourceContentCommitted event may be used to support modification of the resource content, for example, by an external editor.

Manifes

Kunci berikut harus dideklarasikan dalam manifes untuk menggunakan API ini.

"devtools_page"

Menjalankan kode di jendela yang diperiksa

Metode eval memberikan kemampuan bagi ekstensi untuk menjalankan kode JavaScript dalam konteks halaman yang diperiksa. Metode ini sangat berguna jika digunakan dalam konteks yang tepat dan berbahaya jika digunakan dengan tidak tepat. Gunakan metode tabs.executeScript kecuali jika Anda memerlukan fungsi spesifik yang disediakan oleh metode eval.

Berikut adalah perbedaan utama antara metode eval dan tabs.executeScript:

  • Metode eval tidak menggunakan dunia terisolasi untuk kode yang dievaluasi, sehingga status JavaScript dari jendela yang diperiksa dapat diakses oleh kode. Gunakan metode ini jika akses ke status JavaScript halaman yang diperiksa diperlukan.
  • Konteks eksekusi kode yang dievaluasi mencakup API konsol Alat Developer. Misalnya, kode dapat menggunakan inspect dan $0.
  • Kode yang dievaluasi dapat menampilkan nilai yang diteruskan ke callback ekstensi. Nilai yang ditampilkan harus berupa objek JSON yang valid (hanya dapat berisi jenis JavaScript primitif dan referensi asiklik ke objek JSON lainnya). Harap berhati-hati saat memproses data yang diterima dari halaman yang diperiksa—konteks eksekusi pada dasarnya dikontrol oleh halaman yang diperiksa; halaman berbahaya dapat memengaruhi data yang ditampilkan ke ekstensi.

Perhatikan bahwa halaman dapat menyertakan beberapa konteks eksekusi JavaScript yang berbeda. Setiap frame memiliki konteksnya sendiri, ditambah konteks tambahan untuk setiap ekstensi yang memiliki skrip konten yang berjalan dalam frame tersebut.

Secara default, metode eval dijalankan dalam konteks frame utama halaman yang diperiksa.

Metode eval menggunakan argumen kedua opsional yang dapat Anda gunakan untuk menentukan konteks tempat kode dievaluasi. Objek options ini dapat berisi satu atau beberapa kunci berikut:

frameURL
Gunakan untuk menentukan frame selain frame utama halaman yang diperiksa.
contextSecurityOrigin
Gunakan untuk memilih konteks dalam frame yang ditentukan sesuai dengan asal web-nya.
useContentScriptContext
Jika benar (true), jalankan skrip dalam konteks yang sama dengan skrip konten ekstensi. (Setara dengan menentukan asal web ekstensi sendiri sebagai asal keamanan konteks.) Hal ini dapat digunakan untuk bertukar data dengan skrip konten.

Contoh

Kode berikut memeriksa versi jQuery yang digunakan oleh halaman yang diperiksa:

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

Untuk mencoba API ini, instal contoh API alat developer dari repositori chrome-extension-samples.

Jenis

Resource

Resource dalam halaman yang diperiksa, seperti dokumen, skrip, atau gambar.

Properti

  • url

    string

    URL resource.

  • getContent

    void

    Mendapatkan konten resource.

    Fungsi getContent terlihat seperti: 

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

    • callback

      fungsi

      Parameter callback terlihat seperti: 

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

      • konten

        string

        Konten resource (berpotensi dienkode).

      • encoding

        string

        Kosong jika konten tidak dienkode, nama encoding jika tidak. Saat ini, hanya base64 yang didukung.

  • setContent

    void

    Menetapkan konten resource.

    Fungsi setContent terlihat seperti: 

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

    • konten

      string

      Konten baru resource. Saat ini, hanya resource dengan jenis teks yang didukung.

    • commit

      boolean

      Benar (true) jika pengguna telah selesai mengedit resource, dan konten baru resource harus dipertahankan; salah (false) jika ini adalah perubahan kecil yang dikirim saat pengguna mengedit resource.

    • callback

      fungsi opsional

      Parameter callback terlihat seperti: 

      (error?: object) => void

      • error

        objek opsional

        Ditetapkan ke undefined jika konten resource berhasil ditetapkan; jika tidak, akan menjelaskan error.

Properti

tabId

ID tab yang sedang diperiksa. ID ini dapat digunakan dengan chrome.tabs.* API.

Jenis

angka

Metode

eval()

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

Mengevaluasi ekspresi JavaScript dalam konteks frame utama halaman yang diperiksa. Ekspresi harus dievaluasi ke objek yang sesuai dengan JSON, jika tidak, pengecualian akan ditampilkan. Fungsi eval dapat melaporkan error sisi Alat Developer atau pengecualian JavaScript yang terjadi selama evaluasi. Dalam kedua kasus tersebut, parameter result callback adalah undefined. Jika terjadi error sisi Alat Developer, parameter isException tidak null dan memiliki isError yang ditetapkan ke benar (true) dan code ditetapkan ke kode error. Jika terjadi error JavaScript, isException ditetapkan ke benar (true) dan value ditetapkan ke nilai string objek yang ditampilkan.

Parameter

  • ekspresi

    string

    Ekspresi yang akan dievaluasi.

  • opsi

    objek opsional

    Parameter opsi dapat berisi satu atau beberapa opsi.

    • frameURL

      string opsional

      Jika ditentukan, ekspresi akan dievaluasi pada iframe yang URL-nya cocok dengan yang ditentukan. Secara default, ekspresi dievaluasi di frame teratas halaman yang diperiksa.

    • scriptExecutionContext

      string opsional

      Chrome 107+

      Evaluasi ekspresi dalam konteks skrip konten ekstensi yang cocok dengan asal yang ditentukan. Jika diberikan, scriptExecutionContext akan mengganti setelan 'benar' pada useContentScriptContext.

    • useContentScriptContext

      boolean opsional

      Evaluasi ekspresi dalam konteks skrip konten ekstensi panggilan, asalkan skrip konten sudah dimasukkan ke halaman yang diperiksa. Jika tidak, ekspresi tidak dievaluasi dan callback dipanggil dengan parameter pengecualian yang ditetapkan ke objek yang memiliki kolom isError yang ditetapkan ke benar (true) dan kolom code yang ditetapkan ke E_NOTFOUND.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

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

    • hasil

      objek

      Hasil evaluasi.

    • exceptionInfo

      objek

      Objek yang memberikan detail jika terjadi pengecualian saat mengevaluasi ekspresi.

      • kode

        string

        Ditetapkan jika error terjadi di sisi Alat Developer sebelum ekspresi dievaluasi.

      • deskripsi

        string

        Ditetapkan jika error terjadi di sisi Alat Developer sebelum ekspresi dievaluasi.

      • detail

        any[]

        Ditetapkan jika error terjadi di sisi Alat Developer sebelum ekspresi dievaluasi, berisi array nilai yang dapat diganti ke dalam string deskripsi untuk memberikan informasi selengkapnya tentang penyebab error.

      • isError

        boolean

        Ditetapkan jika error terjadi di sisi Alat Developer sebelum ekspresi dievaluasi.

      • isException

        boolean

        Ditetapkan jika kode yang dievaluasi menghasilkan pengecualian yang tidak tertangani.

      • nilai

        string

        Ditetapkan jika kode yang dievaluasi menghasilkan pengecualian yang tidak tertangani.

getResources()

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

Mengambil daftar resource dari halaman yang diperiksa.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (resources: Resource[]) => void

    • resource

      Resource[]

      Resource dalam halaman.

reload()

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

Memuat ulang halaman yang diperiksa.

Parameter

  • reloadOptions

    objek opsional

    • ignoreCache

      boolean opsional

      Jika benar (true), loader akan melewati cache untuk semua resource halaman yang diperiksa yang dimuat sebelum peristiwa load diaktifkan. Efeknya mirip dengan menekan Ctrl+Shift+R di jendela yang diperiksa atau dalam jendela Alat Developer.

    • injectedScript

      string opsional

      Jika ditentukan, skrip akan dimasukkan ke setiap frame halaman yang diperiksa segera setelah dimuat, sebelum skrip frame mana pun. Skrip tidak akan dimasukkan setelah pemuatan ulang berikutnya—misalnya, jika pengguna menekan Ctrl+R.

    • userAgent

      string opsional

      Jika ditentukan, string akan mengganti nilai header HTTP User-Agent yang dikirim saat memuat resource halaman yang diperiksa. String juga akan mengganti nilai properti navigator.userAgent yang ditampilkan ke skrip apa pun yang berjalan dalam halaman yang diperiksa.

Peristiwa

onResourceAdded

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

Diaktifkan saat resource baru ditambahkan ke halaman yang diperiksa.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (resource: Resource) => void

onResourceContentCommitted

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

Diaktifkan saat revisi baru resource di-commit (misalnya, pengguna menyimpan versi resource yang diedit di Alat Developer).

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

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