chrome.webviewTag

คำอธิบาย

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

สิทธิ์

webview

ประเภท

ClearDataOptions

ตัวเลือกที่ระบุว่าควรล้างข้อมูลใดภายใน clearData

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

  • ตั้งแต่

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

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

  • ตรงกัน

    สตริง[]

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

  • ชื่อ

    string

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

  • 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

      string

      ระบุต้นทางของหน้าต่างผู้เข้าร่วมสำหรับการส่งกิจกรรม

ContextMenuCreateProperties

Chrome 44 ขึ้นไป

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

  • เลือกไว้

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

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

  • บริบท

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

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

  • documentUrlPatterns

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

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

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

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

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

  • id

    string ไม่บังคับ

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

    string ไม่บังคับ

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

      • เหตุการณ์

        ออบเจ็กต์

        • preventDefault

          void

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

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

          ()=> {...}

  • สร้าง

    void

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

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

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

    • createProperties

      ออบเจ็กต์

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

    • Callback

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

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

      ()=>void

    • returns

      string|number

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

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

    void

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

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

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

    • menuItemId

      string|number

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

    • Callback

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

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

      ()=>void

  • removeAll

    void

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

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

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

    • Callback

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

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

      ()=>void

  • อัปเดต

    void

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

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

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

    • id

      string|number

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

    • updateProperties

      ออบเจ็กต์

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

    • Callback

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

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

      ()=>void

ContextMenuUpdateProperties

Chrome 44 ขึ้นไป

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

  • เลือกไว้

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

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

  • บริบท

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

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

  • documentUrlPatterns

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

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

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

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

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

    string ไม่บังคับ

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

  • ประเภท

    ItemType ไม่บังคับ

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

  • onclick

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

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

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

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

    • ข้อมูล

      OnClickData

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

ContextType

Chrome 44 ขึ้นไป

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

ค่าแจกแจง

DialogController

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

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

  • ยกเลิก

    void

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

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

    ()=> {...}

  • ตกลง

    void

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

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

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

    • การตอบกลับ

      string ไม่บังคับ

      สตริงการตอบกลับที่จะส่งถึงผู้เข้าร่วมเมื่อยอมรับกล่องโต้ตอบ prompt

DownloadPermissionRequest

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

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

  • requestMethod

    string

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

  • url

    string

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

  • allow

    void

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

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

    ()=> {...}

  • ปฏิเสธ

    void

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

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

    ()=> {...}

FileSystemPermissionRequest

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

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

  • url

    string

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

  • allow

    void

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

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

    ()=> {...}

  • ปฏิเสธ

    void

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

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

    ()=> {...}

FindCallbackResults

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

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

  • activeMatchOrdinal

    ตัวเลข

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

  • ยกเลิกแล้ว

    boolean

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

  • numberOfMatches

    ตัวเลข

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

  • selectionRect

    SelectionRect

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

FindOptions

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

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

  • ย้อนกลับ

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

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

  • matchCase

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

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

FullscreenPermissionRequest

Chrome 43 ขึ้นไป

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

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

  • ต้นกำเนิด

    string

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

  • allow

    void

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

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

    ()=> {...}

  • ปฏิเสธ

    void

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

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

    ()=> {...}

GeolocationPermissionRequest

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

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

  • url

    string

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

  • allow

    void

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

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

    ()=> {...}

  • ปฏิเสธ

    void

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

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

    ()=> {...}

HidPermissionRequest

รอดำเนินการ

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

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

  • url

    string

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

  • allow

    void

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

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

    ()=> {...}

  • ปฏิเสธ

    void

    ปฏิเสธคำขอสิทธิ์ นี่คือลักษณะการทำงานเริ่มต้นหากไม่มีการเรียกใช้ 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

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

  • ตัวระบุ

    string

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

  • ชื่อ

    string

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

  • allow

    void

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

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

    ()=> {...}

  • ปฏิเสธ

    void

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

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

    ()=> {...}

MediaPermissionRequest

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

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

  • url

    string

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

  • allow

    void

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

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

    ()=> {...}

  • ปฏิเสธ

    void

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

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

    ()=> {...}

NewWindow

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

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

  • ต่อเชื่อม

    void

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

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

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

    • webview

      ออบเจ็กต์

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

  • ทิ้ง

    void

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

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

    ()=> {...}

