chrome.webviewTag

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, menanggapi peristiwa error yang terjadi di dalamnya, dan banyak lagi (lihat Penggunaan).

Izin

webview

Jenis

ClearDataOptions

Opsi yang menentukan data yang harus dihapus oleh clearData.

Properti

  • sejak

    angka opsional

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

ClearDataTypeSet

Kumpulan jenis data. Properti yang tidak ada ditafsirkan sebagai false.

Properti

  • {i>appcache<i}

    boolean opsional

    Situs appcaches.

  • cache

    boolean opsional

    Chrome 44 dan yang lebih baru

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

  • cookie

    boolean opsional

    Cookie partisi.

  • fileSystems

    boolean opsional

    Situs sistem file.

  • indexedDB

    boolean opsional

    Situs Data tensorflow.

  • localStorage

    boolean opsional

    Situs data penyimpanan lokal.

  • persistentCookies

    boolean opsional

    Chrome 58 atau yang lebih baru

    Cookie persisten partisi.

  • sessionCookies

    boolean opsional

    Chrome 58 atau yang lebih baru

    Cookie sesi partisi.

  • webSQL

    boolean opsional

    Situs Data WebSQL.

ContentScriptDetails

Chrome 44 dan yang lebih baru

Detail skrip konten yang akan dimasukkan. Lihat dokumentasi skrip konten untuk detail selengkapnya.

Properti

  • all_frames

    boolean opsional

    Jika all_frames adalah true, ini menyiratkan bahwa JavaScript atau CSS harus dimasukkan ke semua bingkai halaman saat ini. Secara default, all_frames adalah false dan JavaScript atau CSS hanya dimasukkan ke dalam frame atas.

  • css

    InjectionItems opsional

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

  • exclude_globs

    string[] opsional

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

  • exclude_matches

    string[] opsional

    Mengecualikan halaman yang seharusnya dimasukkan skrip konten ini.

  • include_globs

    string[] opsional

    Diterapkan setelah kecocokan 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. Kode 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 warisannya cocok dengan salah satu pola yang dinyatakan di kolom kecocokan. URL warisan adalah URL dokumen yang membuat bingkai atau jendela. Skrip konten tidak dapat disisipkan dalam frame dalam sandbox.

  • cocok

    {i>string<i}[]

    Menentukan halaman tempat skrip konten ini akan dimasukkan.

  • nama

    string

    Nama skrip konten yang akan dimasukkan.

  • run_at

    RunAt opsional

    Paling cepat JavaScript atau CSS akan dimasukkan ke tab. Default-nya adalah "document_idle".

ContentWindow

Tuas pesan ke jendela tamu.

Properti

  • postMessage

    void

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

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

    API ini identik dengan HTML5 postMessage API untuk komunikasi antarhalaman. Penyematan dapat memproses balasan dengan menambahkan pemroses peristiwa message ke frame-nya sendiri.

    Fungsi postMessage akan terlihat seperti ini: 

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

    • pesan

      apa pun

      Objek pesan yang akan dikirim ke tamu.

    • targetOrigin

      string

      Menentukan asal periode tamu agar peristiwa bisa dikirim.

ContextMenuCreateProperties

Chrome 44 dan yang lebih baru

Properti

  • dicentang

    boolean opsional

    Status awal kotak centang atau item radio: benar (true) untuk dipilih dan salah (false) untuk tidak dipilih. Hanya satu item radio yang dapat dipilih pada satu waktu dalam 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 diterapkan pada dokumen yang URL-nya cocok dengan salah satu pola yang diberikan. (Ini juga berlaku untuk bingkai.) Untuk mengetahui detail tentang format pola, lihat Pencocokan Pola.

  • diaktifkan

    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 | angka opsional

    ID item menu induk; ini membuat item tersebut menjadi 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 tag anchor.

  • judul

    string opsional

    Teks yang akan ditampilkan di item; ini wajib kecuali type merupakan 'pemisah'. 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 "cool", item menu konteks untuk pilihan ini adalah "Terjemahkan 'cool' menjadi Pig Latin".

  • jenis

    ItemType opsional

    Jenis item menu. Nilai defaultnya adalah 'normal' jika tidak ditentukan.

  • onclick

    batal opsional

    Fungsi yang akan dipanggil kembali saat item menu diklik.

    Fungsi onclick akan terlihat seperti ini: 

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

    • Informasi tentang item yang diklik dan konteks tempat klik terjadi.

ContextMenus

Chrome 44 dan yang lebih baru

