@ohos.update (Update)

The update module applies to updates throughout the entire system, including built-in resources and preset applications, but not third-party applications.

There are two types of updates: SD card update and over the air (OTA) update.

• The SD card update depends on the update packages and SD cards.
• The OTA update depends on the server deployed by the device manufacturer for managing update packages. The OTA server IP address is passed by the caller. The request interface is fixed and developed by the device manufacturer.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs provided by this module are system APIs.

Modules to Import

import update from '@ohos.update'

update.getOnlineUpdater

getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater

Obtains an OnlineUpdater object.

System capability: SystemCapability.Update.UpdateService

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

try {
  const upgradeInfo = {
    upgradeApp: "com.ohos.ota.updateclient",
    businessType: {
      vendor: update.BusinessVendor.PUBLIC,
      subType: update.BusinessSubType.FIRMWARE
    }
  };
  let updater = update.getOnlineUpdater(upgradeInfo);
} catch(error) {
  console.error(`Fail to get updater error: ${error}`);
}

update.getRestorer

getRestorer(): Restorer

Obtains a Restorer object for restoring factory settings.

System capability: SystemCapability.Update.UpdateService

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

try {
  let restorer = update.getRestorer();
} catch(error) {
  console.error(`Fail to get restorer: ${error}`);
}

update.getLocalUpdater

getLocalUpdater(): LocalUpdater

Obtains a LocalUpdater object.

System capability: SystemCapability.Update.UpdateService

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

try {
  let localUpdater = update.getLocalUpdater();
} catch(error) {
  console.error(`Fail to get localUpdater error: ${error}`);
};

Updater

checkNewVersion

checkNewVersion(callback: AsyncCallback<CheckResult>): void

Checks whether a new version is available. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.checkNewVersion((err, result) => {
  console.log(`checkNewVersion isExistNewVersion  ${result?.isExistNewVersion}`);
});

checkNewVersion

checkNewVersion(): Promise<CheckResult>

Checks whether a new version is available. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.checkNewVersion().then(result => {
  console.log(`checkNewVersion isExistNewVersion: ${result.isExistNewVersion}`);
  // Version digest information
  console.log(`checkNewVersion versionDigestInfo: ${result.newVersionInfo.versionDigestInfo.versionDigest}`);
}).catch(err => {
  console.log(`checkNewVersion promise error ${JSON.stringify(err)}`);
});

getNewVersionInfo

getNewVersionInfo(callback: AsyncCallback<NewVersionInfo>): void

Obtains information about the new version. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.getNewVersionInfo((err, info) => {
  console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`);
  console.log(`info innerVersion = ${info?.versionComponents[0].innerVersion}`);
});

getNewVersionInfo

getNewVersionInfo(): Promise<NewVersionInfo>

Obtains information about the new version. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.getNewVersionInfo().then(info => {
  console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`);
  console.log(`info innerVersion = ${info.versionComponents[0].innerVersion}`);
}).catch(err => {
  console.log(`getNewVersionInfo promise error ${JSON.stringify(err)}`);
});

getNewVersionDescription

getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions, callback: AsyncCallback<Array<ComponentDescription>>): void

Obtains the description file of the new version. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Options of the description file
const descriptionOptions = {
  format: update.DescriptionFormat.STANDARD, // Standard format
  language: "zh-cn" // Chinese
};

updater.getNewVersionDescription(versionDigestInfo, descriptionOptions, (err, info) => {
  console.log(`getNewVersionDescription info ${JSON.stringify(info)}`);
  console.log(`getNewVersionDescription err ${JSON.stringify(err)}`);
});

getNewVersionDescription

getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions): Promise<Array<ComponentDescription>>;

Obtains the description file of the new version. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Options of the description file
const descriptionOptions = {
  format: update.DescriptionFormat.STANDARD, // Standard format
  language: "zh-cn" // Chinese
};

updater.getNewVersionDescription(versionDigestInfo, descriptionOptions).then(info => {
  console.log(`getNewVersionDescription promise info ${JSON.stringify(info)}`);
}).catch(err => {
  console.log(`getNewVersionDescription promise error ${JSON.stringify(err)}`);
});

