หน้านี้เป็นส่วนหนึ่งของเอกสารประกอบสำหรับแพลตฟอร์มแอป Chrome ซึ่งเลิกใช้งานไปในปี 2020 โดยจะยังรองรับลูกค้า Enterprise และ Education ใน ChromeOS จนถึงเดือนมกราคม 2025 เป็นอย่างน้อย ดูข้อมูลเพิ่มเติมเกี่ยวกับการย้ายข้อมูลแอป

หน้านี้ได้รับการแปลโดย Cloud Translation API

chrome.webviewTag

คำอธิบาย

ใช้แท็ก webview เพื่อโหลดเนื้อหาสดจากเว็บผ่านเครือข่ายและฝังไว้ในแอป Chrome แอปของคุณจะควบคุมลักษณะที่ปรากฏของ webview และโต้ตอบกับเนื้อหาเว็บ เริ่มการนำทางในหน้าเว็บที่ฝัง ตอบสนองต่อเหตุการณ์ข้อผิดพลาดที่เกิดขึ้นภายใน และอื่นๆ ได้ (ดูการใช้งาน)

สิทธิ์

webview

ประเภท

ClearDataOptions

ตัวเลือกที่กำหนดข้อมูลที่ clearData ควรล้าง

พร็อพเพอร์ตี้

ตั้งแต่

หมายเลข ไม่บังคับ

ล้างข้อมูลที่สะสมในวันที่นี้หรือหลังจากนั้น โดยแสดงเป็นมิลลิวินาทีตั้งแต่ Epoch (เข้าถึงได้ผ่านเมธอด getTime ของออบเจ็กต์ Date ของ JavaScript) หากไม่ระบุ ค่าเริ่มต้นจะเป็น 0 (ซึ่งจะนำข้อมูลการท่องเว็บทั้งหมดออก)

ClearDataTypeSet

ชุดข้อมูลประเภทต่างๆ ระบบจะตีความพร็อพเพอร์ตี้ที่ขาดหายไปเป็น false

พร็อพเพอร์ตี้

Appcache

บูลีน ไม่บังคับ

เว็บไซต์ appcaches
แคช

บูลีน ไม่บังคับ

Chrome 44 ขึ้นไป

ตั้งแต่ Chrome 43 เป็นต้นไป แคชของเบราว์เซอร์ หมายเหตุ: เมื่อนำข้อมูลออก การดำเนินการนี้จะล้างแคชทั้งหมด ไม่จำกัดเฉพาะช่วงที่คุณระบุ
คุกกี้

บูลีน ไม่บังคับ

คุกกี้ของพาร์ติชัน
fileSystems

บูลีน ไม่บังคับ

เว็บไซต์ ของระบบไฟล์ได้อีกด้วย
indexedDB

บูลีน ไม่บังคับ

เว็บไซต์ ข้อมูล IndexedDB
localStorage

บูลีน ไม่บังคับ

เว็บไซต์ ข้อมูลที่จัดเก็บในตัวเครื่อง
persistentCookies

บูลีน ไม่บังคับ

Chrome 58 ขึ้นไป

คุกกี้ถาวรของพาร์ติชัน
sessionCookies

บูลีน ไม่บังคับ

Chrome 58 ขึ้นไป

คุกกี้เซสชันของพาร์ติชัน
webSQL

บูลีน ไม่บังคับ

เว็บไซต์ ข้อมูล WebSQL

ContentScriptDetails

Chrome 44 ขึ้นไป

รายละเอียดของสคริปต์เนื้อหาที่จะแทรก ดูรายละเอียดเพิ่มเติมได้ในเอกสารประกอบของสคริปต์เนื้อหา

พร็อพเพอร์ตี้

all_frames

บูลีน ไม่บังคับ

หาก all_frames คือ true ก็หมายความว่าควรแทรก JavaScript หรือ CSS ลงในเฟรมทั้งหมดของหน้าปัจจุบัน โดยค่าเริ่มต้น all_frames คือ false และระบบจะแทรก JavaScript หรือ CSS ลงในเฟรมบนสุดเท่านั้น
CSS

InjectionItems ไม่บังคับ

โค้ด CSS หรือรายการไฟล์ CSS ที่จะแทรกลงในหน้าที่ตรงกัน ข้อมูลเหล่านี้จะแทรกตามลำดับที่ปรากฏ ก่อนที่จะมีการสร้างหรือแสดง DOM สำหรับหน้าเว็บ
exclude_globs

string[] ไม่บังคับ

ใช้หลังการจับคู่เพื่อยกเว้น URL ที่ตรงกับ glob นี้ มีวัตถุประสงค์เพื่อจำลองคีย์เวิร์ด @exclude Greasemonkey
exclude_matches

string[] ไม่บังคับ

ยกเว้นหน้าที่มีการแทรกสคริปต์เนื้อหานี้
include_globs

string[] ไม่บังคับ

ใช้หลังการจับคู่เพื่อรวมเฉพาะ URL ที่ตรงกับ glob นี้ด้วย มีวัตถุประสงค์เพื่อจำลองคีย์เวิร์ด @include Greasemonkey
JS

InjectionItems ไม่บังคับ

โค้ด JavaScript หรือรายการไฟล์ JavaScript ที่จะแทรกลงในหน้าที่ตรงกัน ซึ่งจะแทรกตามลำดับที่ปรากฏ
match_about_blank

บูลีน ไม่บังคับ

เลือกว่าจะแทรกสคริปต์เนื้อหาใน about:blank และ about:srcdoc หรือไม่ ระบบจะแทรกสคริปต์เนื้อหาในหน้าเว็บเมื่อ URL ที่รับช่วงมาตรงกับรูปแบบที่ประกาศไว้อย่างใดอย่างหนึ่งในช่องที่ตรงกันเท่านั้น URL ที่รับช่วงมาคือ URL ของเอกสารที่สร้างเฟรมหรือหน้าต่าง ไม่สามารถแทรกสคริปต์เนื้อหาในเฟรมแซนด์บ็อกซ์
ตรงกับ

สตริง[]

ระบุหน้าที่จะแทรกสคริปต์เนื้อหานี้
ชื่อ

สตริง

ชื่อของสคริปต์เนื้อหาที่จะแทรก
run_at

RunAt ไม่บังคับ

ที่เร็วที่สุดที่จะมีการแทรก JavaScript หรือ CSS ลงในแท็บ ค่าเริ่มต้นคือ "document_idle"

ContentWindow

แฮนเดิลข้อความไปยังหน้าต่างผู้มาเยือน

พร็อพเพอร์ตี้

postMessage

เป็นโมฆะ

โพสต์ข้อความไปยังเนื้อหาเว็บที่ฝังอยู่ตราบใดที่เนื้อหาที่ฝังแสดงหน้าเว็บจากต้นทางเป้าหมาย วิธีนี้สามารถใช้ได้เมื่อโหลดหน้าเว็บเสร็จสมบูรณ์ ฟังเหตุการณ์ contentload แล้วเรียกใช้เมธอด

ผู้เข้าร่วมจะสามารถส่งข้อความตอบกลับไปยังเครื่องมือฝังได้โดยการโพสต์ข้อความไปยัง event.source ในกิจกรรมข้อความที่ได้รับ

API นี้เหมือนกับ HTML5 postMessage API สำหรับการสื่อสารระหว่างหน้าเว็บ เครื่องมือฝังอาจฟังการตอบกลับโดยเพิ่ม Listener เหตุการณ์ message ลงในเฟรมของตัวเอง

