chrome.webviewTag

说明

您可以使用 webview 标记通过网络主动加载来自网络的实时内容，并将其嵌入到您的 Chrome 应用中。您的应用可以控制 webview 的外观、与 Web 内容交互、在嵌入式网页中启动导航、对其中发生的错误事件作出响应，以及执行其他操作（请参阅用法）。

权限

webview

类型

ClearDataOptions

用于确定 clearData 应清除哪些数据的选项。

属性

  • 开始于

    数字可选

    清除此日期当天或之后累积的数据（以自纪元以来的毫秒数表示）（可通过 JavaScript Date 对象的 getTime 方法访问）。如果没有，则默认为 0（这会移除所有浏览数据）。

ClearDataTypeSet

一组数据类型。缺少的属性会解读为 false。

属性

  • appcache

    布尔值 选填

    网站的应用缓存。

  • 缓存

    布尔值 选填

    Chrome 44 及更高版本

    自 Chrome 43 起。 浏览器的缓存。注意：移除数据时，此操作会清除整个缓存；不仅限于您指定的范围。

  • Google Cloud 网站上的 Cookie，

    布尔值 选填

    分区的 Cookie。

  • fileSystems

    布尔值 选填

    网站的文件系统。

  • indexedDB

    布尔值 选填

    网站的 IndexedDB 数据。

  • localStorage

    布尔值 选填

    网站的本地存储数据。

  • persistentCookies

    布尔值 选填

    Chrome 58 及更高版本

    分区的永久性 Cookie。

  • sessionCookies

    布尔值 选填

    Chrome 58 及更高版本

    分区的会话 Cookie。

  • 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[] 可选

    在匹配项之后应用，以排除与此 glob 匹配的网址。用于模拟 @Exclude Greasemonkey 关键字。

  • exclude_matches

    string[] 可选

    不包括此内容脚本本应注入的网页。

  • include_globs

    string[] 可选

    在匹配项之后应用，以仅包含也与此 glob 匹配的网址。用于模拟 @include Greasemonkey 关键字。

  • js

    InjectionItems 可选

    要注入到匹配页面的 JavaScript 代码或 JavaScript 文件列表。这些依赖项会按其显示顺序进行注入。

  • match_about_blank

    布尔值 选填

    是否在 about:blank 和 about:srcdoc 上插入内容脚本。仅当网页的继承网址与匹配字段中声明的一种格式匹配时，才会在网页中注入内容脚本。沿用网址是创建框架或窗口的文档的网址。无法在沙盒化框架中插入内容脚本。

  • 匹配

    字符串[]

    指定要将此内容脚本注入哪些网页。

  • name

    string

    要注入的内容脚本的名称。

  • run_at

    RunAt 可选

    JavaScript 或 CSS 将尽快注入到标签页中。默认值为“document_idle”。

ContentWindow

访客窗口的消息句柄。

属性

  • postMessage

    void

    向嵌入的 Web 内容发布消息，前提是嵌入的内容显示的是来自目标源的页面。此方法可在页面加载完成后使用。监听 contentload 事件，然后调用该方法。

    访客可以通过在收到的消息事件上向 event.source 发布消息，向嵌入器发送回复。

    此 API 与 HTML5 postMessage API 完全相同，用于在网页之间进行通信。嵌入器可以通过向自己的帧添加 message 事件监听器来监听回复。

    postMessage 函数如下所示：

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

    • 消息

      任意

      要发送给邀请对象的消息对象。

    • targetOrigin

      string

      指定访客窗口的来源必须是要分派的事件。

ContextMenuCreateProperties

Chrome 44 及更高版本

