鸿蒙开发设备管理：ohos.update 升级

jf_46214456 2024-07-05 226

电子说

1.3w人已加入

描述

升级

鸿蒙说明： 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

升级范围：升级整个系统，包括内置的资源、预置应用；第三方的应用不在升级的范围。

升级依赖：升级分为SD卡升级和在线升级两种。

  • SD卡升级依赖升级包和SD卡安装。
  • 在线升级依赖设备厂商部署的用于管理升级包的服务器。服务器由设备厂商部署，IP由调用者传入，请求的request接口是固定的，由设备厂商开发。

导入模块

import update from '@ohos.update'

权限列表

无

update.getUpdater

getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater

获取本地升级Updater。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
upgradeFilestring是升级文件
updateType[UpdateTypes]是升级类型

返回值：

类型说明
[Updater]升级对象

示例：

try {
  let updater = update.getUpdater('/data/updater/updater.zip', 'OTA');
} catch(error) {
  console.error(" Fail to get updater error: " + error);
}

update.getUpdaterForOther

getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater

获取升级对象给待升级设备。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
upgradeFilestring是升级文件
devicestring是待升级设备
updateType[UpdateTypes]是升级类型

返回值：

类型说明
[Updater]升级对象

示例：

try {
  let updater = update.getUpdaterForOther('/data/updater/updater.zip', '1234567890', 'OTA');
} catch(error) {
  console.error(" Fail to get updater error: " + error);
}

update.getUpdaterFromOther

getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater

获取其它设备为本设备升级的Updater。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
upgradeFilestring是升级文件
devicestring是待升级设备
updateType[UpdateTypes]是升级类型

返回值：

类型说明
[Updater]升级对象

示例：

try {
  let updater = update.getUpdaterFromOther('/data/updater/updater.zip', '1234567890', 'OTA');
} catch(error) {
  console.error(" Fail to get updater error: " + error);
}

Updater

getNewVersionInfo

getNewVersionInfo(callback: AsyncCallback): void

获取新版本信息，使用callback方式作为异步方法。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
callbackAsyncCallback<[NewVersionInfo]>否回调返回新版本信息

示例：

updater.getNewVersionInfo((err, info) = > {
  console.log("getNewVersionInfo success  " + info.status);
  console.log(`info versionName = ` + info.checkResults[0].versionName);
  console.log(`info versionCode = ` + info.checkResults[0].versionCode);
  console.log(`info verifyInfo = ` + info.checkResults[0].verifyInfo);
});

getNewVersionInfo

getNewVersionInfo(): Promise

获取新版本信息，使用promise方式作为异步方法。

系统能力 ：SystemCapability.Update.UpdateService

返回值：

类型说明
Promise<[NewVersionInfo]>Promise，用于异步获取结果

示例：

updater.getNewVersionInfo().then(value = > {
  console.log(`info versionName = ` + value.checkResults[0].versionName);
  console.log(`info versionCode = ` + value.checkResults[0].versionCode);
  console.log(`info verifyInfo = ` + value.checkResults[0].verifyInfo);
}).catch(err = > {
  console.log("getNewVersionInfo promise error: " + err.code);
});

checkNewVersion

checkNewVersion(callback: AsyncCallback): void

检查新版本，使用callback方式作为异步方法。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
callbackAsyncCallback<[NewVersionInfo]>否回调返回新版本信息

示例：

updater.checkNewVersion((err, info) = > {
  console.log("checkNewVersion success  " + info.status);
  console.log(`info versionName = ` + info.checkResults[0].versionName);
  console.log(`info versionCode = ` + info.checkResults[0].versionCode);
  console.log(`info verifyInfo = ` + info.checkResults[0].verifyInfo);
});

checkNewVersion

checkNewVersion(): Promise

检查新版本，使用promise方式作为异步方法。

系统能力 ：SystemCapability.Update.UpdateService

返回值:

类型说明
Promise<[NewVersionInfo]>Promise函数返回新版本信息

示例:

updater.checkNewVersion().then(value = > {
  console.log(`info versionName = ` + value.checkResults[0].versionName);
  console.log(`info versionCode = ` + value.checkResults[0].versionCode);
  console.log(`info verifyInfo = ` + value.checkResults[0].verifyInfo);
}).catch(err = > {
  console.log("checkNewVersion promise error: " + err.code);
});

verifyUpdatePackage

verifyUpdatePackage(upgradeFile: string, certsFile: string): void

升级前检查升级包是否有效。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
upgradeFilestring是待校验的升级包路径
certsFilestring是证书路径

示例：

updater.on("verifyProgress", callback = > {
  console.info('on verifyProgress ' + callback.percent);
});
update.verifyUpdatePackage("XXX", "XXX");

rebootAndCleanUserData8+

rebootAndCleanUserData(): Promise

重启设备并清除用户分区数据。

系统能力 ：SystemCapability.Update.UpdateService

返回值：

类型说明
PromisePromise示例，用于异步获取结果。

示例：

updater.rebootAndCleanUserData().then(result = > {
  console.log("rebootAndCleanUserData " + result);
}).catch(err = > {
  console.info("rebootAndCleanUserData promise error: " + err.code);
});

rebootAndCleanUserData8+

rebootAndCleanUserData(callback: AsyncCallback): void

重启设备并清除用户分区数据。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
callbackFunction是AsyncCallback

示例：

updater.rebootAndCleanUserData((err, result) = > {
  console.log("rebootAndCleanUserData ", result)
});

applyNewVersion

applyNewVersion(): Promise

重启设备后安装升级包。

系统能力 ：SystemCapability.Update.UpdateService

返回值：

类型说明
PromisePromise示例，用于异步获取结果。

示例：

updater.applyNewVersion().then(result = > {
    console.log("appVewVersion ", result)
}).catch(err = > {
    console.info("applyNewVersion promise error: " + err.code);
});

applyNewVersion

applyNewVersion(callback: AsyncCallback): void

重启设备后安装升级包。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
callbackFunction是AsyncCallback

示例：

updater.applyNewVersion((err, result) = > {
  console.log("applyNewVersion ", result)
});

download

download(): void

下载新版本，并监听下载进程。

系统能力 ：SystemCapability.Update.UpdateService

示例：

updater.on("downloadProgress", progress = > {
  console.log("downloadProgress on" + progress);
  console.log(`downloadProgress status: ` + progress.status);
  console.log(`downloadProgress percent: ` + progress.percent);
});
updater.download();

upgrade

upgrade():void

启动升级。

系统能力 ：SystemCapability.Update.UpdateService

示例：

updater.on("upgradeProgress", progress = > {
  console.log("upgradeProgress on" + progress);
  console.log(`upgradeProgress status: ` + progress.status);
  console.log(`upgradeProgress percent: ` + progress.percent);
});
updater.upgrade();

setUpdatePolicy

setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback): void

设置升级策略，使用callback方式作为异步方法。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
policy[UpdatePolicy]是设置升级策略
callbackAsyncCallback是回调返回结果

示例：

// 设置策略
let policy = {
  autoDownload: false,
  autoDownloadNet: true,
  mode: 2,
  autoUpgradeInterval: [ 2, 3 ],
  autoUpgradeCondition: 2
}
updater.setUpdatePolicy(policy, (err, result) =  > {
  console.log("setUpdatePolicy ", result)
});

setUpdatePolicy

setUpdatePolicy(policy: UpdatePolicy): Promise

设置升级策略，使用promise方式作为异步方法。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
policy[UpdatePolicy]是设置升级策略

返回值：

类型说明
PromisePromise函数返回设置结果

示例：

