当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
1.4K Star 7.4K Fork 8.2K

OpenHarmony/docs
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
docker
en
zh-cn
application-dev
IDL
ability
connectivity
database
device-usage-statistics
device
dfx
internationalization
media
napi
notification
public_sys-resources
quick-start
reference
apis
figures
public_sys-resources
Readme-CN.md
js-apis-Bundle-InnerBundleManager.md
js-apis-Bundle-distributedBundle.md
js-apis-Bundle.md
js-apis-Context.md
js-apis-DataUriUtils.md
js-apis-WorkSchedulerExtensionAbility.md
js-apis-ability-context.md
js-apis-ability-errorCode.md
js-apis-ability-wantConstant.md
js-apis-abilityAccessCtrl.md
js-apis-abilityDelegatorRegistry.md
js-apis-abilityrunninginfo.md
js-apis-abilitystagecontext.md
js-apis-accessibility.md
js-apis-animator.md
js-apis-appAccount.md
js-apis-application-MissionSnapshot.md
js-apis-application-StartOptions.md
js-apis-application-Want.md
js-apis-application-WindowExtensionAbility.md
js-apis-application-ability.md
js-apis-application-abilityConstant.md
js-apis-application-abilityDelegator.md
js-apis-application-abilityDelegatorArgs.md
js-apis-application-abilityLifecycleCallback.md
js-apis-application-abilityManager.md
js-apis-application-abilityMonitor.md
js-apis-application-abilitystage.md
js-apis-application-applicationContext.md
js-apis-application-context.md
js-apis-application-shellCmdResult.md
js-apis-application-staticSubscriberExtensionAbility.md
js-apis-appmanager.md
js-apis-arraylist.md
js-apis-audio.md
js-apis-backgroundTaskManager.md
js-apis-battery-info.md
js-apis-bluetooth.md
js-apis-brightness.md
js-apis-bundle-AbilityInfo.md
js-apis-bundle-ApplicationInfo.md
js-apis-bundle-BundleInfo.md
js-apis-bundle-BundleInstaller.md
js-apis-bundle-CustomizeData.md
js-apis-bundle-ExtensionAbilityInfo.md
js-apis-bundle-HapModuleInfo.md
js-apis-bundle-Metadata.md
js-apis-bundle-ModuleInfo.md
js-apis-bundle-PermissionDef.md
js-apis-bundle-ShortcutInfo.md
js-apis-bundle-remoteAbilityInfo.md
js-apis-bytrace.md
js-apis-call.md
js-apis-camera.md
js-apis-cardEmulation.md
js-apis-commonEvent.md
js-apis-config-policy.md
js-apis-configuration.md
js-apis-configurationconstant.md
js-apis-connectedTag.md
js-apis-contact.md
js-apis-convertxml.md
js-apis-data-ability.md
js-apis-data-distributedobject.md
js-apis-data-preferences.md
js-apis-data-rdb.md
js-apis-data-resultset.md
js-apis-data-storage.md
js-apis-dataAbilityHelper.md
js-apis-deque.md
js-apis-device-info.md
js-apis-device-manager.md
js-apis-deviceUsageStatistics.md
js-apis-display.md
js-apis-distributed-account.md
js-apis-distributed-data.md
js-apis-document.md
js-apis-emitter.md
js-apis-enterprise-device-manager.md
js-apis-environment.md
js-apis-eventhub.md
js-apis-extension-context.md
js-apis-extensionrunninginfo.md
js-apis-faultLogger.md
js-apis-featureAbility.md
js-apis-fileio.md
js-apis-filemanager.md
js-apis-formInfo.md
js-apis-formbindingdata.md
js-apis-formerror.md
js-apis-formextension.md
js-apis-formextensioncontext.md
js-apis-formhost.md
js-apis-formprovider.md
js-apis-geolocation.md
js-apis-hashmap.md
js-apis-hashset.md
js-apis-hiappevent.md
js-apis-hichecker.md
js-apis-hidebug.md
js-apis-hilog.md
js-apis-hitracechain.md
js-apis-hitracemeter.md
js-apis-http.md
js-apis-huks.md
js-apis-i18n.md
js-apis-image.md
js-apis-inputconsumer.md
js-apis-inputdevice.md
js-apis-inputevent.md
js-apis-inputeventclient.md
js-apis-inputmethod.md
js-apis-inputmethodengine.md
js-apis-inputmonitor.md
js-apis-intl.md
js-apis-keycode.md
js-apis-keyevent.md
js-apis-lightweightmap.md
js-apis-lightweightset.md
js-apis-linkedlist.md
js-apis-list.md
js-apis-logs.md
js-apis-media.md
js-apis-medialibrary.md
js-apis-mediaquery.md
js-apis-missionManager.md
js-apis-mouseevent.md
js-apis-net-connection.md
js-apis-nfcController.md
js-apis-nfcTag.md
js-apis-notification.md
js-apis-observer.md
js-apis-osAccount.md
js-apis-particleAbility.md
js-apis-pasteboard.md
js-apis-permissionrequestresult.md
js-apis-plainarray.md
js-apis-power.md
js-apis-process.md
js-apis-processrunninginfo.md
js-apis-prompt.md
js-apis-queue.md
js-apis-radio.md
js-apis-reminderAgent.md
js-apis-request.md
js-apis-resource-manager.md
js-apis-router.md
js-apis-rpc.md
js-apis-runninglock.md
js-apis-screen-lock.md
js-apis-screen.md
js-apis-screenshot.md
js-apis-securityLabel.md
js-apis-sensor.md
js-apis-service-extension-ability.md
js-apis-service-extension-context.md
js-apis-settings.md
js-apis-sim.md
js-apis-sms.md
js-apis-socket.md
js-apis-stack.md
js-apis-statfs.md
js-apis-storage-statistics.md
js-apis-system-app.md
js-apis-system-battery.md
js-apis-system-bluetooth.md
js-apis-system-brightness.md
js-apis-system-cipher.md
js-apis-system-configuration.md
js-apis-system-device.md
js-apis-system-fetch.md
js-apis-system-file.md
js-apis-system-location.md
js-apis-system-mediaquery.md
js-apis-system-network.md
js-apis-system-notification.md
js-apis-system-package.md
js-apis-system-parameter.md
js-apis-system-prompt.md
js-apis-system-request.md
js-apis-system-router.md
js-apis-system-sensor.md
js-apis-system-storage.md
js-apis-system-time.md
js-apis-system-vibrate.md
js-apis-telephony-data.md
js-apis-testRunner.md
js-apis-thermal.md
js-apis-timer.md
js-apis-touchevent.md
js-apis-treemap.md
js-apis-treeset.md
js-apis-uitest.md
js-apis-update.md
js-apis-uri.md
js-apis-uripermissionmanager.md
js-apis-url.md
js-apis-usb.md
js-apis-useriam-userauth.md
js-apis-util.md
js-apis-vector.md
js-apis-vibrator.md
js-apis-volumemanager.md
js-apis-wallpaper.md
js-apis-wantAgent.md
js-apis-webSocket.md
js-apis-webgl.md
js-apis-webgl2.md
js-apis-wifi.md
js-apis-wifiext.md
js-apis-window.md
js-apis-workScheduler.md
js-apis-worker.md
js-apis-xml.md
js-apis-zlib.md
arkui-js
arkui-ts
native-apis
native-lib
Readme-CN.md
security
task-management
telephony
ui
webgl
windowmanager
Readme-CN.md
application-dev-guide-for-gitee.md
application-dev-guide.md
website.md
contribute
design
device-dev
figures
readme
release-notes
OpenHarmony-Overview_zh.md
glossary.md
readme.md
website.md
.gitattributes
.gitignore
CODEOWNERS
DCO.txt
LICENSE
OAT.xml
README.md
README_zh.md
克隆/下载
js-apis-Bundle.md 79.00 KB
一键复制 编辑 原始数据 按行查看 历史

