升級

說明： 本模塊首批接口從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

參數：

返回值：

示例：

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

獲取新版本信息，使用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): 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

檢查新版本，使用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");

rebootAndCleanUserData8+

rebootAndCleanUserData(): Promise

重啟設備并清除用戶分區數據。

系統能力 ：SystemCapability.Update.UpdateService

返回值：

示例：

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

參數：

示例：

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

applyNewVersion

applyNewVersion(): Promise

重啟設備后安裝升級包。

系統能力 ：SystemCapability.Update.UpdateService

返回值：

示例：

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

參數：

示例：

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

參數：

示例：

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

參數：

返回值：

示例：

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

參數：

示例：

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

返回值：

示例：

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

審核編輯 黃宇