chrome.webviewTag

คำอธิบาย

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

สิทธิ์

webview

ประเภท

ClearDataOptions

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

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

  • ตั้งแต่

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

    ล้างข้อมูลที่สะสมตั้งแต่วันที่นี้เป็นต้นไป ซึ่งแสดงเป็นมิลลิวินาทีตั้งแต่ Epoch (เข้าถึงได้ผ่านเมธอด 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 ขึ้นไป

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

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

  • 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

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

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

  • ตรงกับ

    string[]

    ระบุหน้าเว็บที่จะแทรก Content Script นี้

  • ชื่อ

    สตริง

    ชื่อของ Content Script ที่จะแทรก

  • run_at

    RunAt ไม่บังคับ

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

ContentWindow

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

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

  • postMessage

    เป็นโมฆะ

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

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

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

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

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

    • ข้อความ

      ใดๆ

      ออบเจ็กต์ข้อความที่จะส่งถึงแขกรับเชิญ

    • targetOrigin

      สตริง

      ระบุว่าต้นทางของหน้าต่างผู้เข้าชมต้องเป็นอะไรจึงจะส่งเหตุการณ์ได้

ContextMenuCreateProperties

Chrome 44 ขึ้นไป

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

  • เลือกแล้ว

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

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

  • บริบท

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

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

  • documentUrlPatterns

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

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

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

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

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

  • id

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

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

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

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

  • ประเภท

    ItemType ไม่บังคับ

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

  • onclick

    void optional

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

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

    (info: 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 ขึ้นไป

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

  • เลือกแล้ว

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

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

  • บริบท

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

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

  • documentUrlPatterns

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

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

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

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

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

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

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

  • ประเภท

    ItemType ไม่บังคับ

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

  • onclick

    void optional

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

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

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

    • ข้อมูล

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

ContextType

Chrome 44 ขึ้นไป

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

ค่าแจกแจง

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"วิดีโอ"

"audio"

DialogController

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

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

  • ยกเลิก

    เป็นโมฆะ

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

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

    () => {...}

  • ตกลง

    เป็นโมฆะ

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

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

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

    • การตอบกลับ

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

      สตริงการตอบกลับที่จะแสดงต่อแขกเมื่อยอมรับกล่องโต้ตอบ prompt

DialogMessageType

รอดำเนินการ

ประเภทกล่องโต้ตอบแบบโมดอลที่แขกขอ

ค่าแจกแจง

"alert"

"ยืนยัน"

"พรอมต์"

DownloadPermissionRequest

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

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

  • requestMethod

    สตริง

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

  • URL

    สตริง

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

  • allow

    เป็นโมฆะ

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

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

    () => {...}

  • ปฏิเสธ

    เป็นโมฆะ

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

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

    () => {...}

ExitReason

รอดำเนินการ

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

ค่าแจกแจง

"ปกติ"

"abnormal"

"ขัดข้อง"

"killed"

"oom killed"

"oom"

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

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

FileSystemPermissionRequest

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

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

  • URL

    สตริง

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

  • allow

    เป็นโมฆะ

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

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

    () => {...}

  • ปฏิเสธ

    เป็นโมฆะ

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

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

    () => {...}

FindCallbackResults

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

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

  • activeMatchOrdinal

    ตัวเลข

    หมายเลขลำดับของการแข่งขันปัจจุบัน

  • ยกเลิกแล้ว

    บูลีน

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

  • numberOfMatches

    ตัวเลข

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

  • selectionRect

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

FindOptions

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

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

  • ย้อนกลับ

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

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

  • matchCase

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

    Flag เพื่อให้ตรงกับตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ ค่าเริ่มต้นคือ 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 ที่จะแทรกลงในหน้าเว็บที่ตรงกัน โดยจะแทรกตามลำดับที่ปรากฏในอาร์เรย์นี้

LoadAbortReason

รอดำเนินการ

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

ค่าแจกแจง

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

    () => {...}

PermissionType

รอดำเนินการ

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

ค่าแจกแจง

"media"

"geolocation"

"pointerLock"

"ดาวน์โหลด"

"loadplugin"

"filesystem"

"fullscreen"

"hid"

PointerLockPermissionRequest

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

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

  • lastUnlockedBySelf

    บูลีน

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

  • URL

    สตริง

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

  • userGesture

    บูลีน

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

  • allow

    เป็นโมฆะ

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

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

    () => {...}

  • ปฏิเสธ

    เป็นโมฆะ

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

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

    () => {...}

SelectionRect

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

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

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

  • ส่วนสูง

    ตัวเลข

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

  • ซ้าย

    ตัวเลข

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

  • ด้านบน

    ตัวเลข

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

  • ความกว้าง

    ตัวเลข

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

StopFindingAction

รอดำเนินการ

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

ค่าแจกแจง

"ล้าง"

"keep"

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

WebRequestEventInterface

Chrome 44 ขึ้นไป

อินเทอร์เฟซที่ให้สิทธิ์เข้าถึงเหตุการณ์ webRequest ในหน้าเว็บของผู้เข้าชม ดูรายละเอียดเกี่ยวกับวงจรของ webRequest และแนวคิดที่เกี่ยวข้องได้ใน API ส่วนขยาย chrome.webRequest หมายเหตุ: 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]);

