chrome.webviewTag

說明

使用 webview 標記，透過網路主動載入來自網際網路的即時內容，並將內容嵌入 Chrome 應用程式。應用程式可控制 webview 的顯示方式，並與網頁內容互動、在嵌入的網頁中啟動導覽、回應發生在該網頁中的錯誤事件等 (請參閱「使用方式」)。

權限

webview

類型

ClearDataOptions

決定 clearData 應清除哪些資料的選項。

屬性

  • 開始於

    號碼 選填

    清除此日期當天或之後累積的資料，以自紀元起算的毫秒為單位 (可透過 JavaScript Date 物件的 getTime 方法存取)。如果未指定，預設值為 0 (會移除所有瀏覽資料)。

ClearDataTypeSet

一組資料類型。系統會將缺少的屬性解讀為 false。

屬性

  • appcache

    boolean 選填

    網站的應用程式快取。

  • 快取

    boolean 選填

    Chrome 44 以上版本

    自 Chrome 43 版起。瀏覽器的快取。注意：移除資料時，這項操作會清除整個快取，而不限於您指定的範圍。

  • Cookie

    boolean 選填

    分區的 Cookie。

  • fileSystems

    boolean 選填

    網站的檔案系統。

  • indexedDB

    boolean 選填

    網站的 IndexedDB 資料。

  • localStorage

    boolean 選填

    網站的本機儲存資料。

  • persistentCookies

    boolean 選填

    Chrome 58 以上版本

    分區的永久 Cookie。

  • sessionCookies

    boolean 選填

    Chrome 58 以上版本

    分隔區的工作階段 Cookie。

  • webSQL

    boolean 選填

    網站的 WebSQL 資料。

ContentScriptDetails

Chrome 44 以上版本

要插入的內容指令碼詳細資料。詳情請參閱內容指令碼說明文件。

屬性

  • all_frames

    boolean 選填

    如果 all_frames 是 true，則表示 JavaScript 或 CSS 應插入目前網頁的所有影格。根據預設，all_frames 為 false，且 JavaScript 或 CSS 只會插入頂端框架。

  • CSS

    InjectionItems 選填

    要插入相符網頁的 CSS 程式碼或 CSS 檔案清單。這些項目會依照顯示順序插入，並在任何 DOM 建構或顯示頁面之前執行。

  • exclude_globs

    string[] 選填

    在比對後套用，用於排除與此 glob 相符的網址。意圖模擬 Greasemonkey 的 @exclude 關鍵字。

  • exclude_matches

    string[] 選填

    排除這項內容指令碼會注入的網頁。

  • include_globs

    string[] 選填

    在比對完成後套用，只納入與此 glob 相符的網址。意圖模擬 @include Greasemonkey 關鍵字。

  • js

    InjectionItems 選填

    要插入相符網頁的 JavaScript 程式碼或 JavaScript 檔案清單。這些項目會依顯示順序插入。

  • match_about_blank

    boolean 選填

    是否要在 about:blank 和 about:srcdoc 中插入內容指令碼。只有在繼承網址與 matches 欄位中宣告的模式相符時，系統才會在網頁上插入內容指令碼。繼承網址是建立框架或視窗的文件網址。內容指令碼不得插入沙箱化框架。

  • 完全相符

    string[]

    指定要將這個內容指令碼插入哪些網頁。

  • 名稱

    字串

    要插入的內容指令碼名稱。

  • run_at

    RunAt 選填

    JavaScript 或 CSS 最快會在何時注入分頁。預設值為「document_idle」。

ContentWindow

將訊息控制項傳送至訪客視窗。

屬性

  • postMessage

    void

    只要嵌入內容顯示目標來源的網頁，就會將訊息發布至嵌入的網頁內容。網頁載入完成後，即可使用這項方法。監聽 contentload 事件，然後呼叫該方法。

    訪客可在收到的訊息事件中，將訊息發布至 event.source，藉此傳送回覆給嵌入者。

    這個 API 與用於網頁間通訊的 HTML5 postMessage API 相同。嵌入者可以將 message 事件監聽器新增至自己的框架，以便監聽回覆。

    postMessage 函式如下所示： 

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

    • 訊息

      不限

      要傳送給邀請對象的訊息物件。

    • targetOrigin

      字串

      指定要派送事件時，訪客視窗的來源必須為何。