ฟังก์ชัน postMessage มีลักษณะดังนี้
```
(message: any, targetOrigin: string) => {...}
```
- ข้อความ
  
  ใดๆ
  
  ออบเจ็กต์ข้อความที่จะส่งให้ผู้เข้าร่วม
- targetOrigin
  
  สตริง
  
  ระบุต้นทางของหน้าต่างผู้เข้าร่วมสำหรับการนำส่งกิจกรรม

ContextMenuCreateProperties

Chrome 44 ขึ้นไป

พร็อพเพอร์ตี้

เลือกไว้

บูลีน ไม่บังคับ

สถานะเริ่มต้นของช่องทำเครื่องหมายหรือรายการตัวเลือก: "จริง" สำหรับ "เลือกแล้ว" และ "เท็จ" หากไม่ได้เลือก โดยเลือกได้เพียงครั้งละ 1 รายการในกลุ่มรายการตัวเลือกที่กำหนด
บริบท

[ContextType, ...ContextType[]] ไม่บังคับ

รายการบริบทที่รายการในเมนูนี้จะปรากฏ ค่าเริ่มต้นคือ ['page'] หากไม่ได้ระบุไว้
documentUrlPatterns

string[] ไม่บังคับ

อนุญาตให้คุณจำกัดรายการให้ใช้ได้เฉพาะกับเอกสารที่มี URL ตรงกับรูปแบบใดรูปแบบหนึ่งที่ระบุ (กรณีนี้จะใช้กับเฟรมด้วย) โปรดดูรายละเอียดเกี่ยวกับรูปแบบของรูปแบบที่หัวข้อจับคู่รูปแบบ
เปิดใช้อยู่

บูลีน ไม่บังคับ

เปิดหรือปิดใช้งานรายการเมนูตามบริบทนี้ ค่าเริ่มต้นคือ true
id

string ไม่บังคับ

รหัสที่ไม่ซ้ำกันที่จะกำหนดให้กับรายการนี้ จำเป็นสำหรับหน้ากิจกรรม ต้องไม่เหมือนกับรหัสอื่นสำหรับส่วนขยายนี้
parentId

string | หมายเลข ไม่บังคับ

รหัสของรายการในเมนูระดับบนสุด การดำเนินการนี้จะทำให้รายการนั้นเป็นรายการย่อยของรายการที่เพิ่มก่อนหน้านี้
targetUrlPatterns

string[] ไม่บังคับ

คล้ายกับ documentUrlPatterns แต่ช่วยให้คุณสามารถกรองตามแอตทริบิวต์ src ของแท็ก img/audio/video และ href ของแท็ก Anchor
title

string ไม่บังคับ

ข้อความที่จะแสดงในรายการ ต้องระบุเว้นแต่ type คือ "ตัวคั่น" เมื่อบริบทคือ "การเลือก" คุณจะใช้ %s ภายในสตริงเพื่อแสดงข้อความที่เลือกได้ เช่น หากค่าของพารามิเตอร์นี้คือ "แปล "%s" to Pig Latin" และผู้ใช้เลือกคำว่า "เย็น" รายการเมนูตามบริบทสำหรับการเลือกจะเป็น "แปลคำว่า "น่าสนใจ" Pig Latin"
ประเภท

ItemType ไม่บังคับ

ประเภทของรายการในเมนู ค่าเริ่มต้นคือ "ปกติ" หากไม่ได้ระบุไว้
onclick

เป็นโมฆะ ไม่บังคับ

ฟังก์ชันที่จะถูกเรียกกลับมาเมื่อมีการคลิกรายการในเมนู

ฟังก์ชัน onclick มีลักษณะดังนี้
```
(info: OnClickData) => {...}
```
- ข้อมูล
  
  OnClickData
  
  ข้อมูลเกี่ยวกับรายการที่คลิกและบริบทที่การคลิกเกิดขึ้น

ContextMenus

Chrome 44 ขึ้นไป

พร็อพเพอร์ตี้

onShow

เหตุการณ์<functionvoid>

เริ่มทำงานก่อนแสดงเมนูตามบริบทใน webview นี้ ใช้เพื่อปิดใช้เมนูตามบริบทนี้ได้โดยเรียกใช้ event.preventDefault()

ฟังก์ชัน onShow.addListener มีลักษณะดังนี้
```
(callback: function) => {...}
```
- Callback
  
  ฟังก์ชัน
  
  พารามิเตอร์ callback มีลักษณะดังนี้
```
(event: object) => void
```
  - event
    
    ออบเจ็กต์
    
    preventDefault
    
    เป็นโมฆะ
    
    เรียกใช้เพื่อไม่ให้ระบบแสดงเมนูตามบริบท
    
    ฟังก์ชัน preventDefault มีลักษณะดังนี้
    () => {...}
สร้าง

เป็นโมฆะ

สร้างรายการเมนูตามบริบทใหม่ โปรดทราบว่าหากเกิดข้อผิดพลาดระหว่างการสร้าง คุณอาจไม่พบจนกว่า Callback ของการสร้างจะเริ่มทำงาน (รายละเอียดจะอยู่ใน runtime.lastError)

ฟังก์ชัน create มีลักษณะดังนี้
```
(createProperties: object, callback?: function) => {...}
```
- createProperties
  
  ออบเจ็กต์
  
  พร็อพเพอร์ตี้ที่ใช้สร้างรายการ
- Callback
  
  ไม่บังคับ
  
  พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```
- returns
  string | หมายเลข
  
  รหัสของรายการที่สร้างใหม่
นำข้อมูลออก

เป็นโมฆะ

นำรายการเมนูตามบริบทออก

ฟังก์ชัน remove มีลักษณะดังนี้
```
(menuItemId: string | number, callback?: function) => {...}
```
- menuItemId
  
  string | หมายเลข
  
  รหัสของรายการในเมนูตามบริบทที่จะนำออก
- Callback
  
  ไม่บังคับ
  
  พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```
นำออกทั้งหมด

เป็นโมฆะ

นำรายการเมนูตามบริบททั้งหมดที่เพิ่มไปยัง webview นี้ออก

ฟังก์ชัน removeAll มีลักษณะดังนี้
```
(callback?: function) => {...}
```
- Callback
  
  ไม่บังคับ
  
  พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```
อัปเดต

เป็นโมฆะ

อัปเดตรายการเมนูตามบริบทที่สร้างไว้ก่อนหน้านี้

ฟังก์ชัน update มีลักษณะดังนี้
```
(id: string | number, updateProperties: object, callback?: function) => {...}
```
- id
  
  string | หมายเลข
  
  รหัสของรายการที่จะอัปเดต
- updateProperties
  
  ออบเจ็กต์
  
  พร็อพเพอร์ตี้ที่จะอัปเดต ยอมรับค่าเดียวกันกับฟังก์ชันสร้าง
- Callback
  
  ไม่บังคับ
  
  พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```

ContextMenuUpdateProperties

Chrome 44 ขึ้นไป

พร็อพเพอร์ตี้

เลือกไว้

บูลีน ไม่บังคับ

สถานะของช่องทำเครื่องหมายหรือรายการตัวเลือก: "จริง" สำหรับรายการที่เลือก และ "เท็จ" สำหรับรายการที่ไม่ได้เลือก โดยเลือกได้เพียงครั้งละ 1 รายการในกลุ่มรายการตัวเลือกที่กำหนด
บริบท

