chrome.webviewTag

Penting: API ini hanya berfungsi di ChromeOS.

Deskripsi

Gunakan tag webview untuk secara aktif memuat konten live dari web melalui jaringan dan menyematkannya di Aplikasi Chrome Anda. Aplikasi Anda dapat mengontrol tampilan webview dan berinteraksi dengan konten web, memulai navigasi di halaman web tersemat, bereaksi terhadap peristiwa error yang terjadi di dalamnya, dan lainnya (lihat Penggunaan).

Izin

webview

Ketersediaan

Khusus ChromeOS

Jenis

ClearDataOptions

Opsi yang menentukan data yang harus dihapus oleh clearData.

Properti

• sejak

  number opsional

  Hapus data yang terakumulasi pada atau setelah tanggal ini, yang dinyatakan dalam milidetik sejak epoch (dapat diakses melalui metode getTime dari objek Date JavaScript). Jika tidak ada, setelan defaultnya adalah 0 (yang akan menghapus semua data penjelajahan).

ClearDataTypeSet

Satu set jenis data. Properti yang tidak ada ditafsirkan sebagai false.

Properti

• appcache

  boolean opsional

  Appcache situs.

• cache

  boolean opsional

  Chrome 44+

  Sejak Chrome 43. Cache browser. Catatan: saat menghapus data, tindakan ini akan menghapus seluruh cache; tidak terbatas pada rentang yang Anda tentukan.

• cookie

  boolean opsional

  Cookie partisi.

• fileSystems

  boolean opsional

  Sistem file situs.

• indexedDB

  boolean opsional

  Data IndexedDB situs.

• localStorage

  boolean opsional

  Data penyimpanan lokal situs.

• persistentCookies

  boolean opsional

  Chrome 58+

  Cookie persisten partisi.

• sessionCookies

  boolean opsional

  Chrome 58+

  Cookie sesi partisi.

• webSQL

  boolean opsional

  Data WebSQL situs.

ContentScriptDetails

Chrome 44+

Detail skrip konten yang akan dimasukkan. Baca dokumentasi skrip konten untuk mengetahui detail selengkapnya.

Properti

• all_frames

  boolean opsional

  Jika all_frames adalah true, ini berarti JavaScript atau CSS harus dimasukkan ke dalam semua frame halaman saat ini. Secara default, all_frames adalah false dan JavaScript atau CSS hanya dimasukkan ke dalam frame teratas.

• css

  InjectionItems opsional

  Kode CSS atau daftar file CSS yang akan dimasukkan ke halaman yang cocok. Skrip ini dimasukkan sesuai urutan kemunculannya, sebelum DOM dibuat atau ditampilkan untuk halaman.

• exclude_globs

  string[] opsional

  Diterapkan setelah pencocokan untuk mengecualikan URL yang cocok dengan glob ini. Ditujukan untuk mengemulasi kata kunci Greasemonkey @exclude.

• exclude_matches

  string[] opsional

  Mengecualikan halaman yang seharusnya disisipi skrip konten ini.

• include_globs

  string[] opsional

  Diterapkan setelah pencocokan untuk hanya menyertakan URL yang juga cocok dengan glob ini. Ditujukan untuk mengemulasi kata kunci @include Greasemonkey.

• js

  InjectionItems opsional

  Kode JavaScript atau daftar file JavaScript yang akan dimasukkan ke halaman yang cocok. Data ini dimasukkan sesuai urutan kemunculannya.

• match_about_blank

  boolean opsional

  Apakah akan menyisipkan skrip konten di about:blank dan about:srcdoc. Skrip konten hanya akan dimasukkan di halaman jika URL yang diwarisinya cocok dengan salah satu pola yang dideklarasikan di kolom matches. URL turunan adalah URL dokumen yang membuat frame atau jendela. Skrip konten tidak dapat disisipkan dalam frame dengan sandbox.

• cocok

  string[]

  Menentukan halaman tempat skrip konten ini akan dimasukkan.

• nama

  string

  Nama skrip konten yang akan dimasukkan.

• run_at

  RunAt opsional

  Waktu paling awal JavaScript atau CSS akan dimasukkan ke dalam tab. Default-nya adalah "document_idle".

ContentWindow

Handle pesan ke jendela tamu.

Properti

• postMessage

  void

  Memposting pesan ke konten web tersemat selama konten tersemat menampilkan halaman dari origin target. Metode ini tersedia setelah halaman selesai dimuat. Proses peristiwa contentload, lalu panggil metode.

  Tamu akan dapat mengirim balasan ke penyemat dengan memposting pesan ke event.source pada peristiwa pesan yang diterimanya.

  API ini identik dengan postMessage API HTML5 untuk komunikasi antar-halaman web. Penyemat dapat memproses balasan dengan menambahkan pemroses peristiwa message ke framenya sendiri.

  Fungsi postMessage terlihat seperti:

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

  • pesan

    apa pun

    Objek pesan yang akan dikirim ke tamu.

  • targetOrigin

    string

    Menentukan asal jendela tamu agar peristiwa dapat dikirim.

ContextMenuCreateProperties

Chrome 44+

Properti

• dicentang

  boolean opsional

  Status awal kotak centang atau item pilihan: true untuk dipilih dan false untuk tidak dipilih. Hanya satu item radio yang dapat dipilih dalam satu waktu di grup item radio tertentu.