Properti

  • onShow

    Peristiwa<functionvoidvoid>

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

    Fungsi onShow.addListener akan terlihat seperti ini: 

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

    • callback

      fungsi

      Parameter callback terlihat seperti ini: 

      (event: object) => void

      • peristiwa

        objek

        • preventDefault

          void

          Panggil ini agar menu konteks tidak ditampilkan.

          Fungsi preventDefault akan terlihat seperti ini: 

          () => {...}

  • create

    void

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

    Fungsi create akan terlihat seperti ini: 

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

    • createProperties

      objek

      Properti yang digunakan untuk membuat item

    • callback

      fungsi opsional

      Parameter callback terlihat seperti ini: 

      () => void

    • akan menampilkan

      string | angka

      ID item yang baru dibuat.

  • hapus

    void

    Menghapus item menu konteks.

    Fungsi remove akan terlihat seperti ini: 

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

    • menuItemId

      string | angka

      ID item menu konteks yang akan dihapus.

    • callback

      fungsi opsional

      Parameter callback terlihat seperti ini: 

      () => void

  • hapusSemua

    void

    Menghapus semua item menu konteks yang ditambahkan ke webview ini.

    Fungsi removeAll akan terlihat seperti ini: 

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

    • callback

      fungsi opsional

      Parameter callback terlihat seperti ini: 

      () => void

  • update

    void

    Memperbarui item menu konteks yang dibuat sebelumnya.

    Fungsi update akan terlihat seperti ini: 

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

    • id

      string | angka

      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 ini: 

      () => void

ContextMenuUpdateProperties

Chrome 44 dan yang lebih baru

Properti

  • dicentang

    boolean opsional

    Status kotak centang atau item radio: benar (true) untuk dipilih dan salah (false) untuk tidak dipilih. Hanya satu item radio yang dapat dipilih pada satu waktu dalam 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 diterapkan pada dokumen yang URL-nya cocok dengan salah satu pola yang diberikan. (Ini juga berlaku untuk bingkai.) Untuk mengetahui detail tentang format pola, lihat Pencocokan Pola.

  • diaktifkan

    boolean opsional

    Apakah item menu konteks ini diaktifkan atau dinonaktifkan.

  • parentId

    string | angka opsional

    ID item menu induk; ini membuat item tersebut menjadi 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 tag anchor.

  • judul

    string opsional

    Teks yang akan ditampilkan di item

  • jenis

    ItemType opsional

    Jenis item menu.

  • onclick

    batal opsional

    Fungsi yang akan dipanggil kembali saat item menu diklik.

    Fungsi onclick akan terlihat seperti ini: 

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

    • Informasi tentang item yang diklik dan konteks tempat klik terjadi.

ContextType

Chrome 44 dan yang lebih baru

Berbagai konteks yang dapat menampilkan menu. Menetapkan 'all' setara dengan kombinasi semua konteks lainnya.

Enum

"semua"

"halaman"

"bingkai"

"selection"

"link"

"editable"

"gambar"

"video"

"audio"

DialogController

Antarmuka dilampirkan ke peristiwa DOM dialog.

Properti

  • batal

    void

    Menolak dialog. Setara dengan mengklik Batal dalam dialog confirm atau prompt.

    Fungsi cancel akan terlihat seperti ini: 

    () => {...}

  • oke

    void

    Setujui dialog. Setara dengan mengklik Oke dalam dialog alert, confirm, atau prompt.

    Fungsi ok akan terlihat seperti ini: 

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

    • respons

      string opsional

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

DownloadPermissionRequest

Jenis objek request yang menyertai peristiwa DOM download permissionrequest.

Properti

  • requestMethod

    string

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

  • url

    string

    URL download yang diminta.

  • izinkan

    void

    Berikan permintaan izin.

    Fungsi allow akan terlihat seperti ini: 

    () => {...}

  • tolak

    void

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

    Fungsi deny akan terlihat seperti ini: 

    () => {...}

FileSystemPermissionRequest

Jenis objek request yang menyertai peristiwa DOM filesystem permissionrequest.

Properti

  • url

    string

    URL dari {i>frame<i} yang meminta akses ke sistem file lokal.

  • izinkan

    void

    Berikan permintaan izin.

    Fungsi allow akan terlihat seperti ini: 

    () => {...}

  • tolak

    void

    Menolak permintaan izin.

    Fungsi deny akan terlihat seperti ini: 

    () => {...}

FindCallbackResults