ContextMenuCreateProperties

Chrome 44 以上版本

屬性

  • 已勾選

    boolean 選填

    核取方塊或圓形按鈕項目的初始狀態：已選取為 true，未選取為 false。在特定的圓形按鈕項目群組中，一次只能選取一個圓形按鈕項目。

  • 背景

    [ContextType, ...ContextType[]] 選填

    這個選單項目會顯示的內容清單。如未指定，預設值為 ['page']。

  • documentUrlPatterns

    string[] 選填

    可讓您將項目限制在只套用至網址符合指定模式之一的文件。(這也適用於影格)。如要進一步瞭解模式的格式，請參閱「比對模式」。

  • 已啟用

    boolean 選填

    這個內容選單項目是否已啟用或停用。預設值為 true。

  • id

    string 選填

    要指派給此項目的專屬 ID。這是活動網頁的必要項目。不得與此擴充功能的其他 ID 相同。

  • parentId

    字串 | 數字 選填

    父項選單項目的 ID，這會使該項目成為先前新增項目的子項。

  • targetUrlPatterns

    string[] 選填

    與 documentUrlPatterns 類似，但可讓您根據 img/audio/video 標記的 src 屬性和錨點標記的 href 進行篩選。

  • title

    string 選填

    在項目中顯示的文字。除非 type 為「分隔符」，否則此為必要屬性。如果內容為「選取項目」，您可以在字串中使用 %s 顯示所選文字。舉例來說，如果這個參數的值是「Translate '%s' to Pig Latin」，而使用者選取「cool」這個字，則選取內容的內容選單項目會是「Translate 'cool' to Pig Latin」。

  • 類型

    ItemType 選填

    選單項目的類型。如未指定，預設值為「normal」。

  • onclick

    void 選填

    點選選單項目時會呼叫的回呼函式。

    onclick 函式如下所示： 

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

    • 資訊

      OnClickData

      點選的項目和點擊發生的背景資訊。

ContextMenus

Chrome 44 以上版本

屬性

  • onShow

    Event<functionvoidvoid>

    在這個 webview 上顯示內容選單前觸發。可用於呼叫 event.preventDefault() 來停用這個內容功能表。

    onShow.addListener 函式如下所示： 

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

    • 回呼

      函式

      callback 參數如下所示： 

      (event: object) => void

      • 活動

        物件

        • preventDefault

          void

          呼叫此方法可避免顯示內容選單。

          preventDefault 函式如下所示： 

          () => {...}

  • create

    void

    建立新的內容選單項目。請注意，如果在建立期間發生錯誤，您可能要等到建立回呼觸發時才會發現 (詳細資料會顯示在 runtime.lastError 中)。

    create 函式如下所示： 

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

    • createProperties

      物件

      用來建立項目的屬性

    • 回呼

      函式 選填

      callback 參數如下所示： 

      () => void

    • returns

      字串 | 數字

      新建項目的 ID。

  • 移除

    void

    移除內容選單項目。

    remove 函式如下所示： 

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

    • menuItemId

      字串 | 數字

      要移除的內容選單項目 ID。

    • 回呼

      函式 選填

      callback 參數如下所示： 

      () => void

  • removeAll

    void

    移除新增至此 webview 的所有內容選單項目。

    removeAll 函式如下所示： 

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

    • 回呼

      函式 選填

      callback 參數如下所示： 

      () => void

  • update

    void

    更新先前建立的內容選單項目。

    update 函式如下所示： 

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

    • id

      字串 | 數字

      要更新的商品 ID。

    • updateProperties

      物件

      要更新的房源屬性。接受與 create 函式相同的值。

    • 回呼

      函式 選填

      callback 參數如下所示： 

      () => void

ContextMenuUpdateProperties

Chrome 44 以上版本

