Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 62986c67 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1919 syscap刷新 

Merge pull request !1919 from liangZ15/master
上级 63790e5d 239c593f
隐藏空白更改
内联 并排
Showing with 71 addition and 54 deletion
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @ 62986c67
# 升级
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
升级范围：升级整个系统，包括内置的资源、预置应用；第三方的应用不在升级的范围。
升级依赖：升级分为SD卡升级和在线升级两种。
......@@ -17,15 +20,13 @@ import update from '@ohos.update'
无
## 获取升级对象Updater
### update.getUpdater
## update.getUpdater
getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater
获取本地升级Updater。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -50,13 +51,13 @@ try {
}
```
### update.getUpdaterForOther
## update.getUpdaterForOther
getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater
获取升级对象给待升级设备。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -82,13 +83,13 @@ try {
}
```
### update.getUpdaterFromOther
## update.getUpdaterFromOther
getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater
获取其它设备为本设备升级的Updater。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -122,7 +123,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
获取新版本信息，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -147,7 +148,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
获取新版本信息，使用promise方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**返回值：**
......@@ -173,7 +174,7 @@ checkNewVersion(callback: AsyncCallback\<NewVersionInfo>): void
检查新版本，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -198,7 +199,7 @@ checkNewVersion(): Promise\<NewVersionInfo>
检查新版本，使用promise方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**返回值:**
......@@ -224,7 +225,7 @@ verifyUpdatePackage(upgradeFile: string, certsFile: string): void
升级前检查升级包是否有效。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -248,7 +249,7 @@ rebootAndCleanUserData(): Promise\<number>
重启设备并清除用户分区数据。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**返回值：**
......@@ -272,7 +273,7 @@ rebootAndCleanUserData(callback: AsyncCallback\<number>): void
重启设备并清除用户分区数据。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -294,7 +295,7 @@ applyNewVersion(): Promise\<number>
重启设备后安装升级包。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**返回值：**
......@@ -318,7 +319,7 @@ applyNewVersion(callback: AsyncCallback\<number>): void
重启设备后安装升级包。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -340,7 +341,7 @@ download(): void
下载新版本，并监听下载进程。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**示例：**
......@@ -359,7 +360,7 @@ updater.upgrade():void
启动升级。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**示例：**
......@@ -378,7 +379,7 @@ setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\<number>): void
设置升级策略，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -409,7 +410,7 @@ setUpdatePolicy(policy: UpdatePolicy): Promise\<number>
设置升级策略，使用promise方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -446,7 +447,7 @@ getUpdatePolicy(callback: AsyncCallback\<UpdatePolicy>): void
获取升级策略信息，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**参数：**
......@@ -471,7 +472,7 @@ getUpdatePolicy(): Promise\<UpdatePolicy>
获取升级策略，通过promise方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**系统能力**：SystemCapability.Update.UpdateService
**返回值：**
......@@ -495,85 +496,101 @@ update.getUpdatePolicy().then(value => {
升级类型。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 说明 |
| ------ | -------- |
| OTA | OTA升级 <br/>**系统能力**：SystemCapability.Updater.update_service|
| patch | 补丁升级 <br/>**系统能力**：SystemCapability.Updater.update_service|
| OTA | OTA升级 |
| patch | 补丁升级 |
## PackageTypes
升级包类型。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| -------------------- | ------ | -------------- |
| PACKAGE_TYPE_NORMAL | 1 | 通用升级包 <br/>**系统能力**：SystemCapability.Updater.update_service|
| PACKAGE_TYPE_BASE | 2 | 基础升级包 <br/>**系统能力**：SystemCapability.Updater.update_service|
| PACKAGE_TYPE_CUST | 3 | 定制升级包 <br/>**系统能力**：SystemCapability.Updater.update_service|
| PACKAGE_TYPE_PRELOAD | 4 | 预装升级包 <br/>**系统能力**：SystemCapability.Updater.update_service|
| PACKAGE_TYPE_COTA | 5 | 参数配置升级包 <br/>**系统能力**：SystemCapability.Updater.update_service|
| PACKAGE_TYPE_VERSION | 6 | 版本升级包 <br/>**系统能力**：SystemCapability.Updater.update_service|
| PACKAGE_TYPE_PATCH | 7 | 补丁包 <br/>**系统能力**：SystemCapability.Updater.update_service|
| 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 | 补丁包 |
## InstallMode
安装模式。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ------ | -------- |
| INSTALL_MODE_NORMAL | 0 | 正常升级 <br/>**系统能力**：SystemCapability.Updater.update_service|
| INSTALL_MODE_NIGHT | 1 | 夜间升级 <br/>**系统能力**：SystemCapability.Updater.update_service|
| INSTALL_MODE_AUTO | 2 | 自动升级 <br/>**系统能力**：SystemCapability.Updater.update_service|
| INSTALL_MODE_NORMAL | 0 | 正常升级 |
| INSTALL_MODE_NIGHT | 1 | 夜间升级 |
| INSTALL_MODE_AUTO | 2 | 自动升级 |
## NewVersionStatus
新版本检测状态。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ------ | ---------------- |
| VERSION_STATUS_ERR | -1 | 检测版本时出错 <br/>**系统能力**：SystemCapability.Updater.update_service|
| VERSION_STATUS_NEW | 0 | 检测到新版本 <br/>**系统能力**：SystemCapability.Updater.update_service|
| VERSION_STATUS_NONE | 1 | 没有检测到新版本 <br/>**系统能力**：SystemCapability.Updater.update_service|
| VERSION_STATUS_BUSY | 2 | 检测版本时忙 <br/>**系统能力**：SystemCapability.Updater.update_service|
| VERSION_STATUS_ERR | -1 | 检测版本时出错 |
| VERSION_STATUS_NEW | 0 | 检测到新版本 |
| VERSION_STATUS_NONE | 1 | 没有检测到新版本 |
| VERSION_STATUS_BUSY | 2 | 检测版本时忙 |
## UpdatePolicy
升级策略。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | -------------- |
| autoDownload | bool | 是 | 自动升级开关 <br/>**系统能力**：SystemCapability.Updater.update_service|
| installMode | [InstallMode](#installmode) | 是 | 安装模式 <br/>**系统能力**：SystemCapability.Updater.update_service|
| autoUpgradeInterval | Array\<number> | 是 | 自动升级时间段 <br/>**系统能力**：SystemCapability.Updater.update_service|
| autoDownload | bool | 是 | 自动升级开关 |
| installMode | [InstallMode](#installmode) | 是 | 安装模式 |
| autoUpgradeInterval | Array\<number> | 是 | 自动升级时间段 |
## NewVersionInfo
新版本信息。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ------------------------------------------- | ---- | -------- |
| status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态 <br/>**系统能力**：SystemCapability.Updater.update_service|
| errMsg | string | 是 | 错误信息 <br/>**系统能力**：SystemCapability.Updater.update_service|
| checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果 <br/>**系统能力**：SystemCapability.Updater.update_service|
| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | 是 | 描述信息 <br/>**系统能力**：SystemCapability.Updater.update_service|
| status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态 |
| errMsg | string | 是 | 错误信息 |
| checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果 |
| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | 是 | 描述信息 |
## CheckResult
检测结果。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ----------------------------- | ---- | ------------ |
| versionName | string | 是 | 版本名称 <br/>**系统能力**：SystemCapability.Updater.update_service|
| versionCode | number | 是 | 版本编码 <br/>**系统能力**：SystemCapability.Updater.update_service|
| size | number | 是 | 版本大小 <br/>**系统能力**：SystemCapability.Updater.update_service|
| verifyInfo | string | 是 | 版本校验信息 <br/>**系统能力**：SystemCapability.Updater.update_service|
| packageType | [PackageTypes](#packagetypes) | 是 | 版本类型 <br/>**系统能力**：SystemCapability.Updater.update_service|
| descriptionId | string | 是 | 版本描述信息 <br/>**系统能力**：SystemCapability.Updater.update_service|
| versionName | string | 是 | 版本名称 |
| versionCode | number | 是 | 版本编码 |
| size | number | 是 | 版本大小 |
| verifyInfo | string | 是 | 版本校验信息 |
| packageType | [PackageTypes](#packagetypes) | 是 | 版本类型 |
| descriptionId | string | 是 | 版本描述信息 |
## DescriptionInfo
版本描述信息。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | -------- | ---- | ----------------- |
| descriptionId | string | 是 | 版本versionId信息 <br/>**系统能力**：SystemCapability.Updater.update_service|
| content | string | 是 | 版本changelog信息 <br/>**系统能力**：SystemCapability.Updater.update_service|
\ No newline at end of file
| descriptionId | string | 是 | 版本versionId信息 |
| content | string | 是 | 版本changelog信息 |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或