• konteks

  [ContextType, ...ContextType[]] opsional

  Daftar konteks tempat item menu ini akan muncul. Jika tidak ditentukan, setelan defaultnya adalah ['page'].

• documentUrlPatterns

  string[] opsional

  Memungkinkan Anda membatasi item agar hanya berlaku untuk dokumen yang URL-nya cocok dengan salah satu pola yang diberikan. (Hal ini juga berlaku untuk frame.) Untuk mengetahui detail tentang format pola, lihat Pola Pencocokan.

• aktif

  boolean opsional

  Apakah item menu konteks ini diaktifkan atau dinonaktifkan. Default-nya adalah true.

• id

  string opsional

  ID unik yang akan ditetapkan ke item ini. Wajib untuk halaman acara. Tidak boleh sama dengan ID lain untuk ekstensi ini.

• parentId

  string | number opsional

  ID item menu induk; ini menjadikan item tersebut sebagai turunan dari item yang ditambahkan sebelumnya.

• targetUrlPatterns

  string[] opsional

  Serupa dengan documentUrlPatterns, tetapi memungkinkan Anda memfilter berdasarkan atribut src dari tag img/audio/video dan href dari tag anchor.

• judul

  string opsional

  Teks yang akan ditampilkan dalam item; teks ini wajib ada kecuali jika type adalah 'separator'. Jika konteksnya adalah 'selection', Anda dapat menggunakan %s dalam string untuk menampilkan teks yang dipilih. Misalnya, jika nilai parameter ini adalah "Terjemahkan '%s' ke Pig Latin" dan pengguna memilih kata "keren", item menu konteks untuk pilihan tersebut adalah "Terjemahkan 'keren' ke Pig Latin".

• jenis

  ItemType opsional

  Jenis item menu. Jika tidak ditentukan, setelan defaultnya adalah 'normal'.

• onclick

  void optional

  Fungsi yang akan dipanggil kembali saat item menu diklik.

  Fungsi onclick terlihat seperti:

  (info: OnClickData) => {...}

  • info

    OnClickData

    Informasi tentang item yang diklik dan konteks tempat klik terjadi.

ContextMenus

Chrome 44+

Properti

• onShow

  Event<functionvoidvoid>

  Diaktifkan sebelum menampilkan menu konteks pada webview ini. Dapat digunakan untuk menonaktifkan menu konteks ini dengan memanggil event.preventDefault().

  Fungsi onShow.addListener terlihat seperti:

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

  • callback

    fungsi

    Parameter callback terlihat seperti:

    (event: object) => void

    • event

      objek

      • preventDefault

        void

        Panggil ini untuk mencegah menu konteks ditampilkan.

        Fungsi preventDefault terlihat seperti:

        () => {...}

• create

  void

  Membuat item menu konteks baru. Perhatikan bahwa jika terjadi error selama pembuatan, Anda mungkin tidak akan mengetahuinya hingga callback pembuatan diaktifkan (detailnya akan ada di runtime.lastError).

  Fungsi create terlihat seperti:

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

  • createProperties

    objek

    Properti yang digunakan untuk membuat item

  • callback

    fungsi opsional

    Parameter callback terlihat seperti:

    () => void

  • return

    string | number

    ID item yang baru dibuat.

• hapus

  void

  Menghapus item menu konteks.

  Fungsi remove terlihat seperti:

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

  • menuItemId

    string | number

    ID item menu konteks yang akan dihapus.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti:

    () => void

• removeAll

  void

  Menghapus semua item menu konteks yang ditambahkan ke webview ini.

  Fungsi removeAll terlihat seperti:

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

  • callback

    fungsi opsional

    Parameter callback terlihat seperti:

    () => void

• update

  void

  Memperbarui item menu konteks yang dibuat sebelumnya.

  Fungsi update terlihat seperti:

  (id: string | number, updateProperties: object, callback?: function) => {...}

  • id

    string | number

    ID item yang akan diperbarui.

  • updateProperties

    objek

    Properti yang akan diperbarui. Menerima nilai yang sama dengan fungsi create.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti:

    () => void

ContextMenuUpdateProperties

Chrome 44+

Properti

• dicentang

  boolean opsional

  Status kotak centang atau item pilihan: true untuk dipilih dan false untuk tidak dipilih. Hanya satu item radio yang dapat dipilih dalam satu waktu di grup item radio tertentu.

• konteks

  [ContextType, ...ContextType[]] opsional

  Daftar konteks tempat item menu ini akan muncul.

• documentUrlPatterns

  string[] opsional

  Memungkinkan Anda membatasi item agar hanya berlaku untuk dokumen yang URL-nya cocok dengan salah satu pola yang diberikan. (Hal ini juga berlaku untuk frame.) Untuk mengetahui detail tentang format pola, lihat Pola Pencocokan.

• aktif

  boolean opsional

  Apakah item menu konteks ini diaktifkan atau dinonaktifkan.

• parentId

  string | number opsional

  ID item menu induk; ini menjadikan item tersebut sebagai turunan dari item yang ditambahkan sebelumnya. Catatan: Anda tidak dapat mengubah item menjadi turunan dari salah satu turunannya sendiri.