屬性

  • 已勾選

    boolean 選填

    核取方塊或圓形按鈕項目的狀態：已選取為 true，未選取為 false。在特定的圓形按鈕項目群組中，一次只能選取一個圓形按鈕項目。

  • 背景

    [ContextType, ...ContextType[]] 選填

    這個選單項目會顯示的內容清單。

  • documentUrlPatterns

    string[] 選填

    可讓您將項目限制在只套用至網址符合指定模式之一的文件。(這也適用於影格)。如要進一步瞭解模式的格式，請參閱「比對模式」。

  • 已啟用

    boolean 選填

    這個內容選單項目是否已啟用或停用。

  • parentId

    字串 | 數字 選填

    父項選單項目的 ID，這會使該項目成為先前新增項目的子項。注意：您無法將項目變更為其自身子項的子項。

  • targetUrlPatterns

    string[] 選填

    與 documentUrlPatterns 類似，但可讓您根據 img/audio/video 標記的 src 屬性和錨點標記的 href 進行篩選。

  • title

    string 選填

    要顯示在項目中的文字

  • 類型

    ItemType 選填

    選單項目的類型。

  • onclick

    void 選填

    點選選單項目時會呼叫的回呼函式。

    onclick 函式如下所示： 

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

    • 資訊

      OnClickData

      點選的項目和點擊發生的背景資訊。

ContextType

Chrome 44 以上版本

選單可顯示的不同情境。指定「all」等同於組合所有其他情境。

列舉

"all"

"page"

"frame"

"selection"

"link"

「editable」

"image"

"video"

"audio"

DialogController

附加至 dialog DOM 事件的介面。

屬性

  • 取消

    void

    拒絕對話方塊。等同於在 confirm 或 prompt 對話方塊中按一下「取消」。

    cancel 函式如下所示： 

    () => {...}

  • 正常

    void

    接受對話方塊。等同於在 alert、confirm 或 prompt 對話方塊中按一下「OK」。

    ok 函式如下所示： 

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

    • 回應

      string 選填

      接受 prompt 對話方塊時，要提供給訪客的回應字串。

DownloadPermissionRequest

download permissionrequest DOM 事件隨附的 request 物件類型。

屬性

  • requestMethod

    字串

    與下載要求相關聯的 HTTP 要求類型 (例如 GET)。

  • 網址

    字串

    要求的下載網址。

  • allow

    void

    允許權限要求。

    allow 函式如下所示： 

    () => {...}

  • deny

    void

    拒絕權限要求。這是未呼叫 allow 時的預設行為。

    deny 函式如下所示： 

    () => {...}

FileSystemPermissionRequest

filesystem permissionrequest DOM 事件隨附的 request 物件類型。

屬性

  • 網址

    字串

    要求存取本機檔案系統的框架網址。

  • allow

    void

    允許權限要求。

    allow 函式如下所示： 

    () => {...}

  • deny

    void

    拒絕權限要求。

    deny 函式如下所示： 

    () => {...}

FindCallbackResults

包含尋找要求的所有結果。

屬性

  • activeMatchOrdinal

    數字

    目前比對項目的序號。

  • 已取消

    布林值

    指出這項搜尋要求是否已取消。

  • numberOfMatches

    數字

    網頁上 searchText 的比對次數。

  • selectionRect

    SelectionRect

    以螢幕座標描述有效比對項目周圍的矩形。

FindOptions

查詢要求的選項。

屬性

  • 倒轉

    boolean 選填

    標記，以反向順序尋找相符項目。預設值為 false。

  • matchCase

    boolean 選填

    用於比對大小寫的標記。預設值為 false。

FullscreenPermissionRequest

Chrome 43 以上版本

fullscreen permissionrequest DOM 事件隨附的 request 物件類型。

屬性

  • 起源

    字串

    啟動全螢幕要求的 webview 中影格來源。

  • allow

    void

    允許權限要求。

    allow 函式如下所示： 

    () => {...}

  • deny

    void

    拒絕權限要求。

    deny 函式如下所示： 

    () => {...}

GeolocationPermissionRequest

geolocation permissionrequest DOM 事件隨附的 request 物件類型。

