chrome.webviewTag

สำคัญ: API นี้ใช้ได้ใน ChromeOS เท่านั้น

คำอธิบาย

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

สิทธิ์

webview

ความพร้อมใช้งาน

ChromeOS เท่านั้น

ประเภท

ClearDataOptions

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

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

• ตั้งแต่

  number ไม่บังคับ

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

ClearDataTypeSet

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

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

• appcache

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

  แคชของแอปในเว็บไซต์

• แคช

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

  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 ที่รับค่ามาตรงกับรูปแบบที่ประกาศไว้ในช่อง matches URL ที่รับค่ามาคือ URL ของเอกสารที่สร้างเฟรมหรือหน้าต่าง แทรกสคริปต์เนื้อหาในเฟรมที่ทำแซนด์บ็อกซ์ไม่ได้

• ตรงกับ

  string[]

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

• name

  สตริง

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

• run_at

  RunAt ไม่บังคับ

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

ContentWindow

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

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

• postMessage

  void

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

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

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

  ฟังก์ชัน postMessage จะมีลักษณะดังนี้

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

  • ข้อความ

    ใดๆ

    ออบเจ็กต์ข้อความที่จะส่งให้ผู้เข้าร่วม

  • targetOrigin

    สตริง

    ระบุว่าต้นทางของหน้าต่างผู้มาเยือนต้องเป็นอะไรเพื่อให้ส่งเหตุการณ์ได้

ContextMenuCreateProperties

Chrome 44 ขึ้นไป

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

• เลือกแล้ว

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

  สถานะเริ่มต้นของช่องทำเครื่องหมายหรือรายการปุ่มตัวเลือก: true สำหรับเลือก และ false สำหรับไม่เลือก คุณเลือกรายการปุ่มตัวเลือกได้ครั้งละ 1 รายการเท่านั้นในกลุ่มรายการปุ่มตัวเลือกที่ระบุ

• บริบท

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

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

• documentUrlPatterns

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

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

• เปิดอยู่

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

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

• id

  สตริง ไม่บังคับ

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

• parentId

  string | number ไม่บังคับ

  รหัสของรายการเมนูหลัก ซึ่งจะทำให้รายการนี้เป็นรายการย่อยของรายการที่เพิ่มไว้ก่อนหน้านี้

• targetUrlPatterns

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

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

• title

  สตริง ไม่บังคับ

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

• ประเภท

  ItemType ไม่บังคับ

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

• onclick

  void ไม่บังคับ

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

  ฟังก์ชัน onclick จะมีลักษณะดังนี้

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

  • ข้อมูล

    OnClickData

    ข้อมูลเกี่ยวกับรายการที่คลิกและบริบทที่เกิดการคลิก

ContextMenus

Chrome 44 ขึ้นไป

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

• onShow

  Event<functionvoidvoid>

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

  ฟังก์ชัน onShow.addListener จะมีลักษณะดังนี้

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

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้

    (event: object) => void

    • เหตุการณ์

      ออบเจ็กต์

      • preventDefault

        void

        เรียกใช้เมธอดนี้เพื่อป้องกันไม่ให้แสดงเมนูตามบริบท

        ฟังก์ชัน preventDefault จะมีลักษณะดังนี้

        () => {...}

• สร้าง

  void

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

  ฟังก์ชัน create จะมีลักษณะดังนี้

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

  • createProperties

    ออบเจ็กต์

    พร็อพเพอร์ตี้ที่ใช้สร้างรายการ

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้

    () => void

  • returns

    string | number

    รหัสของรายการที่สร้างขึ้นใหม่

• ลบ

  void

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

  ฟังก์ชัน remove จะมีลักษณะดังนี้

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

  • menuItemId

    string | number

    รหัสของรายการเมนูตามบริบทที่จะนำออก

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้

    () => void

• removeAll

  void

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

  ฟังก์ชัน removeAll จะมีลักษณะดังนี้

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

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้

    () => void

