diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 5edd49f2abb981dea8c044c50215136c8f40b1d1..d652de83b0cba314d03b800d727ad47bf6adfad8 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -1,4 +1,4 @@ -# 接口 +# 接口 - [开发说明](development-intro.md) @@ -260,7 +260,7 @@ - [@ohos.account.osAccount (系统帐号管理)](js-apis-osAccount.md) - 定制管理 - - [@ohos.configPolicy (配置策略)](js-apis-config-policy.md) + - [@ohos.configPolicy (配置策略)](js-apis-configPolicy.md) - [@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)](js-apis-EnterpriseAdminExtensionAbility.md) - [@ohos.enterprise.adminManager (企业设备管理)](js-apis-enterprise-adminManager.md) - [@ohos.enterprise.dateTimeManager（系统时间管理）](js-apis-enterprise-dateTimeManager.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-config-policy.md b/zh-cn/application-dev/reference/apis/js-apis-configPolicy.md similarity index 99% rename from zh-cn/application-dev/reference/apis/js-apis-config-policy.md rename to zh-cn/application-dev/reference/apis/js-apis-configPolicy.md index 03ba2c499362119c7206d46fcacddaab74e08130..043d3c5fd074fd52a97f814f18d3048848ccadcc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-config-policy.md +++ b/zh-cn/application-dev/reference/apis/js-apis-configPolicy.md @@ -24,6 +24,7 @@ getOneCfgFile(relPath: string, callback: AsyncCallback<string>) **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | --------------------- | | relPath | string | 是 | 配置文件名 | @@ -50,11 +51,13 @@ getOneCfgFile(relPath: string): Promise<string> **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ----- | | relPath | string | 是 | 配置文件名 | **返回值：** + | 类型 | 说明 | | --------------------- | ------------ | | Promise<string> | 最高优先级配置文件的路径 | @@ -79,6 +82,7 @@ getCfgFiles(relPath: string, callback: AsyncCallback<Array<string>>) **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------- | | relPath | string | 是 | 配置文件名 | @@ -105,11 +109,13 @@ getCfgFiles(relPath: string): Promise<Array<string>> **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ----- | | relPath | string | 是 | 配置文件名 | **返回值：** + | 类型 | 说明 | | ---------------------------------- | ---- | | Promise<Array<string>> | 文件列表 | @@ -133,6 +139,7 @@ getCfgDirList(callback: AsyncCallback<Array<string>>) **系统能力**：SystemCapability.Customization.ConfigPolicy **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------------- | | callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回配置层级目录列表 | @@ -158,6 +165,7 @@ getCfgDirList(): Promise<Array<string>> **系统能力**：SystemCapability.Customization.ConfigPolicy **返回值：** + | 类型 | 说明 | | ---------------------------------- | -------- | | Promise<Array<string>> | 配置层级目录列表 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-request.md b/zh-cn/application-dev/reference/apis/js-apis-request.md index a96c64782159fda2bc0daeef2ed413709dce7acb..102a5d57dfbe6182e88217ac4823120bf6a7353c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -132,7 +132,7 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | - | callback | AsyncCallback<[UploadTask](#uploadtask)> | 否 | 回调函数，异步返回UploadTask对象。 | + | callback | AsyncCallback<[UploadTask](#uploadtask)> | 是 | 回调函数，异步返回UploadTask对象。 | **示例：** @@ -216,7 +216,7 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up | -------- | -------- | -------- | -------- | | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | - | callback | AsyncCallback<[UploadTask](#uploadtask)> | 否 | 回调函数，异步返回UploadTask对象。 | + | callback | AsyncCallback<[UploadTask](#uploadtask)> | 是 | 回调函数，异步返回UploadTask对象。 | **示例：** @@ -305,7 +305,7 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l | -------- | -------- | -------- | -------- | | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | -| callback | AsyncCallback<[UploadTask](#uploadtask)> | 否 | 回调函数，异步返回UploadTask对象。 | +| callback | AsyncCallback<[UploadTask](#uploadtask)> | 是 | 回调函数，异步返回UploadTask对象。 | **错误码：** 以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 @@ -708,7 +708,7 @@ delete(callback: AsyncCallback<boolean>): void | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | url | string | 是 | 资源地址。 | -| header | object | 是 | 添加要包含在上载请求中的HTTP或HTTPS标志头。 | +| header | Object | 是 | 添加要包含在上载请求中的HTTP或HTTPS标志头。 | | method | string | 是 | 请求方法：POST、PUT。缺省为POST。 | | files | Array<[File](#file)> | 是 | 要上传的文件列表。请使用 multipart/form-data提交。 | | data | Array<[RequestData](#requestdata)> | 是 | 请求的表单数据。 | @@ -808,7 +808,7 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | - | callback | AsyncCallback<[DownloadTask](#downloadtask)> | 否 | 下载接口的回调函数。 | + | callback | AsyncCallback<[DownloadTask](#downloadtask)> | 是 | 下载接口的回调函数。 | **示例：** @@ -879,7 +879,7 @@ download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback&l | -------- | -------- | -------- | -------- | | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | - | callback | AsyncCallback<[DownloadTask](#downloadtask)> | 否 | 下载接口的回调函数。 | + | callback | AsyncCallback<[DownloadTask](#downloadtask)> | 是 | 下载接口的回调函数。 | **示例：** @@ -956,7 +956,7 @@ downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallba | -------- | -------- | -------- | -------- | | context | BaseContext | 是 | 基于应用程序的上下文。 | | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | -| callback | AsyncCallback<[DownloadTask](#downloadtask)> | 否 | 下载接口的回调函数。 | +| callback | AsyncCallback<[DownloadTask](#downloadtask)> | 是 | 下载接口的回调函数。 | **错误码：** 以下错误码的详细介绍请参见[上传下载错误码](../errorcodes/errorcode-request.md)。 @@ -1839,7 +1839,7 @@ restore(callback: AsyncCallback<boolean>): void | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | url | string | 是 | 资源地址。 | -| header | object | 否 | 添加要包含在下载请求中的HTTPS标志头。
开发者可以通过header的X-TLS-Version参数指定需要使用的TLS版本(如果不指定，则默认使用CURL_SSLVERSION_TLSv1_2版本，指定则使用指定版本。)
CURL_SSLVERSION_TLSv1_0
CURL_SSLVERSION_TLSv1_1
CURL_SSLVERSION_TLSv1_2
CURL_SSLVERSION_TLSv1_3
通过header的X-Cipher-List参数指定需要使用的密码套件(如果不指定，则默认使用安全密码套件，指定则使用指定密码套件。)
-1.2允许使用的密码套件白名单：
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_256_GCM_SHA384,
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256,TLS_DSS_RSA_WITH_AES_256_GCM_SHA384,
TLS_PSK_WITH_AES_256_GCM_SHA384,TLS_DHE_PSK_WITH_AES_128_GCM_SHA256,
TLS_DHE_PSK_WITH_AES_256_GCM_SHA384,TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256,
TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256,TLS_ECDHE_PSK_WITH_AES_256_GCM_SHA384,
TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_128_CCM,
TLS_DHE_RSA_WITH_AES_256_CCM,TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256,
TLS_PSK_WITH_AES_256_CCM,TLS_DHE_PSK_WITH_AES_128_CCM,
TLS_DHE_PSK_WITH_AES_256_CCM,TLS_ECDHE_ECDSA_WITH_AES_128_CCM,
TLS_ECDHE_ECDSA_WITH_AES_256_CCM,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
-1.3允许使用的密码套件白名单：
TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256,TLS_AES_128_CCM_SHA256
-1.3新增国密算法套：
TLS_SM4_GCM_SM3,TLS_SM4_CCM_SM3 | +| header | Object | 否 | 添加要包含在下载请求中的HTTPS标志头。
开发者可以通过header的X-TLS-Version参数指定需要使用的TLS版本(如果不指定，则默认使用CURL_SSLVERSION_TLSv1_2版本，指定则使用指定版本。)
CURL_SSLVERSION_TLSv1_0
CURL_SSLVERSION_TLSv1_1
CURL_SSLVERSION_TLSv1_2
CURL_SSLVERSION_TLSv1_3
通过header的X-Cipher-List参数指定需要使用的密码套件(如果不指定，则默认使用安全密码套件，指定则使用指定密码套件。)
-1.2允许使用的密码套件白名单：
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_256_GCM_SHA384,
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256,TLS_DSS_RSA_WITH_AES_256_GCM_SHA384,
TLS_PSK_WITH_AES_256_GCM_SHA384,TLS_DHE_PSK_WITH_AES_128_GCM_SHA256,
TLS_DHE_PSK_WITH_AES_256_GCM_SHA384,TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256,
TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256,TLS_ECDHE_PSK_WITH_AES_256_GCM_SHA384,
TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_128_CCM,
TLS_DHE_RSA_WITH_AES_256_CCM,TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256,
TLS_PSK_WITH_AES_256_CCM,TLS_DHE_PSK_WITH_AES_128_CCM,
TLS_DHE_PSK_WITH_AES_256_CCM,TLS_ECDHE_ECDSA_WITH_AES_128_CCM,
TLS_ECDHE_ECDSA_WITH_AES_256_CCM,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
-1.3允许使用的密码套件白名单：
TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256,TLS_AES_128_CCM_SHA256
-1.3新增国密算法套：
TLS_SM4_GCM_SM3,TLS_SM4_CCM_SM3 | | enableMetered | boolean | 否 | 设置是否允许在按流量计费的连接下下载。
- true：是
- false：否 | | enableRoaming | boolean | 否 | 设置是否允许在漫游网络中下载。
- true：是
- false：否| | description | string | 否 | 设置下载会话的描述。 | diff --git a/zh-cn/application-dev/ui/ui-ts-components-web.md b/zh-cn/application-dev/ui/ui-ts-components-web.md index 6f4acc31caca52b4bab2e97e9913922dd86904fa..884066df04728957cacc39ab5c1263d003519ced 100644 --- a/zh-cn/application-dev/ui/ui-ts-components-web.md +++ b/zh-cn/application-dev/ui/ui-ts-components-web.md @@ -151,6 +151,38 @@ struct WebComponent { ``` + +## 开启网页调试 +在PC上启用端口转发，以及设置Web组件属性webDebuggingAccess为true后，便可以在PC上调试通过USB连接的开发设备上的Web组件里的网页。 + +设置步骤如下： + +1、首先设置Web组件属性webDebuggingAccess为true。 + ```ts + // xxx.ets + @Entry + @Component + struct WebComponent { + controller: WebController = new WebController() + build() { + Column() { + Web({ src: 'www.example.com', controller: this.controller }) + .webDebuggingAccess(true) // true表示启用调试功能 + } + } + } + ``` + +2、PC上启用端口转发功能，添加TCP端口9222映射。 + ```ts + hdc fport tcp:9222 tcp:9222 + ``` + 添加是否成功可以通过如下命令来查看已存在的映射关系表。 + ```ts + hdc fport ls + ``` +如上设置完成后，首先打开应用Web组件、访问要调试的网页，然后在PC上使用chrome浏览器访问：http://localhost:9222, 就可以在PC上调试开发设备刚才访问的网页。 + ## 场景示例 该场景实现了Web组件中视频的动态播放。首先在HTML页面内嵌入视频资源，再使用Web组件的控制器调用onActive和onInactive方法激活和暂停页面渲染。点击onInactive按钮，Web页面停止渲染，视频暂停播放；点击onActive按钮，激活Web组件，视频继续播放。