getCurrentVersionInfo

getCurrentVersionInfo(callback: AsyncCallback<CurrentVersionInfo>): void

Obtains information about the current version. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.getCurrentVersionInfo((err, info) => {
  console.log(`info osVersion = ${info?.osVersion}`);
  console.log(`info deviceName = ${info?.deviceName}`);
  console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`);
});

getCurrentVersionInfo

getCurrentVersionInfo(): Promise<CurrentVersionInfo>

Obtains information about the current version. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.getCurrentVersionInfo().then(info => {
  console.log(`info osVersion = ${info.osVersion}`);
  console.log(`info deviceName = ${info.deviceName}`);
  console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`);
}).catch(err => {
  console.log(`getCurrentVersionInfo promise error ${JSON.stringify(err)}`);
});

getCurrentVersionDescription

getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: AsyncCallback<Array<ComponentDescription>>): void

Obtains the description file of the current version. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

// Options of the description file
const descriptionOptions = {
  format: update.DescriptionFormat.STANDARD, // Standard format
  language: "zh-cn" // Chinese
};

updater.getCurrentVersionDescription(descriptionOptions, (err, info) => {
  console.log(`getCurrentVersionDescription info ${JSON.stringify(info)}`);
  console.log(`getCurrentVersionDescription err ${JSON.stringify(err)}`);
});

getCurrentVersionDescription

getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise<Array<ComponentDescription>>

Obtains the description file of the current version. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

// Options of the description file
const descriptionOptions = {
  format: update.DescriptionFormat.STANDARD, // Standard format
  language: "zh-cn" // Chinese
};

updater.getCurrentVersionDescription(descriptionOptions).then(info => {
  console.log(`getCurrentVersionDescription promise info ${JSON.stringify(info)}`);
}).catch(err => {
  console.log(`getCurrentVersionDescription promise error ${JSON.stringify(err)}`);
});

getTaskInfo

getTaskInfo(callback: AsyncCallback<TaskInfo>): void

Obtains information about the update task. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.getTaskInfo((err, info) => {
  console.log(`getTaskInfo isexistTask= ${info?.existTask}`);
});

getTaskInfo

getTaskInfo(): Promise<TaskInfo>

Obtains information about the update task. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.getTaskInfo().then(info => {
  console.log(`getTaskInfo isexistTask= ${info.existTask}`);
}).catch(err => {
  console.log(`getTaskInfo promise error ${JSON.stringify(err)}`);
});

download

download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions, callback: AsyncCallback<void>): void

Downloads the new version. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Download options
const downloadOptions = {
  allowNetwork: update.NetType.CELLULAR, // Whether to allow download over data network
  order: update.Order.DOWNLOAD // Download
};
updater.download(versionDigestInfo, downloadOptions, (err) => {
  console.log(`download error ${JSON.stringify(err)}`);
});

download

download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions): Promise<void>

Downloads the new version. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Download options
const downloadOptions = {
  allowNetwork: update.NetType.CELLULAR, // Whether to allow download over data network
  order: update.Order.DOWNLOAD // Download
};
updater.download(versionDigestInfo, downloadOptions).then(() => {
  console.log(`download start`);
}).catch(err => {
  console.log(`download error ${JSON.stringify(err)}`);
});

resumeDownload

resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: ResumeDownloadOptions, callback: AsyncCallback<void>): void

Resumes download of the new version. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Options for resuming download
const resumeDownloadOptions = {
  allowNetwork: update.NetType.CELLULAR, // Whether to allow download over data network
};
updater.resumeDownload(versionDigestInfo, resumeDownloadOptions, (err) => {
  console.log(`resumeDownload error ${JSON.stringify(err)}`);
});

resumeDownload

resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: ResumeDownloadOptions): Promise<void>

Resumes download of the new version. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Options for resuming download
const resumeDownloadOptions = {
  allowNetwork: update.NetType.CELLULAR, // Whether to allow download over data network
};
updater.resumeDownload(versionDigestInfo, resumeDownloadOptions).then(value => {
  console.log(`resumeDownload start`);
}).catch(err => {
  console.log(`resumeDownload error ${JSON.stringify(err)}`);
});