屬性

  • 網址

    字串

    要求存取地理位置資料的框架網址。

  • allow

    void

    允許權限要求。

    allow 函式如下所示： 

    () => {...}

  • deny

    void

    拒絕權限要求。這是未呼叫 allow 時的預設行為。

    deny 函式如下所示： 

    () => {...}

HidPermissionRequest

Chrome 125 以上版本

伴隨 hid permissionrequest DOM 事件的 request 物件類型。

屬性

  • 網址

    字串

    要求存取 HID API 的框架網址。

  • allow

    void

    允許權限要求。

    allow 函式如下所示： 

    () => {...}

  • deny

    void

    拒絕權限要求。這是未呼叫 allow 時的預設行為。

    deny 函式如下所示： 

    () => {...}

InjectDetails

要插入的程式碼或 CSS 的詳細資料。必須設定程式碼或檔案資源，但兩者不得同時設定。

屬性

  • 程式碼

    string 選填

    要插入的 JavaScript 或 CSS 程式碼。

    警告：請謹慎使用 code 參數。如果使用不當，應用程式可能會遭到跨網站指令碼攻擊。

  • 檔案

    string 選填

    要插入的 JavaScript 或 CSS 檔案。

InjectionItems

Chrome 44 以上版本

注入項目的類型：程式碼或一組檔案。

屬性

  • 程式碼

    string 選填

    要插入相符網頁的 JavaScript 程式碼或 CSS。

  • 檔案

    string[] 選填

    要插入相符網頁的 JavaScript 或 CSS 檔案清單。這些值會依照陣列中的顯示順序注入。

LoadPluginPermissionRequest

loadplugin permissionrequest DOM 事件隨附的 request 物件類型。

屬性

  • ID

    字串

    外掛程式的 ID 字串。

  • 名稱

    字串

    外掛程式的顯示名稱。

  • allow

    void

    允許權限要求。這是未呼叫 deny 時的預設行為。

    allow 函式如下所示： 

    () => {...}

  • deny

    void

    拒絕權限要求。

    deny 函式如下所示： 

    () => {...}

MediaPermissionRequest

media permissionrequest DOM 事件隨附的 request 物件類型。

屬性

  • 網址

    字串

    要求存取使用者媒體的框架網址。

  • allow

    void

    允許權限要求。

    allow 函式如下所示： 

    () => {...}

  • deny

    void

    拒絕權限要求。這是未呼叫 allow 時的預設行為。

    deny 函式如下所示： 

    () => {...}

NewWindow

附加至 newwindow DOM 事件的介面。

屬性

  • 附加

    void

    將要求的目標網頁附加至現有的 webview 元素。

    attach 函式如下所示： 

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

    • WebView

      物件

      目標網頁應附加的 webview 元素。

  • 捨棄

    void

    取消新視窗要求。

    discard 函式如下所示： 

    () => {...}

PointerLockPermissionRequest

pointerLock permissionrequest DOM 事件隨附的 request 物件類型。

屬性

  • lastUnlockedBySelf

    布林值

    要求的框架是否為最近一次持有指標鎖定的用戶端。

  • 網址

    字串

    要求游標鎖定的影格網址。

  • userGesture

    布林值

    系統是否已要求使用者輸入手勢的結果為指標鎖定。

  • allow

    void

    允許權限要求。

    allow 函式如下所示： 

    () => {...}

  • deny

    void

    拒絕權限要求。這是未呼叫 allow 時的預設行為。

    deny 函式如下所示： 

    () => {...}

SelectionRect

說明畫面座標中的矩形。

包含語意是類似陣列，也就是說，座標 (left, top) 會被視為包含在矩形中，但座標 (left + width, top) 則不會。

屬性

  • 高度

    數字

    矩形的高度。

  • 左側

    數字

    從螢幕左側邊緣到矩形左側邊緣的距離。

  • 頂端

    數字

    從螢幕頂端到矩形頂端的距離。

  • 寬度

    數字

    矩形的寬度。

WebRequestEventInterface

Chrome 44 以上版本

提供訪客頁面 webRequest 事件存取權的介面。如要進一步瞭解 webRequest 生命週期和相關概念，請參閱 chrome.webRequest 擴充功能 API。注意：Webview 不支援 chrome.webRequest.onActionIgnored 事件。

