本页面是 Chrome 应用平台文档（已于 2020 年弃用）的一部分。至少在 2025 年 1 月之前，使用 ChromeOS 的企业版和教育版客户仍可使用该功能。详细了解如何迁移应用。

此页面由 Cloud Translation API 翻译。

chrome.webviewTag

说明

使用 webview 标记可通过网络主动从网络加载实时内容，并将其嵌入到 Chrome 应用中。您的应用可以控制 webview 的外观并与网页内容互动，在嵌入式网页中发起导航，对其中发生的错误事件做出反应，等等（请参阅使用）。

权限

webview

类型

ClearDataOptions

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

属性

开始于

number 可选

清除自相应日期（以自纪元以来的毫秒数表示，可通过 JavaScript Date 对象的 getTime 方法访问）起累积的数据。如果缺省，则默认为 0（这将移除所有浏览数据）。

ClearDataTypeSet

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

属性

appcache

布尔值（可选）

网站的应用缓存。
缓存

布尔值（可选）

Chrome 44 及更高版本

自 Chrome 43 起。浏览器的缓存。注意：移除数据时，系统会清除整个缓存，而不仅仅是您指定的范围。
饼干

布尔值（可选）

分区的 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 上插入内容脚本。仅当网页的继承网址与 matches 字段中声明的某个格式匹配时，才会将内容脚本注入到该网页中。继承网址是创建框架或窗口的文档的网址。内容脚本无法插入到沙盒框架中。
匹配

字符串[]

指定此内容脚本将注入到哪些网页中。
name

字符串

要注入的内容脚本的名称。
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
  
  字符串
  
  指定了在分派事件时，访客窗口的来源必须是什么。

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 来显示所选文本。例如，如果此参数的值为“将‘%s’翻译为 Pig Latin”，并且用户选择了“cool”一词，则所选内容的上下文菜单项为“将‘cool’翻译为 Pig Latin”。
类型

ItemType 可选

菜单项的类型。如果未指定，则默认为“normal”。
onclick

void （可选）

点击菜单项时将调用的函数。

onclick 函数如下所示：
```
(info: OnClickData) => {...}
```
- 信息
  
  OnClickData
  
  有关所点击商品以及点击发生时所处情境的信息。

ContextMenus

Chrome 44 及更高版本

属性

onShow

Event<functionvoidvoid>

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

onShow.addListener 函数如下所示：
```
(callback: function) => {...}
```
- callback
  
  函数
  
  callback 参数如下所示：
```
(event: object) => void
```
  - 事件
    
    对象
    
    preventDefault
    
    void
    
    调用此方法可防止显示上下文菜单。
    
    preventDefault 函数如下所示：
    () => {...}
create

void

创建新的上下文菜单项。请注意，如果在创建过程中发生错误，您可能要等到创建回调触发后才会发现（详细信息将位于 runtime.lastError 中）。

create 函数如下所示：
```
(createProperties: object, callback?: function) => {...}
```
- createProperties
  
  对象
  
  用于创建商品的属性
- callback
  
  函数可选
  
  callback 参数如下所示：
```
() => void
```
- 返回
  字符串 | 数字
  
  新创建的商品的 ID。
移除

void

移除上下文菜单项。

remove 函数如下所示：
```
(menuItemId: string | number, callback?: function) => {...}
```
- menuItemId
  
  字符串 | 数字
  
  要移除的上下文菜单项的 ID。
- callback
  
  函数可选
  
  callback 参数如下所示：
```
() => void
```
removeAll

void

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

removeAll 函数如下所示：
```
(callback?: function) => {...}
```
- callback
  
  函数可选
  
  callback 参数如下所示：
```
() => void
```
update

void

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

update 函数如下所示：
```
(id: string | number, updateProperties: object, callback?: function) => {...}
```
- id
  
  字符串 | 数字
  
  要更新的商品的 ID。
- updateProperties
  
  对象
  
  要更新的属性。接受与创建函数相同的值。
- 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"

"page"

"frame"

"selection"

"link"

"editable"

“图片”

"video"

"audio"

DialogController

附加到 dialog DOM 事件的接口。

属性

取消

void

拒绝对话框。相当于在 confirm 或 prompt 对话框中点击“取消”。

