From 51d3ad1269a0b43c75c1fabca5cb8cdd799dc38a Mon Sep 17 00:00:00 2001 From: jackd320 Date: Tue, 1 Mar 2022 12:15:22 +0000 Subject: [PATCH] update zh-cn/application-dev/reference/apis/js-apis-update.md. Signed-off-by: jackd320 --- .../reference/apis/js-apis-update.md | 98 +++++++++++++------ 1 file changed, 67 insertions(+), 31 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-update.md b/zh-cn/application-dev/reference/apis/js-apis-update.md index 96153284d2..b0f789003d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-update.md +++ b/zh-cn/application-dev/reference/apis/js-apis-update.md @@ -25,6 +25,8 @@ getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater 获取本地升级Updater。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -54,6 +56,8 @@ getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes 获取升级对象给待升级设备。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -84,6 +88,8 @@ getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateType 获取其它设备为本设备升级的Updater。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -116,6 +122,8 @@ getNewVersionInfo(callback: AsyncCallback\): void 获取新版本信息,使用callback方式作为异步方法。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -139,6 +147,8 @@ getNewVersionInfo(): Promise\ 获取新版本信息,使用promise方式作为异步方法。 +**系统能力**:SystemCapability.Updater.update_service + **返回值:** | 类型 | 说明 | @@ -163,6 +173,8 @@ checkNewVersion(callback: AsyncCallback\): void 检查新版本,使用callback方式作为异步方法。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -186,6 +198,8 @@ checkNewVersion(): Promise\ 检查新版本,使用promise方式作为异步方法。 +**系统能力**:SystemCapability.Updater.update_service + **返回值:** | 类型 | 说明 | @@ -210,6 +224,8 @@ verifyUpdatePackage(upgradeFile: string, certsFile: string): void 升级前检查升级包是否有效。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -232,6 +248,8 @@ rebootAndCleanUserData(): Promise\ 重启设备并清除用户分区数据。 +**系统能力**:SystemCapability.Updater.update_service + **返回值:** | 类型 | 说明 | @@ -254,6 +272,8 @@ rebootAndCleanUserData(callback: AsyncCallback\): void 重启设备并清除用户分区数据。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -274,6 +294,8 @@ applyNewVersion(): Promise\ 重启设备后安装升级包。 +**系统能力**:SystemCapability.Updater.update_service + **返回值:** | 类型 | 说明 | @@ -296,6 +318,8 @@ applyNewVersion(callback: AsyncCallback\): void 重启设备后安装升级包。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -316,6 +340,8 @@ download(): void 下载新版本,并监听下载进程。 +**系统能力**:SystemCapability.Updater.update_service + **示例:** ``` @@ -333,6 +359,8 @@ updater.upgrade():void 启动升级。 +**系统能力**:SystemCapability.Updater.update_service + **示例:** ``` @@ -350,6 +378,8 @@ setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\): void 设置升级策略,使用callback方式作为异步方法。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -379,6 +409,8 @@ setUpdatePolicy(policy: UpdatePolicy): Promise\ 设置升级策略,使用promise方式作为异步方法。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -414,6 +446,8 @@ getUpdatePolicy(callback: AsyncCallback\): void 获取升级策略信息,使用callback方式作为异步方法。 +**系统能力**:SystemCapability.Updater.update_service + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -437,6 +471,8 @@ getUpdatePolicy(): Promise\ 获取升级策略,通过promise方式作为异步方法。 +**系统能力**:SystemCapability.Updater.update_service + **返回值:** | 类型 | 说明 | @@ -461,8 +497,8 @@ update.getUpdatePolicy().then(value => { | 参数名 | 说明 | | ------ | -------- | -| OTA | OTA升级 | -| patch | 补丁升级 | +| OTA | OTA升级
**系统能力**:SystemCapability.Updater.update_service| +| patch | 补丁升级
**系统能力**:SystemCapability.Updater.update_service| ## PackageTypes @@ -470,13 +506,13 @@ update.getUpdatePolicy().then(value => { | 参数名 | 默认值 | 说明 | | -------------------- | ------ | -------------- | -| PACKAGE_TYPE_NORMAL | 1 | 通用升级包 | -| PACKAGE_TYPE_BASE | 2 | 基础升级包 | -| PACKAGE_TYPE_CUST | 3 | 定制升级包 | -| PACKAGE_TYPE_PRELOAD | 4 | 预装升级包 | -| PACKAGE_TYPE_COTA | 5 | 参数配置升级包 | -| PACKAGE_TYPE_VERSION | 6 | 版本升级包 | -| PACKAGE_TYPE_PATCH | 7 | 补丁包 | +| PACKAGE_TYPE_NORMAL | 1 | 通用升级包
**系统能力**:SystemCapability.Updater.update_service| +| PACKAGE_TYPE_BASE | 2 | 基础升级包
**系统能力**:SystemCapability.Updater.update_service| +| PACKAGE_TYPE_CUST | 3 | 定制升级包
**系统能力**:SystemCapability.Updater.update_service| +| PACKAGE_TYPE_PRELOAD | 4 | 预装升级包
**系统能力**:SystemCapability.Updater.update_service| +| PACKAGE_TYPE_COTA | 5 | 参数配置升级包
**系统能力**:SystemCapability.Updater.update_service| +| PACKAGE_TYPE_VERSION | 6 | 版本升级包
**系统能力**:SystemCapability.Updater.update_service| +| PACKAGE_TYPE_PATCH | 7 | 补丁包
**系统能力**:SystemCapability.Updater.update_service| ## InstallMode @@ -484,9 +520,9 @@ update.getUpdatePolicy().then(value => { | 参数名 | 默认值 | 说明 | | ------------------- | ------ | -------- | -| INSTALL_MODE_NORMAL | 0 | 正常升级 | -| INSTALL_MODE_NIGHT | 1 | 夜间升级 | -| INSTALL_MODE_AUTO | 2 | 自动升级 | +| INSTALL_MODE_NORMAL | 0 | 正常升级
**系统能力**:SystemCapability.Updater.update_service| +| INSTALL_MODE_NIGHT | 1 | 夜间升级
**系统能力**:SystemCapability.Updater.update_service| +| INSTALL_MODE_AUTO | 2 | 自动升级
**系统能力**:SystemCapability.Updater.update_service| ## NewVersionStatus @@ -494,10 +530,10 @@ update.getUpdatePolicy().then(value => { | 参数名 | 默认值 | 说明 | | ------------------- | ------ | ---------------- | -| VERSION_STATUS_ERR | -1 | 检测版本时出错 | -| VERSION_STATUS_NEW | 0 | 检测到新版本 | -| VERSION_STATUS_NONE | 1 | 没有检测到新版本 | -| VERSION_STATUS_BUSY | 2 | 检测版本时忙 | +| VERSION_STATUS_ERR | -1 | 检测版本时出错
**系统能力**:SystemCapability.Updater.update_service| +| VERSION_STATUS_NEW | 0 | 检测到新版本
**系统能力**:SystemCapability.Updater.update_service| +| VERSION_STATUS_NONE | 1 | 没有检测到新版本
**系统能力**:SystemCapability.Updater.update_service| +| VERSION_STATUS_BUSY | 2 | 检测版本时忙
**系统能力**:SystemCapability.Updater.update_service| ## UpdatePolicy @@ -505,9 +541,9 @@ update.getUpdatePolicy().then(value => { | 名称 | 参数类型 | 必填 | 说明 | | ------------------- | --------------------------- | ---- | -------------- | -| autoDownload | bool | 是 | 自动升级开关 | -| installMode | [InstallMode](#installmode) | 是 | 安装模式 | -| autoUpgradeInterval | Array\ | 是 | 自动升级时间段 | +| autoDownload | bool | 是 | 自动升级开关
**系统能力**:SystemCapability.Updater.update_service| +| installMode | [InstallMode](#installmode) | 是 | 安装模式
**系统能力**:SystemCapability.Updater.update_service| +| autoUpgradeInterval | Array\ | 是 | 自动升级时间段
**系统能力**:SystemCapability.Updater.update_service| ## NewVersionInfo @@ -515,10 +551,10 @@ update.getUpdatePolicy().then(value => { | 名称 | 参数类型 | 必填 | 说明 | | --------------- | ------------------------------------------- | ---- | -------- | -| status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态 | -| errMsg | string | 是 | 错误信息 | -| checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果 | -| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | 是 | 描述信息 | +| status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态
**系统能力**:SystemCapability.Updater.update_service| +| errMsg | string | 是 | 错误信息
**系统能力**:SystemCapability.Updater.update_service| +| checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果
**系统能力**:SystemCapability.Updater.update_service| +| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | 是 | 描述信息
**系统能力**:SystemCapability.Updater.update_service| ## CheckResult @@ -526,12 +562,12 @@ update.getUpdatePolicy().then(value => { | 名称 | 参数类型 | 必填 | 说明 | | ------------- | ----------------------------- | ---- | ------------ | -| versionName | string | 是 | 版本名称 | -| versionCode | number | 是 | 版本编码 | -| size | number | 是 | 版本大小 | -| verifyInfo | string | 是 | 版本校验信息 | -| packageType | [PackageTypes](#packagetypes) | 是 | 版本类型 | -| descriptionId | string | 是 | 版本描述信息 | +| versionName | string | 是 | 版本名称
**系统能力**:SystemCapability.Updater.update_service| +| versionCode | number | 是 | 版本编码
**系统能力**:SystemCapability.Updater.update_service| +| size | number | 是 | 版本大小
**系统能力**:SystemCapability.Updater.update_service| +| verifyInfo | string | 是 | 版本校验信息
**系统能力**:SystemCapability.Updater.update_service| +| packageType | [PackageTypes](#packagetypes) | 是 | 版本类型
**系统能力**:SystemCapability.Updater.update_service| +| descriptionId | string | 是 | 版本描述信息
**系统能力**:SystemCapability.Updater.update_service| ## DescriptionInfo @@ -539,5 +575,5 @@ update.getUpdatePolicy().then(value => { | 名称 | 参数类型 | 必填 | 说明 | | ------------- | -------- | ---- | ----------------- | -| descriptionId | string | 是 | 版本versionId信息 | -| content | string | 是 | 版本changelog信息 | \ No newline at end of file +| descriptionId | string | 是 | 版本versionId信息
**系统能力**:SystemCapability.Updater.update_service| +| content | string | 是 | 版本changelog信息
**系统能力**:SystemCapability.Updater.update_service| \ No newline at end of file -- GitLab