• อัปเดต

  void

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

  ฟังก์ชัน update จะมีลักษณะดังนี้

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

  • id

    string | number

    รหัสของรายการที่จะอัปเดต

  • updateProperties

    ออบเจ็กต์

    พร็อพเพอร์ตี้ที่จะอัปเดต ยอมรับค่าเดียวกับฟังก์ชัน create

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้

    () => void

ContextMenuUpdateProperties

Chrome 44 ขึ้นไป

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

• เลือกแล้ว

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

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

• บริบท

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

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

• documentUrlPatterns

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

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

• เปิดอยู่

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

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

• parentId

  string | number ไม่บังคับ

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

• targetUrlPatterns

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

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

• title

  สตริง ไม่บังคับ

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

• ประเภท

  ItemType ไม่บังคับ

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

• onclick

  void ไม่บังคับ

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

  ฟังก์ชัน onclick จะมีลักษณะดังนี้

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

  • ข้อมูล

    OnClickData

    ข้อมูลเกี่ยวกับรายการที่คลิกและบริบทที่เกิดการคลิก

ContextType

Chrome 44 ขึ้นไป

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

ค่าแจกแจง

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

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

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

• ยกเลิก

  void

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

  ฟังก์ชัน cancel จะมีลักษณะดังนี้

  () => {...}

• ตกลง

  void

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

  ฟังก์ชัน ok จะมีลักษณะดังนี้

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

  • การตอบกลับ

    สตริง ไม่บังคับ

    สตริงการตอบกลับที่จะส่งให้ผู้มาเยือนเมื่อยอมรับกล่องโต้ตอบ prompt

DialogMessageType

Chrome 141 ขึ้นไป

ประเภทของกล่องโต้ตอบโมดัลที่ผู้มาเยือนขอ

ค่าแจกแจง

"alert"

"confirm"

"prompt"

DownloadPermissionRequest

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

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

• requestMethod

  สตริง

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

• URL

  สตริง

  URL สำหรับดาวน์โหลดที่ขอ

• allow

  void

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

  ฟังก์ชัน allow จะมีลักษณะดังนี้

  () => {...}

• ปฏิเสธ

  void

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

  ฟังก์ชัน deny จะมีลักษณะดังนี้

  () => {...}

ExitReason

Chrome 141 ขึ้นไป

สตริงที่ระบุเหตุผลในการออก

ค่าแจกแจง

"normal"

"ผิดปกติ"

"ขัดข้อง"

"killed"

"oom killed"

"oom"

"เปิดไม่สำเร็จ"

"ความสมบูรณ์ล้มเหลว"

FileSystemPermissionRequest

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

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

• URL

  สตริง

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

• allow

  void

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

  ฟังก์ชัน allow จะมีลักษณะดังนี้

  () => {...}

• ปฏิเสธ

  void

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

  ฟังก์ชัน deny จะมีลักษณะดังนี้

  () => {...}

FindCallbackResults

มีผลลัพธ์ทั้งหมดของคำขอค้นหา

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

• activeMatchOrdinal

  ตัวเลข

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

• ยกเลิกแล้ว

  บูลีน

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

• numberOfMatches

  ตัวเลข

  จำนวนครั้งที่พบ searchText ในหน้าเว็บ

• selectionRect

  SelectionRect

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

FindOptions

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

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

• ย้อนกลับ

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

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

• matchCase

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

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

FullscreenPermissionRequest

Chrome 43 ขึ้นไป

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

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

• origin

  สตริง

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

• allow

  void

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

  ฟังก์ชัน allow จะมีลักษณะดังนี้

  () => {...}

• ปฏิเสธ

  void

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

  ฟังก์ชัน deny จะมีลักษณะดังนี้

  () => {...}

GeolocationPermissionRequest

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

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

• URL

  สตริง

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

• allow

  void

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

  ฟังก์ชัน allow จะมีลักษณะดังนี้

  () => {...}

• ปฏิเสธ

  void

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

  ฟังก์ชัน deny จะมีลักษณะดังนี้

  () => {...}

HidPermissionRequest