cancel 函数如下所示：
```
() => {...}
```
确定

void

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

ok 函数如下所示：
```
(response?: string) => {...}
```
- Response
  
  字符串可选
  
  接受 prompt 对话时要提供给嘉宾的响应字符串。

DialogMessageType

待处理

访客请求的模态对话框的类型。

枚举

"alert"

"confirm"

"prompt"

DownloadPermissionRequest

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

属性

requestMethod

字符串

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

字符串

所请求的下载网址。
allow

void

允许权限请求。

allow 函数如下所示：
```
() => {...}
```
deny

void

拒绝权限请求。如果未调用 allow，则这是默认行为。

deny 函数如下所示：
```
() => {...}
```

ExitReason

待处理

指示退出原因的字符串。

枚举

"normal"

"abnormal"

“崩溃”

"killed"

"oom killed"

"oom"

“无法启动”

"integrity failure"

FileSystemPermissionRequest

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

属性

网址

字符串

请求访问本地文件系统的框架的网址。
allow

void

允许权限请求。

allow 函数如下所示：
```
() => {...}
```
deny

void

拒绝权限请求。

deny 函数如下所示：
```
() => {...}
```

FindCallbackResults

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

属性

activeMatchOrdinal

数值

当前比赛的序号。
已取消

布尔值

指示相应查找请求是否已取消。
numberOfMatches

数值

searchText 在网页上匹配的次数。
selectionRect

SelectionRect

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

FindOptions

查找请求的选项。

属性

向后

布尔值（可选）

标志，用于按反向顺序查找匹配项。默认值为 false。
matchCase

布尔值（可选）

用于匹配时区分大小写的标志。默认值为 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 的详细信息。必须设置代码或文件属性，但不能同时设置这两者。

属性

代码

字符串可选

要注入的 JavaScript 或 CSS 代码。

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

字符串可选

要注入的 JavaScript 或 CSS 文件。

InjectionItems

Chrome 44 及更高版本

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

属性

代码

字符串可选

要注入到匹配网页中的 JavaScript 代码或 CSS。
文件

string[] 可选

要注入到匹配网页中的 JavaScript 或 CSS 文件列表。这些参数会按照它们在此数组中显示的顺序注入。

LoadAbortReason

待处理

字符串，用于指明发生了何种类型的中止。我们不保证此字符串在不同版本之间保持向后兼容。您不得解析并根据其内容采取行动。此外，在某些情况下，系统还可能会报告此处未列出的错误。

枚举

"ERR_ABORTED"

"ERR_INVALID_网址"

"ERR_DISALLOWED_URL_SCHEME"

"ERR_BLOCKED_BY_CLIENT"

"ERR_ADDRESS_UNREACHABLE"

"ERR_EMPTY_RESPONSE"

"ERR_FILE_NOT_FOUND"

"ERR_UNKNOWN_URL_SCHEME"

LoadPluginPermissionRequest

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

属性

标识符

字符串

插件的标识符字符串。
name

字符串

插件的显示名称。
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 函数如下所示：
```
() => {...}
```

PermissionType

待处理

所请求的权限类型。

枚举

“媒体”

"geolocation"

"pointerLock"

"download"

"loadplugin"

"filesystem"

"fullscreen"

“hid”

PointerLockPermissionRequest

伴随 pointerLock permissionrequest DOM 事件的 request 对象的类型。

属性

lastUnlockedBySelf

布尔值

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

字符串

请求指针锁定的框架的网址。
userGesture

布尔值

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

void

允许权限请求。

allow 函数如下所示：
```
() => {...}
```
deny

void

拒绝权限请求。如果未调用 allow，则这是默认行为。

deny 函数如下所示：
```
() => {...}
```

SelectionRect

描述屏幕坐标中的矩形。

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

属性

高度

数值

矩形的高度。
向左

数值

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

数值

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

数值

矩形的宽度。

StopFindingAction

待处理

确定在查找会话结束后如何处理有效匹配。clear 将清除对有效匹配项的突出显示；keep 将保持对有效匹配项的突出显示；activate 将保持对有效匹配项的突出显示，并模拟用户点击该匹配项的操作。默认操作为 keep。

枚举

"clear"

“保持”

“activate”

WebRequestEventInterface

Chrome 44 及更高版本

