@ohos.bundle (Bundle模块)(系统接口)

本模块提供应用信息查询能力，支持包信息、应用信息、Ability组件信息等信息的查询，以及应用禁用状态的查询、设置等。

说明：

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

从API Version 9开始，该模块不再维护，系统接口建议使用@ohos.bundle.bundleManager替代。

当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.bundle。

导入模块

import bundle from '@ohos.bundle';

权限列表

权限 权限等级 描述
ohos.permission.CHANGE_ABILITY_ENABLED_STATE system_basic 设置禁用使能所需的权限。
ohos.permission.GET_BUNDLE_INFO normal 查询指定应用信息。
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED system_basic 可查询所有应用信息。
ohos.permission.INSTALL_BUNDLE system_core 可安装、卸载应用。
ohos.permission.REMOVE_CACHE_FILES system_basic 清理应用缓存。

权限等级参考权限等级说明。

bundle.getBundleInstallerdeprecated

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

getBundleInstaller(): Promise<BundleInstaller>

获取用于安装包的接口，使用Promise异步回调，返回安装接口对象。

需要权限：

ohos.permission.INSTALL_BUNDLE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

返回值：

类型 说明
Promise<BundleInstaller> Promise对象，返回安装接口对象。

示例：

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

bundle.getBundleInstaller().then((data) => {
    console.info('getBundleInstaller successfully.');
}).catch((error: BusinessError) => {
    console.error('getBundleInstaller failed.');
});

bundle.getBundleInstallerdeprecated

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

getBundleInstaller(callback: AsyncCallback<BundleInstaller>): void

获取用于安装包的接口，使用callback异步回调。

需要权限：

ohos.permission.INSTALL_BUNDLE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
callback AsyncCallback<BundleInstaller> 是 回调函数，返回安装接口对象。

示例：

import bundle from '@ohos.bundle';

bundle.getBundleInstaller((err, data) => {
    if (err.code == 0) {
        console.error('getBundleInstaller failed.');
    } else {
        console.info('getBundleInstaller successfully');
    }
});

bundle.cleanBundleCacheFiles8+ deprecated

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

cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback<void>): void

清除指定应用程序的缓存数据，使用callback异步回调。

需要权限：

ohos.permission.REMOVE_CACHE_FILES

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 指示要清除其缓存数据的应用Bundle名称。
callback AsyncCallback<void> 是 回调函数。

示例：

import bundle from '@ohos.bundle';

let bundleName: string = "com.example.myapplication";

bundle.cleanBundleCacheFiles(bundleName, err => {
    if (err) {
        console.error('cleanBundleCacheFiles failed.');
    } else {
        console.info('cleanBundleCacheFiles successfully.');
    }
});

bundle.cleanBundleCacheFiles8+ deprecated

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

cleanBundleCacheFiles(bundleName: string): Promise<void>

清除指定应用程序的缓存数据，使用Promise异步回调。

需要权限：

ohos.permission.REMOVE_CACHE_FILES

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 指示要清除其缓存数据的应用Bundle名称。

返回值：

类型 说明
Promise<void> Promise对象，无返回结果的Promise对象。

示例：

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

let bundleName: string = "com.example.myapplication";

bundle.cleanBundleCacheFiles(bundleName).then(()=> {
    console.info('cleanBundleCacheFiles successfully.');
}).catch((error: BusinessError) => {
    console.error('cleanBundleCacheFiles failed.');
});

bundle.setApplicationEnabled8+ deprecated

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

setApplicationEnabled(bundleName: string, isEnable: boolean, callback: AsyncCallback<void>): void

设置是否启用指定的应用程序，使用callback异步回调。

需要权限：

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 指示需要启用或禁用的应用Bundle名称。
isEnable boolean 是 指定是否启用应用程序。true表示启用，false表示禁用。
callback AsyncCallback<void> 是 回调函数。

示例：

import bundle from '@ohos.bundle';

let bundleName: string = "com.example.myapplication";