Berisi semua hasil permintaan pencarian.

Properti

  • activeMatchOrdinal

    angka

    Angka ordinal kecocokan saat ini.

  • dibatalkan

    boolean

    Menunjukkan apakah permintaan pencarian ini dibatalkan.

  • numberOfMatches

    angka

    Frekuensi searchText dicocokkan di halaman.

  • selectionRect

    SelectionRect

    Menggambarkan persegi panjang di sekitar kecocokan aktif dalam koordinat layar.

FindOptions

Opsi untuk permintaan pencarian.

Properti

  • mundur

    boolean opsional

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

  • matchCase

    boolean opsional

    Tandai agar sesuai dengan kepekaan huruf besar/kecil. Nilai default-nya adalah false.

FullscreenPermissionRequest

Chrome 43 dan yang lebih baru

Jenis objek request yang menyertai peristiwa DOM fullscreen permissionrequest.

Properti

  • asal

    string

    Asal frame di dalam webview yang memulai permintaan layar penuh.

  • izinkan

    void

    Berikan permintaan izin.

    Fungsi allow akan terlihat seperti ini: 

    () => {...}

  • tolak

    void

    Menolak permintaan izin.

    Fungsi deny akan terlihat seperti ini: 

    () => {...}

GeolocationPermissionRequest

Jenis objek request yang menyertai peristiwa DOM geolocation permissionrequest.

Properti

  • url

    string

    URL frame yang meminta akses ke data geolokasi.

  • izinkan

    void

    Berikan permintaan izin.

    Fungsi allow akan terlihat seperti ini: 

    () => {...}

  • tolak

    void

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

    Fungsi deny akan terlihat seperti ini: 

    () => {...}

HidPermissionRequest

Chrome 125 dan yang lebih baru

Jenis objek request yang menyertai peristiwa DOM hid permissionrequest.

Properti

  • url

    string

    URL frame yang meminta akses ke HID API.

  • izinkan

    void

    Berikan permintaan izin.

    Fungsi allow akan terlihat seperti ini: 

    () => {...}

  • tolak

    void

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

    Fungsi deny akan terlihat seperti ini: 

    () => {...}

InjectDetails

Detail skrip atau CSS yang akan dimasukkan. Kode atau properti file harus ditetapkan, tetapi keduanya tidak boleh ditetapkan bersamaan.

Properti

  • kode

    string opsional

    Kode JavaScript atau CSS yang akan dimasukkan.

    Peringatan: Hati-hati saat menggunakan parameter code. Penggunaan yang salah dapat menyebabkan aplikasi Anda rentan terkena serangan pembuatan skrip lintas situs.

  • file

    string opsional

    File JavaScript atau CSS yang akan dimasukkan.

InjectionItems

Chrome 44 dan yang lebih baru

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. Ini diinjeksikan sesuai urutan kemunculannya di array ini.

LoadPluginPermissionRequest

Jenis objek request yang menyertai peristiwa DOM loadplugin permissionrequest.

Properti

  • identifier

    string

    String ID plugin.

  • nama

    string

    Nama tampilan plugin.

  • izinkan

    void

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

    Fungsi allow akan terlihat seperti ini: 

    () => {...}

  • tolak

    void

    Menolak permintaan izin.

    Fungsi deny akan terlihat seperti ini: 

    () => {...}

MediaPermissionRequest

Jenis objek request yang menyertai peristiwa DOM media permissionrequest.

Properti

  • url

    string

    URL frame yang meminta akses ke media pengguna.

  • izinkan

    void

    Berikan permintaan izin.

    Fungsi allow akan terlihat seperti ini: 

    () => {...}

  • tolak

    void

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

    Fungsi deny akan terlihat seperti ini: 

    () => {...}

NewWindow

Antarmuka dilampirkan ke peristiwa DOM newwindow.

Properti

  • lampirkan

    void

    Lampirkan halaman target yang diminta ke elemen webview yang ada.

    Fungsi attach akan terlihat seperti ini: 

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

    • WebView

      objek

      Elemen webview tempat halaman target harus dilampirkan.

  • hapus

    void

    Batalkan permintaan jendela baru.

    Fungsi discard akan terlihat seperti ini: 

    () => {...}

PointerLockPermissionRequest

Jenis objek request yang menyertai peristiwa DOM pointerLock permissionrequest.