[ContextType, ...ContextType[]] ไม่บังคับ

รายการบริบทที่รายการในเมนูนี้จะปรากฏ
documentUrlPatterns

string[] ไม่บังคับ

อนุญาตให้คุณจำกัดรายการให้ใช้ได้เฉพาะกับเอกสารที่มี URL ตรงกับรูปแบบใดรูปแบบหนึ่งที่ระบุ (กรณีนี้จะใช้กับเฟรมด้วย) โปรดดูรายละเอียดเกี่ยวกับรูปแบบของรูปแบบที่หัวข้อจับคู่รูปแบบ
เปิดใช้อยู่

บูลีน ไม่บังคับ

เปิดหรือปิดใช้งานรายการเมนูตามบริบทนี้
parentId

string | หมายเลข ไม่บังคับ

รหัสของรายการในเมนูระดับบนสุด การดำเนินการนี้จะทำให้รายการนั้นเป็นรายการย่อยของรายการที่เพิ่มก่อนหน้านี้ หมายเหตุ: คุณไม่สามารถเปลี่ยนรายการเป็นรายการย่อยของรายการที่สืบทอดมา
targetUrlPatterns

string[] ไม่บังคับ

คล้ายกับ documentUrlPatterns แต่ช่วยให้คุณสามารถกรองตามแอตทริบิวต์ src ของแท็ก img/audio/video และ href ของแท็ก Anchor
title

string ไม่บังคับ

ข้อความที่จะแสดงในรายการ
ประเภท

ItemType ไม่บังคับ

ประเภทของรายการในเมนู
onclick

เป็นโมฆะ ไม่บังคับ

ฟังก์ชันที่จะถูกเรียกกลับมาเมื่อมีการคลิกรายการในเมนู

ฟังก์ชัน onclick มีลักษณะดังนี้
```
(info: OnClickData) => {...}
```
- ข้อมูล
  
  OnClickData
  
  ข้อมูลเกี่ยวกับรายการที่คลิกและบริบทที่การคลิกเกิดขึ้น

ContextType

Chrome 44 ขึ้นไป

บริบทต่างๆ ที่เมนูจะปรากฏ กำลังระบุ "ทั้งหมด" จะเทียบเท่ากับการรวมบริบทอื่นๆ ทั้งหมด

ค่าแจกแจง

"ทั้งหมด"

"page"

"frame"

"selection"

"ลิงก์"

"แก้ไขได้"

"รูปภาพ"

"วิดีโอ"

"เสียง"

DialogController

อินเทอร์เฟซที่แนบกับเหตุการณ์ DOM dialog เหตุการณ์

พร็อพเพอร์ตี้

ยกเลิก

เป็นโมฆะ

ปฏิเสธกล่องโต้ตอบ เทียบเท่ากับการคลิก "ยกเลิก" ในกล่องโต้ตอบ confirm หรือ prompt

ฟังก์ชัน cancel มีลักษณะดังนี้
```
() => {...}
```
ตกลง

เป็นโมฆะ

ยอมรับกล่องโต้ตอบ เทียบเท่ากับการคลิกตกลงในกล่องโต้ตอบ alert, confirm หรือ prompt

ฟังก์ชัน ok มีลักษณะดังนี้
```
(response?: string) => {...}
```
- การตอบกลับ
  
  string ไม่บังคับ
  
  สตริงคำตอบที่จะส่งไปยังผู้เข้าร่วมเมื่อยอมรับกล่องโต้ตอบ prompt

DownloadPermissionRequest

ประเภทของออบเจ็กต์ request ที่มาพร้อมกับเหตุการณ์ DOM download permissionrequest

พร็อพเพอร์ตี้

requestMethod

สตริง

ประเภทคำขอ HTTP (เช่น GET) ที่เชื่อมโยงกับคำขอดาวน์โหลด
URL

สตริง

URL การดาวน์โหลดที่ขอ
allow

เป็นโมฆะ

อนุญาตคำขอสิทธิ์

ฟังก์ชัน allow มีลักษณะดังนี้
```
() => {...}
```
ปฏิเสธ

เป็นโมฆะ

ปฏิเสธคำขอสิทธิ์ นี่คือลักษณะการทำงานเริ่มต้นหากไม่มีการเรียกใช้ allow

ฟังก์ชัน deny มีลักษณะดังนี้
```
() => {...}
```

FileSystemPermissionRequest

ประเภทของออบเจ็กต์ request ที่มาพร้อมกับเหตุการณ์ DOM filesystem permissionrequest

พร็อพเพอร์ตี้

URL

สตริง

URL ของเฟรมที่ขอเข้าถึงระบบไฟล์ในเครื่อง
allow

เป็นโมฆะ

อนุญาตคำขอสิทธิ์

ฟังก์ชัน allow มีลักษณะดังนี้
```
() => {...}
```
ปฏิเสธ

เป็นโมฆะ

ปฏิเสธคำขอสิทธิ์

ฟังก์ชัน deny มีลักษณะดังนี้
```
() => {...}
```

FindCallbackResults

ประกอบด้วยผลลัพธ์ทั้งหมดของคำขอการค้นหา

พร็อพเพอร์ตี้

activeMatchOrdinal

ตัวเลข

เลขลำดับของรายการที่ตรงกันปัจจุบัน
ยกเลิกแล้ว

boolean

ระบุว่าคำขอการค้นหานี้ถูกยกเลิกหรือไม่
numberOfMatches

ตัวเลข

จำนวนครั้งที่มีการจับคู่ searchText ในหน้าเว็บ
selectionRect

SelectionRect

อธิบายรูปสี่เหลี่ยมผืนผ้ารอบการจับคู่ที่ใช้งานอยู่ในพิกัดหน้าจอ

FindOptions

ตัวเลือกสำหรับคำขอค้นหา

พร็อพเพอร์ตี้

ย้อนกลับ

บูลีน ไม่บังคับ

แจ้งเพื่อค้นหารายการที่ตรงกันในลำดับที่กลับกัน ค่าเริ่มต้นคือ false
matchCase

บูลีน ไม่บังคับ

แจ้งเพื่อให้ตรงกับการคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ ค่าเริ่มต้นคือ false

FullscreenPermissionRequest

Chrome 43 ขึ้นไป

ประเภทของออบเจ็กต์ request ที่มาพร้อมกับเหตุการณ์ DOM fullscreen permissionrequest

พร็อพเพอร์ตี้

origin

สตริง

ต้นทางของเฟรมภายใน webview ที่ส่งคำขอแบบเต็มหน้าจอ
allow

เป็นโมฆะ

อนุญาตคำขอสิทธิ์

ฟังก์ชัน allow มีลักษณะดังนี้
```
() => {...}
```
ปฏิเสธ

เป็นโมฆะ

ปฏิเสธคำขอสิทธิ์

ฟังก์ชัน deny มีลักษณะดังนี้
```
() => {...}
```

GeolocationPermissionRequest

ประเภทของออบเจ็กต์ request ที่มาพร้อมกับเหตุการณ์ DOM geolocation permissionrequest

พร็อพเพอร์ตี้

URL

สตริง

URL ของเฟรมที่ขอเข้าถึงข้อมูลตำแหน่งทางภูมิศาสตร์
allow

เป็นโมฆะ

อนุญาตคำขอสิทธิ์