為了說明使用方式與 extensions webRequest API 的差異，請參考以下程式碼範例，該程式碼會封鎖任何與 *://www.evil.com/* 相符的網址來賓要求：

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

此外，這個介面也支援透過 onRequest 和 onMessage 事件宣告 webRequest 規則。如需 API 詳細資訊，請參閱 declarativeWebRequest。

請注意，宣告式 WebView 網頁請求的條件和動作應從其 chrome.webViewRequest.* 對應項目例項化。以下程式碼範例會宣告性地封鎖對網頁檢視器 myWebview 上 "example.com" 的所有要求：

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 縮放變更會隨來源儲存，也就是說，當您前往同一來源的其他網頁時，這些網頁都會縮放至相同的縮放比例。

「per-view」
縮放變更只會套用至這個 WebView，其他 WebView 的縮放變更不會影響這個 WebView 的縮放功能。此外，導覽時會重設 per-view 縮放變更；瀏覽網頁檢視畫面時，系統一律會載入各個來源的縮放比例 (在分割區範圍內)。

「disabled」
停用 Webview 中的所有縮放功能。內容會恢復為預設的縮放比例，系統會忽略所有嘗試的縮放變更。

屬性

contentWindow

可用於將訊息發布至訪客頁面的物件參照。

類型

ContentWindow

contextMenus

Chrome 44 以上版本

與 Chrome 的 ContextMenus API 類似，但適用於 webview，而非瀏覽器。使用 webview.contextMenus API 將項目新增至 webview 的內容選單。您可以選擇內容選單新增項目適用於哪些類型的物件，例如圖片、超連結和頁面。

類型

ContextMenus

request

可存取訪客頁面上 webRequest 事件的介面。

類型

WebRequestEventInterface

方法

addContentScripts()

Chrome 44 以上版本 
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)

將內容指令碼插入規則新增至 webview。當 webview 導向符合一或多個規則的網頁時，系統就會插入相關的指令碼。您可以透過程式輔助方式新增規則或更新現有規則。

以下範例會將兩個規則新增至 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,
)

盡可能向後瀏覽一個記錄項目。等同於 go(-1)。

參數

  • 回呼

    函式 選填

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

擷取網頁檢視畫面可見的區域。

參數

  • 選項

    ImageDetails 選填

  • 回呼

    函式

    callback 參數如下所示： 

    (dataUrl: string) => void

    • dataUrl

      字串

      資料網址，可對擷取的分頁可見區域編碼成圖片。可指派至 HTML 圖片元素的「src」屬性，用於顯示。

clearData()

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

清除 webview 分區的瀏覽資料。

參數

  • 用於決定要清除哪些資料的選項。

  • 要清除的資料類型。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    () => void

executeScript()

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

將 JavaScript 程式碼插入訪客頁面。

以下程式碼範例會使用指令碼插入功能，將訪客頁面的背景顏色設為紅色：

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

參數

  • 詳細資料

    InjectDetails

    要執行的指令碼詳細資料。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (result?: any[]) => void

    • 結果

      any[] 選填

      每個插入影格中的指令碼結果。

find()

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

啟動頁面內搜尋要求。

參數

  • searchText

    字串

    要在網頁中尋找的字串。

  • 選項

    FindOptions 選填

    查詢要求的選項。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (results?: FindCallbackResults) => void

    • 結果

      FindCallbackResults 選用

      包含尋找要求的所有結果。如果 results 未在回呼函式主體中使用，則可省略該函式；舉例來說，如果回呼只用於判斷尋找要求何時完成，則可省略該函式。

forward()

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

盡可能前往下一個歷史記錄項目。等同於 go(1)。

參數

  • 回呼

    函式 選填

    Chrome 44 以上版本

    callback 參數如下所示： 

    (success: boolean) => void

    • 成功

      布林值

      指出導覽是否成功。

getAudioState()

Chrome 62 以上版本 
chrome.webviewTag.getAudioState(
  callback: function,
)

查詢音訊狀態。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (audible: boolean) => void

    • audible

      布林值

getProcessId()

chrome.webviewTag.getProcessId()