Properti

  • lastUnlockedBySelf

    boolean

    Apakah frame permintaan adalah klien terbaru yang menahan kunci pointer.

  • url

    string

    URL frame yang meminta kunci pointer.

  • userGesture

    boolean

    Apakah kunci pointer diminta sebagai akibat dari gestur input pengguna.

  • izinkan

    void

    Berikan permintaan izin.

    Fungsi allow akan terlihat seperti ini: 

    () => {...}

  • tolak

    void

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

    Fungsi deny akan terlihat seperti ini: 

    () => {...}

SelectionRect

Menggambarkan persegi panjang dalam koordinat layar.

Semantik pembatasan berbentuk seperti array; yaitu, koordinat (left, top) dianggap berada 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.

WebRequestEventInterface

Chrome 44 dan yang lebih baru

Antarmuka yang memberikan 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 menggambarkan perbedaan penggunaan dengan webRequest API ekstensi, pertimbangkan kode contoh berikut yang memblokir semua 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 webview webRequest deklaratif harus dibuat instance-nya dari pasangan chrome.webViewRequest.*. Kode contoh berikut memblokir semua permintaan ke "example.com" di myWebview webview secara deklaratif:

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

ZoomMode

Chrome 43 dan yang lebih baru

Menentukan cara penanganan zoom di webview.

Enum

"per-origin"
Perubahan zoom akan tetap ada di asal halaman yang di-zoom, yaitu semua webview lain di partisi yang sama yang diarahkan ke asal yang sama tersebut juga akan di-zoom. Selain itu, perubahan zoom per-origin disimpan dengan asalnya, yang berarti saat membuka halaman lain dalam asal yang sama, semua perubahan zoom akan diperbesar ke faktor zoom yang sama.

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

"disable"
Menonaktifkan semua zoom di webview. Konten akan dikembalikan 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 dan yang lebih baru

Serupa 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 menerapkan penambahan menu konteks, seperti gambar, hyperlink, dan halaman.

Jenis

ContextMenus

request

Antarmuka yang memberikan akses ke peristiwa webRequest di halaman tamu.

Jenis

WebRequestEventInterface

Metode

addContentScripts()

Chrome 44 dan yang lebih baru 
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)

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 dinavigasi ke asal (misalnya, foo.com) dan memanggil webview.addContentScripts untuk menambahkan 'myRule', Anda harus menunggu navigasi berikutnya untuk membuat skrip dimasukkan. Jika Anda ingin injeksi langsung, executeScript akan melakukan hal yang benar.

Aturan akan dipertahankan meskipun proses tamu mengalami error, dihentikan, atau bahkan jika webview di-reparent.

Lihat dokumentasi skrip konten untuk detail selengkapnya.

Parameter

back()

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

Menavigasi mundur satu entri histori jika memungkinkan. Setara dengan go(-1).

Parameter

  • callback

    fungsi opsional

    Chrome 44 dan yang lebih baru

    Parameter callback terlihat seperti ini: 

    (success: boolean) => void

    • berhasil

      boolean

      Menunjukkan apakah navigasi berhasil.

canGoBack()

chrome.webviewTag.canGoBack()

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

Hasil

  • boolean

canGoForward()

chrome.webviewTag.canGoForward()

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

Hasil

  • boolean

captureVisibleRegion()

Chrome 50 dan yang lebih baru 
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)

Menangkap region yang terlihat dari webview.

Parameter

  • opsi

    ImageDetails opsional

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (dataUrl: string) => void

    • dataUrl

      string

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

clearData()

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

Menghapus data penjelajahan untuk partisi webview.

Parameter

  • Opsi menentukan data mana yang akan dihapus.

  • Jenis data yang akan dihapus.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    () => void

executeScript()

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

Memasukkan kode JavaScript ke halaman tamu.

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

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

Parameter

  • detail

    InjectDetails

    Detail skrip yang akan dijalankan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (result?: any[]) => void

    • hasil

      setiap[] opsional

      Hasil skrip di setiap frame yang dimasukkan.

find()

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

Memulai permintaan cari-di-halaman.