• targetUrlPatterns

  string[] opsional

  Serupa dengan documentUrlPatterns, tetapi memungkinkan Anda memfilter berdasarkan atribut src dari tag img/audio/video dan href dari tag anchor.

• judul

  string opsional

  Teks yang akan ditampilkan dalam item

• jenis

  ItemType opsional

  Jenis item menu.

• onclick

  void optional

  Fungsi yang akan dipanggil kembali saat item menu diklik.

  Fungsi onclick terlihat seperti:

  (info: OnClickData) => {...}

  • info

    OnClickData

    Informasi tentang item yang diklik dan konteks tempat klik terjadi.

ContextType

Chrome 44+

Berbagai konteks tempat menu dapat muncul. Menentukan 'all' sama dengan kombinasi semua konteks lainnya.

Enum

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

Antarmuka yang dilampirkan ke peristiwa DOM dialog.

Properti

• batal

  void

  Tolak dialog. Setara dengan mengklik Cancel dalam dialog confirm atau prompt.

  Fungsi cancel terlihat seperti:

  () => {...}

• oke

  void

  Terima dialog. Setara dengan mengklik OK dalam dialog alert, confirm, atau prompt.

  Fungsi ok terlihat seperti:

  (response?: string) => {...}

  • respons

    string opsional

    String respons yang akan diberikan kepada tamu saat menerima dialog prompt.

DialogMessageType

Chrome 141+

Jenis dialog modal yang diminta oleh tamu.

Enum

"alert"

"confirm"

"prompt"

DownloadPermissionRequest

Jenis objek request yang menyertai peristiwa DOM permissionrequest download.

Properti

• requestMethod

  string

  Jenis permintaan HTTP (misalnya, GET) yang terkait dengan permintaan download.

• url

  string

  URL download yang diminta.

• izinkan

  void

  Izinkan permintaan izin.

  Fungsi allow terlihat seperti:

  () => {...}

• tolak

  void

  Tolak permintaan izin. Ini adalah perilaku default jika allow tidak dipanggil.

  Fungsi deny terlihat seperti:

  () => {...}

ExitReason

Chrome 141+

String yang menunjukkan alasan keluar.

Enum

"normal"

"abnormal"

"crashed"

"killed"

"oom killed"

"oom"

"gagal diluncurkan"

"kegagalan integritas"

FileSystemPermissionRequest

Jenis objek request yang menyertai peristiwa DOM permissionrequest filesystem.

Properti

• url

  string

  URL frame yang meminta akses ke sistem file lokal.

• izinkan

  void

  Izinkan permintaan izin.

  Fungsi allow terlihat seperti:

  () => {...}

• tolak

  void

  Tolak permintaan izin.

  Fungsi deny terlihat seperti:

  () => {...}

FindCallbackResults

Berisi semua hasil permintaan pencarian.

Properti

• activeMatchOrdinal

  angka

  Nomor urut kecocokan saat ini.

• dibatalkan

  boolean

  Menunjukkan apakah permintaan pencarian ini dibatalkan.

• numberOfMatches

  angka

  Frekuensi searchText dicocokkan di halaman.

• selectionRect

  SelectionRect

  Menjelaskan persegi panjang di sekitar kecocokan aktif dalam koordinat layar.

FindOptions

Opsi untuk permintaan pencarian.

Properti

• mundur

  boolean opsional

  Flag untuk menemukan kecocokan dalam urutan terbalik. Nilai default-nya adalah false.

• matchCase

  boolean opsional

  Flag untuk mencocokkan dengan kepekaan huruf besar/kecil. Nilai default-nya adalah false.

FullscreenPermissionRequest

Chrome 43+

Jenis objek request yang menyertai peristiwa DOM permissionrequest fullscreen.

Properti

• asal

  string

  Asal frame di dalam webview yang memulai permintaan layar penuh.

• izinkan

  void

  Izinkan permintaan izin.

  Fungsi allow terlihat seperti:

  () => {...}

• tolak

  void

  Tolak permintaan izin.

  Fungsi deny terlihat seperti:

  () => {...}

GeolocationPermissionRequest

Jenis objek request yang menyertai peristiwa DOM permissionrequest geolocation.

Properti

• url

  string

  URL frame yang meminta akses ke data geolokasi.

• izinkan

  void

  Izinkan permintaan izin.

  Fungsi allow terlihat seperti:

  () => {...}

• tolak

  void

  Tolak permintaan izin. Ini adalah perilaku default jika allow tidak dipanggil.

  Fungsi deny terlihat seperti:

  () => {...}

HidPermissionRequest

Chrome 125+

Jenis objek request yang menyertai peristiwa DOM permissionrequest hid.

Properti

• url

  string

  URL frame yang meminta akses ke HID API.

• izinkan

  void

  Izinkan permintaan izin.

  Fungsi allow terlihat seperti:

  () => {...}

• tolak

  void

  Tolak permintaan izin. Ini adalah perilaku default jika allow tidak dipanggil.

  Fungsi deny terlihat seperti:

  () => {...}

InjectDetails

Detail skrip atau CSS yang akan dimasukkan. Properti kode atau file harus ditetapkan, tetapi keduanya tidak boleh ditetapkan secara bersamaan.

Properti