属性

  • 已勾选

    布尔值 选填

    复选框或单选项的初始状态：true 表示已选中，false 表示未选中。在一组给定的单选项中，一次只能选择一个单选项。

  • 上下文

    [ContextType,...ContextType[]] 可选

    将出现此菜单项的上下文列表。如果未指定，则默认为 ['page']。

  • documentUrlPatterns

    string[] 可选

    可让您将项目限制为仅应用于网址与给定格式之一相匹配的文档。（这也适用于框架。）要详细了解模式的格式，请参阅匹配模式。

  • 已启用

    布尔值 选填

    此上下文菜单项处于启用还是停用状态。默认为 true。

  • id

    字符串（可选）

    要分配给此项的唯一 ID。必须为活动页面提供。不能与此附加信息的其他 ID 相同。

  • parentId

    字符串|数字，可选

    父菜单项的 ID；这会使该项成为先前添加的项的子项。

  • targetUrlPatterns

    string[] 可选

    与 documentUrlPatterns 类似，但允许您根据 img/audio/video 标记的 src 属性和锚点标记的 href 进行过滤。

  • title

    字符串（可选）

    要在项中显示的文本；除非 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

    事件<functionvoid>

    在此 webview 上显示上下文菜单之前触发。可用于通过调用 event.preventDefault() 停用此上下文菜单。

    onShow.addListener 函数如下所示：

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

    • callback

      功能

      callback 参数如下所示：

      (event: object)=>void

      • event

        对象

        • preventDefault

          void

          调用此方法可阻止显示上下文菜单。

          preventDefault 函数如下所示：

          ()=> {...}

  • 制作游戏

    void

    创建新的上下文菜单项。请注意，如果创建过程中发生错误，您可能要等到创建回调触发后才会发现（有关详情，请参阅 runtime.lastError）。

    create 函数如下所示：

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

    • createProperties

      对象

      用于创建项的属性

    • callback

      函数（可选）

      callback 参数如下所示：

      ()=>void

    • 返回

      string|number

      新创建的商品的 ID。

  • remove

    void

    移除上下文菜单项。

    remove 函数如下所示：

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

    • menuItemId

      string|number

      要移除的上下文菜单项的 ID。

    • callback

      函数（可选）

      callback 参数如下所示：

      ()=>void

  • removeAll

    void

    移除添加到此 webview 的所有上下文菜单项。

    removeAll 函数如下所示：

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

    • callback

      函数（可选）

      callback 参数如下所示：

      ()=>void

  • update

    void

    更新之前创建的上下文菜单项。

    update 函数如下所示：

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

    • id

      string|number

      要更新的商品的 ID。

    • updateProperties

      对象

      要更新的属性。接受与 create 函数相同的值。

    • callback

      函数（可选）

      callback 参数如下所示：

      ()=>void

ContextMenuUpdateProperties

Chrome 44 及更高版本

属性

  • 已勾选

    布尔值 选填

    复选框或单选项的状态：true 表示已选中，false 则表示未选中。在一组给定的单选项中，一次只能选择一个单选项。

  • 上下文

    [ContextType,...ContextType[]] 可选

    将出现此菜单项的上下文列表。

  • documentUrlPatterns

    string[] 可选

    可让您将项目限制为仅应用于网址与给定格式之一相匹配的文档。（这也适用于框架。）要详细了解模式的格式，请参阅匹配模式。

  • 已启用

    布尔值 选填

    此上下文菜单项处于启用还是停用状态。

  • parentId

    字符串|数字，可选

    父菜单项的 ID；这会使该项成为先前添加的项的子项。注意：您无法将某个项更改为它自己的某个后代的子级。

  • targetUrlPatterns

    string[] 可选

    与 documentUrlPatterns 类似，但允许您根据 img/audio/video 标记的 src 属性和锚点标记的 href 进行过滤。

  • title

    字符串（可选）

    要在列表项中显示的文本

  • 类型

    ItemType（可选）

    菜单项的类型。

  • onclick

    void 可选属性

    当用户点击菜单项时回调的函数。

    onclick 函数如下所示：

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

    • 资讯

      OnClickData

      所点击项的相关信息以及发生点击的上下文。

ContextType

Chrome 44 及更高版本

菜单可出现在哪些不同上下文中。指定“all”相当于指定所有其他上下文。

枚举

"selection"

"audio"

DialogController

附加到 dialog DOM 事件的接口。

属性

  • 取消

    void

    拒绝对话框。相当于点击 confirm 或 prompt 对话框中的“Cancel”。

    cancel 函数如下所示：

    ()=> {...}

  • 好的

    void

    接受对话框。相当于在 alert、confirm 或 prompt 对话框中点击“确定”。

    ok 函数如下所示：

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

    • 条回复

      字符串（可选）

      在接受 prompt 对话框时向访客提供的响应字符串。

DownloadPermissionRequest

随 download permissionrequest DOM 事件附带的 request 对象的类型。

属性

  • requestMethod

    string

    与下载请求相关联的 HTTP 请求类型（例如 GET）。

  • 网址

    string

    请求的下载网址。

  • allow

    void

    允许权限请求。

    allow 函数如下所示：

    ()=> {...}

  • deny

    void

    拒绝权限请求。这是未调用 allow 时的默认行为。

    deny 函数如下所示：

    ()=> {...}

