Interfaces(其他)

说明:

  • 该组件首批接口从API version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

  • 示例效果请以真机运行为准,当前DevEco Studio预览器不支持。

WebMediaOptions10+

Web媒体策略的配置。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
resumeInterval number 被其他应用暂停的Web音视频能够自动续播的有效期,单位:秒。取值范围:[-2147483648, 2147483647]。resumeInterval值为0时,不自动续播;大于0时,将在该时间内尝试续播;小于0时,将在无限时间内尝试续播。由于近似值原因,该有效期可能存在一秒内的误差。
audioExclusive boolean 应用内多个Web实例的音频是否独占。
true表示应用内多个Web实例的音频独占,false表示应用内多个Web实例的音频不独占。

ScriptItem11+

通过javaScriptOnDocumentStart属性注入到Web组件的ScriptItem对象。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
script string 需要注入、执行的JavaScript脚本。
scriptRules Array<string> 一组允许来源的匹配规则。
1.如果需要允许所有来源的网址,使用通配符“ * ”。
2.如果需要精确匹配,则描述网站地址,如"https://www.example.com"。
3.如果模糊匹配网址,可以使用“ * ”通配符替代,如"https://*.example.com"。不允许使用"x. * .y.com"、" * foobar.com"等。
4.如果来源是ip地址,则使用规则2。
5.对于http/https以外的协议(自定义协议),不支持使用精确匹配和模糊匹配,且必须以"😕/"结尾,例如"resource://"。
6.一组scriptRule中,如果其中一条不满足以上规则,则整组scriptRule都不生效。

NestedScrollOptionsExt14+

通过NestedScrollOptionsExt可以设置上下左右四个方向的嵌套滚动规则。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
scrollUp NestedScrollMode 可滚动组件往上滚动时的嵌套滚动选项。
默认值:NestedScrollMode.SELF_FIRST。
scrollDown NestedScrollMode 可滚动组件往下滚动时的嵌套滚动选项。
默认值:NestedScrollMode.SELF_FIRST。
scrollLeft NestedScrollMode 可滚动组件往左滚动时的嵌套滚动选项。
默认值:NestedScrollMode.SELF_FIRST。
scrollRight NestedScrollMode 可滚动组件往右滚动时的嵌套滚动选项。
默认值:NestedScrollMode.SELF_FIRST。

NativeMediaPlayerConfig12+

用于开启应用接管网页媒体播放功能的配置信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
enable boolean 是否开启应用接管网页媒体播放功能。
true表示开启应用接管网页媒体播放功能,false表示关闭应用接管网页媒体播放功能。
默认值:false。
shouldOverlay boolean 开启应用接管网页媒体播放功能后,应用接管网页视频的播放器画面是否覆盖网页内容。
true表示改变视频图层的高度,使其覆盖网页内容。false表示不覆盖网页内容,跟原视频图层高度一样,嵌入在网页中。
默认值:false。

ExpandedMenuItemOptions12+

自定义菜单扩展项。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
content ResourceStr 显示内容。
startIcon ResourceStr 显示图标。
action (selectedText: {plainText: string}) => void 选中的文本信息。

AdsBlockedDetails12+

发生广告拦截时,广告资源信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 发生广告过滤的页面url。
adsBlocked Array<string> 被过滤的资源的url或dompath标识,被过滤的多个对象url相同则可能出现重复元素。

SelectionMenuOptionsExt13+

自定义菜单扩展项。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
onAppear Callback<void> 自定义选择菜单弹出时回调。
onDisappear Callback<void> 自定义选择菜单关闭时回调。
preview CustomBuilder 自定义选择菜单的预览内容样式,未配置时无预览内容。
menuType MenuType 自定义选择菜单类型。
默认值:MenuType.SELECTION_MENU
从API version 20起,MenuType.PREVIEW_MENU支持超链接预览。

EmbedOptions16+

Web同层渲染的配置。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
supportDefaultIntrinsicSize boolean 设置同层渲染元素是否支持固定大小 300 * 150。
当H5侧CSS设置了大小时,同层渲染元素大小为CSS大小,否则为固定大小。
为true时,固定大小为 300 * 150。
为false时,若H5侧CSS未设置大小,则同层渲染元素不渲染。
默认值:false
单位:px

OnAlertEvent12+

定义网页触发 alert() 告警时的回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 当前显示弹窗的网页的URL。
message string 显示在弹窗中的信息。
result JsResult 通知Web组件用户的操作结果。

OnBeforeUnloadEvent12+

定义刷新或关闭场景下,在即将离开当前页面时触发此回调。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 必填 说明
url string 当前显示弹窗所在网页的URL。
message string 弹窗中显示的信息。
result JsResult 通知Web组件用户操作行为。

