From 11e60226ed14bed9ca90801f22af789d91ad36dd Mon Sep 17 00:00:00 2001 From: lanhaoyu Date: Wed, 25 Jun 2025 10:59:05 +0800 Subject: [PATCH] fix commentary by design Signed-off-by: lanhaoyu --- api/@ohos.bundle.bundleManager.d.ts | 646 +++++++++++++++++--- api/@ohos.bundle.installer.d.ts | 1 - api/@ohos.bundle.launcherBundleManager.d.ts | 27 +- api/@ohos.bundle.shortcutManager.d.ts | 36 +- api/bundleManager/AbilityInfo.d.ts | 185 +++++- api/bundleManager/ApplicationInfo.d.ts | 238 +++++++- api/bundleManager/BundleInfo.d.ts | 267 +++++++- api/bundleManager/HapModuleInfo.d.ts | 52 +- api/bundleManager/ShortcutInfo.d.ts | 180 +++++- 9 files changed, 1466 insertions(+), 166 deletions(-) diff --git a/api/@ohos.bundle.bundleManager.d.ts b/api/@ohos.bundle.bundleManager.d.ts index d0af29e65a..1a47789d60 100644 --- a/api/@ohos.bundle.bundleManager.d.ts +++ b/api/@ohos.bundle.bundleManager.d.ts @@ -83,11 +83,22 @@ declare namespace bundleManager { */ /** * Used to query the enumeration value of bundleInfo. Multiple values can be passed in the form. + * Multiple value input, such as GET_BUNDLE_INFO_DEFAULT | GET_BUNDLE_INFO_WITH_APPLICATION. * * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Used to query the enumeration value of bundleInfo. Multiple values can be passed in the form. + * Multiple value input, such as GET_BUNDLE_INFO_DEFAULT | GET_BUNDLE_INFO_WITH_APPLICATION. + * + * @enum { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ enum BundleFlag { @@ -104,7 +115,16 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * 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 + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_DEFAULT = 0x00000000, @@ -121,7 +141,16 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * 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 + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_APPLICATION = 0x00000001, @@ -138,33 +167,56 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * 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 + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ 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. + * It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE, + * such as GET_BUNDLE_INFO_WITH_ABILITY | GET_BUNDLE_INFO_WITH_HAP_MODULE. * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ + /** + * 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, + * such as GET_BUNDLE_INFO_WITH_ABILITY | GET_BUNDLE_INFO_WITH_HAP_MODULE. + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 11 + */ /** * 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. + * such as GET_BUNDLE_INFO_WITH_ABILITY | GET_BUNDLE_INFO_WITH_HAP_MODULE. * * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 20 * @arkts 1.1&1.2 */ 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. + * It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE, + * such as GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY | GET_BUNDLE_INFO_WITH_HAP_MODULE. * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 @@ -172,7 +224,8 @@ declare namespace bundleManager { /** * 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. + * It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE, + * such as GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY | GET_BUNDLE_INFO_WITH_HAP_MODULE. * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice @@ -193,26 +246,51 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * 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 + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ 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. + * GET_BUNDLE_INFO_WITH_HAP_MODULE, GET_BUNDLE_INFO_WITH_ABILITY, GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY. * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ + /** + * Used to obtain the metadata contained in applicationInfo, moduleInfo, abilityInfo and extensionAbility. + * 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_ABILITY, GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY, + * such as GET_BUNDLE_INFO_WITH_APPLICATION | GET_BUNDLE_INFO_WITH_METADATA + * or GET_BUNDLE_INFO_WITH_HAP_MODULE | GET_BUNDLE_INFO_WITH_ABILITY | GET_BUNDLE_INFO_WITH_METADATA + * or GET_BUNDLE_INFO_WITH_HAP_MODULE | GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY | GET_BUNDLE_INFO_WITH_METADATA. + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 11 + */ /** * 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. + * GET_BUNDLE_INFO_WITH_HAP_MODULE, GET_BUNDLE_INFO_WITH_ABILITY, GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY, + * such as GET_BUNDLE_INFO_WITH_APPLICATION | GET_BUNDLE_INFO_WITH_METADATA + * or GET_BUNDLE_INFO_WITH_HAP_MODULE | GET_BUNDLE_INFO_WITH_ABILITY | GET_BUNDLE_INFO_WITH_METADATA + * or GET_BUNDLE_INFO_WITH_HAP_MODULE | GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY | GET_BUNDLE_INFO_WITH_METADATA. * * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 20 * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_METADATA = 0x00000020, @@ -231,7 +309,17 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * 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 + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_DISABLE = 0x00000040, @@ -248,14 +336,24 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * 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 + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_SIGNATURE_INFO = 0x00000080, /** * Used to obtain the bundleInfo containing menu configuration in hapModuleInfo. * The obtained bundleInfo does not contain the information of applicationInfo, extensionAbility, ability and permission. - * It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE. + * It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE, + * such as GET_BUNDLE_INFO_WITH_MENU | GET_BUNDLE_INFO_WITH_HAP_MODULE * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice @@ -266,7 +364,8 @@ declare namespace bundleManager { /** * Used to obtain the bundleInfo containing router map configuration in hapModuleInfo. * The obtained bundleInfo does not contain the information of applicationInfo, extensionAbility, ability and permission. - * It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE. + * It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE, + * such as GET_BUNDLE_INFO_WITH_ROUTER_MAP | GET_BUNDLE_INFO_WITH_HAP_MODULE * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice @@ -277,7 +376,9 @@ declare namespace bundleManager { /** * Used to obtain the skillInfo contained in abilityInfo and extensionInfo. * It can't be used alone, it needs to be used with GET_BUNDLE_INFO_WITH_HAP_MODULE, - * GET_BUNDLE_INFO_WITH_ABILITIES, GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY. + * GET_BUNDLE_INFO_WITH_ABILITY, GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY, + * such as GET_BUNDLE_INFO_WITH_SKILL | GET_BUNDLE_INFO_WITH_HAP_MODULE | GET_BUNDLE_INFO_WITH_ABILITY + * or GET_BUNDLE_INFO_WITH_SKILL | GET_BUNDLE_INFO_WITH_HAP_MODULE | GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice @@ -296,7 +397,9 @@ declare namespace bundleManager { */ GET_BUNDLE_INFO_ONLY_WITH_LAUNCHER_ABILITY = 0x00001000, /** - * Used to obtain the bundleInfo only if any user installed + * Used to obtain the bundle information of an application installed by any user. + * It must be used together with GET_BUNDLE_INFO_WITH_APPLICATION. + * It is valid only in the {@link getBundleInfo} and {@link getAllBundleInfo} APIs. * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi @@ -371,7 +474,15 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Used to query the enumeration value of abilityInfo. Multiple values can be passed in the form. + * + * @enum { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ enum AbilityFlag { @@ -381,7 +492,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * 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 + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_ABILITY_INFO_DEFAULT = 0x00000000, @@ -390,7 +509,14 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Used to obtain the abilityInfo containing permission. + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_PERMISSION = 0x00000001, @@ -399,7 +525,14 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Used to obtain the abilityInfo containing applicationInfo. + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_APPLICATION = 0x00000002, @@ -408,7 +541,14 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Used to obtain the abilityInfo containing metadata. + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_METADATA = 0x00000004, @@ -417,7 +557,14 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Used to obtain the abilityInfo containing disabled abilityInfo. + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_DISABLE = 0x00000008, @@ -433,7 +580,14 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Used to obtain the abilityInfo only for system app. + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_ABILITY_INFO_ONLY_SYSTEM_APP = 0x00000010, @@ -442,7 +596,14 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Used to obtain the abilityInfo with domain verification. + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_APP_LINKING = 0x00000040, @@ -451,7 +612,14 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Used to obtain the abilityInfo with Skill + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_SKILL = 0x00000080, @@ -536,8 +704,7 @@ declare namespace bundleManager { * Indicates extension info with type of form * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since arkts {'1.1':'9', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 9 */ /** * Indicates extension info with type of form @@ -769,7 +936,7 @@ declare namespace bundleManager { * Indicates extension info with type of distributed * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since arkts {'1.1':'18', '1.2':'20'} + * @since 20 * @arkts 1.1&1.2 */ DISTRIBUTED = 28, @@ -797,7 +964,16 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * PermissionGrantState + * + * @enum { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export enum PermissionGrantState { @@ -812,7 +988,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * PERMISSION_DENIED + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ PERMISSION_DENIED = -1, @@ -828,7 +1012,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * PERMISSION_GRANTED + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ PERMISSION_GRANTED = 0 @@ -847,7 +1039,16 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Support window mode + * + * @enum { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export enum SupportWindowMode { @@ -862,7 +1063,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates supported window mode of full screen mode + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ FULL_SCREEN = 0, @@ -877,7 +1086,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates supported window mode of split mode + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ SPLIT = 1, @@ -892,7 +1109,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates supported window mode of floating mode + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ FLOATING = 2 @@ -983,7 +1208,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates that the ability can have specified instances + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ SPECIFIED = 2 @@ -1039,7 +1272,16 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Display orientation + * + * @enum { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export enum DisplayOrientation { @@ -1054,7 +1296,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates that the system automatically determines the display orientation + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ UNSPECIFIED, @@ -1070,7 +1320,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the landscape orientation + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ LANDSCAPE, @@ -1086,7 +1344,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the portrait orientation + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ PORTRAIT, @@ -1102,7 +1368,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the page ability orientation is the same as that of the nearest ability in the stack + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ FOLLOW_RECENT, @@ -1118,7 +1392,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the inverted landscape orientation + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ LANDSCAPE_INVERTED, @@ -1134,7 +1416,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the inverted portrait orientation + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ PORTRAIT_INVERTED, @@ -1150,7 +1440,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the orientation can be auto-rotated + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ AUTO_ROTATION, @@ -1166,7 +1464,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the landscape orientation rotated with sensor + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ AUTO_ROTATION_LANDSCAPE, @@ -1182,7 +1488,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the portrait orientation rotated with sensor + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ AUTO_ROTATION_PORTRAIT, @@ -1198,7 +1512,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the sensor restricted mode + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ AUTO_ROTATION_RESTRICTED, @@ -1214,7 +1536,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the sensor landscape restricted mode + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ AUTO_ROTATION_LANDSCAPE_RESTRICTED, @@ -1230,7 +1560,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the sensor portrait restricted mode + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ AUTO_ROTATION_PORTRAIT_RESTRICTED, @@ -1246,7 +1584,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the locked orientation mode + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ LOCKED, @@ -1285,7 +1631,16 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates module type + * + * @enum { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export enum ModuleType { @@ -1300,7 +1655,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates entry type + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ ENTRY = 1, @@ -1315,7 +1678,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates feature type + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ FEATURE = 2, @@ -1330,7 +1701,15 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates shared type + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ SHARED = 3 @@ -1621,7 +2000,18 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Obtains own bundleInfo. + * + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @returns { Promise } The result of getting the bundle info. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ function getBundleInfoForSelf(bundleFlags: number): Promise; @@ -1643,7 +2033,18 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Obtains own bundleInfo. + * + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { AsyncCallback } callback - The callback of getting bundle info result. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ function getBundleInfoForSelf(bundleFlags: number, callback: AsyncCallback): void; @@ -1665,7 +2066,18 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Obtains own bundleInfo. + * + * @param { number } bundleFlags {@link BundleFlag} - 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 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ function getBundleInfoForSelfSync(bundleFlags: number): BundleInfo; @@ -3728,7 +4140,7 @@ declare namespace bundleManager { /** * Migrate files from the source paths to the destination path. - * + * * @permission ohos.permission.MIGRATE_DATA * @param { Array } sourcePaths - Indicates the source paths to be migrated. * @param { string } destinationPath - Target path for data migration. @@ -3761,7 +4173,16 @@ declare namespace bundleManager { * @typedef { _ApplicationInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Obtains configuration information about an application. + * + * @typedef { _ApplicationInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export type ApplicationInfo = _ApplicationInfo; @@ -3779,7 +4200,16 @@ declare namespace bundleManager { * @typedef { _ModuleMetadata } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the metadata information about a module. + * + * @typedef { _ModuleMetadata } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export type ModuleMetadata = _ModuleMetadata; @@ -3797,7 +4227,16 @@ declare namespace bundleManager { * @typedef { _Metadata } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the Metadata. + * + * @typedef { _Metadata } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export type Metadata = _Metadata; @@ -3817,6 +4256,15 @@ declare namespace bundleManager { * @atomicservice * @since 11 */ + /** + * Obtains configuration information about a bundle. + * + * @typedef { _BundleInfo.BundleInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 + */ export type BundleInfo = _BundleInfo.BundleInfo; /** @@ -3824,7 +4272,7 @@ declare namespace bundleManager { * * @typedef { _BundleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @atomicservice + * @crossplatform * @since 20 * @arkts 1.2 */ @@ -3845,6 +4293,15 @@ declare namespace bundleManager { * @atomicservice * @since 11 */ + /** + * The scene which is used. + * + * @typedef { _BundleInfo.UsedScene } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 + */ export type UsedScene = _BundleInfo.UsedScene; /** @@ -3852,7 +4309,7 @@ declare namespace bundleManager { * * @typedef { _UsedScene } * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @atomicservice + * @crossplatform * @since 20 * @arkts 1.2 */ @@ -3873,6 +4330,15 @@ declare namespace bundleManager { * @atomicservice * @since 11 */ + /** + * Indicates the required permissions details defined in file config.json. + * + * @typedef { _BundleInfo.ReqPermissionDetail } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 + */ export type ReqPermissionDetail = _BundleInfo.ReqPermissionDetail; /** @@ -3880,7 +4346,7 @@ declare namespace bundleManager { * * @typedef { _ReqPermissionDetail } * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @atomicservice + * @crossplatform * @since 20 * @arkts 1.2 */ @@ -3901,6 +4367,15 @@ declare namespace bundleManager { * @atomicservice * @since 11 */ + /** + * Indicates the SignatureInfo. + * + * @typedef { _BundleInfo.SignatureInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 + */ export type SignatureInfo = _BundleInfo.SignatureInfo; /** @@ -3908,7 +4383,7 @@ declare namespace bundleManager { * * @typedef { _SignatureInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @atomicservice + * @crossplatform * @since 20 * @arkts 1.2 */ @@ -3948,6 +4423,15 @@ declare namespace bundleManager { * @atomicservice * @since 11 */ + /** + * Obtains configuration information about a module. + * + * @typedef { _HapModuleInfo.HapModuleInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 + */ export type HapModuleInfo = _HapModuleInfo.HapModuleInfo; /** @@ -3955,6 +4439,7 @@ declare namespace bundleManager { * * @typedef { _HapModuleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform * @atomicservice * @since 20 * @arkts 1.2 @@ -4032,7 +4517,6 @@ declare namespace bundleManager { * * @typedef { _RouterItem} * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @atomicservice * @since 20 * @arkts 1.2 */ @@ -4074,6 +4558,15 @@ declare namespace bundleManager { * @atomicservice * @since 11 */ + /** + * Obtains configuration information about an ability. + * + * @typedef { _AbilityInfo.AbilityInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 + */ export type AbilityInfo = _AbilityInfo.AbilityInfo; /** @@ -4081,6 +4574,7 @@ declare namespace bundleManager { * * @typedef { _AbilityInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform * @atomicservice * @since 20 * @arkts 1.2 @@ -4088,27 +4582,37 @@ declare namespace bundleManager { export type AbilityInfo = _AbilityInfo; /** - * Contains basic Ability information. Indicates the window size.. + * Contains basic Ability information. Indicates the window size. * * @typedef { _AbilityInfo.WindowSize } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 9 */ /** - * Contains basic Ability information. Indicates the window size.. + * Contains basic Ability information. Indicates the window size. * * @typedef { _AbilityInfo.WindowSize } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice * @since 11 */ + /** + * Contains basic Ability information. Indicates the window size. + * + * @typedef { _AbilityInfo.WindowSize } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 + */ export type WindowSize = _AbilityInfo.WindowSize; /** - * Contains basic Ability information. Indicates the window size.. + * Contains basic Ability information. Indicates the window size. * * @typedef { _WindowSize } * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform * @atomicservice * @since 20 * @arkts 1.2 diff --git a/api/@ohos.bundle.installer.d.ts b/api/@ohos.bundle.installer.d.ts index 4a42437b13..830abc77dd 100644 --- a/api/@ohos.bundle.installer.d.ts +++ b/api/@ohos.bundle.installer.d.ts @@ -1739,7 +1739,6 @@ declare namespace installer { * @returns { Promise } * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.UNINSTALL_CLONE_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName cannot be found or the bundle is not installed by the specified user. * @throws { BusinessError } 17700004 - The userId is invalid. * @throws { BusinessError } 17700061 - AppIndex not in valid range. diff --git a/api/@ohos.bundle.launcherBundleManager.d.ts b/api/@ohos.bundle.launcherBundleManager.d.ts index fca170eee8..f248440352 100644 --- a/api/@ohos.bundle.launcherBundleManager.d.ts +++ b/api/@ohos.bundle.launcherBundleManager.d.ts @@ -236,7 +236,14 @@ declare namespace launcherBundleManager { * @typedef { _ShortcutInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Provides information about a shortcut, including the shortcut ID and label. + * + * @typedef { _ShortcutInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export type ShortcutInfo = _ShortcutInfo; @@ -246,7 +253,14 @@ declare namespace launcherBundleManager { * @typedef { _ShortcutWant } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ + /** + * Obtains information about the ability that a shortcut will start. + * + * @typedef { _ShortcutWant } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export type ShortcutWant = _ShortcutWant; @@ -256,7 +270,14 @@ declare namespace launcherBundleManager { * @typedef { _ParameterItem } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the custom parameters in shortcut want. + * + * @typedef { _ParameterItem } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export type ParameterItem = _ParameterItem; diff --git a/api/@ohos.bundle.shortcutManager.d.ts b/api/@ohos.bundle.shortcutManager.d.ts index df987404ef..ba509ddb64 100644 --- a/api/@ohos.bundle.shortcutManager.d.ts +++ b/api/@ohos.bundle.shortcutManager.d.ts @@ -26,7 +26,14 @@ import { ShortcutInfo as _ShortcutInfo, ShortcutWant as _ShortcutWant, Parameter * @namespace shortcutManager * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ +/** + * Desktop shortcut bundle manager. + * + * @namespace shortcutManager + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ declare namespace shortcutManager { @@ -93,7 +100,14 @@ declare namespace shortcutManager { * @typedef { _ShortcutInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Provides information about a shortcut, including the shortcut ID and label. + * + * @typedef { _ShortcutInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export type ShortcutInfo = _ShortcutInfo; @@ -103,7 +117,14 @@ declare namespace shortcutManager { * @typedef { _ShortcutWant } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Obtains information about the ability that a shortcut will start. + * + * @typedef { _ShortcutWant } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export type ShortcutWant = _ShortcutWant; @@ -113,7 +134,14 @@ declare namespace shortcutManager { * @typedef { _ParameterItem } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the custom parameters in shortcut want. + * + * @typedef { _ParameterItem } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export type ParameterItem = _ParameterItem; diff --git a/api/bundleManager/AbilityInfo.d.ts b/api/bundleManager/AbilityInfo.d.ts index d380d7c953..c178036ae4 100644 --- a/api/bundleManager/AbilityInfo.d.ts +++ b/api/bundleManager/AbilityInfo.d.ts @@ -80,7 +80,7 @@ export interface AbilityInfo { readonly bundleName: string; /** - * Indicates the name of the .hap package to which the capability belongs + * Indicates the module name of the package to which the capability belongs * * @type { string } * @readonly @@ -88,7 +88,7 @@ export interface AbilityInfo { * @since 9 */ /** - * Indicates the name of the .hap package to which the capability belongs + * Indicates the module name of the package to which the capability belongs * * @type { string } * @readonly @@ -97,7 +97,7 @@ export interface AbilityInfo { * @since 10 */ /** - * Indicates the name of the .hap package to which the capability belongs + * Indicates the module name of the package to which the capability belongs * * @type { string } * @readonly @@ -334,7 +334,17 @@ export interface AbilityInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Process of ability, if user do not set it, the value equal application process + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly process: string; @@ -354,7 +364,17 @@ export interface AbilityInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates whether this ability can be called by other abilities + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly exported: boolean; @@ -385,7 +405,17 @@ export interface AbilityInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Enumerates ability display orientations + * + * @type { bundleManager.DisplayOrientation } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly orientation: bundleManager.DisplayOrientation; @@ -435,7 +465,17 @@ export interface AbilityInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * The permissions that others need to launch this ability + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly permissions: Array; @@ -488,7 +528,17 @@ export interface AbilityInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * The device types that this ability can run on + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly deviceTypes: Array; @@ -568,7 +618,17 @@ export interface AbilityInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates whether the ability is enabled + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly enabled: boolean; @@ -588,7 +648,17 @@ export interface AbilityInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates which window mode is supported + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly supportWindowModes: Array; @@ -608,7 +678,17 @@ export interface AbilityInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates window size + * + * @type { WindowSize } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly windowSize: WindowSize; @@ -674,7 +754,16 @@ export interface AbilityInfo { * @typedef WindowSize * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ +/** + * Indicates the window size. + * + * @typedef WindowSize + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export interface WindowSize { @@ -693,7 +782,17 @@ export interface WindowSize { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates maximum ratio of width over height of window under free window status. + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly maxWindowRatio: number; @@ -713,7 +812,17 @@ export interface WindowSize { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates minimum ratio of width over height of window under free window status. + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly minWindowRatio: number; @@ -733,7 +842,17 @@ export interface WindowSize { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates maximum width of window under free window status. + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly maxWindowWidth: number; @@ -753,7 +872,17 @@ export interface WindowSize { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates minimum width of window under free window status. + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly minWindowWidth: number; @@ -773,7 +902,17 @@ export interface WindowSize { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates maximum height of window under free window status. + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly maxWindowHeight: number; @@ -793,7 +932,17 @@ export interface WindowSize { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates minimum height of window under free window status. + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly minWindowHeight: number; diff --git a/api/bundleManager/ApplicationInfo.d.ts b/api/bundleManager/ApplicationInfo.d.ts index e0e84c3d2b..5a0ba69cf8 100644 --- a/api/bundleManager/ApplicationInfo.d.ts +++ b/api/bundleManager/ApplicationInfo.d.ts @@ -153,7 +153,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates whether or not this application may be instantiated + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly enabled: boolean; @@ -293,7 +303,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Process of application, if user do not set it ,the value equal bundleName + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly process: string; @@ -313,7 +333,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the permissions required for accessing the application. + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly permissions: Array; @@ -375,7 +405,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the metadata of the application + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly metadataArray: Array; @@ -395,7 +435,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates whether or not this application may be removable + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly removable: boolean; @@ -415,7 +465,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the access token of the application + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly accessTokenId: number; @@ -435,7 +495,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the uid of the application + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly uid: number; @@ -455,7 +525,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates icon resource of the application + * + * @type { Resource } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly iconResource: Resource; @@ -475,7 +555,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates label resource of the application + * + * @type { Resource } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly labelResource: Resource; @@ -495,7 +585,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates description resource of the application + * + * @type { Resource } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly descriptionResource: Resource; @@ -515,7 +615,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the appDistributionType of the application + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly appDistributionType: string; @@ -535,7 +645,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the appProvisionType of the application + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly appProvisionType: string; @@ -555,7 +675,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates whether the application is a system application + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly systemApp: boolean; @@ -595,7 +725,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates whether the application is in debug mode. + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly debug: boolean; @@ -607,7 +747,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates whether the application data is unclearable, that is, whether the application data cannot be cleared. + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly dataUnclearable: boolean; @@ -618,7 +768,16 @@ export interface ApplicationInfo { * @type { string } * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates native library path. + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @since 20 * @arkts 1.1&1.2 */ readonly nativeLibraryPath: string; @@ -664,7 +823,17 @@ export interface ApplicationInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the release type of the app + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly releaseType: string; @@ -707,7 +876,16 @@ export interface ApplicationInfo { * @typedef ModuleMetadata * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ +/** + * Indicates the ModuleMetadata + * + * @typedef ModuleMetadata + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export interface ModuleMetadata { @@ -726,7 +904,17 @@ export interface ModuleMetadata { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the name of this hap module + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly moduleName: string; @@ -746,7 +934,17 @@ export interface ModuleMetadata { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the metadata of this hap module + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly metadata: Array; diff --git a/api/bundleManager/BundleInfo.d.ts b/api/bundleManager/BundleInfo.d.ts index 14e62627cf..4cd6d423c8 100644 --- a/api/bundleManager/BundleInfo.d.ts +++ b/api/bundleManager/BundleInfo.d.ts @@ -35,7 +35,16 @@ import bundleManager from './../@ohos.bundle.bundleManager'; * @typedef BundleInfo * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ +/** + * Obtains configuration information about a bundle + * + * @typedef BundleInfo + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export interface BundleInfo { @@ -54,7 +63,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the name of this bundle + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly name: string; @@ -74,7 +93,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the bundle vendor + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly vendor: string; @@ -94,7 +123,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the version code of the bundle + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly versionCode: number; @@ -114,7 +153,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the version name of the bundle + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly versionName: string; @@ -134,7 +183,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the **minimum ** version compatible with the bundle + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly minCompatibleVersionCode: number; @@ -154,7 +213,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the target version number of the bundle + * + * @type { number } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly targetVersion: number; @@ -174,7 +243,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Obtains configuration information about an application + * + * @type { ApplicationInfo } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly appInfo: ApplicationInfo; @@ -194,7 +273,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Obtains configuration information about a module + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly hapModulesInfo: Array; @@ -214,7 +303,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the required permissions details defined in the bundle + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly reqPermissionDetails: Array; @@ -234,7 +333,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the grant state of required permissions + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly permissionGrantStates: Array; @@ -254,7 +363,17 @@ export interface BundleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the SignatureInfo of the bundle + * + * @type { SignatureInfo } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly signatureInfo: SignatureInfo; @@ -348,7 +467,16 @@ export interface BundleInfo { * @typedef ReqPermissionDetail * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ +/** + * Indicates the required permissions details defined in configuration file + * + * @typedef ReqPermissionDetail + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export interface ReqPermissionDetail { @@ -365,7 +493,16 @@ export interface ReqPermissionDetail { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the name of this required permissions + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ name: string; @@ -401,7 +538,16 @@ export interface ReqPermissionDetail { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the reason of this required permissions + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ reason: string; @@ -419,7 +565,16 @@ export interface ReqPermissionDetail { * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the reason id of this required permissions + * + * @type { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ reasonId: number; @@ -437,7 +592,16 @@ export interface ReqPermissionDetail { * @type { UsedScene } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the used scene of this required permissions + * + * @type { UsedScene } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ usedScene: UsedScene; @@ -456,7 +620,16 @@ export interface ReqPermissionDetail { * @typedef UsedScene * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ +/** + * The scene which is used + * + * @typedef UsedScene + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export interface UsedScene { @@ -473,7 +646,16 @@ export interface UsedScene { * @type { Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the abilities that need the permission + * + * @type { Array } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ abilities: Array; @@ -491,7 +673,16 @@ export interface UsedScene { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the time when the permission is used + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ when: string; @@ -510,7 +701,16 @@ export interface UsedScene { * @typedef SignatureInfo * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ +/** + * Indicates SignatureInfo + * + * @typedef SignatureInfo + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ export interface SignatureInfo { @@ -531,7 +731,18 @@ export interface SignatureInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the ID of the application to which this bundle belongs + * The application ID uniquely identifies an application. It is determined by the bundle name and signature + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly appId: string; @@ -551,7 +762,17 @@ export interface SignatureInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the fingerprint of the certificate + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly fingerprint: string; diff --git a/api/bundleManager/HapModuleInfo.d.ts b/api/bundleManager/HapModuleInfo.d.ts index e662cfcf4c..ae02a1d3b6 100644 --- a/api/bundleManager/HapModuleInfo.d.ts +++ b/api/bundleManager/HapModuleInfo.d.ts @@ -384,7 +384,17 @@ export interface HapModuleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * The device types that this hap module can run on + * + * @type { Array } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly deviceTypes: Array; @@ -404,7 +414,17 @@ export interface HapModuleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates whether free installation of the hap module is supported + * + * @type { boolean } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly installationFree: boolean; @@ -424,7 +444,17 @@ export interface HapModuleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the hash value of the hap module + * + * @type { string } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly hashValue: string; @@ -444,7 +474,17 @@ export interface HapModuleInfo { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since arkts {'1.1':'11', '1.2':'20'} + * @since 11 + */ + /** + * Indicates the type of the module + * + * @type { bundleManager.ModuleType } + * @readonly + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @crossplatform + * @atomicservice + * @since 20 * @arkts 1.1&1.2 */ readonly type: bundleManager.ModuleType; @@ -524,7 +564,7 @@ export interface HapModuleInfo { */ readonly nativeLibraryPath: string; - /** + /** * Indicates the code path * * @type { string } @@ -534,7 +574,7 @@ export interface HapModuleInfo { * @since arkts {'1.1':'12', '1.2':'20'} * @arkts 1.1&1.2 */ - readonly codePath: string; + readonly codePath: string; } /** diff --git a/api/bundleManager/ShortcutInfo.d.ts b/api/bundleManager/ShortcutInfo.d.ts index 9654cd59f5..141d227202 100644 --- a/api/bundleManager/ShortcutInfo.d.ts +++ b/api/bundleManager/ShortcutInfo.d.ts @@ -24,7 +24,14 @@ * @typedef ShortcutInfo * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ +/** + * Provides information about a shortcut, including the shortcut ID and label. + * + * @typedef ShortcutInfo + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export interface ShortcutInfo { @@ -43,7 +50,14 @@ export interface ShortcutInfo { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the ID of the application to which this shortcut belongs + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ id: string; @@ -63,7 +77,14 @@ export interface ShortcutInfo { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the name of the bundle containing the shortcut + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ bundleName: string; @@ -83,7 +104,14 @@ export interface ShortcutInfo { * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the moduleName of the shortcut + * + * @type { ?string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ moduleName?: string; @@ -103,7 +131,14 @@ export interface ShortcutInfo { * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the host ability of the shortcut + * + * @type { ?string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ hostAbility?: string; @@ -123,7 +158,14 @@ export interface ShortcutInfo { * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the icon of the shortcut + * + * @type { ?string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ icon?: string; @@ -143,7 +185,14 @@ export interface ShortcutInfo { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the icon id of the shortcut + * + * @type { ?number } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ iconId?: number; @@ -163,7 +212,14 @@ export interface ShortcutInfo { * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the label of the shortcut + * + * @type { ?string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ label?: string; @@ -183,7 +239,14 @@ export interface ShortcutInfo { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the label id of the shortcut + * + * @type { ?number } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ labelId?: number; @@ -203,7 +266,14 @@ export interface ShortcutInfo { * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the wants of the shortcut + * + * @type { ?Array } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ wants?: Array; @@ -214,7 +284,14 @@ export interface ShortcutInfo { * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the index of application clone. + * + * @type { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ appIndex: number; @@ -225,7 +302,14 @@ export interface ShortcutInfo { * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the source type of shortcut. + * + * @type { number } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ sourceType: number; @@ -237,7 +321,14 @@ export interface ShortcutInfo { * @typedef ShortcutWant * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} + * @since 9 + */ +/** + * Obtains information about the ability that a shortcut will start. + * + * @typedef ShortcutWant + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export interface ShortcutWant { @@ -256,7 +347,14 @@ export interface ShortcutWant { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the target bundle of the shortcut want + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ targetBundle: string; @@ -276,7 +374,14 @@ export interface ShortcutWant { * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the target module of the shortcut want + * + * @type { ?string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ targetModule?: string; @@ -296,7 +401,14 @@ export interface ShortcutWant { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the target ability of the shortcut want + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ targetAbility: string; @@ -307,7 +419,14 @@ export interface ShortcutWant { * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the parameters of the shortcut want + * + * @type { ?Array } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ parameters?: Array; @@ -319,7 +438,14 @@ export interface ShortcutWant { * @typedef ParameterItem * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ +/** + * Obtains information about the ability that a shortcut will start. + * + * @typedef ParameterItem + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ export interface ParameterItem { @@ -329,7 +455,14 @@ export interface ParameterItem { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the key of the parameter item. + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ key: string; @@ -340,7 +473,14 @@ export interface ParameterItem { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since arkts {'1.1':'12', '1.2':'20'} + * @since 12 + */ + /** + * Indicates the value of the parameter item. + * + * @type { string } + * @syscap SystemCapability.BundleManager.BundleFramework.Launcher + * @since 20 * @arkts 1.1&1.2 */ value: string; -- Gitee