From f056bb55b12ba1e217b5e69872ca9638d6254255 Mon Sep 17 00:00:00 2001 From: sunjiakun Date: Sat, 13 Jul 2024 15:07:02 +0800 Subject: [PATCH] API Lint Signed-off-by: sunjiakun --- api/@ohos.app.businessAbilityRouter.d.ts | 1 + api/@ohos.bundle.bundleMonitor.d.ts | 1 + api/@ohos.bundle.d.ts | 1 + ...@ohos.bundle.distributedBundleManager.d.ts | 1 + api/@ohos.bundle.freeInstall.d.ts | 12 ++++++++ api/@ohos.bundle.innerBundleManager.d.ts | 1 + api/@ohos.bundle.installer.d.ts | 14 +++++++++- api/@ohos.bundle.launcherBundleManager.d.ts | 3 ++ api/@ohos.bundle.overlay.d.ts | 1 + api/@ohos.zlib.d.ts | 3 ++ api/@system.package.d.ts | 5 ++++ api/bundle/PermissionDef.d.ts | 4 +++ api/bundle/abilityInfo.d.ts | 27 ++++++++++++++++++ api/bundle/bundleInfo.d.ts | 28 +++++++++++++++++++ api/bundle/bundleInstaller.d.ts | 5 ++++ api/bundle/bundleStatusCallback.d.ts | 3 ++ api/bundle/hapModuleInfo.d.ts | 15 ++++++++++ api/bundle/launcherAbilityInfo.d.ts | 6 ++++ api/bundle/moduleInfo.d.ts | 2 ++ api/bundle/remoteAbilityInfo.d.ts | 3 ++ api/bundle/shortcutInfo.d.ts | 14 ++++++++++ api/bundleManager/DispatchInfo.d.ts | 2 ++ 22 files changed, 151 insertions(+), 1 deletion(-) diff --git a/api/@ohos.app.businessAbilityRouter.d.ts b/api/@ohos.app.businessAbilityRouter.d.ts index be342515c..ad41c1ece 100644 --- a/api/@ohos.app.businessAbilityRouter.d.ts +++ b/api/@ohos.app.businessAbilityRouter.d.ts @@ -139,6 +139,7 @@ declare namespace businessAbilityRouter { /** * Obtains business ability info. * + * @typedef { _BusinessAbilityInfo.BusinessAbilityInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @since 10 diff --git a/api/@ohos.bundle.bundleMonitor.d.ts b/api/@ohos.bundle.bundleMonitor.d.ts index 044f761fc..6ee757fec 100644 --- a/api/@ohos.bundle.bundleMonitor.d.ts +++ b/api/@ohos.bundle.bundleMonitor.d.ts @@ -70,6 +70,7 @@ declare namespace bundleMonitor { /** * Indicates the event type of bundle change * + * @typedef { 'add' | 'update' | 'remove' } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 diff --git a/api/@ohos.bundle.d.ts b/api/@ohos.bundle.d.ts index 1557cbe4d..ad46de367 100644 --- a/api/@ohos.bundle.d.ts +++ b/api/@ohos.bundle.d.ts @@ -332,6 +332,7 @@ declare namespace bundle { /** * Indicates the user id * + * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 * @deprecated since 9 diff --git a/api/@ohos.bundle.distributedBundleManager.d.ts b/api/@ohos.bundle.distributedBundleManager.d.ts index ffa5c72dc..1cb83f867 100644 --- a/api/@ohos.bundle.distributedBundleManager.d.ts +++ b/api/@ohos.bundle.distributedBundleManager.d.ts @@ -201,6 +201,7 @@ declare namespace distributedBundleManager { /** * Contains basic remote ability information. * + * typedef { _RemoteAbilityInfo } * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi * @since 9 diff --git a/api/@ohos.bundle.freeInstall.d.ts b/api/@ohos.bundle.freeInstall.d.ts index c85f7c037..e445c411b 100644 --- a/api/@ohos.bundle.freeInstall.d.ts +++ b/api/@ohos.bundle.freeInstall.d.ts @@ -257,6 +257,7 @@ declare namespace freeInstall { /** * The dispatch info class. * + * @typedef { _DispatchInfo } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -266,6 +267,7 @@ declare namespace freeInstall { /** * The bundle pack info class. * + * @typedef { _PackInfo.BundlePackInfo } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -275,6 +277,7 @@ declare namespace freeInstall { /** * The package info class. * + * @typedef { _PackInfo.PackageConfig } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -284,6 +287,7 @@ declare namespace freeInstall { /** * The package summary class. * + * @typedef { _PackInfo.PackageSummary } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -293,6 +297,7 @@ declare namespace freeInstall { /** * The bundle summary class. * + * @typedef { _PackInfo.BundleConfigInfo } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -302,6 +307,7 @@ declare namespace freeInstall { /** * The extension ability forms class. * + * @typedef { _PackInfo.ExtensionAbility } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -311,6 +317,7 @@ declare namespace freeInstall { /** * The module summary of a bundle. * + * @typedef { _PackInfo.ModuleConfigInfo } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -320,6 +327,7 @@ declare namespace freeInstall { /** * The bundle info summary class. * + * @typedef { _PackInfo.ModuleDistroInfo } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -329,6 +337,7 @@ declare namespace freeInstall { /** * The ability info of a module. * + * @typedef { _PackInfo.ModuleAbilityInfo } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -338,6 +347,7 @@ declare namespace freeInstall { /** * The form info of an ability. * + * @typedef { _PackInfo.AbilityFormInfo } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -347,6 +357,7 @@ declare namespace freeInstall { /** * The bundle version class. * + * @typedef { _PackInfo.Version } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -356,6 +367,7 @@ declare namespace freeInstall { /** * The bundle Api version class. * + * @typedef { _PackInfo.ApiVersion } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 diff --git a/api/@ohos.bundle.innerBundleManager.d.ts b/api/@ohos.bundle.innerBundleManager.d.ts index 85938de9f..109bdcc7c 100644 --- a/api/@ohos.bundle.innerBundleManager.d.ts +++ b/api/@ohos.bundle.innerBundleManager.d.ts @@ -184,6 +184,7 @@ declare namespace innerBundleManager { /** * Contains basic Ability information, which uniquely identifies a launcher StatusCallback. * + * @typedef { _BundleStatusCallback } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 diff --git a/api/@ohos.bundle.installer.d.ts b/api/@ohos.bundle.installer.d.ts index 3035eb9e4..4e3da844b 100644 --- a/api/@ohos.bundle.installer.d.ts +++ b/api/@ohos.bundle.installer.d.ts @@ -975,7 +975,7 @@ declare namespace installer { * * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.UNINSTALL_BUNDLE * @param { string } bundleName - Indicates the bundleName. - * @param { Array } moduleName - Indicates the moduleNames for extend resources. + * @param { Array } moduleNames - Indicates the moduleNames for extend resources. * @returns { Promise } Returns removeExtResource result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. @@ -1060,6 +1060,7 @@ declare namespace installer { /** * Indicates the moduleName * + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 @@ -1069,6 +1070,7 @@ declare namespace installer { /** * Indicates the hash value * + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 @@ -1151,6 +1153,7 @@ declare namespace installer { /** * Indicates the user id * + * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 @@ -1160,6 +1163,7 @@ declare namespace installer { /** * Indicates the installation type. The value 0x00 means normal installation, 0x01 means overwrite installation, and 0x10 means installation-free. * + * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 @@ -1169,6 +1173,7 @@ declare namespace installer { /** * Indicates whether the param has data * + * @type { ?boolean } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 @@ -1178,6 +1183,7 @@ declare namespace installer { /** * Indicates the hash params * + * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 @@ -1187,6 +1193,7 @@ declare namespace installer { /** * Indicates the deadline of the crowdtesting bundle * + * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 9 @@ -1196,6 +1203,7 @@ declare namespace installer { /** * Indicates the shared bundle dir paths. * + * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 10 @@ -1205,6 +1213,7 @@ declare namespace installer { /** * Indicates the distribution type specified during bundle installation. * + * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 10 @@ -1214,6 +1223,7 @@ declare namespace installer { /** * Indicates the additional information during bundle installation. * + * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 10 @@ -1254,6 +1264,7 @@ declare namespace installer { /** * Indicates the shared bundle name * + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 10 @@ -1263,6 +1274,7 @@ declare namespace installer { /** * Indicates the shared version code. If default, indicates that all version sharing bundles are uninstalled * + * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi * @since 10 diff --git a/api/@ohos.bundle.launcherBundleManager.d.ts b/api/@ohos.bundle.launcherBundleManager.d.ts index e8cccbb25..95efd0745 100644 --- a/api/@ohos.bundle.launcherBundleManager.d.ts +++ b/api/@ohos.bundle.launcherBundleManager.d.ts @@ -196,6 +196,7 @@ declare namespace launcherBundleManager { /** * Contains basic launcher Ability information, which uniquely identifies an LauncherAbilityInfo. * + * @typedef { _LauncherAbilityInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi * @since 9 @@ -205,6 +206,7 @@ declare namespace launcherBundleManager { /** * Provides information about a shortcut, including the shortcut ID and label. * + * @typedef { _ShortcutInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi * @since 9 @@ -213,6 +215,7 @@ declare namespace launcherBundleManager { /** * Obtains information about the ability that a shortcut will start. * + * @typedef { _ShortcutWant } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi * @since 9 diff --git a/api/@ohos.bundle.overlay.d.ts b/api/@ohos.bundle.overlay.d.ts index 6af6ca956..2267ea00e 100755 --- a/api/@ohos.bundle.overlay.d.ts +++ b/api/@ohos.bundle.overlay.d.ts @@ -278,6 +278,7 @@ declare namespace overlay { /** * Obtains configuration information about a overlay hap module. * + * @typedef { _OverlayModuleInfo.OverlayModuleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @since 10 */ diff --git a/api/@ohos.zlib.d.ts b/api/@ohos.zlib.d.ts index a4b1cb6e1..d686bf71a 100644 --- a/api/@ohos.zlib.d.ts +++ b/api/@ohos.zlib.d.ts @@ -474,6 +474,7 @@ declare namespace zlib { /** * Indicates the compress level. * + * @type { ?CompressLevel } * @syscap SystemCapability.BundleManager.Zlib * @crossplatform * @atomicservice @@ -489,6 +490,7 @@ declare namespace zlib { /** * Indicates the memory level. * + * @type { ?MemLevel } * @syscap SystemCapability.BundleManager.Zlib * @crossplatform * @atomicservice @@ -504,6 +506,7 @@ declare namespace zlib { /** * Indicates the compress strategy. * + * @type { ?CompressStrategy } * @syscap SystemCapability.BundleManager.Zlib * @crossplatform * @atomicservice diff --git a/api/@system.package.d.ts b/api/@system.package.d.ts index a857f7eee..258814913 100644 --- a/api/@system.package.d.ts +++ b/api/@system.package.d.ts @@ -28,6 +28,7 @@ export interface CheckPackageHasInstalledResponse { /** * Whether the application exists, or whether the native application has been installed. * + * @type { boolean } * @syscap SystemCapability.BundleManager.BundleFramework * @since 3 * @deprecated since 9 @@ -45,6 +46,7 @@ export interface CheckPackageHasInstalledOptions { /** * Application bundle name. * + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @since 3 * @deprecated since 9 @@ -54,6 +56,7 @@ export interface CheckPackageHasInstalledOptions { /** * Called when native applications are installed. * + * @type { ?function } * @syscap SystemCapability.BundleManager.BundleFramework * @since 3 * @deprecated since 9 @@ -63,6 +66,7 @@ export interface CheckPackageHasInstalledOptions { /** * Called when native applications fail to be installed. * + * @type { ?function } * @syscap SystemCapability.BundleManager.BundleFramework * @since 3 * @deprecated since 9 @@ -72,6 +76,7 @@ export interface CheckPackageHasInstalledOptions { /** * Called when the execution is completed. * + * @type { ?function } * @syscap SystemCapability.BundleManager.BundleFramework * @since 3 * @deprecated since 9 diff --git a/api/bundle/PermissionDef.d.ts b/api/bundle/PermissionDef.d.ts index f65debb0d..5bbab5084 100644 --- a/api/bundle/PermissionDef.d.ts +++ b/api/bundle/PermissionDef.d.ts @@ -30,6 +30,7 @@ */ export interface PermissionDef { /** + * @type { string } * @default Indicates the name of this permission * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi @@ -39,6 +40,7 @@ export interface PermissionDef { permissionName: string; /** + * @type { number } * @default Indicates the grant mode of this permission * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi @@ -48,6 +50,7 @@ export interface PermissionDef { grantMode: number; /** + * @type { number } * @default Indicates the labelId of this permission * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi @@ -57,6 +60,7 @@ export interface PermissionDef { labelId: number; /** + * @type { number } * @default Indicates the descriptionId of this permission * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi diff --git a/api/bundle/abilityInfo.d.ts b/api/bundle/abilityInfo.d.ts index d0de379c4..238697faf 100644 --- a/api/bundle/abilityInfo.d.ts +++ b/api/bundle/abilityInfo.d.ts @@ -33,6 +33,7 @@ import bundle from './../@ohos.bundle'; */ export interface AbilityInfo { /** + * @type { string } * @default Indicates the name of the bundle containing the ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -41,6 +42,7 @@ export interface AbilityInfo { readonly bundleName: string; /** + * @type { string } * @default Ability simplified class name * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -49,6 +51,7 @@ export interface AbilityInfo { readonly name: string; /** + * @type { string } * @default Indicates the label of the ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -57,6 +60,7 @@ export interface AbilityInfo { readonly label: string; /** + * @type { string } * @default Describes the ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -65,6 +69,7 @@ export interface AbilityInfo { readonly description: string; /** + * @type { string } * @default Indicates the icon of the ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -73,6 +78,7 @@ export interface AbilityInfo { readonly icon: string; /** + * @type { number } * @default Indicates the label id of the ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -81,6 +87,7 @@ export interface AbilityInfo { readonly labelId: number; /** + * @type { number } * @default Indicates the description id of the ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -89,6 +96,7 @@ export interface AbilityInfo { readonly descriptionId: number; /** + * @type { number } * @default Indicates the icon id of the ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -97,6 +105,7 @@ export interface AbilityInfo { readonly iconId: number; /** + * @type { string } * @default Indicates the name of the .hap package to which the capability belongs * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -105,6 +114,7 @@ export interface AbilityInfo { readonly moduleName: string; /** + * @type { string } * @default Process of ability, if user do not set it ,the value equal application process * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -113,6 +123,7 @@ export interface AbilityInfo { readonly process: string; /** + * @type { string } * @default Info about which ability is this nick point to * @syscap SystemCapability.BundleManager.BundleFramework * @FAModelOnly @@ -122,6 +133,7 @@ export interface AbilityInfo { readonly targetAbility: string; /** + * @type { number } * @default Indicates the background service addressing a specific usage scenario * @syscap SystemCapability.BundleManager.BundleFramework * @FAModelOnly @@ -131,6 +143,7 @@ export interface AbilityInfo { readonly backgroundModes: number; /** + * @type { boolean } * @default Indicates whether an ability can be called by other abilities * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -139,6 +152,7 @@ export interface AbilityInfo { readonly isVisible: boolean; /** + * @type { boolean } * @default Indicates whether the ability provides the embedded card capability * @syscap SystemCapability.BundleManager.BundleFramework * @FAModelOnly @@ -148,6 +162,7 @@ export interface AbilityInfo { readonly formEnabled: boolean; /** + * @type { bundle.AbilityType } * @default Enumerates types of templates that can be used by an ability * @syscap SystemCapability.BundleManager.BundleFramework * @FAModelOnly @@ -157,6 +172,7 @@ export interface AbilityInfo { readonly type: bundle.AbilityType; /** + * @type { bundle.AbilitySubType } * @default Enumerates the subType of templates used by an ability * @syscap SystemCapability.BundleManager.BundleFramework * @FAModelOnly @@ -166,6 +182,7 @@ export interface AbilityInfo { readonly subType: bundle.AbilitySubType; /** + * @type { bundle.DisplayOrientation } * @default Enumerates ability display orientations * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -174,6 +191,7 @@ export interface AbilityInfo { readonly orientation: bundle.DisplayOrientation; /** + * @type { bundle.LaunchMode } * @default Enumerates ability launch modes * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -182,6 +200,7 @@ export interface AbilityInfo { readonly launchMode: bundle.LaunchMode; /** + * @type { Array } * @default The permissions that others need to launch this ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -190,6 +209,7 @@ export interface AbilityInfo { readonly permissions: Array; /** + * @type { Array } * @default The device types that this ability can run on * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -198,6 +218,7 @@ export interface AbilityInfo { readonly deviceTypes: Array; /** + * @type { Array } * @default The device capability that this ability needs * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -206,6 +227,7 @@ export interface AbilityInfo { readonly deviceCapabilities: Array; /** + * @type { string } * @default Indicates the permission required for reading ability data * @syscap SystemCapability.BundleManager.BundleFramework * @FAModelOnly @@ -215,6 +237,7 @@ export interface AbilityInfo { readonly readPermission: string; /** + * @type { string } * @default Indicates the permission required for writing data to the ability * @syscap SystemCapability.BundleManager.BundleFramework * @FAModelOnly @@ -224,6 +247,7 @@ export interface AbilityInfo { readonly writePermission: string; /** + * @type { ApplicationInfo } * @default Obtains configuration information about an application * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -232,6 +256,7 @@ export interface AbilityInfo { readonly applicationInfo: ApplicationInfo; /** + * @type { string } * @default Uri of ability * @syscap SystemCapability.BundleManager.BundleFramework * @FAModelOnly @@ -241,6 +266,7 @@ export interface AbilityInfo { readonly uri: string; /** + * @type { Array } * @default Indicates the metadata of ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 8 @@ -249,6 +275,7 @@ export interface AbilityInfo { readonly metaData: Array; /** + * @type { boolean } * @default Indicates whether the ability is enabled * @syscap SystemCapability.BundleManager.BundleFramework * @since 8 diff --git a/api/bundle/bundleInfo.d.ts b/api/bundle/bundleInfo.d.ts index 88894a5f4..2572f6b05 100644 --- a/api/bundle/bundleInfo.d.ts +++ b/api/bundle/bundleInfo.d.ts @@ -33,6 +33,7 @@ import { HapModuleInfo } from './hapModuleInfo'; */ export interface UsedScene { /** + * @type { Array } * @default Indicates the abilities that need the permission * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -41,6 +42,7 @@ export interface UsedScene { abilities: Array; /** + * @type { string } * @default Indicates the time when the permission is used * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -60,6 +62,7 @@ export interface UsedScene { */ export interface ReqPermissionDetail { /** + * @type { string } * @default Indicates the name of this required permissions * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -68,6 +71,7 @@ export interface ReqPermissionDetail { name: string; /** + * @type { string } * @default Indicates the reason of this required permissions * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -76,6 +80,7 @@ export interface ReqPermissionDetail { reason: string; /** + * @type { UsedScene } * @default Indicates the used scene of this required permissions * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -95,6 +100,7 @@ export interface ReqPermissionDetail { */ export interface BundleInfo { /** + * @type { string } * @default Indicates the name of this bundle * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -103,6 +109,7 @@ export interface BundleInfo { readonly name: string; /** + * @type { string } * @default Indicates the name of this original bundle * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -111,6 +118,7 @@ export interface BundleInfo { readonly type: string; /** + * @type { string } * @default 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 * @syscap SystemCapability.BundleManager.BundleFramework @@ -120,6 +128,7 @@ export interface BundleInfo { readonly appId: string; /** + * @type { number } * @default Indicates the UID of the application to which this bundle belongs * The UID uniquely identifies an application. It is determined by the process and user IDs of the application * After an application is installed, its UID remains unchanged unless it is uninstalled and then reinstalled @@ -130,6 +139,7 @@ export interface BundleInfo { readonly uid: number; /** + * @type { number } * @default Indicates the hap install time * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -138,6 +148,7 @@ export interface BundleInfo { readonly installTime: number; /** + * @type { number } * @default Indicates the hap update time * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -146,6 +157,7 @@ export interface BundleInfo { readonly updateTime: number; /** + * @type { ApplicationInfo } * @default Obtains configuration information about an application * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -154,6 +166,7 @@ export interface BundleInfo { readonly appInfo: ApplicationInfo; /** + * @type { Array } * @default Obtains configuration information about an ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -162,6 +175,7 @@ export interface BundleInfo { readonly abilityInfos: Array; /** + * @type { Array } * @default Indicates the required permissions name defined in file config.json * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -170,6 +184,7 @@ export interface BundleInfo { readonly reqPermissions: Array; /** + * @type { Array } * @default Indicates the required permissions details defined in file config.json * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -178,6 +193,7 @@ export interface BundleInfo { readonly reqPermissionDetails: Array; /** + * @type { string } * @default Describes the bundle vendor * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -186,6 +202,7 @@ export interface BundleInfo { readonly vendor: string; /** + * @type { number } * @default Indicates the version number of the bundle * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -194,6 +211,7 @@ export interface BundleInfo { readonly versionCode: number; /** + * @type { string } * @default Indicates the text description of the bundle version * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -202,6 +220,7 @@ export interface BundleInfo { readonly versionName: string; /** + * @type { number } * @default Indicates the compatible version number of the bundle * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -210,6 +229,7 @@ export interface BundleInfo { readonly compatibleVersion: number; /** + * @type { number } * @default Indicates the target version number of the bundle * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -218,6 +238,7 @@ export interface BundleInfo { readonly targetVersion: number; /** + * @type { boolean } * @default Indicates is compress native libs * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -226,6 +247,7 @@ export interface BundleInfo { readonly isCompressNativeLibs: boolean; /** + * @type { Array } * @default Obtains configuration information about a module * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -234,6 +256,7 @@ export interface BundleInfo { readonly hapModuleInfos: Array; /** + * @type { string } * @default Indicates entry module name * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -242,6 +265,7 @@ export interface BundleInfo { readonly entryModuleName: string; /** + * @type { string } * @default Indicates the cpuAbi information of this bundle. * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -250,6 +274,7 @@ export interface BundleInfo { readonly cpuAbi: string; /** + * @type { string } * @default Indicates is silent installation * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -258,6 +283,7 @@ export interface BundleInfo { readonly isSilentInstallation: string; /** + * @type { number } * @default Indicates the earliest historical version compatible with the bundle * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -266,6 +292,7 @@ export interface BundleInfo { readonly minCompatibleVersionCode: number; /** + * @type { boolean } * @default Indicates whether free installation of the entry is supported * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -274,6 +301,7 @@ export interface BundleInfo { readonly entryInstallationFree: boolean; /** + * @type { Array } * @default Indicates the grant status of required permissions * @syscap SystemCapability.BundleManager.BundleFramework * @since 8 diff --git a/api/bundle/bundleInstaller.d.ts b/api/bundle/bundleInstaller.d.ts index 439666da5..94af90192 100644 --- a/api/bundle/bundleInstaller.d.ts +++ b/api/bundle/bundleInstaller.d.ts @@ -33,6 +33,7 @@ import bundle from './../@ohos.bundle'; */ export interface InstallParam { /** + * @type { number } * @default Indicates the user id * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use @@ -43,6 +44,7 @@ export interface InstallParam { userId: number; /** + * @type { number } * @default Indicates the install flag * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use @@ -53,6 +55,7 @@ export interface InstallParam { installFlag: number; /** + * @type { boolean } * @default Indicates whether the param has data * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use @@ -74,6 +77,7 @@ export interface InstallParam { */ export interface InstallStatus { /** + * @type { bundle.InstallErrorCode } * @default Indicates the install or uninstall error code * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use @@ -83,6 +87,7 @@ export interface InstallStatus { status: bundle.InstallErrorCode; /** + * @type { string } * @default Indicates the install or uninstall result string message * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use diff --git a/api/bundle/bundleStatusCallback.d.ts b/api/bundle/bundleStatusCallback.d.ts index 8f09172d8..b7c1bd9a6 100644 --- a/api/bundle/bundleStatusCallback.d.ts +++ b/api/bundle/bundleStatusCallback.d.ts @@ -36,6 +36,7 @@ export interface BundleStatusCallback { * Obtains add callback about an launcherStatusCallback. * * @permission ohos.permission.LISTEN_BUNDLE_CHANGE + * @type { function } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 @@ -47,6 +48,7 @@ export interface BundleStatusCallback { * Obtains update callback about an launcherStatusCallback. * * @permission ohos.permission.LISTEN_BUNDLE_CHANGE + * @type { function } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 @@ -58,6 +60,7 @@ export interface BundleStatusCallback { * Obtains remove callback about an launcherStatusCallback. * * @permission ohos.permission.LISTEN_BUNDLE_CHANGE + * @type { function } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 diff --git a/api/bundle/hapModuleInfo.d.ts b/api/bundle/hapModuleInfo.d.ts index 26c8b199a..a896aa03a 100644 --- a/api/bundle/hapModuleInfo.d.ts +++ b/api/bundle/hapModuleInfo.d.ts @@ -31,6 +31,7 @@ import { AbilityInfo } from './abilityInfo'; */ export interface HapModuleInfo { /** + * @type { string } * @default Indicates the name of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -38,6 +39,7 @@ export interface HapModuleInfo { */ readonly name: string; /** + * @type { string } * @default Describes the hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -45,6 +47,7 @@ export interface HapModuleInfo { */ readonly description: string; /** + * @type { number } * @default Indicates the description of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -52,6 +55,7 @@ export interface HapModuleInfo { */ readonly descriptionId: number; /** + * @type { string } * @default Indicates the icon of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -59,6 +63,7 @@ export interface HapModuleInfo { */ readonly icon: string; /** + * @type { string } * @default Indicates the label of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -66,6 +71,7 @@ export interface HapModuleInfo { */ readonly label: string; /** + * @type { number } * @default Indicates the label id of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -73,6 +79,7 @@ export interface HapModuleInfo { */ readonly labelId: number; /** + * @type { number } * @default Indicates the icon id of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -80,6 +87,7 @@ export interface HapModuleInfo { */ readonly iconId: number; /** + * @type { string } * @default Indicates the background img of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -87,6 +95,7 @@ export interface HapModuleInfo { */ readonly backgroundImg: string; /** + * @type { number } * @default Indicates the supported modes of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -94,6 +103,7 @@ export interface HapModuleInfo { */ readonly supportedModes: number; /** + * @type { Array } * @default Indicates the req capabilities of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -101,6 +111,7 @@ export interface HapModuleInfo { */ readonly reqCapabilities: Array; /** + * @type { Array } * @default The device types that this hapmodule can run on * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -108,6 +119,7 @@ export interface HapModuleInfo { */ readonly deviceTypes: Array; /** + * @type { Array } * @default Obtains configuration information about ability * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -115,6 +127,7 @@ export interface HapModuleInfo { */ readonly abilityInfo: Array; /** + * @type { string } * @default Indicates the name of the .hap package to which the capability belongs * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -122,6 +135,7 @@ export interface HapModuleInfo { */ readonly moduleName: string; /** + * @type { string } * @default Indicates the main ability name of this hapmodule * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -129,6 +143,7 @@ export interface HapModuleInfo { */ readonly mainAbilityName: string; /** + * @type { boolean } * @default Indicates whether free installation of the hapmodule is supported * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 diff --git a/api/bundle/launcherAbilityInfo.d.ts b/api/bundle/launcherAbilityInfo.d.ts index 1664f0898..2bdc8ae92 100644 --- a/api/bundle/launcherAbilityInfo.d.ts +++ b/api/bundle/launcherAbilityInfo.d.ts @@ -39,6 +39,7 @@ export interface LauncherAbilityInfo { /** * Obtains application info information about an launcher ability. * + * @type { ApplicationInfo } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 @@ -49,6 +50,7 @@ export interface LauncherAbilityInfo { /** * Obtains element name about an launcher ability. * + * @type { ElementName } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 @@ -59,6 +61,7 @@ export interface LauncherAbilityInfo { /** * Obtains labelId about an launcher ability. * + * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 @@ -69,6 +72,7 @@ export interface LauncherAbilityInfo { /** * Obtains iconId about an launcher ability. * + * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 @@ -79,6 +83,7 @@ export interface LauncherAbilityInfo { /** * Obtains userId about an launcher ability. * + * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 @@ -89,6 +94,7 @@ export interface LauncherAbilityInfo { /** * Obtains installTime about an launcher ability. * + * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 8 diff --git a/api/bundle/moduleInfo.d.ts b/api/bundle/moduleInfo.d.ts index 455cd8f2e..b4899260a 100644 --- a/api/bundle/moduleInfo.d.ts +++ b/api/bundle/moduleInfo.d.ts @@ -31,6 +31,7 @@ export interface ModuleInfo { /** * The module name. * + * @type { string } * @default Indicates the name of the .hap package to which the capability belongs * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -41,6 +42,7 @@ export interface ModuleInfo { /** * The module source path. * + * @type { string } * @default Indicates the module source dir of this module * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 diff --git a/api/bundle/remoteAbilityInfo.d.ts b/api/bundle/remoteAbilityInfo.d.ts index b9de34b4d..4a5d938c4 100644 --- a/api/bundle/remoteAbilityInfo.d.ts +++ b/api/bundle/remoteAbilityInfo.d.ts @@ -32,6 +32,7 @@ import { ElementName } from './elementName'; */ export interface RemoteAbilityInfo { /** + * @type { ElementName } * @default Indicates the ability information * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi @@ -41,6 +42,7 @@ export interface RemoteAbilityInfo { readonly elementName: ElementName; /** + * @type { string } * @default Indicates the label of the ability * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi @@ -50,6 +52,7 @@ export interface RemoteAbilityInfo { readonly label: string; /** + * @type { string } * @default Indicates the icon of the ability * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi diff --git a/api/bundle/shortcutInfo.d.ts b/api/bundle/shortcutInfo.d.ts index 07650e105..57823b5e0 100644 --- a/api/bundle/shortcutInfo.d.ts +++ b/api/bundle/shortcutInfo.d.ts @@ -31,6 +31,7 @@ */ export interface ShortcutWant { /** + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 7 @@ -38,6 +39,7 @@ export interface ShortcutWant { */ readonly targetBundle: string; /** + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi Hide this for inner system use * @since 7 @@ -56,60 +58,70 @@ export interface ShortcutWant { */ export interface ShortcutInfo { /** + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 * @deprecated since 9 */ readonly id: string; /** + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 * @deprecated since 9 */ readonly bundleName: string; /** + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 * @deprecated since 9 */ readonly hostAbility: string; /** + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 * @deprecated since 9 */ readonly icon: string; /** + * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework * @since 8 * @deprecated since 9 */ readonly iconId: number; /** + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 * @deprecated since 9 */ readonly label: string; /** + * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework * @since 8 * @deprecated since 9 */ readonly labelId: number; /** + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 * @deprecated since 9 */ readonly disableMessage: string; /** + * @type { Array } * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 * @deprecated since 9 */ readonly wants: Array; /** + * @type { ?boolean } * @default false * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -117,6 +129,7 @@ export interface ShortcutInfo { */ readonly isStatic?: boolean; /** + * @type { ?boolean } * @default false * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 @@ -124,6 +137,7 @@ export interface ShortcutInfo { */ readonly isHomeShortcut?: boolean; /** + * @type { ?boolean } * @default false * @syscap SystemCapability.BundleManager.BundleFramework * @since 7 diff --git a/api/bundleManager/DispatchInfo.d.ts b/api/bundleManager/DispatchInfo.d.ts index 19ffc71a2..ce99b7ca9 100644 --- a/api/bundleManager/DispatchInfo.d.ts +++ b/api/bundleManager/DispatchInfo.d.ts @@ -30,6 +30,7 @@ export interface DispatchInfo { /** * Indicates the dispatchInfo version * + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9 @@ -39,6 +40,7 @@ export interface DispatchInfo { /** * Indicates the free install interface version * + * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi * @since 9