ฟังก์ชัน allow มีลักษณะดังนี้
```
() => {...}
```
ปฏิเสธ

เป็นโมฆะ

ปฏิเสธคำขอสิทธิ์ นี่คือลักษณะการทำงานเริ่มต้นหากไม่มีการเรียกใช้ allow

ฟังก์ชัน deny มีลักษณะดังนี้
```
() => {...}
```

HidPermissionRequest

Chrome 125 ขึ้นไป

ประเภทของออบเจ็กต์ request ที่มาพร้อมกับเหตุการณ์ DOM hid permissionrequest

พร็อพเพอร์ตี้

URL

สตริง

URL ของเฟรมที่ขอเข้าถึง HID API
allow

เป็นโมฆะ

อนุญาตคำขอสิทธิ์

ฟังก์ชัน allow มีลักษณะดังนี้
```
() => {...}
```
ปฏิเสธ

เป็นโมฆะ

ปฏิเสธคำขอสิทธิ์ นี่คือลักษณะการทำงานเริ่มต้นหากไม่มีการเรียกใช้ allow

ฟังก์ชัน deny มีลักษณะดังนี้
```
() => {...}
```

InjectDetails

รายละเอียดของสคริปต์หรือ CSS ที่จะแทรก ต้องตั้งค่าโค้ดหรือคุณสมบัติของไฟล์อย่างใดอย่างหนึ่ง แต่ตั้งค่าทั้ง 2 อย่างพร้อมกันไม่ได้

พร็อพเพอร์ตี้

รหัส

string ไม่บังคับ

โค้ด JavaScript หรือ CSS ที่จะแทรก

คำเตือน: โปรดใช้พารามิเตอร์ code อย่างระมัดระวัง การใช้สคริปต์อย่างไม่ถูกต้องอาจทำให้แอปของคุณเกิดการโจมตีแบบการเขียนสคริปต์ข้ามเว็บไซต์
ไฟล์

string ไม่บังคับ

ไฟล์ JavaScript หรือ CSS ที่จะแทรก

InjectionItems

Chrome 44 ขึ้นไป

ประเภทของรายการการแทรก ได้แก่ โค้ดหรือชุดไฟล์

พร็อพเพอร์ตี้

รหัส

string ไม่บังคับ

โค้ด JavaScript หรือ CSS ที่จะแทรกลงในหน้าที่ตรงกัน
files

string[] ไม่บังคับ

รายการไฟล์ JavaScript หรือ CSS ที่จะแทรกลงในหน้าที่ตรงกัน ซึ่งจะแทรกตามลำดับที่ปรากฏในอาร์เรย์

LoadPluginPermissionRequest

ประเภทของออบเจ็กต์ request ที่มาพร้อมกับเหตุการณ์ DOM loadplugin permissionrequest

พร็อพเพอร์ตี้

identifier

สตริง

สตริงตัวระบุของปลั๊กอิน
ชื่อ

สตริง

ชื่อที่แสดงของปลั๊กอิน
allow

เป็นโมฆะ

อนุญาตคำขอสิทธิ์ นี่คือลักษณะการทำงานเริ่มต้นหากไม่มีการเรียกใช้ deny

ฟังก์ชัน allow มีลักษณะดังนี้
```
() => {...}
```
ปฏิเสธ

เป็นโมฆะ

ปฏิเสธคำขอสิทธิ์

ฟังก์ชัน deny มีลักษณะดังนี้
```
() => {...}
```

MediaPermissionRequest

ประเภทของออบเจ็กต์ request ที่มาพร้อมกับเหตุการณ์ DOM media permissionrequest

พร็อพเพอร์ตี้

URL

สตริง

URL ของเฟรมที่ขอเข้าถึงสื่อของผู้ใช้
allow

เป็นโมฆะ

อนุญาตคำขอสิทธิ์

ฟังก์ชัน allow มีลักษณะดังนี้
```
() => {...}
```
ปฏิเสธ

เป็นโมฆะ

ปฏิเสธคำขอสิทธิ์ นี่คือลักษณะการทำงานเริ่มต้นหากไม่มีการเรียกใช้ allow

ฟังก์ชัน deny มีลักษณะดังนี้
```
() => {...}
```

NewWindow

อินเทอร์เฟซที่แนบกับเหตุการณ์ DOM newwindow เหตุการณ์

พร็อพเพอร์ตี้

แนบ

เป็นโมฆะ

แนบหน้าเป้าหมายที่ขอกับองค์ประกอบ webview ที่มีอยู่

ฟังก์ชัน attach มีลักษณะดังนี้
```
(webview: object) => {...}
```
- WebView
  
  ออบเจ็กต์
  
  องค์ประกอบ webview ที่ควรแนบหน้าเป้าหมาย
ทิ้ง

เป็นโมฆะ

ยกเลิกคำขอหน้าต่างใหม่

ฟังก์ชัน discard มีลักษณะดังนี้
```
() => {...}
```

PointerLockPermissionRequest

ประเภทของออบเจ็กต์ request ที่มาพร้อมกับเหตุการณ์ DOM pointerLock permissionrequest

พร็อพเพอร์ตี้

lastUnlockedBySelf

boolean

เฟรมที่ขอเป็นไคลเอ็นต์ล่าสุดที่ล็อกเคอร์เซอร์ไว้หรือไม่
URL

สตริง

URL ของเฟรมที่ขอการล็อกเคอร์เซอร์
userGesture

boolean

มีการขอล็อกเคอร์เซอร์อันเป็นผลมาจากท่าทางสัมผัสการป้อนข้อมูลของผู้ใช้หรือไม่
allow

เป็นโมฆะ

อนุญาตคำขอสิทธิ์

ฟังก์ชัน allow มีลักษณะดังนี้
```
() => {...}
```
ปฏิเสธ

เป็นโมฆะ

ปฏิเสธคำขอสิทธิ์ นี่คือลักษณะการทำงานเริ่มต้นหากไม่มีการเรียกใช้ allow

ฟังก์ชัน deny มีลักษณะดังนี้
```
() => {...}
```

SelectionRect

อธิบายรูปสี่เหลี่ยมผืนผ้าในพิกัดของหน้าจอ

ความหมายของการกักเก็บมีลักษณะเหมือนอาร์เรย์ กล่าวคือ พิกัด (left, top) จะถือว่าอยู่ในรูปสี่เหลี่ยมผืนผ้า แต่พิกัด (left + width, top) ไม่ได้อยู่

พร็อพเพอร์ตี้

ส่วนสูง

ตัวเลข

ความสูงของสี่เหลี่ยมผืนผ้า
ซ้าย

ตัวเลข

ระยะห่างจากขอบด้านซ้ายของหน้าจอไปยังขอบด้านซ้ายของสี่เหลี่ยมผืนผ้า
ด้านบน

ตัวเลข

ระยะห่างจากขอบบนของหน้าจอไปยังขอบด้านบนของสี่เหลี่ยมผืนผ้า
ความกว้าง

ตัวเลข

ความกว้างของสี่เหลี่ยมผืนผ้า

WebRequestEventInterface

Chrome 44 ขึ้นไป

อินเทอร์เฟซที่ให้สิทธิ์เข้าถึงเหตุการณ์ WebRequest ในหน้าผู้เข้าร่วม โปรดดูรายละเอียดเกี่ยวกับวงจรชีวิตของ WebRequest และแนวคิดที่เกี่ยวข้องใน API ของส่วนขยาย chrome.webRequest หมายเหตุ: ไม่รองรับเหตุการณ์ chrome.webRequest.onActionIgnored สำหรับ WebView