Parameter

  • searchText

    string

    String yang akan ditemukan pada halaman.

  • opsi

    FindOptions opsional

    Opsi untuk permintaan pencarian.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (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 membedakan saat permintaan pencarian selesai.

forward()

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

Menavigasi satu entri histori ke depan jika memungkinkan. Setara dengan go(1).

Parameter

  • callback

    fungsi opsional

    Chrome 44 dan yang lebih baru

    Parameter callback terlihat seperti ini: 

    (success: boolean) => void

    • berhasil

      boolean

      Menunjukkan apakah navigasi berhasil.

getAudioState()

Chrome 62 dan yang lebih baru 
chrome.webviewTag.getAudioState(
  callback: function,
)

Meminta status audio.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (audible: boolean) => void

    • audible

      boolean

getProcessId()

chrome.webviewTag.getProcessId()

Menampilkan ID proses internal Chrome untuk proses halaman web tamu saat ini, yang memungkinkan sematan untuk mengetahui jumlah tamu yang akan terpengaruh jika menghentikan proses ini. Dua tamu akan berbagi proses hanya jika mereka adalah anggota aplikasi yang sama dan memiliki ID partisi penyimpanan yang sama. Panggilan tersebut sinkron dan menampilkan gagasan yang di-cache dari sematan dari ID proses saat ini. ID proses tidak sama dengan ID proses sistem operasi.

Hasil

  • angka

getUserAgent()

chrome.webviewTag.getUserAgent()

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

Hasil

  • string

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

Mendapatkan faktor zoom saat ini.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (zoomFactor: number) => void

    • zoomFactor

      angka

      Faktor zoom saat ini.

getZoomMode()

Chrome 43 dan yang lebih baru 
chrome.webviewTag.getZoomMode(
  callback: function,
)

Mendapatkan mode zoom saat ini.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      ZoomMode

      Mode zoom webview saat ini.

go()

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

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

Parameter

  • relativeIndex

    angka

    Indeks histori relatif tempat webview harus dibuka. Misalnya, nilai 2 akan maju 2 entri histori jika memungkinkan; nilai -3 akan menavigasi 3 entri mundur.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (success: boolean) => void

    • berhasil

      boolean

      Menunjukkan apakah navigasi berhasil.

insertCSS()

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

Memasukkan CSS ke halaman tamu.

Parameter

  • detail

    InjectDetails

    Detail CSS yang akan disisipkan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    () => void

isAudioMuted()

Chrome 62 dan yang lebih baru 
chrome.webviewTag.isAudioMuted(
  callback: function,
)

Mengkueri apakah audio dibisukan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (muted: boolean) => void

    • dibisukan

      boolean

isSpatialNavigationEnabled()

Chrome 71 dan yang lebih baru 
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

Mengkueri apakah navigasi spasial diaktifkan untuk webview atau tidak.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (enabled: boolean) => void

    • diaktifkan

      boolean

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

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

loadDataWithBaseUrl()

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

Memuat URL data dengan URL dasar tertentu yang digunakan untuk link relatif. Secara opsional, 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()

Mencetak konten webview. Ini sama dengan memanggil fungsi cetak dengan skrip dari webview itu sendiri.

reload()

chrome.webviewTag.reload()

Memuat ulang halaman tingkat teratas saat ini.

removeContentScripts()

Chrome 44 dan yang lebih baru 
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)

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 dan yang lebih baru 
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

Menyetel status bisukan audio webview.

Parameter

  • bisukan

    boolean

    Bisukan nilai audio

setSpatialNavigationEnabled()

Chrome 71 dan yang lebih baru 
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

Menetapkan status navigasi spasial webview.

Parameter

  • diaktifkan

    boolean

    Nilai status navigasi spasial.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

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

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 ini: 

    () => void

setZoomMode()

Chrome 43 dan yang lebih baru 
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

Menetapkan mode zoom webview.

Parameter

  • ZoomMode

    ZoomMode

    Menentukan cara penanganan zoom di webview.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    () => void

stop()

chrome.webviewTag.stop()

Berhenti memuat navigasi webview saat ini jika sedang berlangsung.

stopFinding()

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

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

Parameter

  • action

    "clear"
     | "keep"
     | "activate"
     opsional

    Menentukan apa yang harus dilakukan dengan pencocokan aktif setelah sesi penemuan berakhir. clear akan menghapus sorotan pada pencocokan aktif; keep akan membuat kecocokan aktif tetap disorot; activate akan membuat kecocokan aktif tetap disorot dan menyimulasikan klik pengguna pada kecocokan tersebut. Tindakan default-nya adalah keep.

terminate()

chrome.webviewTag.terminate()

Secara paksa menghentikan proses perender halaman web tamu. Tindakan ini dapat memengaruhi beberapa tag webview di aplikasi saat ini jika 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 menutupnya sendiri.

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

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

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    () => void

consolemessage

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

Diaktifkan saat jendela tamu mencatat pesan konsol.