Bundle模块(JS端SDK接口)

icon-note.gif 说明: 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 API9 当前为Canary版本,仅供试用,不保证接口可稳定调用。

导入模块

import bundle from '@ohos.bundle';

系统能力

SystemCapability.BundleManager.BundleFramework

权限列表

权限 权限等级 描述
ohos.permission.GET_BUNDLE_INFO normal 仅限查询本应用信息
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED system_basic 可查询所有应用信息
ohos.permission.INSTALL_BUNDLE system_core 可安装、卸载应用

bundle.getApplicationInfo

getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number): Promise<ApplicationInfo>

以异步方法根据给定的包名获取ApplicationInfo,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的应用程序包名称。
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<ApplicationInfo> Promise形式返回应用程序信息。

示例:

let bundleName = "com.example.myapplication";
let bundleFlags = 0;
let userId = 100;
bundle.getApplicationInfo(bundleName, bundleFlags, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getApplicationInfo

getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback<ApplicationInfo>): void

以异步方法根据给定的包名获取ApplicationInfo,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的应用程序包名称。
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<ApplicationInfo> 程序启动作为入参的回调函数,返回应用程序信息。

示例:

let bundleName = "com.example.myapplication";
let bundleFlags = 0;
let userId = 100;
bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
 })

bundle.getApplicationInfo

getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback<ApplicationInfo>): void

以异步方法根据给定的包名获取ApplicationInfo,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的应用程序包名称。
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
callback AsyncCallback<ApplicationInfo> 程序启动作为入参的回调函数,返回应用程序信息。

示例:

let bundleName = "com.example.myapplication";
let bundleFlags = 0;
bundle.getApplicationInfo(bundleName, bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
 })