pauseDownload

pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseDownloadOptions, callback: AsyncCallback<void>): void

Pauses download of the new version. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Options for pausing download
const pauseDownloadOptions = {
  isAllowAutoResume: true // Whether to allow automatic resuming of download
};
updater.pauseDownload(versionDigestInfo, pauseDownloadOptions, (err) => {
  console.log(`pauseDownload error ${JSON.stringify(err)}`);
});

pauseDownload

pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseDownloadOptions): Promise<void>

Resumes download of the new version. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Options for pausing download
const pauseDownloadOptions = {
  isAllowAutoResume: true // Whether to allow automatic resuming of download
};
updater.pauseDownload(versionDigestInfo, pauseDownloadOptions).then(value => {
  console.log(`pauseDownload`);
}).catch(err => {
  console.log(`pauseDownload error ${JSON.stringify(err)}`);
});

upgrade

upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, callback: AsyncCallback<void>): void

Updates the version. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Installation options
const upgradeOptions = {
  order: update.Order.INSTALL // Installation command
};
updater.upgrade(versionDigestInfo, upgradeOptions, (err) => {
  console.log(`upgrade error ${JSON.stringify(err)}`);
});

upgrade

upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): Promise<void>

Updates the version. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Installation options
const upgradeOptions = {
  order: update.Order.INSTALL // Installation command
};
updater.upgrade(versionDigestInfo, upgradeOptions).then(() => {
  console.log(`upgrade start`);
}).catch(err => {
  console.log(`upgrade error ${JSON.stringify(err)}`);
});

clearError

clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, callback: AsyncCallback<void>): void

Clears errors. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Options for clearing errors
const clearOptions = {
  status: update.UpgradeStatus.UPGRADE_FAIL,
};
updater.clearError(versionDigestInfo, clearOptions, (err) => {
  console.log(`clearError error ${JSON.stringify(err)}`);
});

clearError

clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Promise<void>

Clears errors. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

// Version digest information
const versionDigestInfo = {
  versionDigest: "versionDigest" // Version digest information in the check result
};

// Options for clearing errors
const clearOptions = {
  status: update.UpgradeStatus.UPGRADE_FAIL,
};
updater.clearError(versionDigestInfo, clearOptions).then(() => {
  console.log(`clearError success`);
}).catch(err => {
  console.log(`clearError error ${JSON.stringify(err)}`);
});

getUpgradePolicy

getUpgradePolicy(callback: AsyncCallback<UpgradePolicy>): void

Obtains the update policy. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.getUpgradePolicy((err, policy) => {
  console.log(`policy downloadStrategy = ${policy?.downloadStrategy}`);
  console.log(`policy autoUpgradeStrategy = ${policy?.autoUpgradeStrategy}`);
});

getUpgradePolicy

getUpgradePolicy(): Promise<UpgradePolicy>

Obtains the update policy. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.getUpgradePolicy().then(policy => {
  console.log(`policy downloadStrategy = ${policy.downloadStrategy}`);
  console.log(`policy autoUpgradeStrategy = ${policy.autoUpgradeStrategy}`);
}).catch(err => {
  console.log(`getUpgradePolicy promise error ${JSON.stringify(err)}`);
});

setUpgradePolicy

setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback<void>): void

Sets the update policy. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

const policy = {
  downloadStrategy: false,
  autoUpgradeStrategy: false,
  autoUpgradePeriods: [ { start: 120, end: 240 } ] // Automatic update period, in minutes
};
updater.setUpgradePolicy(policy, (err) => {
  console.log(`setUpgradePolicy result: ${err}`);
});

setUpgradePolicy

setUpgradePolicy(policy: UpgradePolicy): Promise<void>

Sets the update policy. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