用于提供对 guest 网页上 webRequest 事件的访问权限的接口。如需详细了解 webRequest 生命周期和相关概念，请参阅 chrome.webRequest 扩展程序 API。注意：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]);

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

可用于将消息发布到访客页面的对象引用。

类型

ContentWindow

contextMenus

Chrome 44 及更高版本

类似于 Chrome 的 ContextMenus API，但适用于 webview 而不是浏览器。使用 webview.contextMenus API 将项添加到 webview 的上下文菜单。您可以选择上下文菜单添加项所适用的对象类型，例如图片、超链接和网页。

类型

ContextMenus

request

用于提供对 guest 网页上 webRequest 事件的访问权限的接口。

类型

WebRequestEventInterface

方法

addContentScripts()

Chrome 44 及更高版本

chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
): void

向 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 会执行正确的操作。

即使 guest 进程崩溃或被终止，甚至 webview 被重新父化，规则也会保留。

如需了解详情，请参阅内容脚本文档。

参数

contentScriptList

[ContentScriptDetails, ...ContentScriptDetails[]]

要添加的内容脚本的详细信息。

back()

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

如果可能，向后导航一个历史记录条目。等同于 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
  
  字符串
  
  一种数据网址，用于对所捕获标签页的可见区域的图片进行编码。可分配给 HTML 图片元素的“src”属性以进行显示。

clearData()

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

清除 webview 分区的浏览数据。

参数

选项

ClearDataOptions

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

ClearDataTypeSet

要清除的数据类型。
callback

函数可选

callback 参数如下所示：
```
() => void
```

executeScript()

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

将 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,
): void

发起网页内查找请求。

参数

searchText

字符串

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

FindOptions 可选

查找请求的选项。
callback

函数可选

callback 参数如下所示：
```
(results?: FindCallbackResults) => void
```
- 结果
  
  FindCallbackResults 可选
  
  包含查找请求的所有结果。如果回调函数正文中未使用 results，则可以省略该参数；例如，如果回调仅用于辨别查找请求何时完成。

forward()

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

尽可能向前导航一个历史记录条目。等同于 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 内部进程 ID，用于访客网页的当前进程，以便嵌入者了解终止进程会影响多少访客。只有当两个 guest 属于同一应用且具有相同的存储分区 ID 时，它们才会共享一个进程。该调用是同步的，并返回嵌入器缓存的当前进程 ID。此进程 ID 与操作系统的进程 ID 不同。

数值

getUserAgent()

chrome.webviewTag.getUserAgent(): string

返回 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
  
  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 注入到访客页面中。

参数

详细信息

InjectDetails

要插入的 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

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

loadDataWithBaseUrl()

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

加载数据网址，并使用指定的基准网址来处理相对链接。（可选）可以提供一个虚拟网址，以向用户显示，而不是显示数据网址。

参数

dataUrl

字符串

要加载的数据网址。
baseUrl

字符串

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

字符串可选

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

print()

chrome.webviewTag.print(): void

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

reload()

chrome.webviewTag.reload(): void

重新加载当前顶级网页。

removeContentScripts()

Chrome 44 及更高版本

chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
): void

从 webview 中移除内容脚本。

以下示例移除了之前添加的“myRule”。

webview.removeContentScripts(['myRule']);

您可以通过调用以下命令来移除所有规则：

webview.removeContentScripts();

参数

scriptNameList

string[] 可选

要移除的内容脚本的名称列表。如果列表为空，则添加到 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

替换 webview 用于访客网页请求的用户代理字符串。替换会导致 User-Agent 客户端提示标头值和 navigator.userAgentData 返回的值对于应用此替换的访客网页请求为空。

参数

userAgent

字符串

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

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

ZoomMode

定义了如何在 webview 中处理缩放。
callback

函数可选

callback 参数如下所示：
```
() => void
```

stop()

chrome.webviewTag.stop(): void

停止加载当前 webview 导航（如果正在加载）。

stopFinding()

chrome.webviewTag.stopFinding(
  action?: StopFindingAction,
): void

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

参数

action

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

level

数值
私信

字符串
line

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

处理此事件会阻塞 Guest 进程，直到每个事件监听器返回或 dialog 对象变得不可访问（如果调用了 preventDefault()）。

默认行为是取消对话框。