bundle.getAllBundleInfo

getAllBundleInfo(bundleFlag: BundleFlag, userId?: number): Promise<Array<BundleInfo>>

以异步方法获取系统中所有可用的BundleInfo,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleFlag BundleFlag 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<Array<BundleInfo>> Promise形式返回所有可用的BundleInfo

示例:

let bundleFlag = 0;
let userId = 100;
bundle.getAllBundleInfo(bundleFlag, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getAllBundleInfo

getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback<Array<BundleInfo>>): void

以异步方法获取系统中所有可用的BundleInfo,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleFlag BundleFlag 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
callback AsyncCallback<Array<BundleInfo>> 程序启动作为入参的回调函数,返回所有可用的BundleInfo。

示例:

let bundleFlag = 0;
bundle.getAllBundleInfo(bundleFlag, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
 })

bundle.getAllBundleInfo

getAllBundleInfo(bundleFlag: BundleFlag, userId: number, callback: AsyncCallback<Array<BundleInfo>>): void

以异步方法获取系统中所有可用的BundleInfo,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleFlag BundleFlag 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<Array<BundleInfo>> 程序启动作为入参的回调函数,返回所有可用的BundleInfo。

示例:

let bundleFlag = 0;
let userId = 100;
bundle.getAllBundleInfo(bundleFlag, userId, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
 })

bundle.getBundleInfo

getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise<BundleInfo>

以异步方法根据给定的包名获取BundleInfo,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 包名
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
options BundleOptions 包含userid。

返回值:

类型 说明
Promise<BundleInfo> 返回值为Promise对象,Promise中包含包信息。

示例:

let bundleName = "com.example.myapplication";
let bundleFlags = 1;
let options = {
  "userId" : 100
};
bundle.getBundleInfo(bundleName, bundleFlags, options)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getBundleInfo

getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback<BundleInfo>): void

以异步方法根据给定的包名获取BundleInfo,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 包名
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
callback AsyncCallback<BundleInfo> 程序启动作为入参的回调函数,返回包信息。

示例:

let bundleName = "com.example.myapplication";
let bundleFlags = 1;
bundle.getBundleInfo(bundleName, bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getBundleInfo

getBundleInfo(bundleName: string, bundleFlags: number, options: BundleOptions, callback: AsyncCallback<BundleInfo>): void

以异步方法根据给定的包名获取BundleInfo,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 包名
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
options BundleOptions 包含userid。
callback AsyncCallback<BundleInfo> 程序启动作为入参的回调函数,返回包信息。

示例:

let bundleName = "com.example.myapplication";
let bundleFlags = 1;
let options = {
  "userId" : 100
};
bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getAllApplicationInfo

getAllApplicationInfo(bundleFlags: number, userId?: number): Promise<Array<ApplicationInfo>>

获取指定用户下所有已安装的应用信息,通过Promise获取返回值。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<Array<ApplicationInfo>> 返回值为Promise对象,Promise中包含应用信息列表。

示例:

let bundleFlags = 8;
let userId = 100;
bundle.getAllApplicationInfo(bundleFlags, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getAllApplicationInfo

getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback<Array<ApplicationInfo>>): void

获取指定用户下所有已安装的应用信息,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<Array<ApplicationInfo>> 程序启动作为入参的回调函数,返回应用信息列表。

示例:

let bundleFlags = 8;
let userId = 100;
bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getAllApplicationInfo

getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback<Array<ApplicationInfo>>) : void;

获取指定用户下所有已安装的应用信息,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleFlags number 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。
callback AsyncCallback<Array<ApplicationInfo>> 程序启动作为入参的回调函数,返回应用信息列表。

示例:

let bundleFlags = 8;
bundle.getAllApplicationInfo(bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getBundleInstaller

getBundleInstaller(): Promise<BundleInstaller>;

获取用于安装包的接口

需要权限:

ohos.permission.INSTALL_BUNDLE

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

返回值:

类型 说明
Promise<BundleInstaller> 返回值为Promise对象,Promise中包含安装信息。

bundle.getBundleInstaller

getBundleInstaller(callback: AsyncCallback<BundleInstaller>): void;

获取用于安装包的接口

需要权限:

ohos.permission.INSTALL_BUNDLE

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
callback AsyncCallback<BundleInstaller> 安装应用程序包。

bundle.getBundleArchiveInfo

getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback<BundleInfo>) : void

获取有关ohos能力包(HAP)中包含的应用程序包的信息

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
hapFilePath string 指示存储HAP的路径,路径应该是数据的相对路径。
bundleFlags number 指示用于指定要删除的BundleInfo对象中包含的信息的标志。
callback AsyncCallback<BundleInfo> 程序启动作为入参的回调函数,返回BundleInfo信息。

bundle.getBundleArchiveInfo