• kode

  string opsional

  Kode JavaScript atau CSS yang akan dimasukkan.

  Peringatan: Berhati-hatilah saat menggunakan parameter code. Penggunaan yang salah dapat membuat aplikasi Anda rentan terhadap serangan pembuatan skrip lintas situs.

• file

  string opsional

  File JavaScript atau CSS yang akan dimasukkan.

InjectionItems

Chrome 44+

Jenis item injeksi: kode atau kumpulan file.

Properti

• kode

  string opsional

  Kode JavaScript atau CSS yang akan dimasukkan ke halaman yang cocok.

• file

  string[] opsional

  Daftar file JavaScript atau CSS yang akan dimasukkan ke halaman yang cocok. Elemen ini dimasukkan sesuai urutan kemunculannya dalam array ini.

LoadAbortReason

Chrome 141+

String yang menunjukkan jenis pembatalan yang terjadi. String ini tidak dijamin akan tetap kompatibel dengan versi lama di antara rilis. Anda tidak boleh mengurai dan bertindak berdasarkan kontennya. Dalam beberapa kasus, error yang tidak tercantum di sini juga dapat dilaporkan.

Enum

"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"

LoadPluginPermissionRequest

Jenis objek request yang menyertai peristiwa DOM permissionrequest loadplugin.

Properti

• identifier

  string

  String ID plugin.

• nama

  string

  Nama tampilan plugin.

• izinkan

  void

  Izinkan permintaan izin. Ini adalah perilaku default jika deny tidak dipanggil.

  Fungsi allow terlihat seperti:

  () => {...}

• tolak

  void

  Tolak permintaan izin.

  Fungsi deny terlihat seperti:

  () => {...}

MediaPermissionRequest

Jenis objek request yang menyertai peristiwa DOM permissionrequest media.

Properti

• url

  string

  URL frame yang meminta akses ke media pengguna.

• izinkan

  void

  Izinkan permintaan izin.

  Fungsi allow terlihat seperti:

  () => {...}

• tolak

  void

  Tolak permintaan izin. Ini adalah perilaku default jika allow tidak dipanggil.

  Fungsi deny terlihat seperti:

  () => {...}

NewWindow

Antarmuka yang dilampirkan ke peristiwa DOM newwindow.

Properti

• lampirkan

  void

  Lampirkan halaman target yang diminta ke elemen webview yang ada.

  Fungsi attach terlihat seperti:

  (webview: object) => {...}

  • webview

    objek

    Elemen webview yang harus dilampirkan ke halaman target.

• hapus

  void

  Batalkan permintaan jendela baru.

  Fungsi discard terlihat seperti:

  () => {...}

PermissionType

Chrome 141+

Jenis izin yang diminta.

Enum

"media"

"geolocation"

"pointerLock"

"download"

"loadplugin"

"filesystem"

"fullscreen"

"hid"

PointerLockPermissionRequest

Jenis objek request yang menyertai peristiwa DOM permissionrequest pointerLock.

Properti

• lastUnlockedBySelf

  boolean

  Apakah frame yang meminta adalah klien terbaru yang menahan kunci pointer atau tidak.

• url

  string

  URL frame yang meminta kunci kursor.

• userGesture

  boolean

  Apakah kunci kursor diminta sebagai hasil dari gestur input pengguna atau tidak.

• izinkan

  void

  Izinkan permintaan izin.

  Fungsi allow terlihat seperti:

  () => {...}

• tolak

  void

  Tolak permintaan izin. Ini adalah perilaku default jika allow tidak dipanggil.

  Fungsi deny terlihat seperti:

  () => {...}

SelectionRect

Menjelaskan persegi panjang dalam koordinat layar.

Semantik penampungan mirip dengan array; yaitu, koordinat (left, top) dianggap berada di dalam persegi panjang, tetapi koordinat (left + width, top) tidak.

Properti

• tinggi

  angka

  Tinggi persegi panjang.

• kiri

  angka

  Jarak dari tepi kiri layar ke tepi kiri persegi panjang.

• atas

  angka

  Jarak dari tepi atas layar ke tepi atas persegi panjang.

• lebar

  angka

  Lebar persegi panjang.

StopFindingAction

Chrome 141+

Menentukan tindakan yang harus dilakukan terhadap kecocokan aktif setelah sesi pencarian berakhir. clear akan menghapus penandaan pada kecocokan aktif; keep akan mempertahankan penandaan pada kecocokan aktif; activate akan mempertahankan penandaan pada kecocokan aktif dan menyimulasikan klik pengguna pada kecocokan tersebut. Tindakan defaultnya adalah keep.

Enum

"clear"

"keep"

"activate"

WebRequestEventInterface

Chrome 44+

Antarmuka yang menyediakan akses ke peristiwa webRequest di halaman tamu. Lihat API ekstensi chrome.webRequest untuk mengetahui detail tentang siklus proses webRequest dan konsep terkait. Catatan: Peristiwa chrome.webRequest.onActionIgnored tidak didukung untuk webview.

Untuk mengilustrasikan perbedaan penggunaan dari webRequest API ekstensi, pertimbangkan contoh kode berikut yang memblokir permintaan tamu untuk URL yang cocok dengan *://www.evil.com/*:

webview.request.onBeforeRequest.addListener(
  function(details) { return {cancel: true}; },
  {urls: ["*://www.evil.com/*"]},
  ["blocking"]);