const policy = {
  downloadStrategy: false,
  autoUpgradeStrategy: false,
  autoUpgradePeriods: [ { start: 120, end: 240 } ] // Automatic update period, in minutes
};
updater.setUpgradePolicy(policy).then(() => {
  console.log(`setUpgradePolicy success`);
}).catch(err => {
  console.log(`setUpgradePolicy promise error ${JSON.stringify(err)}`);
});

terminateUpgrade

terminateUpgrade(callback: AsyncCallback<void>): void

Terminates the update. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.terminateUpgrade((err) => {
  console.log(`terminateUpgrade error ${JSON.stringify(err)}`);
});

terminateUpgrade

terminateUpgrade(): Promise<void>

Terminates the update. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

updater.terminateUpgrade().then(() => {
  console.log(`terminateUpgrade success`);
}).catch(err => {
  console.log(`terminateUpgrade error ${JSON.stringify(err)}`);
});

on

on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): void

Enables listening for update events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

const eventClassifyInfo = {
  eventClassify: update.EventClassify.TASK, // Listening for update events
  extraInfo: ""
};

updater.on(eventClassifyInfo, (eventInfo) => {
  console.log("updater on " + JSON.stringify(eventInfo));
});

off

off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): void

Disables listening for update events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

const eventClassifyInfo = {
  eventClassify: update.EventClassify.TASK, // Listening for update events
  extraInfo: ""
};

updater.off(eventClassifyInfo, (eventInfo) => {
  console.log("updater off " + JSON.stringify(eventInfo));
});

Restorer

factoryReset

factoryReset(callback: AsyncCallback<void>): void

Restores the scale to its factory settings. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.FACTORY_RESET (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

restorer.factoryReset((err) => {
  console.log(`factoryReset error ${JSON.stringify(err)}`);
});

factoryReset

factoryReset(): Promise<void>

Restores the scale to its factory settings. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.FACTORY_RESET (a system permission)

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

restorer.factoryReset().then(() => {
  console.log(`factoryReset success`);
}).catch(err => {
  console.log(`factoryReset error ${JSON.stringify(err)}`);
});

LocalUpdater

verifyUpgradePackage

verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: AsyncCallback<void>): void

Verifies the update package. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

const upgradeFile = {
  fileType: update.ComponentType.OTA, // OTA package
  filePath: "path" // Path of the local update package
};

localUpdater.verifyUpgradePackage(upgradeFile, "cerstFilePath", (err) => {
  console.log(`factoryReset error ${JSON.stringify(err)}`);
});

verifyUpgradePackage

verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise<void>

Verifies the update package. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

const upgradeFile = {
  fileType: update.ComponentType.OTA, // OTA package
  filePath: "path" // Path of the local update package
};
localUpdater.verifyUpgradePackage(upgradeFile, "cerstFilePath").then(() => {
  console.log(`verifyUpgradePackage success`);
}).catch(err => {
  console.log(`verifyUpgradePackage error ${JSON.stringify(err)}`);
});

applyNewVersion

applyNewVersion(upgradeFiles: Array<UpgradeFile>, callback: AsyncCallback<void>): void

Installs the update package. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

const upgradeFiles = [{
  fileType: update.ComponentType.OTA, // OTA package
  filePath: "path" // Path of the local update package
}];

localUpdater.applyNewVersion(upgradeFiles, (err) => {
  console.log(`applyNewVersion error ${JSON.stringify(err)}`);
});

applyNewVersion

applyNewVersion(upgradeFiles: Array<UpgradeFile>): Promise<void>

Installs the update package. This API uses a promise to return the result.

System capability: SystemCapability.Update.UpdateService

Required permission: ohos.permission.UPDATE_SYSTEM (a system permission)

Return value

Error codes

For details about the error codes, see Update Error Codes.

Example

const upgradeFiles = [{
  fileType: update.ComponentType.OTA, // OTA package
  filePath: "path" // Path of the local update package
}];
localUpdater.applyNewVersion(upgradeFiles).then(() => {
  console.log(`applyNewVersion success`);
}).catch(err => {
  console.log(`applyNewVersion error ${JSON.stringify(err)}`);
});

on

on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): void

Enables listening for update events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

const eventClassifyInfo = {
  eventClassify: update.EventClassify.TASK, // Listening for update events
  extraInfo: ""
};