getBundleArchiveInfo(hapFilePath: string, bundleFlags: number) : Promise<BundleInfo>;

获取有关ohos能力包(HAP)中包含的应用程序包的信息

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
hapFilePath string 指示存储HAP的路径,路径应该是数据的相对路径。
bundleFlags number 指示用于指定要删除的BundleInfo对象中包含的信息的标志。

返回值:

类型 说明
Promise<BundleInfo> 返回值为Promise对象,Promise中包含应用包的信息。

bundle.cleanBundleCacheFiles8+

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

清除指定应用程序的缓存数据

需要权限:

ohos.permission.REMOVE_CACHE_FILES

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
bundleName string 指示要清除其缓存数据的应用程序包名称.
callback AsyncCallback 为返回操作结果而调用的回调。

bundle.cleanBundleCacheFiles8+

cleanBundleCacheFiles(bundleName: string): Promise<void>

清除指定应用程序的缓存数据

需要权限:

ohos.permission.REMOVE_CACHE_FILES

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
bundleName string 指示要清除其缓存数据的应用程序包名称.

返回值:

类型 说明
Promise 返回值为Promise对象,Promise中为空。

bundle.setApplicationEnabled8+

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

设置是否启用指定的应用程序

需要权限:

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
bundleName string 应用程序包名称。
isEnable boolean 指定是否启用应用程序。true表示启用,false禁用。
callback AsyncCallback 为返回操作结果而调用的回调。

bundle.setApplicationEnabled8+

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

设置是否启用指定的应用程序

需要权限:

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
bundleName string 应用程序包名称。
isEnable boolean 指定是否启用应用程序。true表示启用,false禁用。

返回值:

类型 说明
Promise 返回值为Promise对象,Promise中为空。

bundle.setAbilityEnabled8+

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

设置是否启用指定的功能

需要权限:

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
info AbilityInfo Ability信息。
isEnable boolean 指定是否启用应用程序。true表示启用,false禁用。
callback AsyncCallback 为返回操作结果而调用的回调。

bundle.setAbilityEnabled8+

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

设置是否启用指定的功能

需要权限:

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
info AbilityInfo Ability信息。
isEnable boolean 指定是否启用应用程序。true表示启用,false禁用。

返回值:

类型 说明
Promise 返回值为Promise对象,Promise中为空。

bundle.getPermissionDef8+

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

按权限名称获取权限的详细信息

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
permissionName string 指定权限的名称。
callback AsyncCallback<PermissionDef> 程序启动作为入参的回调函数,返回定义的权限信息。

bundle.getPermissionDef8+

getPermissionDef(permissionName: string): Promise<PermissionDef>

按权限名称获取权限的详细信息

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
permissionName string 指定权限的名称。

返回值:

类型 说明
Promise<PermissionDef> 返回值为Promise对象,Promise中包含定义的权限信息对象。

bundle.setModuleUpgradeFlag9+

setModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag, callback: AsyncCallback<void>):void;

设置模块是否需要升级

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
bundleName string 应用程序包名称。
moduleName string 应用程序模块名称。
upgradeFlag UpgradeFlag 仅供内部系统使用标志位
callback AsyncCallback 为返回操作结果而调用的回调。

bundle.setModuleUpgradeFlag9+

setModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag): Promise<void>

设置模块是否需要升级

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
bundleName string 应用程序包名称。
moduleName string 应用程序模块名称。
upgradeFlag UpgradeFlag 仅供内部系统使用标志位

返回值:

类型 说明
Promise 返回值为Promise对象,Promise中为空。

bundle.isModuleRemovable9+

isModuleRemovable(bundleName: string, moduleName: string, callback: AsyncCallback<boolean>): void;

检查指定模块是否被移除

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
bundleName string 应用程序包名称。
moduleName string 应用程序模块名称。
callback AsyncCallback 程序启动作为入参的回调函数,返回boolean信息。

bundle.isModuleRemovable9+

isModuleRemovable(bundleName: string, moduleName: string): Promise<boolean>

检查指定模块是否被移除

系统能力:

SystemCapability.BundleManager.BundleFramework

系统API:

此接口为系统接口,三方应用不支持调用

参数:

名称 类型 必填 描述
bundleName string 应用程序包名称。
moduleName string 应用程序模块名称。

返回值:

类型 说明
Promise Promise形式返回boolean信息。

bundle.getAbilityInfo

getAbilityInfo(bundleName: string, abilityName: string): Promise<AbilityInfo>

通过包名称和abilityName获取Ability信息,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 应用程序包名。
abilityName string Ability名称。

返回值:

类型 说明
Promise<AbilityInfo> Promise形式返回Ability信息。

示例:

let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getAbilityInfo

getAbilityInfo(bundleName: string, abilityName: string, callback: AsyncCallback<AbilityInfo>): void;