let policy = {
  autoDownload: false,
  autoDownloadNet: true,
  mode: 2,
  autoUpgradeInterval: [ 2, 3 ],
  autoUpgradeCondition: 2
}
updater.setUpdatePolicy(policy).then(result =  > 
  console.log("setUpdatePolicy ", result)
).catch(err =  > {
  console.log("setUpdatePolicy promise error: " + err.code);
});

getUpdatePolicy

getUpdatePolicy(callback: AsyncCallback): void

获取升级策略信息，使用callback方式作为异步方法。

系统能力 ：SystemCapability.Update.UpdateService

参数：

参数名类型必填说明
callbackAsyncCallback<[UpdatePolicy]>否回调返回升级策略信息

示例：

updater.getUpdatePolicy((err, policy) = > {
  console.log("getUpdatePolicy success");
  console.log(`policy autoDownload = ` + policy.autoDownload);
  console.log(`policy autoDownloadNet = ` + policy.autoDownloadNet);
  console.log(`policy mode = ` + policy.mode);
});

getUpdatePolicy

getUpdatePolicy(): Promise

获取升级策略，通过promise方式作为异步方法。

系统能力 ：SystemCapability.Update.UpdateService

返回值：

类型说明
Promise<[UpdatePolicy]>Promise函数返回升级策略信息

示例：

updater.getUpdatePolicy().then(value = > {
  console.log(`info autoDownload = ` + value.autoDownload);
  console.log(`info autoDownloadNet = ` + value.autoDownloadNet);
  console.log(`info mode = ` + value.mode);
}).catch(err = > {
  console.log("getUpdatePolicy promise error: " + err.code);
});

UpdateTypes

升级类型。

系统能力 ：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService

参数名说明
OTAOTA升级
patch补丁升级

PackageTypes

升级包类型。

系统能力 ：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService

参数名默认值说明
PACKAGE_TYPE_NORMAL1通用升级包
PACKAGE_TYPE_BASE2基础升级包
PACKAGE_TYPE_CUST3定制升级包
PACKAGE_TYPE_PRELOAD4预装升级包
PACKAGE_TYPE_COTA5参数配置升级包
PACKAGE_TYPE_VERSION6版本升级包
PACKAGE_TYPE_PATCH7补丁包

InstallMode

安装模式。

系统能力 ：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService

参数名默认值说明
INSTALL_MODE_NORMAL0正常升级
INSTALL_MODE_NIGHT1夜间升级
INSTALL_MODE_AUTO2自动升级

NewVersionStatus

新版本检测状态。

系统能力 ：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService

参数名默认值说明
VERSION_STATUS_ERR-1检测版本时出错
VERSION_STATUS_NEW0检测到新版本
VERSION_STATUS_NONE1没有检测到新版本
VERSION_STATUS_BUSY2检测版本时忙

UpdatePolicy

升级策略。

系统能力 ：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService

名称参数类型必填说明
autoDownloadbool是自动升级开关
installMode[InstallMode]是安装模式
autoUpgradeIntervalArray是自动升级时间段

NewVersionInfo

新版本信息。

系统能力 ：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService

名称参数类型必填说明
status[NewVersionStatus]是升级状态
errMsgstring是错误信息
checkResultsArray<[CheckResult]>是检测结果
descriptionInfoArray<[DescriptionInfo]>是描述信息

CheckResult

检测结果。

系统能力 ：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService

名称参数类型必填说明
versionNamestring是版本名称
versionCodenumber是版本编码
sizenumber是版本大小
verifyInfostring是版本校验信息
packageType[PackageTypes]是版本类型
descriptionIdstring是HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿版本描述信息

鸿蒙

DescriptionInfo

版本描述信息。

系统能力 ：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService

名称参数类型必填说明
descriptionIdstring是版本versionId信息
contentstring是版本changelog信息

审核编辑 黄宇

打开APP阅读更多精彩内容
声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

下载APP
|投诉反馈|电子发烧友网
© 2021 elecfans.com
湘ICP备2023018690号
×
20
完善资料，
赚取积分