Selain itu, antarmuka ini mendukung aturan webRequest deklaratif melalui peristiwa onRequest dan onMessage. Lihat declarativeWebRequest untuk mengetahui detail API.

Perhatikan bahwa kondisi dan tindakan untuk webRequest webview deklaratif harus dibuat dari pasangan chrome.webViewRequest.*-nya. Contoh kode berikut secara deklaratif memblokir semua permintaan ke "example.com" di webview myWebview:

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

WindowOpenDisposition

Chrome 141+

Disposisi yang diminta untuk jendela baru.

Enum

"ignore"

"save_to_disk"

"current_tab"

"new_background_tab"

"new_foreground_tab"

"new_window"

"new_popup"

ZoomMode

Chrome 43+

Menentukan cara penanganan zoom di webview.

Enum

"per-origin"
Perubahan zoom akan dipertahankan di origin halaman yang di-zoom, yaitu semua webview lain di partisi yang sama yang dibuka ke origin yang sama juga akan di-zoom. Selain itu, perubahan zoom per-origin disimpan dengan origin, yang berarti saat membuka halaman lain di origin yang sama, semua halaman akan di-zoom ke faktor zoom yang sama.

"per-view"
Perubahan zoom hanya berlaku di webview ini, dan perubahan zoom di webview lain tidak akan memengaruhi zoom webview ini. Selain itu, perubahan zoom per-view direset saat navigasi; menavigasi webview akan selalu memuat halaman dengan faktor zoom per origin (dalam cakupan partisi).

"disabled"
Menonaktifkan semua zoom di webview. Konten akan kembali ke tingkat zoom default, dan semua upaya perubahan zoom akan diabaikan.

Properti

contentWindow

Referensi objek yang dapat digunakan untuk memposting pesan ke halaman tamu.

Jenis

ContentWindow

contextMenus

Chrome 44+

Mirip dengan ContextMenus API chrome, tetapi berlaku untuk webview, bukan browser. Gunakan webview.contextMenus API untuk menambahkan item ke menu konteks webview. Anda dapat memilih jenis objek yang akan diterapkan pada penambahan menu konteks, seperti gambar, hyperlink, dan halaman.

Jenis

ContextMenus

request

Antarmuka yang menyediakan akses ke peristiwa webRequest di halaman tamu.

Jenis

WebRequestEventInterface

Metode

addContentScripts()

Chrome 44+

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

Menambahkan aturan injeksi skrip konten ke webview. Saat webview membuka halaman yang cocok dengan satu atau beberapa aturan, skrip terkait akan dimasukkan. Anda dapat menambahkan aturan atau memperbarui aturan yang ada secara terprogram.

Contoh berikut menambahkan dua aturan ke webview: 'myRule' dan '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';

Anda dapat menunda panggilan addContentScripts hingga Anda perlu memasukkan skrip.

Contoh berikut menunjukkan cara menimpa aturan yang ada.

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

Jika webview telah diarahkan ke origin (misalnya, foo.com) dan memanggil webview.addContentScripts untuk menambahkan 'myRule', Anda harus menunggu navigasi berikutnya agar skrip dimasukkan. Jika Anda menginginkan injeksi langsung, executeScript akan melakukan hal yang benar.

Aturan dipertahankan meskipun proses tamu mengalami error atau dihentikan, atau bahkan jika webview diubah induknya.

Baca dokumentasi skrip konten untuk mengetahui detail selengkapnya.

Parameter

• contentScriptList

  ContentScriptDetails, ...ContentScriptDetails[]]

  Detail skrip konten yang akan ditambahkan.

back()

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

Membuka satu entri histori sebelumnya jika memungkinkan. Setara dengan go(-1).

Parameter

• callback

  fungsi opsional

  Chrome 44+

  Parameter callback terlihat seperti:

  (success: boolean) => void

  • berhasil

    boolean

    Menunjukkan apakah navigasi berhasil.

canGoBack()

chrome.webviewTag.canGoBack(): boolean

Menunjukkan apakah mungkin atau tidak untuk menavigasi mundur melalui histori. Status fungsi ini di-cache, dan diperbarui sebelum setiap loadcommit, sehingga tempat terbaik untuk memanggilnya adalah di loadcommit.

Hasil

• boolean

canGoForward()

chrome.webviewTag.canGoForward(): boolean

Menunjukkan apakah mungkin atau tidak untuk menavigasi ke depan melalui histori. Status fungsi ini di-cache, dan diperbarui sebelum setiap loadcommit, sehingga tempat terbaik untuk memanggilnya adalah di loadcommit.

Hasil

• boolean

captureVisibleRegion()

Chrome 50+

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

Mengambil region yang terlihat dari webview.

Parameter

• opsi

  ImageDetails opsional

• callback

  fungsi

  Parameter callback terlihat seperti:

  (dataUrl: string) => void

  • dataUrl

    string

    URL data yang mengenkode gambar area yang terlihat dari tab yang diambil. Dapat ditetapkan ke properti 'src' elemen Gambar HTML untuk ditampilkan.

clearData()

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

Menghapus data penjelajahan untuk partisi webview.

Parameter

• opsi

  ClearDataOptions

  Opsi yang menentukan data mana yang akan dihapus.