通过包名称和abilityName获取Ability信息,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 应用程序包名。
abilityName string Ability名称。
callback AsyncCallback<AbilityInfo> 程序启动作为入参的回调函数,返回Ability信息。

示例:

let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getAbilityInfo9+

getAbilityInfo(bundleName: string, moduleName: string, abilityName: string): Promise<AbilityInfo>

通过包名称、moduleName和abilityName获取Ability信息,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 应用程序包名。
moduleName string Module名称。
abilityName string Ability名称。

返回值:

类型 说明
Promise<AbilityInfo> Promise形式返回Ability信息。

示例:

let bundleName = "com.example.myapplication";
let moduleName = "entry";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, moduleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getAbilityInfo9+

getAbilityInfo(bundleName: string, moduleName: string, abilityName: string, callback: AsyncCallback<AbilityInfo>): void;

通过包名称、moduleName和abilityName获取Ability信息,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 应用程序包名。
moduleName string Module名称。
abilityName string Ability名称。
callback AsyncCallback<AbilityInfo> 程序启动作为入参的回调函数,返回Ability信息。

示例:

let bundleName = "com.example.myapplication";
let moduleName = "entry";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, moduleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getAbilityLabel8+

getAbilityLabel(bundleName: string, abilityName: string): Promise<string>

通过包名称和abilityName获取应用名称,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 应用程序包名。
abilityName string Ability名称。

返回值:

类型 说明
Promise<string> Promise形式返回应用名称信息。

示例:

let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityLabel(bundleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getAbilityLabel8+

getAbilityLabel(bundleName: string, abilityName: string, callback : AsyncCallback<string>): void

通过包名称和abilityName获取应用名称,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 应用程序包名。
abilityName string Ability名称。
callback AsyncCallback<string> 程序启动作为入参的回调函数,返回应用名称信息。

示例:

let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityLabel(bundleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getAbilityLabel9+

getAbilityLabel(bundleName: string, moduleName: string, abilityName: string): Promise<string>

通过包名称、moduleName和abilityName获取应用名称,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 应用程序包名。
moduleName string Module名称。
abilityName string Ability名称。

返回值:

类型 说明
Promise<string> Promise形式返回应用名称信息。

示例:

let bundleName = "com.example.myapplication";
let moduleName = "entry";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityLabel(bundleName, moduleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getAbilityLabel9+

getAbilityLabel(bundleName: string, moduleName: string, abilityName: string, callback : AsyncCallback<string>): void

通过包名称、moduleName和abilityName获取应用名称,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 应用程序包名。
moduleName string Module名称。
abilityName string Ability名称。
callback AsyncCallback<string> 程序启动作为入参的回调函数,返回应用名称信息。

示例:

let bundleName = "com.example.myapplication";
let moduleName = "entry";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityLabel(bundleName, moduleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.isAbilityEnabled8+

isAbilityEnabled(info: AbilityInfo): Promise<boolean>

以异步方法根据给定的AbilityInfo查询ability是否已经启用,使用Promise形式返回结果。

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
info AbilityInfo Ability的配置信息

返回值:

类型 说明
Promise<boolean> Promise形式返回boolean代表是否启用。

示例:

let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName).then((abilityInfo)=>{
    bundle.isAbilityEnabled(abilityInfo).then((data) => {
        console.info('Operation successful. Data: ' + JSON.stringify(data));
    }).catch((error) => {
        console.error('Operation failed. Cause: ' + JSON.stringify(error));
    })
})

bundle.isAbilityEnabled8+

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

以异步方法根据给定的AbilityInfo查询ability是否已经启用,使用callback形式返回结果。

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
info AbilityInfo Ability的配置信息
callback AsyncCallback<boolean> 返回boolean代表是否启用

示例:

let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName).then((abilityInfo)=>{
    bundle.isAbilityEnabled(abilityInfo, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
    })
})

bundle.isApplicationEnabled8+

isApplicationEnabled(bundleName: string): Promise<boolean>

以异步方法根据给定的包名查询指定应用程序是否已经启用,使用Promise形式返回结果。

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的应用程序包名称。

返回值:

类型 说明
Promise<boolean> Promise形式返回boolean代表是否启用。

示例:

let bundleName = "com.example.myapplication";
bundle.isApplicationEnabled(bundleName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.isApplicationEnabled8+

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

以异步方法根据给定的包名查询指定应用程序是否已经启用,使用callback形式返回结果。

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的应用程序包名称。
callback AsyncCallback<boolean> 返回boolean代表是否启用

示例:

let bundleName = "com.example.myapplication";
bundle.isApplicationEnabled(bundleName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.queryAbilityByWant

queryAbilityByWant(want: Want, bundleFlags: number, userId?: number): Promise<Array<AbilityInfo>>

以异步方法根据给定的意图获取Ability信息,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
want Want 包含要查询的应用程序包名称的意图。
bundleFlags number 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0

返回值:

类型 说明
Promise<Array<AbilityInfo>> Promise形式返回Ability信息。

示例:

let bundleFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryAbilityByWant(want, bundleFlags, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.queryAbilityByWant

queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: AsyncCallback<Array<AbilityInfo>>): void

以异步方法根据给定的意图获取Ability信息,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
want Want 指示包含要查询的应用程序包名称的意图。
bundleFlags number 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0
callback AsyncCallback<Array<AbilityInfo>> 程序启动作为入参的回调函数,返回Ability信息。

示例:

let bundleFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryAbilityByWant(want, bundleFlags, userId, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.queryAbilityByWant

queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback<Array<AbilityInfo>>): void;

以异步方法根据给定的意图获取Ability信息,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
want Want 指示包含要查询的应用程序包名称的意图。
bundleFlags number 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。
callback AsyncCallback<Array<AbilityInfo>> 程序启动作为入参的回调函数,返回Ability信息。

示例:

let bundleFlags = 0;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryAbilityByWant(want, bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getLaunchWantForBundle

getLaunchWantForBundle(bundleName: string): Promise<Want>

以异步方法查询拉起指定应用的want对象,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的应用程序包名称。

返回值:

类型 说明
Promise<Want> 返回值为Promise对象,Promise中包含拉起指定应用的Want对象。

示例:

let bundleName = "com.example.myapplication";
bundle.getLaunchWantForBundle(bundleName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getLaunchWantForBundle

getLaunchWantForBundle(bundleName: string, callback: AsyncCallback<Want>): void;

以异步方法查询拉起指定应用的want对象,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的应用程序包名称。
callback AsyncCallback<Want> 程序启动作为入参的回调函数,返回拉起指定应用的want对象。

示例:

let bundleName = "com.example.myapplication";
bundle.getLaunchWantForBundle(bundleName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getNameForUid8+

getNameForUid(uid: number): Promise<string>

以异步方法通过uid获取对应的包名,使用Promise形式返回结果。

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
uid number 要查询的uid。

返回值:

类型 说明
Promise<string> 返回值为Promise对象,Promise中包含指定uid的包名。

示例:

let uid = 20010005;
bundle.getNameForUid(uid)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getNameForUid8+

getNameForUid(uid: number, callback: AsyncCallback<string>) : void

以异步方法通过uid获取对应的包名,使用callback形式返回结果。

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
uid number 要查询的uid。
callback AsyncCallback<string> 程序启动作为入参的回调函数,返回指定uid的包名。

示例:

let uid = 20010005;
bundle.getNameForUid(uid, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getAbilityIcon8+

getAbilityIcon(bundleName: string, abilityName: string): Promise<image.PixelMap>;

以异步方法通过bundleName和abilityName获取对应Icon的PixelMap,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的bundleName。
abilityName string 要查询的abilityName。

返回值:

类型 说明
Promise<image.PixelMap> 返回值为PixelMap

示例:

let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityIcon(bundleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getAbilityIcon8+

getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback<image.PixelMap>): void;

以异步方法通过bundleName和abilityName获取对应Icon的PixelMap,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的bundleName。
abilityName string 要查询的abilityName。
callback AsyncCallback<image.PixelMap> 程序启动作为入参的回调函数,返回指定PixelMap

示例:

let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityIcon(bundleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.getAbilityIcon9+

getAbilityIcon(bundleName: string, moduleName: string, abilityName: string): Promise<image.PixelMap>;

以异步方法通过bundleName、moduleName和abilityName获取对应Icon的PixelMap,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的bundleName。
moduleName string moduleName。
abilityName string 要查询的abilityName。

返回值:

类型 说明
Promise<image.PixelMap> 返回值为PixelMap

示例:

let bundleName = "com.example.myapplication";
let moduleName = "entry";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityIcon(bundleName, moduleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.getAbilityIcon9+

getAbilityIcon(bundleName: string, moduleName: string, abilityName: string, callback: AsyncCallback<image.PixelMap>): void;

以异步方法通过bundleName、moduleName和abilityName获取对应Icon的PixelMap,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
bundleName string 要查询的bundleName。
moduleName string moduleName。
abilityName string 要查询的abilityName。
callback AsyncCallback<image.PixelMap> 程序启动作为入参的回调函数,返回指定PixelMap

示例:

let bundleName = "com.example.myapplication";
let moduleName = "entry";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityIcon(bundleName, moduleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})

bundle.queryExtensionAbilityInfos9+

queryExtensionAbilityInfos(want: Want, extensionType: number, extensionFlags: number, userId?: number): Promise<Array<ExtensionAbilityInfo>>

以异步方法根据给定的意图获取ExtensionAbility信息,使用Promise形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
want Want 包含要查询的应用程序包名称的意图。
extensionType number 用于指定查找的extensionAbilityInfo的类型。 默认值:0,取值范围:枚举值: ExtensionAbilityType
extensionFlags number 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:枚举值: ExtensionFlags
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0

返回值:

类型 说明
Promise<Array<ExtensionAbilityInfo>> Promise形式返回ExtensionAbility信息。

示例:

let extensionType = 0;
let extensionFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryExtensionAbilityInfos(want, extensionType, extensionFlags, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})

bundle.queryExtensionAbilityInfos9+

queryExtensionAbilityInfos(want: Want, extensionType: number, extensionFlags: number, userId: number, callback: AsyncCallback<Array<ExtensionAbilityInfo>>): void

以异步方法根据给定的意图获取ExtensionAbility信息,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
want Want 指示包含要查询的应用程序包名称的意图。
extensionType number 用于指定查找的extensionAbilityInfo的类型。 默认值:0,取值范围:枚举值: ExtensionAbilityType
extensionFlags number 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:枚举值: ExtensionFlags
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0
callback AsyncCallback<Array<ExtensionAbilityInfo>> 程序启动作为入参的回调函数,返回ExtensionAbility信息。

示例:

let extensionType = 0;
let extensionFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
const receiver = function onReceive(err, data) {
    var errValue = JSON.stringify(err)
    var dataValue = JSON.stringify(data)
    console.error('Operation failed. Cause: ' + errValue);
    console.error('Operation failed. Cause: ' + dataValue);
}
bundle.queryExtensionAbilityInfos(want, extensionType, extensionFlags, userId, receiver)

bundle.queryExtensionAbilityInfos9+

queryExtensionAbilityInfos(want: Want, extensionType: number, extensionFlags: number, callback: AsyncCallback<Array<ExtensionAbilityInfo>>): void;

以异步方法根据给定的意图获取ExtensionAbility信息,使用callback形式返回结果。

需要权限:

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

系统能力:

SystemCapability.BundleManager.BundleFramework

参数:

名称 类型 必填 描述
want Want 指示包含要查询的应用程序包名称的意图。
extensionType number 用于指定查找的extensionAbilityInfo的类型。 默认值:0,取值范围:枚举值: ExtensionAbilityType
extensionFlags number 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:枚举值: ExtensionFlags
callback AsyncCallback<Array<ExtensionAbilityInfo>> 程序启动作为入参的回调函数,返回ExtensionAbility信息。

示例:

let extensionType = 0;
let extensionFlags = 0;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
const receiver = function onReceive(err, data) {
    var errValue = JSON.stringify(err)
    var dataValue = JSON.stringify(data)
    console.error('Operation failed. Cause: ' + errValue);
    console.error('Operation failed. Cause: ' + dataValue);
}
bundle.queryExtensionAbilityInfos(want, extensionType, extensionFlags, receiver)

InstallErrorCode

系统能力: SystemCapability.BundleManager.BundleFramework

名称 默认值 说明
SUCCESS 0 安装成功
STATUS_INSTALL_FAILURE 1 安装失败(不存在安装的应用)
STATUS_INSTALL_FAILURE_ABORTED 2 安装中止
STATUS_INSTALL_FAILURE_INVALID 3 安装参数无效
STATUS_INSTALL_FAILURE_CONFLICT 4 安装冲突 (常见于升级和已有应用基本信息不一致)
STATUS_INSTALL_FAILURE_STORAGE 5 存储包信息失败
STATUS_INSTALL_FAILURE_INCOMPATIBLE 6 安装不兼容(常见于版本降级安装或者签名信息错误)
STATUS_UNINSTALL_FAILURE 7 卸载失败 (不存在卸载的应用)
STATUS_UNINSTALL_FAILURE_BLOCKED 8 卸载中止 (没有使用)
STATUS_UNINSTALL_FAILURE_ABORTED 9 卸载中止 (参数无效导致)
STATUS_UNINSTALL_FAILURE_CONFLICT 10 卸载冲突 (卸载系统应用失败, 结束应用进程失败)
STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT 0x0B 安装失败 (下载超时)
STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED 0x0C 安装失败 (下载失败)
STATUS_RECOVER_FAILURE_INVALID8+ 0x0D 恢复预置应用失败
STATUS_ABILITY_NOT_FOUND 0x40 Ability未找到
STATUS_BMS_SERVICE_ERROR 0x41 BMS服务错误
STATUS_FAILED_NO_SPACE_LEFT8+ 0x42 设备空间不足
STATUS_GRANT_REQUEST_PERMISSIONS_FAILED8+ 0x43 应用授权失败
STATUS_INSTALL_PERMISSION_DENIED8+ 0x44 安装权限拒绝
STATUS_UNINSTALL_PERMISSION_DENIED8+ 0x45 卸载权限拒绝

BundleFlag

包的标志

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

名称 默认值 说明
GET_BUNDLE_DEFAULT 0x00000000 获取默认的应用信息
GET_BUNDLE_WITH_ABILITIES 0x00000001 获取包括Ability信息的包信息
GET_ABILITY_INFO_WITH_PERMISSION 0x00000002 获取包括权限的Ability信息
GET_ABILITY_INFO_WITH_APPLICATION 0x00000004 获取包括应用的Ability信息
GET_APPLICATION_INFO_WITH_PERMISSION 0x00000008 获取包括权限的应用信息
GET_BUNDLE_WITH_REQUESTED_PERMISSION 0x00000010 获取包括所需权限的包信息
GET_ABILITY_INFO_WITH_METADATA8+ 0x00000020 获取ability的元数据信息
GET_BUNDLE_WITH_EXTENSION_ABILITY9+ 0x00000020 获取包括Ability信息的扩展包信息
GET_APPLICATION_INFO_WITH_METADATA8+ 0x00000040 获取应用的元数据信息
GET_ABILITY_INFO_SYSTEMAPP_ONLY8+ 0x00000080 获取仅包括系统应用的ability信息
GET_ABILITY_INFO_WITH_DISABLE8+ 0x00000100 获取包括被禁用的ability信息
GET_APPLICATION_INFO_WITH_DISABLE8+ 0x00000200 获取包括被禁用的应用信息
GET_ALL_APPLICATION_INFO 0xFFFF0000 获取应用所有的信息

BundleOptions

包的选项

系统能力: SystemCapability.BundleManager.BundleFramework

名称 类型 可读 可写 说明
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

AbilityType

Ability类型

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

名称 类型 说明
UNKNOWN 未知Ability类型
PAGE Ability有一个UI界面
SERVICE Ability没有UI界面
DATA Ability用于提供数据访问服务

DisplayOrientation

屏幕显示方向

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

名称 类型 说明
UNSPECIFIED 屏幕方向--不指定
LANDSCAPE 屏幕方向--横屏
PORTRAIT 屏幕方向--竖屏
FOLLOW_RECENT 屏幕方向--紧跟上一个组件

LaunchMode

启动模式

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

名称 类型 说明
SINGLETON 0 Ability只有一个示例
STANDARD 1 Ability有多个示例

AbilitySubType

Ability的子类型

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

名称 类型 说明
UNSPECIFIED 0 未定义Ability子类型
CA 1 Ability子类型是带有 UI 的服务

ExtensionAbilityType9+

ExtensionAbility的类型

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

名称 类型 说明
FORM9+ 0 ExtensionAbility的类型包括卡片
WORK_SCHEDULER9+ 1 ExtensionAbility的类型包括行程安排
INPUT_METHOD9+ 2 ExtensionAbility的类型包括输入法
SERVICE9+ 3 ExtensionAbility的类型包括服务
ACCESSIBILITY9+ 4 ExtensionAbility的类型包括无障碍
DATA_SHARE9+ 5 ExtensionAbility的类型包括数据共享
FILE_SHARE9+ 6 ExtensionAbility的类型包括文件共享
STATIC_SUBSCRIBER9+ 7 ExtensionAbility的类型包括订阅者
WALLPAPER9+ 8 ExtensionAbility的类型包括墙纸
BACKUP9+ 9 ExtensionAbility的类型包括数据备份恢复
WINDOW9+ 10 ExtensionAbility的窗口类型扩展信息
UNSPECIFIED9+ 20 ExtensionAbility未指定类型

ExtensionFlag9+

扩展标志

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

名称 默认值 说明
GET_EXTENSION_INFO_DEFAULT9+ 0x00000000 获取默认的extensionAbilityInfo
GET_EXTENSION_INFO_WITH_PERMISSION9+ 0x00000002 获取携带权限信息的extensionAbilityInfo
GET_EXTENSION_INFO_WITH_APPLICATION9+ 0x00000004 获取携带应用信息的extensionAbilityInfo
GET_EXTENSION_INFO_WITH_METADATA9+ 0x00000020 获取携带元数据信息的extensionAbilityInfo

ColorMode

颜色模式

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

名称 类型 说明
AUTO_MODE -1 自动模式
DARK_MODE 0 黑色模式
LIGHT_MODE 1 亮度模式

GrantStatus

授予状态

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

名称 类型 说明
PERMISSION_DENIED -1 拒绝许可
PERMISSION_GRANTED 0 批准

UpgradeFlag

此项仅供内部系统使用

系统API:

此接口为系统接口,三方应用不支持调用

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

名称 说明
NOT_UPGRADE9+ 0 模块无需升级
SINGLE_UPGRADE9+ 1 单个模块需要升级
RELATION_UPGRADE9+ 2 关系模块需要升级
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
其他
1
https://gitee.com/openharmony/docs.git
git@gitee.com:openharmony/docs.git
openharmony
docs
docs
OpenHarmony-3.2-Beta1

搜索帮助