harmony 鸿蒙BundleInstaller

2022-08-09
浏览 (1213)

BundleInstaller

说明： 本模块首批接口从API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块提供设备上安装、升级和卸载应用的能力。

BundleInstaller.install^(deprecated)

从API version 9开始不再维护，建议使用@ohos.bundle.installer.install替代。

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

以异步方法在应用中安装hap，支持多hap安装。使用callback形式返回结果。

需要权限：

ohos.permission.INSTALL_BUNDLE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统API： 此接口为系统接口。

参数：

参数名	类型	必填	说明
bundleFilePaths	Array<string>	是	指示存储HAP的沙箱路径。沙箱路径的获取方法参见获取应用的沙箱路径。
param	InstallParam	是	指定安装所需的其他参数。
callback	AsyncCallback<InstallStatus>	是	程序启动作为入参的回调函数，返回安装状态信息。

示例：

import bundleInstall from '@ohos.bundle.installer';
import { BusinessError } from '@ohos.base';

let hapFilePaths: Array<string> = ['/data/storage/el2/base/haps/entry/files/'];
let installParam: bundleInstall.InstallParam = {
  userId: 100,
  isKeepData: false,
  installFlag: 1,
};

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

BundleInstaller.uninstall^(deprecated)

从API version 9开始不再维护，建议使用uninstall替代。

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

以异步方法卸载应用程序，使用callback异步回调，返回安装状态信息。

需要权限：

ohos.permission.INSTALL_BUNDLE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统API： 此接口为系统接口。

参数：

参数名	类型	必填	说明
bundleName	string	是	应用Bundle名称。
param	InstallParam	是	指定卸载所需的其他参数。
callback	AsyncCallback<InstallStatus>	是	程序启动作为入参的回调函数，返回安装状态信息。

示例：

import bundleInstall from '@ohos.bundle.installer';
import { BusinessError } from '@ohos.base';

let bundleName: string = 'com.example.myapplication';
let installParam: bundleInstall.InstallParam = {
  userId: 100,
  isKeepData: false,
  installFlag: 1,
};

bundleInstall.getBundleInstaller().then(installer => {
  installer.uninstall(bundleName, installParam, err => {
    if (err) {
      console.error('uninstall failed:' + JSON.stringify(err));
    } else {
      console.info('uninstall successfully.');
    }
  });
}).catch((error: BusinessError) => {
  let message = (error as BusinessError).message;
  console.error('getBundleInstaller failed. Cause: ' + message);
});

BundleInstaller.recover^(deprecated)

从API version 9开始不再维护，建议使用recover替代。

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

以异步方法恢复一个应用程序，使用callback形式返回结果。当预置应用被卸载后，可以通过此接口进行恢复。

需要权限：

ohos.permission.INSTALL_BUNDLE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统API： 此接口为系统接口。

参数：

参数名	类型	必填	说明
bundleName	string	是	应用Bundle名称。
param	InstallParam	是	指定应用恢复所需的其他参数。
callback	AsyncCallback<InstallStatus>	是	程序启动作为入参的回调函数，返回应用恢复状态信息。

示例：

import bundleInstall from '@ohos.bundle.installer';
import { BusinessError } from '@ohos.base';

let bundleName: string = 'com.example.myapplication';
let installParam: bundleInstall.InstallParam = {
  userId: 100,
  isKeepData: false,
  installFlag: 1,
};

bundleInstall.getBundleInstaller().then(installer => {
  installer.uninstall(bundleName, installParam, err => {
    if (err) {
      console.error('uninstall failed:' + JSON.stringify(err));
    } else {
      console.info('uninstall successfully.');
    }
  });
}).catch((error: BusinessError) => {
  let message = (error as BusinessError).message;
  console.error('getBundleInstaller failed. Cause: ' + message);
});

InstallParam^(deprecated)

安装、恢复或卸载时需要指定的参数。

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

系统API： 此接口为系统接口。

名称	类型	可读	可写	说明
userId	number	是	是	指示用户id, 默认值：调用方的userId
installFlag	number	是	是	指示安装标志, 默认值：1, 取值范围： 1: 覆盖安装, 16: 免安装
isKeepData	boolean	是	是	指示参数是否有数据，默认值：false

InstallStatus^(deprecated)

应用程序安装卸载的结果。

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

系统API： 此接口为系统接口。

名称	类型	可读	可写	说明
status	bundle.InstallErrorCode	是	否	表示安装或卸载错误状态码。取值范围：枚举值InstallErrorCode
statusMessage	string	是	否	表示安装或卸载的字符串结果信息。取值范围包括： “SUCCESS” : 安装成功， “STATUS_INSTALL_FAILURE”: 安装失败（不存在安装文件）, “STATUS_INSTALL_FAILURE_ABORTED”: 安装中止, “STATUS_INSTALL_FAILURE_INVALID”: 安装参数无效, “STATUS_INSTALL_FAILURE_CONFLICT”: 安装冲突（常见于升级和已有应用基本信息不一致）, “STATUS_INSTALL_FAILURE_STORAGE”: 存储包信息失败, “STATUS_INSTALL_FAILURE_INCOMPATIBLE”: 安装不兼容（常见于版本降级安装或者签名信息错误）, “STATUS_UNINSTALL_FAILURE”: 卸载失败（不存在卸载的应用）, “STATUS_UNINSTALL_FAILURE_ABORTED”: 卸载中止（没有使用）, “STATUS_UNINSTALL_FAILURE_ABORTED”: 卸载冲突（卸载系统应用失败，结束应用进程失败）, “STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT”: 安装失败（下载超时）, “STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED”: 安装失败（下载失败）, “STATUS_RECOVER_FAILURE_INVALID”: 恢复预置应用失败, “STATUS_ABILITY_NOT_FOUND”: Ability未找到, “STATUS_BMS_SERVICE_ERROR”: BMS服务错误, “STATUS_FAILED_NO_SPACE_LEFT”: 设备空间不足, “STATUS_GRANT_REQUEST_PERMISSIONS_FAILED”: 应用授权失败, “STATUS_INSTALL_PERMISSION_DENIED”: 缺少安装权限, “STATUS_UNINSTALL_PERMISSION_DENIED”: 缺少卸载权限

获取应用的沙箱路径

对于FA模型，应用的沙箱路径可以通过Context中的方法获取；对于Stage模型，应用的沙箱路径可以通过Context中的属性获取。下面以获取沙箱文件路径为例。

示例：

// Stage模型
import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage) {
        let context = this.context;
        let pathDir = context.filesDir;
        console.info('sandbox path is ' + pathDir);
    }
}

// FA模型
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
context.getFilesDir().then((data) => {
    let pathDir = data;
    console.info('sandbox path is ' + pathDir);
});