針對訪客網頁的目前程序，傳回 Chrome 內部程序 ID，讓嵌入者知道終止程序會影響多少訪客。只有在兩個訪客屬於同一個應用程式，且具有相同的儲存空間分割區 ID時，才會共用一個程序。這個呼叫是同步的，會傳回嵌入程式對目前程序 ID 的快取概念。程序 ID 與作業系統的程序 ID 不同。

傳回

  • 數字

getUserAgent()

chrome.webviewTag.getUserAgent()

傳回 webview 用於來賓頁面要求的使用者代理程式字串。

傳回

  • 字串

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

取得目前的縮放係數。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (zoomFactor: number) => void

    • zoomFactor

      數字

      目前的縮放係數。

getZoomMode()

Chrome 43 以上版本 
chrome.webviewTag.getZoomMode(
  callback: function,
)

取得目前的縮放模式。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      ZoomMode

      webview目前的縮放模式。

go()

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

使用相對於目前導覽的記錄索引，前往記錄項目。如果無法執行所要求的導覽，此方法就不會生效。

參數

  • relativeIndex

    數字

    webview 應前往的相對記錄索引。舉例來說，如果值為 2，系統會盡可能向前瀏覽 2 個歷史記錄項目；如果值為 -3，則會向後瀏覽 3 個項目。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (success: boolean) => void

    • 成功

      布林值

      指出導覽是否成功。

insertCSS()

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

將 CSS 插入訪客頁面。

參數

  • 詳細資料

    InjectDetails

    要插入的 CSS 詳細資料。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    () => void

isAudioMuted()

Chrome 62 以上版本 
chrome.webviewTag.isAudioMuted(
  callback: function,
)

查詢音訊是否設為靜音。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (muted: boolean) => void

    • 已設為靜音。

      布林值

isSpatialNavigationEnabled()

Chrome 71 以上版本 
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

查詢是否已為 WebView 啟用空間導覽功能。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (enabled: boolean) => void

    • 已啟用

      布林值

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

指出 webview 的使用者代理程式字串是否已遭到 webviewTag.setUserAgentOverride 覆寫。

loadDataWithBaseUrl()

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

載入資料網址，並使用指定的基準網址做為相對連結。您可以選擇提供虛擬網址，以便向使用者顯示，而非資料網址。

參數

  • dataUrl

    字串

    要載入的資料網址。

  • baseUrl

    字串

    用於相對連結的基本網址。

  • virtualUrl

    string 選填

    向使用者顯示的網址 (在網址列中)。

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

覆寫 webview 用於來賓頁面要求的使用者代理程式字串。覆寫會導致 User-Agent 用戶端提示標頭值和 navigator.userAgentData 傳回的值，對於套用此覆寫值的訪客頁面要求而言，會變成空白。

參數

  • userAgent

    字串

    要使用的使用者代理程式字串。

setZoom()

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

變更網頁的縮放係數。這項變更的範圍和持續時間取決於 WebView 目前的縮放模式 (請參閱 webviewTag.ZoomMode)。

參數

  • zoomFactor

    數字

    新的縮放比例。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    () => void

setZoomMode()

Chrome 43 以上版本 
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

設定 webview 的縮放模式。

參數

  • ZoomMode

    ZoomMode

    定義如何在 webview 中處理縮放功能。

  • 回呼

    函式 選填

    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 參數如下所示： 

    () => void

consolemessage

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

當訪客視窗記錄主控台訊息時觸發。

以下範例程式碼會將所有記錄訊息轉送至嵌入程式的控制台，不考慮記錄層級或其他屬性。

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

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (level: number, message: string, line: number, sourceId: string) => void

    • level

      數字

    • 訊息

      字串

    • 行

      數字

    • sourceId

      字串

contentload

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

在訪客視窗觸發 load 事件時觸發，例如載入新文件時。這不包括目前文件中的網頁導覽或非同步資源載入作業。

以下程式碼範例會在網頁載入後，修改訪客的 body 元素預設字型大小：

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

參數

  • 回呼

    函式

    callback 參數如下所示： 

    () => void

dialog

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

