openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 07:10:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

getBundleInfo&getBundleNameByUid public api

Browse Source 
Signed-off-by: zhaogan <zhaogan2@huawei.com>
This commit is contained in:
zhaogan 2024-11-06 16:02:12 +08:00
parent 55a0183883
commit 6b0b3479e8
1 changed files with 19 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
api/@ohos.bundle.bundleManager.d.ts vendored
View File

@ -1476,25 +1476,23 @@ declare namespace bundleManager {
function getBundleInfoForSelfSync(bundleFlags: number): BundleInfo; function getBundleInfoForSelfSync(bundleFlags: number): BundleInfo;
/** /**
* Obtains bundleInfo based on bundleName, bundleFlags. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access. * Obtains bundleInfo based on bundleName, bundleFlags. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { string } bundleName - Indicates the application bundle name to be queried. * @param { string } bundleName - Indicates the application bundle name to be queried.
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned.
* @param { AsyncCallback<BundleInfo> } callback - The callback of getting bundle info result. * @param { AsyncCallback<BundleInfo> } callback - The callback of getting bundle info result.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700001 - The specified bundleName is not found.
* @throws { BusinessError } 17700026 - The specified bundle is disabled. * @throws { BusinessError } 17700026 - The specified bundle is disabled.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 9
*/ */
function getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback<BundleInfo>): void; function getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback<BundleInfo>): void;
/** /**
* Obtains bundleInfo based on bundleName, bundleFlags and userId. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access. * Obtains bundleInfo based on bundleName, bundleFlags and userId. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { string } bundleName - Indicates the application bundle name to be queried. * @param { string } bundleName - Indicates the application bundle name to be queried.
@ -1502,20 +1500,18 @@ declare namespace bundleManager {
* @param { number } userId - Indicates the user ID or do not pass user ID. * @param { number } userId - Indicates the user ID or do not pass user ID.
* @param { AsyncCallback<BundleInfo> } callback - The callback of getting bundle info result. * @param { AsyncCallback<BundleInfo> } callback - The callback of getting bundle info result.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700001 - The specified bundleName is not found.
* @throws { BusinessError } 17700004 - The specified user ID is not found. * @throws { BusinessError } 17700004 - The specified user ID is not found.
* @throws { BusinessError } 17700026 - The specified bundle is disabled. * @throws { BusinessError } 17700026 - The specified bundle is disabled.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 9
*/ */
function getBundleInfo(bundleName: string, function getBundleInfo(bundleName: string,
bundleFlags: number, userId: number, callback: AsyncCallback<BundleInfo>): void; bundleFlags: number, userId: number, callback: AsyncCallback<BundleInfo>): void;
/** /**
* Obtains bundleInfo based on bundleName, bundleFlags and userId. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access. * Obtains bundleInfo based on bundleName, bundleFlags and userId. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { string } bundleName - Indicates the application bundle name to be queried. * @param { string } bundleName - Indicates the application bundle name to be queried.
@ -1523,14 +1519,12 @@ declare namespace bundleManager {
* @param { number } userId - Indicates the user ID or do not pass user ID. * @param { number } userId - Indicates the user ID or do not pass user ID.
* @returns { Promise<BundleInfo> } The result of getting the bundle info. * @returns { Promise<BundleInfo> } The result of getting the bundle info.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700001 - The specified bundleName is not found.
* @throws { BusinessError } 17700004 - The specified user ID is not found. * @throws { BusinessError } 17700004 - The specified user ID is not found.
* @throws { BusinessError } 17700026 - The specified bundle is disabled. * @throws { BusinessError } 17700026 - The specified bundle is disabled.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 9
*/ */
function getBundleInfo(bundleName: string, bundleFlags: number, userId?: number): Promise<BundleInfo>; function getBundleInfo(bundleName: string, bundleFlags: number, userId?: number): Promise<BundleInfo>;
@ -1952,50 +1946,44 @@ declare namespace bundleManager {
userId?: number): Array<ExtensionAbilityInfo>; userId?: number): Array<ExtensionAbilityInfo>;
/** /**
* Obtains bundle name by the given uid. * Obtains bundle name by the given uid. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { number } uid - Indicates the UID of an application. * @param { number } uid - Indicates the UID of an application.
* @param { AsyncCallback<string> } callback - The callback of getting bundle name. * @param { AsyncCallback<string> } callback - The callback of getting bundle name.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700021 - The uid is not found. * @throws { BusinessError } 17700021 - The uid is not found.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 9
*/ */
function getBundleNameByUid(uid: number, callback: AsyncCallback<string>): void; function getBundleNameByUid(uid: number, callback: AsyncCallback<string>): void;
/** /**
* Obtains bundle name by the given uid. * Obtains bundle name by the given uid. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { number } uid - Indicates the UID of an application. * @param { number } uid - Indicates the UID of an application.
* @returns { Promise<string> } Returns the bundle name. * @returns { Promise<string> } Returns the bundle name.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700021 - The uid is not found. * @throws { BusinessError } 17700021 - The uid is not found.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 9
*/ */
function getBundleNameByUid(uid: number): Promise<string>; function getBundleNameByUid(uid: number): Promise<string>;
/** /**
* Obtains bundle name by the given uid. * Obtains bundle name by the given uid. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { number } uid - Indicates the UID of an application. * @param { number } uid - Indicates the UID of an application.
* @returns { string } Returns the bundle name. * @returns { string } Returns the bundle name.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700021 - The uid is not found. * @throws { BusinessError } 17700021 - The uid is not found.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 10
*/ */
function getBundleNameByUidSync(uid: number): string; function getBundleNameByUidSync(uid: number): string;
@ -2804,7 +2792,7 @@ declare namespace bundleManager {
function getApplicationInfoSync(bundleName: string, applicationFlags: number): ApplicationInfo; function getApplicationInfoSync(bundleName: string, applicationFlags: number): ApplicationInfo;
/** /**
* Obtains bundleInfo based on bundleName, bundleFlags and userId. * Obtains bundleInfo based on bundleName, bundleFlags and userId. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { string } bundleName - Indicates the application bundle name to be queried. * @param { string } bundleName - Indicates the application bundle name to be queried.
@ -2812,32 +2800,28 @@ declare namespace bundleManager {
* @param { number } userId - Indicates the user ID or do not pass user ID. * @param { number } userId - Indicates the user ID or do not pass user ID.
* @returns { BundleInfo } - Returns the BundleInfo object. * @returns { BundleInfo } - Returns the BundleInfo object.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700001 - The specified bundleName is not found.
* @throws { BusinessError } 17700004 - The specified user ID is not found. * @throws { BusinessError } 17700004 - The specified user ID is not found.
* @throws { BusinessError } 17700026 - The specified bundle is disabled. * @throws { BusinessError } 17700026 - The specified bundle is disabled.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 9
*/ */
function getBundleInfoSync(bundleName: string, bundleFlags: number, userId: number): BundleInfo; function getBundleInfoSync(bundleName: string, bundleFlags: number, userId: number): BundleInfo;
/** /**
* Obtains bundleInfo based on bundleName, bundleFlags. * Obtains bundleInfo based on bundleName, bundleFlags. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { string } bundleName - Indicates the application bundle name to be queried. * @param { string } bundleName - Indicates the application bundle name to be queried.
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object that will be returned. * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object that will be returned.
* @returns { BundleInfo } - Returns the BundleInfo object. * @returns { BundleInfo } - Returns the BundleInfo object.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700001 - The specified bundleName is not found.
* @throws { BusinessError } 17700026 - The specified bundle is disabled. * @throws { BusinessError } 17700026 - The specified bundle is disabled.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 9
*/ */
function getBundleInfoSync(bundleName: string, bundleFlags: number): BundleInfo; function getBundleInfoSync(bundleName: string, bundleFlags: number): BundleInfo;
@ -3373,18 +3357,16 @@ declare namespace bundleManager {
function getAllAppCloneBundleInfo(bundleName: string, bundleFlags: number, userId?: number): Promise<Array<BundleInfo>>; function getAllAppCloneBundleInfo(bundleName: string, bundleFlags: number, userId?: number): Promise<Array<BundleInfo>>;
/** /**
* Obtains AppCloneIdentity contains bundleName and appIndex by the given uid. * Obtains AppCloneIdentity contains bundleName and appIndex by the given uid. The application requires to be a system application when requesting the permission of ohos.permission.GET_BUNDLE_INFO.
* *
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { number } uid - Indicates the UID of an application. * @param { number } uid - Indicates the UID of an application.
* @returns { Promise<AppCloneIdentity> } Returns the clone Identity contains bundleName and appIndex. * @returns { Promise<AppCloneIdentity> } Returns the clone Identity contains bundleName and appIndex.
* @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 17700021 - The uid is not found. * @throws { BusinessError } 17700021 - The uid is not found.
* @syscap SystemCapability.BundleManager.BundleFramework.Core * @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi * @since 14
* @since 12
*/ */
function getAppCloneIdentity(uid: number): Promise<AppCloneIdentity>; function getAppCloneIdentity(uid: number): Promise<AppCloneIdentity>;