• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Enums
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 9开始支持,后续版本的新增接口,则采用上角标单独标记接口的起始版本。
12
13## WebHitTestType
14
15[getLastHitTest](./arkts-apis-webview-WebviewController.md#getlasthittest18)接口用于指示游标节点。
16
17**系统能力:** SystemCapability.Web.Webview.Core
18
19| 名称          | 值 | 说明                                      |
20| ------------- | -- |----------------------------------------- |
21| EditText      | 0 |可编辑的区域。                            |
22| Email         | 1 |电子邮件地址。                            |
23| HttpAnchor    | 2 |超链接,其中src为http。                     |
24| HttpAnchorImg | 3 |带有超链接的图片,其中src为http + HTML::img。 |
25| Img           | 4 |HTML::img标签。                           |
26| Map           | 5 |地理地址。                                |
27| Phone         | 6 |电话号码。                                |
28| Unknown       | 7 |未知内容。                                |
29
30## SecureDnsMode<sup>10+</sup>
31
32Web组件使用HTTPDNS的模式。
33
34**系统能力:** SystemCapability.Web.Webview.Core
35
36| 名称          | 值 | 说明                                      |
37| ------------- | -- |----------------------------------------- |
38| OFF                                  | 0 |不使用HTTPDNS, 可以用于撤销之前使用的HTTPDNS配置。|
39| AUTO                                 | 1 |自动模式,用于解析的设定DNS服务器不可用时,可自动回落至系统DNS。|
40| SECURE_ONLY                          | 2 |强制使用设定的HTTPDNS服务器进行域名解析。|
41
42## SecurityLevel<sup>11+</sup>
43
44当前网页的安全级别。
45
46**系统能力:** SystemCapability.Web.Webview.Core
47
48| 名称          | 值 | 说明                                      |
49| ------------- | -- |----------------------------------------- |
50| NONE          | 0 |页面既不绝对安全,也不是不安全,即是中立。例如,部分scheme非http/https的URL。|
51| SECURE        | 1 |页面安全,页面使用的是HTTPS协议,且使用了信任的证书。|
52| WARNING       | 2 |页面不安全。例如,使用HTTP协议或使用HTTPS协议但使用旧版TLS版本。|
53| DANGEROUS     | 3 |页面不安全。尝试HTTPS并失败、页面未通过身份验证、页面上包含不安全活动内容的HTTPS、恶意软件、网络钓鱼或任何其他可能危险的严重安全问题。 |
54
55## MediaPlaybackState<sup>12+</sup>
56
57当前网页的播控状态。
58
59**系统能力:** SystemCapability.Web.Webview.Core
60
61| 名称    | 值   | 说明               |
62| ------- | ---- | ------------------ |
63| NONE    | 0    | 页面无音视频启播。 |
64| PLAYING | 1    | 页面音视频播放中。 |
65| PAUSED  | 2    | 页面音视频暂停。   |
66| STOPPED | 3    | 页面音视频停止。   |
67
68## PressureLevel<sup>14+</sup>
69
70内存压力等级。在应用主动清理Web组件占用的缓存时,Web内核会根据内存压力等级,进行缓存释放。
71
72**系统能力:** SystemCapability.Web.Webview.Core
73
74| 名称 | 值 | 说明 |
75| ------------------------------- | - | ---------- |
76| MEMORY_PRESSURE_LEVEL_MODERATE | 1 | 中等内存压力等级。这个等级下,Web内核会尝试释放重新分配开销较小且不需要立即使用的缓存。 |
77| MEMORY_PRESSURE_LEVEL_CRITICAL | 2 | 严重内存压力等级。这个等级下,Web内核会尝试释放所有可能的内存缓存。 |
78
79## WebMessageType<sup>10+</sup>
80
81[webMessagePort](./arkts-apis-webview-WebMessagePort.md)接口所支持的数据类型。
82
83**系统能力:** SystemCapability.Web.Webview.Core
84
85| 名称         | 值 | 说明                            |
86| ------------ | -- |------------------------------- |
87| NOT_SUPPORT  | 0 |不支持的数据类型。|
88| STRING       | 1 |字符串类型。|
89| NUMBER       | 2 |数值类型。|
90| BOOLEAN      | 3 |布尔类型。|
91| ARRAY_BUFFER | 4 |原始二进制数据缓冲区。|
92| ARRAY        | 5 |数组类型。|
93| ERROR        | 6 |错误类型。|
94
95## JsMessageType<sup>10+</sup>
96
97[runJavaScriptExt](./arkts-apis-webview-WebviewController.md#runjavascriptext10)接口脚本执行后返回的结果的类型。
98
99**系统能力:** SystemCapability.Web.Webview.Core
100
101| 名称         | 值 | 说明                              |
102| ------------ | -- |--------------------------------- |
103| NOT_SUPPORT  | 0 |不支持的数据类型。|
104| STRING       | 1 |字符串类型。|
105| NUMBER       | 2 |数值类型。|
106| BOOLEAN      | 3 |布尔类型。|
107| ARRAY_BUFFER | 4 |原始二进制数据缓冲区。|
108| ARRAY        | 5 |数组类型|
109
110## RenderProcessMode<sup>12+</sup>
111
112ArkWeb渲染子进程模式类型。
113
114**系统能力:** SystemCapability.Web.Webview.Core
115
116| 名称          | 值 | 说明                                      |
117| ------------- | -- |----------------------------------------- |
118| SINGLE        | 0 |ArkWeb单渲染子进程模式。该模式下,多个Web复用一个渲染子进程。|
119| MULTIPLE      | 1 |ArkWeb多渲染子进程模式。该模式下,每个Web一个渲染子进程。|
120
121## OfflineResourceType<sup>12+</sup>
122
123[OfflineResourceMap](./arkts-apis-webview-i.md#offlineresourcemap12)对象对应的本地离线资源的接口类型。
124
125**系统能力:** SystemCapability.Web.Webview.Core
126
127| 名称         | 值 | 说明                              |
128| ------------ | -- |--------------------------------- |
129| IMAGE  | 0 | 图片类型的资源。 |
130| CSS       | 1 | CSS类型的资源。|
131| CLASSIC_JS       | 2 | 通过<script src="" /\>标签加载的Javascript资源。|
132| MODULE_JS      | 3 |通过<script src="" type="module" /\>标签加载的Javascript资源。|
133
134## ScrollType<sup>12+</sup>
135
136Scroll滚动类型,用于[setScrollable](./arkts-apis-webview-WebviewController.md#setscrollable12)。
137
138**系统能力:** SystemCapability.Web.Webview.Core
139
140| 名称         | 值 | 说明                              |
141| ------------ | -- |--------------------------------- |
142| EVENT  | 0 | 滚动事件,表示通过触摸屏,触摸板,鼠标滚轮生成的网页滚动。|
143
144## WebDownloadState<sup>11+</sup>
145
146下载任务的状态。
147
148**系统能力:** SystemCapability.Web.Webview.Core
149
150| 名称          | 值 | 说明                                      |
151| ------------- | -- |----------------------------------------- |
152| IN_PROGRESS                                  | 0 |下载任务正在进行中。|
153| COMPLETED                                 | 1 |下载任务已经完成。|
154| CANCELED                          | 2 |下载任务已经被取消。|
155| INTERRUPTED                          | 3 |下载任务被中断。|
156| PENDING                          | 4 |下载任务等待开始。|
157| PAUSED                          | 5 |下载任务已经被暂停。|
158| UNKNOWN                          | 6 |下载任务未知状态。|
159
160## WebDownloadErrorCode<sup>11+</sup>
161
162下载任务的错误码。
163
164**系统能力:** SystemCapability.Web.Webview.Core
165
166| 名称          | 值 | 说明                                      |
167| ------------- | -- |----------------------------------------- |
168| ERROR_UNKNOWN                                  | 0 |未知的错误。|
169| FILE_FAILED | 1 |  常规文件操作失败。|
170| FILE_ACCESS_DENIED | 2 | 没有权限访问文件。|
171| FILE_NO_SPACE | 3 | 磁盘没有足够的空间。|
172| FILE_NAME_TOO_LONG | 5 | 文件名字过长。|
173| FILE_TOO_LARGE | 6 | 文件太大。|
174| FILE_TRANSIENT_ERROR | 10 |  出现了一些临时问题,例如内存不足、文件正在使用以及同时打开的文件过多。|
175| FILE_BLOCKED | 11 |  由于某些本地策略,文件被阻止访问。|
176| FILE_TOO_SHORT | 13 |  当尝试恢复下载时,发现文件不够长,可能该文件已不存在。|
177| FILE_HASH_MISMATCH | 14 |  哈希不匹配。|
178| FILE_SAME_AS_SOURCE | 15 |  文件已存在。|
179| NETWORK_FAILED | 20 |  一般网络错误。|
180| NETWORK_TIMEOUT | 21 | 网络超时。|
181| NETWORK_DISCONNECTED | 22 | 网络断开连接。|
182| NETWORK_SERVER_DOWN | 23 |  服务器关闭。|
183| NETWORK_INVALID_REQUEST | 24 |  无效的网络请求,可能重定向到不支持的方案或无效的URL。|
184| SERVER_FAILED | 30 | 服务器返回了一个一般性错误。|
185| SERVER_NO_RANGE | 31 |  服务器不支持范围请求。|
186| SERVER_BAD_CONTENT | 33 |   服务器没有请求的数据。|
187| SERVER_UNAUTHORIZED | 34 |  服务器不允许下载该文件。|
188| SERVER_CERT_PROBLEM | 35 |  服务器证书错误。|
189| SERVER_FORBIDDEN | 36 |  服务器访问被禁止。|
190| SERVER_UNREACHABLE | 37 |  无法访问服务器。|
191| SERVER_CONTENT_LENGTH_MISMATCH | 38 |  接收到的数据与内容长度不匹配。|
192| SERVER_CROSS_ORIGIN_REDIRECT | 39 | 发生意外的跨站重定向。|
193| USER_CANCELED | 40 | 用户取消了下载。|
194| USER_SHUTDOWN | 41 | 用户关闭了应用。|
195| CRASH | 50 | 应用发生了崩溃。|
196
197## WebResourceType<sup>12+</sup>
198
199资源请求的资源类型。
200
201**系统能力:** SystemCapability.Web.Webview.Core
202
203| 名称         | 值 | 说明                              |
204| ------------ | -- |--------------------------------- |
205| MAIN_FRAME | 0 | 顶层页面。 |
206| SUB_FRAME | 1 | Frame或Iframe。 |
207| STYLE_SHEET | 2 | CSS样式表。 |
208| SCRIPT | 3 | 外部脚本。 |
209| IMAGE | 4 | 图片(jpg/gif/png/以及其他)。 |
210| FONT_RESOURCE | 5 | 字体。 |
211| SUB_RESOURCE | 6 | 其他子资源。如果实际类型未知,则是默认类型。 |
212| OBJECT | 7 | 插件的Object(或embed)标签,或者插件请求的资源。 |
213| MEDIA | 8 | 媒体资源。 |
214| WORKER | 9 | 专用工作线程的主资源。 |
215| SHARED_WORKER | 10 | 共享工作线程的主资源。 |
216| PREFETCH | 11 | 明确的预取请求。 |
217| FAVICON | 12 | 网站图标。 |
218| XHR | 13 | XMLHttpRequest。 |
219| PING | 14 | <a ping\>/sendBeacon的Ping请求。 |
220| SERVICE_WORKER | 15 | service worker的主资源。 |
221| CSP_REPORT | 16 | 内容安全策略违规报告。 |
222| PLUGIN_RESOURCE | 17 | 插件请求的资源。 |
223| NAVIGATION_PRELOAD_MAIN_FRAME | 19 | 触发service worker预热的主frame跳转请求。 |
224| NAVIGATION_PRELOAD_SUB_FRAME | 20 | 触发service worker预热的子frame跳转请求。 |
225
226## PlaybackStatus<sup>12+</sup>
227
228[handleStatusChanged](./arkts-apis-webview-NativeMediaPlayerHandler.md#handlestatuschanged12) 接口参数, 用于表示播放器的播放状态。
229
230**系统能力:** SystemCapability.Web.Webview.Core
231
232| 名称 | 值 | 说明 |
233|------|----|------|
234| PAUSED  | 0 | 播放状态为播放状态。 |
235| PLAYING | 1 | 播放状态为暂停状态。 |
236
237## NetworkState<sup>12+<sup>
238
239播放器的网络状态。
240
241**系统能力:** SystemCapability.Web.Webview.Core
242
243| 名称 | 值 | 说明 |
244|------|----|------|
245| EMPTY         | 0 | 播放器还没有开始下载数据。 |
246| IDLE          | 1 | 播放器网络状态空闲,比如媒体分片下载完成,下一个分片还没有开始下载。 |
247| LOADING       | 2 | 播放器正在下载媒体数据。 |
248| NETWORK_ERROR | 3 | 发生了网络错误。 |
249
250## ReadyState<sup>12+<sup>
251
252播放器的缓存状态。
253
254**系统能力:** SystemCapability.Web.Webview.Core
255
256| 名称 | 值 | 说明 |
257|------|----|------|
258| HAVE_NOTHING      | 0 | 没有缓存。 |
259| HAVE_METADATA     | 1 | 只缓存了媒体元数据。 |
260| HAVE_CURRENT_DATA | 2 | 只缓存到当前的播放进度。 |
261| HAVE_FUTURE_DATA  | 3 | 缓存时长超过了当前的播放进度, 但是仍有可能导致卡顿。 |
262| HAVE_ENOUGH_DATA  | 4 | 缓存了足够的数据,保证播放流畅。 |
263
264## MediaError<sup>12+<sup>
265
266播放器的错误类型。
267
268**系统能力:** SystemCapability.Web.Webview.Core
269
270| 名称 | 值 | 说明 |
271|------|----|------|
272| NETWORK_ERROR | 1 | 网络错误。 |
273| FORMAT_ERROR  | 2 | 媒体格式错误。 |
274| DECODE_ERROR  | 3 | 解码错误。 |
275
276## SuspendType<sup>12+<sup>
277
278表示播放器的挂起类型。
279
280**系统能力:** SystemCapability.Web.Webview.Core
281
282| 名称 | 值 | 说明 |
283|------|----|------|
284| ENTER_BACK_FORWARD_CACHE | 0 | 页面进BFCache。 |
285| ENTER_BACKGROUND         | 1 | 页面进后台。 |
286| AUTO_CLEANUP             | 2 | 系统自动清理。 |
287
288## MediaType<sup>12+<sup>
289
290表示媒体类型。
291
292**系统能力:** SystemCapability.Web.Webview.Core
293
294| 名称 | 值 | 说明 |
295|------|----|------|
296| VIDEO | 0 | 视频。 |
297| AUDIO | 1 | 音频。 |
298
299## SourceType<sup>12+<sup>
300
301表示媒体源的类型。
302
303**系统能力:** SystemCapability.Web.Webview.Core
304
305| 名称 | 值 | 说明 |
306|------|----|------|
307| URL | 0 | 媒体源的类型是URL。 |
308| MSE | 1 | 媒体源的类型是blob。 |
309
310## Preload<sup>12+<sup>
311
312播放器预加载媒体数据。
313
314**系统能力:** SystemCapability.Web.Webview.Core
315
316| 名称 | 值 | 说明 |
317|------|----|------|
318| NONE     | 0 | 不预加载。 |
319| METADATA | 1 | 只预加载媒体的元数据。 |
320| AUTO     | 2 | 预加载足够多的媒体数据,以保证能流畅地播放。 |
321
322## ProxySchemeFilter<sup>15+</sup>
323
324使用代理的请求的scheme信息。
325
326**系统能力:** SystemCapability.Web.Webview.Core
327
328| 名称          | 值 | 说明                                     |
329| ------------- | -- |----------------------------------------- |
330| MATCH_ALL_SCHEMES | 0 |所有的scheme都会使用代理。|
331| MATCH_HTTP        | 1 |HTTP请求会使用代理。|
332| MATCH_HTTPS       | 2 |HTTPS请求会使用代理。|
333
334## WebDestroyMode<sup>20+</sup>
335
336Web组件的销毁模式,当Web组件销毁时,销毁模式会影响Web内核的资源释放时机,例如JavaScript运行上下文、渲染上下文等等。
337
338**系统能力:** SystemCapability.Web.Webview.Core
339
340| 名称 | 值 | 说明 |
341| ------------------------------- | - | ---------- |
342| NORMAL_MODE | 0 | 普通模式,由系统决定Web组件资源的销毁时机。 |
343| FAST_MODE   | 1 | 快速模式,当Web组件触发销毁时,立即销毁相关的内部资源。 |
344
345## WebBlanklessErrorCode<sup>20+</sup>
346
347无白屏加载的异常错误码。
348
349**系统能力:** SystemCapability.Web.Webview.Core
350
351| 名称 | 值 | 说明 |
352| ------------------------------- | - | ---------- |
353| SUCCESS | 0 | 成功。 |
354| ERR_UNKNOWN   | -1 | 未知错误,内部状态错误等。 |
355| ERR_INVALID_PARAM   | -2 | 参数不合法。 |
356| ERR_CONTROLLER_NOT_INITED   | -3 | WebViewController未绑定组件。 |
357| ERR_KEY_NOT_MATCH   | -4 | 未匹配到key值,对于[setBlanklessLoadingWithKey](./arkts-apis-webview-WebviewController.md#setblanklessloadingwithkey20)需与[getBlanklessInfoWithKey](./arkts-apis-webview-WebviewController.md#getblanklessinfowithkey20)配套使用并且key值一致,否则返回该错误码。 |
358| ERR_SIGNIFICANT_CHANGE   | -5 | 当相似度较低时,系统会判定为跳变太大,[setBlanklessLoadingWithKey](./arkts-apis-webview-WebviewController.md#setblanklessloadingwithkey20)接口不会成功启用插帧。 |
359
360## ArkWebEngineVersion<sup>20+</sup>
361
362ArkWeb内核版本,请参考[M114内核在OpenHarmony6.0系统上的适配指导](https://gitcode.com/openharmony-tpc/chromium_src/blob/132_trunk/web/ReleaseNote/CompatibleWithLegacyWebEngine.md)363
364| **内核类型** | **英文** | **说明** |
365| ----------- | -------- | -------- |
366| 常青内核     | EVERGREEN WebCore | 当前系统的最新Web内核,系统基于此内核进行完整的功能实现,推荐应用使用。|
367| 遗留内核     | LEGACY WebCore    | 复用上一版本的内核,只做安全补丁及舆情问题修复,仅作为兼容性回滚使用,且遗留内核的支持有时间限制。 |
368
369**系统能力:** SystemCapability.Web.Webview.Core
370
371| 名称          | 值 | 说明                                      |
372| ------------- | -- |----------------------------------------- |
373| SYSTEM_DEFAULT   | 0     | 系统默认内核,OpenHarmony 6.0版本默认为M132。|
374| M114             | 1     | OpenHarmony 6.0版本的遗留内核。开发者可选择此遗留内核,若系统版本上不存在此内核则设置无效。|
375| M132             | 2     | OpenHarmony 6.0版本的常青内核,M132为此版本的默认内核。若系统版本上不存在此内核则设置无效。|