• tipe

  ClearDataTypeSet

  Jenis data yang akan dihapus.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

executeScript()

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

Memasukkan kode JavaScript ke halaman tamu.

Kode contoh berikut menggunakan injeksi skrip untuk menetapkan warna latar belakang halaman tamu menjadi merah:

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

Parameter

• detail

  InjectDetails

  Detail skrip yang akan dijalankan.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (result?: any[]) => void

  • hasil

    any[] opsional

    Hasil skrip di setiap frame yang dimasukkan.

find()

chrome.webviewTag.find(
  searchText: string,
  options?: FindOptions,
  callback?: function,
): void

Memulai permintaan cari dalam halaman.

Parameter

• searchText

  string

  String yang akan ditemukan di halaman.

• opsi

  FindOptions opsional

  Opsi untuk permintaan pencarian.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (results?: FindCallbackResults) => void

  • hasil

    FindCallbackResults opsional

    Berisi semua hasil permintaan pencarian. results dapat dihilangkan jika tidak digunakan dalam isi fungsi callback; misalnya, jika callback hanya digunakan untuk mengetahui kapan permintaan pencarian telah selesai.

forward()

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

Maju satu entri histori jika memungkinkan. Setara dengan go(1).

Parameter

• callback

  fungsi opsional

  Chrome 44+

  Parameter callback terlihat seperti:

  (success: boolean) => void

  • berhasil

    boolean

    Menunjukkan apakah navigasi berhasil.

getAudioState()

Chrome 62+

chrome.webviewTag.getAudioState(
  callback: function,
): void

Membuat kueri status audio.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (audible: boolean) => void

  • audible

    boolean

getProcessId()

chrome.webviewTag.getProcessId(): number

Menampilkan ID proses internal Chrome untuk proses halaman web tamu saat ini, sehingga penyemat dapat mengetahui jumlah tamu yang akan terpengaruh jika proses dihentikan. Dua tamu akan berbagi proses hanya jika keduanya termasuk dalam aplikasi yang sama dan memiliki ID partisi penyimpanan yang sama. Panggilan ini bersifat sinkron dan menampilkan gagasan yang di-cache penyemat tentang ID proses saat ini. ID proses tidak sama dengan ID proses sistem operasi.

Hasil

• angka

getUserAgent()

chrome.webviewTag.getUserAgent(): string

Menampilkan string agen pengguna yang digunakan oleh webview untuk permintaan halaman tamu.

Hasil

• string

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
): void

Mendapatkan faktor zoom saat ini.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (zoomFactor: number) => void

  • zoomFactor

    angka

    Faktor zoom saat ini.

getZoomMode()

Chrome 43+

chrome.webviewTag.getZoomMode(
  callback: function,
): void

Mendapatkan mode zoom saat ini.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (ZoomMode: ZoomMode) => void

  • ZoomMode

    ZoomMode

    Mode zoom webview saat ini.

go()

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

Membuka entri histori menggunakan indeks histori yang terkait dengan navigasi saat ini. Jika navigasi yang diminta tidak memungkinkan, metode ini tidak akan berpengaruh.

Parameter

• relativeIndex

  angka

  Indeks histori relatif yang harus dibuka oleh webview. Misalnya, nilai 2 akan membuka 2 entri histori berikutnya jika memungkinkan; nilai -3 akan membuka 3 entri sebelumnya.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (success: boolean) => void

  • berhasil

    boolean

    Menunjukkan apakah navigasi berhasil.

insertCSS()

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

Memasukkan CSS ke halaman tamu.

Parameter

• detail

  InjectDetails

  Detail CSS yang akan disisipkan.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

isAudioMuted()

Chrome 62+

chrome.webviewTag.isAudioMuted(
  callback: function,
): void

Membuat kueri apakah audio dibisukan.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (muted: boolean) => void

  • dibisukan

    boolean

isSpatialNavigationEnabled()

Chrome 71+

chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
): void

Membuat kueri apakah navigasi spasial diaktifkan untuk webview.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (enabled: boolean) => void

  • aktif

    boolean

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden(): void

Menunjukkan apakah string agen pengguna webview telah diganti oleh webviewTag.setUserAgentOverride atau tidak.

loadDataWithBaseUrl()

chrome.webviewTag.loadDataWithBaseUrl(
  dataUrl: string,
  baseUrl: string,
  virtualUrl?: string,
): void

Memuat URL data dengan URL dasar yang ditentukan yang digunakan untuk link relatif. Jika perlu, URL virtual dapat diberikan untuk ditampilkan kepada pengguna, bukan URL data.

Parameter

• dataUrl

  string

  URL data yang akan dimuat.

• baseUrl

  string

  URL dasar yang akan digunakan untuk link relatif.

• virtualUrl

  string opsional

  URL yang akan ditampilkan kepada pengguna (di kolom URL).

print()

chrome.webviewTag.print(): void

Mencetak konten webview. Hal ini setara dengan memanggil fungsi cetak yang ditulis dalam skrip dari webview itu sendiri.

reload()

chrome.webviewTag.reload(): void

Memuat ulang halaman tingkat teratas saat ini.

removeContentScripts()

Chrome 44+

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

Menghapus skrip konten dari webview.

Contoh berikut menghapus "myRule" yang ditambahkan sebelumnya.