Chrome 125 ขึ้นไป

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

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

• URL

  สตริง

  URL ของเฟรมที่ขอสิทธิ์เข้าถึง HID API

• allow

  void

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

  ฟังก์ชัน allow จะมีลักษณะดังนี้

  () => {...}

• ปฏิเสธ

  void

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

  ฟังก์ชัน deny จะมีลักษณะดังนี้

  () => {...}

InjectDetails

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

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

• รหัส

  สตริง ไม่บังคับ

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

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

• ไฟล์

  สตริง ไม่บังคับ

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

InjectionItems

Chrome 44 ขึ้นไป

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

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

• รหัส

  สตริง ไม่บังคับ

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

• ไฟล์

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

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

LoadAbortReason

Chrome 141 ขึ้นไป

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

ค่าแจกแจง

"ERR_ABORTED"

"ERR_INVALID_URL"

"ERR_DISALLOWED_URL_SCHEME"

"ERR_BLOCKED_BY_CLIENT"

"ERR_ADDRESS_UNREACHABLE"

"ERR_EMPTY_RESPONSE"

"ERR_FILE_NOT_FOUND"

"ERR_UNKNOWN_URL_SCHEME"

LoadPluginPermissionRequest

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

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

• identifier

  สตริง

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

• name

  สตริง

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

• allow

  void

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

  ฟังก์ชัน allow จะมีลักษณะดังนี้

  () => {...}

• ปฏิเสธ

  void

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

  ฟังก์ชัน deny จะมีลักษณะดังนี้

  () => {...}

MediaPermissionRequest

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

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

• URL

  สตริง

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

• allow

  void

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

  ฟังก์ชัน allow จะมีลักษณะดังนี้

  () => {...}

• ปฏิเสธ

  void

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

  ฟังก์ชัน deny จะมีลักษณะดังนี้

  () => {...}

NewWindow

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

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

• แนบ

  void

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

  ฟังก์ชัน attach จะมีลักษณะดังนี้

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

  • WebView

    ออบเจ็กต์

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

• ทิ้ง

  void

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

  ฟังก์ชัน discard จะมีลักษณะดังนี้

  () => {...}

PermissionType

Chrome 141 ขึ้นไป

ประเภทของสิทธิ์ที่ขอ

ค่าแจกแจง

"media"

"geolocation"

"pointerLock"

"ดาวน์โหลด"

"loadplugin"

"filesystem"

"fullscreen"

"hid"

PointerLockPermissionRequest

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

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

• lastUnlockedBySelf

  บูลีน

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

• URL

  สตริง

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

• userGesture

  บูลีน

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

• allow

  void

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

  ฟังก์ชัน allow จะมีลักษณะดังนี้

  () => {...}

• ปฏิเสธ

  void

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

  ฟังก์ชัน deny จะมีลักษณะดังนี้

  () => {...}

SelectionRect

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

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

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

• ความสูง

  ตัวเลข

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

• ซ้าย

  ตัวเลข

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

• ด้านบน

  ตัวเลข

  ระยะห่างจากขอบด้านบนของหน้าจอถึงขอบด้านบนของสี่เหลี่ยมผืนผ้า

• ความกว้าง

  ตัวเลข

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

StopFindingAction

Chrome 141 ขึ้นไป

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

ค่าแจกแจง

"clear"

"keep"

"เปิดใช้งาน"

WebRequestEventInterface

Chrome 44 ขึ้นไป

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

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

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

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

โปรดทราบว่าเงื่อนไขและการดำเนินการสำหรับ webRequests ของ 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]);

WindowOpenDisposition

Chrome 141 ขึ้นไป

การจัดการที่ขอของหน้าต่างใหม่

ค่าแจกแจง

"ignore"

"save_to_disk"

"current_tab"

"new_background_tab"

"new_foreground_tab"

"new_window"

"new_popup"

ZoomMode

Chrome 43 ขึ้นไป

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

ค่าแจกแจง

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

"per-view"
การเปลี่ยนแปลงการซูมจะมีผลใน 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[]],
): void

