js-apis-bundle-BundleInstaller.md 8.4 KB
Newer Older
J
junyi233 已提交
1 2 3 4 5
# BundleInstaller

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

W
wanghang 已提交
6
在设备上安装、升级和卸载应用
J
junyi233 已提交
7

W
wanghang 已提交
8
## BundleInstaller.install<sup>(deprecated)<sup>
J
junyi233 已提交
9

W
wanghang 已提交
10
> 从API version 9开始不再维护,建议使用[install](js-apis-installer.md)替代。
J
junyi233 已提交
11 12 13

install(bundleFilePaths: Array&lt;string&gt;, param: InstallParam, callback: AsyncCallback&lt;InstallStatus&gt;): void;

X
xsz233 已提交
14
以异步方法在应用中安装hap,支持多hap安装。使用callback形式返回结果。
J
junyi233 已提交
15 16 17 18 19 20 21 22 23

**需要权限:**

ohos.permission.INSTALL_BUNDLE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

J
junyi233 已提交
24 25
**系统API:** 此接口为系统接口,三方应用不支持调用

J
junyi233 已提交
26 27 28 29
**参数:**

| 名称            | 类型                                                 | 必填 | 描述                                                         |
| --------------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
X
xsz233 已提交
30
| bundleFilePaths | Array&lt;string&gt;                                  | 是   | 指示存储hap包的沙箱路径。沙箱路径的获取方法参见[获取应用的沙箱路径](#获取应用的沙箱路径)|
J
junyi233 已提交
31 32 33
| param           | [InstallParam](#installparam)                        | 是   | 指定安装所需的其他参数。                                     |
| callback        | AsyncCallback&lt;[InstallStatus](#installstatus)&gt; | 是   | 程序启动作为入参的回调函数,返回安装状态信息。               |

X
xsz233 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
**示例:**

```ts
import bundle from '@ohos.bundle';
let hapFilePaths = ['/data/storage/el2/base/haps/entry/files/'];
let installParam = {
    userId: 100,
    isKeepData: false,
    installFlag: 1,
};

bundle.getBundleInstaller().then(installer=>{
    installer.install(hapFilePaths, installParam, err => {
        if (err) {
            console.error('install failed:' + JSON.stringify(err));
        } else {
            console.info('install successfully.');
        }
    });
}).catch(error => {
    console.error('getBundleInstaller failed. Cause: ' + error.message);
});
```

W
wanghang 已提交
58 59 60
## BundleInstaller.uninstall<sup>(deprecated)<sup>

> 从API version 9开始不再维护,建议使用[uninstall](js-apis-installer.md)替代。
J
junyi233 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73

uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback&lt;InstallStatus&gt;): void;

以异步方法卸载应用程序,使用callback形式返回结果。

**需要权限:**

ohos.permission.INSTALL_BUNDLE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

J
junyi233 已提交
74 75
**系统API:** 此接口为系统接口,三方应用不支持调用

J
junyi233 已提交
76 77 78 79 80
**参数:**

| 名称       | 类型                                                 | 必填 | 描述                                           |
| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| bundleName | string                                               | 是   | 包名                                           |
X
xsz233 已提交
81
| param      | [InstallParam](#installparam)                        | 是   | 指定卸载所需的其他参数。                       |
J
junyi233 已提交
82 83
| callback   | AsyncCallback&lt;[InstallStatus](#installstatus)&gt; | 是   | 程序启动作为入参的回调函数,返回安装状态信息。 |

X
xsz233 已提交
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
**示例:**

```ts
import bundle from '@ohos.bundle';
let bundleName = 'com.ohos.demo';
let installParam = {
    userId: 100,
    isKeepData: false,
    installFlag: 1,
};

bundle.getBundleInstaller().then(installer=>{
    installer.uninstall(bundleName, installParam, err => {
        if (err) {
            console.error('uninstall failed:' + JSON.stringify(err));
        } else {
            console.info('uninstall successfully.');
        }
    });
}).catch(error => {
    console.error('getBundleInstaller failed. Cause: ' + error.message);
});
```
W
wanghang 已提交
107 108 109
## BundleInstaller.recover<sup>(deprecated)<sup>

> 从API version 9开始不再维护,建议使用[recover](js-apis-installer.md)替代。
J
junyi233 已提交
110 111 112

recover(bundleName: string, param: InstallParam, callback: AsyncCallback&lt;InstallStatus&gt;): void;

X
xsz233 已提交
113
以异步方法恢复一个应用程序,使用callback形式返回结果。当预置应用被卸载后,可以通过此接口进行恢复。
J
junyi233 已提交
114 115 116 117 118 119 120 121 122

**需要权限:**

ohos.permission.INSTALL_BUNDLE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

J
junyi233 已提交
123 124
**系统API:** 此接口为系统接口,三方应用不支持调用

J
junyi233 已提交
125 126 127 128 129
**参数:**

| 名称       | 类型                                                 | 必填 | 描述                                           |
| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| bundleName | string                                               | 是   | 包名                                           |
X
xsz233 已提交
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
| param      | [InstallParam](#installparam)                        | 是   | 指定应用恢复所需的其他参数。                       |
| callback   | AsyncCallback&lt;[InstallStatus](#installstatus)&gt; | 是   | 程序启动作为入参的回调函数,返回应用恢复状态信息。 |

**示例:**

```ts
import bundle from '@ohos.bundle';

let bundleName = 'com.ohos.demo';
let installParam = {
    userId: 100,
    isKeepData: false,
    installFlag: 1,
};

bundle.getBundleInstaller().then(installer=>{
    installer.recover(bundleName, installParam, err => {
        if (err) {
            console.error('recover failed:' + JSON.stringify(err));
        } else {
            console.info('recover successfully.');
        }
    });
}).catch(error => {
    console.error('getBundleInstaller failed. Cause: ' + error.message);
});
```
J
junyi233 已提交
157

W
wanghang 已提交
158
## InstallParam<sup>(deprecated)<sup>
J
junyi233 已提交
159 160 161 162 163

应用程序安装卸载信息

 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

J
junyi233 已提交
164 165
 **系统API:**  此接口为系统接口,三方应用不支持调用

X
xsz233 已提交
166 167
| 名称                           | 类型                           |可读|可写| 说明               |
| ------------------------------ | ------------------------------ | ---- |----|--------------- |
X
xsz233 已提交
168 169
| userId                         | number                         | 是|是 |指示用户id,可以通过[账户子系统](js-apis-)         |
| installFlag                    | number                         | 是|是 |指示安装标志 <br> 0表示正常安装 <br>1表示替代原有应用       |
X
xsz233 已提交
170
| isKeepData                     | boolean                        | 是|是 |指示应用删除后是否保留数据 |
J
junyi233 已提交
171 172


W
wanghang 已提交
173
## InstallStatus<sup>(deprecated)<sup>
J
junyi233 已提交
174

X
xsz233 已提交
175
应用程序安装卸载状态
J
junyi233 已提交
176 177 178

 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

J
junyi233 已提交
179 180
 **系统API:**  此接口为系统接口,三方应用不支持调用

J
junyi233 已提交
181 182 183
| 名称          | 类型                                                         | 可读 | 可写 | 说明                           |
| ------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------ |
| status        | bundle.[InstallErrorCode](js-apis-Bundle.md#installerrorcode) | 是   | 否   | 表示安装或卸载错误状态码       |
J
junyi233 已提交
184
| statusMessage | string                                                       | 是   | 否   | 表示安装或卸载的字符串结果信息 |
X
xsz233 已提交
185 186 187 188 189 190 191 192 193 194 195 196

## 获取应用的沙箱路径
对于FA模型,应用的沙箱路径可以通过[Context](js-apis-Context.md)中的方法获取;对于Stage模型,应用的沙箱路径可以通过[Context](js-apis-ability-context.md#abilitycontext)中的属性获取。

**示例:**
``` ts
// Stage模型
import Ability from '@ohos.application.Ability';
class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
        let context = this.context;
        let pathDir = context.filesDir;
X
xsz233 已提交
197
        console.info('sandbox path is ' + pathDir);
X
xsz233 已提交
198 199 200 201 202 203 204 205
    }
}

// FA模型
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
context.getFilesDir().then((data) => {
    let pathDir = data;
X
xsz233 已提交
206
    console.info('sandbox path is ' + pathDir);
X
xsz233 已提交
207 208
});
```