function onTaskUpdate(eventInfo) {
  console.log(`on eventInfo id `, eventInfo.eventId);
}

localUpdater.on(eventClassifyInfo, onTaskUpdate);

off

off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): void

Disables listening for update events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Update.UpdateService

Parameters

Error codes

For details about the error codes, see Update Error Codes.

Example

const eventClassifyInfo = {
  eventClassify: update.EventClassify.TASK, // Listening for update events
  extraInfo: ""
};

function onTaskUpdate(eventInfo) {
  console.log(`on eventInfo id `, eventInfo.eventId);
}

localUpdater.off(eventClassifyInfo, onTaskUpdate);

UpgradeInfo

Represents update information.

System capability: SystemCapability.Update.UpdateService

BusinessType

Enumerates update service types.

System capability: SystemCapability.Update.UpdateService

CheckResult

Represents the package check result.

System capability: SystemCapability.Update.UpdateService

NewVersionInfo

Represents information about the new version.

System capability: SystemCapability.Update.UpdateService

VersionDigestInfo

Represents version digest information.

System capability: SystemCapability.Update.UpdateService

VersionComponent

Represents a version component.

System capability: SystemCapability.Update.UpdateService

DescriptionOptions

Represents options of the description file.

System capability: SystemCapability.Update.UpdateService

ComponentDescription

Represents a component description file.

System capability: SystemCapability.Update.UpdateService

DescriptionInfo

Represents information about the version description file.

System capability: SystemCapability.Update.UpdateService

CurrentVersionInfo

Represents information about the current version.

System capability: SystemCapability.Update.UpdateService

DownloadOptions

Represents download options.

System capability: SystemCapability.Update.UpdateService

ResumeDownloadOptions

Represents options for resuming download.

System capability: SystemCapability.Update.UpdateService

PauseDownloadOptions

Represents options for pausing download.

System capability: SystemCapability.Update.UpdateService

UpgradeOptions

Represents update options.

System capability: SystemCapability.Update.UpdateService

ClearOptions

Represents options for clearing errors.

System capability: SystemCapability.Update.UpdateService

UpgradePolicy

Represents an update policy.

System capability: SystemCapability.Update.UpdateService

UpgradePeriod

Represents an automatic update period.

System capability: SystemCapability.Update.UpdateService

TaskInfo

Task information.

System capability: SystemCapability.Update.UpdateService

EventInfo

Represents event information.

System capability: SystemCapability.Update.UpdateService

TaskBody

Represents task data.

System capability: SystemCapability.Update.UpdateService

ErrorMessage

Represents an error message.

System capability: SystemCapability.Update.UpdateService

EventClassifyInfo

Represents event type information.

System capability: SystemCapability.Update.UpdateService

UpgradeFile

Represents an update file.

System capability: SystemCapability.Update.UpdateService

UpgradeTaskCallback

(eventInfo: EventInfo): void

Represents an event callback.

System capability: SystemCapability.Update.UpdateService

BusinessVendor

Represents a device vendor.

System capability: SystemCapability.Update.UpdateService

BusinessSubType

Represents an update type.

System capability: SystemCapability.Update.UpdateService

ComponentType

Represents a component type.

System capability: SystemCapability.Update.UpdateService

UpgradeAction

Represents an update mode.

System capability: SystemCapability.Update.UpdateService

EffectiveMode

Represents an effective mode.

System capability: SystemCapability.Update.UpdateService

DescriptionType

Represents a description file type.

System capability: SystemCapability.Update.UpdateService

DescriptionFormat

Represents a description file format.

System capability: SystemCapability.Update.UpdateService

NetType

Represents a network type.

System capability: SystemCapability.Update.UpdateService

Order

Represents an update command.

System capability: SystemCapability.Update.UpdateService

UpgradeStatus

Enumerates update states.

System capability: SystemCapability.Update.UpdateService

EventClassify

Represents an event type.

System capability: SystemCapability.Update.UpdateService

EventId

Enumerates event IDs.

System capability: SystemCapability.Update.UpdateService