當訪客視窗嘗試透過 window.alert、window.confirm 或 window.prompt 開啟模態對話方塊時觸發。

處理此事件會阻斷訪客程序，直到每個事件監聽器傳回或 dialog 物件無法存取 (如果已呼叫 preventDefault()) 為止。

預設行為是取消對話方塊。

參數

  • 回呼

    函式

    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 參數如下所示： 

    (processID: number, reason: "normal" 
      | "abnormal" 
      | "crash" 
      | "kill" 
     ) => void

    • processID

      數字

    • reason

      "normal"
       | "abnormal"
       | "crash"
       | "kill"

findupdate

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

當有新的搜尋結果可供使用中搜尋要求使用時觸發。在找到相符項目後，單一查詢要求可能會多次執行。

參數

  • 回呼

    函式

    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 事件 (如有) 以來所有已確認的載入作業都已中止，也是如此。

注意：當 about 網址或 JavaScript 網址的載入作業中止時，系統會觸發 loadabort，然後將 webview 導向至 'about:blank'。

參數

  • 回呼

    函式

    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

    • 網址

      字串

    • isTopLevel

      布林值

    • 程式碼

      數字

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

loadcommit

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

在載入作業完成時觸發。這包括目前文件內的導覽，以及子框架文件層級的載入作業，但不包括非同步資源載入作業。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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

    • 網址

      字串

    • isTopLevel

      布林值

loadredirect

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

當頂層載入要求已重新導向至其他網址時觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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

    • oldUrl

      字串

    • newUrl

      字串

    • isTopLevel

      布林值

loadstart

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

在載入作業開始時觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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

    • 網址

      字串

    • isTopLevel

      布林值

loadstop

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

在訪客頁面 (包括所有子畫面) 的所有畫面層級載入作業完成時觸發。這包括目前文件內的導覽，以及子影格文件層級的載入作業，但不包括非同步資源載入作業。每當文件層級載入次數從一 (或更多) 變為零時，就會觸發此事件。舉例來說，如果網頁已完成載入 (也就是loadstop 已觸發一次) 會建立新的 iframe 來載入網頁，然後在 iframe 網頁載入完成時觸發第二個 loadstop。這種模式通常會出現在載入廣告的網頁上。

注意：當已提交的載入作業遭到中止時，loadabort 事件最終會接著 loadstop 事件發生，即使自上次 loadstop 事件 (如有) 以來已提交的所有載入作業都遭到中止也一樣。

參數

  • 回呼

    函式

    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 參數如下所示： 

    (window: NewWindow, targetUrl: string, initialWidth: number, initialHeight: number, name: string, windowOpenDisposition: "ignore" 
      | "save_to_disk" 
      | "current_tab" 
      | "new_background_tab" 
      | "new_foreground_tab" 
      | "new_window" 
      | "new_popup" 
     ) => void

    • 窗戶

      NewWindow

    • targetUrl

      字串

    • initialWidth

      數字

    • initialHeight

      數字

    • 名稱

      字串

    • windowOpenDisposition

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

permissionrequest

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

當訪客頁面需要向嵌入者要求特殊權限時觸發。

以下程式碼範例會授予訪客頁面對 webkitGetUserMedia API 的存取權。請注意，使用此範例程式碼的應用程式本身必須指定 audioCapture 和/或 videoCapture 資訊清單權限：

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

參數

  • 回呼

    函式

    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 參數如下所示： 

    (processID: number) => void

    • processID

      數字

sizechanged

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

當嵌入式網頁內容已透過 autosize 調整大小時觸發。只有在啟用 autosize 時才會觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (oldWidth: number, oldHeight: number, newWidth: number, newHeight: number) => void

    • oldWidth

      數字

    • oldHeight

      數字

    • newWidth

      數字

    • newHeight

      數字

unresponsive

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

當轉譯訪客網頁內容的程序沒有回應時觸發。如果訪客開始再次回應，系統會產生這項事件，並與相符的回應事件一起產生。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (processID: number) => void

    • processID

      數字

zoomchange

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

在頁面縮放變更時觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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

    • oldZoomFactor

      數字

    • newZoomFactor

      數字