OnConfirmEvent12+

定义网页触发 confirm() 弹窗时的回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 当前显示弹窗的网页的URL。
message string 显示在弹窗中的信息。
result JsResult 通知Web组件用户的操作结果。

OnPromptEvent12+

定义网页触发 prompt() 弹窗时的回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 当前显示弹窗的网页的URL。
message string 显示在弹窗中的信息。
value string 对话框默认返回的信息。
result JsResult 通知Web组件用户的操作结果。

OnConsoleEvent12+

定义通知宿主应用JavaScript console消息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
message ConsoleMessage 触发的控制台信息。

OnErrorReceiveEvent12+

定义网页加载遇到错误时触发该回调。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
request WebResourceRequest 网页请求的封装信息。
error WebResourceError 网页加载资源错误的封装信息 。

OnHttpErrorReceiveEvent12+

定义网页收到加载资源加载HTTP错误时触发。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
request WebResourceRequest 网页请求的封装信息。
response WebResourceResponse 资源响应的封装信息。

OnDownloadStartEvent12+

定义通知主应用开始下载一个文件。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 文件下载的URL。
userAgent string 用于下载的用户代理。
contentDisposition string 服务器返回的 Content-Disposition响应头,服务器可能返回空。
mimetype string 服务器返回内容媒体类型(MIME)信息。
contentLength number 服务器返回文件的长度。

OnRefreshAccessedHistoryEvent12+

定义网页刷新访问历史记录时触发。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 访问的url。
isRefreshed boolean true表示该页面是被重新加载的(调用refresh9+接口),false表示该页面是新加载的。

OnRenderExitedEvent12+

定义渲染过程退出时触发。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
renderExitReason RenderExitReason 渲染进程异常退出的具体原因。

OnShowFileSelectorEvent12+

定义文件选择器结果。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
result FileSelectorResult 用于通知Web组件文件选择的结果。
fileSelector FileSelectorParam 文件选择器的相关信息。

OnResourceLoadEvent12+

定义加载url时触发。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 所加载的资源文件url信息。

OnScaleChangeEvent12+

定义当前页面显示比例的变化时触发。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
oldScale number 变化前的显示比例百分比。
newScale number 变化后的显示比例百分比。

OnHttpAuthRequestEvent12+

定义通知收到http auth认证请求。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
handler HttpAuthHandler 通知Web组件用户操作行为。
host string HTTP身份验证凭据应用的主机。
realm string HTTP身份验证凭据应用的域。

OnInterceptRequestEvent12+

定义当Web组件加载url之前触发。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
request WebResourceRequest url请求的相关信息。

OnPermissionRequestEvent12+

定义通知收到获取权限请求。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
request PermissionRequest 通知Web组件用户操作行为。

OnScreenCaptureRequestEvent12+

定义通知收到屏幕捕获请求。

系统能力: SystemCapability.Web.Webview.Core

| 名称 | 类型 | 只读 | 可选 | 说明 | | -------------- | ---- | ---- | ---------------------------------------- | | handler | ScreenCaptureHandler | 否 | 否 | 通知Web组件用户操作行为。 |

OnContextMenuShowEvent12+

定义调用时触发的回调,以允许自定义显示上下文菜单。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
param WebContextMenuParam 菜单相关参数。
result WebContextMenuResult 菜单相应事件传入内核。

OnSearchResultReceiveEvent12+

定义通知调用方网页页内查找的结果。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
activeMatchOrdinal number 当前匹配的查找项的序号(从0开始)。
numberOfMatches number 所有匹配到的关键词的个数。
isDoneCounting boolean 当次页内查找操作是否结束。
true表示当次页内查找操作结束,false表示当次页内查找操作未结束。
该方法可能会回调多次,直到isDoneCounting为true为止。

OnScrollEvent12+

定义滚动条滑动到指定位置时触发。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
xOffset number 以网页最左端为基准,水平滚动条滚动所在位置。
单位:vp。
yOffset number 以网页最上端为基准,竖直滚动条滚动所在位置。
单位:vp。

OnSslErrorEventReceiveEvent12+

定义网页收到SSL错误时触发。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
handler SslErrorHandler 通知Web组件用户操作行为。
error SslError 错误码。
certChainData15+ Array<Uint8Array> 证书链数据。

SslErrorEvent12+

用户加载资源时发生SSL错误时触发的回调详情。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
handler SslErrorHandler 通知Web组件用户操作行为。
error SslError 错误码。
url string url地址。
originalUrl string 请求的原始url地址。
referrer string referrer url地址。
isFatalError boolean 是否是致命错误。
true表示致命错误,false表示非致命错误。
isMainFrame boolean 是否是主资源。
true表示主资源,false表示非主资源。