เพิ่มกฎการแทรกสคริปต์เนื้อหาลงใน 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,
): void

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

พารามิเตอร์

• callback

  function ไม่บังคับ

  Chrome 44 ขึ้นไป

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (success: boolean) => void

  • สำเร็จ

    บูลีน

    ระบุว่าการนำทางสำเร็จหรือไม่

canGoBack()

chrome.webviewTag.canGoBack(): boolean

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

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

• บูลีน

canGoForward()

chrome.webviewTag.canGoForward(): boolean

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

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

• บูลีน

captureVisibleRegion()

Chrome 50 ขึ้นไป

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

จับภาพพื้นที่ที่มองเห็นได้ของ WebView

พารามิเตอร์

• ตัวเลือก

  ImageDetails ไม่บังคับ

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (dataUrl: string) => void

  • dataUrl

    สตริง

    URL ข้อมูลที่เข้ารหัสรูปภาพของพื้นที่ที่มองเห็นได้ของแท็บที่บันทึกไว้ อาจกำหนดให้กับพร็อพเพอร์ตี้ "src" ขององค์ประกอบรูปภาพ HTML เพื่อแสดงผล

clearData()

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

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

พารามิเตอร์

• ตัวเลือก

  ClearDataOptions

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

• ประเภท

  ClearDataTypeSet

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

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  () => void

executeScript()

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

แทรกโค้ด JavaScript ลงในหน้าผู้มาเยือน

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

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

พารามิเตอร์

• รายละเอียด

  InjectDetails

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

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (result?: any[]) => void

  • ผลลัพธ์

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

    ผลลัพธ์ของสคริปต์ในทุกเฟรมที่แทรก

find()

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

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

พารามิเตอร์

• searchText

  สตริง

  สตริงที่จะค้นหาในหน้าเว็บ

• ตัวเลือก

  FindOptions ไม่บังคับ

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

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (results?: FindCallbackResults) => void

  • ผลลัพธ์

    FindCallbackResults ไม่บังคับ

    มีผลลัพธ์ทั้งหมดของคำขอค้นหา คุณสามารถละเว้น results ได้หากไม่ได้ใช้ในเนื้อหาฟังก์ชัน Callback เช่น หากใช้ Callback เพื่อแยกแยะเมื่อคำขอค้นหาเสร็จสมบูรณ์เท่านั้น

forward()

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

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

พารามิเตอร์

• callback

  function ไม่บังคับ

  Chrome 44 ขึ้นไป

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (success: boolean) => void

  • สำเร็จ

    บูลีน

    ระบุว่าการนำทางสำเร็จหรือไม่

getAudioState()

Chrome 62 ขึ้นไป

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

ค้นหาสถานะเสียง

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (audible: boolean) => void

  • audible

    บูลีน

getProcessId()

chrome.webviewTag.getProcessId(): number

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

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

• ตัวเลข

getUserAgent()

chrome.webviewTag.getUserAgent(): string

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

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

• สตริง

getZoom()

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

รับปัจจัยการซูมปัจจุบัน

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (zoomFactor: number) => void

  • zoomFactor

    ตัวเลข

    ปัจจัยการซูมปัจจุบัน

getZoomMode()

Chrome 43 ขึ้นไป

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

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

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (ZoomMode: ZoomMode) => void

  • ZoomMode

    ZoomMode

    โหมดการซูมปัจจุบันของ webview

go()

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

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

พารามิเตอร์

• relativeIndex

  ตัวเลข

  ดัชนีประวัติที่เกี่ยวข้องซึ่งควรไปยัง webview เช่น ค่า 2 จะไปยังรายการประวัติข้างหน้า 2 รายการหากเป็นไปได้ ค่า -3 จะไปยังรายการประวัติย้อนหลัง 3 รายการ

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (success: boolean) => void

  • สำเร็จ

    บูลีน

    ระบุว่าการนำทางสำเร็จหรือไม่

insertCSS()

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

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

พารามิเตอร์

