1# Types 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## WebviewController<sup>9+</sup> 16 17type WebviewController = WebviewController 18 19提供Web控制器的方法。 20 21**系统能力:** SystemCapability.Web.Webview.Core 22 23| 类型 | 说明 | 24| ------ | ---------- | 25| [WebviewController](./arkts-apis-webview-WebviewController.md) | 通过WebviewController可以控制Web组件各种行为。一个WebviewController对象只能控制一个Web组件,且必须在Web组件和WebviewController绑定后,才能调用WebviewController上的方法(静态方法除外)。 | 26 27## OnAdsBlockedCallback<sup>12+</sup> 28 29type OnAdsBlockedCallback = (details: AdsBlockedDetails) => void 30 31当页面发生广告过滤时触发此回调。 32 33**系统能力:** SystemCapability.Web.Webview.Core 34 35**参数:** 36 37| 参数名 | 类型 | 必填 | 说明 | 38| -------------------- | ----------------------------------------------- | ---- | -------------------------------- | 39| details | [AdsBlockedDetails](./arkts-basic-components-web-i.md#adsblockeddetails12) | 是 | 发生广告拦截时,广告资源信息。 | 40 41## OnSslErrorEventCallback<sup>12+</sup> 42 43type OnSslErrorEventCallback = (sslErrorEvent: SslErrorEvent) => void 44 45用户加载资源时发生SSL错误时触发的回调。 46 47**系统能力:** SystemCapability.Web.Webview.Core 48 49**参数:** 50 51| 参数名 | 类型 | 必填 | 说明 | 52| ------ | ------ | ---- | --------------------- | 53| sslErrorEvent | [SslErrorEvent](./arkts-basic-components-web-i.md#sslerrorevent12) | 是 | 用户加载资源时发生SSL错误时触发的回调详情。 | 54 55## OnContextMenuHideCallback<sup>11+</sup> 56 57type OnContextMenuHideCallback = () => void 58 59上下文菜单自定义隐藏的回调。 60 61**系统能力:** SystemCapability.Web.Webview.Core 62 63## OnRenderProcessNotRespondingCallback<sup>12+</sup> 64 65type OnRenderProcessNotRespondingCallback = (data : RenderProcessNotRespondingData) => void 66 67渲染进程无响应时触发的回调。 68 69**系统能力:** SystemCapability.Web.Webview.Core 70 71**参数:** 72 73| 参数名 | 类型 | 必填 | 说明 | 74| ------ | ------ | ---- | --------------------- | 75| data | [RenderProcessNotRespondingData](./arkts-basic-components-web-i.md#renderprocessnotrespondingdata12) | 是 | 渲染进程无响应的详细信息。 | 76 77## OnRenderProcessRespondingCallback<sup>12+</sup> 78 79type OnRenderProcessRespondingCallback = () => void 80 81渲染进程由无响应状态变回正常运行状态时触发该回调。 82 83**系统能力:** SystemCapability.Web.Webview.Core 84 85## OnViewportFitChangedCallback<sup>12+</sup> 86 87type OnViewportFitChangedCallback = (viewportFit: ViewportFit) => void 88 89网页meta中viewport-fit配置项更改时触发的回调。 90 91**系统能力:** SystemCapability.Web.Webview.Core 92 93**参数:** 94 95| 参数名 | 类型 | 必填 | 说明 | 96| ------ | ------ | ---- | --------------------- | 97| viewportFit | [ViewportFit](./arkts-basic-components-web-e.md#viewportfit12) | 是 | 网页meta中viewport-fit配置的视口类型。 | 98 99## OnNativeEmbedVisibilityChangeCallback<sup>12+</sup> 100 101type OnNativeEmbedVisibilityChangeCallback = (nativeEmbedVisibilityInfo: NativeEmbedVisibilityInfo) => void 102 103当同层标签可见性变化时触发该回调。 104 105**系统能力:** SystemCapability.Web.Webview.Core 106 107**参数:** 108 109| 参数名 | 类型 | 必填 | 说明 | 110| ------ | ------ | ---- | --------------------- | 111| nativeEmbedVisibilityInfo | [NativeEmbedVisibilityInfo](./arkts-basic-components-web-i.md#nativeembedvisibilityinfo12) | 是 | 提供同层标签的可见性信息。 | 112 113## OnFullScreenEnterCallback<sup>12+</sup> 114 115type OnFullScreenEnterCallback = (event: FullScreenEnterEvent) => void 116 117Web组件进入全屏时触发的回调。 118 119**系统能力:** SystemCapability.Web.Webview.Core 120 121**参数:** 122 123| 参数名 | 类型 | 必填 | 说明 | 124| ------ | ------ | ---- | --------------------- | 125| event | [FullScreenEnterEvent](./arkts-basic-components-web-i.md#fullscreenenterevent12) | 是 | Web组件进入全屏的回调事件详情。 | 126 127## OnFirstMeaningfulPaintCallback<sup>12+</sup> 128 129type OnFirstMeaningfulPaintCallback = (firstMeaningfulPaint: [FirstMeaningfulPaint](./arkts-basic-components-web-i.md#firstmeaningfulpaint12)) => void 130 131网页绘制页面度量信息的回调,当网页加载完页面主要内容时会触发该回调。 132 133**系统能力:** SystemCapability.Web.Webview.Core 134 135**参数:** 136 137| 参数名 | 类型 | 必填 | 说明 | 138| ------ | ------ | ---- | --------------------- | 139| firstMeaningfulPaint | [FirstMeaningfulPaint](./arkts-basic-components-web-i.md#firstmeaningfulpaint12) | 是 | 绘制页面主要内容度量的详细信息。 | 140 141## OnLargestContentfulPaintCallback<sup>12+</sup> 142 143type OnLargestContentfulPaintCallback = (largestContentfulPaint: [LargestContentfulPaint](./arkts-basic-components-web-i.md#largestcontentfulpaint12 144)) => void 145 146网页绘制页面最大内容度量信息的回调。 147 148**系统能力:** SystemCapability.Web.Webview.Core 149 150**参数:** 151 152| 参数名 | 类型 | 必填 | 说明 | 153| ------ | ------ | ---- | --------------------- | 154| largestContentfulPaint | [LargestContentfulPaint](./arkts-basic-components-web-i.md#largestcontentfulpaint12) | 是 | 网页绘制页面最大内容度量的详细信息。 | 155 156## OnNavigationEntryCommittedCallback<sup>11+</sup> 157 158type OnNavigationEntryCommittedCallback = (loadCommittedDetails: [LoadCommittedDetails](./arkts-basic-components-web-i.md#loadcommitteddetails11)) => void 159 160导航条目提交时触发的回调。 161 162**系统能力:** SystemCapability.Web.Webview.Core 163 164**参数:** 165 166| 参数名 | 类型 | 必填 | 说明 | 167| ------ | ------ | ---- | --------------------- | 168| loadCommittedDetails | [LoadCommittedDetails](./arkts-basic-components-web-i.md#loadcommitteddetails11) | 是 | 提供已提交跳转的网页的详细信息。 | 169 170## OnSafeBrowsingCheckResultCallback<sup>11+</sup> 171 172type OnSafeBrowsingCheckResultCallback = (threatType: ThreatType) => void 173 174网站安全风险检查触发的回调。 175 176**系统能力:** SystemCapability.Web.Webview.Core 177 178**参数:** 179 180| 参数名 | 类型 | 必填 | 说明 | 181| ------ | ------ | ---- | --------------------- | 182| threatType | [ThreatType](./arkts-basic-components-web-e.md#threattype11) | 是 | 定义网站threat类型。 | 183 184## OnIntelligentTrackingPreventionCallback<sup>12+</sup> 185 186type OnIntelligentTrackingPreventionCallback = (details: IntelligentTrackingPreventionDetails) => void 187 188当跟踪者cookie被拦截时触发的回调。 189 190**系统能力:** SystemCapability.Web.Webview.Core 191 192**参数:** 193 194| 参数名 | 类型 | 必填 | 说明 | 195| ------ | ------ | ---- | --------------------- | 196| details | [IntelligentTrackingPreventionDetails](./arkts-basic-components-web-i.md#intelligenttrackingpreventiondetails12) | 是 | 提供智能防跟踪拦截的详细信息。 | 197 198## OnOverrideUrlLoadingCallback<sup>12+</sup> 199 200type OnOverrideUrlLoadingCallback = (webResourceRequest: WebResourceRequest) => boolean 201 202onOverrideUrlLoading的回调。 203 204**系统能力:** SystemCapability.Web.Webview.Core 205 206**参数:** 207 208| 参数名 | 类型 | 必填 | 说明 | 209| ------------------ | ------- | ---- | ------------- | 210| webResourceRequest | [WebResourceRequest](./arkts-basic-components-web-WebResourceRequest.md) | 是 | url请求的相关信息。| 211 212**返回值:** 213 214| 类型 | 说明 | 215| ------- | ------------------------ | 216| boolean | 返回true表示阻止此次加载,否则允许此次加载。 | 217 218## WebKeyboardCallback<sup>12+</sup> 219 220type WebKeyboardCallback = (keyboardCallbackInfo: WebKeyboardCallbackInfo) => WebKeyboardOptions 221 222拦截网页可编辑元素拉起软键盘的回调,一般在点击网页input标签时触发。 223 224**系统能力:** SystemCapability.Web.Webview.Core 225 226**参数:** 227 228| 参数名 | 类型 | 必填 | 说明 | 229| ------------- | ------ | ---- | ------------------ | 230| keyboardCallbackInfo | [WebKeyboardCallbackInfo](./arkts-basic-components-web-i.md#webkeyboardcallbackinfo12) | 是 | 拦截网页拉起软键盘回调通知的入参,其中包括[WebKeyboardController](./arkts-basic-components-web-WebKeyboardController.md)、可编辑元素的属性。 | 231 232**返回值:** 233 234| 类型 | 说明 | 235| ------------------ | ------------------------------------------------------------ | 236| [WebKeyboardOptions](./arkts-basic-components-web-i.md#webkeyboardoptions12) | 回调函数通过返回[WebKeyboardOptions](./arkts-basic-components-web-i.md#webkeyboardoptions12)来决定ArkWeb内核拉起不同类型的软键盘。 | 237 238## OnOverrideErrorPageCallback<sup>20+</sup> 239 240type OnOverrideErrorPageCallback = (errorPageEvent: OnErrorReceiveEvent) => string 241 242onOverrideErrorPage的回调函数,网页加载失败时触发。 243 244**系统能力:** SystemCapability.Web.Webview.Core 245 246**参数:** 247 248| 参数名 | 类型 | 必填 | 说明 | 249| -------------- | ---- | ---- | ---------------------------------------- | 250| errorPageEvent | [OnErrorReceiveEvent](./arkts-basic-components-web-i.md#onerrorreceiveevent12) | 是 | 网页加载遇到错误时返回的相关信息。 | 251 252**返回值:** 253 254| 类型 | 说明 | 255| ------- | ------------------------ | 256| string | 返回以Base64编码的HTML文本内容。 | 257 258## MouseInfoCallback<sup>20+<sup> 259 260type MouseInfoCallback = (event: NativeEmbedMouseInfo) => void 261 262当鼠标/触摸板点击到同层标签时触发该回调。 263 264**系统能力:** SystemCapability.Web.Webview.Core 265 266**参数:** 267 268| 参数名 | 类型 | 必填 | 说明 | 269|--------|------|------|------| 270| event | [NativeEmbedMouseInfo](./arkts-basic-components-web-i.md#nativeembedmouseinfo20) | 是 | 提供鼠标/触摸板在同层标签上点击或长按的详细信息。 | 271 272**示例:** 273 274完整示例代码参考[onNativeEmbedMouseEvent](./arkts-basic-components-web-events.md#onnativeembedmouseevent20)。