FileSystemPermissionRequest

随 filesystem permissionrequest DOM 事件附带的 request 对象的类型。

属性

  • 网址

    string

    请求访问本地文件系统的帧的网址。

  • allow

    void

    允许权限请求。

    allow 函数如下所示：

    ()=> {...}

  • deny

    void

    拒绝权限请求。

    deny 函数如下所示：

    ()=> {...}

FindCallbackResults

包含查找请求的所有结果。

属性

  • activeMatchOrdinal

    number

    当前匹配的序数。

  • 已取消

    boolean

    指明此查找请求是否已取消。

  • numberOfMatches

    number

    searchText 在网页上的匹配次数。

  • selectionRect

    SelectionRect

    描述屏幕坐标中有效匹配项周围的矩形。

FindOptions

查找请求的选项。

属性

  • 后退

    布尔值 选填

    用于按倒序查找匹配项的标志。默认值为 false。

  • matchCase

    布尔值 选填

    用于匹配区分大小写的标志。默认值为 false。

FullscreenPermissionRequest

Chrome 43 及更高版本

随 fullscreen permissionrequest DOM 事件附带的 request 对象的类型。

属性

  • 发迹地

    string

    发起全屏请求的 webview 中的帧的来源。

  • allow

    void

    允许权限请求。

    allow 函数如下所示：

    ()=> {...}

  • deny

    void

    拒绝权限请求。

    deny 函数如下所示：

    ()=> {...}

GeolocationPermissionRequest

随 geolocation permissionrequest DOM 事件附带的 request 对象的类型。

属性

  • 网址

    string

    请求访问地理定位数据的帧的网址。

  • allow

    void

    允许权限请求。

    allow 函数如下所示：

    ()=> {...}

  • deny

    void

    拒绝权限请求。这是未调用 allow 时的默认行为。

    deny 函数如下所示：

    ()=> {...}

HidPermissionRequest

待处理

伴随 hid permissionrequest DOM 事件提供的 request 对象的类型。

属性

  • 网址

    string

    请求访问 HID API 的帧的网址。

  • allow

    void

    允许权限请求。

    allow 函数如下所示：

    ()=> {...}

  • deny

    void

    拒绝权限请求。这是未调用 allow 时的默认行为。

    deny 函数如下所示：

    ()=> {...}

InjectDetails

要注入的脚本或 CSS 的详细信息。必须设置代码或文件属性，但不能同时设置这两者。

属性

  • 验证码

    字符串（可选）

    要注入的 JavaScript 或 CSS 代码。

    警告：请谨慎使用 code 参数。如果使用不当，可能会导致您的应用遭受跨站脚本攻击。

  • 文件

    字符串（可选）

    要注入的 JavaScript 或 CSS 文件。

InjectionItems

Chrome 44 及更高版本

注入项的类型：代码或一组文件。

属性

  • 验证码

    字符串（可选）

    要注入到匹配页面的 JavaScript 代码或 CSS。

  • 文件

    string[] 可选

    要注入到匹配网页的 JavaScript 或 CSS 文件的列表。这些变量会按照它们在此数组中出现的顺序进行注入。

LoadPluginPermissionRequest

随 loadplugin permissionrequest DOM 事件附带的 request 对象的类型。

属性

  • identifier

    string

    插件的标识符字符串。

  • name

    string

    插件的显示名称。

  • allow

    void

    允许权限请求。这是未调用 deny 时的默认行为。

    allow 函数如下所示：

    ()=> {...}

  • deny

    void

    拒绝权限请求。

    deny 函数如下所示：

    ()=> {...}

MediaPermissionRequest

随 media permissionrequest DOM 事件附带的 request 对象的类型。

属性

  • 网址

    string

    请求访问用户媒体的帧的网址。

  • 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

    boolean

    请求帧是否为最新持有指针锁的客户端。

  • 网址

    string

    请求指针锁定的帧的网址。

  • userGesture

    boolean

    是否因用户输入手势而请求了指针锁定。

  • allow

    void

    允许权限请求。

    allow 函数如下所示：

    ()=> {...}

  • deny

    void

    拒绝权限请求。这是未调用 allow 时的默认行为。

    deny 函数如下所示：

    ()=> {...}

SelectionRect

用屏幕坐标描述矩形。