webview.removeContentScripts(['myRule']);

Anda dapat menghapus semua aturan dengan memanggil:

webview.removeContentScripts();

Parameter

• scriptNameList

  string[] opsional

  Daftar nama skrip konten yang akan dihapus. Jika daftar kosong, semua skrip konten yang ditambahkan ke webview akan dihapus.

setAudioMuted()

Chrome 62+

chrome.webviewTag.setAudioMuted(
  mute: boolean,
): void

Menetapkan status audio nonaktif pada tampilan web.

Parameter

• bisukan

  boolean

  Nilai bisukan audio

setSpatialNavigationEnabled()

Chrome 71+

chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
): void

Menetapkan status navigasi spasial webview.

Parameter

• aktif

  boolean

  Nilai status navigasi spasial.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
): void

Ganti string agen pengguna yang digunakan oleh webview untuk permintaan halaman tamu. Penggantian akan menyebabkan nilai header Petunjuk Klien Agen Pengguna dan nilai yang ditampilkan oleh navigator.userAgentData menjadi kosong untuk permintaan halaman tamu yang menerapkan penggantian ini.

Parameter

• userAgent

  string

  String agen pengguna yang akan digunakan.

setZoom()

chrome.webviewTag.setZoom(
  zoomFactor: number,
  callback?: function,
): void

Mengubah faktor zoom halaman. Cakupan dan persistensi perubahan ini ditentukan oleh mode zoom webview saat ini (lihat webviewTag.ZoomMode).

Parameter

• zoomFactor

  angka

  Faktor zoom baru.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

setZoomMode()

Chrome 43+

chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
): void

Menetapkan mode zoom webview.

Parameter

• ZoomMode

  ZoomMode

  Menentukan cara penanganan zoom di webview.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  () => void

stop()

chrome.webviewTag.stop(): void

Berhenti memuat navigasi webview saat ini jika sedang berlangsung.

stopFinding()

chrome.webviewTag.stopFinding(
  action?: StopFindingAction,
): void

Mengakhiri sesi pencarian saat ini (menghapus semua penandaan) dan membatalkan semua permintaan pencarian yang sedang berlangsung.

Parameter

• tindakan

  StopFindingAction opsional

  Menentukan tindakan yang harus dilakukan dengan kecocokan aktif setelah sesi pencarian berakhir. clear akan menghapus penandaan pada kecocokan aktif; keep akan mempertahankan penandaan pada kecocokan aktif; activate akan mempertahankan penandaan pada kecocokan aktif dan menyimulasikan klik pengguna pada kecocokan tersebut. Tindakan defaultnya adalah keep.

terminate()

chrome.webviewTag.terminate(): void

Menghentikan paksa proses perender halaman web tamu. Tindakan ini dapat memengaruhi beberapa tag webview di aplikasi saat ini jika tag tersebut menggunakan proses yang sama, tetapi tidak akan memengaruhi tag webview di aplikasi lain.

Acara

close

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

Diaktifkan saat jendela tamu mencoba menutup dirinya sendiri.

Kode contoh berikut mengarahkan webview ke about:blank saat tamu mencoba menutup dirinya sendiri.

webview.addEventListener('close', function() {
  webview.src = 'about:blank';
});

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  () => void

consolemessage

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

Diaktifkan saat jendela tamu mencatat pesan konsol ke dalam log.

Kode contoh berikut meneruskan semua pesan log ke konsol penyemat tanpa memperhatikan level log atau properti lainnya.

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

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

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

  • level

    angka

  • pesan

    string

  • jalur

    angka

  • sourceId

    string

contentload

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

Diaktifkan saat jendela tamu mengaktifkan peristiwa load, yaitu saat dokumen baru dimuat. Hal ini tidak mencakup navigasi halaman dalam dokumen saat ini atau pemuatan resource asinkron.

Contoh kode berikut mengubah ukuran font default elemen body tamu setelah pemuatan halaman:

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

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  () => void

dialog

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

Diaktifkan saat jendela tamu mencoba membuka dialog modal melalui window.alert, window.confirm, atau window.prompt.

Menangani peristiwa ini akan memblokir proses tamu hingga setiap pemroses peristiwa ditampilkan atau objek dialog menjadi tidak dapat dijangkau (jika preventDefault() dipanggil).

Perilaku defaultnya adalah membatalkan dialog.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (messageType: DialogMessageType, messageText: string, dialog: DialogController) => void

  • messageType

    DialogMessageType

  • messageText

    string

  • dialog

    DialogController

exit

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

Diaktifkan saat proses yang merender konten web tamu telah keluar.

Kode contoh berikut akan menampilkan pesan perpisahan setiap kali halaman tamu error:

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

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (details: object) => void

  • detail

    objek

    • processID

      angka

      ID internal Chrome dari proses yang keluar.

    • mampu bernalar

      ExitReason

      String yang menunjukkan alasan keluar.

findupdate

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

Diaktifkan saat hasil penemuan baru tersedia untuk permintaan penemuan yang aktif. Hal ini mungkin terjadi beberapa kali untuk satu permintaan pencarian saat kecocokan ditemukan.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (searchText: string, numberOfMatches: number, activeMatchOrdinal: number, selectionRect: SelectionRect, canceled: boolean, finalUpdate: string) => void

  • searchText

    string

  • numberOfMatches

    angka

  • activeMatchOrdinal

    angka

  • selectionRect

    SelectionRect

  • dibatalkan

    boolean

  • finalUpdate

    string