• รายละเอียด

  InjectDetails

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

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  () => void

isAudioMuted()

Chrome 62 ขึ้นไป

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

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

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (muted: boolean) => void

  • ปิดเสียงอยู่

    บูลีน

isSpatialNavigationEnabled()

Chrome 71 ขึ้นไป

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

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

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (enabled: boolean) => void

  • เปิดอยู่

    บูลีน

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden(): void

ระบุว่าสตริง User Agent ของ webview ถูกลบล้างโดย webviewTag.setUserAgentOverride หรือไม่

loadDataWithBaseUrl()

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

โหลด URL ข้อมูลที่มี URL ฐานที่ระบุซึ่งใช้สำหรับ Relative Link คุณสามารถระบุ URL เสมือนที่จะแสดงต่อผู้ใช้แทน URL ข้อมูลได้ (ไม่บังคับ)

พารามิเตอร์

• dataUrl

  สตริง

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

• baseUrl

  สตริง

  URL ฐานที่จะใช้สำหรับ Relative Link

• virtualUrl

  สตริง ไม่บังคับ

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

print()

chrome.webviewTag.print(): void

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

reload()

chrome.webviewTag.reload(): void

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

removeContentScripts()

Chrome 44 ขึ้นไป

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

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

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

webview.removeContentScripts(['myRule']);

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

webview.removeContentScripts();

พารามิเตอร์

• scriptNameList

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

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

setAudioMuted()

Chrome 62 ขึ้นไป

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

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

พารามิเตอร์

• ปิดเสียง

  บูลีน

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

setSpatialNavigationEnabled()

Chrome 71 ขึ้นไป

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

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

พารามิเตอร์

• เปิดอยู่

  บูลีน

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

setUserAgentOverride()

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

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

พารามิเตอร์

• userAgent

  สตริง

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

setZoom()

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

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

พารามิเตอร์

• zoomFactor

  ตัวเลข

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

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  () => void

setZoomMode()

Chrome 43 ขึ้นไป

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

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

พารามิเตอร์

• ZoomMode

  ZoomMode

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

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  () => void

stop()

chrome.webviewTag.stop(): void

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

stopFinding()

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

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

พารามิเตอร์

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

  StopFindingAction ไม่บังคับ

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

terminate()

chrome.webviewTag.terminate(): void

บังคับให้หยุดกระบวนการแสดงผลของหน้าเว็บของผู้มาเยือน การดำเนินการนี้อาจส่งผลต่อแท็ก 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: DialogMessageType, messageText: string, dialog: DialogController) => void

  • messageType

    DialogMessageType

  • 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 จะมีลักษณะดังนี้

  (details: object) => void

  • รายละเอียด

    ออบเจ็กต์

    • processID

      ตัวเลข

      รหัสภายในของ Chrome ของกระบวนการที่ออก

    • เหตุผล

      ExitReason

      สตริงที่ระบุเหตุผลในการออก

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

  • ยกเลิกแล้ว

    บูลีน

  • finalUpdate

    สตริง

loadabort

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

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

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

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

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

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

  • URL

    สตริง

  • isTopLevel

    บูลีน

  • รหัส

    ตัวเลข

  • เหตุผล

    LoadAbortReason

loadcommit

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

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

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

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

  • URL

    สตริง

  • isTopLevel

    บูลีน

loadredirect

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

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

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

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

  • oldUrl

    สตริง

  • newUrl

    สตริง

  • isTopLevel

    บูลีน

loadstart

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

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

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

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

  • URL

    สตริง

  • isTopLevel

    บูลีน

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: WindowOpenDisposition) => void

  • หน้าต่าง

    NewWindow

  • targetUrl

    สตริง

  • initialWidth

    ตัวเลข

  • initialHeight

    ตัวเลข

  • name

    สตริง

  • windowOpenDisposition

    WindowOpenDisposition

permissionrequest

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

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

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

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

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

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

  • สิทธิ์

    PermissionType

  • ส่งคำขอ

    ออบเจ็กต์

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

    ตัวเลข