Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 739513f5 编写于 作者: L liangZ15
浏览文件
操作

Signed-off-by: liangZ15<lihongliang20@huawei.com> 

refresh doc
上级 49d80944
隐藏空白更改
内联 并排
Showing with 41 addition and 69 deletion
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @ 739513f5
...@@ -17,15 +17,13 @@ import update from '@ohos.update' ...@@ -17,15 +17,13 @@ import update from '@ohos.update'
无 无
## 获取升级对象Updater ## update.getUpdater
### update.getUpdater
getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater
获取本地升级Updater。 获取本地升级Updater。
**系统能力**：SystemCapability.Updater.update_service **系统能力**：SystemCapability.Update.UpdateService
**参数：** **参数：**
...@@ -50,13 +48,13 @@ try { ...@@ -50,13 +48,13 @@ try {
} }
``` ```
### update.getUpdaterForOther ## update.getUpdaterForOther
getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater
获取升级对象给待升级设备。 获取升级对象给待升级设备。
**系统能力**：SystemCapability.Updater.update_service **系统能力**：SystemCapability.Update.UpdateService
**参数：** **参数：**
...@@ -82,13 +80,13 @@ try { ...@@ -82,13 +80,13 @@ try {
} }
``` ```
### update.getUpdaterFromOther ## update.getUpdaterFromOther
getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater
获取其它设备为本设备升级的Updater。 获取其它设备为本设备升级的Updater。
**系统能力**：SystemCapability.Updater.update_service **系统能力**：SystemCapability.Update.UpdateService
**参数：** **参数：**
...@@ -116,14 +114,14 @@ try { ...@@ -116,14 +114,14 @@ try {
## Updater ## Updater
**系统能力**：以下各项对应能力均为：SystemCapability.Update.UpdateService
### getNewVersionInfo ### getNewVersionInfo
getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
获取新版本信息，使用callback方式作为异步方法。 获取新版本信息，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -147,8 +145,6 @@ getNewVersionInfo(): Promise\<NewVersionInfo> ...@@ -147,8 +145,6 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
获取新版本信息，使用promise方式作为异步方法。 获取新版本信息，使用promise方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -173,8 +169,6 @@ checkNewVersion(callback: AsyncCallback\<NewVersionInfo>): void ...@@ -173,8 +169,6 @@ checkNewVersion(callback: AsyncCallback\<NewVersionInfo>): void
检查新版本，使用callback方式作为异步方法。 检查新版本，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -198,8 +192,6 @@ checkNewVersion(): Promise\<NewVersionInfo> ...@@ -198,8 +192,6 @@ checkNewVersion(): Promise\<NewVersionInfo>
检查新版本，使用promise方式作为异步方法。 检查新版本，使用promise方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -224,8 +216,6 @@ verifyUpdatePackage(upgradeFile: string, certsFile: string): void ...@@ -224,8 +216,6 @@ verifyUpdatePackage(upgradeFile: string, certsFile: string): void
升级前检查升级包是否有效。 升级前检查升级包是否有效。
**系统能力**：SystemCapability.Updater.update_service
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -248,8 +238,6 @@ rebootAndCleanUserData(): Promise\<number> ...@@ -248,8 +238,6 @@ rebootAndCleanUserData(): Promise\<number>
重启设备并清除用户分区数据。 重启设备并清除用户分区数据。
**系统能力**：SystemCapability.Updater.update_service
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -272,8 +260,6 @@ rebootAndCleanUserData(callback: AsyncCallback\<number>): void ...@@ -272,8 +260,6 @@ rebootAndCleanUserData(callback: AsyncCallback\<number>): void
重启设备并清除用户分区数据。 重启设备并清除用户分区数据。
**系统能力**：SystemCapability.Updater.update_service
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -294,8 +280,6 @@ applyNewVersion(): Promise\<number> ...@@ -294,8 +280,6 @@ applyNewVersion(): Promise\<number>
重启设备后安装升级包。 重启设备后安装升级包。
**系统能力**：SystemCapability.Updater.update_service
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -318,8 +302,6 @@ applyNewVersion(callback: AsyncCallback\<number>): void ...@@ -318,8 +302,6 @@ applyNewVersion(callback: AsyncCallback\<number>): void
重启设备后安装升级包。 重启设备后安装升级包。
**系统能力**：SystemCapability.Updater.update_service
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -340,8 +322,6 @@ download(): void ...@@ -340,8 +322,6 @@ download(): void
下载新版本，并监听下载进程。 下载新版本，并监听下载进程。
**系统能力**：SystemCapability.Updater.update_service
**示例：** **示例：**
``` ```
...@@ -359,8 +339,6 @@ updater.upgrade():void ...@@ -359,8 +339,6 @@ updater.upgrade():void
启动升级。 启动升级。
**系统能力**：SystemCapability.Updater.update_service
**示例：** **示例：**
``` ```
...@@ -378,8 +356,6 @@ setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\<number>): void ...@@ -378,8 +356,6 @@ setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\<number>): void
设置升级策略，使用callback方式作为异步方法。 设置升级策略，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -409,8 +385,6 @@ setUpdatePolicy(policy: UpdatePolicy): Promise\<number> ...@@ -409,8 +385,6 @@ setUpdatePolicy(policy: UpdatePolicy): Promise\<number>
设置升级策略，使用promise方式作为异步方法。 设置升级策略，使用promise方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -446,8 +420,6 @@ getUpdatePolicy(callback: AsyncCallback\<UpdatePolicy>): void ...@@ -446,8 +420,6 @@ getUpdatePolicy(callback: AsyncCallback\<UpdatePolicy>): void
获取升级策略信息，使用callback方式作为异步方法。 获取升级策略信息，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -471,8 +443,6 @@ getUpdatePolicy(): Promise\<UpdatePolicy> ...@@ -471,8 +443,6 @@ getUpdatePolicy(): Promise\<UpdatePolicy>
获取升级策略，通过promise方式作为异步方法。 获取升级策略，通过promise方式作为异步方法。
**系统能力**：SystemCapability.Updater.update_service
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -495,10 +465,12 @@ update.getUpdatePolicy().then(value => { ...@@ -495,10 +465,12 @@ update.getUpdatePolicy().then(value => {
升级类型。 升级类型。
**系统能力**：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 说明 | | 参数名 | 说明 |
| ------ | -------- | | ------ | -------- |
| OTA | OTA升级 <br/>**系统能力**：SystemCapability.Updater.update_service| | OTA | OTA升级 |
| patch | 补丁升级 <br/>**系统能力**：SystemCapability.Updater.update_service| | patch | 补丁升级 |
## PackageTypes ## PackageTypes
...@@ -506,13 +478,13 @@ update.getUpdatePolicy().then(value => { ...@@ -506,13 +478,13 @@ update.getUpdatePolicy().then(value => {
| 参数名 | 默认值 | 说明 | | 参数名 | 默认值 | 说明 |
| -------------------- | ------ | -------------- | | -------------------- | ------ | -------------- |
| PACKAGE_TYPE_NORMAL | 1 | 通用升级包 <br/>**系统能力**：SystemCapability.Updater.update_service| | PACKAGE_TYPE_NORMAL | 1 | 通用升级包 |
| PACKAGE_TYPE_BASE | 2 | 基础升级包 <br/>**系统能力**：SystemCapability.Updater.update_service| | PACKAGE_TYPE_BASE | 2 | 基础升级包 |
| PACKAGE_TYPE_CUST | 3 | 定制升级包 <br/>**系统能力**：SystemCapability.Updater.update_service| | PACKAGE_TYPE_CUST | 3 | 定制升级包 |
| PACKAGE_TYPE_PRELOAD | 4 | 预装升级包 <br/>**系统能力**：SystemCapability.Updater.update_service| | PACKAGE_TYPE_PRELOAD | 4 | 预装升级包 |
| PACKAGE_TYPE_COTA | 5 | 参数配置升级包 <br/>**系统能力**：SystemCapability.Updater.update_service| | PACKAGE_TYPE_COTA | 5 | 参数配置升级包 |
| PACKAGE_TYPE_VERSION | 6 | 版本升级包 <br/>**系统能力**：SystemCapability.Updater.update_service| | PACKAGE_TYPE_VERSION | 6 | 版本升级包 |
| PACKAGE_TYPE_PATCH | 7 | 补丁包 <br/>**系统能力**：SystemCapability.Updater.update_service| | PACKAGE_TYPE_PATCH | 7 | 补丁包 |
## InstallMode ## InstallMode
...@@ -520,9 +492,9 @@ update.getUpdatePolicy().then(value => { ...@@ -520,9 +492,9 @@ update.getUpdatePolicy().then(value => {
| 参数名 | 默认值 | 说明 | | 参数名 | 默认值 | 说明 |
| ------------------- | ------ | -------- | | ------------------- | ------ | -------- |
| INSTALL_MODE_NORMAL | 0 | 正常升级 <br/>**系统能力**：SystemCapability.Updater.update_service| | INSTALL_MODE_NORMAL | 0 | 正常升级 |
| INSTALL_MODE_NIGHT | 1 | 夜间升级 <br/>**系统能力**：SystemCapability.Updater.update_service| | INSTALL_MODE_NIGHT | 1 | 夜间升级 |
| INSTALL_MODE_AUTO | 2 | 自动升级 <br/>**系统能力**：SystemCapability.Updater.update_service| | INSTALL_MODE_AUTO | 2 | 自动升级 |
## NewVersionStatus ## NewVersionStatus
...@@ -530,10 +502,10 @@ update.getUpdatePolicy().then(value => { ...@@ -530,10 +502,10 @@ update.getUpdatePolicy().then(value => {
| 参数名 | 默认值 | 说明 | | 参数名 | 默认值 | 说明 |
| ------------------- | ------ | ---------------- | | ------------------- | ------ | ---------------- |
| VERSION_STATUS_ERR | -1 | 检测版本时出错 <br/>**系统能力**：SystemCapability.Updater.update_service| | VERSION_STATUS_ERR | -1 | 检测版本时出错 |
| VERSION_STATUS_NEW | 0 | 检测到新版本 <br/>**系统能力**：SystemCapability.Updater.update_service| | VERSION_STATUS_NEW | 0 | 检测到新版本 |
| VERSION_STATUS_NONE | 1 | 没有检测到新版本 <br/>**系统能力**：SystemCapability.Updater.update_service| | VERSION_STATUS_NONE | 1 | 没有检测到新版本 |
| VERSION_STATUS_BUSY | 2 | 检测版本时忙 <br/>**系统能力**：SystemCapability.Updater.update_service| | VERSION_STATUS_BUSY | 2 | 检测版本时忙 |
## UpdatePolicy ## UpdatePolicy
...@@ -541,9 +513,9 @@ update.getUpdatePolicy().then(value => { ...@@ -541,9 +513,9 @@ update.getUpdatePolicy().then(value => {
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | -------------- | | ------------------- | --------------------------- | ---- | -------------- |
| autoDownload | bool | 是 | 自动升级开关 <br/>**系统能力**：SystemCapability.Updater.update_service| | autoDownload | bool | 是 | 自动升级开关 |
| installMode | [InstallMode](#installmode) | 是 | 安装模式 <br/>**系统能力**：SystemCapability.Updater.update_service| | installMode | [InstallMode](#installmode) | 是 | 安装模式 |
| autoUpgradeInterval | Array\<number> | 是 | 自动升级时间段 <br/>**系统能力**：SystemCapability.Updater.update_service| | autoUpgradeInterval | Array\<number> | 是 | 自动升级时间段 |
## NewVersionInfo ## NewVersionInfo
...@@ -551,10 +523,10 @@ update.getUpdatePolicy().then(value => { ...@@ -551,10 +523,10 @@ update.getUpdatePolicy().then(value => {
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ------------------------------------------- | ---- | -------- | | --------------- | ------------------------------------------- | ---- | -------- |
| status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态 <br/>**系统能力**：SystemCapability.Updater.update_service| | status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态 |
| errMsg | string | 是 | 错误信息 <br/>**系统能力**：SystemCapability.Updater.update_service| | errMsg | string | 是 | 错误信息 |
| checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果 <br/>**系统能力**：SystemCapability.Updater.update_service| | checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果 |
| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | 是 | 描述信息 <br/>**系统能力**：SystemCapability.Updater.update_service| | descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | 是 | 描述信息 |
## CheckResult ## CheckResult
...@@ -562,12 +534,12 @@ update.getUpdatePolicy().then(value => { ...@@ -562,12 +534,12 @@ update.getUpdatePolicy().then(value => {
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ----------------------------- | ---- | ------------ | | ------------- | ----------------------------- | ---- | ------------ |
| versionName | string | 是 | 版本名称 <br/>**系统能力**：SystemCapability.Updater.update_service| | versionName | string | 是 | 版本名称 |
| versionCode | number | 是 | 版本编码 <br/>**系统能力**：SystemCapability.Updater.update_service| | versionCode | number | 是 | 版本编码 |
| size | number | 是 | 版本大小 <br/>**系统能力**：SystemCapability.Updater.update_service| | size | number | 是 | 版本大小 |
| verifyInfo | string | 是 | 版本校验信息 <br/>**系统能力**：SystemCapability.Updater.update_service| | verifyInfo | string | 是 | 版本校验信息 |
| packageType | [PackageTypes](#packagetypes) | 是 | 版本类型 <br/>**系统能力**：SystemCapability.Updater.update_service| | packageType | [PackageTypes](#packagetypes) | 是 | 版本类型 |
| descriptionId | string | 是 | 版本描述信息 <br/>**系统能力**：SystemCapability.Updater.update_service| | descriptionId | string | 是 | 版本描述信息 |
## DescriptionInfo ## DescriptionInfo
...@@ -575,5 +547,5 @@ update.getUpdatePolicy().then(value => { ...@@ -575,5 +547,5 @@ update.getUpdatePolicy().then(value => {
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | -------- | ---- | ----------------- | | ------------- | -------- | ---- | ----------------- |
| descriptionId | string | 是 | 版本versionId信息 <br/>**系统能力**：SystemCapability.Updater.update_service| | descriptionId | string | 是 | 版本versionId信息 |
| content | string | 是 | 版本changelog信息 <br/>**系统能力**：SystemCapability.Updater.update_service| | content | string | 是 | 版本changelog信息 |
\ No newline at end of file \ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或