chrome.webviewTag

คำอธิบาย

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

สิทธิ์

webview

ประเภท

ClearDataOptions

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

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

  • ตั้งแต่

    ตัวเลข ไม่บังคับ

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

ClearDataTypeSet

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

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

  • appcache

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

    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 ที่ตรงกับนิพจน์ทั่วไปนี้ มีไว้เพื่อเลียนแบบคีย์เวิร์ด @exclude ของ Greasemonkey

  • exclude_matches

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

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

  • include_globs

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

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

  • js

    InjectionItems ไม่บังคับ

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

  • match_about_blank

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

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

  • ตรงกับ

    string[]

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

  • ชื่อ

    สตริง

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

  • run_at

    RunAt ไม่บังคับ

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

ContentWindow

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

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

  • postMessage

    โมฆะ

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

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

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

    ฟังก์ชัน postMessage มีรูปแบบดังนี้ 

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

    • ข้อความ

      ใดๆ

      ออบเจ็กต์ข้อความที่จะส่งไปยังผู้เข้าร่วม

    • targetOrigin

      สตริง

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

ContextMenuCreateProperties

Chrome 44 ขึ้นไป

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

  • เลือกไว้

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

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

  • บริบท

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

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

  • documentUrlPatterns

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

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

  • เปิดใช้อยู่

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

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

  • id

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

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

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

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

  • ประเภท

    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

          โมฆะ

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

          ฟังก์ชัน preventDefault มีรูปแบบดังนี้ 

          () => {...}

  • สร้าง

    โมฆะ

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

    ฟังก์ชัน create มีรูปแบบดังนี้ 

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

    • createProperties

      ออบเจ็กต์

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

    • Callback

      ฟังก์ชัน ไม่บังคับ

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

      () => void

    • returns

      สตริง | ตัวเลข

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

  • นำข้อมูลออก

    โมฆะ

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

    ฟังก์ชัน remove มีรูปแบบดังนี้ 

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

    • menuItemId

      สตริง | ตัวเลข

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

    • Callback

      ฟังก์ชัน ไม่บังคับ

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

      () => void

  • removeAll

    โมฆะ

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

    ฟังก์ชัน removeAll มีรูปแบบดังนี้ 

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

    • Callback

      ฟังก์ชัน ไม่บังคับ

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

      () => void

  • อัปเดต

    โมฆะ

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

    ฟังก์ชัน update มีรูปแบบดังนี้ 

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

    • id

      สตริง | ตัวเลข

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

    • updateProperties

      ออบเจ็กต์

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

    • Callback

      ฟังก์ชัน ไม่บังคับ

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

      () => void

ContextMenuUpdateProperties

Chrome 44 ขึ้นไป

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

  • เลือกไว้

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

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

  • บริบท

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

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

  • documentUrlPatterns

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

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

  • เปิดใช้อยู่

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

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

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

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

  • ประเภท

    ItemType ไม่บังคับ

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

  • onclick

    void ไม่บังคับ

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

    ฟังก์ชัน onclick มีรูปแบบดังนี้ 

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

    • ข้อมูล

      OnClickData

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

ContextType

Chrome 44 ขึ้นไป

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

ค่าแจกแจง

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

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

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

  • ยกเลิก

    โมฆะ

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

    ฟังก์ชัน cancel มีรูปแบบดังนี้ 

    () => {...}

  • ตกลง

    โมฆะ

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

    ฟังก์ชัน ok มีรูปแบบดังนี้ 

    (response?: 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

    ตัวเลข

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

  • ยกเลิกแล้ว

    บูลีน

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

  • 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 อย่างพร้อมกันไม่ได้

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

  • รหัส

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

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

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

  • ไฟล์

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

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

InjectionItems

Chrome 44 ขึ้นไป

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

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

  • รหัส

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

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

  • ไฟล์

    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

    บูลีน

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

  • URL

    สตริง

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

  • userGesture

    บูลีน

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

  • allow

    โมฆะ

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

    ฟังก์ชัน allow มีรูปแบบดังนี้ 

    () => {...}

  • ปฏิเสธ

    โมฆะ

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

    ฟังก์ชัน deny มีรูปแบบดังนี้ 

    () => {...}

SelectionRect

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

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

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

  • ส่วนสูง

    ตัวเลข

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

  • ซ้าย

    ตัวเลข

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

  • ด้านบน

    ตัวเลข

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

  • ความกว้าง

    ตัวเลข

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

WebRequestEventInterface

Chrome 44 ขึ้นไป

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

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

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ระบบจะบันทึกการเปลี่ยนแปลงการซูมไว้กับต้นทาง ซึ่งหมายความว่าเมื่อไปยังหน้าอื่นๆ ในต้นทางเดียวกัน ระบบจะซูมหน้าทั้งหมดเป็นอัตราส่วนการซูมเดียวกัน

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

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

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

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

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

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

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

พารามิเตอร์

back()

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

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน ไม่บังคับ

    Chrome 44 ขึ้นไป

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

    (success: boolean) => void

    • สำเร็จ

      บูลีน

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

canGoBack()

chrome.webviewTag.canGoBack()

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

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

  • บูลีน

canGoForward()

chrome.webviewTag.canGoForward()

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

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

  • บูลีน

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

    • สำเร็จ

      บูลีน

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

getAudioState()

Chrome 62 ขึ้นไป 
chrome.webviewTag.getAudioState(
  callback: function,
)

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (audible: boolean) => void

    • audible

      บูลีน

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

    • สำเร็จ

      บูลีน

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

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

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

      บูลีน

isSpatialNavigationEnabled()

Chrome 71 ขึ้นไป 
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (enabled: boolean) => void

    • เปิดใช้อยู่

      บูลีน

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

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

    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

พารามิเตอร์

  • ปิดเสียง

    บูลีน

    ค่าปิดเสียง

setSpatialNavigationEnabled()

Chrome 71 ขึ้นไป 
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

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

พารามิเตอร์

  • เปิดใช้อยู่

    บูลีน

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

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

ลบล้างสตริง User Agent ที่ webview ใช้สำหรับคำขอหน้าผู้มาเยือน การลบล้างจะทำให้ค่าส่วนหัวคำแนะนำสำหรับไคลเอ็นต์ของ User Agent และค่าที่ 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" 
 ,
)

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

พารามิเตอร์

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

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

      "alert"
       | "confirm"
       | "prompt"

    • 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

      ตัวเลข

    • เหตุผล

      "normal"
       | "abnormal"
       | "crash"
       | "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

    • ยกเลิกแล้ว

      บูลีน

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

      บูลีน

    • รหัส

      ตัวเลข

    • เหตุผล

      "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

      บูลีน

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: "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 แก่หน้าผู้มาเยือน โปรดทราบว่าแอปที่ใช้โค้ดตัวอย่างนี้ต้องระบุสิทธิ์ในไฟล์ Manifest audioCapture และ/หรือ videoCapture ด้วยตนเอง

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

    • สิทธิ์

      "media"
       | "geolocation"
       | "pointerLock"
       | "download"
       | "loadplugin"
       | "filesystem"
       | "fullscreen"
       | "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

      ตัวเลข