提交 36047115 编写于 作者: X xsz233

modify BundleInstaller doc

Signed-off-by: Nxsz233 <xushizhe@huawei.com>
上级 cd982c66
......@@ -7,15 +7,13 @@
在设备上安装、升级和删除捆绑包
本模块提供在设备上安装、升级和删除应用的能力。
## BundleInstaller.install
install(bundleFilePaths: Array&lt;string&gt;, param: InstallParam, callback: AsyncCallback&lt;InstallStatus&gt;): void;
以异步方法在HAP中安装应用程序,使用callback形式返回结果。
以异步方法为应用安装hap,支持多hap安装。使用callback形式返回结果。
**需要权限:**
......@@ -31,10 +29,34 @@ SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 必填 | 描述 |
| --------------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| bundleFilePaths | Array&lt;string&gt; | 是 | 指示存储应用程序包的路径。路径应该是当前应用程序的数据目录的相对路径。 |
| bundleFilePaths | Array&lt;string&gt; | 是 | 指示存储hap包的沙箱路径,应用的沙箱路径可以通过[Context](js-apis-Context.md#contextgetfilesdir)获取|
| param | [InstallParam](#installparam) | 是 | 指定安装所需的其他参数。 |
| callback | AsyncCallback&lt;[InstallStatus](#installstatus)&gt; | 是 | 程序启动作为入参的回调函数,返回安装状态信息。 |
**示例:**
```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);
});
```
## BundleInstaller.uninstall
uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback&lt;InstallStatus&gt;): void;
......@@ -56,14 +78,37 @@ SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| bundleName | string | 是 | 包名 |
| param | [InstallParam](#installparam) | 是 | 指定安装所需的其他参数。 |
| 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.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);
});
```
## BundleInstaller.recover<sup>8+</sup>
recover(bundleName: string, param: InstallParam, callback: AsyncCallback&lt;InstallStatus&gt;): void;
以异步方法恢复一个应用程序,使用callback形式返回结果。
以异步方法恢复一个应用程序,使用callback形式返回结果。当预置应用被卸载后,可以通过此接口进行恢复。
**需要权限:**
......@@ -80,21 +125,46 @@ SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| bundleName | string | 是 | 包名 |
| param | [InstallParam](#installparam) | 是 | 指定安装所需的其他参数。 |
| callback | AsyncCallback&lt;[InstallStatus](#installstatus)&gt; | 是 | 程序启动作为入参的回调函数,返回安装状态信息。 |
| 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);
});
```
## HashParam<sup>9+</sup>
应用程序安装卸载信息
hap的哈希值参数。应用市场升级检测时,校验各版本哈希值是否一致。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
**系统API:** 此接口为系统接口,三方应用不支持调用
| 名称 | 类型 | 说明 |
| ---------- | ------ | ---------------- |
| moduleName | string | 应用程序模块名称 |
| hashValue | string | 哈希值 |
| 名称 | 类型 | 可读|可写|说明 |
| ---------- | ------ | ---|---|---------------- |
| moduleName | string | 是|是 | 应用程序模块名称 |
| hashValue | string | 是|是 |hap包的sha256哈希值 |
## InstallParam
......@@ -104,17 +174,17 @@ SystemCapability.BundleManager.BundleFramework
**系统API:** 此接口为系统接口,三方应用不支持调用
| 名称 | 类型 | 说明 |
| ------------------------------ | ------------------------------ | ------------------ |
| userId | number | 指示用户id |
| installFlag | number | 指示安装标志 |
| isKeepData | boolean | 指示参数是否有数据 |
| hashParams<sup>9+</sup> | Array<[HashParam](#hashparam)> | 哈希值参数 |
| crowdtestDeadline<sup>9+</sup> | number | 测试包的被杀死时间 |
| 名称 | 类型 |可读|可写| 说明 |
| ------------------------------ | ------------------------------ | ---- |----|--------------- |
| userId | number | 是|是 |指示用户id |
| installFlag | number | 是|是 |指示安装标志 |
| isKeepData | boolean | 是|是 |指示应用删除后是否保留数据 |
| hashParams<sup>9+</sup> | Array<[HashParam](#hashparam)> | 是|是 |哈希值参数 |
| crowdtestDeadline<sup>9+</sup> | number | 是|是 |[众测](https://deveco.huawei.com/crowdtest)截止时间 |
## InstallStatus
应用程序安装状态
应用程序安装卸载状态
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册