From 84275654ff2aa1b78c5419ed10d124aae271d130 Mon Sep 17 00:00:00 2001 From: laosan_ted Date: Fri, 18 Nov 2022 17:24:59 +0800 Subject: [PATCH] fix webview docs problem Signed-off-by: laosan_ted --- .../reference/apis/js-apis-webview.md | 271 +++++++++--------- 1 file changed, 137 insertions(+), 134 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-webview.md b/zh-cn/application-dev/reference/apis/js-apis-webview.md index a31ccc4a1e..34e32a7810 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-webview.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webview.md @@ -68,9 +68,9 @@ postMessageEvent(message: string): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------- | ------ | ---- | ------ | :------------- | -| message | string | 是 | - | 要发送的消息。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | :------------- | +| message | string | 是 | 要发送的消息。 | **错误码**： @@ -120,9 +120,9 @@ onMessageEvent(callback: (result: string) => void): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| -------- | -------- | ---- | ------ | :------------------- | -| callback | function | 是 | - | 接收消息的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | ---- | :------------------- | +| callback | function | 是 | 接收消息的回调函数。 | **错误码**： @@ -196,10 +196,10 @@ loadUrl(url: string | Resource, headers?: Array\): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------- | ---------------- | ---- | ------ | :-------------------- | -| url | string | 是 | - | 需要加载的 URL。 | -| headers | Array\<[HeaderV9](#headerv9)> | 是 | - | URL的附加HTTP请求头。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------- | ---- | :-------------------- | +| url | string | 是 | 需要加载的 URL。 | +| headers | Array\<[HeaderV9](#headerv9)> | 否 | URL的附加HTTP请求头。 | **错误码**： @@ -248,13 +248,13 @@ loadData(data: string, mimeType: string, encoding: string, baseUrl?: string, his **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ---------- | ------ | ---- | ------ | ------------------------------------------------------------ | -| data | string | 是 | - | 按照”Base64“或者”URL"编码后的一段字符串。 | -| mimeType | string | 是 | - | 媒体类型（MIME）。 | -| encoding | string | 是 | - | 编码类型，具体为“Base64"或者”URL编码。 | -| baseUrl | string | 否 | - | 指定的一个URL路径（“http”/“https”/"data"协议），并由Web组件赋值给window.origin。 | -| historyUrl | string | 否 | - | 历史记录URL。非空时，可被历史记录管理，实现前进后退功能。当baseUrl为空时，此属性无效。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | ------------------------------------------------------------ | +| data | string | 是 | 按照”Base64“或者”URL"编码后的一段字符串。 | +| mimeType | string | 是 | 媒体类型（MIME）。 | +| encoding | string | 是 | 编码类型，具体为“Base64"或者”URL编码。 | +| baseUrl | string | 否 | 指定的一个URL路径（“http”/“https”/"data"协议），并由Web组件赋值给window.origin。 | +| historyUrl | string | 否 | 历史记录URL。非空时，可被历史记录管理，实现前进后退功能。当baseUrl为空时，此属性无效。 | **错误码**： @@ -263,6 +263,7 @@ loadData(data: string, mimeType: string, encoding: string, baseUrl?: string, his | 错误码ID | 错误信息 | | -------- | ------------------------------------------------------------ | | 17100001 | Init error. The WebviewController must be associated with a Web component. | +| 17100002 | Invalid url. | **示例：** @@ -619,9 +620,9 @@ accessStep(step: number): boolean **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | -------- | ---- | ------ | ------------------------------------------ | -| step | number | 是 | - | 要跳转的步数，正数代表前进，负数代表后退。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | -------- | ---- | ------------------------------------------ | +| step | number | 是 | 要跳转的步数，正数代表前进，负数代表后退。 | **返回值：** @@ -769,11 +770,11 @@ registerJavaScriptProxy(object: object, name: string, methodList: Array\ **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ---------- | -------------- | ---- | ------ | ------------------------------------------------------------ | -| object | object | 是 | - | 参与注册的应用侧JavaScript对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean | -| name | string | 是 | - | 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。 | -| methodList | Array\ | 是 | - | 参与注册的应用侧JavaScript对象的方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | -------------- | ---- | ------------------------------------------------------------ | +| object | object | 是 | 参与注册的应用侧JavaScript对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean | +| name | string | 是 | 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。 | +| methodList | Array\ | 是 | 参与注册的应用侧JavaScript对象的方法。 | **错误码：** @@ -829,10 +830,10 @@ runJavaScript(script: string, callback : AsyncCallback\): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------- | ------------------------ | ---- | ------ | ------------------------------------------------------------ | -| script | string | 是 | - | JavaScript脚本。 | -| callback | AsyncCallback\ | 否 | - | 回调执行JavaScript脚本结果。JavaScript脚本若执行失败或无返回值时，返回null。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ---------------------------- | +| script | string | 是 | JavaScript脚本。 | +| callback | AsyncCallback\ | 否 | 回调执行JavaScript脚本结果。JavaScript脚本若执行失败或无返回值时，返回null。 | **错误码：** @@ -892,9 +893,9 @@ runJavaScript(script: string): Promise\ **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | -------- | ---- | ------ | ---------------- | -| script | string | 是 | - | JavaScript脚本。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | -------- | ---- | ---------------- | +| script | string | 是 | JavaScript脚本。 | **返回值：** @@ -956,9 +957,9 @@ deleteJavaScriptRegister(name: string): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | -------- | ---- | ------ | ------------------------------------------------------------ | -| name | string | 是 | - | 注册对象的名称，可在网页侧JavaScript中通过此名称调用应用侧JavaScript对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | -------- | ---- | ---- | +| name | string | 是 | 注册对象的名称，可在网页侧JavaScript中通过此名称调用应用侧JavaScript对象。 | **错误码：** @@ -1007,7 +1008,7 @@ zoom(factor: number): void **参数：** -| 参数名 | 参数类型 | 必填 | 参数描述 | +| 参数名 | 类型 | 必填 | 说明 | | ------ | -------- | ---- | ------------------------------------------------------------ | | factor | number | 是 | 基于当前网页所需调整的相对缩放比例，正值为放大，负值为缩小。 | @@ -1155,9 +1156,9 @@ searchNext(forward: boolean): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | -------- | ---- | ------ | ---------------------- | -| forward | boolean | 是 | - | 从前向后或者逆向查找。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------- | ---- | ---------------------- | +| forward | boolean | 是 | 从前向后或者逆向查找。 | **错误码：** @@ -1341,11 +1342,11 @@ postMessage(name: string, ports: Array\, uri: string): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ---------------------- | ---- | ------ | :------------------------------- | -| name | string | 是 | - | 要发送的消息，包含数据和消息端口。 | -| ports | Array\ | 是 | - | 接收该消息的URI。 | -| uri | string | 是 | - | 接收该消息的URI。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------------- | ---- | :------------------------------- | +| name | string | 是 | 要发送的消息，包含数据和消息端口。 | +| ports | Array\ | 是 | 接收该消息的URI。 | +| uri | string | 是 | 接收该消息的URI。 | **错误码**： @@ -1855,7 +1856,7 @@ storeWebArchive(baseName: string, autoName: boolean, callback: AsyncCallback\ **参数：** -| 参数名 | 参数类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | ---- | ------------------------------------------------------------ | | baseName | string | 是 | 文件存储路径，该值不能为空。 | | autoName | boolean | 是 | 决定是否自动生成文件名。 如果为false，则将baseName作为文件存储路径。 如果为true，则假定baseName是一个目录，将根据当前页的Url自动生成文件名。 | @@ -2073,9 +2074,9 @@ backOrForward(step: number): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | -------- | ---- | ------ | ---------------------- | -| step | number | 是 | - | 需要前进或后退的步长。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | -------- | ---- | ---------------------- | +| step | number | 是 | 需要前进或后退的步长。 | **错误码**： @@ -2127,9 +2128,9 @@ static getCookie(url: string): string **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ------ | :------------------------ | -| url | string | 是 | - | 要获取的cookie所属的url。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | :------------------------ | +| url | string | 是 | 要获取的cookie所属的url。 | **返回值：** @@ -2140,6 +2141,7 @@ static getCookie(url: string): string **错误码**： 以下错误码的详细介绍请参见 [webview错误码](../errorcodes/errorcode-webview.md) + | 错误码ID | 错误信息 | | -------- | ------------------------------------------------------ | | 17100002 | Invalid url. | @@ -2182,10 +2184,10 @@ static setCookie(url: string, value: string): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ------ | :------------------------ | -| url | string | 是 | - | 要设置的cookie所属的url。 | -| value | string | 是 | - | 要设置的cookie的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | :------------------------ | +| url | string | 是 | 要设置的cookie所属的url。 | +| value | string | 是 | 要设置的cookie的值。 | **错误码**： @@ -2233,9 +2235,9 @@ static saveCookieAsync(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| -------- | ---------------------- | ---- | ------ | :------------------------------------------------- | -| callback | AsyncCallback\ | 是 | - | 返回cookie是否成功保存的布尔值作为回调函数的入参。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | :------------------------------------------------- | +| callback | AsyncCallback\ | 是 | 返回cookie是否成功保存的布尔值作为回调函数的入参。 | **示例：** @@ -2326,9 +2328,9 @@ static putAcceptCookieEnabled(accept: boolean): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------- | ---- | ------ | :----------------------------------- | -| accept | boolean | 是 | - | 设置是否拥有发送和接收cookie的权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | :----------------------------------- | +| accept | boolean | 是 | 设置是否拥有发送和接收cookie的权限。 | **示例：** @@ -2405,9 +2407,9 @@ static putAcceptThirdPartyCookieEnabled(accept: boolean): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------- | ---- | ------ | :----------------------------------------- | -| accept | boolean | 是 | - | 设置是否拥有发送和接收第三方cookie的权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | :----------------------------------------- | +| accept | boolean | 是 | 设置是否拥有发送和接收第三方cookie的权限。 | **示例：** @@ -2588,9 +2590,9 @@ static deleteOrigin(origin : string): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ------ | ------------------------ | -| origin | string | 是 | - | 指定源的字符串索引. | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------ | +| origin | string | 是 | 指定源的字符串索引. | **错误码：** @@ -2640,9 +2642,9 @@ static getOrigins(callback: AsyncCallback\>) : void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| -------- | -------------------------------------- | ---- | ------ | ------------------------------------------------------ | -| callback | AsyncCallback\> | 是 | - | 以数组方式返回源的信息，信息内容参考[WebStorageOrigin](#webstorageorigin)。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ------------------------------------------------------ | +| callback | AsyncCallback\> | 是 | 以数组方式返回源的信息，信息内容参考[WebStorageOrigin](#webstorageorigin)。 | **错误码：** @@ -2762,10 +2764,10 @@ static getOriginQuota(origin : string, callback : AsyncCallback\) : void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| -------- | --------------------- | ---- | ------ | ------------------ | -| origin | string | 是 | - | 指定源的字符串索引 | -| callback | AsyncCallback\ | 是 | - | 指定源的存储配额 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | ------------------ | +| origin | string | 是 | 指定源的字符串索引 | +| callback | AsyncCallback\ | 是 | 指定源的存储配额 | **错误码：** @@ -2821,9 +2823,9 @@ static getOriginQuota(origin : string) : Promise\ **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ------ | ------------------ | -| origin | string | 是 | - | 指定源的字符串索引 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------ | +| origin | string | 是 | 指定源的字符串索引 | **返回值：** @@ -2885,10 +2887,10 @@ static getOriginUsage(origin : string, callback : AsyncCallback\) : void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| -------- | --------------------- | ---- | ------ | ------------------ | -| origin | string | 是 | - | 指定源的字符串索引 | -| callback | AsyncCallback\ | 是 | - | 指定源的存储量。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | ------------------ | +| origin | string | 是 | 指定源的字符串索引 | +| callback | AsyncCallback\ | 是 | 指定源的存储量。 | **错误码：** @@ -2944,9 +2946,9 @@ static getOriginUsage(origin : string) : Promise\ **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ------ | ------------------ | -| origin | string | 是 | - | 指定源的字符串索引 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------ | +| origin | string | 是 | 指定源的字符串索引 | **返回值：** @@ -3048,10 +3050,10 @@ static getHttpAuthCredentials(host: string, realm: string): Array\ **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ------ | ---------------------------- | -| host | string | 是 | - | HTTP身份验证凭据应用的主机。 | -| realm | string | 是 | - | HTTP身份验证凭据应用的域。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------------------------- | +| host | string | 是 | HTTP身份验证凭据应用的主机。 | +| realm | string | 是 | HTTP身份验证凭据应用的域。 | **返回值：** @@ -3103,12 +3105,12 @@ static saveHttpAuthCredentials(host: string, realm: string, username: string, pa **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| -------- | ------ | ---- | ------ | ---------------------------- | -| host | string | 是 | - | HTTP身份验证凭据应用的主机。 | -| realm | string | 是 | - | HTTP身份验证凭据应用的域。 | -| username | string | 是 | - | 用户名。 | -| password | string | 是 | - | 密码。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ---------------------------- | +| host | string | 是 | HTTP身份验证凭据应用的主机。 | +| realm | string | 是 | HTTP身份验证凭据应用的域。 | +| username | string | 是 | 用户名。 | +| password | string | 是 | 密码。 | **示例：** @@ -3229,13 +3231,14 @@ static allowGeolocation(origin: string): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ------ | ------------------ | -| origin | string | 是 | - | 指定源的字符串索引 | +| 参数名 | 类型 | 说明 | +| ------ | ------ | ------------------ | +| origin | string | 指定源的字符串索引 | **错误码：** 以下错误码的详细介绍请参见 [webview错误码](../errorcodes/errorcode-webview.md) + | 错误码ID | 错误信息 | | -------- | ------------------------------------------------------ | | 17100011 | Invalid origin. | @@ -3278,9 +3281,9 @@ static deleteGeolocation(origin: string): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ------ | ------------------ | -| origin | string | 是 | - | 指定源的字符串索引 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------ | +| origin | string | 是 | 指定源的字符串索引 | **错误码：** @@ -3328,10 +3331,10 @@ static getAccessibleGeolocation(origin: string, callback: AsyncCallback\ | 是 | - | 返回指定源的地理位置权限状态。获取成功，true表示已授权，false表示拒绝访问。获取失败，表示不存在指定源的权限状态。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------------------------------------------------------ | +| origin | string | 是 | 指定源的字符串索引 | +| callback | AsyncCallback\ | 是 | 返回指定源的地理位置权限状态。获取成功，true表示已授权，false表示拒绝访问。获取失败，表示不存在指定源的权限状态。 | **错误码：** @@ -3385,9 +3388,9 @@ static getAccessibleGeolocation(origin: string): Promise\ **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | -------- | ---- | ------ | -------------------- | -| origin | string | 是 | - | 指定源的字符串索引。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | -------------------- | +| origin | string | 是 | 指定源的字符串索引。 | **返回值：** @@ -3446,9 +3449,9 @@ static getStoredGeolocation(callback: AsyncCallback\>): void **参数：** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| -------- | ---------------------------- | ---- | ------ | ---------------------------------------- | -| callback | AsyncCallback\> | 是 | - | 返回已存储地理位置权限状态的所有源信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | ---------------------------------------- | +| callback | AsyncCallback\> | 是 | 返回已存储地理位置权限状态的所有源信息。 | **示例：** @@ -3570,25 +3573,25 @@ Web组件返回的请求/响应头对象。 **系统能力：** SystemCapability.Web.Webview.Core -| 名称 | 类型 | 说明 | -| ----------- | ------ | :------------------- | -| headerKey | string | 请求/响应头的key。 | -| headerValue | string | 请求/响应头的value。 | +| 名称 | 类型 | 可读 | 可写 |说明 | +| ----------- | ------ | -----|------|------------------- | +| headerKey | string | 是 | 是 | 请求/响应头的key。 | +| headerValue | string | 是 | 是 | 请求/响应头的value。 | ## HitTestTypeV9 **系统能力：** SystemCapability.Web.Webview.Core -| 名称 | 描述 | -| ------------- | ----------------------------------------- | -| EditText | 可编辑的区域。 | -| Email | 电子邮件地址。 | -| HttpAnchor | 超链接，其src为http。 | -| HttpAnchorImg | 带有超链接的图片，其中超链接的src为http。 | -| Img | HTML::img标签。 | -| Map | 地理地址。 | -| Phone | 电话号码。 | -| Unknown | 未知内容。 | +| 名称 | 值 | 说明 | +| ------------- | -- |----------------------------------------- | +| EditText | 0 |可编辑的区域。 | +| Email | 1 |电子邮件地址。 | +| HttpAnchor | 2 |超链接，其src为http。 | +| HttpAnchorImg | 3 |带有超链接的图片，其中超链接的src为http。 | +| Img | 4 |HTML::img标签。 | +| Map | 5 |地理地址。 | +| Phone | 6 |电话号码。 | +| Unknown | 7 |未知内容。 | ## HitTestValue @@ -3596,10 +3599,10 @@ Web组件返回的请求/响应头对象。 **系统能力：** SystemCapability.Web.Webview.Core -| 名称 | 类型 | 说明 | -| ----- | ------------- | :----------------------------------------------------------- | -| type | [HitTestTypeV9](#hittesttypev9) | 当前被点击区域的元素类型。 | -| extra | string | 点击区域的附加参数信息。若被点击区域为图片或链接，则附加参数信息为其url地址。 | +| 名称 | 类型 | 可读 | 可写 | 说明| +| ---- | ---- | ---- | ---- |---- | +| type | [HitTestTypeV9](#hittesttypev9) | 是 | 否 | 当前被点击区域的元素类型。| +| extra | string | 是 | 否 |点击区域的附加参数信息。若被点击区域为图片或链接，则附加参数信息为其url地址。 | ## WebStorageOrigin @@ -3607,8 +3610,8 @@ Web组件返回的请求/响应头对象。 **系统能力：** SystemCapability.Web.Webview.Core -| 名称 | 类型 | 必填 | 说明 | -| ------ | ------ | :--- | -------------------- | -| origin | string | 是 | 指定源的字符串索引。 | -| usage | number | 是 | 指定源的存储量。 | -| quota | number | 是 | 指定源的存储配额。 | \ No newline at end of file +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------ | ------ | ---- | ---- | ---- | +| origin | string | 是 | 否 | 指定源的字符串索引。 | +| usage | number | 是 | 否 | 指定源的存储量。 | +| quota | number | 是 | 否 | 指定源的存储配额。 | \ No newline at end of file -- GitLab