WindowOpenDisposition

รอดำเนินการ

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

ค่าแจกแจง

"ignore"

"save_to_disk"

"current_tab"

"new_background_tab"

"new_foreground_tab"

"new_window"

"new_popup"

ZoomMode

Chrome 43 ขึ้นไป

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

ค่าแจกแจง

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

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

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

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

contentWindow

การอ้างอิงออบเจ็กต์ที่ใช้โพสต์ข้อความในหน้าเว็บของผู้เข้าชมได้

ประเภท

contextMenus

Chrome 44 ขึ้นไป

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

ประเภท

request

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

ประเภท

เมธอด

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 จะได้รับการเปลี่ยนระดับก็ตาม

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

พารามิเตอร์

back()

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

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

พารามิเตอร์

  • callback

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

    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

พารามิเตอร์

  • ตัวเลือก

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

  • ประเภท

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

  • callback

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

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

    () => void

executeScript()

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

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

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

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

พารามิเตอร์

  • รายละเอียด

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

  • callback

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

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

    (result?: any[]) => void

    • ผลลัพธ์

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

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

find()

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

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

พารามิเตอร์

  • searchText

    สตริง

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

  • ตัวเลือก

    FindOptions ไม่บังคับ

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

  • callback

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

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

    (results?: FindCallbackResults) => void

    • ผลลัพธ์

      FindCallbackResults ไม่บังคับ

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

forward()

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

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

พารามิเตอร์

  • callback

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

    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 คนจะแชร์กระบวนการได้ก็ต่อเมื่อเป็นของแอปเดียวกันและมีรหัสพาร์ติชันพื้นที่เก็บข้อมูลเดียวกัน การเรียกใช้เป็นแบบซิงโครนัสและแสดงผลแนวคิดที่แคชไว้ของผู้ฝังเกี่ยวกับรหัสกระบวนการปัจจุบัน รหัสกระบวนการไม่ใช่รหัสกระบวนการของระบบปฏิบัติการ

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

  • ตัวเลข

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

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

go()

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

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

พารามิเตอร์

  • relativeIndex

    ตัวเลข

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

  • callback

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

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

    (success: boolean) => void

    • สำเร็จ

      บูลีน

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

insertCSS()

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

แทรก CSS ลงในหน้าแขกรับเชิญ

พารามิเตอร์

  • รายละเอียด

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

  • callback

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

    พารามิเตอร์ 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

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

loadDataWithBaseUrl()

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

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

พารามิเตอร์

  • dataUrl

    สตริง

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

  • baseUrl

    สตริง

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

  • virtualUrl

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

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

print()

chrome.webviewTag.print(): void

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

reload()

chrome.webviewTag.reload(): void

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

removeContentScripts()

Chrome 44 ขึ้นไป
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)
: void

นำ Content Script ออกจาก webview

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

webview.removeContentScripts(['myRule']);

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

webview.removeContentScripts();

พารามิเตอร์

  • scriptNameList

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

    รายการชื่อของ Content Script ที่จะนำออก หากรายการว่างเปล่า ระบบจะนำสคริปต์เนื้อหาทั้งหมดที่เพิ่มลงใน 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

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

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

    () => void

setZoomMode()

Chrome 43 ขึ้นไป
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)
: void

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

พารามิเตอร์

  • ZoomMode

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

  • callback

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

    พารามิเตอร์ 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())

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

พารามิเตอร์

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 ของกระบวนการที่ออก

      • เหตุผล

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

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
    • ยกเลิกแล้ว

      บูลีน

    • 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

      บูลีน

    • รหัส

      ตัวเลข

    • เหตุผล

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

    • หน้าต่าง
    • targetUrl

      สตริง

    • initialWidth

      ตัวเลข

    • initialHeight

      ตัวเลข

    • ชื่อ

      สตริง

    • windowOpenDisposition

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: PermissionType, request: object) => void

    • สิทธิ์
    • ส่งคำขอ

      ออบเจ็กต์

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,
)

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

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (processID: number) => void

    • processID

      ตัวเลข

zoomchange

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

ทริกเกอร์เมื่อมีการเปลี่ยนแปลงการซูมของหน้า

พารามิเตอร์

  • callback

    ฟังก์ชัน

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

    (oldZoomFactor: number, newZoomFactor: number) => void

    • oldZoomFactor

      ตัวเลข

    • newZoomFactor

      ตัวเลข