The bundleManager module provides APIs for obtaining application information, including BundleInfo, ApplicationInfo, AbilityInfo, and ExtensionAbility.
The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
| Permission | APL | Description |
|---|---|---|
| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | Permission to obtain basic information and other sensitive information about a bundle. |
For details about the APL, see Basic Concepts in the Permission Mechanism.
Enumerates the bundle flags, which indicate the type of bundle information to obtain.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| GET_BUNDLE_INFO_DEFAULT | 0x00000000 | Used to obtain the default bundle information. The obtained information does not contain information about the signature, application, HAP module, ability, ExtensionAbility, or permission. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_APPLICATION | 0x00000001 | Used to obtain the bundle information with application information. The obtained information does not contain information about the signature, HAP module, ability, ExtensionAbility, or permission. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_HAP_MODULE | 0x00000002 | Used to obtain the bundle information with HAP module information. The obtained information does not contain information about the signature, application, ability, ExtensionAbility, or permission. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_ABILITY | 0x00000004 | Used to obtain the bundle information with ability information. The obtained information does not contain information about the signature, application, ExtensionAbility, or permission. It must be used together with GET_BUNDLE_INFO_WITH_HAP_MODULE. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY | 0x00000008 | Used to obtain the bundle information with ExtensionAbility information. The obtained information does not contain information about the signature, application, ability, or permission. It must be used together with GET_BUNDLE_INFO_WITH_HAP_MODULE. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION | 0x00000010 | Used to obtain the bundle information with permission information. The obtained information does not contain information about the signature, application, HAP module, ability, or ExtensionAbility. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_METADATA | 0x00000020 | Used to obtain the metadata contained in the application, HAP module, ability, or ExtensionAbility information. It must be used together with GET_BUNDLE_INFO_WITH_APPLICATION, GET_BUNDLE_INFO_WITH_HAP_MODULE, GET_BUNDLE_INFO_WITH_ABILITY, and GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_DISABLE | 0x00000040 | Used to obtain the information about disabled bundles and abilities of a bundle. The obtained information does not contain information about the signature, application, HAP module, ability, ExtensionAbility, or permission. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_SIGNATURE_INFO | 0x00000080 | Used to obtain the bundle information with signature information. The obtained information does not contain information about the application, HAP module, ability, ExtensionAbility, or permission. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_MENU11+ | 0x00000100 | Used to obtain the bundle information with the file context menu configuration. It must be used together with GET_BUNDLE_INFO_WITH_HAP_MODULE. Atomic service API: This API can be used in atomic services since API version 11. |
| GET_BUNDLE_INFO_WITH_ROUTER_MAP12+ | 0x00000200 | Used to obtain the bundle information with the router map. It must be used together with GET_BUNDLE_INFO_WITH_HAP_MODULE. Atomic service API: This API can be used in atomic services since API version 12. |
| GET_BUNDLE_INFO_WITH_SKILL12+ | 0x00000800 | Used to obtain the bundle information with the skills. It must be used together with GET_BUNDLE_INFO_WITH_HAP_MODULE, GET_BUNDLE_INFO_WITH_ABILITY, and GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY. Atomic service API: This API can be used in atomic services since API version 12. |
Enumerates the types of ExtensionAbilities.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| FORM | 0 | FormExtensionAbility: provides APIs for widget development. Atomic service API: This API can be used in atomic services since API version 11. |
| WORK_SCHEDULER | 1 | WorkSchedulerExtensionAbility: enables applications to execute non-real-time tasks when the system is idle. |
| INPUT_METHOD | 2 | InputMethodExtensionAbility: provides APIs for developing input method applications. |
| ACCESSIBILITY | 4 | |
| AccessibilityExtensionAbility: provides accessibility for access to and operations on the UI. | ||
| BACKUP | 9 | BackupExtensionAbility: provides APIs to implement application data backup and restore. |
| ENTERPRISE_ADMIN | 11 | EnterpriseAdminExtensionAbility: provides APIs for processing enterprise management events, such as application installation events on devices and events indicating too many incorrect screen-lock password attempts. |
| SHARE10+ | 16 | ShareExtensionAbility: provides sharing service templates based on UIExtensionAbilities. |
| ACTION10+ | 19 | ActionExtensionAbility: provides custom action service templates based on UIExtensionAbilities. |
| EMBEDDED_UI12+ | 21 | EmbeddedUIExtensionAbility: provides ExtensionAbilities for the embeddable UI across process. |
| INSIGHT_INTENT_UI12+ | 22 | InsightIntentUIExtensionAbility: provides APIs that enable applications to be called by Celia intents so as to be displayed in windows. |
| UNSPECIFIED | 255 | No type is specified. It is used together with queryExtensionAbilityInfo to query all types of ExtensionAbilities. |
Enumerates the permission grant states.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| PERMISSION_DENIED | -1 | Permission denied. |
| PERMISSION_GRANTED | 0 | Permission granted. |
Enumerates the window modes supported by the ability.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| FULL_SCREEN | 0 | A window in full-screen mode is supported. |
| SPLIT | 1 | A window in split-screen mode is supported. |
| FLOATING | 2 | A floating window is supported. |
Enumerates the launch types of the ability.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| SINGLETON | 0 | The ability can have only one instance. |
| MULTITON | 1 | The ability can have multiple instances. |
| SPECIFIED | 2 | The ability can have one or multiple instances, depending on the internal service of the ability. |
Enumerates the types of abilities.
Model restriction: This API can be used only in the FA model.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| PAGE | 1 | Ability that has the UI. FA developed using the Page template to provide the capability of interacting with users. |
| SERVICE | 2 | Ability of the background service type, without the UI. PA developed using the Service template to provide the capability of running tasks in the background. |
| DATA | 3 | PA developed using the Data template to provide unified data access for external systems. |
Enumerates the display orientations of the ability. This property applies only to the ability using the Page template.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| UNSPECIFIED | 0 | Unspecified. The orientation is determined by the system. Atomic service API: This API can be used in atomic services since API version 11. |
| LANDSCAPE | 1 | Landscape. Atomic service API: This API can be used in atomic services since API version 11. |
| PORTRAIT | 2 | Portrait. Atomic service API: This API can be used in atomic services since API version 11. |
| FOLLOW_RECENT | 3 | The last display orientation is used. Atomic service API: This API can be used in atomic services since API version 11. |
| LANDSCAPE_INVERTED | 4 | Reverse landscape. Atomic service API: This API can be used in atomic services since API version 11. |
| PORTRAIT_INVERTED | 5 | Reverse portrait. Atomic service API: This API can be used in atomic services since API version 11. |
| AUTO_ROTATION | 6 | Auto rotation. Atomic service API: This API can be used in atomic services since API version 11. |
| AUTO_ROTATION_LANDSCAPE | 7 | Auto rotation in the horizontal direction. Atomic service API: This API can be used in atomic services since API version 11. |
| AUTO_ROTATION_PORTRAIT | 8 | Auto rotation in the vertical direction. Atomic service API: This API can be used in atomic services since API version 11. |
| AUTO_ROTATION_RESTRICTED | 9 | Switched-determined auto rotation. Atomic service API: This API can be used in atomic services since API version 11. |
| AUTO_ROTATION_LANDSCAPE_RESTRICTED | 10 | Switched-determined auto rotation in the horizontal direction. Atomic service API: This API can be used in atomic services since API version 11. |
| AUTO_ROTATION_PORTRAIT_RESTRICTED | 11 | Switched-determined auto rotation in the vertical direction. Atomic service API: This API can be used in atomic services since API version 11. |
| LOCKED | 12 | Locked. Atomic service API: This API can be used in atomic services since API version 11. |
| AUTO_ROTATION_UNSPECIFIED12+ | 13 | Auto rotation controlled by the switch and determined by the system. Atomic service API: This API can be used in atomic services since API version 12. |
| FOLLOW_DESKTOP12+ | 14 | Following the orientation of the home screen. Atomic service API: This API can be used in atomic services since API version 12. |
Defines the version compatibility type of the shared library.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| BACKWARD_COMPATIBILITY | 1 | The shared library is backward compatible. |
Enumerates the module types.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| ENTRY | 1 | Main module of the application. |
| FEATURE | 2 | Dynamic feature module of the application. |
| SHARED | 3 | Dynamic shared library module of the application. |
Enumerates the bundle types.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| APP | 0 | The bundle is an application. |
| ATOMIC_SERVICE | 1 | The bundle is an atomic service. |
Enumerates the types of the multi-app mode.
System capability: SystemCapability.BundleManager.BundleFramework.Core
| Name | Value | Description |
|---|---|---|
| UNSPECIFIED | 0 | Unspecified type. |
| MULTI_INSTANCE | 1 | Multiton mode. |
| APP_CLONE | 2 | App clone mode. |
getBundleInfoForSelf(bundleFlags: number): Promise<BundleInfo>
Obtains the bundle information based on the given bundle flags. This API uses a promise to return the result.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| bundleFlags | number | Yes | Type of the bundle information to obtain. |
Return value
| Type | Description |
|---|---|
| Promise<BundleInfo> | Promise used to return the bundle information. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
Example
// Obtain application info with metadataArray.
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION | bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_METADATA;
try {
bundleManager.getBundleInfoForSelf(bundleFlags).then((data) => {
hilog.info(0x0000, 'testTag', 'getBundleInfoForSelf successfully. Data: %{public}s', JSON.stringify(data));
}).catch((err: BusinessError) => {
hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed. Cause: %{public}s', err.message);
});
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed: %{public}s', message);
} getBundleInfoForSelf(bundleFlags: number, callback: AsyncCallback<BundleInfo>): void
Obtains the bundle information based on the given bundle flags. This API uses an asynchronous callback to return the result.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| bundleFlags | number | Yes | Type of the bundle information to obtain. |
| callback | AsyncCallback<BundleInfo> | Yes | Callback used to return the result. If the operation is successful, err is null and data is the bundle information obtained. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
Example
// Obtain ability info with permissions.
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_HAP_MODULE | bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_ABILITY | bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION;
try {
bundleManager.getBundleInfoForSelf(bundleFlags, (err, data) => {
if (err) {
hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed: %{public}s', err.message);
} else {
hilog.info(0x0000, 'testTag', 'getBundleInfoForSelf successfully: %{public}s', JSON.stringify(data));
}
});
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getBundleInfoForSelf failed: %{public}s', message);
} getProfileByAbility(moduleName: string, abilityName: string, metadataName: string, callback: AsyncCallback<Array<string>>): void
Obtains the JSON string array of the configuration file based on the given module name, ability name, and metadata name (name configured in metadata). This API uses an asynchronous callback to return the result.
If the profile uses the resource reference format, the return value retains this format (for example, $string:res_id). You can obtain the referenced resources through related APIs of the resource management module.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| moduleName | string | Yes | Module name. |
| abilityName | string | Yes | Name of the UIAbility component. |
| metadataName | string | Yes | Metadata name of the UIAbility component, that is, name of the metadata tag under abilities in the module.json5 file. |
| callback | AsyncCallback<Array<string>> | Yes | Callback used to return the result. If the operation is successful, err is null and data is the array of JSON strings obtained. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Universal Error Codes and Bundle Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 17700002 | The specified moduleName is not existed. |
| 17700003 | The specified abilityName is not existed. |
| 17700024 | Failed to get the profile because there is no profile in the HAP. |
| 17700026 | The specified bundle is disabled. |
| 17700029 | The specified ability is disabled. |
Example
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let moduleName = 'entry';
let abilityName = 'EntryAbility';
let metadataName = 'ability_metadata';
try {
bundleManager.getProfileByAbility(moduleName, abilityName, metadataName, (err, data) => {
if (err) {
hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', err.message);
} else {
hilog.info(0x0000, 'testTag', 'getProfileByAbility successfully: %{public}s', JSON.stringify(data));
}
});
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', message);
} getProfileByAbility(moduleName: string, abilityName: string, metadataName?: string): Promise<Array<string>>
Obtains the JSON string array of the configuration file based on the given module name, ability name, and metadata name (name configured in metadata). This API uses a promise to return the result.
If the profile uses the resource reference format, the return value retains this format (for example, $string:res_id). You can obtain the referenced resources through related APIs of the resource management module.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| moduleName | string | Yes | Module name. |
| abilityName | string | Yes | Name of the UIAbility component. |
| metadataName | string | No | Metadata name of the UIAbility component, that is, name of the metadata tag under abilities in the module.json5 file. The default value is null. |
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the array of JSON strings obtained. |
Error codes
For details about the error codes, see Universal Error Codes and Bundle Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 17700002 | The specified moduleName is not existed. |
| 17700003 | The specified abilityName is not existed. |
| 17700024 | Failed to get the profile because there is no profile in the HAP. |
| 17700026 | The specified bundle is disabled. |
| 17700029 | The specified ability is disabled. |
Example
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let moduleName = 'entry';
let abilityName = 'EntryAbility';
try {
// Obtain the JSON string array of the configuration file based on the module name and ability name.
bundleManager.getProfileByAbility(moduleName, abilityName).then((data) => {
hilog.info(0x0000, 'testTag', 'getProfileByAbility successfully. Data: %{public}s', JSON.stringify(data));
}).catch((err: BusinessError) => {
hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', err.message);
});
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', message);
} import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let moduleName = 'entry';
let abilityName = 'EntryAbility';
let metadataName = 'ability_metadata';
try {
// Obtain the JSON string array of the configuration file based on the module name, ability name, and metadata name.
bundleManager.getProfileByAbility(moduleName, abilityName, metadataName).then((data) => {
hilog.info(0x0000, 'testTag', 'getProfileByAbility successfully. Data: %{public}s', JSON.stringify(data));
}).catch((err: BusinessError) => {
hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', err.message);
});
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByAbility failed. Cause: %{public}s', message);
} getProfileByAbilitySync(moduleName: string, abilityName: string, metadataName?: string): Array<string>
Obtains the JSON string array of the current application's configuration file in the metadata based on a given module name, ability name, and metadata name. This API returns the result synchronously. The result value is a string array.
If the profile uses the resource reference format, the return value retains this format (for example, $string:res_id). You can obtain the referenced resources through related APIs of the resource management module.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| moduleName | string | Yes | Module name. |
| abilityName | string | Yes | Name of the UIAbility component. |
| metadataName | string | No | Metadata name of the UIAbility component, that is, name of the metadata tag under abilities in the module.json5 file. The default value is null. |
Return value
| Type | Description |
|---|---|
| Array<string> | An array of JSON strings. |
Error codes
For details about the error codes, see Universal Error Codes and Bundle Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 17700002 | The specified moduleName is not existed. |
| 17700003 | The specified abilityName is not existed. |
| 17700024 | Failed to get the profile because there is no profile in the HAP. |
| 17700026 | The specified bundle is disabled. |
| 17700029 | The specified ability is disabled. |
Example
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let moduleName = 'entry';
let abilityName = 'EntryAbility';
try {
// Obtain the JSON string array of the configuration file based on the module name and ability name.
let data = bundleManager.getProfileByAbilitySync(moduleName, abilityName);
hilog.info(0x0000, 'testTag', 'getProfileByAbilitySync successfully. Data: %{public}s', JSON.stringify(data));
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByAbilitySync failed. Cause: %{public}s', message);
} import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let moduleName: string = 'entry';
let abilityName: string = 'EntryAbility';
let metadataName: string = 'ability_metadata';
try {
// Obtain the JSON string array of the configuration file based on the module name, ability name, and metadata name.
let data = bundleManager.getProfileByAbilitySync(moduleName, abilityName, metadataName);
hilog.info(0x0000, 'testTag', 'getProfileByAbilitySync successfully. Data: %{public}s', JSON.stringify(data));
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByAbilitySync failed. Cause: %{public}s', message);
} getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, metadataName: string, callback: AsyncCallback<Array<string>>): void
Obtains the JSON string array of the configuration file based on the given module name, ExtensionAbility name, and metadata name (name configured in metadata). This API uses an asynchronous callback to return the result.
If the profile uses the resource reference format, the return value retains this format (for example, $string:res_id). You can obtain the referenced resources through related APIs of the resource management module.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| moduleName | string | Yes | Module name. |
| extensionAbilityName | string | Yes | Name of the ExtensionAbility component. |
| metadataName | string | Yes | Metadata name of the ExtensionAbility component, that is, name of the metadata tag under extensionAbilities in the module.json5 file. |
| callback | AsyncCallback<Array<string>> | Yes | Callback used to return the result. If the operation is successful, err is null and data is the array of JSON strings obtained. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Universal Error Codes and Bundle Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 17700002 | The specified moduleName is not existed. |
| 17700003 | The specified extensionAbilityName not existed. |
| 17700024 | Failed to get the profile because there is no profile in the HAP. |
| 17700026 | The specified bundle is disabled. |
Example
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let moduleName = 'entry';
let extensionAbilityName = 'com.example.myapplication.extension';
let metadataName = 'ability_metadata';
try {
bundleManager.getProfileByExtensionAbility(moduleName, extensionAbilityName, metadataName, (err, data) => {
if (err) {
hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed: %{public}s', err.message);
} else {
hilog.info(0x0000, 'testTag', 'getProfileByExtensionAbility successfully: %{public}s', JSON.stringify(data));
}
});
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed: %{public}s', message);
} getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, metadataName?: string): Promise<Array<string>>
Obtains the JSON string array of the current application's configuration file in the metadata based on a given module name, ExtensionAbility name, and metadata name. This API uses a promise to return the result.
If the profile uses the resource reference format, the return value retains this format (for example, $string:res_id). You can obtain the referenced resources through related APIs of the resource management module.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| moduleName | string | Yes | Module name. |
| extensionAbilityName | string | Yes | Name of the ExtensionAbility component. |
| metadataName | string | No | Metadata name of the ExtensionAbility component, that is, name of the metadata tag under extensionAbilities in the module.json5 file. The default value is null. |
Return value
| Type | Description |
|---|---|
| Promise<Array<string>> | Promise used to return the array of JSON strings obtained. |
Error codes
For details about the error codes, see Universal Error Codes and Bundle Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 17700002 | The specified moduleName is not existed. |
| 17700003 | The specified extensionAbilityName not existed. |
| 17700024 | Failed to get the profile because there is no profile in the HAP. |
| 17700026 | The specified bundle is disabled. |
Example
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let moduleName = 'entry';
let extensionAbilityName = 'com.example.myapplication.extension';
let metadataName = 'ability_metadata';
try {
bundleManager.getProfileByExtensionAbility(moduleName, extensionAbilityName).then((data) => {
hilog.info(0x0000, 'testTag', 'getProfileByExtensionAbility successfully. Data: %{public}s', JSON.stringify(data));
}).catch((err: BusinessError) => {
hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', err.message);
});
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', message);
}
try {
bundleManager.getProfileByExtensionAbility(moduleName, extensionAbilityName, metadataName).then((data) => {
hilog.info(0x0000, 'testTag', 'getProfileByExtensionAbility successfully. Data: %{public}s', JSON.stringify(data));
}).catch((err: BusinessError) => {
hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', err.message);
});
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbility failed. Cause: %{public}s', message);
} getProfileByExtensionAbilitySync(moduleName: string, extensionAbilityName: string, metadataName?: string): Array<string>
Obtains the JSON string array of the current application's configuration file in the metadata based on a given module name, ExtensionAbility name, and metadata name. This API returns the result synchronously. The result value is a string array.
If the profile uses the resource reference format, the return value retains this format (for example, $string:res_id). You can obtain the referenced resources through related APIs of the resource management module.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| moduleName | string | Yes | Module name. |
| extensionAbilityName | string | Yes | Name of the ExtensionAbility component. |
| metadataName | string | No | Metadata name of the ExtensionAbility component, that is, name of the metadata tag under extensionAbilities in the module.json5 file. The default value is null. |
Return value
| Type | Description |
|---|---|
| Array<string> | An array of JSON strings. |
Error codes
For details about the error codes, see Universal Error Codes and Bundle Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 17700002 | The specified moduleName is not existed. |
| 17700003 | The specified extensionAbilityName not existed. |
| 17700024 | Failed to get the profile because there is no profile in the HAP. |
| 17700026 | The specified bundle is disabled. |
Example
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let moduleName = 'entry';
let extensionAbilityName = 'com.example.myapplication.extension';
let metadataName = 'ability_metadata';
try {
let data = bundleManager.getProfileByExtensionAbilitySync(moduleName, extensionAbilityName);
hilog.info(0x0000, 'testTag', 'getProfileByExtensionAbilitySync successfully. Data: %{public}s', JSON.stringify(data));
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbilitySync failed. Cause: %{public}s', message);
}
try {
let data = bundleManager.getProfileByExtensionAbilitySync(moduleName, extensionAbilityName, metadataName);
hilog.info(0x0000, 'testTag', 'getProfileByExtensionAbilitySync successfully. Data: %{public}s', JSON.stringify(data));
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getProfileByExtensionAbilitySync failed. Cause: %{public}s', message);
} getBundleInfoForSelfSync(bundleFlags: number): BundleInfo
Obtains the bundle information of this bundle based on the given bundle flags. This API returns the result synchronously.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| bundleFlags | number | Yes | Type of the bundle information to obtain. |
Return value
| Type | Description |
|---|---|
| BundleInfo | Bundle information obtained. |
Error codes
For details about the error codes, see Universal Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
Example
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION;
try {
let data = bundleManager.getBundleInfoForSelfSync(bundleFlags);
hilog.info(0x0000, 'testTag', 'getBundleInfoForSelfSync successfully: %{public}s', JSON.stringify(data));
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getBundleInfoForSelfSync failed: %{public}s', message);
} canOpenLink(link: string): boolean
Checks whether a link can be opened. The scheme of the specified link must be configured in the querySchemes field of the module.json file.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| link | string | Yes | Link to check. |
Return value
| Type | Description |
|---|---|
| boolean | true: The link can be opened. false: The link cannot be opened. |
Error codes
For details about the error codes, see Universal Error Codes and Bundle Error Codes.
| ID | Error Message |
|---|---|
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 17700055 | The specified link is invalid. |
| 17700056 | The scheme of the specified link is not in the querySchemes. |
Example
import { bundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
try {
let link = 'welink://';
let data = bundleManager.canOpenLink(link);
hilog.info(0x0000, 'testTag', 'canOpenLink successfully: %{public}s', JSON.stringify(data));
} catch (err) {
let message = (err as BusinessError).message;
hilog.error(0x0000, 'testTag', 'canOpenLink failed: %{public}s', message);
} getLaunchWant(): Want
Obtains the Want parameter used to start the application.
Atomic service API: This API can be used in atomic services since API version 13.
System capability: SystemCapability.BundleManager.BundleFramework.Core
Return value
| Type | Description |
|---|---|
| Want | Want object that contains the bundle name and ability name. |
Error codes
For details about the error codes, see Bundle Error Codes.
| ID | Error Message |
|---|---|
| 17700072 | The launch want is not found. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
import { bundleManager } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
try {
let want = bundleManager.getLaunchWant();
hilog.info(0x0000, 'testTag', 'getLaunchWant ability name: %{public}s', want.abilityName);
hilog.info(0x0000, 'testTag', 'getLaunchWant bundle name: %{public}s', want.bundleName);
} catch (error) {
let message = (error as BusinessError).message;
hilog.error(0x0000, 'testTag', 'getLaunchWant failed: %{public}s', message);
}