@ohos.bundle.innerBundleManager (innerBundleManager Module) (System API)
The module provides APIs for the Home Screen application.
NOTE
The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
This module is deprecated since API version 9. You are advised to use launcherBundleManager and bundleMonitor instead.
The APIs provided by this module are system APIs.
Modules to Import
import innerBundleManager from '@ohos.bundle.innerBundleManager';
System Capability
SystemCapability.BundleManager.BundleFramework
innerBundleManager.getLauncherAbilityInfos(deprecated)
getLauncherAbilityInfos(bundleName: string, userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void
Obtains an array of the launcher ability information based on a given bundle name. This API uses an asynchronous callback to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use getLauncherAbilityInfo instead.
Required permissions
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| bundleName | string | Yes | Bundle name. |
| userId | number | Yes | User ID. The value must be greater than or equal to 0. |
| callback | AsyncCallback<Array<LauncherAbilityInfo>> | Yes | Callback used to return an array of the launcher ability information. |
innerBundleManager.getLauncherAbilityInfos(deprecated)
getLauncherAbilityInfos(bundleName: string, userId: number) : Promise<Array<LauncherAbilityInfo>>
Obtains an array of the launcher ability information based on a given bundle name. This API uses a promise to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use getLauncherAbilityInfo instead.
Required permissions
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| bundleName | string | Yes | Bundle name. |
| userId | number | Yes | User ID. The value must be greater than or equal to 0. |
Return value
| Type | Description |
|---|---|
| Promise<Array<LauncherAbilityInfo>> | Promise used to return an array of the launcher ability information. |
innerBundleManager.on(deprecated)
on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback, callback: AsyncCallback<string>) : void
Registers a callback to receive bundle status changes. This API uses an asynchronous callback to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use on instead.
Required permissions
ohos.permission.LISTEN_BUNDLE_CHANGE
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Event type. Only BundleStatusChange is supported. |
| bundleStatusCallback | BundleStatusCallback | Yes | Callback to register. |
| callback | AsyncCallback<string> | Yes | Callback used to return a successful result or error information. |
innerBundleManager.on(deprecated)
on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback) : Promise<string>
Registers a callback to receive bundle status changes. This API uses an asynchronous callback to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use on instead.
Required permissions
ohos.permission.LISTEN_BUNDLE_CHANGE
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Event type. Only BundleStatusChange is supported. |
| bundleStatusCallback | BundleStatusCallback | Yes | Callback to register. |
Return value
| Type | Description |
|---|---|
| Promise<string> | Promise used to return a successful result or error information. |
innerBundleManager.off(deprecated)
off(type:"BundleStatusChange", callback: AsyncCallback<string>) : void
Unregisters the callback that receives bundle status changes. This API uses an asynchronous callback to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use off instead.
Required permissions
ohos.permission.LISTEN_BUNDLE_CHANGE
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Event type. Only BundleStatusChange is supported. |
| callback | AsyncCallback<string> | Yes | Callback used to return a successful result or error information. |
innerBundleManager.off(deprecated)
off(type:"BundleStatusChange") : Promise<string>
Unregisters the callback that receives bundle status changes. This API uses an asynchronous callback to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use off instead.
Required permissions
ohos.permission.LISTEN_BUNDLE_CHANGE
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| type | string | Yes | Event type. Only BundleStatusChange is supported. |
Return value
| Type | Description |
|---|---|
| Promise<string> | Promise used to return a successful result or error information. |
innerBundleManager.getAllLauncherAbilityInfos(deprecated)
getAllLauncherAbilityInfos(userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void
Obtains the information about all launcher abilities. This API uses an asynchronous callback to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use getAllLauncherAbilityInfo instead.
Required permissions
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| userId | number | Yes | User ID. The value must be greater than or equal to 0. |
| callback | AsyncCallback<Array<LauncherAbilityInfo>> | Yes | Callback used to return an array of the launcher ability information. |
innerBundleManager.getAllLauncherAbilityInfos(deprecated)
getAllLauncherAbilityInfos(userId: number) : Promise<Array<LauncherAbilityInfo>>
Obtains the information about all launcher abilities. This API uses a promise to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use getAllLauncherAbilityInfo instead.
Required permissions
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| userId | number | Yes | User ID. The value must be greater than or equal to 0. |
Return value
| Type | Description |
|---|---|
| Promise<Array<LauncherAbilityInfo>> | Promise used to return an array of the launcher ability information. |
innerBundleManager.getShortcutInfos(deprecated)
getShortcutInfos(bundleName :string, callback: AsyncCallback<Array<ShortcutInfo>>) : void
Obtains an array of the shortcut information based on a given bundle name. This API uses an asynchronous callback to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use getShortcutInfo instead.
Required permissions
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| bundleName | string | Yes | Bundle name. |
| callback | AsyncCallback<Array<ShortcutInfo>> | Yes | Callback used to return an array of the shortcut information. |
innerBundleManager.getShortcutInfos(deprecated)
getShortcutInfos(bundleName : string) : Promise<Array<ShortcutInfo>>
Obtains an array of the shortcut information based on a given bundle name. This API uses a promise to return the result.
NOTE
This API has been supported since API version 8 and deprecated since API version 9. You are advised to use getShortcutInfo instead.
Required permissions
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
System capability
SystemCapability.BundleManager.BundleFramework
System API
This is a system API.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| bundleName | string | Yes | Bundle name. |
Return value
| Type | Description |
|---|---|
| Promise<Array<ShortcutInfo>> | Promise used to return an array of the shortcut information. |