เพื่อแสดงให้เห็นว่าการใช้งานต่างจาก WebRequest API ของส่วนขยายอย่างไร ให้พิจารณาโค้ดตัวอย่างต่อไปนี้ที่บล็อกคำขอของผู้มาเยือนสำหรับ URL ที่ตรงกับ *://www.evil.com/*

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

นอกจากนี้ อินเทอร์เฟซนี้ยังรองรับกฎ WebRequest ที่มีการประกาศผ่านเหตุการณ์ onRequest และ onMessage ด้วย ดูรายละเอียด API ได้ที่ declarativeWebRequest

โปรดทราบว่าควรสร้างอินสแตนซ์เงื่อนไขและการดำเนินการสำหรับ webRequest ของ WebView แบบประกาศจากอินสแตนซ์ chrome.webViewRequest.* โค้ดตัวอย่างต่อไปนี้บล็อกคำขอทั้งหมดสำหรับ "example.com" ใน WebView myWebview อย่างชัดแจ้ง

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

ZoomMode

Chrome 43 ขึ้นไป

กำหนดวิธีจัดการการซูมใน webview

ค่าแจกแจง

"per-origin"
การเปลี่ยนแปลงการซูมจะคงอยู่ในต้นทางของหน้าที่ซูม กล่าวคือ WebView อื่นๆ ทั้งหมดในพาร์ติชันเดียวกันซึ่งไปยังต้นทางเดียวกันจะถูกซูมด้วยเช่นกัน นอกจากนี้ การเปลี่ยนแปลงการซูม per-origin รายการจะบันทึกพร้อมต้นทาง ซึ่งหมายความว่าเมื่อไปยังหน้าอื่นๆ ในต้นทางเดียวกัน การเปลี่ยนแปลงการซูมทั้งหมดจะถูกซูมด้วยปัจจัยการซูมเดียวกัน

"ต่อมุมมอง"
การเปลี่ยนแปลงการซูมจะส่งผลใน WebView นี้เท่านั้น และการเปลี่ยนแปลงการซูมใน WebView อื่นๆ จะไม่ส่งผลต่อการซูมของ WebView นี้ นอกจากนี้ ระบบจะรีเซ็ตการเปลี่ยนแปลงการซูม per-view รายการเมื่อนำทาง การไปยังส่วนต่างๆ ของ WebView จะโหลดหน้าเว็บพร้อมกับปัจจัยการซูมตามต้นทางเสมอ (ภายในขอบเขตของพาร์ติชัน)

" disabled"
ปิดใช้การซูมทั้งหมดใน WebView เนื้อหาจะเปลี่ยนกลับเป็นระดับการซูมเริ่มต้น และระบบจะไม่สนใจการเปลี่ยนแปลงการซูมทั้งหมดที่พยายามทำ

พร็อพเพอร์ตี้

contentWindow

การอ้างอิงวัตถุที่สามารถใช้โพสต์ข้อความลงในหน้าผู้เข้าร่วม

ประเภท

ContentWindow

contextMenus

Chrome 44 ขึ้นไป

คล้ายกับ ContextMenus API ของ Chrome แต่จะมีผลกับ webview แทนเบราว์เซอร์ ใช้ webview.contextMenus API เพื่อเพิ่มรายการลงในเมนูตามบริบทของ webview คุณเลือกประเภทออบเจกต์ที่จะใช้การเพิ่มเมนูตามบริบทได้ เช่น รูปภาพ ไฮเปอร์ลิงก์ และหน้า

ประเภท

ContextMenus

request

อินเทอร์เฟซที่ให้สิทธิ์เข้าถึงเหตุการณ์ WebRequest ในหน้าผู้เข้าร่วม

ประเภท

WebRequestEventInterface

เมธอด

addContentScripts()

Chrome 44 ขึ้นไป

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

เพิ่มกฎการแทรกสคริปต์เนื้อหาไปยัง webview เมื่อ webview ไปยังหน้าเว็บที่ตรงกับกฎอย่างน้อย 1 ข้อ ระบบจะแทรกสคริปต์ที่เกี่ยวข้อง คุณเพิ่มกฎหรืออัปเดตกฎที่มีอยู่แบบเป็นโปรแกรมได้

ตัวอย่างต่อไปนี้เพิ่มกฎ 2 ข้อใน webview: "myRule" และ "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';

คุณสามารถเลื่อนการเรียก addContentScripts ได้จนกว่าจะต้องแทรกสคริปต์

ตัวอย่างต่อไปนี้แสดงวิธีเขียนทับกฎที่มีอยู่

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

หาก webview ได้ไปยังต้นทาง (เช่น foo.com) และเรียก webview.addContentScripts ให้เพิ่ม 'myRule' คุณจะต้องรอการนำทางถัดไปเพื่อให้สคริปต์ที่มีการแทรกข้อมูล หากต้องการให้มีการแทรกเนื้อหาทันที executeScript จะทำสิ่งที่ถูกต้อง

กฎจะยังคงเดิมแม้ว่ากระบวนการของผู้มาเยือนจะขัดข้องหรือหยุดทำงาน หรือแม้ว่า webview จะได้รับการกำหนดใหม่ก็ตาม

ดูรายละเอียดเพิ่มเติมได้ในเอกสารประกอบของสคริปต์เนื้อหา

พารามิเตอร์

contentScriptList

[ContentScriptDetails, ...ContentScriptDetails[]]

รายละเอียดของสคริปต์เนื้อหาที่จะเพิ่ม

back()

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

ย้อนกลับไปยังประวัติ 1 รายการหากเป็นไปได้ เทียบเท่ากับ go(-1)

พารามิเตอร์

Callback

ไม่บังคับ

Chrome 44 ขึ้นไป

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean) => void
```
- สำเร็จ
  
  boolean
  
  ระบุว่าการนำทางสำเร็จหรือไม่

canGoBack()

chrome.webviewTag.canGoBack()

ระบุว่าสามารถย้อนดูประวัติได้หรือไม่ ระบบจะแคชสถานะของฟังก์ชันนี้และอัปเดตก่อน loadcommit แต่ละรายการ ตำแหน่งที่ดีที่สุดในการเรียกใช้คือเมื่อ loadcommit

การคืนสินค้า

boolean

canGoForward()

chrome.webviewTag.canGoForward()

ระบุว่าสามารถไปยังประวัติที่ผ่านมาได้หรือไม่ ระบบจะแคชสถานะของฟังก์ชันนี้และอัปเดตก่อน loadcommit แต่ละรายการ ตำแหน่งที่ดีที่สุดในการเรียกใช้คือเมื่อ loadcommit

การคืนสินค้า

boolean

captureVisibleRegion()

Chrome 50 ขึ้นไป

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

จับภาพบริเวณที่มองเห็นของ WebView

พารามิเตอร์

ตัวเลือก

ImageDetails ไม่บังคับ
Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(dataUrl: string) => void
```
- dataUrl
  
  สตริง
  
  URL ข้อมูลที่เข้ารหัสรูปภาพของส่วนที่มองเห็นได้ของแท็บที่บันทึก อาจกำหนดให้กับ "src" ขององค์ประกอบรูปภาพ HTML สำหรับการแสดงผล