包含语义类似于数组；也就是说，坐标 (left, top) 被视为包含在该矩形内，但坐标 (left + width, top) 不包含。

属性

  • 高度

    number

    矩形的高度。

  • 剩余

    number

    从屏幕左边缘到矩形左边缘的距离。

  • 上

    number

    从屏幕顶部边缘到矩形顶部边缘的距离。

  • 宽度

    number

    矩形的宽度。

WebRequestEventInterface

Chrome 44 及更高版本

用于访问访客页面上的 webRequest 事件的接口。请参阅 chrome.webRequest 扩展程序 API，详细了解 webRequest 生命周期和相关概念。注意：WebView 不支持 chrome.webRequest.onActionIgnored 事件。

为说明用法与扩展程序 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 webRequest 的条件和操作应从对应的 chrome.webViewRequest.* 副本进行实例化。以下示例代码在 WebView 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 缩放更改会在导航时重置；在 WebView 中导航时，始终会加载页面及其每个原点的缩放比例（在分区范围内）。

"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)。

参数

  • 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

      一个数据网址，用于对捕获的标签页的可见区域的图片进行编码。可以分配给要显示的 HTML 图片元素的“src”属性。

clearData()

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

清除 webview 分区的浏览数据。

参数

  • 用于确定要清除哪些数据的选项。

  • 要清除的数据类型。

  • callback

    函数（可选）

    callback 参数如下所示：

    ()=>void

executeScript()

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

将 JavaScript 代码注入访客页面。

以下示例代码使用脚本注入将访客页面的背景颜色设为红色：

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

参数

  • 明细

    InjectDetails

    要运行的脚本的详细信息。

  • callback

    函数（可选）

    callback 参数如下所示：

    (result?: any[])=>void

    • 结果

      any[] 可选属性

      每个注入帧中的脚本结果。

find()

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

发起“在网页上查找”请求。

参数

  • searchText

    string

    要在网页中查找的字符串。

  • 选项

    FindOptions 可选

    查找请求的选项。

  • callback

    函数（可选）

    callback 参数如下所示：

    (results?: FindCallbackResults)=>void

    • 结果

      FindCallbackResults 可选

      包含查找请求的所有结果。如果回调函数正文中未使用 results，则可以将其省略；例如，该回调函数仅用于识别查找请求何时完成时。

forward()

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

如果可能，向前导航一个历史记录条目。等同于 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 内部进程 ID，以便嵌入者了解终止该进程会影响多少访客。两个访客必须属于同一应用且存储空间分区 ID 相同，才能共享进程。该调用是同步的，并返回嵌入器的已缓存当前进程 ID 概念。进程 ID 与操作系统的进程 ID 不同。

返回

  • number

getUserAgent()

chrome.webviewTag.getUserAgent()

返回 webview 对访客页面请求使用的用户代理字符串。

返回

  • string

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

获取当前缩放比例。

参数

  • callback

    功能

    callback 参数如下所示：

    (zoomFactor: number)=>void

    • zoomFactor

      number

      当前缩放比例。

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

    number

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

用于指示 webview 的用户代理字符串是否已被 webviewTag.setUserAgentOverride 替换。

loadDataWithBaseUrl()

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

加载具有用于相对链接的指定基准网址的数据网址。您还可以选择提供一个虚拟网址来向用户显示，而不是提供数据网址。

参数

  • dataUrl

    string

    要加载的数据网址。

  • baseUrl

    string

    将用于相对链接的基础网址。

  • virtualUrl

    字符串（可选）

    向用户显示的网址（在地址栏中）。

print()

chrome.webviewTag.print()

输出 webview 的内容。这相当于从 webview 本身调用脚本化的 print 函数。

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

替换 webview 针对访客页面请求使用的用户代理字符串。对于应用了此替换项的访客页面请求，进行替换会导致 User-Agent Client Hint 标头值和 navigator.userAgentData 返回的值为空。

参数

  • userAgent

    string

    要使用的用户代理字符串。

setZoom()

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

用于更改网页的缩放比例。此变更的范围和持久性取决于 WebView 的当前缩放模式（请参阅 webviewTag.ZoomMode）。

参数

  • zoomFactor

    number

    新的缩放比例。

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

结束当前的查找会话（清除所有突出显示内容），并取消所有正在进行的查找请求。

参数

  • action

     可选

    确定在查找会话结束后如何处理有效匹配项。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

    • level

      number

    • 消息

      string

    • line

      number

    • 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 打开模态对话框时触发。

