提交 084fb9ae 编写于 作者: S shawn_he

update doc

Signed-off-by: Nshawn_he <shawn.he@huawei.com>
上级 68c82983
...@@ -32,7 +32,7 @@ This is a system API. ...@@ -32,7 +32,7 @@ This is a system API.
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Type of the key input event to listen for. Only **key** is supported.| | type | string | Yes| Type of the key input event to listen for. Only **key** is supported.|
| keyOptions | [keyOptions](#keyOptions) | Yes| Key option, which specifies the condition for combination key input.| | keyOptions | [keyOptions](#keyoptions) | Yes| Key option, which specifies the condition for combination key input.|
| callback | Callback&lt;KeyOptions&gt; | Yes| Callback used to return the result.<br> When a key input event that meets the specified options occurs, **keyOptions** will be passed as an input parameter to **callback**.| | callback | Callback&lt;KeyOptions&gt; | Yes| Callback used to return the result.<br> When a key input event that meets the specified options occurs, **keyOptions** will be passed as an input parameter to **callback**.|
**Example** **Example**
...@@ -62,7 +62,7 @@ This is a system API. ...@@ -62,7 +62,7 @@ This is a system API.
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Type of the key input event to listen for. Only **key** is supported.| | type | string | Yes| Type of the key input event to listen for. Only **key** is supported.|
| keyOptions | [keyOptions](#keyOptions) | Yes| Key options passed to the key input event when listening starts.| | keyOptions | [keyOptions](#keyoptions) | Yes| Key options passed to the key input event when listening starts.|
| callback | Callback&lt;KeyOptions&gt; | Yes| Callback function passed to the key input event with **keyOptions** when listening starts.| | callback | Callback&lt;KeyOptions&gt; | Yes| Callback function passed to the key input event with **keyOptions** when listening starts.|
**Example** **Example**
......
...@@ -4,7 +4,8 @@ ...@@ -4,7 +4,8 @@
The Input Device module implements listening for connection, disconnection, and update events of input devices and displays information about input devices. For example, it can be used to listen for mouse insertion and removal and obtain information such as the ID, name, and pointer speed of the mouse. The Input Device module implements listening for connection, disconnection, and update events of input devices and displays information about input devices. For example, it can be used to listen for mouse insertion and removal and obtain information such as the ID, name, and pointer speed of the mouse.
> **NOTE**<br> > **NOTE**
>
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
...@@ -28,7 +29,7 @@ Enables listening for hot swap events of an input device. ...@@ -28,7 +29,7 @@ Enables listening for hot swap events of an input device.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ----------- | | -------- | ---------------------------------------- | ---- | ----------- |
| type | string | Yes | Event type of the input device. | | type | string | Yes | Event type of the input device. |
| listener | Callback&lt;[DeviceListener](#devicelistener<sup>9+</sup>)&gt; | Yes | Listener for events of the input device.| | listener | Callback&lt;[DeviceListener](#devicelistener9)&gt; | Yes | Listener for events of the input device.|
**Example** **Example**
...@@ -63,7 +64,7 @@ Disables listening for hot swap events of an input device. ...@@ -63,7 +64,7 @@ Disables listening for hot swap events of an input device.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ----------- | | -------- | ---------------------------------------- | ---- | ----------- |
| type | string | Yes | Event type of the input device. | | type | string | Yes | Event type of the input device. |
| listener | Callback&lt;[DeviceListener](#devicelistener<sup>9+</sup>)&gt; | No | Listener for events of the input device.| | listener | Callback&lt;[DeviceListener](#devicelistener9)&gt; | No | Listener for events of the input device.|
**Example** **Example**
...@@ -245,7 +246,7 @@ Obtains the keyboard type of an input device. This API uses an asynchronous call ...@@ -245,7 +246,7 @@ Obtains the keyboard type of an input device. This API uses an asynchronous call
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | --------------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------------- |
| deviceId | number | Yes | Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.| | deviceId | number | Yes | Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.|
| callback | AsyncCallback&lt;[KeyboardType](#keyboardtype)&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;[KeyboardType](#keyboardtype9)&gt; | Yes | Callback used to return the result. |
**Example** **Example**
...@@ -268,7 +269,7 @@ Obtains the keyboard type of an input device. This API uses a promise to return ...@@ -268,7 +269,7 @@ Obtains the keyboard type of an input device. This API uses a promise to return
| Parameter | Description | | Parameter | Description |
| ---------------------------------------- | ------------------- | | ---------------------------------------- | ------------------- |
| Promise&lt;[KeyboardType](#keyboardtype)&gt; | Promise used to return the result.| | Promise&lt;[KeyboardType](#keyboardtype9)&gt; | Promise used to return the result.|
**Example** **Example**
...@@ -336,7 +337,7 @@ Defines the axis range of an input device. ...@@ -336,7 +337,7 @@ Defines the axis range of an input device.
| Name | Type | Description | | Name | Type | Description |
| ----------------------- | ------------------------- | -------- | | ----------------------- | ------------------------- | -------- |
| source | [SourceType](#sourcetype) | Input source type of the axis.| | source | [SourceType](#sourcetype) | Input source type of the axis.|
| axis | [AxisType](#axistype) | Axis type. | | axis | [AxisType](#axistype9) | Axis type. |
| max | number | Maximum value of the axis. | | max | number | Maximum value of the axis. |
| min | number | Minimum value of the axis. | | min | number | Minimum value of the axis. |
| fuzz<sup>9+</sup> | number | Fuzzy value of the axis. | | fuzz<sup>9+</sup> | number | Fuzzy value of the axis. |
...@@ -358,7 +359,7 @@ Enumerates the input source types. For example, if a mouse reports an x-axis eve ...@@ -358,7 +359,7 @@ Enumerates the input source types. For example, if a mouse reports an x-axis eve
| touchpad | string | The input device is a touchpad.| | touchpad | string | The input device is a touchpad.|
| joystick | string | The input device is a joystick.| | joystick | string | The input device is a joystick.|
## ChangeType ## ChangedType
Defines the change type for the hot swap event of an input device. Defines the change type for the hot swap event of an input device.
......
# Input Method Framework # Input Method Framework
> **NOTE** The **inputMethod** module provides an input method framework, which can be used to hide the keyboard, obtain the list of installed input methods, display the dialog box for input method selection, and more.
> **NOTE**
> >
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
...@@ -8,14 +10,14 @@ ...@@ -8,14 +10,14 @@
## Modules to Import ## Modules to Import
``` ```
import inputMethod from '@ohos.inputMethod'; import inputMethod from '@ohos.inputmethod';
``` ```
## inputMethod<sup>8+</sup> ## inputMethod<sup>8+</sup>
Provides the constants. Provides the constants.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
| Name| Type| Readable| Writable| Description| | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
...@@ -26,7 +28,7 @@ Provides the constants. ...@@ -26,7 +28,7 @@ Provides the constants.
Describes the input method application attributes. Describes the input method application attributes.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
| Name| Type| Readable| Writable| Description| | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
...@@ -37,15 +39,15 @@ Describes the input method application attributes. ...@@ -37,15 +39,15 @@ Describes the input method application attributes.
getInputMethodController(): InputMethodController getInputMethodController(): InputMethodController
Obtains an [InputMethodController](#InputMethodController) instance. Obtains an **[InputMethodController](#inputmethodcontroller)** instance.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value** **Return value**
| Type| Description| | Type | Description |
| -------- | -------- | | ----------------------------------------- | ---------------------------- |
| [InputMethodController](#InputMethodController) | Returns the current **InputMethodController** instance.| | [InputMethodController](#inputmethodcontroller) | Returns the current **InputMethodController** instance.|
**Example** **Example**
...@@ -57,25 +59,74 @@ Obtains an [InputMethodController](#InputMethodController) instance. ...@@ -57,25 +59,74 @@ Obtains an [InputMethodController](#InputMethodController) instance.
getInputMethodSetting(): InputMethodSetting getInputMethodSetting(): InputMethodSetting
Obtains an [InputMethodSetting](#InputMethodSetting) instance. Obtains an **[InputMethodSetting](#inputmethodsetting8)** instance.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value** **Return value**
| Type | Description | | Type | Description |
| ----------------------------------------- | ---------------------------- | | ----------------------------------------- | ---------------------------- |
| [InputMethodSetting](#InputMethodSetting) | Returns the current **InputMethodSetting** instance.| | [InputMethodSetting](#inputmethodsetting8) | Returns the current **InputMethodSetting** instance.|
**Example** **Example**
```js ```js
var InputMethodSetting = inputMethod.getInputMethodSetting(); var InputMethodSetting = inputMethod.getInputMethodSetting();
``` ```
## inputMethod.switchInputMethod<sup>9+</sup>
switchInputMethod(target: InputmethodProperty, callback: AsyncCallback&lt;boolean&gt;): void;
Switches to another input method. This API uses an asynchronous callback to return the result. This API can be used only in the stage model.
**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
|target | [InputmethodProperty](#inputmethodproperty8) | Yes| Input method to switch to.|
| callback | AsyncCallback&lt;boolean&gt; | Yes| Callback used to return the execution result. |
**Example**
```js
inputMethod.switchInputMethod({packageName:"com.ohos.inputApp", methodId:"InputDemoService"}).then(res => {
prompt.showToast({message:"Input method switched." + this.imeList[this.flag].packageName, duration: 200});
});
```
## inputMethod.switchInputMethod<sup>9+</sup>
switchInputMethod(target: InputmethodProperty): Promise&lt;boolean&gt;
Switches to another input method. This API uses a promise to return the result. This API can be used only in the stage model.
**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
|target | [InputmethodProperty](#inputmethodproperty8)| Yes| Input method to switch to.|
**Return value**
| Type | Description |
| ----------------------------------------- | ---------------------------- |
| Promise\<boolean> | Promise used to return the execution result. |
**Example**
```js
inputMethod.switchInputMethod({packageName:"com.ohos.inputApp", methodId:"InputDemoService"}).then(res => {
prompt.showToast({message:"Input method switched." + this.imeList[this.flag].packageName, duration: 200});
});
```
## InputMethodController ## InputMethodController
In the following API examples, you must first use [getInputMethodController](#getInputMethodController) to obtain an **InputMethodController** instance, and then call the APIs using the obtained instance. In the following API examples, you must first use [getInputMethodController](#getinputmethodcontroller) to obtain an **InputMethodController** instance, and then call the APIs using the obtained instance.
### stopInput ### stopInput
...@@ -83,7 +134,7 @@ stopInput(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -83,7 +134,7 @@ stopInput(callback: AsyncCallback&lt;boolean&gt;): void
Hides the keyboard. This API uses an asynchronous callback to return the result. Hides the keyboard. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters** **Parameters**
...@@ -105,13 +156,13 @@ stopInput(): Promise&lt;boolean&gt; ...@@ -105,13 +156,13 @@ stopInput(): Promise&lt;boolean&gt;
Hides the keyboard. This API uses an asynchronous callback to return the result. Hides the keyboard. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | Promise used to return whether the keyboard is successfully hidden.| | Promise&lt;boolean&gt; | Promise used to return whether the keyboard is successfully hidden. |
**Example** **Example**
...@@ -123,7 +174,7 @@ Hides the keyboard. This API uses an asynchronous callback to return the result. ...@@ -123,7 +174,7 @@ Hides the keyboard. This API uses an asynchronous callback to return the result.
## InputMethodSetting<sup>8+</sup> ## InputMethodSetting<sup>8+</sup>
In the following API examples, you must first use [getInputMethodSetting](#getInputMethodSetting) to obtain an **InputMethodSetting** instance, and then call the APIs using the obtained instance. In the following API examples, you must first use [getInputMethodSetting](#getinputmethodsetting) to obtain an **InputMethodSetting** instance, and then call the APIs using the obtained instance.
### listInputMethod ### listInputMethod
...@@ -131,13 +182,12 @@ listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;) ...@@ -131,13 +182,12 @@ listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;)
Obtains the list of installed input methods. This API uses an asynchronous callback to return the result. Obtains the list of installed input methods. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | -------------------------------------------------- | ---- | ---------------------- | | -------- | -------------------------------------------------- | ---- | ---------------------- |
| callback | Array<[InputMethodProperty](#InputMethodProperty)> | Yes | Callback used to return the list of installed input methods.| | callback | Array<[InputMethodProperty](#inputmethodproperty8)> | Yes | Callback used to return the list of installed input methods.|
**Example** **Example**
...@@ -156,13 +206,12 @@ listInputMethod(): Array&lt;InputMethodProperty&gt; ...@@ -156,13 +206,12 @@ listInputMethod(): Array&lt;InputMethodProperty&gt;
Obtains the list of installed input methods. This API uses an asynchronous callback to return the result. Obtains the list of installed input methods. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value** **Return value**
| Type | Description | | Type | Description |
| ----------------------------------------------------------- | ---------------------- | | ----------------------------------------------------------- | ---------------------- |
| Promise<Array<[InputMethodProperty](#InputMethodProperty)>> | Promise used to return the list of installed input methods.| | Promise<Array<[InputMethodProperty](#inputmethodproperty8)>> | Promise used to return the list of installed input methods. |
**Example** **Example**
...@@ -180,15 +229,16 @@ displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void ...@@ -180,15 +229,16 @@ displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void
Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result. Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
- Parameters **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the execution result.| | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the execution result.|
**Example** **Example**
```js ```js
InputMethodSetting.displayOptionalInputMethod(()=>{ InputMethodSetting.displayOptionalInputMethod(()=>{
console.info('displayOptionalInputMethod is called'); console.info('displayOptionalInputMethod is called');
...@@ -201,16 +251,16 @@ Displays a dialog box for selecting an input method. This API uses an asynchrono ...@@ -201,16 +251,16 @@ Displays a dialog box for selecting an input method. This API uses an asynchrono
Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result. Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Miscservices.InputMethodFramework **System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | Promise used to return the execution result.| | Promise&lt;void&gt; | Promise used to return the execution result. |
**Example** **Example**
```js ```js
InputMethodSetting.displayOptionalInputMethod(); InputMethodSetting.displayOptionalInputMethod();
``` ```
\ No newline at end of file
# Update # Update
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
The Update module applies to updates throughout the entire system, including built-in resources and preset applications, but not third-party applications. 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. There are two types of updates: SD card update and over the air (OTA) update.
...@@ -10,135 +7,180 @@ There are two types of updates: SD card update and over the air (OTA) update. ...@@ -10,135 +7,180 @@ 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 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. - 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 ## Modules to Import
```js ```js
import update from '@ohos.update' import update from '@ohos.update'
``` ```
## Required Permissions ## update.getOnlineUpdater
None
## update.getUpdater
getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater
Obtains the **Updater** object for local update. Obtains an **OnlineUpdater** object.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| ----------- | --------------------------- | --------- | ------------ | | ----------- | --------------------------- | ---- | ------ |
| upgradeFile | string | Yes | Update file. | | upgradeInfo | [UpgradeInfo](#upgradeinfo) | Yes | **UpgradeInfo** object.|
| updateType | [UpdateTypes](#updatetypes) | Yes | Update type. |
**Return value** **Return value**
| Type | Description | | Type | Description |
| ------------------- | ------------------- | | ------------------- | ---- |
| [Updater](#updater) | **Updater** object. | | [Updater](#updater) | **OnlineUpdater** object.|
**Example** **Example**
``` ```ts
try { try {
let updater = update.getUpdater('/data/updater/updater.zip', 'OTA'); var upgradeInfo = {
upgradeApp: "com.ohos.ota.updateclient",
businessType: {
vendor: update.BusinessVendor.PUBLIC,
subType: update.BusinessSubType.FIRMWARE
}
}
let updater = update.getOnlineUpdater(upgradeInfo);
} catch(error) { } catch(error) {
console.error(" Fail to get updater error: " + error); console.error(`Fail to get updater error: ${error}`);
} }
``` ```
## update.getUpdaterForOther ## update.getRestorer
getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater getRestorer(): Restorer
Obtains the **Updater** object for the device to be updated. Obtains a **Restorer** object for restoring factory settings.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | --------------------------- | --------- | --------------------- |
| upgradeFile | string | Yes | Update file. |
| device | string | Yes | Device to be updated. |
| updateType | [UpdateTypes](#updatetypes) | Yes | Update type. |
**Return value** **Return value**
| Type | Description | | Type | Description |
| ------------------- | ------------------- | | --------------------- | ------ |
| [Updater](#updater) | **Updater** object. | | [Restorer](#restorer) | **Restorer** object for restoring factory settings.|
**Example** **Example**
``` ```ts
try { try {
let updater = update.getUpdaterForOther('/data/updater/updater.zip', '1234567890', 'OTA'); let restorer = update.getRestorer();
} catch(error) { } catch(error) {
console.error(" Fail to get updater error: " + error); console.error(`Fail to get restorer: ${error}`);
} }
``` ```
## update.getUpdaterFromOther ## update.getLocalUpdater
getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateTypes): Updater getLocalUpdater(): LocalUpdater
Obtains the **Updater** object from another device for the device to be updated. Obtains a **LocalUpdater** object.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Parameters**
| Name | Type | Mandatory | Description |
| ----------- | --------------------------- | --------- | --------------------- |
| upgradeFile | string | Yes | Update file. |
| device | string | Yes | Device to be updated. |
| updateType | [UpdateTypes](#updatetypes) | Yes | Update type. |
**Return value** **Return value**
| Type | Description | | Type | Description |
| ------------------- | ------------------- | | ----------------------------- | ------ |
| [Updater](#updater) | **Updater** object. | | [LocalUpdater](#localupdater) | **LocalUpdater** object.|
**Example** **Example**
``` ```ts
try { try {
let updater = update.getUpdaterFromOther('/data/updater/updater.zip', '1234567890', 'OTA'); let localUpdater = update.getLocalUpdater();
} catch(error) { } catch(error) {
console.error(" Fail to get updater error: " + error); console.error(`Fail to get localUpdater error: ${error}`);
} }
``` ```
## Updater ## 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**
| Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<[CheckResult](#checkresult)> | Yes | Callback used to return the result.|
**Example**
```ts
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**
| Type | Description |
| ------------------------------------- | ------------------- |
| Promise\<[CheckResult](#checkresult)> | Promise used to return the result.|
**Example**
```ts
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
getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
Obtains the new version information. This function uses an asynchronous callback to return the result. Obtains information about the new version. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | --------- | ---------------------------------------- | | -------- | ---------------------------------------- | ---- | --------------- |
| callback | AsyncCallback<[NewVersionInfo](#newversioninfo)> | No | Callback used to return the new version information. | | callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | Yes | Callback used to return the result.|
**Example** **Example**
``` ```ts
updater.getNewVersionInfo(info => { updater.getNewVersionInfo((err, info) => {
console.log("getNewVersionInfo success " + info.status); console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`);
console.log(`info versionName = ` + info.checkResult[0].versionName); console.log(`info innerVersion = ${info?.versionComponents[0].innerVersion}`);
console.log(`info versionCode = ` + info.checkResult[0].versionCode);
console.log(`info verifyInfo = ` + info.checkResult[0].verifyInfo);
}); });
``` ```
...@@ -146,451 +188,1562 @@ updater.getNewVersionInfo(info => { ...@@ -146,451 +188,1562 @@ updater.getNewVersionInfo(info => {
getNewVersionInfo(): Promise\<NewVersionInfo> getNewVersionInfo(): Promise\<NewVersionInfo>
Obtains the new version information. This function uses a promise to return the result. Obtains information about the new version. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Return value** **Return value**
| Type | Description | | Type | Description |
| ---------------------------------------- | ---------------------------------------- | | ---------------------------------------- | -------------------- |
| Promise\<[NewVersionInfo](#newversioninfo)> | Promise used to return the new version information. | | Promise\<[NewVersionInfo](#newversioninfo)> | Promise used to return the result.|
**Example** **Example**
``` ```ts
updater.getNewVersionInfo().then(value => { updater.getNewVersionInfo().then(info => {
console.log(`info versionName = ` + value.checkResult[0].versionName); console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`);
console.log(`info versionCode = ` + value.checkResult[0].versionCode); console.log(`info innerVersion = ${info.versionComponents[0].innerVersion}`);
console.log(`info verifyInfo = ` + value.checkResult[0].verifyInfo);
}).catch(err => { }).catch(err => {
console.log("getNewVersionInfo promise error: " + err.code); console.log(`getNewVersionInfo promise error ${JSON.stringify(err)}`);
}); });
``` ```
### checkNewVersion ### getNewVersionDescription
checkNewVersion(callback: AsyncCallback\<NewVersionInfo>): void getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions, callback: AsyncCallback\<Array\<ComponentDescription>>): void
Checks whether the current version is the latest. This function uses an asynchronous callback to return the result. Obtains the description file of the new version. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | --------- | ---------------------------------------- | | ------------------ | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | No | Callback used to return the new version information. | | versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information. |
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | Yes | Options of the description file. |
| callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>>) | Yes | Callback used to return the result.|
**Example** **Example**
``` ```ts
updater.checkNewVersion(info => { // Version digest information
console.log("checkNewVersion success " + info.status); var versionDigestInfo = {
console.log(`info versionName = ` + info.checkResult[0].versionName); versionDigest: "versionDigest" // Version digest information in the check result
console.log(`info versionCode = ` + info.checkResult[0].versionCode); }
console.log(`info verifyInfo = ` + info.checkResult[0].verifyInfo);
// Options of the description file
var descriptionOptions = {
format: 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)}`);
}); });
``` ```
### checkNewVersion ### getNewVersionDescription
checkNewVersion(): Promise\<NewVersionInfo> getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions): Promise\<Array\<ComponentDescription>>;
Checks whether the current version is the latest. This function uses a promise to return the result. Obtains the description file of the new version. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters**
| Name | Type | Mandatory | Description |
| ------------------ | ---------------------------------------- | ---- | ------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information.|
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | Yes | Options of the description file.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| ---------------------------------------- | ---------------------------------------- | | ---------------------------------------- | ------------------- |
| Promise\<[NewVersionInfo](#newversioninfo)> | Promise used to return the new version information. | | Promise\<Array\<[ComponentDescription](#componentdescription)>> | Promise used to return the result.|
**Example** **Example**
``` ```ts
updater.checkNewVersion().then(value => { // Version digest information
console.log(`info versionName = ` + value.checkResult[0].versionName); var versionDigestInfo = {
console.log(`info versionCode = ` + value.checkResult[0].versionCode); versionDigest: "versionDigest" // Version digest information in the check result
console.log(`info verifyInfo = ` + value.checkResult[0].verifyInfo); }
// Options of the description file
var descriptionOptions = {
format: DescriptionFormat.STANDARD, // Standard format
language: "zh-cn" // Chinese
}
updater.getNewVersionDescription(versionDigestInfo, descriptionOptions).then(info => {
console.log(`getNewVersionDescription promise info ${JSON.stringify(info)}`);
}).catch(err => { }).catch(err => {
console.log("checkNewVersion promise error: " + err.code); console.log(`getNewVersionDescription promise error ${JSON.stringify(err)}`);
}); });
``` ```
### verifyUpdatePackage ### getCurrentVersionInfo
verifyUpdatePackage(upgradeFile: string, certsFile: string): void getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void
Verifies whether the update package is valid. Obtains information about the current version. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| ----------- | ------ | --------- | ---------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------- |
| upgradeFile | string | Yes | Path of the update package to be verified. | | callback | AsyncCallback\<[CurrentVersionInfo](#currentversioninfo)> | Yes | Callback used to return the result.|
| certsFile | string | Yes | Certificate path. |
**Example** **Example**
``` ```ts
updater.on("verifyProgress", callback => { updater.getCurrentVersionInfo((err, info) => {
console.info('on verifyProgress ' + callback.percent); console.log(`info osVersion = ${info?.osVersion}`);
console.log(`info deviceName = ${info?.deviceName}`);
console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`);
}); });
update.verifyUpdatePackage("XXX", "XXX");
``` ```
### rebootAndCleanUserData<sup>8+</sup> ### getCurrentVersionInfo
rebootAndCleanUserData(): Promise\<number> getCurrentVersionInfo(): Promise\<CurrentVersionInfo>
Reboots the device and clears the user partition data. This function uses a promise to return the result. Obtains information about the current version. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Return value** **Return value**
| Type | Description | | Type | Description |
| ---------------- | ---------------------------------------- | | ---------------------------------------- | ------------------- |
| Promise\<number> | Promise used to return the execution result. | | Promise\<[CurrentVersionInfo](#currentversioninfo)> | Promise used to return the result.|
**Example** **Example**
``` ```ts
updater.rebootAndCleanUserData().then(result => { updater.getCurrentVersionInfo().then(info => {
console.log("rebootAndCleanUserData " + result); console.log(`info osVersion = ${info.osVersion}`);
console.log(`info deviceName = ${info.deviceName}`);
console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`);
}).catch(err => { }).catch(err => {
console.info("rebootAndCleanUserData promise error: " + err.code); console.log(`getCurrentVersionInfo promise error ${JSON.stringify(err)}`);
}); });
``` ```
### rebootAndCleanUserData<sup>8+</sup> ### getCurrentVersionDescription
rebootAndCleanUserData(callback: AsyncCallback\<number>): void getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: AsyncCallback\<Array\<ComponentDescription>>): void
Reboots the device and clears the user partition data. This function uses a promise to return the result. Obtains the description file of the current version. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------- | --------- | ---------------------------------------- | | ------------------ | ---------------------------------------- | ---- | --------------- |
| callback | AsyncCallback\<number> | Yes | Callback used to return the execution result. | | descriptionOptions | [DescriptionOptions](#descriptionoptions) | Yes | Options of the description file. |
| callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>>) | Yes | Callback used to return the result.|
**Example** **Example**
``` ```ts
updater.rebootAndCleanUserData(result => { // Options of the description file
console.log("rebootAndCleanUserData ", result) var descriptionOptions = {
format: 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)}`);
}); });
``` ```
### applyNewVersion ### getCurrentVersionDescription
applyNewVersion(): Promise\<number> getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<Array\<ComponentDescription>>
Installs the update package. This function uses a promise to return the result. Obtains the description file of the current version. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters**
| Name | Type | Mandatory | Description |
| ------------------ | ---------------------------------------- | ---- | ------ |
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | Yes | Options of the description file.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| ---------------- | ---------------------------------------- | | ---------------------------------------- | -------------------- |
| Promise\<number> | Promise used to return the execution result. | | Promise\<Array\<[ComponentDescription](#componentdescription)>> | Promise used to return the result.|
**Example** **Example**
``` ```ts
updater.applyNewVersion().then(result => { // Options of the description file
console.log("appVewVersion ", result) var descriptionOptions = {
format: DescriptionFormat.STANDARD, // Standard format
language: "zh-cn" // Chinese
}
updater.getCurrentVersionDescription(descriptionOptions).then(info => {
console.log(`getCurrentVersionDescription promise info ${JSON.stringify(info)}`);
}).catch(err => { }).catch(err => {
console.info("applyNewVersion promise error: " + err.code); console.log(`getCurrentVersionDescription promise error ${JSON.stringify(err)}`);
}); });
``` ```
### applyNewVersion ### getTaskInfo
applyNewVersion(callback: AsyncCallback\<number>): void getTaskInfo(callback: AsyncCallback\<TaskInfo>): void
Installs the update package. This function uses a promise to return the result. Obtains information about the update task. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------- | --------- | ---------------------------------------- | | -------- | ------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback\<number> | Yes | Callback used to return the execution result. | | callback | AsyncCallback\<[TaskInfo](#taskinfo)> | Yes | Callback used to return the result.|
**Example** **Example**
``` ```ts
updater.applyNewVersion(result => { updater.getTaskInfo((err, info) => {
console.log("applyNewVersion ", result) console.log(`getTaskInfo isexistTask= ${info?.existTask}`);
}); });
``` ```
### download ### getTaskInfo
download(): void getTaskInfo(): Promise\<TaskInfo>
Downloads the new version and displays the download process. Obtains information about the update task. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Return value**
| Type | Description |
| ------------------------------- | ------------------- |
| Promise\<[TaskInfo](#taskinfo)> | Promise used to return the result.|
**Example** **Example**
``` ```ts
updater.on("downloadProgress", progress => { updater.getTaskInfo().then(info => {
console.log("downloadProgress on" + progress); console.log(`getTaskInfo isexistTask= ${info.existTask}`);
console.log(`downloadProgress status: ` + progress.status); }).catch(err => {
console.log(`downloadProgress percent: ` + progress.percent); console.log(`getTaskInfo promise error ${JSON.stringify(err)}`);
}); });
updater.download();
``` ```
### upgrade ### download
upgrade():void download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions, callback: AsyncCallback\<void>): void
Starts an update. Downloads the new version. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters**
| Name | Type | Mandatory | Description |
| ----------------- | --------------------------------------- | ---- | ---------------------------------- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information. |
| downloadOptions | [DownloadOptions](#downloadoptions) | Yes | Download options. |
| callback | AsyncCallback\<void> | Yes | Callback invoked to return the result. If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.|
**Example** **Example**
``` ```ts
updater.on("upgradeProgress", progress => { // Version digest information
console.log("upgradeProgress on" + progress); var versionDigestInfo = {
console.log(`upgradeProgress status: ` + progress.status); versionDigest: "versionDigest" // Version digest information in the check result
console.log(`upgradeProgress percent: ` + progress.percent); }
// Download options
var 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)}`);
}); });
updater.upgrade();
``` ```
### setUpdatePolicy ### download
setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\<number>): void download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions): Promise\<void>
Sets the update policy. This function uses an asynchronous callback to return the result. Downloads the new version. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | --------- | ---------------------------------------- | | ----------------- | --------------------------------------- | ---- | ------ |
| policy | [UpdatePolicy](#updatepolicy) | Yes | Update policy to set. | | versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information.|
| callback | Callback used to return the execution result. | Yes | Callback used to return the execution result. | | downloadOptions | [DownloadOptions](#downloadoptions) | Yes | Download options. |
**Return value**
| Type | Description |
| -------------- | -------------------------- |
| Promise\<void> | Promise that returns no value.|
**Example** **Example**
```ts
// Version digest information
var versionDigestInfo = {
versionDigest: "versionDigest" // Version digest information in the check result
}
// Download options
var 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)}`);
});
``` ```
// Set the update policy.
let policy = { ### resumeDownload
autoDownload: false,
autoDownloadNet: true, resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: ResumeDownloadOptions, callback: AsyncCallback\<void>): void
mode: 2,
autoUpgradeInterval: [ 2, 3 ], Resumes download of the new version. This API uses an asynchronous callback to return the result.
autoUpgradeCondition: 2
**System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters**
| Name | Type | Mandatory | Description |
| --------------------- | ---------------------------------------- | ---- | ------------------------------------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information. |
| resumeDownloadOptions | [ResumeDownloadOptions](#resumedownloadoptions) | Yes | Options for resuming download. |
| callback | AsyncCallback\<void> | Yes | Callback invoked to return the result. If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.|
**Example**
```ts
// Version digest information
var versionDigestInfo = {
versionDigest: "versionDigest" // Version digest information in the check result
}
// Options for resuming download
var resumeDownloadOptions = {
allowNetwork: update.NetType.CELLULAR, // Whether to allow download over data network
} }
updater.setUpdatePolicy(policy, result => { updater.resumeDownload(versionDigestInfo, resumeDownloadOptions, (err) => {
console.log("setUpdatePolicy ", result) console.log(`resumeDownload error ${JSON.stringify(err)}`);
}); });
``` ```
### setUpdatePolicy ### resumeDownload
setUpdatePolicy(policy: UpdatePolicy): Promise\<number> resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: ResumeDownloadOptions): Promise\<void>
Sets the update policy. This function uses a promise to return the result. Resumes download of the new version. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| ------ | ----------------------------- | --------- | --------------------- | | --------------------- | ---------------------------------------- | ---- | ------ |
| policy | [UpdatePolicy](#updatepolicy) | Yes | Update policy to set. | | versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information.|
| resumeDownloadOptions | [ResumeDownloadOptions](#resumedownloadoptions) | Yes | Options for resuming download.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| ---------------- | ---------------------------------------- | | -------------- | -------------------------- |
| Promise\<number> | Promise used to return the execution result. | | Promise\<void> | Promise that returns no value.|
**Example** **Example**
```ts
// Version digest information
var versionDigestInfo = {
versionDigest: "versionDigest" // Version digest information in the check result
}
// Options for resuming download
var 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)}`);
});
``` ```
let policy = {
autoDownload: false, ### pauseDownload
autoDownloadNet: true,
mode: 2, pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseDownloadOptions, callback: AsyncCallback\<void>): void
autoUpgradeInterval: [ 2, 3 ],
autoUpgradeCondition: 2 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**
| Name | Type | Mandatory | Description |
| -------------------- | ---------------------------------------- | ---- | ------------------------------------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information. |
| pauseDownloadOptions | [PauseDownloadOptions](#pausedownloadoptions) | Yes | Options for pausing download. |
| callback | AsyncCallback\<void> | Yes | Callback invoked to return the result. If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.|
**Example**
```ts
// Version digest information
var versionDigestInfo = {
versionDigest: "versionDigest" // Version digest information in the check result
}
// Options for pausing download
var pauseDownloadOptions = {
isAllowAutoResume: true // Whether to allow automatic resuming of download
} }
updater.setUpdatePolicy(policy).then(result => updater.pauseDownload(versionDigestInfo, pauseDownloadOptions, (err) => {
console.log("setUpdatePolicy ", result) console.log(`pauseDownload error ${JSON.stringify(err)}`);
).catch(err => {
console.log("setUpdatePolicy promise error: " + err.code);
}); });
``` ```
### getUpdatePolicy ### pauseDownload
getUpdatePolicy(callback: AsyncCallback\<UpdatePolicy>): void pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseDownloadOptions): Promise\<void>
Obtains the update policy. This function uses an asynchronous callback to return the result. Resumes download of the new version. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | --------- | ---------------------------------------- | | -------------------- | ---------------------------------------- | ---- | ------ |
| callback | AsyncCallback\<[UpdatePolicy](#updatepolicy)> | No | Callback used to return the update policy. | | versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information.|
| pauseDownloadOptions | [PauseDownloadOptions](#pausedownloadoptions) | Yes | Options for pausing download.|
**Return value**
| Type | Description |
| -------------- | -------------------------- |
| Promise\<void> | Promise that returns no value.|
**Example** **Example**
```ts
// Version digest information
var versionDigestInfo = {
versionDigest: "versionDigest" // Version digest information in the check result
}
// Options for pausing download
var 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)}`);
});
``` ```
updater.getUpdatePolicy(policy => {
console.log("getUpdatePolicy success"); ### upgrade
console.log(`policy autoDownload = ` + policy.autoDownload);
console.log(`policy autoDownloadNet = ` + policy.autoDownloadNet); upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, callback: AsyncCallback\<void>): void
console.log(`policy mode = ` + policy.mode);
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**
| Name | Type | Mandatory | Description |
| ----------------- | --------------------------------------- | ---- | ------------------------------------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information. |
| upgradeOptions | [UpgradeOptions](#upgradeoptions) | Yes | Update options. |
| callback | AsyncCallback\<void> | Yes | Callback invoked to return the result. If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.|
**Example**
```ts
// Version digest information
var versionDigestInfo = {
versionDigest: "versionDigest" // Version digest information in the check result
}
// Installation options
var upgradeOptions = {
order: update.Order.INSTALL // Installation command
}
updater.upgrade(versionDigestInfo, upgradeOptions, (err) => {
console.log(`upgrade error ${JSON.stringify(err)}`);
}); });
``` ```
### getUpdatePolicy ### upgrade
getUpdatePolicy(): Promise\<UpdatePolicy> upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): Promise\<void>
Obtains the update policy. This function uses a promise to return the result. Updates the version. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
**Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
**Parameters**
| Name | Type | Mandatory | Description |
| ----------------- | --------------------------------------- | ---- | ------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information.|
| upgradeOptions | [UpgradeOptions](#upgradeoptions) | Yes | Update options. |
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------------------------- | ---------------------------------------- | | -------------- | -------------------------- |
| Promise\<[UpdatePolicy](#updatepolicy)> | Promise used to return the update policy. | | Promise\<void> | Promise that returns no value.|
**Example** **Example**
``` ```ts
updater.getUpdatePolicy().then(value => { // Version digest information
console.log(`info autoDownload = ` + value.autoDownload); var versionDigestInfo = {
console.log(`info autoDownloadNet = ` + value.autoDownloadNet); versionDigest: "versionDigest" // Version digest information in the check result
console.log(`info mode = ` + value.mode); }
// Installation options
var upgradeOptions = {
order: update.Order.INSTALL // Installation command
}
updater.upgrade(versionDigestInfo, upgradeOptions).then(() => {
console.log(`upgrade start`);
}).catch(err => { }).catch(err => {
console.log("getUpdatePolicy promise error: " + err.code); console.log(`upgrade error ${JSON.stringify(err)}`);
}); });
``` ```
## UpdateTypes ### clearError
Enumerates update types. 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 **System capability**: SystemCapability.Update.UpdateService
| Name | Description | **Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
| ----- | ------------- |
| OTA | OTA update. | **Parameters**
| patch | Patch update. |
| Name | Type | Mandatory | Description |
| ----------------- | --------------------------------------- | ---- | ------------------------------------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information. |
| clearOptions | [ClearOptions](#clearoptions) | Yes | Clear options. |
| callback | AsyncCallback\<void> | Yes | Callback invoked to return the result. If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.|
**Example**
```ts
// Version digest information
var versionDigestInfo = {
versionDigest: "versionDigest" // Version digest information in the check result
}
// Options for clearing errors
var clearOptions = {
status: update.UpgradeStatus.UPGRADE_FAIL,
}
updater.clearError(versionDigestInfo, clearOptions, (err) => {
console.log(`clearError error ${JSON.stringify(err)}`);
});
```
### clearError
## PackageTypes clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Promise\<void>
Enumerates update package types. Clears errors. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description | **Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
| -------------------- | ------------- | --------------------------------------- |
| PACKAGE_TYPE_NORMAL | 1 | Common update package. | **Parameters**
| PACKAGE_TYPE_BASE | 2 | Basic update package. |
| PACKAGE_TYPE_CUST | 3 | Custom update package. | | Name | Type | Mandatory | Description |
| PACKAGE_TYPE_PRELOAD | 4 | Preinstalled update package. | | ----------------- | --------------------------------------- | ---- | ------ |
| PACKAGE_TYPE_COTA | 5 | Parameter configuration update package. | | versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information.|
| PACKAGE_TYPE_VERSION | 6 | Version update package. | | clearOptions | [ClearOptions](#clearoptions) | Yes | Update options. |
| PACKAGE_TYPE_PATCH | 7 | Patch package. |
**Return value**
| Type | Description |
| -------------- | -------------------------- |
| Promise\<void> | Promise that returns no value.|
**Example**
```ts
// Version digest information
var versionDigestInfo = {
versionDigest: "versionDigest" // Version digest information in the check result
}
// Options for clearing errors
var clearOptions = {
status: update.UpgradeStatus.UPGRADE_FAIL,
}
updater.clearError(versionDigestInfo, clearOptions).then(() => {
console.log(`clearError success`);
}).catch(err => {
console.log(`clearError error ${JSON.stringify(err)}`);
});
```
## InstallMode ### getUpgradePolicy
Enumerates update modes. getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void
Obtains the update policy. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description | **Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
| ------------------- | ------------- | ----------------- |
| INSTALL_MODE_NORMAL | 0 | Normal update. | **Parameters**
| INSTALL_MODE_NIGHT | 1 | Update at night. |
| INSTALL_MODE_AUTO | 2 | Automatic update. | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | --------------- |
| callback | AsyncCallback\<[UpgradePolicy](#upgradepolicy)> | Yes | Callback used to return the result.|
**Example**
```ts
updater.getUpgradePolicy((err, policy) => {
console.log(`policy downloadStrategy = ${policy?.downloadStrategy}`);
console.log(`policy autoUpgradeStrategy = ${policy?.autoUpgradeStrategy}`);
});
```
### getUpgradePolicy
## NewVersionStatus getUpgradePolicy(): Promise\<UpgradePolicy>
Enumerates new version check results. Obtains the update policy. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description | **Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
| ------------------- | ------------- | ---------------------------------------- |
| VERSION_STATUS_ERR | -1 | System error while checking for the new version. | **Return value**
| VERSION_STATUS_NEW | 0 | New version detected. |
| VERSION_STATUS_NONE | 1 | No new version detected. | | Type | Description |
| VERSION_STATUS_BUSY | 2 | System busy while checking for the new version. | | ---------------------------------------- | --------------------- |
| Promise\<[UpgradePolicy](#upgradepolicy)> | Promise used to return the result.|
**Example**
```ts
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
## UpdatePolicy setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void
Defines the update policy. Sets the update policy. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description | **Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
| ------------------- | --------------------------- | --------- | ------------------------------------ |
| autoDownload | bool | Yes | Automatic update switch. |
| installMode | [InstallMode](#installmode) | Yes | Update mode. |
| autoUpgradeInterval | Array\<number> | Yes | Period of time for automatic update. |
## NewVersionInfo **Parameters**
| Name | Type | Mandatory | Description |
| -------- | ------------------------------- | ---- | ------------- |
| policy | [UpgradePolicy](#upgradepolicy) | Yes | Update policy. |
| callback | AsyncCallback\<void> | Yes | Callback used to return the result.|
**Example**
```ts
let policy = {
downloadStrategy: false,
autoUpgradeStrategy: false,
autoUpgradePeriods: [ { start: 120, end: 240 } ] // Automatic update period, in minutes
}
updater.setUpgradePolicy(policy, (err) => {
console.log(`setUpgradePolicy result: ${err}`);
});
```
Defines the new version information. ### setUpgradePolicy
setUpgradePolicy(policy: UpgradePolicy): Promise\<void>
Sets the update policy. This API uses a promise to return the result.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description | **Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
| --------------- | ---------------------------------------- | --------- | -------------------------------- |
| status | [NewVersionStatus](#newversionstatus) | Yes | Update status. |
| errMsg | string | Yes | Error message. |
| checkResults | Array<[CheckResult](#checkresult)> | Yes | Version check result. |
| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | Yes | Version description information. |
## CheckResult **Parameters**
Defines the version check result. | Name | Type | Mandatory | Description |
| ------ | ------------------------------- | ---- | ---- |
| policy | [UpgradePolicy](#upgradepolicy) | Yes | Update policy.|
**Return value**
| Type | Description |
| -------------- | ------------------- |
| Promise\<void> | Promise used to return the result.|
**Example**
```ts
let 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 **System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description | **Required permission**: ohos.permission.UPDATE_SYSTEM (a system permission)
| ------------- | ----------------------------- | --------- | --------------------------------- |
| versionName | string | Yes | Version name. |
| versionCode | number | Yes | Version code. |
| size | number | Yes | Version size. |
| verifyInfo | string | Yes | Version verification information. |
| packageType | [PackageTypes](#packagetypes) | Yes | Version type. |
| descriptionId | string | Yes | Version description information. |
## DescriptionInfo **Parameters**
| Name | Type | Mandatory | Description |
| -------- | -------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<void> | Yes | Callback invoked to return the result. If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.|
**Example**
```ts
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**
| Type | Description |
| -------------- | -------------------------- |
| Promise\<void> | Promise that returns no value.|
**Example**
```ts
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**
| Name | Type | Mandatory | Description |
| ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | Yes | Event information.|
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | Yes | Event callback.|
**Example**
```ts
var 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**
| Name | Type | Mandatory | Description |
| ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | Yes | Event information.|
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | No | Event callback.|
**Example**
```ts
var 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
Restore the device 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**
| Name | Type | Mandatory | Description |
| -------- | -------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<void> | Yes | Callback invoked to return the result. If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.|
**Example**
```ts
restorer.factoryReset((err) => {
console.log(`factoryReset error ${JSON.stringify(err)}`);
});
```
### factoryReset
factoryReset(): Promise\<void>
Restore the device 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**
| Type | Description |
| -------------- | -------------------------- |
| Promise\<void> | Promise that returns no value.|
**Example**
```ts
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**
| Name | Type | Mandatory | Description |
| ----------- | --------------------------- | ---- | ---------------- |
| upgradeFile | [UpgradeFile](#upgradefile) | Yes | Update file. |
| certsFile | string | Yes | Path of the certificate file. |
| callback | AsyncCallback\<void> | Yes | Callback used to return the result.|
**Example**
```ts
var 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**
| Name | Type | Mandatory | Description |
| ----------- | --------------------------- | ---- | ------ |
| upgradeFile | [UpgradeFile](#upgradefile) | Yes | Update file. |
| certsFile | string | Yes | Path of the certificate file.|
**Return value**
| Type | Description |
| -------------- | ---------------------- |
| Promise\<void> | Promise used to return the result.|
**Example**
```ts
var 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](#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**
| Name | Type | Mandatory | Description |
| ----------- | ---------------------------------- | ---- | --------------------------------------- |
| upgradeFile | Array<[UpgradeFile](#upgradefile)> | Yes | Update file. |
| callback | AsyncCallback\<void> | Yes | Callback invoked to return the result. If the operation is successful, `err` is `undefined`; otherwise, `err` is an `Error` object.|
**Example**
```ts
var 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](#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**
| Type | Description |
| -------------- | -------------------------- |
| Promise\<void> | Promise that returns no value.|
**Example**
```ts
var 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**
| Name | Type | Mandatory | Description |
| ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | Yes | Event information.|
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | Yes | Event callback.|
**Example**
```ts
var 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**
| Name | Type | Mandatory | Description |
| ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | Yes | Event information.|
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | Yes | Event callback.|
**Example**
```ts
var 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
| Name | Type | Mandatory | Description |
| ------------ | ----------------------------- | ---- | ------ |
| upgradeApp | string | Yes | Application package name. |
| businessType | [BusinessType](#businesstype) | Yes | Update service type.|
## BusinessType
Enumerates update service types.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ------- | ----------------------------------- | ---- | ---- |
| vendor | [BusinessVendor](#businessvendor) | Yes | Application vendor. |
| subType | [BusinessSubType](#businesssubtype) | Yes | Type |
## CheckResult
Represents the package check result.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ----------------- | --------------------------------- | ---- | ------ |
| isExistNewVersion | bool | Yes | Whether a new version is available.|
| newVersionInfo | [NewVersionInfo](#newversioninfo) | No | Information about the new version. |
## NewVersionInfo
Represents information about the new version.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ----------------- | ---------------------------------------- | ---- | ---- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information.|
| versionComponents | Array\<[VersionComponent](#versioncomponent)> | Yes | Version components.|
## VersionDigestInfo
Represents version digest information.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ------------- | ------ | ---- | ---- |
| versionDigest | string | Yes | Version digest information.|
## VersionComponent
Represents a version component.
**System capability**: SystemCapability.Update.UpdateService
| Parameter | Type | Mandatory | Description |
| --------------- | ----------------------------------- | ---- | -------- |
| componentId | number | Yes | Component ID. |
| componentType | [ComponentType](#componenttype) | Yes | Component type. |
| upgradeAction | [UpgradeAction](#upgradeaction) | Yes | Update mode. |
| displayVersion | string | Yes | Display version number. |
| innerVersion | string | Yes | Internal version number. |
| size | number | Yes | Update package size. |
| effectiveMode | [EffectiveMode](#effectivemode) | Yes | Effective mode. |
| descriptionInfo | [DescriptionInfo](#descriptioninfo) | Yes | Information about the version description file.|
## DescriptionOptions
Represents options of the description file.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| -------- | --------------------------------------- | ---- | ------ |
| format | [DescriptionFormat](#descriptionformat) | Yes | Format of the description file.|
| language | string | Yes | Language of the description file.|
## ComponentDescription
Represents a component description file.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| --------------- | ----------------------------------- | ---- | ------ |
| componentId | string | Yes | Component ID. |
| descriptionInfo | [DescriptionInfo](#descriptioninfo) | Yes | Information about the description file.|
## DescriptionInfo
Represents information about the version description file.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| --------------- | ----------------------------------- | ---- | ------ |
| descriptionType | [DescriptionType](#descriptiontype) | Yes | Type of the description file.|
| content | string | Yes | Content of the description file.|
## CurrentVersionInfo
Represents information about the current version.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ----------------- | ---------------------------------------- | ---- | ----- |
| osVersion | string | Yes | System version number.|
| deviceName | string | Yes | Device name. |
| versionComponents | Array\<[VersionComponent](#versioncomponent)> | No | Version components. |
## DownloadOptions
Represents download options.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ------------ | ------------------- | ---- | ---- |
| allowNetwork | [NetType](#nettype) | Yes | Network type.|
| order | [Order](#order) | Yes | Update command.|
## ResumeDownloadOptions
Represents options for resuming download.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ------------ | ------------------- | ---- | ---- |
| allowNetwork | [NetType](#nettype) | Yes | Network type.|
## PauseDownloadOptions
Represents options for pausing download.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type| Mandatory | Description |
| ----------------- | ---- | ---- | -------- |
| isAllowAutoResume | bool | Yes | Whether to allow automatic resuming of download.|
## UpgradeOptions
Represents update options.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ----- | --------------- | ---- | ---- |
| order | [Order](#order) | Yes | Update command.|
## ClearOptions
Represents options for clearing errors.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ------ | ------------------------------- | ---- | ---- |
| status | [UpgradeStatus](#upgradestatus) | Yes | Error status.|
## UpgradePolicy
Represents an update policy.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ------------------- | --------------------------------------- | ---- | ------- |
| downloadStrategy | bool | Yes | Automatic download policy. |
| autoUpgradeStrategy | bool | Yes | Automatic update policy. |
| autoUpgradePeriods | Array\<[UpgradePeriod](#upgradeperiod)> | Yes | Automatic update period.|
## UpgradePeriod
Represents a period for automatic update.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ----- | ------ | ---- | ---- |
| start | number | Yes | Start time.|
| end | number | Yes | End time.|
## TaskInfo
Represents task information.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| --------- | --------------------- | ---- | ------ |
| existTask | bool | Yes | Whether a task exists.|
| taskBody | [TaskBody](#taskinfo) | Yes | Task data. |
## EventInfo
Represents event type information.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| -------- | --------------------- | ---- | ---- |
| eventId | [EventId](#eventid) | Yes | Event ID.|
| taskBody | [TaskBody](#taskinfo) | Yes | Task data.|
## TaskBody
Represents task data.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ----------------- | ---------------------------------------- | ---- | ---- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | Yes | Version digest information.|
| status | [UpgradeStatus](#upgradestatus) | Yes | Update status.|
| subStatus | number | No | Sub-status. |
| progress | number | Yes | Progress. |
| installMode | number | Yes | Installation mode.|
| errorMessages | Array\<[ErrorMessage](#errormessage)> | No | Error message.|
| versionComponents | Array\<[VersionComponent](#versioncomponent)> | Yes | Version components.|
## ErrorMessage
Represents an error message.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ------------ | ------ | ---- | ---- |
| errorCode | number | Yes | Error code. |
| errorMessage | string | Yes | Error description.|
## EventClassifyInfo
Represents event type information.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| ------------- | ------------------------------- | ---- | ---- |
| eventClassify | [EventClassify](#eventclassify) | Yes | Event type.|
| extraInfo | string | Yes | Additional information.|
## UpgradeFile
Represents an update file.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| -------- | ------------------------------- | ---- | ---- |
| fileType | [ComponentType](#componenttype) | Yes | File type.|
| filePath | string | Yes | File path.|
## UpgradeTaskCallback
### (eventInfo: [EventInfo](#eventinfo)): void
Represents an event callback.
**System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description |
| --------- | ----------------------- | ---- | ---- |
| eventInfo | [EventInfo](#eventinfo) | Yes | Event information.|
## BusinessVendor
Device vendor.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| ------ | -------- | ---- |
| PUBLIC | "public" | Open source. |
## BusinessSubType
Represents an update type.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| -------- | ---- | ---- |
| FIRMWARE | 1 | Firmware. |
## ComponentType
Represents a component type.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| ---- | ---- | ---- |
| OTA | 1 | Firmware. |
## UpgradeAction
Represents an update mode.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| -------- | ---------- | ---- |
| UPGRADE | "upgrade" | Differential package. |
| RECOVERY | "recovery" | Recovery package. |
## EffectiveMode
Represents an effective mode.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| ------------- | ---- | ---- |
| COLD | 1 | Cold update. |
| LIVE | 2 | Live update. |
| LIVE_AND_COLD | 3 | Hybrid live and cold update.|
## DescriptionType
Represents a description file type.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| ------- | ---- | ---- |
| CONTENT | 0 | Content. |
| URI | 1 | Link. |
## DescriptionFormat
Represents a description file format.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| ---------- | ---- | ---- |
| STANDARD | 0 | Standard format.|
| SIMPLIFIED | 1 | Simple format.|
## NetType
Enumerates network types.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| ----------------- | ---- | --------- |
| CELLULAR | 1 | Data network. |
| METERED_WIFI | 2 | Wi-Fi hotspot. |
| NOT_METERED_WIFI | 4 | Non Wi-Fi hotspot. |
| WIFI | 6 | Wi-Fi. |
| CELLULAR_AND_WIFI | 7 | Data network and Wi-Fi.|
## Order
Represents an update command.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| -------------------- | ---- | ----- |
| DOWNLOAD | 1 | Download. |
| INSTALL | 2 | Install. |
| DOWNLOAD_AND_INSTALL | 3 | Download and install.|
| APPLY | 4 | Apply. |
| INSTALL_AND_APPLY | 6 | Install and apply.|
## UpgradeStatus
Enumerates update states.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| ---------------- | ---- | ---- |
| WAITING_DOWNLOAD | 20 | Waiting for download. |
| DOWNLOADING | 21 | Downloading. |
| DOWNLOAD_PAUSED | 22 | Download paused.|
| DOWNLOAD_FAIL | 23 | Download failed.|
| WAITING_INSTALL | 30 | Waiting for installation. |
| UPDATING | 31 | Updating. |
| WAITING_APPLY | 40 | Waiting for applying the update. |
| APPLYING | 21 | Applying the update. |
| UPGRADE_SUCCESS | 50 | Update succeeded.|
| UPGRADE_FAIL | 51 | Update failed.|
## EventClassify
Represents an event type.
**System capability**: SystemCapability.Update.UpdateService
| Name | Default Value | Description |
| ---- | ---------- | ---- |
| TASK | 0x01000000 | Task event.|
## EventId
Defines the version description information. Enumerates event IDs.
**System capability**: SystemCapability.Update.UpdateService **System capability**: SystemCapability.Update.UpdateService
| Name | Type | Mandatory | Description | | Name | Default Value | Description |
| ------------- | ------ | --------- | ------------------------------ | | ---------------------- | ---------- | ------ |
| descriptionId | string | Yes | Version ID information. | | EVENT_TASK_BASE | 0x01000000 | Indicates a task event. |
| content | string | Yes | Version changelog information. | | EVENT_TASK_RECEIVE | 0x01000001 | Indicates that a task is received. |
| EVENT_TASK_CANCEL | 0x01000010 | Indicates that a task is cancelled. |
| EVENT_DOWNLOAD_WAIT | 0x01000011 | Indicates the state of waiting for the download. |
| EVENT_DOWNLOAD_START | 0x01000100 | Indicates that the download starts. |
| EVENT_DOWNLOAD_UPDATE | 0x01000101 | Indicates the download progress update.|
| EVENT_DOWNLOAD_PAUSE | 0x01000110 | Indicates that the download is paused. |
| EVENT_DOWNLOAD_RESUME | 0x01000111 | Indicates that the download is resumed. |
| EVENT_DOWNLOAD_SUCCESS | 0x01001000 | Indicates that the download succeeded. |
| EVENT_DOWNLOAD_FAIL | 0x01001001 | Indicates that the download failed. |
| EVENT_UPGRADE_WAIT | 0x01001010 | Indicates the state of waiting for the update. |
| EVENT_UPGRADE_START | 0x01001011 | Indicates that the update starts. |
| EVENT_UPGRADE_UPDATE | 0x01001100 | Indicates that the update is in progress. |
| EVENT_APPLY_WAIT | 0x01001101 | Indicates the state of waiting for applying the update. |
| EVENT_APPLY_START | 0x01001110 | Indicates the state of applying the update. |
| EVENT_UPGRADE_SUCCESS | 0x01001111 | Indicates that the update succeeded. |
| EVENT_UPGRADE_FAIL | 0x01010000 | Indicates that the update failed. |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册