clearData()

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

ล้างข้อมูลการท่องเว็บของพาร์ติชัน webview

พารามิเตอร์

ตัวเลือก

ClearDataOptions

ตัวเลือกเพื่อกำหนดข้อมูลที่จะล้าง
ประเภท

ClearDataTypeSet

ประเภทข้อมูลที่จะล้าง
Callback

ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```

executeScript()

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

แทรกโค้ด JavaScript ลงในหน้าผู้เข้าร่วม

โค้ดตัวอย่างต่อไปนี้ใช้การแทรกสคริปต์เพื่อตั้งค่าสีพื้นหลังของหน้าผู้เข้าร่วมเป็นสีแดง

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

พารามิเตอร์

รายละเอียด

InjectDetails

รายละเอียดของสคริปต์ที่จะเรียกใช้
Callback

ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(result?: any[]) => void
```
- ผลลัพธ์
  
  any[] ไม่บังคับ
  
  ผลลัพธ์ของสคริปต์ในทุกเฟรมที่แทรก

find()

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

เริ่มคำขอค้นหาในหน้าเว็บ

พารามิเตอร์

searchText

สตริง

สตริงที่จะค้นหาในหน้า
ตัวเลือก

FindOptions ไม่บังคับ

ตัวเลือกสำหรับคำขอค้นหา
Callback

ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(results?: FindCallbackResults) => void
```
- ผลลัพธ์
  
  FindCallbackResults ไม่บังคับ
  
  ประกอบด้วยผลลัพธ์ทั้งหมดของคำขอการค้นหา ละเว้น results ได้หากไม่ได้ใช้ในส่วนเนื้อหาของฟังก์ชัน Callback ตัวอย่างเช่น หากใช้ Callback เพื่อแยกแยะเมื่อคำขอการค้นหาเสร็จสิ้นแล้วเท่านั้น

forward()

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

ส่งต่อรายการในประวัติ 1 รายการหากเป็นไปได้ เทียบเท่ากับ go(1)

พารามิเตอร์

Callback

ไม่บังคับ

Chrome 44 ขึ้นไป

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean) => void
```
- สำเร็จ
  
  boolean
  
  ระบุว่าการนำทางสำเร็จหรือไม่

getAudioState()

Chrome 62 ขึ้นไป

chrome.webviewTag.getAudioState(
  callback: function,
)

สถานะเสียงของการค้นหา

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(audible: boolean) => void
```
- audible
  
  boolean

getProcessId()

chrome.webviewTag.getProcessId()

แสดงรหัสกระบวนการภายในของ Chrome สำหรับกระบวนการปัจจุบันของหน้าเว็บของผู้เข้าร่วม ทำให้ผู้ฝังทราบจำนวนผู้เข้าร่วมที่จะได้รับผลกระทบเมื่อยุติขั้นตอนนี้ ผู้เข้าร่วม 2 คนจะแชร์กระบวนการกันก็ต่อเมื่อผู้ใช้อยู่ในแอปเดียวกันและมีรหัสพาร์ติชันพื้นที่เก็บข้อมูลเดียวกัน การเรียกจะเป็นแบบซิงโครนัสและแสดงผลแนวความคิดในแคชของเครื่องมือฝัง ของรหัสกระบวนการปัจจุบัน รหัสกระบวนการจะไม่เหมือนกับรหัสกระบวนการของระบบปฏิบัติการ

การคืนสินค้า

ตัวเลข

getUserAgent()

chrome.webviewTag.getUserAgent()

แสดงผลสตริง User Agent ที่ webview ใช้สำหรับคำขอหน้าเว็บผู้เข้าร่วม

การคืนสินค้า

สตริง

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

รับค่าตัวคูณการซูมปัจจุบัน

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(zoomFactor: number) => void
```
- zoomFactor
  
  ตัวเลข
  
  ปัจจัยการซูมปัจจุบัน

getZoomMode()

Chrome 43 ขึ้นไป

chrome.webviewTag.getZoomMode(
  callback: function,
)

เรียกดูโหมดการซูมปัจจุบัน

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(ZoomMode: ZoomMode) => void
```
- ZoomMode
  
  ZoomMode
  
  โหมดซูมปัจจุบันของ webview

go()

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

นำทางไปยังรายการประวัติโดยใช้ดัชนีประวัติที่สัมพันธ์กับการนำทางปัจจุบัน หากการนำทางที่ขอเป็นไปไม่ได้ วิธีการนี้จะไม่มีผล

พารามิเตอร์

relativeIndex

ตัวเลข

ดัชนีประวัติสัมพัทธ์ที่ควรใช้ webview เช่น ค่า 2 จะไปที่รายการประวัติ 2 รายการหากเป็นไปได้ ค่า -3 จะเลื่อนไปข้างหลัง 3 รายการ
Callback

ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
(success: boolean) => void
```
- สำเร็จ
  
  boolean
  
  ระบุว่าการนำทางสำเร็จหรือไม่

insertCSS()

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

แทรก CSS ลงในหน้าผู้มาเยือน

พารามิเตอร์

รายละเอียด

InjectDetails

รายละเอียดของ CSS ที่จะแทรก
Callback

ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```

isAudioMuted()

Chrome 62 ขึ้นไป

chrome.webviewTag.isAudioMuted(
  callback: function,
)

ค้นหาว่าปิดเสียงอยู่หรือไม่

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(muted: boolean) => void
```
- ปิดเสียงอยู่
  
  boolean

isSpatialNavigationEnabled()

Chrome 71 ขึ้นไป

chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

การค้นหาว่าเปิดใช้การนำทางเชิงพื้นที่สำหรับ WebView หรือไม่

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(enabled: boolean) => void
```
- เปิดใช้อยู่
  
  boolean

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

ระบุว่า webviewTag.setUserAgentOverride ลบล้างสตริง User Agent ของ webview แล้วหรือไม่

loadDataWithBaseUrl()

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

โหลด URL ข้อมูลพร้อมด้วย URL ฐานที่ระบุซึ่งใช้สำหรับลิงก์แบบสัมพัทธ์ หรือสามารถระบุ URL เสมือนเพื่อแสดงต่อผู้ใช้แทน URL ของข้อมูลได้

พารามิเตอร์

dataUrl

สตริง

URL ข้อมูลที่จะโหลด
baseUrl

สตริง

URL ฐานที่จะใช้สำหรับลิงก์ที่เกี่ยวข้อง
virtualUrl

string ไม่บังคับ

URL ที่จะแสดงต่อผู้ใช้ (ในแถบที่อยู่)

print()

chrome.webviewTag.print()

พิมพ์เนื้อหาของ webview ซึ่งเทียบเท่ากับการเรียกใช้ฟังก์ชันการพิมพ์ตามสคริปต์จาก webview เอง

reload()

chrome.webviewTag.reload()

โหลดหน้าระดับบนสุดปัจจุบันซ้ำ

removeContentScripts()

Chrome 44 ขึ้นไป

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

นำสคริปต์เนื้อหาออกจาก webview

ตัวอย่างต่อไปนี้จะนำ "myRule" ออก ที่เพิ่มไว้ก่อนหน้านี้

webview.removeContentScripts(['myRule']);

คุณสามารถนำกฎทั้งหมดออกได้โดยเรียกใช้:

webview.removeContentScripts();

พารามิเตอร์

scriptNameList

string[] ไม่บังคับ

รายการชื่อสคริปต์เนื้อหาที่จะถูกนำออก หากรายการว่างเปล่า สคริปต์เนื้อหาทั้งหมดที่เพิ่มลงใน webview จะถูกนำออก

setAudioMuted()

Chrome 62 ขึ้นไป

chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

ตั้งค่าสถานะปิดเสียงของ WebView

พารามิเตอร์

ปิดเสียง

boolean

ปิดเสียงค่าเสียง

setSpatialNavigationEnabled()

Chrome 71 ขึ้นไป

chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

ตั้งค่าสถานะการนำทางเชิงพื้นที่ของ WebView

พารามิเตอร์

เปิดใช้อยู่

boolean

ค่าสถานะการนำทางในพื้นที่

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

ลบล้างสตริง User Agent ที่ webview ใช้สำหรับคำขอหน้าผู้เข้าร่วม การลบล้างจะทำให้ค่าส่วนหัว User-Agent Client Hint และค่าที่แสดงผลโดย navigator.userAgentData ว่างเปล่าสำหรับคำขอหน้าผู้มาเยือนที่จะใช้การลบล้างนี้

พารามิเตอร์

userAgent

สตริง

สตริง User Agent ที่จะใช้

setZoom()

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

เปลี่ยนปัจจัยการซูมของหน้า ขอบเขตและความต่อเนื่องของการเปลี่ยนแปลงนี้กําหนดโดยโหมดซูมปัจจุบันของ WebView (ดู webviewTag.ZoomMode)

พารามิเตอร์

zoomFactor

ตัวเลข

ปัจจัยการซูมใหม่
Callback

ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```