参数

callback

函数

callback 参数如下所示：
```
(messageType: DialogMessageType, messageText: string, dialog: DialogController) => void
```
- messageType
  
  DialogMessageType
- messageText
  
  字符串
- 对话框
  
  DialogController

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 参数如下所示：
```
(details: object) => void
```
- 详细信息
  
  对象
  - processID
    
    数值
    
    已退出的进程的 Chrome 内部 ID。
  - reason
    
    ExitReason
    
    指示退出原因的字符串。

findupdate

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

当有新的查找结果可用于有效查找请求时触发。在找到匹配项时，单个查找请求可能会多次发生这种情况。

参数

callback

函数

callback 参数如下所示：

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

searchText

字符串
numberOfMatches

数值
activeMatchOrdinal

数值
selectionRect

SelectionRect
已取消

布尔值
finalUpdate

字符串

loadabort

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

在顶级加载已中止但未提交时触发。除非阻止了默认事件，否则系统会将错误消息输出到控制台。

注意：当资源加载中止时，即使自上次 loadstop 事件以来所有已提交的加载（如果有）都被中止，loadabort 事件最终也会后跟 loadstop 事件。

注意：当 about 网址或 JavaScript 网址的加载被中止时，系统会触发 loadabort，然后 webview 会导航到“about:blank”。

参数

callback

函数

callback 参数如下所示：
```
(url: string, isTopLevel: boolean, code: number, reason: LoadAbortReason) => void
```
- 网址
  
  字符串
- isTopLevel
  
  布尔值
- 代码
  
  数值
- reason
  
  LoadAbortReason

loadcommit

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

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

参数

callback

函数

callback 参数如下所示：
```
(url: string, isTopLevel: boolean) => void
```
- 网址
  
  字符串
- isTopLevel
  
  布尔值

loadredirect

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

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

参数

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
```
- 网址
  
  字符串
- isTopLevel
  
  布尔值

loadstop

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

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

注意：当已提交的加载被中止时，即使自上次 loadstop 事件以来所有已提交的加载（如果有）都被中止，最终也会出现 loadstop 事件，随后出现 loadabort 事件。

参数

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

窗口

NewWindow
targetUrl

字符串
initialWidth

数值
initialHeight

数值
name

字符串
windowOpenDisposition

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: PermissionType, request: object) => void
```
- 权限
  
  PermissionType
- request
  
  对象

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

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

参数

callback

函数

callback 参数如下所示：

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

oldWidth

数值
oldHeight

数值
newWidth

数值
newHeight

数值

unresponsive

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

当渲染来宾 Web 内容的进程变得无响应时触发。如果嘉宾再次开始回答，系统将生成一次此事件，并附带匹配的响应事件。

参数

callback

函数

callback 参数如下所示：
```
(processID: number) => void
```
- processID
  
  数值

zoomchange

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

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

参数

callback

函数

callback 参数如下所示：
```
(oldZoomFactor: number, newZoomFactor: number) => void
```
- oldZoomFactor
  
  数值
- newZoomFactor
  
  数值

chrome.webviewTag 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

说明

权限

类型

ClearDataOptions

属性

ClearDataTypeSet

属性

ContentScriptDetails

属性

ContentWindow

属性

ContextMenuCreateProperties

属性

ContextMenus

属性

ContextMenuUpdateProperties

属性

ContextType

枚举

DialogController

属性

DialogMessageType

枚举

DownloadPermissionRequest

属性

ExitReason

枚举

FileSystemPermissionRequest

属性

FindCallbackResults

属性

FindOptions

属性

FullscreenPermissionRequest

属性

GeolocationPermissionRequest

属性

HidPermissionRequest

属性

InjectDetails

属性

InjectionItems

属性

LoadAbortReason

枚举

LoadPluginPermissionRequest

属性

MediaPermissionRequest

属性

NewWindow

属性

PermissionType

枚举

PointerLockPermissionRequest

属性

SelectionRect

属性

StopFindingAction

枚举

WebRequestEventInterface

WindowOpenDisposition

枚举

ZoomMode

枚举

属性

contentWindow

类型

contextMenus

类型

request

类型

方法

addContentScripts()

参数

back()

参数

canGoBack()

返回

canGoForward()

chrome.webviewTag