1# Interfaces（其他） 2<!--Kit: ArkWeb--> 3<!--Subsystem: Web--> 4<!--Owner: @yp99ustc; @aohui; @zourongchun--> 5<!--Designer: @LongLie; @yaomingliu; @zhufenghao--> 6<!--Tester: @ghiker--> 7<!--Adviser: @HelloCrease--> 8 9> **说明：** 10> 11> - 该组件从API version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 12> 13> - 示例效果请以真机运行为准，当前DevEco Studio预览器不支持。 14 15## WebOptions 16 17通过[接口](./arkts-basic-components-web.md#接口)定义Web选项。 18 19**系统能力：** SystemCapability.Web.Webview.Core 20 21| 名称 | 类型 | 只读 | 可选 | 说明 | 22| ---------- | ------------------------------|---- | ---- | ---------------------------------------- | 23| src | string \| [Resource](../apis-arkui/arkui-ts/ts-types.md#resource) | 否 | 否 | 网页资源地址。如果访问本地资源文件，请使用$rawfile或者resource协议。如果加载应用包外沙箱路径的本地资源文件(文件支持html和txt类型)，请使用file://沙箱文件路径。<br>src不能通过状态变量（例如：@State）动态更改地址，如需更改，请通过[loadUrl()](./arkts-apis-webview-WebviewController.md#loadurl)重新加载。 | 24| controller | [WebController](./arkts-basic-components-web-WebController.md) \| [WebviewController<sup>9+</sup>](./arkts-basic-components-web-t.md#webviewcontroller9) | 否 | 否 | 控制器，通过controller可以控制Web组件各种行为（包括页面导航、声明周期状态、JavaScript交互等行为）。从API version 9开始，WebController不再维护，建议使用WebviewController替代。 | 25| renderMode<sup>12+</sup> | [RenderMode](./arkts-basic-components-web-e.md#rendermode12)| 否 | 是 | 表示当前Web组件的渲染方式，`RenderMode.ASYNC_RENDER`表示Web组件异步渲染，`RenderMode.SYNC_RENDER`表示支持Web组件同步渲染能力，默认值`RenderMode.ASYNC_RENDER`，该模式不支持动态调整。 | 26| incognitoMode<sup>11+</sup> | boolean | 否 | 是 | 表示当前创建的webview是否是隐私模式。true表示创建隐私模式的webview，false表示创建正常模式的webview。<br> 默认值：false。 | 27| sharedRenderProcessToken<sup>12+</sup> | string | 否 | 是 | 表示当前Web组件指定共享渲染进程的token，多渲染进程模式下，相同token的Web组件会优先尝试复用与token相绑定的渲染进程。token与渲染进程的绑定发生在渲染进程的初始化阶段。当渲染进程没有关联的Web组件时，其与token绑定关系将被移除。<br> 默认值： ""。 | 28 29## WebMediaOptions<sup>10+</sup> 30 31Web媒体策略的配置。 32 33**系统能力：** SystemCapability.Web.Webview.Core 34 35| 名称 | 类型 | 只读 | 可选 | 说明 | 36| -------------- | ------- | ---- | ---- | ---------------------------------------- | 37| resumeInterval | number | 否 | 是 | 被其他应用暂停的Web音视频能够自动续播的有效期，单位：秒。取值范围：[-2147483648, 2147483647]。resumeInterval值为0时，不自动续播；大于0时，将在该时间内尝试续播；小于0时，将在无限时间内尝试续播。由于近似值原因，该有效期可能存在一秒内的误差。 <br>**说明：** <br>HLS视频被打断后，回到前台将自动续播，不受该时间控制。| 38| audioExclusive | boolean | 否 | 是 | 应用内多个Web实例的音频是否独占。<br>true表示应用内多个Web实例的音频独占，false表示应用内多个Web实例的音频不独占。<br>默认值:true。 | 39| audioSessionType<sup>20+</sup> | [AudioSessionType](./arkts-basic-components-web-e.md#audiosessiontype20) | 否 | 是 | 应用中Web音频类型。默认值对应[系统音频流类型](../../reference/apis-audio-kit/arkts-apis-audio-e.md#streamusage)STREAM_USAGE_MUSIC。设置该参数会改变组件音频类型与系统音频类型映射关系，进而影响ArkWeb音频焦点策略。| 40 41## ScriptItem<sup>11+</sup> 42 43通过[javaScriptOnDocumentStart](./arkts-basic-components-web-attributes.md#javascriptondocumentstart11)属性注入到Web组件的ScriptItem对象。 44 45**系统能力：** SystemCapability.Web.Webview.Core 46 47| 名称 | 类型 | 只读 | 可选 | 说明 | 48| ----------- | -------------- | --- | ------|--------------- | 49| script | string | 否 | 否 | 需要注入、执行的JavaScript脚本。 | 50| scriptRules | Array\<string> | 否 | 否 | 一组允许来源的匹配规则。<br>1.如果需要允许所有来源的网址，使用通配符“ * ”。<br>2.如果需要精确匹配，则描述网站地址，如"https:\//www\.example.com"。<br>3.如果模糊匹配网址，可以使用“ * ”通配符替代，如"https://*.example.com"。不允许使用"x. * .y.com"、" * foobar.com"等。<br>4.如果来源是ip地址，则使用规则2。<br>5.对于http/https以外的协议(自定义协议)，不支持使用精确匹配和模糊匹配，且必须以`://`结尾，例如"resource://"。<br>6.一组scriptRule中，如果其中一条不满足以上规则，则整组scriptRule都不生效。 | 51 52## NestedScrollOptionsExt<sup>14+</sup> 53 54通过NestedScrollOptionsExt可以设置上下左右四个方向的嵌套滚动规则。 55 56**系统能力：** SystemCapability.Web.Webview.Core 57 58| 名称 | 类型 | 只读 | 可选 | 说明 | 59| -------------- | ---------------- | ---- | ---- | -------------------- | 60| scrollUp | [NestedScrollMode](../apis-arkui/arkui-ts/ts-appendix-enums.md#nestedscrollmode10) | 否 | 是 | 可滚动组件往上滚动时的嵌套滚动选项。<br/>默认值：NestedScrollMode.SELF_FIRST。| 61| scrollDown | [NestedScrollMode](../apis-arkui/arkui-ts/ts-appendix-enums.md#nestedscrollmode10) | 否 | 是 | 可滚动组件往下滚动时的嵌套滚动选项。<br/>默认值：NestedScrollMode.SELF_FIRST。| 62| scrollLeft | [NestedScrollMode](../apis-arkui/arkui-ts/ts-appendix-enums.md#nestedscrollmode10) | 否 | 是 | 可滚动组件往左滚动时的嵌套滚动选项。<br/>默认值：NestedScrollMode.SELF_FIRST。| 63| scrollRight | [NestedScrollMode](../apis-arkui/arkui-ts/ts-appendix-enums.md#nestedscrollmode10) | 否 | 是 | 可滚动组件往右滚动时的嵌套滚动选项。<br/>默认值：NestedScrollMode.SELF_FIRST。| 64 65## NativeMediaPlayerConfig<sup>12+</sup> 66 67用于[开启应用接管网页媒体播放功能](./arkts-basic-components-web-attributes.md#enablenativemediaplayer12)的配置信息。 68 69**系统能力：** SystemCapability.Web.Webview.Core 70 71| 名称 | 类型 | 只读 | 可选 | 说明 | 72|------|------|------|------|------| 73| enable | boolean | 否 | 否 | 是否开启应用接管网页媒体播放功能。<br/> true表示开启应用接管网页媒体播放功能，false表示关闭应用接管网页媒体播放功能。<br/> 默认值：false。 | 74| shouldOverlay | boolean | 否 | 否 | 开启应用接管网页媒体播放功能后，应用接管网页视频的播放器画面是否覆盖网页内容。<br/> true表示改变视频图层的高度，使其覆盖网页内容。false表示不覆盖网页内容，跟原视频图层高度一样，嵌入在网页中。<br>默认值：false。 | 75 76## ExpandedMenuItemOptions<sup>12+</sup> 77 78自定义菜单扩展项。 79 80**系统能力：** SystemCapability.Web.Webview.Core 81 82| 名称 | 类型 | 只读 | 可选 | 说明 | 83| ---------- | -----------------------------------------------------| ------ | ------ | ---------------- | 84| content | [ResourceStr](../apis-arkui/arkui-ts/ts-types.md#resourcestr) | 否 | 否 | 显示内容。 | 85| startIcon | [ResourceStr](../apis-arkui/arkui-ts/ts-types.md#resourcestr) | 否 | 是 | 显示图标。默认值为空，不显示图标。 | 86| action | (selectedText: {plainText: string}) => void | 否 | 否 | 选中的文本信息。| 87 88## AdsBlockedDetails<sup>12+</sup> 89 90发生广告拦截时，广告资源信息。 91 92**系统能力：** SystemCapability.Web.Webview.Core 93 94| 名称 | 类型 | 只读 | 可选 | 说明 | 95| ---------- | -----------------|---- | ----- | -------------------- | 96| url | string | 否 | 否 | 发生广告过滤的页面url。 | 97| adsBlocked | Array\<string\> | 否 | 否 | 被过滤的资源的url或dompath标识，被过滤的多个对象url相同则可能出现重复元素。 | 98 99## SelectionMenuOptionsExt<sup>13+</sup> 100 101自定义菜单扩展项。 102 103**系统能力：** SystemCapability.Web.Webview.Core 104 105| 名称 | 类型 | 只读 | 可选 | 说明 | 106| ---------- | -----------------------------------------------------| ------ | ------ | ---------------- | 107| onAppear | Callback\<void\> | 否 | 是 | 自定义选择菜单弹出时回调。 | 108| onDisappear | Callback\<void\> | 否 | 是 | 自定义选择菜单关闭时回调。 | 109| preview | [CustomBuilder](../apis-arkui/arkui-ts/ts-types.md#custombuilder8) | 否 | 是 | 自定义选择菜单的预览内容样式，未配置时无预览内容。| 110| menuType | [MenuType](../apis-arkui/arkui-ts/ts-text-common.md#menutype13枚举说明) | 否 | 是 | 自定义选择菜单类型。<br>默认值：`MenuType.SELECTION_MENU`。<br> 从API version 20起，`MenuType.PREVIEW_MENU`支持超链接预览。 | 111| previewMenuOptions<sup>20+</sup> | [PreviewMenuOptions](#previewmenuoptions20) | 否 | 是 | 自定义选择预览菜单选项。 | 112 113## PreviewMenuOptions<sup>20+</sup> 114 115预览菜单选项。 116 117**系统能力：** SystemCapability.Web.Webview.Core 118 119| 名称 | 类型 | 只读 | 可选 | 说明 | 120| ---------- | -----------------------------------------------------| ------ | ------ | ---------------- | 121| hapticFeedbackMode | [HapticFeedbackMode](../apis-arkui/arkui-ts/ts-universal-attributes-menu.md#hapticfeedbackmode18) | 否 | 是 | 菜单弹出时振动效果。需配置"ohos.permission.VIBRATE"权限<br/>默认值：HapticFeedbackMode.DISABLED，菜单弹出时不振动。 | 122 123## EmbedOptions<sup>16+</sup> 124 125Web同层渲染的配置。 126 127**系统能力：** SystemCapability.Web.Webview.Core 128 129| 名称 | 类型 | 只读 | 可选 | 说明 | 130| -------------- | ------- | ---- | ---- |---------------------------------------- | 131| supportDefaultIntrinsicSize | boolean | 否 | 是 | 设置同层渲染元素是否支持固定大小 300 * 150。<br>当H5侧CSS设置了大小时，同层渲染元素大小为CSS大小，否则为固定大小。<br>为true时，固定大小为 300 * 150。<br>为false时，若H5侧CSS未设置大小，则同层渲染元素不渲染。<br>默认值：false<br>单位：px | 132| supportCssDisplayChange<sup>20+</sup> | boolean | 否 | 是 | 设置同层渲染可见性接口是否支持显示属性。 <br>同层渲染可见性接口默认支持同层标签相对于视口的可见状态。 <br>设置为true时，支持显示CSS属性，包括visibility、display和宽高。 <br>设置为false时，不支持显示CSS属性，仅支持同层标签相对于视口的可见性。 | 133 134## OnAlertEvent<sup>12+</sup> 135 136定义网页触发 `alert()` 告警时的回调函数。 137 138**系统能力：** SystemCapability.Web.Webview.Core 139 140| 名称 | 类型 | 只读 | 可选 | 说明 | 141| ------- | ---------------------------------------------------- | ---- | ---- | --------------------------- | 142| url | string | 否 | 否 | 当前显示弹窗的网页的URL。 | 143| message | string | 否 | 否 | 显示在弹窗中的信息。 | 144| result | [JsResult](./arkts-basic-components-web-JsResult.md) | 否 | 否 | 通知Web组件用户的操作结果。 | 145 146## OnBeforeUnloadEvent<sup>12+</sup> 147 148定义刷新或关闭场景下，在即将离开当前页面时触发此回调。 149 150**系统能力：** SystemCapability.Web.Webview.Core 151 152| 名称 | 类型 | 只读| 可选 | 说明 | 153| --------------------- | -------- | -- | ----|--------------------------------- | 154| url | string | 否 | 否 | 当前显示弹窗所在网页的URL。 | 155| message | string | 否 | 否 | 弹窗中显示的信息。 | 156| result | [JsResult](./arkts-basic-components-web-JsResult.md) | 否 | 否 | 通知Web组件用户操作行为。 | 157| isReload<sup>20+</sup>| boolean | 否 | 是 | 页面是否刷新。<br>当页面因刷新即将离开时，isReload参数被设置为true；当页面因关闭即将离开时，isReload参数被设置为false。<br>默认值：false。| 158 159## OnConfirmEvent<sup>12+</sup> 160 161定义网页触发 `confirm()` 弹窗时的回调函数。 162 163**系统能力：** SystemCapability.Web.Webview.Core 164 165| 名称 | 类型 | 只读 | 可选 | 说明 | 166| ------- | ---------------------------------------------------- | ---- | ---- | --------------------------- | 167| url | string | 否 | 否 | 当前显示弹窗的网页的URL。 | 168| message | string | 否 | 否 | 显示在弹窗中的信息。 | 169| result | [JsResult](./arkts-basic-components-web-JsResult.md) | 否 | 否 | 通知Web组件用户的操作结果。 | 170 171## OnPromptEvent<sup>12+</sup> 172 173定义网页触发 `prompt()` 弹窗时的回调函数。 174 175**系统能力：** SystemCapability.Web.Webview.Core 176 177| 名称 | 类型 | 只读 | 可选 | 说明 | 178| ------- | ---------------------------------------------------- | ---- | ---- | --------------------------- | 179| url | string | 否 | 否 | 当前显示弹窗的网页的URL。 | 180| message | string | 否 | 否 | 显示在弹窗中的信息。 | 181| value | string | 否 | 否 | 对话框默认返回的信息。 | 182| result | [JsResult](./arkts-basic-components-web-JsResult.md) | 否 | 否 | 通知Web组件用户的操作结果。 | 183 184## OnConsoleEvent<sup>12+</sup> 185 186定义通知宿主应用JavaScript console消息。 187 188**系统能力：** SystemCapability.Web.Webview.Core 189 190| 名称 | 类型 | 只读 | 可选 | 说明 | 191| -------------- | ---- | ---- | ---------|------------------------------- | 192| message | [ConsoleMessage](./arkts-basic-components-web-ConsoleMessage.md) | 否 | 否 | 触发的控制台信息。 | 193 194## OnErrorReceiveEvent<sup>12+</sup> 195 196定义网页加载遇到错误时触发该回调。 197 198**系统能力：** SystemCapability.Web.Webview.Core 199 200| 名称 | 类型 | 只读 | 可选 | 说明 | 201| -------------- | ---- | ---- | ------|---------------------------------- | 202| request | [WebResourceRequest](./arkts-basic-components-web-WebResourceRequest.md) | 否 | 否 | 网页请求的封装信息。 | 203| error | [WebResourceError](./arkts-basic-components-web-WebResourceError.md) | 否 | 否 | 网页加载资源错误的封装信息 。 | 204 205## OnHttpErrorReceiveEvent<sup>12+</sup> 206 207定义网页收到加载资源加载HTTP错误时触发。 208 209**系统能力：** SystemCapability.Web.Webview.Core 210 211| 名称 | 类型 |只读 | 可选 | 说明 | 212| ---------- | --------------------------------------------------------------------------- | -- | ----|------------------- | 213| request | [WebResourceRequest](./arkts-basic-components-web-WebResourceRequest.md) | 否 | 否 | 网页请求的封装信息。 | 214| response | [WebResourceResponse](./arkts-basic-components-web-WebResourceResponse.md) | 否 | 否 | 资源响应的封装信息。 | 215 216## OnDownloadStartEvent<sup>12+</sup> 217 218定义通知主应用开始下载一个文件。 219 220**系统能力：** SystemCapability.Web.Webview.Core 221 222| 名称 | 类型 | 只读 | 可选 | 说明 | 223| ---------------- | -------- | --- | -----|----------------------------------- | 224| url | string | 否 | 否 | 文件下载的URL。 | 225| userAgent | string | 否 | 否 | 用于下载的用户代理。 | 226| contentDisposition | string | 否 | 否 | 服务器返回的 Content-Disposition响应头，服务器可能返回空。 | 227| mimetype | string | 否 | 否 | 服务器返回内容媒体类型（MIME）信息。 | 228| contentLength | number | 否 | 否 | 服务器返回文件的长度。 | 229 230## OnRefreshAccessedHistoryEvent<sup>12+</sup> 231 232定义导航完成时触发。 233 234**系统能力：** SystemCapability.Web.Webview.Core 235 236| 名称 | 类型 | 只读 | 可选 | 说明 | 237| -------------- | ---- | ---- | ------------|---------------------------- | 238| url | string | 否 | 否 | 访问的url。 | 239| isRefreshed | boolean | 否 | 否 | true表示该页面是被重新加载的（调用[refresh<sup>9+</sup>](./arkts-apis-webview-WebviewController.md#refresh)接口），false表示该页面是新加载的。 | 240 241## OnRenderExitedEvent<sup>12+</sup> 242 243定义渲染过程退出时触发。 244 245**系统能力：** SystemCapability.Web.Webview.Core 246 247| 名称 | 类型 | 只读 | 可选 | 说明 | 248| -------------- | ---- | ---- | ------------|---------------------------- | 249| renderExitReason | [RenderExitReason](./arkts-basic-components-web-e.md#renderexitreason9) | 否 | 否 | 渲染进程异常退出的具体原因。 | 250 251## OnShowFileSelectorEvent<sup>12+</sup> 252 253定义文件选择器结果。 254 255**系统能力：** SystemCapability.Web.Webview.Core 256 257| 名称 | 类型 | 只读 | 可选 | 说明 | 258| ------------ | ------------------------------------------------------------------------ | ---- | ---- | ------------------------------- | 259| result | [FileSelectorResult](./arkts-basic-components-web-FileSelectorResult.md) | 否 | 否 | 用于通知Web组件文件选择的结果。 | 260| fileSelector | [FileSelectorParam](./arkts-basic-components-web-FileSelectorParam.md) | 否 | 否 | 文件选择器的相关信息。 | 261 262## OnResourceLoadEvent<sup>12+</sup> 263 264定义加载url时触发。 265 266**系统能力：** SystemCapability.Web.Webview.Core 267 268| 名称 | 类型 | 只读 | 可选 | 说明 | 269| -------------- | ---- | ---- | ------------|---------------------------- | 270| url | string | 否 | 否 | 所加载的资源文件url信息。 | 271 272## OnScaleChangeEvent<sup>12+</sup> 273 274定义当前页面显示比例的变化时触发。 275 276**系统能力：** SystemCapability.Web.Webview.Core 277 278| 名称 | 类型 | 只读 | 可选 | 说明 | 279| -------- | ------ | ---- | ---- | ------------------------ | 280| oldScale | number | 否 | 否 | 变化前的显示比例百分比。 | 281| newScale | number | 否 | 否 | 变化后的显示比例百分比。 | 282 283## OnHttpAuthRequestEvent<sup>12+</sup> 284 285定义通知收到http auth认证请求。 286 287**系统能力：** SystemCapability.Web.Webview.Core 288 289| 名称 | 类型 | 只读 | 可选 | 说明 | 290| -------------- | ---- | ---- | -----------|----------------------------- | 291| handler | [HttpAuthHandler](./arkts-basic-components-web-HttpAuthHandler.md) | 否 | 否 | 通知Web组件用户操作行为。 | 292| host | string | 否 | 否 | HTTP身份验证凭据应用的主机。 | 293| realm | string | 否 | 否 | HTTP身份验证凭据应用的域。 | 294 295## OnInterceptRequestEvent<sup>12+</sup> 296 297定义当Web组件加载url之前触发。 298 299**系统能力：** SystemCapability.Web.Webview.Core 300 301| 名称 | 类型 | 只读 | 可选 | 说明 | 302| -------------- | ---- | ---- | ------------|---------------------------- | 303| request | [WebResourceRequest](./arkts-basic-components-web-WebResourceRequest.md) | 否 | 否 | url请求的相关信息。 | 304 305## OnPermissionRequestEvent<sup>12+</sup> 306 307定义通知收到获取权限请求。 308 309**系统能力：** SystemCapability.Web.Webview.Core 310 311| 名称 | 类型 | 只读 | 可选 | 说明 | 312| -------------- | ---- | ---- | ---- | ---------------------------------------- | 313| request | [PermissionRequest](./arkts-basic-components-web-PermissionRequest.md) | 否 | 否 | 通知Web组件用户操作行为。 | 314 315## OnScreenCaptureRequestEvent<sup>12+</sup> 316 317定义通知收到屏幕捕获请求。 318 319**系统能力：** SystemCapability.Web.Webview.Core 320 321| 名称 | 类型 | 只读 | 可选 | 说明 | 322| -------------- | ---- | ---- | ---- | ---------------------------------------- | 323| handler | [ScreenCaptureHandler](./arkts-basic-components-web-ScreenCaptureHandler.md) | 否 | 否 | 通知Web组件用户操作行为。 | 324 325## OnContextMenuShowEvent<sup>12+</sup> 326 327定义调用时触发的回调，以允许自定义显示上下文菜单。 328 329**系统能力：** SystemCapability.Web.Webview.Core 330 331| 名称 | 类型 | 只读 | 可选 | 说明 | 332| -------------- | ---- | ---- | ---- | ---------------------------------------- | 333| param | [WebContextMenuParam](./arkts-basic-components-web-WebContextMenuParam.md) | 否 | 否 | 菜单相关参数。 | 334| result | [WebContextMenuResult](./arkts-basic-components-web-WebContextMenuResult.md) | 否 | 否 | 菜单相应事件传入内核。 | 335 336## OnSearchResultReceiveEvent<sup>12+</sup> 337 338定义通知调用方网页页内查找的结果。 339 340**系统能力：** SystemCapability.Web.Webview.Core 341 342| 名称 | 类型 | 只读 | 可选 | 说明 | 343| ------------------ | ------- | --- | --- |----------------------------- | 344| activeMatchOrdinal | number | 否 | 否 | 当前匹配的查找项的序号（从0开始）。 | 345| numberOfMatches | number | 否 | 否 | 所有匹配到的关键词的个数。 | 346| isDoneCounting | boolean | 否 | 否 | 当次页内查找操作是否结束。<br>true表示当次页内查找操作结束，false表示当次页内查找操作未结束。<br>该方法可能会回调多次，直到isDoneCounting为true为止。 | 347 348## OnScrollEvent<sup>12+</sup> 349 350定义滚动条滑动到指定位置时触发。 351 352**系统能力：** SystemCapability.Web.Webview.Core 353 354| 名称 | 类型 | 只读 | 可选 | 说明 | 355| -------------- | ---- | ---- | ---- | ---------------------------------------- | 356| xOffset | number | 否 | 否 | 以网页最左端为基准，水平滚动条滚动所在位置。<br>单位：vp。 | 357| yOffset | number | 否 | 否 | 以网页最上端为基准，竖直滚动条滚动所在位置。<br>单位：vp。 | 358 359## OnSslErrorEventReceiveEvent<sup>12+</sup> 360 361定义网页收到SSL错误时触发。 362 363**系统能力：** SystemCapability.Web.Webview.Core 364 365| 名称 | 类型 | 只读 | 可选 | 说明 | 366| -------------- | ---- | ---- | ------------|---------------------------- | 367| handler | [SslErrorHandler](./arkts-basic-components-web-SslErrorHandler.md) | 否 | 否 | 通知Web组件用户操作行为。 | 368| error | [SslError](./arkts-basic-components-web-e.md#sslerror9) | 否 | 否 | 错误码。 | 369| certChainData<sup>15+</sup> | Array<Uint8Array\> | 否 | 是 | 证书链数据。 | 370 371## SslErrorEvent<sup>12+</sup> 372 373用户加载资源时发生SSL错误时触发的回调详情。 374 375**系统能力：** SystemCapability.Web.Webview.Core 376 377| 名称 | 类型 | 只读 | 可选 | 说明 | 378| ------- | ------------------------------------ | ---- | ------|------------- | 379| handler | [SslErrorHandler](./arkts-basic-components-web-SslErrorHandler.md) | 否 | 否 | 通知Web组件用户操作行为。 | 380| error | [SslError](./arkts-basic-components-web-e.md#sslerror9) | 否 | 否 | 错误码。 | 381| url | string | 否 | 否 | url地址。 | 382| originalUrl | string | 否 | 否 | 请求的原始url地址。 | 383| referrer | string | 否 | 否 | referrer url地址。 | 384| isFatalError | boolean | 否 | 否 | 是否是致命错误。<br>true表示致命错误，false表示非致命错误。 | 385| isMainFrame | boolean | 否 | 否 | 是否是主资源。<br>true表示主资源，false表示非主资源。 | 386| certChainData<sup>20+</sup> | Array<Uint8Array\> | 否 | 是 | 证书链数据。 | 387 388## OnClientAuthenticationEvent<sup>12+</sup> 389 390定义当需要用户提供SSL客户端证书时触发回调。 391 392**系统能力：** SystemCapability.Web.Webview.Core 393 394| 名称 | 类型 | 只读 | 可选 | 说明 | 395| -------------- | ---- | ---- | ------------|---------------------------- | 396| handler | [ClientAuthenticationHandler](./arkts-basic-components-web-ClientAuthenticationHandler.md) | 否 | 否 | 通知Web组件用户操作行为。 | 397| host | string | 否 | 否 | 请求证书服务器的主机名。 | 398| port | number | 否 | 否 | 请求证书服务器的端口号。 | 399| keyTypes | Array<string\> | 否 | 否 | 可接受的非对称秘钥类型。 | 400| issuers | Array<string\> | 否 | 否 | 与私钥匹配的证书可接受颁发者。 | 401 402## OnWindowNewEvent<sup>12+</sup> 403 404定义网页要求用户创建窗口时触发的回调。 405 406**系统能力：** SystemCapability.Web.Webview.Core 407 408| 名称 | 类型 | 只读 | 可选 | 说明 | 409| -------------- | ---- | ---- | ---- | ---------------------------------------- | 410| isAlert | boolean | 否 | 否 | true代表请求创建对话框，false代表新标签页。 | 411| isUserTrigger | boolean | 否 | 否 | true代表用户触发，false代表非用户触发。 | 412| targetUrl | string | 否 | 否 | 目标url。 | 413| handler | [ControllerHandler](./arkts-basic-components-web-ControllerHandler.md) | 否 | 否 | 用于设置新建窗口的WebviewController实例。 | 414 415## OnTouchIconUrlReceivedEvent<sup>12+</sup> 416 417定义设置接收到apple-touch-icon url地址时的回调函数。 418 419**系统能力：** SystemCapability.Web.Webview.Core 420 421| 名称 | 类型 | 只读 | 可选 | 说明 | 422| -------------- | ---- | ---- | ------------|---------------------------- | 423| url | string | 否 | 否 | 接收到的apple-touch-icon url地址。 | 424| precomposed | boolean | 否 | 否 | 对应apple-touch-icon是否为预合成。<br>true表示对应apple-touch-icon为预合成，false表示对应apple-touch-icon不是预合成。 | 425 426## OnFaviconReceivedEvent<sup>12+</sup> 427 428定义应用为当前页面接收到新的favicon时的回调函数。 429 430**系统能力：** SystemCapability.Web.Webview.Core 431 432| 名称 | 类型 | 只读 | 可选 | 说明 | 433| -------------- | ---- | ---- | ------------|---------------------------- | 434| favicon | [PixelMap](../apis-image-kit/arkts-apis-image-PixelMap.md) | 否 | 否 | 接收到的favicon图标的PixelMap对象。 | 435 436## OnPageVisibleEvent<sup>12+</sup> 437 438定义旧页面不再呈现，新页面即将可见时触发的回调函数。 439 440**系统能力：** SystemCapability.Web.Webview.Core 441 442| 名称 | 类型 | 只读 | 可选 | 说明 | 443| -------------- | ---- | ---- | ---- | ---------------------------------------- | 444| url | string | 否 | 否 | 旧页面不再呈现，新页面即将可见时新页面的url地址。 | 445 446## OnDataResubmittedEvent<sup>12+</sup> 447 448定义网页表单可以重新提交时触发的回调函数。 449 450**系统能力：** SystemCapability.Web.Webview.Core 451 452| 名称 | 类型 | 只读 | 可选 | 说明 | 453| -------------- | ---- | ---- | ------------|---------------------------- | 454| handler | [DataResubmissionHandler](./arkts-basic-components-web-DataResubmissionHandler.md) | 否 | 否 | 表单数据重新提交句柄。 | 455 456## OnAudioStateChangedEvent<sup>12+</sup> 457 458定义网页上的音频播放状态发生改变时的回调函数。 459 460**系统能力：** SystemCapability.Web.Webview.Core 461 462| 名称 | 类型 | 只读 | 可选 | 说明 | 463| -------------- | ---- | ---- | ---- | ---------------------------------------- | 464| playing | boolean | 否 | 否 | 当前页面的音频播放状态，true表示正在播放，false表示未播放。 | 465 466## OnFirstContentfulPaintEvent<sup>12+</sup> 467 468定义网页首次内容绘制回调函数。 469 470**系统能力：** SystemCapability.Web.Webview.Core 471 472| 名称 | 类型 | 只读 | 可选 | 说明 | 473| -------------- | ---- | ---- | ---- | ---------------------------------------- | 474| navigationStartTick | number | 否 | 否 | 启动页面加载开始的时间，单位以微秒表示。 | 475| firstContentfulPaintMs | number | 否 | 否 | 从启动页面加载开始到第一次绘制内容的时间，单位是以毫秒表示。 | 476 477## OnLoadInterceptEvent<sup>12+</sup> 478 479定义截获资源加载时触发的回调。 480 481**系统能力：** SystemCapability.Web.Webview.Core 482 483| 名称 | 类型 | 只读 | 可选 | 说明 | 484| -------------- | ---- | ---- | ------------|---------------------------- | 485| data | [WebResourceRequest](./arkts-basic-components-web-WebResourceRequest.md) | 否 | 否 | url请求的相关信息。 | 486 487## OnOverScrollEvent<sup>12+</sup> 488 489定义网页过度滚动时触发的回调。 490 491**系统能力：** SystemCapability.Web.Webview.Core 492 493| 名称 | 类型 | 只读 | 可选 | 说明 | 494| -------------- | ---- | ---- | ---- | ---------------------------------------- | 495| xOffset | number | 否 | 否 | 以网页最左端为基准，水平过度滚动的偏移量。<br>单位：vp。 | 496| yOffset | number | 否 | 否 | 以网页最上端为基准，竖直过度滚动的偏移量。<br>单位：vp。 | 497 498## JavaScriptProxy<sup>12+</sup> 499 500定义要注入的JavaScript对象。 501 502**系统能力：** SystemCapability.Web.Webview.Core 503 504| 名称 | 类型 | 只读 | 可选 | 说明 | 505| -------------- | ---- | ---- | ------------|---------------------------- | 506| object | object | 否 | 否 | 参与注册的对象。只能声明方法，不能声明属性。 | 507| name | string | 否 | 否 | 注册对象的名称，与window中调用的对象名一致。 | 508| methodList | Array\<string\> | 否 | 否 | 参与注册的应用侧JavaScript对象的同步方法。 | 509| controller | [WebController](./arkts-basic-components-web-WebController.md) \| [WebviewController<sup>9+</sup>](./arkts-apis-webview-WebviewController.md) | 否 | 否 | 控制器。从API version 9开始，WebController不再维护，建议使用WebviewController替代。 | 510| asyncMethodList<sup>12+</sup> | Array\<string\> | 否 | 是 | 参与注册的应用侧JavaScript对象的异步方法。异步方法无法获取返回值。 | 511| permission<sup>12+</sup> | string | 否 | 是 | json字符串，默认为空，通过该字符串配置JSBridge的权限管控，可以定义object、method一级的url白名单。<br>示例请参考[前端页面调用应用侧函数](../../web/web-in-page-app-function-invoking.md)。 | 512 513## OnPageEndEvent<sup>12+</sup> 514 515定义网页加载结束时触发的函数。 516 517**系统能力：** SystemCapability.Web.Webview.Core 518 519| 名称 | 类型 | 只读 | 可选 | 说明 | 520| -------------- | ---- | ---- | ------------|---------------------------- | 521| url | string | 否 | 否 | 页面的URL地址。 | 522 523## OnPageBeginEvent<sup>12+</sup> 524 525定义网页加载开始时触发的函数。 526 527**系统能力：** SystemCapability.Web.Webview.Core 528 529| 名称 | 类型 | 只读 | 可选 | 说明 | 530| -------------- | ---- | ---- | ------------|---------------------------- | 531| url | string | 否 | 否 | 页面的URL地址。 | 532 533## OnProgressChangeEvent<sup>12+</sup> 534 535定义网页加载进度变化时触发该回调。 536 537**系统能力：** SystemCapability.Web.Webview.Core 538 539| 名称 | 类型 | 只读 | 可选 | 说明 | 540| -------------- | ---- | ---- | ------------|---------------------------- | 541| newProgress | number | 否 | 否 | 新的加载进度，取值范围为0到100的整数。 | 542 543## OnTitleReceiveEvent<sup>12+</sup> 544 545定义网页document标题更改时触发该回调。 546 547**系统能力：** SystemCapability.Web.Webview.Core 548 549| 名称 | 类型 | 只读 | 可选 | 说明 | 550| -------------- | ---- | ---- | -------------|--------------------------- | 551| title | string | 否 | 否 | document标题内容。 | 552| isRealTitle<sup>20+</sup> | boolean | 否 | 是 | document标题来源，true表示来自网页的title标签，false表示该title是根据url自动生成。 <br>默认值：false | 553 554## OnGeolocationShowEvent<sup>12+</sup> 555 556定义通知用户收到地理位置信息获取请求。 557 558**系统能力：** SystemCapability.Web.Webview.Core 559 560| 名称 | 类型 | 只读 | 可选 | 说明 | 561| -------------- | ---- | ---- | -------------|--------------------------- | 562| origin | string | 否 | 否 | 指定源的字符串索引。 | 563| geolocation | [JsGeolocation](./arkts-basic-components-web-JsGeolocation.md) | 否 | 否 | 通知Web组件用户操作行为。 | 564 565## NativeEmbedVisibilityInfo<sup>12+</sup> 566 567提供同层标签的可见性信息。 568 569**系统能力：** SystemCapability.Web.Webview.Core 570 571| 名称 | 类型 | 只读 | 可选 | 说明 | 572| ------------- | ------------------------------------| ----- | ----- | ------------------ | 573| visibility | boolean | 否 | 否 | 可见性。<br>true表示可见，false表示不可见。 | 574| embedId | string | 否 | 否 | 同层渲染标签的唯一id。 | 575 576## RenderProcessNotRespondingData<sup>12+</sup> 577 578提供渲染进程无响应的详细信息。 579 580**系统能力：** SystemCapability.Web.Webview.Core 581 582| 名称 | 类型 | 只读 | 可选 | 说明 | 583| ------------------------ | ---- | ---- | ---- | -------------------------------------- | 584| jsStack | string | 否 | 否 | 网页的javaScript调用栈信息。 | 585| pid | number | 否 | 否 | 网页的进程id。 | 586| reason | [RenderProcessNotRespondingReason](./arkts-basic-components-web-e.md#renderprocessnotrespondingreason12) | 否 | 否 | 触发渲染进程无响应回调的原因。 | 587 588## FullScreenEnterEvent<sup>12+</sup> 589 590Web组件进入全屏回调事件的详情。 591 592**系统能力：** SystemCapability.Web.Webview.Core 593 594| 名称 | 类型 | 只读 | 可选 | 说明 | 595| ----------- | ------------------------------------ | ---- | ---- | --------------------- | 596| handler | [FullScreenExitHandler](./arkts-basic-components-web-FullScreenExitHandler.md) | 否 | 否 | 用于退出全屏模式的函数句柄。 | 597| videoWidth | number | 否 | 是 | 视频的宽度，单位：px。如果进入全屏的是 `<video>` 元素，表示其宽度；如果进入全屏的子元素中包含 `<video>` 元素，表示第一个子视频元素的宽度；其他情况下，为0。 | 598| videoHeight | number | 否 | 是 | 视频的高度，单位：px。如果进入全屏的是 `<video>` 元素，表示其高度；如果进入全屏的子元素中包含 `<video>` 元素，表示第一个子视频元素的高度；其他情况下，为0。 | 599 600## LoadCommittedDetails<sup>11+</sup> 601 602提供已提交跳转的网页的详细信息。 603 604**系统能力：** SystemCapability.Web.Webview.Core 605 606| 名称 | 类型 | 只读 | 可选 | 说明 | 607| ----------- | ------------------------------------ | ---- | -------|-------------- | 608| isMainFrame | boolean | 否 | 否 | 是否是主文档。<br>true表示是主文档，false表示不是主文档。 | 609| isSameDocument | boolean | 否 | 否 | 是否在不更改文档的情况下进行的网页跳转。<br>true表示在不更改文档的情况下进行的网页跳转，false表示在更改文档的情况下进行的网页跳转。<br>在同文档跳转的示例：1.参考片段跳转；2.pushState或replaceState触发的跳转；3.同一页面历史跳转。 | 610| didReplaceEntry | boolean | 否 | 否 | 是否提交的新节点替换了已有的节点。<br>true表示提交的新节点替换了已有的节点，false表示提交的新节点未替换已有的节点。<br>另外在一些子文档跳转的场景，虽然没有实际替换已有节点，但是有一些属性发生了变更。 | 611| navigationType | [WebNavigationType](./arkts-basic-components-web-e.md#webnavigationtype11) | 否 | 否 | 网页跳转的类型。 | 612| url | string | 否 | 否 | 当前跳转网页的URL。 | 613 614## NativeEmbedInfo<sup>11+</sup> 615 616提供同层标签的详细信息。 617 618**系统能力：** SystemCapability.Web.Webview.Core 619 620| 名称 | 类型 | 只读 | 可选 | 说明 | 621|-------------------| ------------------------------------ | ---- | ---- |---------------------------| 622| id | string | 否 | 是 | 同层标签的id信息。 | 623| type | string | 否 | 是 | 同层标签的type信息，统一为小写字符。 | 624| src | string | 否 | 是 | 同层标签的src信息。 | 625| width | number | 否 | 是 | 同层标签的宽，单位为px。 | 626| height | number | 否 | 是 | 同层标签的高，单位为px。 | 627| url | string | 否 | 是 | 同层标签的url信息。 | 628| tag<sup>12+</sup> | string | 否 | 是 | 标签名，统一为大写字符。 | 629| params<sup>12+</sup> | Map<string, string> | 否 | 是 | object标签包含的param标签键值对列表，该map本质为Object类型，请使用Object提供的方法操作该对象，即`embed.info?.param?.["name"]`。 | 630| position<sup>12+</sup> | Position | 否 | 是 | 同层标签在屏幕坐标系中相对于Web组件的位置信息，此处区别于标准Position，单位为px。 | 631 632## IntelligentTrackingPreventionDetails<sup>12+</sup> 633 634提供智能防跟踪拦截的详细信息。 635 636**系统能力：** SystemCapability.Web.Webview.Core 637 638| 名称 | 类型 | 只读 | 可选 | 说明 | 639| ------------- | ------------------------------------| ---- | ---- |------- | 640| host | string | 否 | 否 | 网站域名。 | 641| trackerHost | string | 否 | 否 | 追踪者域名。 | 642 643## WebKeyboardCallbackInfo<sup>12+</sup> 644 645拦截网页可编辑元素拉起软键盘的回调入参，其中包括[WebKeyboardController](./arkts-basic-components-web-WebKeyboardController.md)、可编辑元素的属性。 646 647**系统能力：** SystemCapability.Web.Webview.Core 648 649| 名称 | 类型 | 只读 | 可选 | 说明 | 650| -------------- | ---- | ---- | ---- | ---------------------------------------- | 651| controller | [WebKeyboardController](./arkts-basic-components-web-WebKeyboardController.md) | 否 | 否 | 提供控制自定义键盘的输入、删除、关闭等操作。 | 652| attributes | Record<string, string> | 否 | 否 | 触发本次软键盘弹出的网页元素属性。 653 654## WebKeyboardOptions<sup>12+</sup> 655 656拦截网页可编辑元素拉起软键盘的回调返回值，可以指定使用的键盘类型，并返回给web内核，以控制拉起不同类型的软键盘； 657 658**系统能力：** SystemCapability.Web.Webview.Core 659 660| 名称 | 类型 | 只读 | 可选 | 说明 | 661| -------------- | ---- | ---- | ---- | ---------------------------------------- | 662| useSystemKeyboard | boolean | 否 | 否 | 是否使用系统默认软键盘。<br>true表示使用系统默认软键盘，false表示不使用系统默认软键盘。<br>默认值：true。 | 663| enterKeyType | number | 否 | 是 | 指定系统软键盘enter键的类型，取值范围见输入框架的定义[EnterKeyType](../apis-ime-kit/js-apis-inputmethod.md#enterkeytype10)，该参数为可选参数，默认值为UNSPECIFIED。当useSystemKeyboard为true，并且设置了有效的enterKeyType时候，才有效。| 664| customKeyboard | [CustomBuilder](../apis-arkui/arkui-ts/ts-types.md#custombuilder8) | 否 | 是 | 指定自定义键盘组件builder，可选参数，当useSystemKeyboard为false时，需要设置该参数，然后Web组件会拉起该自定义键盘。 665 666 667## FirstMeaningfulPaint<sup>12+</sup> 668 669提供网页绘制页面主要内容的详细信息。 670 671**系统能力：** SystemCapability.Web.Webview.Core 672 673| 名称 | 类型 | 只读 | 可选 | 说明 | 674| ------------------------ | ------ | ---- | ---- | -------------------------------------- | 675| navigationStartTime | number | 否 | 是 | 导航条加载时间，单位以微秒表示。 | 676| firstMeaningfulPaintTime | number | 否 | 是 | 绘制页面主要内容时间，单位以毫秒表示。 | 677 678## LargestContentfulPaint<sup>12+</sup> 679 680提供网页绘制页面主要内容的详细信息。 681 682**系统能力：** SystemCapability.Web.Webview.Core 683 684| 名称 | 类型 | 只读 | 可选 | 说明 | 685| ------------------------- | ------ | ---- | ---- | ---------------------------------------- | 686| navigationStartTime | number | 否 | 是 | 导航条加载时间，单位以微秒表示。 | 687| largestImagePaintTime | number | 否 | 是 | 最大图片加载的时间，单位是以毫秒表示。 | 688| largestTextPaintTime | number | 否 | 是 | 最大文本加载时间，单位是以毫秒表示。 | 689| largestImageLoadStartTime | number | 否 | 是 | 最大图片开始加载时间，单位是以毫秒表示。 | 690| largestImageLoadEndTime | number | 否 | 是 | 最大图片结束记载时间，单位是以毫秒表示。 | 691| imageBPP | number | 否 | 是 | 最大图片像素位数。 | 692 693## NativeEmbedDataInfo<sup>11+</sup> 694 695提供同层标签生命周期变化的详细信息。 696 697**系统能力：** SystemCapability.Web.Webview.Core 698 699| 名称 | 类型 | 只读 | 可选 | 说明 | 700| ----------- | ------------------------------------ | ---- | ---- | --------------------- | 701| status | [NativeEmbedStatus](./arkts-basic-components-web-e.md#nativeembedstatus11) | 否 | 是 | 同层标签生命周期状态。 | 702| surfaceId | string | 否 | 是 | NativeImage的psurfaceid。 | 703| embedId | string | 否 | 是 | 同层标签的唯一id。 | 704| info | [NativeEmbedInfo](./arkts-basic-components-web-i.md#nativeembedinfo11) | 否 | 是 | 同层标签的详细信息。 | 705 706## NativeEmbedTouchInfo<sup>11+</sup> 707 708提供手指触摸到同层标签的详细信息。 709 710**系统能力：** SystemCapability.Web.Webview.Core 711 712| 名称 | 类型 | 只读 | 可选 | 说明 | 713| ----------- | ------------------------------------ | ---- | ---- | --------------------- | 714| embedId | string | 否 | 是 | 同层标签的唯一id。 | 715| touchEvent | [TouchEvent](../apis-arkui/arkui-ts/ts-universal-events-touch.md#touchevent对象说明) | 否 | 是 | 手指触摸动作信息。 | 716| result<sup>12+</sup> | [EventResult](./arkts-basic-components-web-EventResult.md) | 否 | 是 | 通知Web组件手势事件的消费结果。 | 717 718## NativeEmbedMouseInfo<sup>20+</sup> 719 720提供鼠标/触摸板在同层标签上点击或长按的详细信息。 721 722**系统能力：** SystemCapability.Web.Webview.Core 723 724| 名称 | 类型 | 只读 | 可选 | 说明 | 725| ----------- | ------------------------------------ | ---- | ---- | --------------------- | 726| embedId | string | 否 | 是 | 同层标签的唯一id。 | 727| mouseEvent | [MouseEvent](../apis-arkui/arkui-ts/ts-universal-mouse-key.md#mouseevent对象说明) | 否 | 是 | 鼠标/触摸板点击/长按信息。 | 728| result | [EventResult](./arkts-basic-components-web-EventResult.md) | 否 | 是 | 通知Web组件鼠标事件的消费结果。 | 729 730## OnLoadStartedEvent<sup>20+</sup> 731 732定义网页加载开始时触发的函数。 733 734**系统能力：** SystemCapability.Web.Webview.Core 735 736| 名称 | 类型 | 只读 | 可选 | 说明 | 737| -------------- | ---- | ---- | ------------|---------------------------- | 738| url | string | 否 | 否 | 页面的URL地址。 | 739 740## OnLoadFinishedEvent<sup>20+</sup> 741 742定义网页加载结束时触发的函数。 743 744**系统能力：** SystemCapability.Web.Webview.Core 745 746| 名称 | 类型 | 只读 | 可选 | 说明 | 747| -------------- | ---- | ---- | ------------|---------------------------- | 748| url | string | 否 | 否 | 页面的URL地址。 | 749 750## OnPdfLoadEvent<sup>20+</sup> 751 752定义PDF加载成功或失败时触发的函数。 753 754**系统能力：** SystemCapability.Web.Webview.Core 755 756| 名称 | 类型 | 只读 | 可选 | 说明 | 757| -------------- | ---- | ---- | ---- | ---------------------------------------- | 758| url | string | 否 | 否 | 页面的URL地址。 | 759| result | [PdfLoadResult](./arkts-basic-components-web-e.md#pdfloadresult20) | 否 | 否 | PDF页面加载结果。 | 760 761## OnPdfScrollEvent<sup>20+</sup> 762 763定义PDF页面滚动到底时触发的函数。 764 765**系统能力：** SystemCapability.Web.Webview.Core 766 767| 名称 | 类型 | 只读 | 可选 | 说明 | 768| -------------- | ---- | ---- | ---- | ---------------------------------------- | 769| url | string | 否 | 否 | 页面的URL地址。 | 770 771## Header 772 773Web组件返回的请求/响应头对象。 774 775**系统能力：** SystemCapability.Web.Webview.Core 776 777| 名称 | 类型 | 只读 | 可选 | 说明 | 778| ----------- | ------ | --- | -----|---------------- | 779| headerKey | string | 否 | 否 | 请求/响应头的key。 | 780| headerValue | string | 否 | 否 | 请求/响应头的value。 | 781 782## ScreenCaptureConfig<sup>10+</sup> 783 784Web屏幕捕获的配置。 785 786**系统能力：** SystemCapability.Web.Webview.Core 787 788| 名称 | 类型 | 只读 | 可选 | 说明 | 789| ----------- | --------------------------------------- | ---- |----| ---------- | 790| captureMode | [WebCaptureMode](./arkts-basic-components-web-e.md#webcapturemode10) | 否 | 否 | Web屏幕捕获模式。 | 791