setZoomMode()

Chrome 43 ขึ้นไป

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

ตั้งค่าโหมดซูมของ webview

พารามิเตอร์

ZoomMode

ZoomMode

กำหนดวิธีจัดการการซูมใน webview
Callback

ไม่บังคับ

พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```

stop()

chrome.webviewTag.stop()

หยุดโหลดการนำทางปัจจุบันของ webview หากอยู่ระหว่างดำเนินการ

stopFinding()

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

สิ้นสุดเซสชันการค้นหาปัจจุบัน (ล้างการไฮไลต์ทั้งหมด) และยกเลิกคำขอค้นหาทั้งหมดที่กำลังดำเนินการ

พารามิเตอร์

การดำเนินการ

"ล้าง"
| "keep"
| "activate"
ไม่บังคับ

กำหนดว่าจะต้องทำอย่างไรกับการจับคู่ที่ใช้งานอยู่หลังจากเซสชันการค้นหาสิ้นสุดลง clear จะล้างการไฮไลต์ทับการจับคู่ที่ใช้งานอยู่ keep จะไฮไลต์การจับคู่ที่ทำงานอยู่ต่อไป activate จะไฮไลต์การจับคู่ที่ใช้งานอยู่และจำลองการคลิกของผู้ใช้ในการจับคู่นั้น การดำเนินการเริ่มต้นคือ keep

terminate()

chrome.webviewTag.terminate()

บังคับปิดกระบวนการแสดงผลของหน้าเว็บผู้เข้าร่วม ซึ่งอาจส่งผลต่อแท็ก webview หลายแท็กในแอปปัจจุบัน หากใช้กระบวนการเดียวกัน แต่จะไม่ส่งผลต่อแท็ก webview ในแอปอื่นๆ

กิจกรรม

close

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

เริ่มทำงานเมื่อหน้าต่างผู้มาเยือนพยายามปิดตัวเอง

โค้ดตัวอย่างต่อไปนี้จะไปยังส่วนต่างๆ ของ webview ไปยัง about:blank เมื่อผู้เข้าร่วมพยายามปิดตัวเอง

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

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```

consolemessage

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

เริ่มทำงานเมื่อหน้าต่างผู้มาเยือนบันทึกข้อความในคอนโซล

โค้ดตัวอย่างต่อไปนี้จะส่งต่อข้อความบันทึกทั้งหมดไปยังคอนโซลของเครื่องมือฝัง โดยไม่คำนึงถึงระดับการบันทึกหรือพร็อพเพอร์ตี้อื่นๆ

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

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(level: number, message: string, line: number, sourceId: string) => void
```
- ระดับ
  
  ตัวเลข
- ข้อความ
  
  สตริง
- บรรทัด
  
  ตัวเลข
- sourceId
  
  สตริง

contentload

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

เริ่มทำงานเมื่อหน้าต่างผู้เข้าร่วมเริ่มการทำงานของเหตุการณ์ load ซึ่งก็คือเมื่อโหลดเอกสารใหม่ ซึ่งไม่รวมถึงการนำทางหน้าเว็บภายในเอกสารปัจจุบันหรือการโหลดทรัพยากรแบบไม่พร้อมกัน

โค้ดตัวอย่างต่อไปนี้จะแก้ไขขนาดแบบอักษรเริ่มต้นขององค์ประกอบ body ของผู้เข้าร่วมหลังจากโหลดหน้าเว็บ

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

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```

dialog

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

เริ่มทำงานเมื่อหน้าต่างผู้มาเยือนพยายามเปิดกล่องโต้ตอบโมดัลผ่าน window.alert, window.confirm หรือ window.prompt

การจัดการกิจกรรมนี้จะบล็อกกระบวนการของผู้เข้าร่วมจนกว่า Listener กิจกรรมแต่ละรายจะย้อนกลับ หรือวัตถุ dialog ไม่สามารถเข้าถึงได้ (หากมีการเรียก preventDefault())

การทำงานเริ่มต้นคือการยกเลิกกล่องโต้ตอบ

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(messageType: "alert" 
  | "confirm" 
  | "prompt" 
 , messageText: string, dialog: DialogController) => void
```
- messageType
  
  "การแจ้งเตือน"
  | "ยืนยัน"
  | "พรอมต์"
- messageText
  
  สตริง
- กล่องโต้ตอบ
  
  DialogController

exit

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

เริ่มทำงานเมื่อออกจากขั้นตอนการแสดงผลเนื้อหาเว็บของผู้เข้าร่วม

โค้ดตัวอย่างต่อไปนี้จะแสดงข้อความอำลาเมื่อใดก็ตามที่หน้าผู้เข้าร่วมขัดข้อง:

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

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(processID: number, reason: "normal" 
  | "abnormal" 
  | "crash" 
  | "kill" 
 ) => void
```
- processID
  
  ตัวเลข
- สาเหตุ
  
  "ปกติ"
  | "ผิดปกติ"
  | "รถชน"
  | "kill"

findupdate

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