处理此事件将阻止客机进程，直到每个事件监听器返回或无法访问 dialog 对象（如果调用了 preventDefault()）。

默认行为是取消对话框。

参数

  • callback

    功能

    callback 参数如下所示：

    (messageType: "alert" 
     |"confirm" 
     |"prompt" 
     ,messageText: string,dialog: DialogController)=>void

exit

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

在呈现访客 Web 内容的进程退出时触发。

以下示例代码会在每次访客页面崩溃时显示告别消息：

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

      number

    • 原因

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

findupdate

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

在有有效查找请求的新查找结果可用时触发。对于单个查找请求，可能会发生多次匹配的情况，因为系统找到了匹配项。

参数

  • callback

    功能

    callback 参数如下所示：

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

    • searchText

      string

    • numberOfMatches

      number

    • activeMatchOrdinal

      number

    • selectionRect

      SelectionRect

    • 已取消

      boolean

    • finalUpdate

      string

loadabort

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

当顶级加载被取消而不提交时触发。除非默认阻止该事件，否则控制台将输出一条错误消息。

注意：取消资源加载后，loadabort 事件最终将后跟 loadstop 事件，即使自上次 loadstop 事件（如有）以来提交的所有加载都已取消。

注意：当关于网址或 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

    • 网址

      string

    • isTopLevel

      boolean

    • 验证码

      number

    • 原因

      "ERR_ABORTED"
      |"ERR_INVALID_网址"
      |"ERR_DISALLOWED_网址_SCHEME"
      |"ERR_BLOCKED_BY_CLIENT"
      |"ERR_ADDRESS_UNREACHABLE"
      |"ERR_EMPERDER
      R |"
      R |"

loadcommit

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

发生加载事件时触发。这包括当前文档内的导航以及子框架文档级加载，但不包括异步资源加载。

参数

  • callback

    功能

    callback 参数如下所示：

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

    • 网址

      string

    • isTopLevel

      boolean

loadredirect

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

在顶级加载请求重定向到其他网址时触发。

参数

  • 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

    • 网址

      string

    • isTopLevel

      boolean

loadstop

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

在访客页面（包括其所有子框架）中的所有框架级加载都完成时触发。这包括当前文档内的导航以及子框架文档级加载，但不包括异步资源加载。每当文档级加载次数从一（或更多）变为零时，就会触发此事件。例如，如果某个网页已经加载完毕（即loadstop 已触发一次）会创建一个加载网页的新 iframe，然后在 iframe 网页加载完成时触发第二个 loadstop。加载广告的网页上通常可以看到此模式。

注意：取消提交的加载后，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

      number

    • initialHeight

      number

    • name

      string

    • windowOpenDisposition

permissionrequest

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

在访客页面需要向嵌入器请求特殊权限时触发。

以下示例代码将向访客页面授予对 webkitGetUserMedia API 的访问权限。请注意，使用此示例代码的应用本身必须指定 audioCapture 和/或 videoCapture 清单权限：

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

参数

  • callback

    功能

    callback 参数如下所示：

    (permission: "media" 
     |"geolocation" 
     |"pointerLock" 
     |"download" 
     |"loadplugin" 
     |"filesystem" 
     |"fullscreen" 
     |"hid" 
     ,request: object)=>void

    • 权限

      "media"
      |"geolocation"
      |"pointerLock"
      |"download"
      |"loadplugin"
      |"filesystem"
      |"fullscreen"
      |"hid"

    • request

      对象

responsive

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

当呈现访客 Web 内容的进程在无响应后再次响应时触发。

以下示例代码会在 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

      number

sizechanged

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

在通过 autosize 调整嵌入的 Web 内容的大小时触发。仅在 autosize 已启用时触发。

参数

  • callback

    功能

    callback 参数如下所示：

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

    • oldWidth

      number

    • oldHeight

      number

    • newWidth

      number

    • newHeight

      number

unresponsive

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

在呈现访客 Web 内容的进程无响应时触发。如果邀请对象开始再次回复，系统会生成一次此事件，并提供匹配的自适应事件。

参数

  • callback

    功能

    callback 参数如下所示：

    (processID: number)=>void

    • processID

      number

zoomchange

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

在网页的缩放比例发生变化时触发。

参数

  • callback

    功能

    callback 参数如下所示：

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

    • oldZoomFactor

      number

    • newZoomFactor

      number