loadabort

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

Diaktifkan saat pemuatan tingkat teratas dibatalkan tanpa di-commit. Pesan error akan dicetak ke konsol kecuali jika peristiwa dicegah secara default.

Catatan: Jika pemuatan resource dibatalkan, peristiwa loadabort pada akhirnya akan diikuti oleh peristiwa loadstop, meskipun semua pemuatan yang di-commit sejak peristiwa loadstop terakhir (jika ada) dibatalkan.

Catatan: Jika pemuatan URL about atau URL JavaScript dibatalkan, loadabort akan diaktifkan, lalu webview akan diarahkan ke 'about:blank'.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (url: string, isTopLevel: boolean, code: number, reason: LoadAbortReason) => void

  • url

    string

  • isTopLevel

    boolean

  • kode

    angka

  • mampu bernalar

    LoadAbortReason

loadcommit

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

Diaktifkan saat pemuatan telah di-commit. Hal ini mencakup navigasi dalam dokumen saat ini serta pemuatan tingkat dokumen subframe, tetapi tidak mencakup pemuatan resource asinkron.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

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

  • url

    string

  • isTopLevel

    boolean

loadredirect

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

Diaktifkan saat permintaan pemuatan tingkat teratas telah dialihkan ke URL yang berbeda.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

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

  • oldUrl

    string

  • newUrl

    string

  • isTopLevel

    boolean

loadstart

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

Diaktifkan saat pemuatan dimulai.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

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

  • url

    string

  • isTopLevel

    boolean

loadstop

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

Diaktifkan saat semua pemuatan tingkat frame di halaman tamu (termasuk semua subframenya) telah selesai. Hal ini mencakup navigasi dalam dokumen saat ini serta pemuatan tingkat dokumen subframe, tetapi tidak mencakup pemuatan resource asinkron. Peristiwa ini diaktifkan setiap kali jumlah pemuatan tingkat dokumen beralih dari satu (atau lebih) ke nol. Misalnya, jika halaman yang telah selesai dimuat (yaitu, loadstop sudah diaktifkan sekali) membuat iframe baru yang memuat halaman, lalu loadstop kedua akan diaktifkan saat pemuatan halaman iframe selesai. Pola ini biasanya terlihat di halaman yang memuat iklan.

Catatan: Jika pemuatan yang di-commit dibatalkan, peristiwa loadstop pada akhirnya akan mengikuti peristiwa loadabort, meskipun semua pemuatan yang di-commit sejak peristiwa loadstop terakhir (jika ada) dibatalkan.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  () => void

newwindow

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

Diaktifkan saat halaman tamu mencoba membuka jendela browser baru.

Kode contoh berikut akan membuat dan mengarahkan webview baru di embedder untuk setiap jendela baru yang diminta:

webview.addEventListener('newwindow', function(e) {
  var newWebview = document.createElement('webview');
  document.body.appendChild(newWebview);
  e.window.attach(newWebview);
});

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (window: NewWindow, targetUrl: string, initialWidth: number, initialHeight: number, name: string, windowOpenDisposition: WindowOpenDisposition) => void

  • jendela

    NewWindow

  • targetUrl

    string

  • initialWidth

    angka

  • initialHeight

    angka

  • nama

    string

  • windowOpenDisposition

    WindowOpenDisposition

permissionrequest

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

Diaktifkan saat halaman tamu perlu meminta izin khusus dari penyemat.

Kode contoh berikut akan memberikan akses halaman tamu ke webkitGetUserMedia API. Perhatikan bahwa aplikasi yang menggunakan kode contoh ini harus menentukan sendiri izin manifes audioCapture dan/atau videoCapture:

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

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (permission: PermissionType, request: object) => void

  • izin

    PermissionType

  • minta

    objek

responsive

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

Dipicu saat proses yang merender konten web tamu menjadi responsif kembali setelah tidak responsif.

Kode contoh berikut akan memudarkan elemen webview saat menjadi responsif atau tidak responsif:

webview.style.webkitTransition = 'opacity 250ms';
webview.addEventListener('unresponsive', function() {
  webview.style.opacity = '0.5';
});
webview.addEventListener('responsive', function() {
  webview.style.opacity = '1';
});

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (processID: number) => void

  • processID

    angka

sizechanged

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

Diaktifkan saat konten web tersemat telah diubah ukurannya melalui autosize. Hanya diaktifkan jika autosize diaktifkan.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (oldWidth: number, oldHeight: number, newWidth: number, newHeight: number) => void

  • oldWidth

    angka

  • oldHeight

    angka

  • newWidth

    angka

  • newHeight

    angka

unresponsive

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

Diaktifkan saat proses yang merender konten web tamu menjadi tidak responsif. Peristiwa ini akan dibuat sekali dengan peristiwa responsif yang cocok jika tamu mulai merespons lagi.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

  (processID: number) => void

  • processID

    angka

zoomchange

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

Diaktifkan saat zoom halaman berubah.

Parameter

• callback

  fungsi

  Parameter callback terlihat seperti:

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

  • oldZoomFactor

    angka

  • newZoomFactor

    angka