From 3edefcf10000addfd755d191ad77d584525d08e0 Mon Sep 17 00:00:00 2001 From: liujinwei Date: Wed, 9 Mar 2022 22:17:31 +0800 Subject: [PATCH] add web Signed-off-by: liujinwei Change-Id: I49117fade29106037fc683511fd8bff59e3b9391 --- .../arkui-ts/ts-basic-components-web.md | 88 +++++++++++++++++-- 1 file changed, 80 insertions(+), 8 deletions(-) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md index 566d3b6012..3373cce20b 100755 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md @@ -61,15 +61,32 @@ ohos.permission.READ_USER_STORAGE 通用事件仅支持onFocus。 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | | onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void) |

下载开始时触发该回调。
url：Web引擎返回的下载URL。
userAgent：Web引擎返回的用户代理名称。
contentDisposition：Web引擎返回的响应头。
mimetype：Web引擎返回的mimetype信息。
contentLength：Web引擎返回的内容长度。

| -| onGeolocationHide(callback: () => void) |

调用onGeolocationShow时发出的地理位置权限请求被取消后触发该回调。

| +| onGeolocationHide(callback: () => void) |

调用onGeolocationShow时发出的地理位置权限请求被取消后触发该回调。

| | onGeolocationShow(callback: (event?: { origin: string, geolocation: JsGeolocation }) => void) |

应用尝试使用地理位置时触发该回调，并向用户请求权限。
origin：尝试获取地理位置的Web内容的来源。
geolocation：用于请求地理位置权限。

| -| onPageBegin(callback: (event?: { url: string }) => void) |

网页加载时触发该回调。
url：Web引擎返回的URL。

| -| onPageEnd(callback: (event?: { url: string }) => void) |

网页加载结束时触发该回调。
url：Web引擎返回的URL。

| +| onPageBegin(callback: (event?: { url: string }) => void) |

网页加载时触发该回调。
url：Web引擎返回的URL。

| +| onPageEnd(callback: (event?: { url: string }) => void) |

网页加载结束时触发该回调。
url：Web引擎返回的URL。

| | onProgressChange(callback: (event?: { newProgress: number }) => void) |

网页加载进度变化时触发该回调。
newProgress：加载进度，取值范围为0到100的整数。

| -| onTitleReceive(callback: (event?: { title: string }) => void) |

网页主页面标题更改时触发该回调。
title：标题内容。

| +| onTitleReceive(callback: (event?: { title: string }) => void) |

网页主页面标题更改时触发该回调。
title：标题内容。

| +| onErrorReceive(callback: (event?: { request: WebResourceRequest, error: WebResourceError }) => void) |

网页加载错误时触发该回调。
request：网页的请求信息。
error：网页的错误信息 。

| +| onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: WebResourceResponse }) => void) |

网页加载出现网络错误时触发该回调。
request：网页的请求信息。
response：网页的响应信息

| +| onConsole(callback: (event?: { message: ConsoleMessage }) => boolean) |

向主应用报告JavaScript控制台消息时触发该回调。
message：触发的控制台信息。

| +| onAlert(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

网页触发alert()告警弹窗时触发。
url：Web引擎返回的下载URL。
message：Web引擎返回的信息。
JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。

| +| onBeforeUnload(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

网页重新加载或关闭时触发。
url：Web引擎返回的下载URL。
message：Web引擎返回的信息。
JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。

| +| onConfirm(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

即将离开当前页面（刷新或关闭）时触发。
url：Web引擎返回的下载URL。
message：Web引擎返回的信息。
JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。

| + +### JsResult 对象说明 + +Web引擎返回的弹窗确认或弹窗取消功能对象。 + +- 接口 + + | 接口名称 | 功能描述 | + | --------------------- | ----------------- | + | handleCancel(): void |

取消弹窗。

| + | handleConfirm(): void |

确认弹窗。

| ### JsGeolocation 对象说明 @@ -77,10 +94,65 @@ ohos.permission.READ_USER_STORAGE - 接口 - | 接口名称 | 功能描述 | - | ---------------------------------------- | ---------------------------------------- | + | 接口名称 | 功能描述 | + | ------------------------------------------------------------ | ------------------------------------------------------------ | | invoke(origin: string, allow: boolean, retain: boolean): void |

通知系统用户是否批准该应用使用地理位置权限。
origin：尝试获取地理位置的Web内容的来源。
allow：用户是否批准该应用使用地理位置权限。true: 允许访问，false: 不允许访问。
retain：是否允许将地理位置权限状态保存到系统中。true: 允许，false: 不允许。

| +### WebResourceRequest对象说明 + +- 接口 + + | 接口名称 | 功能描述 | + | --------------------------------- | ------------------------------------ | + | getRequestUrl(): string | 获取请求的url信息。 | + | isRequestGesture(): boolean | 获取请求是否与手势关联。 | + | isMainFrame(): boolean | 获取请求是否时为了获取主窗口的信息。 | + | isRedirect(): boolean | 获取请求是否重定向。 | + | getRequestHeader(): Array
| 获取请求头信息。 | + +### WebResourceError对象说明 + +- 接口 + + | 接口名称 | 功能描述 | + | ---------------------- | ------------------------ | + | getErrorInfo(): string | 获取加载资源的错误信息。 | + | getErrorCode(): number | 获取加载资源的错误码。 | + +### WebResourceResponse对象说明 + +- 接口 + + | 接口名称 | 功能描述 | + | ---------------------------------- | ---------------------- | + | getResponseData(): string | 获取响应数据。 | + | getResponseEncoding(): string | 获取响应的编码。 | + | getResponseMimeType(): string | 获取响应的MIME类型。 | + | getResponseCode(): number | 获取响应的状态码。 | + | getReasonMessage(): string | 获取响应的状态码描述。 | + | getResponseHeader(): Array
| 获取响应头信息。 | + +### ConsoleMessage对象说明 + +- 接口 + + | 接口名称 | 功能描述 | + | ------------------------------- | ------------------------------ | + | getMessage(): string | 获取ConsoleMessage的日志信息。 | + | getSourceId(): string | 获取ConsoleMessage的源的Id。 | + | getLineNumber(): number | 获取ConsoleMessage的行数。 | + | getMessageLevel(): MessageLevel | 获取ConsoleMessage的信息级别。 | + +- MessageLevel枚举说明 + + | 名称 | 描述 | + | ----- | :--------- | + | Debug | 调试级别。 | + | Error | 错误级别。 | + | Info | 消息级别。 | + | Log | 日志级别。 | + | Warn | 警告级别。 | + ## WebController Web 组件的控制器。 -- GitLab