# BundleInstaller

The **BundleInstaller** module provides APIs for installing, updating, and deleting bundles on devices.

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

## System Capability

SystemCapability.BundleManager.BundleFramework

## BundleInstaller.install

install(bundleFilePaths: Array<string>, param: InstallParam, callback: AsyncCallback<InstallStatus>): void;

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

**Required permissions**

ohos.permission.INSTALL_BUNDLE

**System capability**

SystemCapability.BundleManager.BundleFramework

**Parameters**

| Name           | Type                                                | Mandatory| Description                                                        |
| --------------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| bundleFilePaths | Array<string>                                  | Yes  | Paths where the bundles are stored. Each path should point to a relative directory of the current application's data directory.|
| param           | [InstallParam](#installparam)                        | Yes  | Parameters required for the installation or uninstall.                                    |
| callback        | AsyncCallback<[InstallStatus](#installstatus)> | Yes  | Callback used to return the installation status.              |

## BundleInstaller.uninstall

uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback<InstallStatus>): void;

Uninstalls a bundle. This API uses an asynchronous callback to return the result.

**Required permissions**

ohos.permission.INSTALL_BUNDLE

**System capability**

SystemCapability.BundleManager.BundleFramework

**Parameters**

| Name      | Type                                                | Mandatory| Description                                          |
| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| bundleName | string                                               | Yes  | Bundle name.                                          |
| param      | [InstallParam](#installparam)                        | Yes  | Parameters required for the installation or uninstall.                      |
| callback   | AsyncCallback<[InstallStatus](#installstatus)> | Yes  | Callback used to return the installation status.|

## BundleInstaller.recover

recover(bundleName: string, param: InstallParam, callback: AsyncCallback<InstallStatus>): void;

Recovers a bundle. This API uses an asynchronous callback to return the result.

**Required permissions**

ohos.permission.INSTALL_BUNDLE

**System capability**

SystemCapability.BundleManager.BundleFramework

**Parameters**

| Name      | Type                                                | Mandatory| Description                                          |
| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| bundleName | string                                               | Yes  | Bundle name.                                          |
| param      | [InstallParam](#installparam)                        | Yes  | Parameters required for the installation or uninstall.                      |
| callback   | AsyncCallback<[InstallStatus](#installstatus)> | Yes  | Callback used to return the installation status.|

## InstallParam

Describes the parameters required for bundle installation or uninstall.

 **System capability**: SystemCapability.BundleManager.BundleFramework

| Name       | Type   | Description              |
| ----------- | ------- | ------------------ |
| userId      | number  | User ID.        |
| installFlag | number  | Installation flag.      |
| isKeepData  | boolean | Whether data is kept.|

## InstallStatus

Describes the bundle installation status.

 **System capability**: SystemCapability.BundleManager.BundleFramework

| Name         | Type                                                        | Readable| Writable| Description                          |
| ------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------ |
| status        | bundle.[InstallErrorCode](js-apis-Bundle.md#installerrorcode) | Yes  | No  | Installation or uninstall error code.      |
| statusMessage | string                                                       | Yes  | No  | Installation or uninstall status message.|