OnClientAuthenticationEvent12+

定义当需要用户提供SSL客户端证书时触发回调。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
handler ClientAuthenticationHandler 通知Web组件用户操作行为。
host string 请求证书服务器的主机名。
port number 请求证书服务器的端口号。
keyTypes Array<string> 可接受的非对称秘钥类型。
issuers Array<string> 与私钥匹配的证书可接受颁发者。

OnWindowNewEvent12+

定义网页要求用户创建窗口时触发的回调。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 必填 说明
isAlert boolean true代表请求创建对话框,false代表新标签页。
isUserTrigger boolean true代表用户触发,false代表非用户触发。
targetUrl string 目标url。
handler ControllerHandler 用于设置新建窗口的WebviewController实例。

OnTouchIconUrlReceivedEvent12+

定义设置接收到apple-touch-icon url地址时的回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 接收到的apple-touch-icon url地址。
precomposed boolean 对应apple-touch-icon是否为预合成。
true表示对应apple-touch-icon为预合成,false表示对应apple-touch-icon不是预合成。

OnFaviconReceivedEvent12+

定义应用为当前页面接收到新的favicon时的回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
favicon PixelMap 接收到的favicon图标的PixelMap对象。

OnPageVisibleEvent12+

定义旧页面不再呈现,新页面即将可见时触发的回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 必填 说明
url string 旧页面不再呈现,新页面即将可见时新页面的url地址。

OnDataResubmittedEvent12+

定义网页表单可以重新提交时触发的回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
handler DataResubmissionHandler 表单数据重新提交句柄。

OnAudioStateChangedEvent12+

定义网页上的音频播放状态发生改变时的回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
playing boolean 当前页面的音频播放状态,true表示正在播放,false表示未播放。

OnFirstContentfulPaintEvent12+

定义网页首次内容绘制回调函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
navigationStartTick number 启动页面加载开始的时间,单位以微秒表示。
firstContentfulPaintMs number 从启动页面加载开始到第一次绘制内容的时间,单位是以毫秒表示。

OnLoadInterceptEvent12+

定义截获资源加载时触发的回调。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
data WebResourceRequest url请求的相关信息。

OnOverScrollEvent12+

定义网页过度滚动时触发的回调。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
xOffset number 以网页最左端为基准,水平过度滚动的偏移量。
单位:vp。
yOffset number 以网页最上端为基准,竖直过度滚动的偏移量。
单位:vp。

JavaScriptProxy12+

定义要注入的JavaScript对象。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
object object 参与注册的对象。只能声明方法,不能声明属性。
name string 注册对象的名称,与window中调用的对象名一致。
methodList Array<string> 参与注册的应用侧JavaScript对象的同步方法。
controller WebController | WebviewController9+ 控制器。从API version 9开始,WebController不再维护,建议使用WebviewController替代。
asyncMethodList12+ Array<string> 参与注册的应用侧JavaScript对象的异步方法。异步方法无法获取返回值。
permission12+ string json字符串,默认为空,通过该字符串配置JSBridge的权限管控,可以定义object、method一级的url白名单。
示例请参考前端页面调用应用侧函数

OnPageEndEvent12+

定义网页加载结束时触发的函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 页面的URL地址。

OnPageBeginEvent12+

定义网页加载开始时触发的函数。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
url string 页面的URL地址。

OnProgressChangeEvent12+

定义网页加载进度变化时触发该回调。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
newProgress number 新的加载进度,取值范围为0到100的整数。

OnTitleReceiveEvent12+

定义网页document标题更改时触发该回调。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
title string document标题内容。
默认值:false

OnGeolocationShowEvent12+

定义通知用户收到地理位置信息获取请求。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
origin string 指定源的字符串索引。
geolocation JsGeolocation 通知Web组件用户操作行为。

NativeEmbedVisibilityInfo12+

提供同层标签的可见性信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
visibility boolean 可见性。
true表示可见,false表示不可见。
embedId string 同层渲染标签的唯一id。

RenderProcessNotRespondingData12+

提供渲染进程无响应的详细信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 必填 说明
jsStack string 网页的javaScript调用栈信息。
pid number 网页的进程id。
reason RenderProcessNotRespondingReason 触发渲染进程无响应回调的原因。

FullScreenEnterEvent12+