Kode contoh berikut meneruskan semua pesan log ke konsol sematan 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 ini: 

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

    • yaitu tingkat klik

      angka

    • pesan

      string

    • baris

      angka

    • sourceId

      string

contentload

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

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

Kode contoh berikut mengubah ukuran font default elemen body tamu setelah halaman dimuat:

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

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    () => 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 ini: 

    (messageType: "alert" 
          | "confirm" 
          | "prompt" 
         , messageText: string, dialog: DialogController) => void

    • messageType

      "notifikasi"
       | "confirm"
       | "perintah"

    • messageText

      string

exit

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

Diaktifkan saat proses rendering konten web tamu telah keluar.

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

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

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (processID: number, reason: "normal" 
          | "abnormal" 
          | "crash" 
          | "kill" 
         ) => void

    • processID

      angka

    • alasan

      "normal"
       | "abnormal"
       | "crash"
       | "kill"

findupdate

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

Diaktifkan saat hasil temuan baru tersedia untuk permintaan pencarian aktif. Tindakan ini dapat terjadi beberapa kali untuk satu permintaan pencarian karena kecocokan ditemukan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (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 level teratas dibatalkan tanpa melakukan commit. Pesan error akan dicetak ke konsol kecuali jika peristiwa tersebut dicegah secara default.

Catatan: Saat 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: Saat pemuatan URL tentang atau URL JavaScript dibatalkan, loadabort akan diaktifkan, lalu webview akan dialihkan ke 'about:blank'.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (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

      string

    • isTopLevel

      boolean

    • kode

      angka

    • alasan

      "ERR_ABORTED"
       | &quot;ERR_INVALID_URL&quot;
       | &quot;ERR_DISALLOWED_URL_SCHEME&quot;
       | &quot;ERR_BLOCKED_BY_CLIENT&quot;
       | "ERR_ADDRESS_UNREACHABLE"
       | &quot;ERR_EMPTY_RESPONSE&quot;
       | &quot;ERR_FILE_NOT_FOUND&quot;
       | &quot;ERR_UNKNOWN_URL_SCHEME&quot;

loadcommit

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

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

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (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 ini: 

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

    • oldUrl

      string

    • newUrl

      string

    • isTopLevel

      boolean

loadstart

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

Diaktifkan saat beban dimulai.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (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 termasuk pemuatan resource asinkron. Peristiwa ini diaktifkan setiap kali jumlah transisi pemuatan tingkat dokumen dari satu (atau beberapa) ke nol. Misalnya, jika sebuah halaman yang sudah selesai dimuat (yaitu, loadstop sudah diaktifkan satu kali) membuat iframe baru yang memuat halaman, lalu loadstop kedua akan diaktifkan saat pemuatan halaman iframe selesai. Pola ini biasanya diamati 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 ini: 

    () => void

newwindow

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

Diaktifkan saat halaman tamu mencoba membuka jendela browser baru.

Kode contoh berikut akan membuat dan membuka webview baru dalam sematan 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 ini: 

    (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

    • jendela

      NewWindow

    • targetUrl

      string

    • initialWidth

      angka

    • initialHeight

      angka

    • nama

      string

    • windowOpenDisposition

      "abaikan"
       | "save_to_disk"
       | "current_tab"
       | &quot;new_background_tab&quot;
       | "new_foreground_tab"
       | "new_window"
       | "popup_baru"

permissionrequest

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

Diaktifkan saat halaman tamu perlu meminta izin khusus dari sematan.

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

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

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (permission: "media" 
          | "geolocation" 
          | "pointerLock" 
          | "download" 
          | "loadplugin" 
          | "filesystem" 
          | "fullscreen" 
          | "hid" 
         , request: object) => void

    • izin

      "media"
       | "geolokasi"
       | "pointerLock"
       | "download"
       | "loadplugin"
       | "sistem file"
       | "layar penuh"
       | "disembunyikan"

    • minta

      objek

responsive

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

Diaktifkan saat proses merender konten web tamu menjadi responsif lagi setelah tidak responsif.

Kode contoh berikut akan memudarkan elemen webview saat elemen tersebut 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 ini: 

    (processID: number) => void

    • processID

      angka

sizechanged

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

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

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (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 rendering konten web tamu tidak responsif. Peristiwa ini akan dibuat sekali dengan peristiwa responsif yang cocok jika tamu mulai merespons lagi.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

    (processID: number) => void

    • processID

      angka

zoomchange

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

Diaktifkan jika zoom halaman berubah.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

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

    • oldZoomFactor

      angka

    • newZoomFactor

      angka