升级

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

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

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

说明：

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口为系统接口。

导入模块

import update from '@ohos.update'

权限列表

无

update.getUpdater

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

获取本地升级Updater。

系统能力：SystemCapability.Update.UpdateService

参数：

返回值：

示例：

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

参数：

返回值：

示例：

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

参数：

返回值：

示例：

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<NewVersionInfo>): void

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

系统能力：SystemCapability.Update.UpdateService

参数：

示例：

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<NewVersionInfo>

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

系统能力：SystemCapability.Update.UpdateService

返回值：

示例：

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<NewVersionInfo>): void

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

系统能力：SystemCapability.Update.UpdateService

参数：

示例：

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<NewVersionInfo>

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

系统能力：SystemCapability.Update.UpdateService

返回值:

示例:

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

参数：

示例：

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

rebootAndCleanUserData⁸⁺

rebootAndCleanUserData(): Promise<number>

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

系统能力：SystemCapability.Update.UpdateService

返回值：

示例：

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

rebootAndCleanUserData⁸⁺

rebootAndCleanUserData(callback: AsyncCallback<number>): void

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

系统能力：SystemCapability.Update.UpdateService

参数：

示例：

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

applyNewVersion

applyNewVersion(): Promise<number>

重启设备后安装升级包。

系统能力：SystemCapability.Update.UpdateService

返回值：

示例：

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

applyNewVersion

applyNewVersion(callback: AsyncCallback<number>): void

重启设备后安装升级包。

系统能力：SystemCapability.Update.UpdateService

参数：

示例：

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<number>): void

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

系统能力：SystemCapability.Update.UpdateService

参数：

示例：

// 设置策略
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<number>

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

系统能力：SystemCapability.Update.UpdateService

参数：

返回值：

示例：

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<UpdatePolicy>): void

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

系统能力：SystemCapability.Update.UpdateService

参数：

示例：

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<UpdatePolicy>

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

系统能力：SystemCapability.Update.UpdateService

返回值：

示例：

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

PackageTypes

升级包类型。

系统能力：SystemCapability.Update.UpdateService

InstallMode

安装模式。

系统能力：SystemCapability.Update.UpdateService

NewVersionStatus

新版本检测状态。

系统能力：SystemCapability.Update.UpdateService

UpdatePolicy

升级策略。

系统能力：SystemCapability.Update.UpdateService

NewVersionInfo

新版本信息。

系统能力：SystemCapability.Update.UpdateService

CheckResult

检测结果。

系统能力：SystemCapability.Update.UpdateService

DescriptionInfo

版本描述信息。

系统能力：SystemCapability.Update.UpdateService