bundle.setApplicationEnabled(bundleName, false, err => {
    if (err) {
        console.error('setApplicationEnabled failed.');
    } else {
        console.info('setApplicationEnabled successfully.');
    }
});

bundle.setApplicationEnabled8+ deprecated

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

setApplicationEnabled(bundleName: string, isEnable: boolean): Promise<void>

设置是否启用指定的应用程序，使用Promise异步回调。

需要权限：

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 指示需要启用或禁用的应用Bundle名称。
isEnable boolean 是 指定是否启用应用程序。true表示启用，false禁用。

返回值：

类型 说明
Promise<void> Promise对象，无返回结果的Promise对象。

示例：

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

let bundleName: string = "com.example.myapplication";

bundle.setApplicationEnabled(bundleName, false).then(()=> {
    console.info('setApplicationEnabled successfully.');
}).catch((error: BusinessError) => {
    console.error('setApplicationEnabled failed.');
});

bundle.setAbilityEnabled8+ deprecated

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

setAbilityEnabled(info: AbilityInfo, isEnable: boolean, callback: AsyncCallback<void>): void

设置是否启用指定的Ability组件，使用callback异步回调。

需要权限：

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
info AbilityInfo 是 Ability信息，指示需要设置启用状态的Ability。
isEnable boolean 是 指定是否启用应用程序。true表示启用，false禁用。
callback AsyncCallback<void> 是 为返回操作结果而调用的回调。

bundle.setAbilityEnabled8+ deprecated

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

setAbilityEnabled(info: AbilityInfo, isEnable: boolean): Promise<void>

设置是否启用指定的Ability组件，使用Promise异步回调。

需要权限：

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
info AbilityInfo 是 Ability信息，指示需要设置启用状态的Ability。
isEnable boolean 是 指定是否启用应用程序。true表示启用，false禁用。

返回值：

类型 说明
Promise<void> Promise对象，无返回结果的Promise对象。

示例：

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

let bundleName: string = "com.example.myapplication";
let abilityName: string = "EntryAbility";

bundle.getAbilityInfo(bundleName, abilityName).then((abilityInfo) => {
    console.info('getAbilityInfo successfully. Data: ' + JSON.stringify(abilityInfo));

    bundle.setAbilityEnabled(abilityInfo, false).then(data => {
        console.info('setAbilityEnabled successfully.');
    }).catch((error: BusinessError) => {
        console.error('setAbilityEnabled failed:' + JSON.stringify(error));
    })
}).catch((error: BusinessError) => {
    console.error('getAbilityInfo failed. Cause: ' + JSON.stringify(error));
});

bundle.getPermissionDef8+ deprecated

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

getPermissionDef(permissionName: string, callback: AsyncCallback<PermissionDef>): void

按权限名称获取权限的详细信息，使用callback异步回调。

需要权限：

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
permissionName string 是 需要查询的权限的名称。
callback AsyncCallback<PermissionDef> 是 程序启动作为入参的回调函数，返回定义的权限信息。

示例：

import bundle from '@ohos.bundle';

let permission: string = "ohos.permission.GET_BUNDLE_INFO";
bundle.getPermissionDef(permission, (err, data) => {
    if (err) {
        console.error('getPermissionDef failed:' + err.message);
    } else {
        console.info('getPermissionDef successfully:' + JSON.stringify(data));
    }
});

bundle.getPermissionDef8+ deprecated

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

getPermissionDef(permissionName: string): Promise<PermissionDef>

按权限名称获取权限的详细信息，使用promise异步回调。。

需要权限：

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：

SystemCapability.BundleManager.BundleFramework

系统接口：

此接口为系统接口。

参数：

参数名 类型 必填 说明
permissionName string 是 需要查询的权限的名称。

返回值：

类型 说明
Promise<PermissionDef> Promise对象，获取成功时返回权限详细信息。

示例：

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

let permissionName: string = "ohos.permission.GET_BUNDLE_INFO";
bundle.getPermissionDef(permissionName).then((data) => {
    console.info('getPermissionDef successfully. Data: ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.error('getPermissionDef failed. Cause: ' + error.message);
});