Deskripsi
Gunakan tag webview
untuk memuat konten live dari web melalui jaringan secara aktif dan menyematkannya di Aplikasi Chrome. 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
Jenis
ClearDataOptions
Opsi yang menentukan data yang harus dihapus oleh clearData
.
Properti
-
sejak
nomor opsional
Menghapus data yang terakumulasi pada atau setelah tanggal ini, yang direpresentasikan dalam milidetik sejak epoch (dapat diakses melalui metode getTime dari objek
Date
JavaScript). Jika tidak ada, setelan defaultnya adalah0
(yang akan menghapus semua data penjelajahan).
ClearDataTypeSet
Kumpulan jenis data. Properti yang tidak ada ditafsirkan sebagai false
.
Properti
-
cache aplikasi
boolean opsional
Appcache situs.
-
cache
boolean opsional
Chrome 44+Mulai Chrome 43. Cache browser. Catatan: saat menghapus data, tindakan ini akan menghapus seluruh cache; ini tidak terbatas pada rentang yang Anda tetapkan.
-
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
Detail skrip konten yang akan dimasukkan. Lihat dokumentasi skrip konten untuk detail selengkapnya.
Properti
-
all_frames
boolean opsional
Jika
all_frames
adalahtrue
, ini menyiratkan bahwa JavaScript atau CSS harus dimasukkan ke semua frame halaman saat ini. Secara default,all_frames
adalahfalse
dan JavaScript atau CSS hanya dimasukkan ke dalam bingkai atas. -
css
InjectionItems opsional
Kode CSS atau daftar file CSS yang akan dimasukkan ke halaman yang cocok. Semua ini dimasukkan sesuai urutan kemunculannya, sebelum DOM dibuat atau ditampilkan untuk halaman tersebut.
-
exclude_globs
string[] opsional
Diterapkan setelah kecocokan untuk mengecualikan URL yang cocok dengan glob ini. Dimaksudkan untuk mengemulasi kata kunci @exclude GreaseMonkey.
-
exclude_matches
string[] opsional
Mengecualikan halaman tempat skrip konten ini akan dimasukkan ke dalamnya.
-
include_globs
string[] opsional
Diterapkan setelah kecocokan untuk hanya menyertakan URL yang juga cocok dengan glob ini. Dimaksudkan untuk mengemulasi kata kunci @include GreaseMonkey.
-
js
InjectionItems opsional
Kode JavaScript atau daftar file JavaScript yang akan dimasukkan ke halaman yang cocok. Ini akan dimasukkan sesuai urutan kemunculannya.
-
match_about_blank
boolean opsional
Apakah akan menyisipkan skrip konten tentang about:blank dan about:srcdoc. Skrip konten hanya akan dimasukkan pada halaman jika URL yang diwariskan cocok dengan salah satu pola yang dinyatakan di kolom kecocokan. URL yang diwariskan adalah URL dari dokumen yang membuat bingkai atau jendela. Skrip konten tidak dapat disisipkan dalam frame dengan sandbox.
-
cocok dengan
string[]
Menentukan halaman tempat skrip konten akan dimasukkan.
-
name
string
Nama skrip konten yang akan dimasukkan.
-
run_at
RunAt opsional
Secepatnya JavaScript atau CSS akan dimasukkan ke dalam 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 penyemat dengan memposting pesan ke
event.source
pada peristiwa pesan yang diterimanya.API ini identik dengan HTML5 postMessage API untuk komunikasi antar-halaman. Penyemat dapat memproses balasan dengan menambahkan pemroses peristiwa
message
ke frame-nya sendiri.Fungsi
postMessage
terlihat seperti:(message: any, targetOrigin: string) => {...}
-
pesan
apa pun
Objek pesan yang akan dikirim ke tamu.
-
targetOrigin
string
Menentukan apa yang harus menjadi asal jendela tamu untuk peristiwa yang akan dikirim.
-
ContextMenuCreateProperties
Properti
-
dicentang
boolean opsional
Keadaan awal kotak centang atau item radio: benar untuk yang dipilih dan salah untuk yang tidak dipilih. Hanya satu item radio yang dapat dipilih pada satu waktu di grup item radio tertentu.
-
konteks
[ContextType, ...ContextType[]] opsional
Daftar konteks akan menampilkan item menu ini. Setelan default-nya adalah ['page'] jika tidak ditentukan.
-
documentUrlPatterns
string[] opsional
Memungkinkan Anda membatasi item agar hanya diterapkan pada dokumen yang URL-nya cocok dengan salah satu pola yang ditentukan. (Ini juga berlaku untuk bingkai.) Untuk detail tentang format pola, lihat Mencocokkan 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 | number opsional
ID item menu induk; ini membuat item menjadi turunan dari item yang ditambahkan sebelumnya.
-
targetUrlPatterns
string[] opsional
Mirip dengan documentUrlPatterns, tetapi memungkinkan Anda memfilter berdasarkan atribut
src
dari tag img/audio/video danhref
tag anchor. -
title
string opsional
Teks yang akan ditampilkan dalam item; ini wajib, kecuali jika
type
adalah 'pemisah'. Jika konteksnya adalah 'selection', Anda dapat menggunakan%s
dalam string untuk menampilkan teks yang dipilih. Misalnya, jika nilai parameter ini adalah "Translate '%s' to Pig Latin" dan pengguna memilih kata "cool", item menu konteks untuk pilihan tersebut adalah "Translate 'cool' to Pig Latin". -
tipe
ItemType opsional
Jenis item menu. Jika tidak ditentukan, setelan defaultnya adalah 'normal'.
-
onclick
membatalkan opsional
Fungsi yang akan dipanggil kembali saat item menu diklik.
Fungsi
onclick
terlihat seperti:(info: OnClickData) => {...}
-
info
Informasi tentang item yang diklik dan konteks tempat klik terjadi.
-
ContextMenus
Properti
-
onShow
Peristiwa<functionvoidvoid>
Diaktifkan sebelum menampilkan menu konteks pada
webview
ini. Dapat digunakan untuk menonaktifkan menu konteks ini dengan memanggilevent.preventDefault()
.Fungsi
onShow.addListener
terlihat seperti:(callback: function) => {...}
-
callback
fungsi
Parameter
callback
terlihat seperti:(event: object) => void
-
event
objek
-
preventDefault
void
Panggil ini agar menu konteks tidak ditampilkan.
Fungsi
preventDefault
terlihat seperti:() => {...}
-
-
-
-
create
void
Membuat item menu konteks baru. Perhatikan bahwa jika terjadi error selama pembuatan, Anda mungkin tidak mengetahuinya hingga callback pembuatan diaktifkan (detailnya dapat dilihat 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
-
akan menampilkan
string | angka
ID item yang baru dibuat.
-
-
hapus
void
Menghapus item menu konteks.
Fungsi
remove
terlihat seperti:(menuItemId: string | number, callback?: function) => {...}
-
string | angka
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
-
-
ubah
void
Memperbarui item menu konteks yang dibuat sebelumnya.
Fungsi
update
terlihat seperti:(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:() => void
-
ContextMenuUpdateProperties
Properti
-
dicentang
boolean opsional
Keadaan kotak centang atau item radio: benar untuk yang dipilih dan salah untuk yang tidak dipilih. Hanya satu item radio yang dapat dipilih pada satu waktu di grup item radio tertentu.
-
konteks
[ContextType, ...ContextType[]] opsional
Daftar konteks akan menampilkan item menu ini.
-
documentUrlPatterns
string[] opsional
Memungkinkan Anda membatasi item agar hanya diterapkan pada dokumen yang URL-nya cocok dengan salah satu pola yang ditentukan. (Ini juga berlaku untuk bingkai.) Untuk detail tentang format pola, lihat Mencocokkan Pola.
-
diaktifkan
boolean opsional
Apakah item menu konteks ini diaktifkan atau dinonaktifkan.
-
parentId
string | number opsional
ID item menu induk; ini membuat item menjadi turunan dari item yang ditambahkan sebelumnya. Catatan: Anda tidak dapat mengubah item menjadi turunan dari salah satu turunannya.
-
targetUrlPatterns
string[] opsional
Mirip dengan documentUrlPatterns, tetapi memungkinkan Anda memfilter berdasarkan atribut
src
dari tag img/audio/video danhref
tag anchor. -
title
string opsional
Teks yang akan ditampilkan dalam item
-
tipe
ItemType opsional
Jenis item menu.
-
onclick
membatalkan opsional
Fungsi yang akan dipanggil kembali saat item menu diklik.
Fungsi
onclick
terlihat seperti:(info: OnClickData) => {...}
-
info
Informasi tentang item yang diklik dan konteks tempat klik terjadi.
-
ContextType
Berbagai konteks yang dapat menampilkan menu. Menetapkan 'all' sama dengan kombinasi semua konteks lainnya.
Enum
"selection"
"link"
"video"
"audio"
DialogController
Antarmuka dilampirkan ke dialog
peristiwa DOM.
Properti
-
batal
void
Tolak dialog. Sama dengan mengklik Batal dalam dialog
confirm
atauprompt
.Fungsi
cancel
terlihat seperti:() => {...}
-
oke
void
Setujui dialog. Setara dengan mengklik Oke dalam dialog
alert
,confirm
, atauprompt
.Fungsi
ok
terlihat seperti:(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
Izinkan permintaan izin.
Fungsi
allow
terlihat seperti:() => {...}
-
tolak
void
Menolak permintaan izin. Ini adalah perilaku default jika
allow
tidak dipanggil.Fungsi
deny
terlihat seperti:() => {...}
FileSystemPermissionRequest
Jenis objek request
yang menyertai peristiwa DOM filesystem
permissionrequest
.
Properti
-
url
string
URL frame yang meminta akses ke sistem file lokal.
-
izinkan
void
Izinkan permintaan izin.
Fungsi
allow
terlihat seperti:() => {...}
-
tolak
void
Menolak permintaan izin.
Fungsi
deny
terlihat seperti:() => {...}
FindCallbackResults
Berisi semua hasil permintaan pencarian.
Properti
-
activeMatchOrdinal
angka
Nomor ordinal kecocokan saat ini.
-
dibatalkan
boolean
Menunjukkan apakah permintaan pencarian ini dibatalkan.
-
numberOfMatches
angka
Frekuensi
searchText
dicocokkan di halaman. -
selectionRect
Menjelaskan persegi panjang di sekitar kecocokan aktif dalam koordinat layar.
FindOptions
Opsi untuk permintaan penemuan.
Properti
-
mundur
boolean opsional
Tandai untuk menemukan kecocokan dalam urutan terbalik. Nilai default-nya adalah
false
. -
matchCase
boolean opsional
Tanda agar cocok dengan peka huruf besar/kecil. Nilai default-nya adalah
false
.
FullscreenPermissionRequest
Jenis objek request
yang menyertai peristiwa DOM fullscreen
permissionrequest
.
Properti
-
asal
string
Asal frame di dalam
webview
yang memulai permintaan layar penuh. -
izinkan
void
Izinkan permintaan izin.
Fungsi
allow
terlihat seperti:() => {...}
-
tolak
void
Menolak permintaan izin.
Fungsi
deny
terlihat seperti:() => {...}
GeolocationPermissionRequest
Jenis objek request
yang menyertai peristiwa DOM geolocation
permissionrequest
.
Properti
-
url
string
URL frame yang meminta akses ke data geolokasi.
-
izinkan
void
Izinkan permintaan izin.
Fungsi
allow
terlihat seperti:() => {...}
-
tolak
void
Menolak permintaan izin. Ini adalah perilaku default jika
allow
tidak dipanggil.Fungsi
deny
terlihat seperti:() => {...}
HidPermissionRequest
Jenis objek request
yang menyertai peristiwa DOM hid
permissionrequest
.
Properti
-
url
string
URL frame yang meminta akses ke HID API.
-
izinkan
void
Izinkan permintaan izin.
Fungsi
allow
terlihat seperti:() => {...}
-
tolak
void
Menolak permintaan izin. Ini adalah perilaku default jika
allow
tidak dipanggil.Fungsi
deny
terlihat seperti:() => {...}
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: Berhati-hatilah saat menggunakan parameter
code
. Penggunaan yang salah dapat membuat aplikasi Anda rentan terkena serangan pembuatan skrip lintas situs. -
file
string opsional
file JavaScript atau CSS yang akan dimasukkan.
InjectionItems
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 akan dimasukkan sesuai urutan kemunculannya dalam array ini.
LoadPluginPermissionRequest
Jenis objek request
yang menyertai peristiwa DOM loadplugin
permissionrequest
.
Properti
-
ID
string
String ID plugin.
-
name
string
Nama tampilan plugin.
-
izinkan
void
Izinkan permintaan izin. Ini adalah perilaku default jika
deny
tidak dipanggil.Fungsi
allow
terlihat seperti:() => {...}
-
tolak
void
Menolak permintaan izin.
Fungsi
deny
terlihat seperti:() => {...}
MediaPermissionRequest
Jenis objek request
yang menyertai peristiwa DOM media
permissionrequest
.
Properti
-
url
string
URL frame yang meminta akses ke media pengguna.
-
izinkan
void
Izinkan permintaan izin.
Fungsi
allow
terlihat seperti:() => {...}
-
tolak
void
Menolak permintaan izin. Ini adalah perilaku default jika
allow
tidak dipanggil.Fungsi
deny
terlihat seperti:() => {...}
NewWindow
Antarmuka dilampirkan ke newwindow
peristiwa DOM.
Properti
-
pasang
void
Lampirkan halaman target yang diminta ke elemen
webview
yang ada.Fungsi
attach
terlihat seperti:(webview: object) => {...}
-
webview
objek
Elemen
webview
tempat halaman target harus dilampirkan.
-
-
hapus
void
Batalkan permintaan jendela baru.
Fungsi
discard
terlihat seperti:() => {...}
PointerLockPermissionRequest
Jenis objek request
yang menyertai peristiwa DOM pointerLock
permissionrequest
.
Properti
-
lastUnlockedBySelf
boolean
Apakah frame yang meminta adalah klien terbaru yang menahan kunci pointer atau bukan.
-
url
string
URL frame yang meminta kunci pointer.
-
userGesture
boolean
Apakah kunci pointer diminta atau tidak sebagai hasil dari gestur input pengguna.
-
izinkan
void
Izinkan permintaan izin.
Fungsi
allow
terlihat seperti:() => {...}
-
tolak
void
Menolak permintaan izin. Ini adalah perilaku default jika
allow
tidak dipanggil.Fungsi
deny
terlihat seperti:() => {...}
SelectionRect
Menjelaskan persegi panjang dalam koordinat layar.
Semantik pembatasan bersifat seperti array; yaitu, koordinat (left, top)
dianggap dimuat oleh persegi panjang, tetapi koordinat (left + width, top)
tidak.
Properti
-
tinggi
angka
Tinggi persegi panjang.
-
lagi
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
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 menggambarkan perbedaan penggunaan dengan webRequest API ekstensi, pertimbangkan kode contoh 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 instance-nya dari chrome.webViewRequest.*
yang serupa. Kode contoh berikut secara deklaratif memblokir semua permintaan ke "example.com"
di myWebview
webview:
var rule = {
conditions: [
new chrome.webViewRequest.RequestMatcher({ url: { hostSuffix: 'example.com' } })
],
actions: [ new chrome.webViewRequest.CancelRequest() ]
};
myWebview.request.onRequest.addRules([rule]);
ZoomMode
Menentukan cara zoom ditangani di webview
.
Enum
"per origin"
Perubahan zoom akan tetap ada di origin halaman yang di-zoom, yaitu semua webview lain di partisi yang sama yang diarahkan ke origin yang sama juga akan di-zoom. Selain itu, perubahan zoom per-origin
disimpan dengan asal, artinya saat membuka halaman lain dengan asal yang sama, semuanya akan di-zoom ke faktor zoom yang sama.
"per-tampilan"
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
akan direset saat navigasi; menavigasi webview akan selalu memuat halaman dengan faktor zoom per originnya (dalam cakupan partisi).
"disabled"
Menonaktifkan semua zoom di webview. Konten akan dikembalikan ke tingkat zoom default, dan semua percobaan perubahan zoom akan diabaikan.
Properti
contentWindow
Referensi objek yang dapat digunakan untuk memposting pesan ke halaman tamu.
Jenis
contextMenus
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 dengan penambahan menu konteks, seperti gambar, hyperlink, dan halaman.
Jenis
request
Antarmuka yang menyediakan akses ke peristiwa webRequest di halaman tamu.
Jenis
Metode
addContentScripts()
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 secara terprogram atau memperbarui aturan yang sudah ada.
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 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 asal (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, dimatikan, atau bahkan jika webview
di-reparent.
Lihat dokumentasi skrip konten untuk detail selengkapnya.
Parameter
-
contentScriptList
Detail skrip konten yang akan ditambahkan.
back()
chrome.webviewTag.back(
callback?: function,
)
Menavigasi mundur 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.
-
canGoBack()
chrome.webviewTag.canGoBack()
Menunjukkan apakah Anda dapat menavigasi mundur melalui histori atau tidak. Status fungsi ini di-cache dan diperbarui sebelum setiap loadcommit
, sehingga tempat terbaik untuk memanggilnya adalah di loadcommit
.
Hasil
-
boolean
canGoForward()
chrome.webviewTag.canGoForward()
Menunjukkan apakah Anda dapat menavigasi maju atau tidak menelusuri riwayat. Status fungsi ini di-cache dan diperbarui sebelum setiap loadcommit
, sehingga tempat terbaik untuk memanggilnya adalah di loadcommit
.
Hasil
-
boolean
captureVisibleRegion()
chrome.webviewTag.captureVisibleRegion(
options?: ImageDetails,
callback: function,
)
Merekam wilayah webview yang terlihat.
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,
)
Menghapus data penjelajahan untuk partisi webview
.
Parameter
-
opsi
Opsi yang menentukan data mana yang akan dihapus.
-
tipe
Jenis data yang akan dihapus.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
executeScript()
chrome.webviewTag.executeScript(
details: InjectDetails,
callback?: function,
)
Memasukkan kode JavaScript ke halaman tamu.
Kode contoh berikut menggunakan injeksi skrip untuk menyetel warna latar belakang halaman tamu menjadi merah:
webview.executeScript({ code: "document.body.style.backgroundColor = 'red'" });
Parameter
-
detail
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,
)
Memulai permintaan cari-di-halaman.
Parameter
-
searchText
string
String yang akan ditemukan di halaman.
-
opsi
FindOptions opsional
Opsi untuk permintaan penemuan.
-
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 membedakan saat permintaan find telah selesai.
-
forward()
chrome.webviewTag.forward(
callback?: function,
)
Menavigasi 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.webviewTag.getAudioState(
callback: function,
)
Status audio kueri.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(audible: boolean) => void
-
audible
boolean
-
getProcessId()
chrome.webviewTag.getProcessId()
Menampilkan ID proses internal Chrome untuk proses halaman web tamu saat ini, yang memungkinkan penyemat mengetahui jumlah tamu yang akan terpengaruh jika proses berhenti. Dua tamu akan berbagi proses hanya jika mereka berada di aplikasi yang sama dan memiliki ID partisi penyimpanan yang sama. Panggilan ini 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()
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:(zoomFactor: number) => void
-
zoomFactor
angka
Faktor zoom saat ini.
-
getZoomMode()
chrome.webviewTag.getZoomMode(
callback: function,
)
Mendapatkan mode zoom saat ini.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(ZoomMode: ZoomMode) => void
-
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 mungkin dilakukan, metode ini tidak akan berpengaruh.
Parameter
-
relativeIndex
angka
Indeks histori relatif tempat
webview
harus dibuka. Misalnya, nilai2
akan menavigasi 2 entri histori maju jika memungkinkan; nilai-3
akan menavigasi 3 entri mundur. -
callback
fungsi opsional
Parameter
callback
terlihat seperti:(success: boolean) => void
-
berhasil
boolean
Menunjukkan apakah navigasi berhasil.
-
insertCSS()
chrome.webviewTag.insertCSS(
details: InjectDetails,
callback?: function,
)
Memasukkan CSS ke halaman tamu.
Parameter
-
detail
Detail CSS yang akan disisipkan.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
isAudioMuted()
chrome.webviewTag.isAudioMuted(
callback: function,
)
Menanyakan apakah audio dibisukan.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(muted: boolean) => void
-
dibisukan
boolean
-
isSpatialNavigationEnabled()
chrome.webviewTag.isSpatialNavigationEnabled(
callback: function,
)
Menanyakan apakah navigasi spasial diaktifkan untuk webview.
Parameter
-
fungsi
Parameter
callback
terlihat seperti:(enabled: boolean) => void
-
boolean
-
isUserAgentOverridden()
chrome.webviewTag.isUserAgentOverridden()
Menunjukkan apakah string agen pengguna webview
telah diganti oleh webviewTag.setUserAgentOverride
atau tidak.
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 atas saat ini.
removeContentScripts()
chrome.webviewTag.removeContentScripts(
scriptNameList?: string[],
)
Menghapus skrip konten dari webview
.
Contoh berikut menghapus "myRule" yang telah 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.webviewTag.setAudioMuted(
mute: boolean,
)
Menyetel status membisukan audio webview.
Parameter
-
bisukan
boolean
Bisukan nilai audio
setSpatialNavigationEnabled()
chrome.webviewTag.setSpatialNavigationEnabled(
enabled: boolean,
)
Menetapkan status navigasi spasial webview.
Parameter
-
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:() => void
setZoomMode()
chrome.webviewTag.setZoomMode(
ZoomMode: ZoomMode,
callback?: function,
)
Menetapkan mode zoom webview
.
Parameter
-
ZoomMode
Menentukan cara zoom ditangani di
webview
. -
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
stop()
chrome.webviewTag.stop()
Menghentikan pemuatan 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
opsional
Menentukan apa yang harus dilakukan dengan pencocokan aktif setelah sesi pencarian berakhir.
clear
akan menghapus sorotan pada pencocokan aktif;keep
akan membuat pencocokan aktif tetap ditandai;activate
akan membuat pencocokan aktif ditandai dan menyimulasikan klik pengguna pada pencocokan tersebut. Tindakan default-nya adalahkeep
.
terminate()
chrome.webviewTag.terminate()
Secara paksa mematikan proses perender halaman web tamu. Hal ini dapat memengaruhi beberapa tag webview
di aplikasi saat ini jika tag tersebut memiliki 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 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.
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
-
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:() => void
dialog
chrome.webviewTag.dialog.addListener(
callback: function,
)
Diaktifkan saat jendela tamu mencoba membuka dialog modal melalui window.alert
, window.confirm
, atau window.prompt
.
Penanganan peristiwa ini akan memblokir proses tamu hingga setiap pemroses peristiwa ditampilkan atau objek dialog
menjadi tidak dapat dijangkau (jika preventDefault()
dipanggil.)
Perilaku default-nya adalah membatalkan dialog.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(messageType: "alert"
| "confirm"
| "prompt"
, messageText: string, dialog: DialogController) => void-
messageType
"alert"
| "konfirmasi"
| "prompt"
-
messageText
string
-
dialog
-
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 error:
webview.addEventListener('exit', function(e) {
if (e.reason === 'crash') {
webview.src = 'data:text/plain,Goodbye, world!';
}
});
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(processID: number, reason: "normal"
| "abnormal"
| "crash"
| "kill"
) => void-
processID
angka
-
alasan
"normal"
| "abnormal"
| "error"
| "kill"
-
findupdate
chrome.webviewTag.findupdate.addListener(
callback: function,
)
Diaktifkan saat hasil temuan baru tersedia untuk permintaan pencarian aktif. Hal ini dapat terjadi beberapa kali untuk satu permintaan penemuan saat ditemukan kecocokan.
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
-
dibatalkan
boolean
-
finalUpdate
string
-
loadabort
chrome.webviewTag.loadabort.addListener(
callback: function,
)
Diaktifkan saat beban tingkat atas telah dibatalkan tanpa melakukan commit. Pesan error akan dicetak ke konsol kecuali 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 diarahkan ke 'about:blank'.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(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"
| "ERR_INVALID_URL"
| "ERR_DISALLOWED_URL_SCHEME"
| "ERR_BLOCKED_BY_CLIENT"
| "ERR_ADDRESS_UNREACHABLE"
| "ERR_HETY_RESPONSE"
-
loadcommit
chrome.webviewTag.loadcommit.addListener(
callback: function,
)
Diaktifkan saat beban telah di-commit. Hal ini termasuk navigasi dalam dokumen saat ini serta pemuatan tingkat dokumen subframe, tetapi tidak termasuk 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 atas telah dialihkan ke URL lain.
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 level frame di halaman tamu (termasuk semua subframe-nya) telah selesai. Hal ini termasuk navigasi dalam dokumen saat ini serta pemuatan tingkat dokumen subframe, tetapi tidak termasuk pemuatan resource asinkron. Peristiwa ini aktif setiap kali jumlah pemuatan tingkat dokumen beralih dari satu (atau beberapa) ke nol. Misalnya, jika halaman yang telah selesai dimuat (yaitu, loadstop
telah diaktifkan satu kali) 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 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 membuka webview
baru di penyemat 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: "ignore"
| "save_to_disk"
| "current_tab"
| "new_background_tab"
| "new_foreground_tab"
| "new_window"
| "new_popup"
) => void-
jendela
-
targetUrl
string
-
initialWidth
angka
-
initialHeight
angka
-
name
string
-
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 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: "media"
| "geolocation"
| "pointerLock"
| "download"
| "loadplugin"
| "filesystem"
| "fullscreen"
| "hid"
, request: object) => void-
izin
"media"
| "geolocation"
| "pointerLock"
| "download"
| "loadplugin"
| "filesystem"
| "fullscreen"
| "hid"
-
minta
objek
-
responsive
chrome.webviewTag.responsive.addListener(
callback: function,
)
Diaktifkan saat proses rendering konten web tamu menjadi responsif lagi setelah tidak responsif.
Kode contoh berikut akan memudarkan elemen webview
masuk atau keluar 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 satu kali 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
-