mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 22:24:20 +00:00
254a788463
Description:bms add sync api Sig:SIG_ApplicaitonFramework Feature or Bugfix:Feature Binary Source:No Signed-off-by: wangtiantian <wangtiantian19@huawei.com>
2215 lines
99 KiB
TypeScript
2215 lines
99 KiB
TypeScript
/*
|
|
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { AsyncCallback } from './@ohos.base';
|
|
import { ApplicationInfo as _ApplicationInfo } from './bundleManager/ApplicationInfo';
|
|
import { Metadata as _Metadata } from './bundleManager/Metadata';
|
|
import { PermissionDef as _PermissionDef } from './bundleManager/PermissionDef';
|
|
import { ElementName as _ElementName } from './bundleManager/ElementName';
|
|
import { SharedBundleInfo as _SharedBundleInfo } from './bundleManager/SharedBundleInfo';
|
|
import Want from './@ohos.app.ability.Want';
|
|
import * as _AbilityInfo from './bundleManager/AbilityInfo';
|
|
import * as _AppProvisionInfo from './bundleManager/AppProvisionInfo';
|
|
import * as _BundleInfo from './bundleManager/BundleInfo';
|
|
import * as _HapModuleInfo from './bundleManager/HapModuleInfo';
|
|
import * as _ExtensionAbilityInfo from './bundleManager/ExtensionAbilityInfo';
|
|
|
|
/**
|
|
* This module is used to obtain package information of various applications installed on the current device.
|
|
*
|
|
* @namespace bundleManager
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
declare namespace bundleManager {
|
|
/**
|
|
* Used to query the enumeration value of bundleInfo. Multiple values can be passed in the form.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
enum BundleFlag {
|
|
/**
|
|
* Used to obtain the default bundleInfo. The obtained bundleInfo does not contain information of
|
|
* signatureInfo, applicationInfo, hapModuleInfo, ability, extensionAbility and permission.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_DEFAULT = 0x00000000,
|
|
/**
|
|
* Used to obtain the bundleInfo containing applicationInfo. The obtained bundleInfo does not
|
|
* contain the information of signatureInfo, hapModuleInfo, ability, extensionAbility and permission.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_WITH_APPLICATION = 0x00000001,
|
|
/**
|
|
* Used to obtain the bundleInfo containing hapModuleInfo. The obtained bundleInfo does not
|
|
* contain the information of signatureInfo, applicationInfo, ability, extensionAbility and permission.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_WITH_HAP_MODULE = 0x00000002,
|
|
/**
|
|
* Used to obtain the bundleInfo containing ability. The obtained bundleInfo does not
|
|
* contain the information of signatureInfo, applicationInfo, extensionAbility and permission.
|
|
* It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_WITH_ABILITY = 0x00000004,
|
|
/**
|
|
* Used to obtain the bundleInfo containing extensionAbility. The obtained bundleInfo does not
|
|
* contain the information of signatureInfo, applicationInfo, ability and permission.
|
|
* It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY = 0x00000008,
|
|
/**
|
|
* Used to obtain the bundleInfo containing permission. The obtained bundleInfo does not
|
|
* contain the information of signatureInfo, applicationInfo, hapModuleInfo, extensionAbility and ability.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION = 0x00000010,
|
|
/**
|
|
* Used to obtain the metadata contained in applicationInfo, moduleInfo and abilityInfo.
|
|
* It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_APPLICATION,
|
|
* GET_BUNDLE_INFO_WITH_HAP_MODULE, GET_BUNDLE_INFO_WITH_ABILITIES, GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_WITH_METADATA = 0x00000020,
|
|
/**
|
|
* Used to obtain the default bundleInfo containing disabled application and ability.
|
|
* The obtained bundleInfo does not contain information of signatureInfo, applicationInfo,
|
|
* hapModuleInfo, ability, extensionAbility and permission.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_WITH_DISABLE = 0x00000040,
|
|
/**
|
|
* Used to obtain the bundleInfo containing signatureInfo. The obtained bundleInfo does not
|
|
* contain the information of applicationInfo, hapModuleInfo, extensionAbility, ability and permission.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
GET_BUNDLE_INFO_WITH_SIGNATURE_INFO = 0x00000080
|
|
}
|
|
|
|
/**
|
|
* Used to query the enumeration value of applicationInfo. Multiple values can be passed in the form.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
enum ApplicationFlag {
|
|
/**
|
|
* Used to obtain the default applicationInfo. The obtained applicationInfo does not contain the information of
|
|
* permission and metadata.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_APPLICATION_INFO_DEFAULT = 0x00000000,
|
|
/**
|
|
* Used to obtain the applicationInfo containing permission.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_APPLICATION_INFO_WITH_PERMISSION = 0x00000001,
|
|
/**
|
|
* Used to obtain the applicationInfo containing metadata.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_APPLICATION_INFO_WITH_METADATA = 0x00000002,
|
|
/**
|
|
* Used to obtain the applicationInfo containing disabled application.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_APPLICATION_INFO_WITH_DISABLE = 0x00000004
|
|
}
|
|
|
|
/**
|
|
* Used to query the enumeration value of abilityInfo. Multiple values can be passed in the form.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
enum AbilityFlag {
|
|
/**
|
|
* Used to obtain the default abilityInfo. The obtained abilityInfo does not contain the information of
|
|
* permission, metadata and disabled abilityInfo.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_ABILITY_INFO_DEFAULT = 0x00000000,
|
|
/**
|
|
* Used to obtain the abilityInfo containing permission.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_ABILITY_INFO_WITH_PERMISSION = 0x00000001,
|
|
/**
|
|
* Used to obtain the abilityInfo containing applicationInfo.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_ABILITY_INFO_WITH_APPLICATION = 0x00000002,
|
|
/**
|
|
* Used to obtain the abilityInfo containing metadata.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_ABILITY_INFO_WITH_METADATA = 0x00000004,
|
|
/**
|
|
* Used to obtain the abilityInfo containing disabled abilityInfo.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_ABILITY_INFO_WITH_DISABLE = 0x00000008,
|
|
/**
|
|
* Used to obtain the abilityInfo only for system app.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_ABILITY_INFO_ONLY_SYSTEM_APP = 0x00000010
|
|
}
|
|
|
|
/**
|
|
* Used to query the enumeration value of ExtensionAbilityInfo. Multiple values can be passed in the form.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
enum ExtensionAbilityFlag {
|
|
/**
|
|
* Used to obtain the default extensionAbilityInfo. The obtained extensionAbilityInfo does not contain the information of
|
|
* permission, metadata and disabled abilityInfo.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_EXTENSION_ABILITY_INFO_DEFAULT = 0x00000000,
|
|
/**
|
|
* Used to obtain the extensionAbilityInfo containing permission.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_EXTENSION_ABILITY_INFO_WITH_PERMISSION = 0x00000001,
|
|
/**
|
|
* Used to obtain the extensionAbilityInfo containing applicationInfo.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_EXTENSION_ABILITY_INFO_WITH_APPLICATION = 0x00000002,
|
|
/**
|
|
* Used to obtain the extensionAbilityInfo containing metadata.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
GET_EXTENSION_ABILITY_INFO_WITH_METADATA = 0x00000004
|
|
}
|
|
|
|
/**
|
|
* This enumeration value is used to identify various types of extension ability
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export enum ExtensionAbilityType {
|
|
/**
|
|
* Indicates extension info with type of form
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
FORM = 0,
|
|
|
|
/**
|
|
* Indicates extension info with type of work schedule
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
WORK_SCHEDULER = 1,
|
|
|
|
/**
|
|
* Indicates extension info with type of input method
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
INPUT_METHOD = 2,
|
|
|
|
/**
|
|
* Indicates extension info with type of service
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
SERVICE = 3,
|
|
|
|
/**
|
|
* Indicates extension info with type of accessibility
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
ACCESSIBILITY = 4,
|
|
|
|
/**
|
|
* Indicates extension info with type of dataShare
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
DATA_SHARE = 5,
|
|
|
|
/**
|
|
* Indicates extension info with type of filesShare
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
FILE_SHARE = 6,
|
|
|
|
/**
|
|
* Indicates extension info with type of staticSubscriber
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
STATIC_SUBSCRIBER = 7,
|
|
|
|
/**
|
|
* Indicates extension info with type of wallpaper
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
WALLPAPER = 8,
|
|
|
|
/**
|
|
* Indicates extension info with type of backup
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
BACKUP = 9,
|
|
|
|
/**
|
|
* Indicates extension info with type of window
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
WINDOW = 10,
|
|
|
|
/**
|
|
* Indicates extension info with type of enterprise admin
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
ENTERPRISE_ADMIN = 11,
|
|
|
|
/**
|
|
* Indicates extension info with type of thumbnail
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
THUMBNAIL = 13,
|
|
|
|
/**
|
|
* Indicates extension info with type of preview
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
PREVIEW = 14,
|
|
|
|
/**
|
|
* Indicates extension info with type of print
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
PRINT = 15,
|
|
|
|
/**
|
|
* Indicates extension info with type of share
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
SHARE = 16,
|
|
|
|
/**
|
|
* Indicates extension info with type of push
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
PUSH = 17,
|
|
|
|
/**
|
|
* Indicates extension info with type of driver
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
DRIVER = 18,
|
|
|
|
/**
|
|
* Indicates extension info with type of action
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
ACTION = 19,
|
|
|
|
/**
|
|
* Indicates extension info with type of unspecified
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
UNSPECIFIED = 255
|
|
}
|
|
|
|
/**
|
|
* PermissionGrantState
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export enum PermissionGrantState {
|
|
/**
|
|
* PERMISSION_DENIED
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
PERMISSION_DENIED = -1,
|
|
|
|
/**
|
|
* PERMISSION_GRANTED
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
PERMISSION_GRANTED = 0
|
|
}
|
|
|
|
/**
|
|
* Support window mode
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export enum SupportWindowMode {
|
|
/**
|
|
* Indicates supported window mode of full screen mode
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
FULL_SCREEN = 0,
|
|
/**
|
|
* Indicates supported window mode of split mode
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
SPLIT = 1,
|
|
/**
|
|
* Indicates supported window mode of floating mode
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
FLOATING = 2
|
|
}
|
|
|
|
/**
|
|
* Launch type
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Launch type
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export enum LaunchType {
|
|
/**
|
|
* Indicates that the ability has only one instance
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates that the ability has only one instance
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
SINGLETON = 0,
|
|
|
|
/**
|
|
* Indicates that the ability can have multiple instances
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates that the ability can have multiple instances
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
MULTITON = 1,
|
|
|
|
/**
|
|
* Indicates that the ability can have specified instances
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
SPECIFIED = 2
|
|
}
|
|
|
|
/**
|
|
* Indicates ability type
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @FAModelOnly
|
|
* @since 9
|
|
*/
|
|
export enum AbilityType {
|
|
/**
|
|
* Indicates that the ability has a UI
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @FAModelOnly
|
|
* @since 9
|
|
*/
|
|
PAGE = 1,
|
|
|
|
/**
|
|
* Indicates that the ability does not have a UI
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @FAModelOnly
|
|
* @since 9
|
|
*/
|
|
SERVICE = 2,
|
|
|
|
/**
|
|
* Indicates that the ability is used to provide data access services
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @FAModelOnly
|
|
* @since 9
|
|
*/
|
|
DATA = 3
|
|
}
|
|
|
|
/**
|
|
* Display orientation
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export enum DisplayOrientation {
|
|
/**
|
|
* Indicates that the system automatically determines the display orientation
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
UNSPECIFIED,
|
|
|
|
/**
|
|
* Indicates the landscape orientation
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
LANDSCAPE,
|
|
|
|
/**
|
|
* Indicates the portrait orientation
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
PORTRAIT,
|
|
|
|
/**
|
|
* Indicates the page ability orientation is the same as that of the nearest ability in the stack
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
FOLLOW_RECENT,
|
|
|
|
/**
|
|
* Indicates the inverted landscape orientation
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
LANDSCAPE_INVERTED,
|
|
|
|
/**
|
|
* Indicates the inverted portrait orientation
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
PORTRAIT_INVERTED,
|
|
|
|
/**
|
|
* Indicates the orientation can be auto-rotated
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
AUTO_ROTATION,
|
|
|
|
/**
|
|
* Indicates the landscape orientation rotated with sensor
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
AUTO_ROTATION_LANDSCAPE,
|
|
|
|
/**
|
|
* Indicates the portrait orientation rotated with sensor
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
AUTO_ROTATION_PORTRAIT,
|
|
|
|
/**
|
|
* Indicates the sensor restricted mode
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
AUTO_ROTATION_RESTRICTED,
|
|
|
|
/**
|
|
* Indicates the sensor landscape restricted mode
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
AUTO_ROTATION_LANDSCAPE_RESTRICTED,
|
|
|
|
/**
|
|
* Indicates the sensor portrait restricted mode
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
AUTO_ROTATION_PORTRAIT_RESTRICTED,
|
|
|
|
/**
|
|
* Indicates the locked orientation mode
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
LOCKED
|
|
}
|
|
|
|
/**
|
|
* Indicates module type
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export enum ModuleType {
|
|
/**
|
|
* Indicates entry type
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
ENTRY = 1,
|
|
/**
|
|
* Indicates feature type
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
FEATURE = 2,
|
|
/**
|
|
* Indicates shared type
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
SHARED = 3
|
|
}
|
|
|
|
/**
|
|
* Indicates bundle type
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export enum BundleType {
|
|
/**
|
|
* Indicates app
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
APP = 0,
|
|
/*
|
|
* Indicates atomic service
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
ATOMIC_SERVICE = 1
|
|
}
|
|
|
|
/**
|
|
* Shared bundle compatible policy
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
export enum CompatiblePolicy {
|
|
/**
|
|
* Indicates that the app is a shared bundle and the shared bundle type is backward compatibility
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
BACKWARD_COMPATIBILITY = 1
|
|
}
|
|
|
|
/**
|
|
* Obtains own bundleInfo.
|
|
*
|
|
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned.
|
|
* @returns { Promise<BundleInfo> } The result of getting the bundle info.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
function getBundleInfoForSelf(bundleFlags: number): Promise<BundleInfo>;
|
|
|
|
/**
|
|
* Obtains own bundleInfo.
|
|
*
|
|
* @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.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
function getBundleInfoForSelf(bundleFlags: number, callback: AsyncCallback<BundleInfo>): void;
|
|
|
|
/**
|
|
* Obtains own bundleInfo.
|
|
*
|
|
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned.
|
|
* @returns { BundleInfo } The result of getting the bundle info.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
function getBundleInfoForSelfSync(bundleFlags: number): BundleInfo;
|
|
|
|
/**
|
|
* Obtains bundleInfo based on bundleName, bundleFlags. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @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 { 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.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
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.
|
|
*
|
|
* @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 { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @param { AsyncCallback<BundleInfo> } callback - The callback of getting bundle info result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getBundleInfo(bundleName: string,
|
|
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.
|
|
*
|
|
* @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 { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { Promise<BundleInfo> } The result of getting the bundle info.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getBundleInfo(bundleName: string, bundleFlags: number, userId?: number): Promise<BundleInfo>;
|
|
|
|
/**
|
|
* Obtains application info based on a given bundle name. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @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 { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned.
|
|
* @param { AsyncCallback<ApplicationInfo> } callback - The callback of getting application info result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getApplicationInfo(bundleName: string, appFlags: number, callback: AsyncCallback<ApplicationInfo>): void;
|
|
|
|
/**
|
|
* Obtains application info based on a given bundle name. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @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 { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @param { AsyncCallback<ApplicationInfo> } callback - The callback of getting application info result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getApplicationInfo(bundleName: string,
|
|
appFlags: number, userId: number, callback: AsyncCallback<ApplicationInfo>): void;
|
|
|
|
/**
|
|
* Obtains application info based on a given bundle name. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @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 { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { Promise<ApplicationInfo> } The result of getting the application info.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getApplicationInfo(bundleName: string, appFlags: number, userId?: number): Promise<ApplicationInfo>;
|
|
|
|
/**
|
|
* Obtains BundleInfo of all bundles available in the system.
|
|
*
|
|
* @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST
|
|
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo that will be returned.
|
|
* @param { AsyncCallback<Array<BundleInfo>> } callback - The callback of getting a list of BundleInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getAllBundleInfo(bundleFlags: number, callback: AsyncCallback<Array<BundleInfo>>): void;
|
|
|
|
/**
|
|
* Obtains BundleInfo of all bundles available in the system.
|
|
*
|
|
* @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST
|
|
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo that will be returned.
|
|
* @param { number } userId - Indicates the user id.
|
|
* @param { AsyncCallback<Array<BundleInfo>> } callback - The callback of getting a list of BundleInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getAllBundleInfo(bundleFlags: number, userId: number, callback: AsyncCallback<Array<BundleInfo>>): void;
|
|
|
|
/**
|
|
* Obtains BundleInfo of all bundles available in the system.
|
|
*
|
|
* @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST
|
|
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo that will be returned.
|
|
* @param { number } userId - Indicates the user id.
|
|
* @returns { Promise<Array<BundleInfo>> } Returns a list of BundleInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getAllBundleInfo(bundleFlags: number, userId?: number): Promise<Array<BundleInfo>>;
|
|
|
|
/**
|
|
* Obtains information about all installed applications of a specified user.
|
|
*
|
|
* @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST
|
|
* @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned.
|
|
* @param { AsyncCallback<Array<ApplicationInfo>> } callback - The callback of getting a list of ApplicationInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getAllApplicationInfo(appFlags: number, callback: AsyncCallback<Array<ApplicationInfo>>): void;
|
|
|
|
/**
|
|
* Obtains information about all installed applications of a specified user.
|
|
*
|
|
* @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST
|
|
* @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @param { AsyncCallback<Array<ApplicationInfo>> } callback - The callback of getting a list of ApplicationInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getAllApplicationInfo(appFlags: number,
|
|
userId: number, callback: AsyncCallback<Array<ApplicationInfo>>): void;
|
|
|
|
/**
|
|
* Obtains information about all installed applications of a specified user.
|
|
*
|
|
* @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST
|
|
* @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { Promise<Array<ApplicationInfo>> } Returns a list of ApplicationInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getAllApplicationInfo(appFlags: number, userId?: number): Promise<Array<ApplicationInfo>>;
|
|
|
|
/**
|
|
* Query the AbilityInfo by the given Want. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { Want } want - Indicates the Want containing the application bundle name to be queried.
|
|
* @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned.
|
|
* @param { AsyncCallback<Array<AbilityInfo>> } callback - The callback of querying ability info result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified ability is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function queryAbilityInfo(want: Want, abilityFlags: number, callback: AsyncCallback<Array<AbilityInfo>>): void;
|
|
|
|
/**
|
|
* Query the AbilityInfo by the given Want. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { Want } want - Indicates the Want containing the application bundle name to be queried.
|
|
* @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned.
|
|
* @param { number } userId - userId Indicates the user ID.
|
|
* @param { AsyncCallback<Array<AbilityInfo>> } callback - The callback of querying ability info result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified ability is not found.
|
|
* @throws { BusinessError } 17700004 - The specified userId is invalid.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function queryAbilityInfo(want: Want,
|
|
abilityFlags: number, userId: number, callback: AsyncCallback<Array<AbilityInfo>>): void;
|
|
|
|
/**
|
|
* Query the AbilityInfo by the given Want. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { Want } want - Indicates the Want containing the application bundle name to be queried.
|
|
* @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned.
|
|
* @param { number } userId - userId Indicates the user ID.
|
|
* @returns { Promise<Array<AbilityInfo>> } Returns a list of AbilityInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified ability is not found.
|
|
* @throws { BusinessError } 17700004 - The specified userId is invalid.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function queryAbilityInfo(want: Want, abilityFlags: number, userId?: number): Promise<Array<AbilityInfo>>;
|
|
|
|
/**
|
|
* Query the AbilityInfo by the given Want. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { Want } want - Indicates the Want containing the application bundle name to be queried.
|
|
* @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned.
|
|
* @param { number } userId - userId Indicates the user ID.
|
|
* @returns { Array<AbilityInfo> } Returns a list of AbilityInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified ability is not found.
|
|
* @throws { BusinessError } 17700004 - The specified userId is invalid.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function queryAbilityInfoSync(want: Want, abilityFlags: number, userId?: number): Array<AbilityInfo>;
|
|
|
|
/**
|
|
* Query extension info of by utilizing a Want. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { Want } want - Indicates the Want containing the application bundle name to be queried.
|
|
* @param { ExtensionAbilityType } extensionAbilityType - Indicates ExtensionAbilityType.
|
|
* @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the
|
|
* ExtensionAbilityInfo objects that will be returned.
|
|
* @param { AsyncCallback<Array<ExtensionAbilityInfo>> } callback - The callback of querying extension ability info result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified extensionAbility is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function queryExtensionAbilityInfo(want: Want, extensionAbilityType: ExtensionAbilityType,
|
|
extensionAbilityFlags: number, callback: AsyncCallback<Array<ExtensionAbilityInfo>>): void;
|
|
|
|
/**
|
|
* Query extension info of by utilizing a Want. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { Want } want - Indicates the Want containing the application bundle name to be queried.
|
|
* @param { ExtensionAbilityType } extensionAbilityType - Indicates ExtensionAbilityType.
|
|
* @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the
|
|
* ExtensionAbilityInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID.
|
|
* @param { AsyncCallback<Array<ExtensionAbilityInfo>> } callback - The callback of querying extension ability info result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified extensionAbility is not found.
|
|
* @throws { BusinessError } 17700004 - The specified userId is invalid.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function queryExtensionAbilityInfo(want: Want, extensionAbilityType: ExtensionAbilityType,
|
|
extensionAbilityFlags: number, userId: number, callback: AsyncCallback<Array<ExtensionAbilityInfo>>): void;
|
|
|
|
/**
|
|
* Query the ExtensionAbilityInfo by the given Want. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { Want } want - Indicates the Want containing the application bundle name to be queried.
|
|
* @param { ExtensionAbilityType } extensionAbilityType - Indicates ExtensionAbilityType.
|
|
* @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the
|
|
* ExtensionAbilityInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID.
|
|
* @returns { Promise<Array<ExtensionAbilityInfo>> } Returns a list of ExtensionAbilityInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified extensionAbility is not found.
|
|
* @throws { BusinessError } 17700004 - The specified userId is invalid.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function queryExtensionAbilityInfo(want: Want, extensionAbilityType: ExtensionAbilityType,
|
|
extensionAbilityFlags: number, userId?: number): Promise<Array<ExtensionAbilityInfo>>;
|
|
|
|
/**
|
|
* Query the ExtensionAbilityInfo by the given Want. ohos.permission.GET_BUNDLE_INFO_PRIVILEGED is required for cross user access.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { Want } want - Indicates the Want containing the application bundle name to be queried.
|
|
* @param { ExtensionAbilityType } extensionAbilityType - Indicates ExtensionAbilityType.
|
|
* @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the
|
|
* ExtensionAbilityInfo objects that will be returned.
|
|
* @param { number } userId - Indicates the user ID.
|
|
* @returns { Array<ExtensionAbilityInfo> } Returns a list of ExtensionAbilityInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified extensionAbility is not found.
|
|
* @throws { BusinessError } 17700004 - The specified userId is invalid.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function queryExtensionAbilityInfoSync(want: Want, extensionAbilityType: ExtensionAbilityType,
|
|
extensionAbilityFlags: number, userId?: number): Array<ExtensionAbilityInfo>;
|
|
|
|
/**
|
|
* Obtains bundle name by the given uid.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { number } uid - Indicates the UID of an application.
|
|
* @param { AsyncCallback<string> } callback - The callback of getting bundle name.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700021 - The uid is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getBundleNameByUid(uid: number, callback: AsyncCallback<string>): void;
|
|
|
|
/**
|
|
* Obtains bundle name by the given uid.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { number } uid - Indicates the UID of an application.
|
|
* @returns { Promise<string> } Returns the bundle name.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700021 - The uid is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getBundleNameByUid(uid: number): Promise<string>;
|
|
|
|
/**
|
|
* Obtains bundle name by the given uid.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { number } uid - Indicates the UID of an application.
|
|
* @returns { string } Returns the bundle name.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700021 - The uid is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getBundleNameByUidSync(uid: number): string;
|
|
|
|
/**
|
|
* Obtains information about an application bundle contained in an ohos Ability Package (HAP).
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } hapFilePath - Indicates the path storing the HAP.
|
|
* The path should be the relative path to the data directory of the current application.
|
|
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object to be returned.
|
|
* @param { AsyncCallback<BundleInfo> } callback - The callback of getting bundle archive info result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700022 - The hapFilePath is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback<BundleInfo>): void;
|
|
|
|
/**
|
|
* Obtains information about an application bundle contained in an ohos Ability Package (HAP).
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } hapFilePath - Indicates the path storing the HAP.
|
|
* The path should be the relative path to the data directory of the current application.
|
|
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object to be returned.
|
|
* @returns { Promise<BundleInfo> } Returns the BundleInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700022 - The hapFilePath is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getBundleArchiveInfo(hapFilePath: string, bundleFlags: number): Promise<BundleInfo>;
|
|
|
|
/**
|
|
* Obtains information about an application bundle contained in an ohos Ability Package (HAP).
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } hapFilePath - Indicates the path storing the HAP.
|
|
* The path should be the relative path to the data directory of the current application.
|
|
* @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object to be returned.
|
|
* @returns { BundleInfo } Returns the BundleInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700022 - The hapFilePath is invalid.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getBundleArchiveInfoSync(hapFilePath: string, bundleFlags: number): BundleInfo;
|
|
|
|
/**
|
|
* Clears cache data of a specified application.
|
|
*
|
|
* @permission ohos.permission.REMOVE_CACHE_FILES
|
|
* @param { string } bundleName - Indicates the bundle name of the application whose cache data is to be cleaned.
|
|
* @param { AsyncCallback<void> } callback - The callback of cleaning bundle cache files result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700030 - The specified bundle does not support clearing of cache files.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Clears cache data of a specified application.
|
|
*
|
|
* @permission ohos.permission.REMOVE_CACHE_FILES
|
|
* @param { string } bundleName - Indicates the bundle name of the application whose cache data is to be cleaned.
|
|
* @returns { Promise<void> } Clean bundle cache files result
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700030 - The specified bundle does not support clearing of cache files.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function cleanBundleCacheFiles(bundleName: string): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether to enable a specified application.
|
|
*
|
|
* @permission ohos.permission.CHANGE_ABILITY_ENABLED_STATE
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @param { boolean } isEnabled - The value true means to enable it, and the value false means to disable it.
|
|
* @param { AsyncCallback<void> } callback - The callback of setting app enabled result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function setApplicationEnabled(bundleName: string, isEnabled: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets whether to enable a specified application.
|
|
*
|
|
* @permission ohos.permission.CHANGE_ABILITY_ENABLED_STATE
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @param { boolean } isEnabled - The value true means to enable it, and the value false means to disable it.
|
|
* @returns { Promise<void> } set app enabled result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function setApplicationEnabled(bundleName: string, isEnabled: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether to enable a specified application.
|
|
*
|
|
* @permission ohos.permission.CHANGE_ABILITY_ENABLED_STATE
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @param { boolean } isEnabled - The value true means to enable it, and the value false means to disable it.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function setApplicationEnabledSync(bundleName: string, isEnabled: boolean): void;
|
|
|
|
/**
|
|
* Sets whether to enable a specified ability.
|
|
*
|
|
* @permission ohos.permission.CHANGE_ABILITY_ENABLED_STATE
|
|
* @param { AbilityInfo } info - Indicates information about the ability to set.
|
|
* @param { boolean } isEnabled - The value true means to enable it, and the value false means to disable it.
|
|
* @param { AsyncCallback<void> } callback - The callback of setting ability enabled result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityInfo is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function setAbilityEnabled(info: AbilityInfo, isEnabled: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets whether to enable a specified ability.
|
|
*
|
|
* @permission ohos.permission.CHANGE_ABILITY_ENABLED_STATE
|
|
* @param { AbilityInfo } info - Indicates information about the ability to set.
|
|
* @param { boolean } isEnabled - The value true means to enable it, and the value false means to disable it.
|
|
* @returns { Promise<void> } set ability enabled result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityInfo is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function setAbilityEnabled(info: AbilityInfo, isEnabled: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether to enable a specified ability.
|
|
*
|
|
* @permission ohos.permission.CHANGE_ABILITY_ENABLED_STATE
|
|
* @param { AbilityInfo } info - Indicates information about the ability to set.
|
|
* @param { boolean } isEnabled - The value true means to enable it, and the value false means to disable it.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityInfo is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function setAbilityEnabledSync(info: AbilityInfo, isEnabled: boolean): void;
|
|
|
|
/**
|
|
* Checks whether a specified application is enabled.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @param { AsyncCallback<boolean> } callback - The callback of checking application enabled result. The result is true if enabled, false otherwise.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function isApplicationEnabled(bundleName: string, callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Checks whether a specified application is enabled.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @returns { Promise<boolean> } Returns true if the application is enabled; returns false otherwise.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function isApplicationEnabled(bundleName: string): Promise<boolean>;
|
|
|
|
/**
|
|
* Checks whether a specified application is enabled.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @returns { boolean } Returns true if the application is enabled; returns false otherwise.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function isApplicationEnabledSync(bundleName: string): boolean;
|
|
|
|
/**
|
|
* Checks whether a specified ability is enabled.
|
|
*
|
|
* @param { AbilityInfo } info - Indicates information about the ability to check.
|
|
* @param { AsyncCallback<boolean> } callback - The callback of checking ability enabled result. The result is true if enabled, false otherwise.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function isAbilityEnabled(info: AbilityInfo, callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Checks whether a specified ability is enabled.
|
|
*
|
|
* @param { AbilityInfo } info - Indicates information about the ability to check.
|
|
* @returns { Promise<boolean> } Returns true if the ability is enabled; returns false otherwise.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function isAbilityEnabled(info: AbilityInfo): Promise<boolean>;
|
|
|
|
/**
|
|
* Checks whether a specified ability is enabled.
|
|
*
|
|
* @param { AbilityInfo } info - Indicates information about the ability to check.
|
|
* @returns { boolean } Returns true if the ability is enabled; returns false otherwise.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function isAbilityEnabledSync(info: AbilityInfo): boolean;
|
|
|
|
/**
|
|
* Obtains the Want for starting the main ability of an application based on the
|
|
* given bundle name. The main ability of an application is the ability that has the
|
|
* #ACTION_HOME and #ENTITY_HOME Want filters set in the application's <b>config.json</b> or <b>module.json</b> file.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @param { AsyncCallback<Want> } callback - The callback for starting the application's main ability.
|
|
* @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.GET_BUNDLE_INFO_PRIVILEGED'.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getLaunchWantForBundle(bundleName: string, userId: number, callback: AsyncCallback<Want>): void;
|
|
|
|
/**
|
|
* Obtains the Want for starting the main ability of an application based on the
|
|
* given bundle name. The main ability of an application is the ability that has the
|
|
* #ACTION_HOME and #ENTITY_HOME Want filters set in the application's <b>config.json</b> or <b>module.json</b> file.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @param { AsyncCallback<Want> } callback - The callback for starting the application's main ability.
|
|
* @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.GET_BUNDLE_INFO_PRIVILEGED'.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getLaunchWantForBundle(bundleName: string, callback: AsyncCallback<Want>): void;
|
|
|
|
/**
|
|
* Obtains the Want for starting the main ability of an application based on the
|
|
* given bundle name. The main ability of an application is the ability that has the
|
|
* #ACTION_HOME and #ENTITY_HOME Want filters set in the application's <b>config.json</b> or <b>module.json</b> file.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { Promise<Want> } the Want for starting the application's main ability.
|
|
* @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.GET_BUNDLE_INFO_PRIVILEGED'.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getLaunchWantForBundle(bundleName: string, userId?: number): Promise<Want>;
|
|
|
|
/**
|
|
* Obtains the Want for starting the main ability of an application based on the
|
|
* given bundle name. The main ability of an application is the ability that has the
|
|
* #ACTION_HOME and #ENTITY_HOME Want filters set in the application's <b>config.json</b> or <b>module.json</b> file.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundle name of the application.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { Want } the Want for starting the application's main ability.
|
|
* @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.GET_BUNDLE_INFO_PRIVILEGED'.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getLaunchWantForBundleSync(bundleName: string, userId?: number): Want;
|
|
|
|
/**
|
|
* Obtains the profile designated by metadata name, abilityName and moduleName from the current application.
|
|
*
|
|
* @param { string } moduleName - Indicates the moduleName of the application.
|
|
* @param { string } abilityName - Indicates the abilityName of the application.
|
|
* @param { string } metadataName - Indicates the name of metadata in ability.
|
|
* @param { AsyncCallback<Array<string>> } callback - The callback of returning string in json-format of the corresponding config file.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not existed.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not existed.
|
|
* @throws { BusinessError } 17700024 - Failed to get the profile because there is no profile in the HAP.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
function getProfileByAbility(moduleName: string, abilityName: string, metadataName: string, callback: AsyncCallback<Array<string>>): void;
|
|
|
|
/**
|
|
* Obtains the profile designated by metadata name, abilityName and moduleName from the current application.
|
|
*
|
|
* @param { string } moduleName - Indicates the moduleName of the application.
|
|
* @param { string } abilityName - Indicates the abilityName of the application.
|
|
* @param { string } metadataName - Indicates the name of metadata in ability.
|
|
* @returns { Promise<Array<string>> } Returns string in json-format of the corresponding config file.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not existed.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not existed.
|
|
* @throws { BusinessError } 17700024 - Failed to get the profile because there is no profile in the HAP.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
function getProfileByAbility(moduleName: string, abilityName: string, metadataName?: string): Promise<Array<string>>;
|
|
|
|
/**
|
|
* Obtains the profile designated by metadata name, abilityName and moduleName from the current application.
|
|
*
|
|
* @param { string } moduleName - Indicates the moduleName of the application.
|
|
* @param { string } abilityName - Indicates the abilityName of the application.
|
|
* @param { string } metadataName - Indicates the name of metadata in ability.
|
|
* @returns { Array<string> } Returns string in json-format of the corresponding config file.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not existed.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not existed.
|
|
* @throws { BusinessError } 17700024 - Failed to get the profile because there is no profile in the HAP.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
function getProfileByAbilitySync(moduleName: string, abilityName: string, metadataName?: string): Array<string>;
|
|
|
|
/**
|
|
* Obtains the profile designated by metadata name, extensionAbilityName and moduleName from the current application.
|
|
*
|
|
* @param { string } moduleName - Indicates the moduleName of the application.
|
|
* @param { string } extensionAbilityName - Indicates the extensionAbilityName of the application.
|
|
* @param { string } metadataName - Indicates the name of metadata in ability.
|
|
* @param { AsyncCallback<Array<string>> } callback - The callback of returning string in json-format of the corresponding config file.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not existed.
|
|
* @throws { BusinessError } 17700003 - The specified extensionAbilityName not existed.
|
|
* @throws { BusinessError } 17700024 - Failed to get the profile because there is no profile in the HAP.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
function getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, metadataName: string, callback: AsyncCallback<Array<string>>): void;
|
|
|
|
/**
|
|
* Obtains the profile designated by metadata name, extensionAbilityName and moduleName from the current application.
|
|
*
|
|
* @param { string } moduleName - Indicates the moduleName of the application.
|
|
* @param { string } extensionAbilityName - Indicates the extensionAbilityName of the application.
|
|
* @param { string } metadataName - Indicates the name of metadata in ability.
|
|
* @returns { Promise<Array<string>> } Returns string in json-format of the corresponding config file.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not existed.
|
|
* @throws { BusinessError } 17700003 - The specified extensionAbilityName not existed.
|
|
* @throws { BusinessError } 17700024 - Failed to get the profile because there is no profile in the HAP.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
function getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, metadataName?: string): Promise<Array<string>>;
|
|
|
|
/**
|
|
* Obtains the profile designated by metadata name, extensionAbilityName and moduleName from the current application.
|
|
*
|
|
* @param { string } moduleName - Indicates the moduleName of the application.
|
|
* @param { string } extensionAbilityName - Indicates the extensionAbilityName of the application.
|
|
* @param { string } metadataName - Indicates the name of metadata in ability.
|
|
* @returns { Array<string> } Returns string in json-format of the corresponding config file.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not existed.
|
|
* @throws { BusinessError } 17700003 - The specified extensionAbilityName not existed.
|
|
* @throws { BusinessError } 17700024 - Failed to get the profile because there is no profile in the HAP.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 10
|
|
*/
|
|
function getProfileByExtensionAbilitySync(moduleName: string, extensionAbilityName: string, metadataName?: string): Array<string>;
|
|
|
|
/**
|
|
* Get the permission details by permission name.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } permissionName - Indicates permission name.
|
|
* @param { AsyncCallback<PermissionDef> } callback - The callback of get permissionDef object result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700006 - The specified permission is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getPermissionDef(permissionName: string, callback: AsyncCallback<PermissionDef>): void;
|
|
|
|
/**
|
|
* Get the permission details by permission name.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } permissionName - Indicates permission name.
|
|
* @returns { Promise<PermissionDef> } Returns permissionDef object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700006 - The specified permission is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getPermissionDef(permissionName: string): Promise<PermissionDef>;
|
|
|
|
/**
|
|
* Get the permission details by permission name.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } permissionName - Indicates permission name.
|
|
* @returns { PermissionDef } Returns permissionDef object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700006 - The specified permission is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getPermissionDefSync(permissionName: string): PermissionDef;
|
|
|
|
/**
|
|
* Obtains the label of a specified ability.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the ability belongs.
|
|
* @param { string } moduleName - Indicates the module name.
|
|
* @param { string } abilityName - Indicates the ability name.
|
|
* @param { AsyncCallback<string> } callback - The callback of getting ability label result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getAbilityLabel(bundleName: string, moduleName: string, abilityName: string, callback: AsyncCallback<string>): void;
|
|
|
|
/**
|
|
* Obtains the label of a specified ability.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the ability belongs.
|
|
* @param { string } moduleName - Indicates the module name.
|
|
* @param { string } abilityName - Indicates the ability name.
|
|
* @returns { Promise<string> } Returns the label representing the label of the specified ability.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getAbilityLabel(bundleName: string, moduleName: string, abilityName: string): Promise<string>;
|
|
|
|
/**
|
|
* Obtains the label of a specified ability.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the ability belongs.
|
|
* @param { string } moduleName - Indicates the module name.
|
|
* @param { string } abilityName - Indicates the ability name.
|
|
* @returns { string } Returns the label representing the label of the specified ability.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not found.
|
|
* @throws { BusinessError } 17700003 - The specified abilityName is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @throws { BusinessError } 17700029 - The specified ability is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Resource
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getAbilityLabelSync(bundleName: string, moduleName: string, abilityName: string): string;
|
|
|
|
/**
|
|
* Obtains applicationInfo based on a given bundleName and bundleFlags.
|
|
*
|
|
* @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 { number } applicationFlags - Indicates the flag used to specify information contained in the ApplicationInfo object that will be returned.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { ApplicationInfo } - Returns the ApplicationInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getApplicationInfoSync(bundleName: string, applicationFlags: number, userId: number): ApplicationInfo;
|
|
|
|
/**
|
|
* Obtains applicationInfo based on a given bundleName and bundleFlags.
|
|
*
|
|
* @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 { number } applicationFlags - Indicates the flag used to specify information contained in the ApplicationInfo object that will be returned.
|
|
* @returns { ApplicationInfo } - Returns the ApplicationInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getApplicationInfoSync(bundleName: string, applicationFlags: number): ApplicationInfo;
|
|
|
|
/**
|
|
* Obtains bundleInfo based on bundleName, bundleFlags and userId.
|
|
*
|
|
* @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 { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object that will be returned.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { BundleInfo } - Returns the BundleInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getBundleInfoSync(bundleName: string, bundleFlags: number, userId: number): BundleInfo;
|
|
|
|
/**
|
|
* Obtains bundleInfo based on bundleName, bundleFlags.
|
|
*
|
|
* @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 { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object that will be returned.
|
|
* @returns { BundleInfo } - Returns the BundleInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getBundleInfoSync(bundleName: string, bundleFlags: number): BundleInfo;
|
|
|
|
/**
|
|
* Obtains SharedBundleInfo of all shared bundle available in the system.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { AsyncCallback<Array<SharedBundleInfo>> } callback - The callback of getting a list of SharedBundleInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getAllSharedBundleInfo(callback: AsyncCallback<Array<SharedBundleInfo>>): void;
|
|
|
|
/**
|
|
* Obtains SharedBundleInfo of all shared bundle available in the system.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @returns { Promise<Array<SharedBundleInfo>> } Returns a list of SharedBundleInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getAllSharedBundleInfo(): Promise<Array<SharedBundleInfo>>;
|
|
|
|
/**
|
|
* Obtains SharedBundleInfo of shared bundle by bundle name and module name.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundleName of the application.
|
|
* @param { string } moduleName - Indicates the moduleName of the application.
|
|
* @param { AsyncCallback<Array<SharedBundleInfo>> } callback - The callback of getting a list of SharedBundleInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getSharedBundleInfo(bundleName: string, moduleName: string, callback: AsyncCallback<Array<SharedBundleInfo>>): void;
|
|
|
|
/**
|
|
* Obtains SharedBundleInfo of shared bundle by bundle name and module name.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundleName of the application.
|
|
* @param { string } moduleName - Indicates the moduleName of the application.
|
|
* @returns { Promise<Array<SharedBundleInfo>> } Returns a list of SharedBundleInfo objects.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700002 - The specified moduleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getSharedBundleInfo(bundleName: string, moduleName: string): Promise<Array<SharedBundleInfo>>;
|
|
|
|
/**
|
|
* Obtains the profile file information of a specified bundle.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the ability belongs.
|
|
* @param { AsyncCallback<AppProvisionInfo> } callback - Indicates the callback of getting AppProvisionInfo result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getAppProvisionInfo(bundleName: string, callback: AsyncCallback<AppProvisionInfo>): void;
|
|
|
|
/**
|
|
* Obtains the profile file information of a specified bundle.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the ability belongs.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @param { AsyncCallback<AppProvisionInfo> } callback - Indicates the callback of getting AppProvisionInfo result.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getAppProvisionInfo(bundleName: string, userId: number, callback: AsyncCallback<AppProvisionInfo>): void;
|
|
|
|
/**
|
|
* Obtains the profile file information of a specified bundle.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the ability belongs.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { Promise<AppProvisionInfo> } Returns the AppProvisionInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getAppProvisionInfo(bundleName: string, userId?: number): Promise<AppProvisionInfo>;
|
|
|
|
/**
|
|
* Obtains the profile file information of a specified bundle.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the ability belongs.
|
|
* @param { number } userId - Indicates the user ID or do not pass user ID.
|
|
* @returns { AppProvisionInfo } Returns the AppProvisionInfo object.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - The parameter check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @throws { BusinessError } 17700004 - The specified user ID is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getAppProvisionInfoSync(bundleName: string, userId?: number): AppProvisionInfo;
|
|
|
|
/**
|
|
* Obtains the distribution type specified during bundle installation.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the application bundle name to be queried.
|
|
* @returns { string } The specified distribution type.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getSpecifiedDistributionType(bundleName: string): string;
|
|
|
|
/**
|
|
* Obtains the additional information during bundle installation.
|
|
*
|
|
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param { string } bundleName - Indicates the application bundle name to be queried.
|
|
* @returns { string } The additional information.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Input parameters check failed.
|
|
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getAdditionalInfo(bundleName: string): string;
|
|
|
|
/**
|
|
* Obtains configuration information about an application.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type ApplicationInfo = _ApplicationInfo;
|
|
|
|
/**
|
|
* Indicates the Metadata.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type Metadata = _Metadata;
|
|
|
|
/**
|
|
* Obtains configuration information about a bundle.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type BundleInfo = _BundleInfo.BundleInfo;
|
|
|
|
/**
|
|
* The scene which is used.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type UsedScene = _BundleInfo.UsedScene;
|
|
|
|
/**
|
|
* Indicates the required permissions details defined in file config.json.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type ReqPermissionDetail = _BundleInfo.ReqPermissionDetail;
|
|
|
|
/**
|
|
* Indicates the SignatureInfo.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type SignatureInfo = _BundleInfo.SignatureInfo;
|
|
|
|
/**
|
|
* Obtains configuration information about a module.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type HapModuleInfo = _HapModuleInfo.HapModuleInfo;
|
|
|
|
/**
|
|
* Obtains preload information about a module.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type PreloadItem = _HapModuleInfo.PreloadItem;
|
|
|
|
/**
|
|
* Obtains dependency information about a module.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type Dependency = _HapModuleInfo.Dependency;
|
|
|
|
/**
|
|
* Obtains configuration information about an ability.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type AbilityInfo = _AbilityInfo.AbilityInfo;
|
|
|
|
/**
|
|
* Contains basic Ability information. Indicates the window size..
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type WindowSize = _AbilityInfo.WindowSize;
|
|
|
|
/**
|
|
* Obtains extension information about a bundle.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type ExtensionAbilityInfo = _ExtensionAbilityInfo.ExtensionAbilityInfo;
|
|
|
|
/**
|
|
* Indicates the defined permission details in file config.json.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
export type PermissionDef = _PermissionDef;
|
|
|
|
/**
|
|
* Contains basic Ability information, which uniquely identifies an ability.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @since 9
|
|
*/
|
|
export type ElementName = _ElementName;
|
|
|
|
/**
|
|
* Contains shared bundle info.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
export type SharedBundleInfo = _SharedBundleInfo;
|
|
|
|
/**
|
|
* Obtains profile file information about a bundle.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
export type AppProvisionInfo = _AppProvisionInfo.AppProvisionInfo;
|
|
|
|
/**
|
|
* Obtains profile file validity about a bundle.
|
|
*
|
|
* @syscap SystemCapability.BundleManager.BundleFramework.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
export type Validity = _AppProvisionInfo.Validity;
|
|
}
|
|
|
|
export default bundleManager;
|