เริ่มทำงานเมื่อมีผลการค้นหาใหม่พร้อมใช้งานสำหรับคำขอการค้นหาที่ใช้งานอยู่ กรณีนี้อาจเกิดขึ้นหลายครั้งสำหรับคำขอการค้นหารายการเดียวเนื่องจากพบรายการที่ตรงกัน

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(searchText: string, numberOfMatches: number, activeMatchOrdinal: number, selectionRect: SelectionRect, canceled: boolean, finalUpdate: string) => void
```
- searchText
  
  สตริง
- numberOfMatches
  
  ตัวเลข
- activeMatchOrdinal
  
  ตัวเลข
- selectionRect
  
  SelectionRect
- ยกเลิกแล้ว
  
  boolean
- finalUpdate
  
  สตริง

loadabort

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

เริ่มทำงานเมื่อมีการล้มเลิกการโหลดระดับบนสุดโดยไม่มีการดำเนินการ ระบบจะพิมพ์ข้อความแสดงข้อผิดพลาดไปยังคอนโซล เว้นแต่จะมีการป้องกันกิจกรรมโดยค่าเริ่มต้น

หมายเหตุ: เมื่อการโหลดทรัพยากรถูกล้มเลิก เหตุการณ์ loadabort จะตามมาด้วยเหตุการณ์ loadstop แม้ว่าการโหลดที่คอมมิตทั้งหมดนับตั้งแต่เหตุการณ์ loadstop ล่าสุด (หากมี) จะถูกล้มเลิก

หมายเหตุ: เมื่อมีการล้มเลิกการโหลดของ URL ที่เกี่ยวกับ URL หรือ JavaScript URL loadabortจะเริ่มทำงาน จากนั้น webview จะไปยัง "about:blank"

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(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
  
  สตริง
- isTopLevel
  
  boolean
- รหัส
  
  ตัวเลข
- สาเหตุ
  
  "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"

loadcommit

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

เริ่มทำงานเมื่อโหลดแล้ว ซึ่งรวมถึงการนำทางภายในเอกสารปัจจุบันและการโหลดระดับเอกสารของเฟรมย่อย แต่จะไม่รวมการโหลดทรัพยากรแบบไม่พร้อมกัน

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(url: string, isTopLevel: boolean) => void
```
- URL
  
  สตริง
- isTopLevel
  
  boolean

loadredirect

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

เริ่มทำงานเมื่อคำขอโหลดระดับบนสุดเปลี่ยนเส้นทางไปยัง URL อื่น

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(oldUrl: string, newUrl: string, isTopLevel: boolean) => void
```
- oldUrl
  
  สตริง
- newUrl
  
  สตริง
- isTopLevel
  
  boolean

loadstart

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

เริ่มทำงานเมื่อเริ่มการโหลด

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(url: string, isTopLevel: boolean) => void
```
- URL
  
  สตริง
- isTopLevel
  
  boolean

loadstop

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

เริ่มทำงานเมื่อการโหลดระดับเฟรมทั้งหมดในหน้าผู้มาเยือน (รวมถึงเฟรมย่อยทั้งหมด) เสร็จสิ้นลง ซึ่งรวมถึงการนำทางภายในเอกสารปัจจุบันและการโหลดระดับเอกสารของเฟรมย่อย แต่จะไม่รวมการโหลดทรัพยากรแบบไม่พร้อมกัน เหตุการณ์นี้จะเริ่มทำงานทุกครั้งที่จำนวนการโหลดระดับเอกสารเปลี่ยนจาก 1 รายการ (หรือมากกว่า) เป็น 0 เช่น หากหน้าที่โหลดเสร็จแล้ว (เช่น loadstop เริ่มทำงานแล้ว 1 ครั้ง) สร้าง iframe ใหม่ที่โหลดหน้าเว็บ จากนั้น loadstop รายการที่ 2 จะเริ่มทำงานเมื่อการโหลดหน้าเว็บ iframe เสร็จสมบูรณ์ รูปแบบนี้มักพบได้ทั่วไปในหน้าเว็บที่โหลดโฆษณา

หมายเหตุ: เมื่อล้มเลิกการโหลดที่คอมมิตแล้ว เหตุการณ์ loadstop จะติดตามเหตุการณ์ loadabort ในที่สุด แม้ว่าการโหลดที่คอมมิตทั้งหมดนับตั้งแต่เหตุการณ์ loadstop ล่าสุด (หากมี) จะถูกล้มเลิก

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
() => void
```

newwindow

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

เริ่มทำงานเมื่อหน้าผู้มาเยือนพยายามเปิดหน้าต่างเบราว์เซอร์ใหม่

โค้ดตัวอย่างต่อไปนี้จะสร้างและไปยัง webview ใหม่ในโปรแกรมฝังสำหรับหน้าต่างใหม่ที่ขอแต่ละรายการ

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

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(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
```
- หน้าต่าง
  
  NewWindow
- targetUrl
  
  สตริง
- initialWidth
  
  ตัวเลข
- initialHeight
  
  ตัวเลข
- ชื่อ
  
  สตริง
- windowOpenDisposition
  
  "ignore"
  | "save_to_disk"
  | "current_tab"
  | "new_background_tab"
  | "new_foreground_tab"
  | "new_window"
  | "new_popup"

permissionrequest

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

เริ่มทำงานเมื่อหน้าผู้มาเยือนต้องขอสิทธิ์พิเศษจากผู้ฝัง

โค้ดตัวอย่างต่อไปนี้จะให้สิทธิ์เข้าถึง webkitGetUserMedia API แก่หน้าเว็บของผู้เข้าร่วม โปรดทราบว่าแอปที่ใช้โค้ดตัวอย่างนี้ต้องระบุสิทธิ์ audioCapture และ/หรือ videoCapture สำหรับไฟล์ Manifest

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

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(permission: "media" 
  | "geolocation" 
  | "pointerLock" 
  | "download" 
  | "loadplugin" 
  | "filesystem" 
  | "fullscreen" 
  | "hid" 
 , request: object) => void
```
- สิทธิ์
  
  "สื่อ"
  | "ตำแหน่งทางภูมิศาสตร์"
  | "pointerLock"
  | "ดาวน์โหลด"
  | "loadplugin"
  | "filesystem"
  | "เต็มหน้าจอ"
  | "hid"
- ส่งคำขอ
  
  ออบเจ็กต์

responsive

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

เริ่มทำงานเมื่อกระบวนการแสดงผลเนื้อหาเว็บของผู้เข้าร่วมมีการตอบสนองอีกครั้งหลังจากไม่ตอบสนอง

โค้ดตัวอย่างต่อไปนี้จะทำให้องค์ประกอบ webview เฟดเข้าหรือออกเมื่อมีการตอบสนองหรือไม่ตอบสนอง

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

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(processID: number) => void
```
- processID
  
  ตัวเลข

sizechanged

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

เริ่มทำงานเมื่อมีการปรับขนาดเนื้อหาเว็บที่ฝังผ่าน autosize เริ่มทำงานเมื่อเปิดใช้ autosize เท่านั้น

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(oldWidth: number, oldHeight: number, newWidth: number, newHeight: number) => void
```
- oldWidth
  
  ตัวเลข
- oldHeight
  
  ตัวเลข
- newWidth
  
  ตัวเลข
- newHeight
  
  ตัวเลข

unresponsive

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

เริ่มทำงานเมื่อกระบวนการแสดงผลเนื้อหาเว็บของผู้มาเยือนไม่ตอบสนอง ระบบจะสร้างกิจกรรมนี้ 1 ครั้งโดยมีกิจกรรมที่ปรับเปลี่ยนตามอุปกรณ์ที่ตรงกัน หากผู้เข้าร่วมเริ่มตอบกลับอีกครั้ง

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(processID: number) => void
```
- processID
  
  ตัวเลข

zoomchange

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

เริ่มทำงานเมื่อการซูมหน้าเว็บเปลี่ยนแปลง

พารามิเตอร์

Callback

ฟังก์ชัน

พารามิเตอร์ callback มีลักษณะดังนี้
```
(oldZoomFactor: number, newZoomFactor: number) => void
```
- oldZoomFactor
  
  ตัวเลข
- newZoomFactor
  
  ตัวเลข