Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“5568e1a3a7e8074e61869e4bf34b504511c62a5f”上不存在“git@gitcode.net:JIULANG9/gpt-vue.git”
提交 10f7b647 编写于 作者: H HelloCrease 提交者： LiAn
浏览文件
操作

fixed c78b6168 from https://gitee.com/HelloCrease/docs/pulls/7353 

update docs
Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 b0a74b87
隐藏空白更改
内联 并排
Showing with 441 addition and 440 deletion
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md
浏览文件 @ 10f7b647
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
按钮组件，可快速创建不同样式的按钮。 按钮组件，可快速创建不同样式的按钮。
> **说明：** > **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表 ## 权限列表
...@@ -21,44 +21,44 @@ ...@@ -21,44 +21,44 @@
- Button(options?: {type?: ButtonType, stateEffect?: boolean}) - Button(options?: {type?: ButtonType, stateEffect?: boolean})
**表1** options参数说明 **表1** options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| type | ButtonType | 否 | Capsule | 描述按钮风格。 |
| stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果，当状态置为false时，点击效果关闭。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----------- | ---------- | ---- | ------- | --------------------------------- |
| type | ButtonType | 否 | Capsule | 描述按钮风格。 |
| stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果，当状态置为false时，点击效果关闭。 |
- Button(label?: [ResourceStr](../../ui/ts-types.md), options?: { type?: ButtonType, stateEffect?: boolean })
- Button(label?: ResourceStr, options?: { type?: ButtonType, stateEffect?: boolean })
使用文本内容创建相应的按钮组件，此时Button无法包含子组件。 使用文本内容创建相应的按钮组件，此时Button无法包含子组件。
**表2** value参数说明 **表2** value参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | ------- | ----------------------------------- | ---- | ---- | ------------- |
| label | [ResourceStr](../../ui/ts-types.md) | 否 | - | 按钮文本内容。 | | label | [ResourceStr](../../ui/ts-types.md) | 否 | - | 按钮文本内容。 |
| options | Object | 否 | - | 见options参数说明。 | | options | Object | 否 | - | 见options参数说明。 |
## 属性 ## 属性
| 名称 | 参数类型 | 默认值 | 描述 | | 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | | ----------- | ---------- | ------- | --------------------------------- |
| type | ButtonType | Capsule | 设置Button样式。 | | type | ButtonType | Capsule | 设置Button样式。 |
| stateEffect | boolean | true | 状态切换时是否开启切换效果，当状态置为false时，点击效果关闭。 | | stateEffect | boolean | true | 状态切换时是否开启切换效果，当状态置为false时，点击效果关闭。 |
- ButtonType枚举说明 - ButtonType枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ------- | ------------------ |
| Capsule | 胶囊型按钮（圆角默认为高度的一半）。 | | Capsule | 胶囊型按钮（圆角默认为高度的一半）。 |
| Circle | 圆形按钮。 | | Circle | 圆形按钮。 |
| Normal | 普通按钮（默认不带圆角）。 | | Normal | 普通按钮（默认不带圆角）。 |
> **说明：** > **说明：**
> - 按钮圆角通过[通用属性borderRadius设置](ts-universal-attributes-border.md)（不支持通过border接口设置圆角）。 > - 按钮圆角通过[通用属性borderRadius设置](ts-universal-attributes-border.md)（不支持通过border接口设置圆角）。
> - 当按钮类型为Capsule时，borderRadius设置不生效，按钮圆角始终为高度的一半。 > - 当按钮类型为Capsule时，borderRadius设置不生效，按钮圆角始终为高度的一半。
> - 当按钮类型为Circle时，borderRadius即为按钮半径，若未设置borderRadius按钮半径则为宽、高中较小值的一半。 > - 当按钮类型为Circle时，borderRadius即为按钮半径，若未设置borderRadius按钮半径则为宽、高中较小值的一半。
> - 按钮文本通过[通用文本样式](ts-universal-attributes-text-style.md)进行设置。 > - 按钮文本通过[通用文本样式](ts-universal-attributes-text-style.md)进行设置。
## 示例 ## 示例
...@@ -75,6 +75,7 @@ struct ButtonExample { ...@@ -75,6 +75,7 @@ struct ButtonExample {
Button('Ok', { type: ButtonType.Normal, stateEffect: true }).borderRadius(8).backgroundColor(0x317aff).width(90) Button('Ok', { type: ButtonType.Normal, stateEffect: true }).borderRadius(8).backgroundColor(0x317aff).width(90)
Button({ type: ButtonType.Normal, stateEffect: true }) { Button({ type: ButtonType.Normal, stateEffect: true }) {
Row() { Row() {
// 图片建议通过$r创建Resource对象引入
Image($r('app.media.loading')).width(20).height(20).margin({ left: 12 }) Image($r('app.media.loading')).width(20).height(20).margin({ left: 12 })
Text('loading').fontSize(12).fontColor(0xffffff).margin({ left: 5, right: 12 }) Text('loading').fontSize(12).fontColor(0xffffff).margin({ left: 5, right: 12 })
}.alignItems(VerticalAlign.Center) }.alignItems(VerticalAlign.Center)
......
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md
浏览文件 @ 10f7b647
...@@ -17,10 +17,10 @@ ...@@ -17,10 +17,10 @@
Web(options: { src: string, controller?: WebController }) Web(options: { src: string, controller?: WebController })
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------------------------------- | ---- | ------ | -------------- | | ---------- | ------------------------------- | ---- | ---- | ------- |
| src | string | 是 | - | 网页资源地址。 | | src | string | 是 | - | 网页资源地址。 |
| controller | [WebController](#webcontroller) | 否 | - | 控制器。 | | controller | [WebController](#webcontroller) | 否 | - | 控制器。 |
**示例：** **示例：**
```ts ```ts
...@@ -52,9 +52,9 @@ domStorageAccess(domStorageAccess: boolean) ...@@ -52,9 +52,9 @@ domStorageAccess(domStorageAccess: boolean)
设置是否开启文档对象模型存储接口（DOM Storage API）权限，默认未开启。 设置是否开启文档对象模型存储接口（DOM Storage API）权限，默认未开启。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ---------------- | ------- | ---- | ---- | ------------------------------------ |
| domStorageAccess | boolean | 是 | - | 设置是否开启文档对象模型存储接口（DOM Storage API）权限。 | | domStorageAccess | boolean | 是 | - | 设置是否开启文档对象模型存储接口（DOM Storage API）权限。 |
**示例：** **示例：**
```ts ```ts
...@@ -76,12 +76,12 @@ domStorageAccess(domStorageAccess: boolean) ...@@ -76,12 +76,12 @@ domStorageAccess(domStorageAccess: boolean)
fileAccess(fileAccess: boolean) fileAccess(fileAccess: boolean)
设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)访问应用中rawfile路径的文件， 默认启用。 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)访问应用中rawfile路径的文件， 默认启用。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ---------- | ------- | ---- | ---- | ---------------------------------------- |
| fileAccess | boolean | 是 | - | 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)访问应用中rawfile路径的文件。 | | fileAccess | boolean | 是 | - | 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)访问应用中rawfile路径的文件。 |
**示例：** **示例：**
```ts ```ts
...@@ -103,12 +103,12 @@ fileAccess(fileAccess: boolean) ...@@ -103,12 +103,12 @@ fileAccess(fileAccess: boolean)
fileFromUrlAccess(fileFromUrlAccess: boolean) fileFromUrlAccess(fileFromUrlAccess: boolean)
设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)的内容，默认未启用。 设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)的内容，默认未启用。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ----------------- | ------- | ---- | ---- | ---------------------------------------- |
| fileFromUrlAccess | boolean | 是 | - | 设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)的内容。 | | fileFromUrlAccess | boolean | 是 | - | 设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-resource-access.md)的内容。 |
**示例：** **示例：**
```ts ```ts
...@@ -133,9 +133,9 @@ imageAccess(imageAccess: boolean) ...@@ -133,9 +133,9 @@ imageAccess(imageAccess: boolean)
设置是否允许自动加载图片资源，默认允许。 设置是否允许自动加载图片资源，默认允许。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ----------- | ------- | ---- | ---- | --------------- |
| imageAccess | boolean | 是 | - | 设置是否允许自动加载图片资源。 | | imageAccess | boolean | 是 | - | 设置是否允许自动加载图片资源。 |
**示例：** **示例：**
```ts ```ts
...@@ -161,12 +161,12 @@ javaScriptProxy(javaScriptProxy: { object: object, name: string, methodList: Arr ...@@ -161,12 +161,12 @@ javaScriptProxy(javaScriptProxy: { object: object, name: string, methodList: Arr
注入JavaScript对象到window对象中，并在window对象中调用该对象的方法。所有参数不支持更新。 注入JavaScript对象到window对象中，并在window对象中调用该对象的方法。所有参数不支持更新。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ---------- | --------------- | ---- | ---- | ------------------------- |
| object | object | 是 | - | 参与注册的对象。只能声明方法，不能声明属性。 | | object | object | 是 | - | 参与注册的对象。只能声明方法，不能声明属性。 |
| name | string | 是 | - | 注册对象的名称，与window中调用的对象名一致。 | | name | string | 是 | - | 注册对象的名称，与window中调用的对象名一致。 |
| methodList | Array\<string\> | 是 | - | 参与注册的应用侧JavaScript对象的方法。| | methodList | Array\<string\> | 是 | - | 参与注册的应用侧JavaScript对象的方法。 |
**示例：** **示例：**
```ts ```ts
// xxx.ets // xxx.ets
...@@ -207,9 +207,9 @@ javaScriptAccess(javaScriptAccess: boolean) ...@@ -207,9 +207,9 @@ javaScriptAccess(javaScriptAccess: boolean)
设置是否允许执行JavaScript脚本，默认允许执行。 设置是否允许执行JavaScript脚本，默认允许执行。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ---------------- | ------- | ---- | ---- | ------------------- |
| javaScriptAccess | boolean | 是 | - | 是否允许执行JavaScript脚本。 | | javaScriptAccess | boolean | 是 | - | 是否允许执行JavaScript脚本。 |
**示例：** **示例：**
```ts ```ts
...@@ -234,9 +234,9 @@ mixedMode(mixedMode: MixedMode) ...@@ -234,9 +234,9 @@ mixedMode(mixedMode: MixedMode)
设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。 设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | --------- | --------------------------- | ---- | ---- | --------- |
| mixedMode | [MixedMode](#mixedmode枚举说明) | 是 | - | 要设置的混合内容。 | | mixedMode | [MixedMode](#mixedmode枚举说明) | 是 | - | 要设置的混合内容。 |
**示例：** **示例：**
```ts ```ts
...@@ -262,9 +262,9 @@ onlineImageAccess(onlineImageAccess: boolean) ...@@ -262,9 +262,9 @@ onlineImageAccess(onlineImageAccess: boolean)
设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。 设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ----------------- | ------- | ---- | ---- | ---------------- |
| onlineImageAccess | boolean | 是 | - | 设置是否允许从网络加载图片资源。 | | onlineImageAccess | boolean | 是 | - | 设置是否允许从网络加载图片资源。 |
**示例：** **示例：**
```ts ```ts
...@@ -289,9 +289,9 @@ zoomAccess(zoomAccess: boolean) ...@@ -289,9 +289,9 @@ zoomAccess(zoomAccess: boolean)
设置是否支持手势进行缩放，默认允许执行缩放。 设置是否支持手势进行缩放，默认允许执行缩放。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ---------- | ------- | ---- | ---- | ------------- |
| zoomAccess | boolean | 是 | - | 设置是否支持手势进行缩放。 | | zoomAccess | boolean | 是 | - | 设置是否支持手势进行缩放。 |
**示例：** **示例：**
```ts ```ts
...@@ -316,9 +316,9 @@ overviewModeAccess(overviewModeAccess: boolean) ...@@ -316,9 +316,9 @@ overviewModeAccess(overviewModeAccess: boolean)
设置是否使用概览模式加载网页，默认使用该方式。 设置是否使用概览模式加载网页，默认使用该方式。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ------------------ | ------- | ---- | ---- | --------------- |
| overviewModeAccess | boolean | 是 | - | 设置是否使用概览模式加载网页。 | | overviewModeAccess | boolean | 是 | - | 设置是否使用概览模式加载网页。 |
**示例：** **示例：**
```ts ```ts
...@@ -343,9 +343,9 @@ databaseAccess(databaseAccess: boolean) ...@@ -343,9 +343,9 @@ databaseAccess(databaseAccess: boolean)
设置是否开启数据库存储API权限，默认不开启。 设置是否开启数据库存储API权限，默认不开启。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | -------------- | ------- | ---- | ---- | ----------------- |
| databaseAccess | boolean | 是 | - | 设置是否开启数据库存储API权限。 | | databaseAccess | boolean | 是 | - | 设置是否开启数据库存储API权限。 |
```ts ```ts
// xxx.ets // xxx.ets
...@@ -369,9 +369,9 @@ cacheMode(cacheMode: CacheMode) ...@@ -369,9 +369,9 @@ cacheMode(cacheMode: CacheMode)
设置缓存模式。 设置缓存模式。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | --------- | --------------------------- | ---- | ---- | --------- |
| cacheMode | [CacheMode](#cachemode枚举说明) | 是 | - | 要设置的缓存模式。 | | cacheMode | [CacheMode](#cachemode枚举说明) | 是 | - | 要设置的缓存模式。 |
**示例：** **示例：**
```ts ```ts
...@@ -397,9 +397,9 @@ textZoomAtio(textZoomAtio: number) ...@@ -397,9 +397,9 @@ textZoomAtio(textZoomAtio: number)
设置页面的文本缩放百分比，默认为100%。 设置页面的文本缩放百分比，默认为100%。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ------------ | ------ | ---- | ---- | --------------- |
| textZoomAtio | number | 是 | - | 要设置的页面的文本缩放百分比。 | | textZoomAtio | number | 是 | - | 要设置的页面的文本缩放百分比。 |
**示例：** **示例：**
```ts ```ts
...@@ -425,9 +425,9 @@ userAgent(userAgent: string) ...@@ -425,9 +425,9 @@ userAgent(userAgent: string)
设置用户代理。 设置用户代理。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | --------- | ------ | ---- | ---- | --------- |
| userAgent | string | 是 | - | 要设置的用户代理。 | | userAgent | string | 是 | - | 要设置的用户代理。 |
**示例：** **示例：**
```ts ```ts
...@@ -461,16 +461,16 @@ onAlert(callback: (event?: { url: string; message: string; result: JsResult }) = ...@@ -461,16 +461,16 @@ onAlert(callback: (event?: { url: string; message: string; result: JsResult }) =
网页触发alert()告警弹窗时触发回调。 网页触发alert()告警弹窗时触发回调。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | --------------------- | --------------- |
| url | string | 当前显示弹窗所在网页的URL。| | url | string | 当前显示弹窗所在网页的URL。 |
| message | string | 弹窗中显示的信息。 | | message | string | 弹窗中显示的信息。 |
| result | [JsResult](#jsresult) | 通知Web组件用户操作行为。| | result | [JsResult](#jsresult) | 通知Web组件用户操作行为。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | ---------------------------------------- |
| boolean | 当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件最终是否离开当前页面。 | | boolean | 当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件最终是否离开当前页面。 |
**示例：** **示例：**
```ts ```ts
...@@ -510,16 +510,16 @@ onBeforeUnload(callback: (event?: { url: string; message: string; result: JsResu ...@@ -510,16 +510,16 @@ onBeforeUnload(callback: (event?: { url: string; message: string; result: JsResu
刷新或关闭场景下，在即将离开当前页面时触发此回调。 刷新或关闭场景下，在即将离开当前页面时触发此回调。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | --------------------- | --------------- |
| url | string | 当前显示弹窗所在网页的URL。| | url | string | 当前显示弹窗所在网页的URL。 |
| message | string | 弹窗中显示的信息。 | | message | string | 弹窗中显示的信息。 |
| result | [JsResult](#jsresult) | 通知Web组件用户操作行为。| | result | [JsResult](#jsresult) | 通知Web组件用户操作行为。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | ---------------------------------------- |
| boolean | 当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件最终是否离开当前页面。 | | boolean | 当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件最终是否离开当前页面。 |
**示例：** **示例：**
```ts ```ts
...@@ -550,16 +550,16 @@ onConfirm(callback: (event?: { url: string; message: string; result: JsResult }) ...@@ -550,16 +550,16 @@ onConfirm(callback: (event?: { url: string; message: string; result: JsResult })
网页调用confirm()告警时触发此回调。 网页调用confirm()告警时触发此回调。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | --------------------- | --------------- |
| url | string | 当前显示弹窗所在网页的URL。| | url | string | 当前显示弹窗所在网页的URL。 |
| message | string | 弹窗中显示的信息。 | | message | string | 弹窗中显示的信息。 |
| result | [JsResult](#jsresult) | 通知Web组件用户操作行为。| | result | [JsResult](#jsresult) | 通知Web组件用户操作行为。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | ---------------------------------------- |
| boolean | 当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件。 | | boolean | 当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件。 |
**示例：** **示例：**
```ts ```ts
...@@ -601,16 +601,16 @@ onConfirm(callback: (event?: { url: string; message: string; result: JsResult }) ...@@ -601,16 +601,16 @@ onConfirm(callback: (event?: { url: string; message: string; result: JsResult })
onPrompt(callback: (event?: { url: string; message: string; value: string; result: JsResult }) => boolean) onPrompt(callback: (event?: { url: string; message: string; value: string; result: JsResult }) => boolean)
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | --------------------- | --------------- |
| url | string | 当前显示弹窗所在网页的URL。| | url | string | 当前显示弹窗所在网页的URL。 |
| message | string | 弹窗中显示的信息。 | | message | string | 弹窗中显示的信息。 |
| result | [JsResult](#jsresult) | 通知Web组件用户操作行为。| | result | [JsResult](#jsresult) | 通知Web组件用户操作行为。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | ---------------------------------------- |
| boolean | 当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件。 | | boolean | 当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件。 |
**示例：** **示例：**
```ts ```ts
...@@ -640,14 +640,14 @@ onConsole(callback: (event?: { message: ConsoleMessage }) => boolean) ...@@ -640,14 +640,14 @@ onConsole(callback: (event?: { message: ConsoleMessage }) => boolean)
通知宿主应用JavaScript console消息。 通知宿主应用JavaScript console消息。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | --------------------------------- | --------- |
| message | [ConsoleMessage](#consolemessage) | 触发的控制台信息。 | | message | [ConsoleMessage](#consolemessage) | 触发的控制台信息。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | ----------------------------------- |
| boolean | 当返回true时，该条消息将不会再打印至控制台，反之仍会打印至控制台。 | | boolean | 当返回true时，该条消息将不会再打印至控制台，反之仍会打印至控制台。 |
**示例：** **示例：**
```ts ```ts
...@@ -677,12 +677,12 @@ onConsole(callback: (event?: { message: ConsoleMessage }) => boolean) ...@@ -677,12 +677,12 @@ onConsole(callback: (event?: { message: ConsoleMessage }) => boolean)
onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void) onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void)
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------------------ | ------------- | ----------------------------------- |
| url | string | 文件下载的URL。 | | url | string | 文件下载的URL。 |
| contentDisposition | string | 服务器返回的 Content-Disposition响应头，可能为空。 | | contentDisposition | string | 服务器返回的 Content-Disposition响应头，可能为空。 |
| mimetype | string | 服务器返回内容媒体类型（MIME）信息。 | | mimetype | string | 服务器返回内容媒体类型（MIME）信息。 |
| contentLength | contentLength | 服务器返回文件的长度。 | | contentLength | contentLength | 服务器返回文件的长度。 |
**示例：** **示例：**
```ts ```ts
...@@ -714,10 +714,10 @@ onErrorReceive(callback: (event?: { request: WebResourceRequest, error: WebResou ...@@ -714,10 +714,10 @@ onErrorReceive(callback: (event?: { request: WebResourceRequest, error: WebResou
网页加载遇到错误时触发该回调。出于性能考虑，建议此回调中尽量执行简单逻辑。 网页加载遇到错误时触发该回调。出于性能考虑，建议此回调中尽量执行简单逻辑。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | ---------------------------------------- | --------------- |
| request | [WebResourceRequest](#webresourcerequest) | 网页请求的封装信息。 | | request | [WebResourceRequest](#webresourcerequest) | 网页请求的封装信息。 |
| error | [WebResourceError](#webresourceerror) | 网页加载资源错误的封装信息 。 | | error | [WebResourceError](#webresourceerror) | 网页加载资源错误的封装信息 。 |
**示例：** **示例：**
```ts ```ts
...@@ -756,10 +756,10 @@ onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: W ...@@ -756,10 +756,10 @@ onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: W
网页加载资源遇到的HTTP错误（响应码>=400)时触发该回调。 网页加载资源遇到的HTTP错误（响应码>=400)时触发该回调。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | ---------------------------------------- | --------------- |
| request | [WebResourceRequest](#webresourcerequest) | 网页请求的封装信息。 | | request | [WebResourceRequest](#webresourcerequest) | 网页请求的封装信息。 |
| error | [WebResourceError](#webresourceerror) | 网页加载资源错误的封装信息 。 | | error | [WebResourceError](#webresourceerror) | 网页加载资源错误的封装信息 。 |
**示例：** **示例：**
```ts ```ts
...@@ -802,13 +802,13 @@ onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: W ...@@ -802,13 +802,13 @@ onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: W
onPageBegin(callback: (event?: { url: string }) => void) onPageBegin(callback: (event?: { url: string }) => void)
网页开始加载时触发该回调，且只在主frame触发，iframe或者frameset的内容加载时不会触发此回调。 网页开始加载时触发该回调，且只在主frame触发，iframe或者frameset的内容加载时不会触发此回调。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ---- | ------ | --------- |
| url | string | 页面的URL地址。 | | url | string | 页面的URL地址。 |
**示例：** **示例：**
```ts ```ts
...@@ -833,13 +833,13 @@ onPageBegin(callback: (event?: { url: string }) => void) ...@@ -833,13 +833,13 @@ onPageBegin(callback: (event?: { url: string }) => void)
onPageEnd(callback: (event?: { url: string }) => void) onPageEnd(callback: (event?: { url: string }) => void)
网页加载完成时触发该回调，且只在主frame触发。 网页加载完成时触发该回调，且只在主frame触发。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ---- | ------ | --------- |
| url | string | 页面的URL地址。 | | url | string | 页面的URL地址。 |
**示例：** **示例：**
```ts ```ts
...@@ -867,9 +867,9 @@ onProgressChange(callback: (event?: { newProgress: number }) => void) ...@@ -867,9 +867,9 @@ onProgressChange(callback: (event?: { newProgress: number }) => void)
网页加载进度变化时触发该回调。 网页加载进度变化时触发该回调。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ----------- | ------ | --------------------- |
| newProgress | number | 新的加载进度，取值范围为0到100的整数。 | | newProgress | number | 新的加载进度，取值范围为0到100的整数。 |
**示例：** **示例：**
```ts ```ts
...@@ -897,9 +897,9 @@ onTitleReceive(callback: (event?: { title: string }) => void) ...@@ -897,9 +897,9 @@ onTitleReceive(callback: (event?: { title: string }) => void)
网页document标题更改时触发该回调。 网页document标题更改时触发该回调。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ----- | ------ | ------------- |
| title | string | document标题内容。 | | title | string | document标题内容。 |
**示例：** **示例：**
```ts ```ts
...@@ -927,10 +927,10 @@ onRefreshAccessedHistory(callback: (event?: { url: string, isRefreshed: boolean ...@@ -927,10 +927,10 @@ onRefreshAccessedHistory(callback: (event?: { url: string, isRefreshed: boolean
加载网页页面完成时触发该回调，用于应用更新其访问的历史链接。 加载网页页面完成时触发该回调，用于应用更新其访问的历史链接。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ----------- | ------- | --------------------------------- |
| url | string | 访问的url。 | | url | string | 访问的url。 |
| isRefreshed | boolean | true表示该页面是被重新加载的，false表示该页面是新加载的。 | | isRefreshed | boolean | true表示该页面是被重新加载的，false表示该页面是新加载的。 |
**示例：** **示例：**
```ts ```ts
...@@ -958,9 +958,9 @@ onRenderExited(callback: (event?: { renderExitReason: RenderExitReason }) => voi ...@@ -958,9 +958,9 @@ onRenderExited(callback: (event?: { renderExitReason: RenderExitReason }) => voi
应用渲染进程异常退出时触发该回调。 应用渲染进程异常退出时触发该回调。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ---------------- | ---------------------------------------- | ---------------- |
| renderExitReason | [RenderExitReason](#renderexitreason枚举说明) | 渲染进程进程异常退出的具体原因。 | | renderExitReason | [RenderExitReason](#renderexitreason枚举说明) | 渲染进程进程异常退出的具体原因。 |
**示例：** **示例：**
```ts ```ts
...@@ -988,10 +988,10 @@ onShowFileSelector(callback: (event?: { result: FileSelectorResult, fileSelector ...@@ -988,10 +988,10 @@ onShowFileSelector(callback: (event?: { result: FileSelectorResult, fileSelector
调用此函数以处理具有“文件”输入类型的HTML表单，以响应用户按下的“选择文件”按钮。 调用此函数以处理具有“文件”输入类型的HTML表单，以响应用户按下的“选择文件”按钮。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------------ | ---------------------------------------- | ----------------- |
| result | [FileSelectorResult](#fileselectorresult9) | 用于通知Web组件文件选择的结果。 | | result | [FileSelectorResult](#fileselectorresult9) | 用于通知Web组件文件选择的结果。 |
| fileSelector | [FileSelectorParam](#fileselectorparam9) | 文件选择器的相关信息。 | | fileSelector | [FileSelectorParam](#fileselectorparam9) | 文件选择器的相关信息。 |
**示例：** **示例：**
```ts ```ts
...@@ -1036,14 +1036,14 @@ onUrlLoadIntercept(callback: (event?: { data:string | WebResourceRequest }) => b ...@@ -1036,14 +1036,14 @@ onUrlLoadIntercept(callback: (event?: { data:string | WebResourceRequest }) => b
当Web组件加载url之前触发该回调，用于是否阻止此次访问。 当Web组件加载url之前触发该回调，用于是否阻止此次访问。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ---- | ---------------------------------------- | --------- |
| data | string / [WebResourceRequest](#webresourcerequest) | url的相关信息。 | | data | string / [WebResourceRequest](#webresourcerequest) | url的相关信息。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | ------------------------ |
| boolean | 返回true表示阻止此次加载，否则允许此次加载。 | | boolean | 返回true表示阻止此次加载，否则允许此次加载。 |
**示例：** **示例：**
```ts ```ts
...@@ -1072,14 +1072,14 @@ onInterceptRequest9+(callback: (event?: { request: WebResourceRequest}) => WebRe ...@@ -1072,14 +1072,14 @@ onInterceptRequest9+(callback: (event?: { request: WebResourceRequest}) => WebRe
当Web组件加载url之前触发该回调，用于拦截url并返回响应数据。 当Web组件加载url之前触发该回调，用于拦截url并返回响应数据。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | ---------------------------------------- | ----------- |
| request | [WebResourceRequest](#webresourcerequest) | url请求的相关信息。 | | request | [WebResourceRequest](#webresourcerequest) | url请求的相关信息。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ---------------------------------------- | --------------------------- |
| [WebResourceResponse](#webresourceresponse) | 返回响应数据为空表示按原来方式加载，否则加载响应数据。 | | [WebResourceResponse](#webresourceresponse) | 返回响应数据为空表示按原来方式加载，否则加载响应数据。 |
**示例：** **示例：**
```ts ```ts
...@@ -1134,16 +1134,16 @@ onHttpAuthRequest(callback: (event?: { handler: HttpAuthHandler, host: string, r ...@@ -1134,16 +1134,16 @@ onHttpAuthRequest(callback: (event?: { handler: HttpAuthHandler, host: string, r
通知收到http auth认证请求。 通知收到http auth认证请求。
**参数：** **参数：**
| 参数名 | 参数类型 | 参数描述 | | 参数名 | 参数类型 | 参数描述 |
| ------ | -------- | ------------------------- | | ------- | ------------------------------------ | ---------------- |
| handler | [HttpAuthHandler](#httpauthhandler9) | 通知Web组件用户操作行为。 | | handler | [HttpAuthHandler](#httpauthhandler9) | 通知Web组件用户操作行为。 |
| host | string | HTTP身份验证凭据应用的主机。 | | host | string | HTTP身份验证凭据应用的主机。 |
| realm | string | HTTP身份验证凭据应用的域。 | | realm | string | HTTP身份验证凭据应用的域。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | --------------------- |
| boolean | 返回false表示此次认证失败，否则成功。 | | boolean | 返回false表示此次认证失败，否则成功。 |
**示例：** **示例：**
```ts ```ts
...@@ -1196,9 +1196,9 @@ getLineNumber(): number ...@@ -1196,9 +1196,9 @@ getLineNumber(): number
获取ConsoleMessage的行数。 获取ConsoleMessage的行数。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | -------------------- |
| number | 返回ConsoleMessage的行数。 | | number | 返回ConsoleMessage的行数。 |
### getMessage ### getMessage
...@@ -1207,9 +1207,9 @@ getMessage(): string ...@@ -1207,9 +1207,9 @@ getMessage(): string
获取ConsoleMessage的日志信息。 获取ConsoleMessage的日志信息。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ---------------------- |
| string | 返回ConsoleMessage的日志信息。 | | string | 返回ConsoleMessage的日志信息。 |
### getMessageLevel ### getMessageLevel
...@@ -1218,9 +1218,9 @@ getMessageLevel(): MessageLevel ...@@ -1218,9 +1218,9 @@ getMessageLevel(): MessageLevel
获取ConsoleMessage的信息级别。 获取ConsoleMessage的信息级别。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | --------------------------------- | ---------------------- |
| [MessageLevel](#messagelevel枚举说明) | 返回ConsoleMessage的信息级别。 | | [MessageLevel](#messagelevel枚举说明) | 返回ConsoleMessage的信息级别。 |
### getSourceId ### getSourceId
...@@ -1229,9 +1229,9 @@ getSourceId(): string ...@@ -1229,9 +1229,9 @@ getSourceId(): string
获取网页源文件路径和名字。 获取网页源文件路径和名字。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ------------- |
| string | 返回网页源文件路径和名字。 | | string | 返回网页源文件路径和名字。 |
## JsResult ## JsResult
...@@ -1256,9 +1256,9 @@ handlePromptConfirm(result: string): void ...@@ -1256,9 +1256,9 @@ handlePromptConfirm(result: string): void
通知Web组件用户确认弹窗操作及对话框内容。 通知Web组件用户确认弹窗操作及对话框内容。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ------ | ------ | ---- | ---- | ----------- |
| result | string | 是 | - | 用户输入的对话框内容。 | | result | string | 是 | - | 用户输入的对话框内容。 |
## WebResourceError ## WebResourceError
...@@ -1271,9 +1271,9 @@ getErrorCode(): number ...@@ -1271,9 +1271,9 @@ getErrorCode(): number
获取加载资源的错误码。 获取加载资源的错误码。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ----------- |
| number | 返回加载资源的错误码。 | | number | 返回加载资源的错误码。 |
### getErrorInfo ### getErrorInfo
...@@ -1282,9 +1282,9 @@ getErrorInfo(): string ...@@ -1282,9 +1282,9 @@ getErrorInfo(): string
获取加载资源的错误信息。 获取加载资源的错误信息。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ------------ |
| string | 返回加载资源的错误信息。 | | string | 返回加载资源的错误信息。 |
## WebResourceRequest ## WebResourceRequest
...@@ -1297,9 +1297,9 @@ getResponseHeader() : Array\<Header\> ...@@ -1297,9 +1297,9 @@ getResponseHeader() : Array\<Header\>
获取资源请求头信息。 获取资源请求头信息。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | -------------------------- | ---------- |
| Array\<[Header](#header)\> | 返回资源请求头信息。 | | Array\<[Header](#header)\> | 返回资源请求头信息。 |
### getRequestUrl ### getRequestUrl
...@@ -1308,9 +1308,9 @@ getRequestUrl(): string ...@@ -1308,9 +1308,9 @@ getRequestUrl(): string
获取资源请求的URL信息。 获取资源请求的URL信息。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ------------- |
| string | 返回资源请求的URL信息。 | | string | 返回资源请求的URL信息。 |
### isMainFrame ### isMainFrame
...@@ -1319,9 +1319,9 @@ isMainFrame(): boolean ...@@ -1319,9 +1319,9 @@ isMainFrame(): boolean
判断资源请求是否为主frame。 判断资源请求是否为主frame。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------- | ---------------- |
| boolean | 返回资源请求是否为主frame。 | | boolean | 返回资源请求是否为主frame。 |
### isRedirect ### isRedirect
...@@ -1330,9 +1330,9 @@ isRedirect(): boolean ...@@ -1330,9 +1330,9 @@ isRedirect(): boolean
判断资源请求是否被服务端重定向。 判断资源请求是否被服务端重定向。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------- | ---------------- |
| boolean | 返回资源请求是否被服务端重定向。 | | boolean | 返回资源请求是否被服务端重定向。 |
### isRequestGesture ### isRequestGesture
...@@ -1341,18 +1341,18 @@ isRequestGesture(): boolean ...@@ -1341,18 +1341,18 @@ isRequestGesture(): boolean
获取资源请求是否与手势（如点击）相关联。 获取资源请求是否与手势（如点击）相关联。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------- | -------------------- |
| boolean | 返回资源请求是否与手势（如点击）相关联。 | | boolean | 返回资源请求是否与手势（如点击）相关联。 |
## Header ## Header
Web组件返回的请求/响应头对象。 Web组件返回的请求/响应头对象。
| 名称 | 类型 | 描述 | | 名称 | 类型 | 描述 |
| ----------- | -------- | -------------------- | | ----------- | ------ | ------------- |
| headerKey | string | 请求/响应头的key。 | | headerKey | string | 请求/响应头的key。 |
| headerValue | string | 请求/响应头的value。 | | headerValue | string | 请求/响应头的value。 |
## WebResourceResponse ## WebResourceResponse
...@@ -1366,9 +1366,9 @@ getReasonMessage(): string ...@@ -1366,9 +1366,9 @@ getReasonMessage(): string
获取资源响应的状态码描述。 获取资源响应的状态码描述。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ------------- |
| string | 返回资源响应的状态码描述。 | | string | 返回资源响应的状态码描述。 |
### getResponseCode ### getResponseCode
...@@ -1377,9 +1377,9 @@ getResponseCode(): number ...@@ -1377,9 +1377,9 @@ getResponseCode(): number
获取资源响应的状态码。 获取资源响应的状态码。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ----------- |
| number | 返回资源响应的状态码。 | | number | 返回资源响应的状态码。 |
### getResponseData ### getResponseData
...@@ -1388,9 +1388,9 @@ getResponseData(): string ...@@ -1388,9 +1388,9 @@ getResponseData(): string
获取资源响应数据。 获取资源响应数据。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | --------- |
| string | 返回资源响应数据。 | | string | 返回资源响应数据。 |
### getResponseEncoding ### getResponseEncoding
...@@ -1399,9 +1399,9 @@ getResponseEncoding(): string ...@@ -1399,9 +1399,9 @@ getResponseEncoding(): string
获取资源响应的编码。 获取资源响应的编码。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ---------- |
| string | 返回资源响应的编码。 | | string | 返回资源响应的编码。 |
### getResponseHeader ### getResponseHeader
...@@ -1410,9 +1410,9 @@ getResponseHeader() : Array\<Header\> ...@@ -1410,9 +1410,9 @@ getResponseHeader() : Array\<Header\>
获取资源响应头。 获取资源响应头。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | -------------------------- | -------- |
| Array\<[Header](#header)\> | 返回资源响应头。 | | Array\<[Header](#header)\> | 返回资源响应头。 |
### getResponseMimeType ### getResponseMimeType
...@@ -1421,9 +1421,9 @@ getResponseMimeType(): string ...@@ -1421,9 +1421,9 @@ getResponseMimeType(): string
获取资源响应的媒体（MIME）类型。 获取资源响应的媒体（MIME）类型。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ------------------ |
| string | 返回资源响应的媒体（MIME）类型。 | | string | 返回资源响应的媒体（MIME）类型。 |
### setResponseData<sup>9+</sup> ### setResponseData<sup>9+</sup>
...@@ -1432,9 +1432,9 @@ setResponseData(data: string) ...@@ -1432,9 +1432,9 @@ setResponseData(data: string)
设置资源响应数据。 设置资源响应数据。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ---- | ------ | ---- | ---- | ----------- |
| data | string | 是 | - | 要设置的资源响应数据。 | | data | string | 是 | - | 要设置的资源响应数据。 |
### setResponseEncoding<sup>9+</sup> ### setResponseEncoding<sup>9+</sup>
...@@ -1443,9 +1443,9 @@ setResponseEncoding(encoding: string) ...@@ -1443,9 +1443,9 @@ setResponseEncoding(encoding: string)
设置资源响应的编码。 设置资源响应的编码。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | -------- | ------ | ---- | ---- | ------------ |
| encoding | string | 是 | - | 要设置的资源响应的编码。 | | encoding | string | 是 | - | 要设置的资源响应的编码。 |
### setResponseMimeType<sup>9+</sup> ### setResponseMimeType<sup>9+</sup>
...@@ -1454,9 +1454,9 @@ setResponseMimeType(mimeType: string) ...@@ -1454,9 +1454,9 @@ setResponseMimeType(mimeType: string)
设置资源响应的媒体（MIME）类型。 设置资源响应的媒体（MIME）类型。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | -------- | ------ | ---- | ---- | -------------------- |
| mimeType | string | 是 | - | 要设置的资源响应的媒体（MIME）类型。 | | mimeType | string | 是 | - | 要设置的资源响应的媒体（MIME）类型。 |
### setReasonMessage<sup>9+</sup> ### setReasonMessage<sup>9+</sup>
...@@ -1465,9 +1465,9 @@ setReasonMessage(reason: string) ...@@ -1465,9 +1465,9 @@ setReasonMessage(reason: string)
设置资源响应的状态码描述。 设置资源响应的状态码描述。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ------ | ------ | ---- | ---- | --------------- |
| reason | string | 是 | - | 要设置的资源响应的状态码描述。 | | reason | string | 是 | - | 要设置的资源响应的状态码描述。 |
### setResponseHeader<sup>9+</sup> ### setResponseHeader<sup>9+</sup>
...@@ -1476,9 +1476,9 @@ setResponseHeader(header: Array\<Header\>) ...@@ -1476,9 +1476,9 @@ setResponseHeader(header: Array\<Header\>)
设置资源响应头。 设置资源响应头。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ------ | -------------------------- | ---- | ---- | ---------- |
| header | Array\<[Header](#header)\> | 是 | - | 要设置的资源响应头。 | | header | Array\<[Header](#header)\> | 是 | - | 要设置的资源响应头。 |
### setResponseCode<sup>9+</sup> ### setResponseCode<sup>9+</sup>
...@@ -1487,9 +1487,9 @@ setResponseCode(code: number) ...@@ -1487,9 +1487,9 @@ setResponseCode(code: number)
设置资源响应的状态码。 设置资源响应的状态码。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ---- | ------ | ---- | ---- | ------------- |
| code | number | 是 | - | 要设置的资源响应的状态码。 | | code | number | 是 | - | 要设置的资源响应的状态码。 |
## FileSelectorResult<sup>9+</sup> ## FileSelectorResult<sup>9+</sup>
...@@ -1502,9 +1502,9 @@ handleFileList(fileList: Array\<string\>): void ...@@ -1502,9 +1502,9 @@ handleFileList(fileList: Array\<string\>): void
通知Web组件进行文件选择操作。 通知Web组件进行文件选择操作。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | -------- | --------------- | ---- | ---- | ------------ |
| fileList | Array\<string\> | 是 | - | 需要进行操作的文件列表。 | | fileList | Array\<string\> | 是 | - | 需要进行操作的文件列表。 |
## FileSelectorParam<sup>9+</sup> ## FileSelectorParam<sup>9+</sup>
...@@ -1517,9 +1517,9 @@ getTitle(): string ...@@ -1517,9 +1517,9 @@ getTitle(): string
获取文件选择器标题。 获取文件选择器标题。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------ | ---------- |
| string | 返回文件选择器标题。 | | string | 返回文件选择器标题。 |
### getMode<sup>9+</sup> ### getMode<sup>9+</sup>
...@@ -1528,9 +1528,9 @@ getMode(): FileSelectorMode ...@@ -1528,9 +1528,9 @@ getMode(): FileSelectorMode
获取文件选择器的模式。 获取文件选择器的模式。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ---------------------------------------- | ----------- |
| [FileSelectorMode](#fileselectormode枚举说明) | 返回文件选择器的模式。 | | [FileSelectorMode](#fileselectormode枚举说明) | 返回文件选择器的模式。 |
### getAcceptType<sup>9+</sup> ### getAcceptType<sup>9+</sup>
...@@ -1539,9 +1539,9 @@ getAcceptType(): Array\<string\> ...@@ -1539,9 +1539,9 @@ getAcceptType(): Array\<string\>
获取文件过滤类型。 获取文件过滤类型。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | --------------- | --------- |
| Array\<string\> | 返回文件过滤类型。 | | Array\<string\> | 返回文件过滤类型。 |
### isCapture<sup>9+</sup> ### isCapture<sup>9+</sup>
...@@ -1550,9 +1550,9 @@ isCapture(): boolean ...@@ -1550,9 +1550,9 @@ isCapture(): boolean
获取是否调用多媒体能力。 获取是否调用多媒体能力。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------- | ------------ |
| boolean | 返回是否调用多媒体能力。 | | boolean | 返回是否调用多媒体能力。 |
## HttpAuthHandler<sup>9+</sup> ## HttpAuthHandler<sup>9+</sup>
...@@ -1572,15 +1572,15 @@ confirm(userName: string, pwd: string): boolean ...@@ -1572,15 +1572,15 @@ confirm(userName: string, pwd: string): boolean
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ------ | -------------- | | -------- | ------ | ---- | ---- | ---------- |
| userName | string | 是 | - | HTTP认证用户名。| | userName | string | 是 | - | HTTP认证用户名。 |
| pwd | string | 是 | - | HTTP认证密码。 | | pwd | string | 是 | - | HTTP认证密码。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------------------------- | | ------- | --------------------- |
| boolean | 认证成功返回true，失败返回false。 | | boolean | 认证成功返回true，失败返回false。 |
### isHttpAuthInfoSaved<sup>9+</sup> ### isHttpAuthInfoSaved<sup>9+</sup>
...@@ -1589,9 +1589,9 @@ isHttpAuthInfoSaved(): boolean ...@@ -1589,9 +1589,9 @@ isHttpAuthInfoSaved(): boolean
通知Web组件用户使用服务器缓存的账号密码认证。 通知Web组件用户使用服务器缓存的账号密码认证。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------------------------------- | | ------- | ------------------------- |
| boolean | 存在密码认证成功返回true，其他返回false。| | boolean | 存在密码认证成功返回true，其他返回false。 |
## WebController ## WebController
...@@ -1610,9 +1610,9 @@ accessBackward(): boolean ...@@ -1610,9 +1610,9 @@ accessBackward(): boolean
当前页面是否可后退，即当前页面是否有返回历史记录。 当前页面是否可后退，即当前页面是否有返回历史记录。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------------------------------- | | ------- | --------------------- |
| boolean | 可以后退返回true,否则返回false。 | | boolean | 可以后退返回true,否则返回false。 |
**示例：** **示例：**
```ts ```ts
...@@ -1642,9 +1642,9 @@ accessForward(): boolean ...@@ -1642,9 +1642,9 @@ accessForward(): boolean
当前页面是否可前进，即当前页面是否有前进历史记录。 当前页面是否可前进，即当前页面是否有前进历史记录。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------------------------------- | | ------- | --------------------- |
| boolean | 可以前进返回true,否则返回false。 | | boolean | 可以前进返回true,否则返回false。 |
**示例：** **示例：**
```ts ```ts
...@@ -1675,14 +1675,14 @@ accessStep(step: number): boolean ...@@ -1675,14 +1675,14 @@ accessStep(step: number): boolean
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------------------------ | | ---- | ------ | ---- | ---- | --------------------- |
| step | number | 是 | - | 要跳转的步数，正数代表前进，负数代表后退。 | | step | number | 是 | - | 要跳转的步数，正数代表前进，负数代表后退。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------------ | | ------- | --------- |
| boolean | 页面是否前进或后退 | | boolean | 页面是否前进或后退 |
**示例：** **示例：**
```ts ```ts
...@@ -1765,9 +1765,9 @@ backOrForward(step: number): void ...@@ -1765,9 +1765,9 @@ backOrForward(step: number): void
按照历史栈，前进或者后退指定步长的页面，当历史栈中不存在对应步长的页面时，不会进行页面跳转。 按照历史栈，前进或者后退指定步长的页面，当历史栈中不存在对应步长的页面时，不会进行页面跳转。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------ | ---- | ---- | ---------------------------------------- | | ---- | ------ | ---- | ---- | ----------- |
| step | number | 是 |- |需要前进或后退的步长。 | | step | number | 是 | - | 需要前进或后退的步长。 |
**示例：** **示例：**
```ts ```ts
...@@ -1794,9 +1794,9 @@ deleteJavaScriptRegister(name: string) ...@@ -1794,9 +1794,9 @@ deleteJavaScriptRegister(name: string)
删除通过registerJavaScriptProxy注册到window上的指定name的应用侧JavaScript对象。 删除通过registerJavaScriptProxy注册到window上的指定name的应用侧JavaScript对象。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------------------------------------------ | | ---- | ------ | ---- | ---- | ---------------------------------------- |
| name | string | 是 | - | 注册对象的名称，可在网页侧JavaScript中通过此名称调用应用侧JavaScript对象。 | | name | string | 是 | - | 注册对象的名称，可在网页侧JavaScript中通过此名称调用应用侧JavaScript对象。 |
**示例：** **示例：**
```ts ```ts
...@@ -1826,9 +1826,9 @@ getHitTest(): HitTestType ...@@ -1826,9 +1826,9 @@ getHitTest(): HitTestType
获取当前被点击区域的元素类型。 获取当前被点击区域的元素类型。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------------ | | ------------------------------- | ----------- |
| [HitTestType](#hittesttype枚举说明) | 被点击区域的元素类型。 | | [HitTestType](#hittesttype枚举说明) | 被点击区域的元素类型。 |
**示例：** **示例：**
```ts ```ts
...@@ -1857,9 +1857,9 @@ getHitTestValue(): HitTestValue ...@@ -1857,9 +1857,9 @@ getHitTestValue(): HitTestValue
获取当前被点击区域的元素信息。 获取当前被点击区域的元素信息。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------------------------------ | ---------- |
| [HitTestValue](#hittestvalue9) | 点击区域的元素信息。 | | [HitTestValue](#hittestvalue9) | 点击区域的元素信息。 |
**示例：** **示例：**
```ts ```ts
...@@ -1889,9 +1889,9 @@ getWebId(): number ...@@ -1889,9 +1889,9 @@ getWebId(): number
获取当前Web组件的索引值，用于多个Web组件的管理。 获取当前Web组件的索引值，用于多个Web组件的管理。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------ | ------------ |
| number | 当前Web组件的索引值。 | | number | 当前Web组件的索引值。 |
**示例：** **示例：**
```ts ```ts
...@@ -1920,9 +1920,9 @@ getTitle(): string ...@@ -1920,9 +1920,9 @@ getTitle(): string
获取当前网页的标题。 获取当前网页的标题。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------ | -------- |
| string | 当前网页的标题。 | | string | 当前网页的标题。 |
**示例：** **示例：**
```ts ```ts
...@@ -1951,9 +1951,9 @@ getPageHeight(): number ...@@ -1951,9 +1951,9 @@ getPageHeight(): number
获取当前网页的页面高度。 获取当前网页的页面高度。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------ | ---------- |
| number | 当前网页的页面高度。 | | number | 当前网页的页面高度。 |
**示例：** **示例：**
```ts ```ts
...@@ -1982,9 +1982,9 @@ getDefaultUserAgent(): string ...@@ -1982,9 +1982,9 @@ getDefaultUserAgent(): string
获取当前默认用户代理。 获取当前默认用户代理。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------ | ------- |
| string | 默认用户代理。 | | string | 默认用户代理。 |
**示例：** **示例：**
```ts ```ts
...@@ -2018,13 +2018,13 @@ baseUrl为空时，通过”data“协议加载指定的一段字符串。 ...@@ -2018,13 +2018,13 @@ baseUrl为空时，通过”data“协议加载指定的一段字符串。
当baseUrl为“http/https"协议时，编码后的data字符串将被Web组件以类似loadUrl的方式以非编码字符串处理。 当baseUrl为“http/https"协议时，编码后的data字符串将被Web组件以类似loadUrl的方式以非编码字符串处理。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | -------- | ---- | ------ | ------------------------------------------------------------ | | ---------- | ------ | ---- | ---- | ---------------------------------------- |
| data | string | 是 | - | 按照”Base64“或者”URL"编码后的一段字符串。 | | data | string | 是 | - | 按照”Base64“或者”URL"编码后的一段字符串。 |
| mimeType | string | 是 | - | 媒体类型（MIME）。 | | mimeType | string | 是 | - | 媒体类型（MIME）。 |
| encoding | string | 是 | - | 编码类型，具体为“Base64"或者”URL编码。 | | encoding | string | 是 | - | 编码类型，具体为“Base64"或者”URL编码。 |
| baseUrl | string | 否 | - | 指定的一个URL路径（“http”/“https”/"data"协议），并由Web组件赋值给window.origin。 | | baseUrl | string | 否 | - | 指定的一个URL路径（“http”/“https”/"data"协议），并由Web组件赋值给window.origin。 |
| historyUrl | string | 否 | - | 历史记录URL。非空时，可被历史记录管理，实现前后后退功能。当baseUrl为空时，此属性无效。 | | historyUrl | string | 否 | - | 历史记录URL。非空时，可被历史记录管理，实现前后后退功能。当baseUrl为空时，此属性无效。 |
**示例：** **示例：**
```ts ```ts
...@@ -2061,10 +2061,10 @@ loadUrl(options: { url: string | Resource, headers?: Array\<Header\> }) ...@@ -2061,10 +2061,10 @@ loadUrl(options: { url: string | Resource, headers?: Array\<Header\> })
而通过registerJavaScriptProxy注入的对象，在loadUrl导航到新的页面也会有效。 而通过registerJavaScriptProxy注入的对象，在loadUrl导航到新的页面也会有效。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------- | ---------------------------------- | ---- | ------ | --------------------- | | ------- | -------------------------- | ---- | ---- | -------------- |
| url | string | 是 | - | 需要加载的 URL。 | | url | string | 是 | - | 需要加载的 URL。 |
| headers | Array\<[Header](#header)\> | 否 | [] | URL的附加HTTP请求头。 | | headers | Array\<[Header](#header)\> | 否 | [] | URL的附加HTTP请求头。 |
**示例：** **示例：**
```ts ```ts
...@@ -2144,9 +2144,9 @@ zoom(factor: number): void ...@@ -2144,9 +2144,9 @@ zoom(factor: number): void
调整当前网页的缩放比例。 调整当前网页的缩放比例。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 | | 参数名 | 参数类型 | 必填 | 参数描述 |
|--------|----------|------|---------| | ------ | ------ | ---- | ------------------------------ |
| factor | number | 是 | 基于当前网页所需调整的相对缩放比例，正值为放大，负值为缩小。 | | factor | number | 是 | 基于当前网页所需调整的相对缩放比例，正值为放大，负值为缩小。 |
**示例：** **示例：**
```ts ```ts
...@@ -2175,9 +2175,9 @@ zoomIn(): boolean ...@@ -2175,9 +2175,9 @@ zoomIn(): boolean
调用此接口将当前网页进行放大，比列20%。 调用此接口将当前网页进行放大，比列20%。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | ----------- |
| boolean | 放大操作是否成功执行。 | | boolean | 放大操作是否成功执行。 |
**示例：** **示例：**
```ts ```ts
...@@ -2206,9 +2206,9 @@ zoomOut(): boolean ...@@ -2206,9 +2206,9 @@ zoomOut(): boolean
调用此接口将当前网页进行缩小，比列20%。 调用此接口将当前网页进行缩小，比列20%。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------- | ----------- |
| boolean | 缩小操作是否成功执行。 | | boolean | 缩小操作是否成功执行。 |
**示例：** **示例：**
```ts ```ts
...@@ -2264,11 +2264,11 @@ registerJavaScriptProxy(options: { object: object, name: string, methodList: Arr ...@@ -2264,11 +2264,11 @@ registerJavaScriptProxy(options: { object: object, name: string, methodList: Arr
注入JavaScript对象到window对象中，并在window对象中调用该对象的方法。注册后，须调用refresh接口生效。 注入JavaScript对象到window对象中，并在window对象中调用该对象的方法。注册后，须调用refresh接口生效。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | --------------- | ---- | ------ | ------------------------------------------------------------ | | ---------- | --------------- | ---- | ---- | ---------------------------------------- |
| object | object | 是 | - | 参与注册的应用侧JavaScript对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean | | object | object | 是 | - | 参与注册的应用侧JavaScript对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean |
| name | string | 是 | - | 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。 | | name | string | 是 | - | 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。 |
| methodList | Array\<string\> | 是 | - | 参与注册的应用侧JavaScript对象的方法。 | | methodList | Array\<string\> | 是 | - | 参与注册的应用侧JavaScript对象的方法。 |
**示例：** **示例：**
```ts ```ts
...@@ -2302,7 +2302,7 @@ registerJavaScriptProxy(options: { object: object, name: string, methodList: Arr ...@@ -2302,7 +2302,7 @@ registerJavaScriptProxy(options: { object: object, name: string, methodList: Arr
} }
} }
``` ```
```html ```html
<!-- index.html --> <!-- index.html -->
<!DOCTYPE html> <!DOCTYPE html>
...@@ -2328,10 +2328,10 @@ runJavaScript(options: { script: string, callback?: (result: string) => void }) ...@@ -2328,10 +2328,10 @@ runJavaScript(options: { script: string, callback?: (result: string) => void })
异步执行JavaScript脚本，并通过回调方式返回脚本执行的结果。runJavaScript需要在loadUrl完成后，比如onPageEnd中调用。 异步执行JavaScript脚本，并通过回调方式返回脚本执行的结果。runJavaScript需要在loadUrl完成后，比如onPageEnd中调用。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | ------------------------ | ---- | ------ | ------------------------------------------------------------ | | -------- | ------------------------ | ---- | ---- | ---------------------------------------- |
| script | string | 是 | - | JavaScript脚本。 | | script | string | 是 | - | JavaScript脚本。 |
| callback | (result: string) => void | 否 | - | 回调执行JavaScript脚本结果。JavaScript脚本若执行失败或无返回值时，返回null。 | | callback | (result: string) => void | 否 | - | 回调执行JavaScript脚本结果。JavaScript脚本若执行失败或无返回值时，返回null。 |
**示例：** **示例：**
```ts ```ts
...@@ -2437,9 +2437,9 @@ getCookieManager(): WebCookie ...@@ -2437,9 +2437,9 @@ getCookieManager(): WebCookie
获取web组件cookie管理对象。 获取web组件cookie管理对象。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------- | -------------------------------------------------------- | | --------- | ---------------------------------------- |
| WebCookie | web组件cookie管理对象，参考[WebCookie](#webcookie)定义。 | | WebCookie | web组件cookie管理对象，参考[WebCookie](#webcookie)定义。 |
**示例：** **示例：**
```ts ```ts
...@@ -2470,9 +2470,9 @@ getType(): HitTestType ...@@ -2470,9 +2470,9 @@ getType(): HitTestType
获取当前被点击区域的元素类型。 获取当前被点击区域的元素类型。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------------------------------- | ------------- |
| [HitTestType](#hittesttype枚举说明) | 当前被点击区域的元素类型。 | | [HitTestType](#hittesttype枚举说明) | 当前被点击区域的元素类型。 |
### getExtra<sup>9+</sup> ### getExtra<sup>9+</sup>
getExtra(): string getExtra(): string
...@@ -2480,9 +2480,9 @@ getExtra(): string ...@@ -2480,9 +2480,9 @@ getExtra(): string
若被点击区域为图片或链接，则附加参数信息为其url地址。 若被点击区域为图片或链接，则附加参数信息为其url地址。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|----------|------| | ------ | ------------ |
| string | 点击区域的附加参数信息。 | | string | 点击区域的附加参数信息。 |
## WebCookie ## WebCookie
...@@ -2494,15 +2494,15 @@ setCookie(url: string, value: string): boolean ...@@ -2494,15 +2494,15 @@ setCookie(url: string, value: string): boolean
设置cookie，该方法为同步方法。设置成功返回true，否则返回false。 设置cookie，该方法为同步方法。设置成功返回true，否则返回false。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | ------------------------- | | ----- | ------ | ---- | ---- | ----------------- |
| url | string | 是 | - | 要设置的cookie所属的url。 | | url | string | 是 | - | 要设置的cookie所属的url。 |
| value | string | 是 | - | cookie的值。 | | value | string | 是 | - | cookie的值。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------------------- | | ------- | ------------- |
| boolean | 设置cookie是否成功。 | | boolean | 设置cookie是否成功。 |
**示例：** **示例：**
```ts ```ts
...@@ -2531,9 +2531,9 @@ saveCookieSync(): boolean ...@@ -2531,9 +2531,9 @@ saveCookieSync(): boolean
将当前存在内存中的cookie同步到磁盘中，该方法为同步方法。 将当前存在内存中的cookie同步到磁盘中，该方法为同步方法。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ---------------------------------- | | ------- | -------------------- |
| boolean | 同步内存cookie到磁盘操作是否成功。 | | boolean | 同步内存cookie到磁盘操作是否成功。 |
**示例：** **示例：**
```ts ```ts
...@@ -2566,9 +2566,9 @@ static existHttpAuthCredentials(): boolean ...@@ -2566,9 +2566,9 @@ static existHttpAuthCredentials(): boolean
判断是否存在任何已保存的HTTP身份验证凭据，该方法为同步方法。存在返回true，不存在返回false。 判断是否存在任何已保存的HTTP身份验证凭据，该方法为同步方法。存在返回true，不存在返回false。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ----------------------------------- | | ------- | ---------------------------------------- |
| boolean | 是否存在任何已保存的HTTP身份验证凭据。存在返回true，不存在返回false | | boolean | 是否存在任何已保存的HTTP身份验证凭据。存在返回true，不存在返回false |
**示例：** **示例：**
```ts ```ts
...@@ -2626,15 +2626,15 @@ static getHttpAuthCredentials(host: string, realm: string): Array\<string\> ...@@ -2626,15 +2626,15 @@ static getHttpAuthCredentials(host: string, realm: string): Array\<string\>
检索给定主机和域的HTTP身份验证凭据，该方法为同步方法。检索成功返回一个包含用户名和密码的组数，检索不成功返回空数组。 检索给定主机和域的HTTP身份验证凭据，该方法为同步方法。检索成功返回一个包含用户名和密码的组数，检索不成功返回空数组。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ------ | -------------------------- | | ----- | ------ | ---- | ---- | ---------------- |
| host | string | 是 | - | HTTP身份验证凭据应用的主机。 | | host | string | 是 | - | HTTP身份验证凭据应用的主机。 |
| realm | string | 是 | - | HTTP身份验证凭据应用的域。 | | realm | string | 是 | - | HTTP身份验证凭据应用的域。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | --------------------------------------------- | | --------------- | ---------------------- |
| Array\<string\> | 包含用户名和密码的组数，检索失败返回空数组。 | | Array\<string\> | 包含用户名和密码的组数，检索失败返回空数组。 |
**示例：** **示例：**
```ts ```ts
...@@ -2670,12 +2670,12 @@ static saveHttpAuthCredentials(host: string, realm: string, username: string, pa ...@@ -2670,12 +2670,12 @@ static saveHttpAuthCredentials(host: string, realm: string, username: string, pa
保存给定主机和域的HTTP身份验证凭据，该方法为同步方法。 保存给定主机和域的HTTP身份验证凭据，该方法为同步方法。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ------ | -------------------------- | | -------- | ------ | ---- | ---- | ---------------- |
| host | string | 是 | - | HTTP身份验证凭据应用的主机。 | | host | string | 是 | - | HTTP身份验证凭据应用的主机。 |
| realm | string | 是 | - | HTTP身份验证凭据应用的域。 | | realm | string | 是 | - | HTTP身份验证凭据应用的域。 |
| username | string | 是 | - | 用户名。 | | username | string | 是 | - | 用户名。 |
| password | string | 是 | - | 密码。 | | password | string | 是 | - | 密码。 |
**示例：** **示例：**
```ts ```ts
...@@ -2733,9 +2733,9 @@ static deleteOrigin(origin : string): void ...@@ -2733,9 +2733,9 @@ static deleteOrigin(origin : string): void
清除指定源所使用的存储。 清除指定源所使用的存储。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
|---------|---------|-----|-----| | ------ | ------ | ---- | ---------- |
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
**示例：** **示例：**
```ts ```ts
...@@ -2765,9 +2765,9 @@ static getOrigins(callback: AsyncCallback<Array<[WebStorageOrigin]>>) : void ...@@ -2765,9 +2765,9 @@ static getOrigins(callback: AsyncCallback<Array<[WebStorageOrigin]>>) : void
以回调方式异步获取当前使用Web SQL数据库的所有源的信息。 以回调方式异步获取当前使用Web SQL数据库的所有源的信息。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
|---------|---------|-----|----| | -------- | ---------------------------------------- | ---- | ----------------------------------- |
| callback | AsyncCallback<Array<[WebStorageOrigin](#webstorageorigin9)>> | 是 | 以数组方式返回源的信息，信息内容参考WebStorageOrigin。| | callback | AsyncCallback<Array<[WebStorageOrigin](#webstorageorigin9)>> | 是 | 以数组方式返回源的信息，信息内容参考WebStorageOrigin。 |
**示例：** **示例：**
```ts ```ts
...@@ -2807,9 +2807,9 @@ static getOrigins() : Promise<Array<[WebStorageOrigin]>> ...@@ -2807,9 +2807,9 @@ static getOrigins() : Promise<Array<[WebStorageOrigin]>>
以Promise方式异步获取当前使用Web SQL数据库的所有源的信息。 以Promise方式异步获取当前使用Web SQL数据库的所有源的信息。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|------|------| | ---------------------------------------- | ---------------------------------------- |
| Promise<Array<[WebStorageOrigin](#webstorageorigin9)>> | Promise实例，用于获取当前所有源的信息，信息内容参考WebStorageOrigin。 | | Promise<Array<[WebStorageOrigin](#webstorageorigin9)>> | Promise实例，用于获取当前所有源的信息，信息内容参考WebStorageOrigin。 |
**示例：** **示例：**
```ts ```ts
...@@ -2849,10 +2849,10 @@ static getOriginQuota(origin : string, callback : AsyncCallback<number>) : void ...@@ -2849,10 +2849,10 @@ static getOriginQuota(origin : string, callback : AsyncCallback<number>) : void
使用callback回调异步获取指定源的Web SQL数据库的存储配额，配额以字节为单位。 使用callback回调异步获取指定源的Web SQL数据库的存储配额，配额以字节为单位。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
|----------|-----------|------|------| | -------- | --------------------- | ---- | --------- |
| origin | string | 是 | 指定源的字符串索引 | | origin | string | 是 | 指定源的字符串索引 |
| callback | AsyncCallback<number> | 是 | 指定源的存储配额。 | | callback | AsyncCallback<number> | 是 | 指定源的存储配额。 |
**示例：** **示例：**
```ts ```ts
...@@ -2888,14 +2888,14 @@ static getOriginQuota(origin : string) : Promise<number> ...@@ -2888,14 +2888,14 @@ static getOriginQuota(origin : string) : Promise<number>
以Promise方式异步获取指定源的Web SQL数据库的存储配额，配额以字节为单位。 以Promise方式异步获取指定源的Web SQL数据库的存储配额，配额以字节为单位。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
|----------|---------|------|-------| | ------ | ------ | ---- | ---------- |
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|------|------| | --------------- | ----------------------- |
| Promise<number> | Promise实例，用于获取指定源的存储配额。 | | Promise<number> | Promise实例，用于获取指定源的存储配额。 |
**示例：** **示例：**
```ts ```ts
...@@ -2931,10 +2931,10 @@ static getOriginUsage(origin : string, callback : AsyncCallback<number>) : void ...@@ -2931,10 +2931,10 @@ static getOriginUsage(origin : string, callback : AsyncCallback<number>) : void
以回调方式异步获取指定源的Web SQL数据库的存储量，存储量以字节为单位。 以回调方式异步获取指定源的Web SQL数据库的存储量，存储量以字节为单位。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
|----------|----------|------|------| | -------- | --------------------- | ---- | ---------- |
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
| callback | AsyncCallback<number> | 是 | 指定源的存储量。 | | callback | AsyncCallback<number> | 是 | 指定源的存储量。 |
**示例：** **示例：**
```ts ```ts
...@@ -2970,14 +2970,14 @@ static getOriginUsage(origin : string) : Promise<number> ...@@ -2970,14 +2970,14 @@ static getOriginUsage(origin : string) : Promise<number>
以Promise方式异步获取指定源的Web SQL数据库的存储量，存储量以字节为单位。 以Promise方式异步获取指定源的Web SQL数据库的存储量，存储量以字节为单位。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
|----------|----------|------|------| | ------ | ------ | ---- | ---------- |
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|------|------| | --------------- | ---------------------- |
| Promise<number> | Promise实例，用于获取指定源的存储量。 | | Promise<number> | Promise实例，用于获取指定源的存储量。 |
**示例：** **示例：**
```ts ```ts
...@@ -3012,16 +3012,16 @@ static getOriginUsage(origin : string) : Promise<number> ...@@ -3012,16 +3012,16 @@ static getOriginUsage(origin : string) : Promise<number>
提供Web SQL数据库的使用信息。 提供Web SQL数据库的使用信息。
**参数：** **参数：**
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
|----------|----------|------|------| | ------ | ------ | ---- | ---------- |
| origin | string | 是 | 指定源的字符串索引。 | | origin | string | 是 | 指定源的字符串索引。 |
| usage | number | 是 | 指定源的存储量。 | | usage | number | 是 | 指定源的存储量。 |
| quota | number | 是 | 指定源的存储配额。 | | quota | number | 是 | 指定源的存储配额。 |
## MessageLevel枚举说明 ## MessageLevel枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| ----- | :--------- | | ----- | :---- |
| Debug | 调试级别。 | | Debug | 调试级别。 |
| Error | 错误级别。 | | Error | 错误级别。 |
| Info | 消息级别。 | | Info | 消息级别。 |
...@@ -3032,46 +3032,46 @@ static getOriginUsage(origin : string) : Promise<number> ...@@ -3032,46 +3032,46 @@ static getOriginUsage(origin : string) : Promise<number>
onRenderExited接口返回的渲染进程退出的具体原因。 onRenderExited接口返回的渲染进程退出的具体原因。
| 名称 | 描述 | | 名称 | 描述 |
| -------------------------- | ---------------------------- | | -------------------------- | ----------------- |
| ProcessAbnormalTermination | 渲染进程异常退出。 | | ProcessAbnormalTermination | 渲染进程异常退出。 |
| ProcessWasKilled | 收到SIGKILL，或被手动终止。 | | ProcessWasKilled | 收到SIGKILL，或被手动终止。 |
| ProcessCrashed | 渲染进程崩溃退出，如段错误。 | | ProcessCrashed | 渲染进程崩溃退出，如段错误。 |
| ProcessOom | 程序内存不足。 | | ProcessOom | 程序内存不足。 |
| ProcessExitUnknown | 其他原因。 | | ProcessExitUnknown | 其他原因。 |
## MixedMode枚举说明 ## MixedMode枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| ---------- | ----------------------------------------------------------- | | ---------- | ---------------------------------- |
| All | 允许加载HTTP和HTTPS混合内容。所有不安全的内容都可以被加载。 | | All | 允许加载HTTP和HTTPS混合内容。所有不安全的内容都可以被加载。 |
| Compatible | 混合内容兼容性模式，部分不安全的内容可能被加载。 | | Compatible | 混合内容兼容性模式，部分不安全的内容可能被加载。 |
| None | 不允许加载HTTP和HTTPS混合内容。 | | None | 不允许加载HTTP和HTTPS混合内容。 |
## CacheMode枚举说明 ## CacheMode枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| ------- | ------------------------------------------------------------ | | ------- | ------------------------------------ |
| Default | 使用未过期的cache加载资源，如果cache中无该资源则从网络中获取。 | | Default | 使用未过期的cache加载资源，如果cache中无该资源则从网络中获取。 |
| None | 加载资源使用cache，如果cache中无该资源则从网络中获取。 | | None | 加载资源使用cache，如果cache中无该资源则从网络中获取。 |
| Online | 加载资源不使用cache，全部从网络中获取。 | | Online | 加载资源不使用cache，全部从网络中获取。 |
| Only | 只从cache中加载资源。 | | Only | 只从cache中加载资源。 |
## FileSelectorMode枚举说明 ## FileSelectorMode枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------------------- | -------------------- | | -------------------- | ---------- |
| FileOpenMode | 打开上传单个文件。 | | FileOpenMode | 打开上传单个文件。 |
| FileOpenMultipleMode | 打开上传多个文件。 | | FileOpenMultipleMode | 打开上传多个文件。 |
| FileOpenFolderMode | 打开上传文件夹模式。 | | FileOpenFolderMode | 打开上传文件夹模式。 |
| FileSaveMode | 文件保存模式。 | | FileSaveMode | 文件保存模式。 |
## HitTestType枚举说明 ## HitTestType枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| ------------- | ----------------------------------------- | | ------------- | ------------------------ |
| EditText | 可编辑的区域。 | | EditText | 可编辑的区域。 |
| Email | 电子邮件地址。 | | Email | 电子邮件地址。 |
| HttpAnchor | 超链接，其src为http。 | | HttpAnchor | 超链接，其src为http。 |
| HttpAnchorImg | 带有超链接的图片，其中超链接的src为http。 | | HttpAnchorImg | 带有超链接的图片，其中超链接的src为http。 |
| Img | HTML::img标签。 | | Img | HTML::img标签。 |
| Map | 地理地址。 | | Map | 地理地址。 |
| Unknown | 未知内容。 | | Unknown | 未知内容。 |
\ No newline at end of file \ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或