PointerLockPermissionRequest

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

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

  • lastUnlockedBySelf

    boolean

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

  • url

    string

    URL ของเฟรมที่ขอล็อกตัวชี้

  • userGesture

    boolean

    มีการขอล็อกตัวชี้จากท่าทางสัมผัสการป้อนข้อมูลของผู้ใช้หรือไม่

  • allow

    void

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

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

    ()=> {...}

  • ปฏิเสธ

    void

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

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

    ()=> {...}

SelectionRect

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

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

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

  • ส่วนสูง

    ตัวเลข

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

  • ฝั่งซ้าย

    ตัวเลข

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

  • ครึ่งแรกของอินนิ่ง

    ตัวเลข

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

  • ความกว้าง

    ตัวเลข

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

WebRequestEventInterface

Chrome 44 ขึ้นไป

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

ดูความแตกต่างระหว่างการใช้งานกับ 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 ระดับบนสุดอีกครั้ง

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

พารามิเตอร์

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

      string

      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

    • ผลลัพธ์

      ทั้งหมด[] ไม่บังคับ

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

find()

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

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

พารามิเตอร์

  • searchText

    string

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

  • ตัวเลือก

    FindOptions ไม่บังคับ

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

  • Callback

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

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

    (results?: FindCallbackResults)=>void

    • ผลการแข่งขัน

      FindCallbackResults ไม่บังคับ

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

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 ใช้สำหรับคำขอหน้าเว็บผู้มาเยือน

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

  • string

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

    string

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

  • baseUrl

    string

    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

    string

    สตริง 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 จะยังคงไฮไลต์การจับคู่ที่ใช้งานอยู่ต่อไปและจำลองการคลิกของผู้ใช้ในการจับคู่นั้น การดำเนินการเริ่มต้นคือ 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

    • ระดับ

      ตัวเลข

    • ข้อความ

      string

    • บรรทัด

      ตัวเลข

    • sourceId

      string

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"
      |"ยืนยัน"
      |"ข้อความแจ้ง"

    • messageText

      string

    • กล่องโต้ตอบ

      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

      ตัวเลข

    • สาเหตุ

findupdate

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

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (searchText: string,numberOfMatches: number,activeMatchOrdinal: number,selectionRect: SelectionRect,canceled: boolean,finalUpdate: string)=>void

    • searchText

      string

    • numberOfMatches

      ตัวเลข

    • activeMatchOrdinal

      ตัวเลข

    • selectionRect

      SelectionRect

    • ยกเลิกแล้ว

      boolean

    • finalUpdate

      string

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

      string

    • isTopLevel

      boolean

    • รหัส

      ตัวเลข

    • สาเหตุ

      "ERR_ABORTED"
      |"ERR_INVALID_URL"
      |"ERR_DISAllowed_URL_SCHEME"
      |"ERR_BLOCKED_BY_CLIENT"
      |"ERR_ADDRESS_UNREACHABLE"
      |"ERR_EMPTY_RESPONSE"
      |"

loadcommit

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

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

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

    • url

      string

    • isTopLevel

      boolean

loadredirect

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

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

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

    • oldUrl

      string

    • newUrl

      string

    • isTopLevel

      boolean

loadstart

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

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

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

    • url

      string

    • 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

      string

    • initialWidth

      ตัวเลข

    • initialHeight

      ตัวเลข

    • ชื่อ

      string

    • windowOpenDisposition

      "ignore"
      |"save_to_disk"
      |"current_tab"
      |"new_background_tab"
      |"new_foreground_tab"
      |"new_window"
      |"new_popup"

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: "media" 
     |"geolocation" 
     |"pointerLock" 
     |"download" 
     |"loadplugin" 
     |"filesystem" 
     |"fullscreen" 
     |"hid" 
     ,request: object)=>void

    • สิทธิ์

      "media"
      |"ตำแหน่งทางภูมิศาสตร์"
      |"pointerLock"
      |"download"
      |"loadplugin"
      |"filesystem"
      |"เต็มหน้าจอ"
      |"ซ่อน"

    • ส่งคำขอ

      ออบเจ็กต์

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

      ตัวเลข