Web组件进入全屏回调事件的详情。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
handler FullScreenExitHandler 用于退出全屏模式的函数句柄。
videoWidth number 视频的宽度,单位:px。如果进入全屏的是 <video> 元素,表示其宽度;如果进入全屏的子元素中包含 <video> 元素,表示第一个子视频元素的宽度;其他情况下,为0。
videoHeight number 视频的高度,单位:px。如果进入全屏的是 <video> 元素,表示其高度;如果进入全屏的子元素中包含 <video> 元素,表示第一个子视频元素的高度;其他情况下,为0。

LoadCommittedDetails11+

提供已提交跳转的网页的详细信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
isMainFrame boolean 是否是主文档。
true表示是主文档,false表示不是主文档。
isSameDocument boolean 是否在不更改文档的情况下进行的网页跳转。
true表示在不更改文档的情况下进行的网页跳转,false表示在更改文档的情况下进行的网页跳转。
在同文档跳转的示例:1.参考片段跳转;2.pushState或replaceState触发的跳转;3.同一页面历史跳转。
didReplaceEntry boolean 是否提交的新节点替换了已有的节点。
true表示提交的新节点替换了已有的节点,false表示提交的新节点未替换已有的节点。
另外在一些子文档跳转的场景,虽然没有实际替换已有节点,但是有一些属性发生了变更。
navigationType WebNavigationType 网页跳转的类型。
url string 当前跳转网页的URL。

NativeEmbedInfo11+

提供同层标签的详细信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
id string 同层标签的id信息。
type string 同层标签的type信息,统一为小写字符。
src string 同层标签的src信息。
width number 同层标签的宽,单位为px。
height number 同层标签的高,单位为px。
url string 同层标签的url信息。
tag12+ string 标签名,统一为大写字符。
params12+ Map<string, string> object标签包含的param标签键值对列表,该map本质为Object类型,请使用Object提供的方法操作该对象,即embed.info?.param?.["name"]
position12+ Position 同层标签在屏幕坐标系中相对于Web组件的位置信息,此处区别于标准Position,单位为px。

IntelligentTrackingPreventionDetails12+

提供智能防跟踪拦截的详细信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
host string 网站域名。
trackerHost string 追踪者域名。

WebKeyboardCallbackInfo12+

拦截网页可编辑元素拉起软键盘的回调入参,其中包括WebKeyboardController、可编辑元素的属性。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 必填 说明
controller WebKeyboardController 提供控制自定义键盘的输入、删除、关闭等操作。
attributes Record<string, string> 触发本次软键盘弹出的网页元素属性。

WebKeyboardOptions12+

拦截网页可编辑元素拉起软键盘的回调返回值,可以指定使用的键盘类型,并返回给web内核,以控制拉起不同类型的软键盘;

系统能力: SystemCapability.Web.Webview.Core

名称 类型 必填 说明
useSystemKeyboard boolean 是否使用系统默认软键盘。
true表示使用系统默认软键盘,false表示不使用系统默认软键盘。
默认值:true。
enterKeyType number 指定系统软键盘enter键的类型,取值范围见输入框架的定义EnterKeyType,该参数为可选参数,当useSystemKeyboard为true,并且设置了有效的enterKeyType时候,才有效。
customKeyboard CustomBuilder 指定自定义键盘组件builder,可选参数,当useSystemKeyboard为false时,需要设置该参数,然后Web组件会拉起该自定义键盘。

FirstMeaningfulPaint12+

提供网页绘制页面主要内容的详细信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
navigationStartTime number 导航条加载时间,单位以微秒表示。
firstMeaningfulPaintTime number 绘制页面主要内容时间,单位以毫秒表示。

LargestContentfulPaint12+

提供网页绘制页面主要内容的详细信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
navigationStartTime number 导航条加载时间,单位以微秒表示。
largestImagePaintTime number 最大图片加载的时间,单位是以毫秒表示。
largestTextPaintTime number 最大文本加载时间,单位是以毫秒表示。
largestImageLoadStartTime number 最大图片开始加载时间,单位是以毫秒表示。
largestImageLoadEndTime number 最大图片结束记载时间,单位是以毫秒表示。
imageBPP number 最大图片像素位数。

NativeEmbedDataInfo11+

提供同层标签生命周期变化的详细信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
status NativeEmbedStatus 同层标签生命周期状态。
surfaceId string NativeImage的psurfaceid。
embedId string 同层标签的唯一id。
info NativeEmbedInfo 同层标签的详细信息。

NativeEmbedTouchInfo11+

提供手指触摸到同层标签的详细信息。

系统能力: SystemCapability.Web.Webview.Core

名称 类型 只读 可选 说明
embedId string 同层标签的唯一id。
touchEvent TouchEvent 手指触摸动作信息。
result12+ EventResult 通知Web组件手势事件的消费结果。