openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2025-04-03 04:32:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

bundle api support syscap

Browse Source 
Signed-off-by: shuaiyutao <shuaiyutao1@huawei.com>
This commit is contained in:
shuaiyutao 2022-02-09 18:55:07 +08:00
parent bb58bdfd4a
commit c635b22073
18 changed files with 300 additions and 343 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
api/@ohos.bundle.d.ts vendored
View File

@ -28,8 +28,7 @@ import { PermissionDef } from './bundle/PermissionDef';
* bundle.
* @name bundle
* @since 7
* @sysCap SystemCapability.Appexecfwk
* @devices phone, tablet, tv, wearable
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
*/
declare namespace bundle {
@ -37,10 +36,9 @@ declare namespace bundle {
/**
* @name BundleFlag
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
enum BundleFlag {
GET_BUNDLE_DEFAULT = 0x00000000,
@ -79,10 +77,9 @@ declare namespace bundle {
/**
* @name ExtensionFlag
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
enum ExtensionFlag {
GET_EXTENSION_INFO_DEFAULT = 0x00000000,
@ -94,10 +91,9 @@ declare namespace bundle {
/**
* @name ColorMode
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export enum ColorMode {
AUTO_MODE = -1,
@ -108,10 +104,9 @@ declare namespace bundle {
/**
* @name GrantStatus
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export enum GrantStatus {
PERMISSION_DENIED = -1,
@ -121,37 +116,36 @@ declare namespace bundle {
/**
* @name AbilityType
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export enum AbilityType {
/**
* @default Indicates an unknown ability type
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
UNKNOWN,
/**
* @default Indicates that the ability has a UI
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
PAGE,
/**
* @default Indicates that the ability does not have a UI
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
SERVICE,
/**
* @default Indicates that the ability is used to provide data access services
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
DATA,
}
@ -159,10 +153,9 @@ declare namespace bundle {
/**
* @name AbilitySubType
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export enum AbilitySubType {
UNSPECIFIED = 0,
@ -172,37 +165,36 @@ declare namespace bundle {
/**
* @name DisplayOrientation
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export enum DisplayOrientation {
/**
* @default Indicates that the system automatically determines the display orientation
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
UNSPECIFIED,
/**
* @default Indicates the landscape orientation
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
LANDSCAPE,
/**
* @default Indicates the portrait orientation
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
PORTRAIT,
/**
* @default Indicates the page ability orientation is the same as that of the nearest ability in the stack
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
FOLLOW_RECENT,
}
@ -210,23 +202,22 @@ declare namespace bundle {
/**
* @name LaunchMode
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export enum LaunchMode {
/**
* @default Indicates that the ability has only one instance
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
SINGLETON = 0,
/**
* @default Indicates that the ability can have multiple instances
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
STANDARD = 1,
}
@ -234,70 +225,69 @@ declare namespace bundle {
/**
* @name ExtensionAbilityType
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export enum ExtensionAbilityType {
/**
* @default Indicates extension info with type of form
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
FORM = 0,
/**
* @default Indicates extension info with type of work schedule
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
WORK_SCHEDULER = 1,
/**
* @default Indicates extension info with type of input method
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
INPUTMETHOD = 2,
/**
* @default Indicates extension info with type of service
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
SERVICE = 3,
/**
* @default Indicates extension info with type of accessibility
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
ACCESSIBILITY = 4,
/**
* @default Indicates extension info with type of datashare
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
DATASHARE = 5,
/**
* @default Indicates extension info with type of fileshare
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
FILESHARE = 6,
/**
* @default Indicates extension info with type of staticsubscriber
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
STATICSUBSCRIBER = 7,
/**
* @default Indicates extension info with type of wallpaper
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
WALLPAPER = 8,
/**
* @default Indicates extension info with type of unspecified
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
UNSPECIFIED = 9,
}
@ -305,23 +295,22 @@ declare namespace bundle {
/**
* @name BundleOptions
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export interface BundleOptions {
/**
* @default Indicates the user id
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
userId?: number;
/**
* @default Indicates the network id
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
networkId?: string;
}
@ -329,10 +318,9 @@ declare namespace bundle {
/**
* @name InstallErrorCode
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable
*/
export enum InstallErrorCode{
SUCCESS = 0,
@ -373,9 +361,8 @@ declare namespace bundle {
/**
* Obtains bundleInfo based on bundleName, bundleFlags and options.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the application bundle name to be queried.
* @param bundleFlags Indicates the application bundle flags to be queried.
* @param options Indicates the bundle options object.
@ -389,9 +376,8 @@ declare namespace bundle {
/**
* Obtains the interface used to install bundles.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @return Returns the IBundleInstaller interface.
* @permission ohos.permission.INSTALL_BUNDLE
*/
@ -401,9 +387,8 @@ declare namespace bundle {
/**
* Obtains based on a given bundle name.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the application bundle name to be queried.
* @param bundleFlags Indicates the flag used to specify information contained in the ApplicationInfo object
* that will be returned.
@ -417,9 +402,8 @@ declare namespace bundle {
/**
* Checks whether a specified bundle has been granted a specific permission.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the name of the bundle to check.
* @param permission Indicates the permission to check.
* @return Returns 0 if the bundle has the permission; returns -1 otherwise.
@ -430,9 +414,8 @@ declare namespace bundle {
/**
* Query the AbilityInfo by the given Want.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param want Indicates the Want containing the application bundle name to
* be queried.
* @param bundleFlags Indicates the flag used to specify information contained in the AbilityInfo objects that
@ -448,9 +431,8 @@ declare namespace bundle {
/**
* Obtains BundleInfo of all bundles available in the system.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundlelFlag Indicates the flag used to specify information contained in the BundleInfo that will be
* returned.
* @param userId Indicates the user id.
@ -464,9 +446,8 @@ declare namespace bundle {
/**
* Obtains information about all installed applications of a specified user.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleFlags Indicates the flag used to specify information contained in the ApplicationInfo objects
* that will be returned.
* @param userId Indicates the user ID.
@ -479,9 +460,8 @@ declare namespace bundle {
/**
* Obtains information about an application bundle contained in an ohos Ability Package (HAP).
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param hapFilePath Indicates the path storing the HAP. The path should be the relative path to the data
* directory of the current application.
* @param bundleFlags Indicates the flag used to specify information contained in the BundleInfo object to be
@ -499,9 +479,8 @@ declare namespace bundle {
* #ACTION_HOME and #ENTITY_HOME Want
* filters set in the application's <b>config.json</b> file.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the bundle name of the application.
* @return Returns the Want for starting the application's main ability if any; returns null if
* the given bundle does not exist or does not contain any main ability.
@ -513,9 +492,8 @@ declare namespace bundle {
/**
* Obtains information about the shortcuts of the application.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the bundle name of the application.
* @return Returns a list of ShortcutInfo objects containing shortcut information about the application.
* @permission ohos.permission.MANAGE_SHORTCUTS
@ -526,9 +504,8 @@ declare namespace bundle {
/**
* get module usage record list in descending order of lastLaunchTime.
*
* @devices phone, tablet, tv, wearable
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param maxNum the return size of the records, must be in range of 1 to 1000.
* @return Returns ability usage record list.
* @systemapi hide this for inner system use
@ -539,9 +516,8 @@ declare namespace bundle {
/**
* Clears cache data of a specified application.
*
* @devices phone, tablet, tv, wearable, car
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the bundle name of the application whose cache data is to be cleared.
* @param callback Indicates the callback to be invoked for returning the operation result.
* @permission ohos.permission.REMOVE_CACHE_FILES
@ -553,9 +529,8 @@ declare namespace bundle {
/**
* Sets whether to enable a specified application.
*
* @devices phone, tablet, tv, wearable, car
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the bundle name of the application.
* @param isEnabled Specifies whether to enable the application. The value true means to enable it, and the
* value false means to disable it.
@ -568,9 +543,8 @@ declare namespace bundle {
/**
* Sets whether to enable a specified ability.
*
* @devices phone, tablet, tv, wearable, car
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param abilityInfo Indicates information about the ability to set.
* @param isEnabled Specifies whether to enable the ability. The value true means to enable it, and the
* value false means to disable it..
@ -583,9 +557,8 @@ declare namespace bundle {
/**
* Query extension info of by utilizing a Want.
*
* @devices phone, tablet, tv, wearable, car
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param want Indicates the Want containing the application bundle name to be queried.
* @param extensionFlags Indicates the flag used to specify information contained in the ExtensionInfo objects that
* will be returned.
@ -600,9 +573,8 @@ declare namespace bundle {
/**
* Get the permission details by permissionName.
*
* @devices phone, tablet, tv, wearable, car
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param permissionName Indicates permission name.
* @return Returns permissionDef object.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
@ -612,4 +584,4 @@ declare namespace bundle {
function getPermissionDef(permissionName: string): Promise<PermissionDef>;
}
export default bundle;
export default bundle;

20
api/@ohos.bundle.innerBundleManager.d.ts vendored
View File

@ -22,8 +22,7 @@ import { ShortcutInfo } from './bundle/shortcutInfo';
* inner bundle manager.
* @name innerBundleManager
* @since 8
* @sysCap SystemCapability.Appexecfwk
* @devices phone, tablet, tv, wearable
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @systemapi Hide this for inner system use
*/
@ -32,9 +31,8 @@ declare namespace innerBundleManager {
/**
* Obtains based on a given bundleName and userId.
*
* @devices phone, tablet, tv, wearable
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the application bundle name to be queried.
* @param userId Indicates the id for the user.
* @return Returns the LauncherAbilityInfo object.
@ -47,9 +45,8 @@ declare namespace innerBundleManager {
/**
* Register Callback.
*
* @devices phone, tablet, tv, wearable
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param type Indicates the command should be implement.
* @param LauncherStatusCallback Indicates the callback to be register.
* @return Returns the result or error maeeage.
@ -62,9 +59,8 @@ declare namespace innerBundleManager {
/**
* UnRegister Callback.
*
* @devices phone, tablet, tv, wearable
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param type Indicates the command should be implement.
* @return Returns the result or error maeeage.
* @permission ohos.permission.LISTEN_BUNDLE_CHANGE
@ -76,9 +72,8 @@ declare namespace innerBundleManager {
/**
* Obtains based on a given userId.
*
* @devices phone, tablet, tv, wearable
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param userId Indicates the id for the user.
* @return Returns the LauncherAbilityInfo object.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
@ -90,9 +85,8 @@ declare namespace innerBundleManager {
/**
* Obtains based on a given bundleName.
*
* @devices phone, tablet, tv, wearable
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @param bundleName Indicates the application bundle name to be queried.
* @return Returns the LauncherShortcutInfo object.
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
@ -102,4 +96,4 @@ declare namespace innerBundleManager {
function getShortcutInfos(bundleName : string) : Promise<Array<ShortcutInfo>>;
}
export default innerBundleManager;
export default innerBundleManager;

21
api/@ohos.zlib.d.ts vendored
View File

@ -19,10 +19,9 @@ declare namespace zlib {
/**
* @name ErrorCode
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.Zlib
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable, car
*/
export enum ErrorCode {
ERROR_CODE_OK = 0,
@ -32,10 +31,9 @@ declare namespace zlib {
/**
* @name CompressLevel
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.Zlib
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable, car
*/
export enum CompressLevel {
COMPRESS_LEVEL_NO_COMPRESSION = 0,
@ -47,10 +45,9 @@ declare namespace zlib {
/**
* @name CompressStrategy
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.Zlib
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable, car
*/
export enum CompressStrategy {
COMPRESS_STRATEGY_DEFAULT_STRATEGY = 0,
@ -63,10 +60,9 @@ declare namespace zlib {
/**
* @name MemLevel
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.Zlib
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable, car
*/
export enum MemLevel {
MEM_LEVEL_MIN = 1,
@ -77,10 +73,9 @@ declare namespace zlib {
/**
* @name Options
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.Zlib
* @import NA
* @permission NA
* @devices phone, tablet, tv, wearable, car
*/
interface Options {
level?: CompressLevel;
@ -91,9 +86,8 @@ declare namespace zlib {
/**
* Compress the specified file.
*
* @devices phone, tablet, tv, wearable, car
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.Zlib
* @param inFile Indicates the path of the file to be compressed.
* @param outFile Indicates the path of the output compressed file.
* @return Returns error code.
@ -103,9 +97,8 @@ declare namespace zlib {
/**
* Decompress the specified file.
*
* @devices phone, tablet, tv, wearable, car
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.Zlib
* @param inFile Indicates the path of the file to be decompressed.
* @param outFile Indicates the path of the decompressed file.
* @return Returns error code.

11
api/bundle/PermissionDef.d.ts vendored
View File

@ -16,37 +16,36 @@
/**
* @name Indicates the defined permission details in file config.json
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
* @systemapi
*/
export interface PermissionDef {
/**
* @default Indicates the name of this permission
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
permissionName: string;
/**
* @default Indicates the bundleName of this permission
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
bundleName: string;
/**
* @default Indicates the labelId of this permission
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
labelId: number;
/**
* @default Indicates the descriptionId of this permission
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
descriptionId: number;
}

71
api/bundle/abilityInfo.d.ts vendored
View File

@ -21,85 +21,84 @@ import bundle from './../@ohos.bundle';
/**
* @name Obtains configuration information about an ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*/
export interface AbilityInfo {
/**
* @default Indicates the name of the bundle containing the ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly bundleName: string;
/**
* @default Ability simplified class name
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly name: string;
/**
* @default Indicates the label of the ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly label: string;
/**
* @default Describes the ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly description: string;
/**
* @default Indicates the icon of the ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly icon: string;
/**
* @default Indicates the label id of the ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly labelId: number;
/**
* @default Indicates the description id of the ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly descriptionId: number;
/**
* @default Indicates the icon id of the ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly iconId: number;
/**
* @default Indicates the name of the .hap package to which the capability belongs
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly moduleName: string;
/**
* @default Process of ability, if user do not set it ,the value equal application process
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly process: string;
/**
* @default Info about which ability is this nick point to
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly targetAbility: string;
@ -107,7 +106,7 @@ export interface AbilityInfo {
/**
* @default Indicates the background service addressing a specific usage scenario
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly backgroundModes: number;
@ -115,14 +114,14 @@ export interface AbilityInfo {
/**
* @default Indicates whether an ability can be called by other abilities
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly isVisible: boolean;
/**
* @default Indicates whether the ability provides the embedded card capability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly formEnabled: boolean;
@ -130,7 +129,7 @@ export interface AbilityInfo {
/**
* @default Enumerates types of templates that can be used by an ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly type: bundle.AbilityType;
@ -138,7 +137,7 @@ export interface AbilityInfo {
/**
* @default Enumerates the subType of templates used by an ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly subType: bundle.AbilitySubType;
@ -146,7 +145,7 @@ export interface AbilityInfo {
/**
* @default Enumerates ability display orientations
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly orientation: bundle.DisplayOrientation;
@ -154,35 +153,35 @@ export interface AbilityInfo {
/**
* @default Enumerates ability launch modes
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly launchMode: bundle.LaunchMode;
/**
* @default The permissions that others need to launch this ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly permissions: Array<string>;
/**
* @default The device types that this ability can run on
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly deviceTypes: Array<string>;
/**
* @default The device capability that this ability needs
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly deviceCapabilities: Array<string>;
/**
* @default Indicates the permission required for reading ability data
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly readPermission: string;
@ -190,7 +189,7 @@ export interface AbilityInfo {
/**
* @default Indicates the permission required for writing data to the ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly writePermission: string;
@ -198,14 +197,14 @@ export interface AbilityInfo {
/**
* @default Obtains configuration information about an application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly applicationInfo: ApplicationInfo;
/**
* @default Where form can be displayed
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly formEntity: number;
@ -213,7 +212,7 @@ export interface AbilityInfo {
/**
* @default Minimum height of ability.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly minFormHeight: number;
@ -221,7 +220,7 @@ export interface AbilityInfo {
/**
* @default Default height of ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly defaultFormHeight: number;
@ -229,7 +228,7 @@ export interface AbilityInfo {
/**
* @default Minimum width of ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly minFormWidth: number;
@ -237,7 +236,7 @@ export interface AbilityInfo {
/**
* @default Default width of ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly defaultFormWidth: number;
@ -245,7 +244,7 @@ export interface AbilityInfo {
/**
* @default Uri of ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @FAModelOnly
*/
readonly uri: string;
@ -253,21 +252,21 @@ export interface AbilityInfo {
/**
* @default Indicates the custom metadata of ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
customizeData: Map<string, Array<CustomizeData>>;
/**
* @default Indicates the metadata of ability
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly metaData: Array<CustomizeData>;
/**
* @default Indicates the metadata of ability
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*
*/
readonly metadata: Array<Metadata>;
@ -275,7 +274,7 @@ export interface AbilityInfo {
/**
* @default Indicates the metadata of ability
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly enabled: boolean;
}

50
api/bundle/applicationInfo.d.ts vendored
View File

@ -20,169 +20,169 @@ import { Metadata } from './metadata'
/**
* @name Obtains configuration information about an application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface ApplicationInfo {
/**
* @default Indicates the application name, which is the same as {@code bundleName}
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly name: string;
/**
* @default Description of application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly description: string;
/**
* @default Indicates the description id of the application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly descriptionId: number;
/**
* @default Indicates whether the application is a system application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly systemApp: boolean;
/**
* @default Indicates whether or not this application may be instantiated
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly enabled: boolean;
/**
* @default Indicates the label of the application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly label: string;
/**
* @default Indicates the label id of the application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly labelId: string;
/**
* @default Indicates the icon of the application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly icon: string;
/**
* @default Indicates the icon id of the application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly iconId: string;
/**
* @default Process of application, if user do not set it ,the value equal bundleName
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly process: string;
/**
* @default Indicates the running mode supported by the application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly supportedModes: number;
/**
* @default Indicates the path storing the module resources of the application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly moduleSourceDirs: Array<string>;
/**
* @default Indicates the permissions required for accessing the application.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly permissions: Array<string>;
/**
* @default Indicates module information about an application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly moduleInfos: Array<ModuleInfo>;
/**
* @default Indicates the path where the {@code Entry.hap} file of the application is saved
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly entryDir: string;
/**
* @default Indicates the application source code path
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly codePath: string;
/**
* @default Indicates the custom metadata of the application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
customizeData: Map<string, CustomizeData>;
/**
* @default Indicates the metadata of module
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly metaData: Map<string, Array<CustomizeData>>;
/**
* @default Indicates the metadata of module
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly metadata: Map<string, Array<Metadata>>;
/**
* @default Indicates whether or not this application may be removable
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly removable: boolean;
/**
* @default Indicates the access token of the application
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly accessTokenId: number;
/**
* @default Indicates the uid of the application
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly uid: number;
/**
* @default Indicates entity type of the application
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly entityType: string;
}

70
api/bundle/bundleInfo.d.ts vendored
View File

@ -21,22 +21,22 @@ import { HapModuleInfo } from './hapModuleInfo';
/**
* @name The scene which is used
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface UsedScene {
/**
* @default Indicates the abilities that need the permission
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
abilities: Array<string>;
/**
* @default Indicates the time when the permission is used
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
when: string;
}
@ -44,29 +44,29 @@ export interface UsedScene {
/**
* @name Indicates the required permissions details defined in file config.json
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface ReqPermissionDetail {
/**
* @default Indicates the name of this required permissions
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
name: string;
/**
* @default Indicates the reason of this required permissions
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
reason: string;
/**
* @default Indicates the used scene of this required permissions
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
usedScene: UsedScene;
}
@ -74,22 +74,22 @@ export interface ReqPermissionDetail {
/**
* @name Obtains configuration information about a bundle
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface BundleInfo {
/**
* @default Indicates the name of this bundle
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly name: string;
/**
* @default Indicates the name of this original bundle
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly type: string;
@ -97,7 +97,7 @@ export interface BundleInfo {
* @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
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly appId: string;
@ -106,147 +106,147 @@ export interface BundleInfo {
* 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
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly uid: number;
/**
* @default Indicates the hap install time
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly installTime: number;
/**
* @default Indicates the hap update time
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly updateTime: number;
/**
* @default Obtains configuration information about an application
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly appInfo: ApplicationInfo;
/**
* @default Obtains configuration information about an ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly abilityInfo: Array<AbilityInfo>;
/**
* @default Indicates the required permissions name defined in file config.json
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly reqPermissions: Array<string>;
/**
* @default Indicates the required permissions details defined in file config.json
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly reqPermissionDetails: Array<ReqPermissionDetail>;
/**
* @default Describes the bundle vendor
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly vendor: string;
/**
* @default Indicates the version number of the bundle
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly versionCode: number;
/**
* @default Indicates the text description of the bundle version
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly versionName: string;
/**
* @default Indicates the compatible version number of the bundle
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly compatibleVersion: number;
/**
* @default Indicates the target version number of the bundle
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly targetVersion: number;
/**
* @default Indicates is compress native libs
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly isCompressNativeLibs: boolean;
/**
* @default Obtains configuration information about an module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly hapModuleInfo: Array<HapModuleInfo>;
/**
* @default Indicates entry module name
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly entryModuleName: string;
/**
* @default Indicates the cpuAbi information of this bundle.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly cpuAbi: string;
/**
* @default Indicates is silent installation
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly isSilentInstallation: string;
/**
* @default Indicates the earliest historical version compatible with the bundle
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly minCompatibleVersionCode: number;
/**
* @default Indicates whether free installation of the entry is supported
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly entryInstallationFree: boolean;
/**
* @default Indicates the grant status of required permissions
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly reqPermissionStates: Array<number>;
/**
* @default Obtains configuration information about an ability
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly extensionAbilityInfo: Array<ExtensionAbilityInfo>;
}

34
api/bundle/bundleInstaller.d.ts vendored
View File

@ -19,29 +19,29 @@ import bundle from './../@ohos.bundle';
/**
* @name Provides parameters required for installing or uninstalling an application.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface InstallParam {
/**
* @default Indicates the user id
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
userId: number;
/**
* @default Indicates the install flag
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
installFlag: number;
/**
* @default Indicates whether the param has data
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
isKeepData: boolean;
}
@ -49,23 +49,23 @@ export interface InstallParam {
/**
* @name Indicates the install or uninstall status
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface InstallStatus {
/**
* @default Indicates the install or uninstall error code
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
status: bundle.InstallErrorCode;
/**
* @default Indicates the install or uninstall result string message
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
statusMessage: string;
}
@ -73,17 +73,17 @@ export interface InstallStatus {
/**
* @name Offers install, upgrade, and remove bundles on the devices.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface BundleInstaller {
/**
* Install an application in a HAP.
*
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @devices phone, tablet, tv, wearable, car
* @syscap SystemCapability.BundleManager.BundleFramework
*
* @param bundleFilePaths Indicates the path where the bundle of the application is stored. The path should be the
* relative path to the data directory of the current application.
* @param installParam Indicates other parameters required for the installation.
@ -96,8 +96,8 @@ export interface BundleInstaller {
* Uninstall an application.
*
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @devices phone, tablet, tv, wearable, car
* @syscap SystemCapability.BundleManager.BundleFramework
*
* @param bundleName Indicates the bundle name of the application to be uninstalled.
* @param installParam Indicates other parameters required for the uninstallation.
* @return InstallStatus
@ -109,8 +109,8 @@ export interface BundleInstaller {
* recover an application.
*
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @devices phone, tablet, tv, wearable, car
* @syscap SystemCapability.BundleManager.BundleFramework
*
* @param bundleName Indicates the bundle name of the application to be recovered.
* @param installParam Indicates other parameters required for the recover.
* @return InstallStatus

16
api/bundle/bundleStatusCallback.d.ts vendored
View File

@ -19,8 +19,8 @@
* such as the add, update, remove.
* @name Contains basic launcher status callback information, which uniquely identifies an LauncherStatusCallback
* @since 8
* @sysCap SystemCapability.Appexecfwk
* @devices phone, tablet, tv, wearable, car
* @syscap SystemCapability.BundleManager.BundleFramework
*
* @permission ohos.permission.LISTEN_BUNDLE_CHANGE
* @systemapi Hide this for inner system use
*/
@ -28,9 +28,9 @@ declare interface BundleStatusCallback {
/**
* @name Obtains add callback about an launcherStatusCallback.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission ohos.permission.LISTEN_BUNDLE_CHANGE
* @devices phone, tablet, tv, wearable, car
*
* @systemapi Hide this for inner system use
*/
add: (bundleName : string, userId: number) => void;
@ -38,9 +38,9 @@ declare interface BundleStatusCallback {
/**
* @name Obtains update callback about an launcherStatusCallback.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission ohos.permission.LISTEN_BUNDLE_CHANGE
* @devices phone, tablet, tv, wearable, car
*
* @systemapi Hide this for inner system use
*/
update: (bundleName : string, userId: number) => void;
@ -48,9 +48,9 @@ declare interface BundleStatusCallback {
/**
* @name Obtains remove callback about an launcherStatusCallback.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission ohos.permission.LISTEN_BUNDLE_CHANGE
* @devices phone, tablet, tv, wearable, car
*
* @systemapi Hide this for inner system use
*/
remove: (bundleName : string, userId: number) => void;

10
api/bundle/customizeData.d.ts vendored
View File

@ -16,29 +16,29 @@
/**
* @name Indicates the custom metadata
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface CustomizeData {
/**
* @default Indicates the custom metadata name
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
name: string;
/**
* @default Indicates the custom metadata value
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
value: string;
/**
* @default Indicates the custom metadata resource
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
extra: string;
}

24
api/bundle/elementName.d.ts vendored
View File

@ -19,53 +19,53 @@
* such as the device ID, bundle name, and ability name.
* @name Contains basic Ability information, which uniquely identifies an ability
* @since 7
* @sysCap SystemCapability.Appexecfwk
* @devices phone, tablet, tv, wearable, car
* @syscap SystemCapability.BundleManager.BundleFramework
*
* @permission N/A
*/
export interface ElementName {
/**
* device id
* @default -
* @devices phone, tablet, tv, wearable, car
*
* @since 7
* @sysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
deviceId?: string;
/**
* bundle name
* @default -
* @devices phone, tablet, tv, wearable, car
*
* @since 7
* @sysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
bundleName: string;
/**
* ability name
* @default ability class name.
* @devices phone, tablet, tv, wearable, car
*
* @since 7
* @sysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
abilityName: string;
/**
* uri
* @default -
* @devices phone, tablet, tv, wearable, car
*
* @since 7
* @sysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
uri?: string;
/**
* shortName
* @default -
* @devices phone, tablet, tv, wearable, car
*
* @since 7
* @sysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
shortName?: string;
}

32
api/bundle/extensionAbilityInfo.d.ts vendored
View File

@ -20,106 +20,106 @@ import bundle from './../@ohos.bundle';
/**
* @name Obtains extension information about a bundle
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface ExtensionAbilityInfo {
/**
* @default Indicates the name of the bundle
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly bundleName: string;
/**
* @default Indicates the name of the module
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly moduleName: string;
/**
* @default Indicates the name of the extension info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly name: string;
/**
* @default Indicates the label id of the entension info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly labelId: number;
/**
* @default Indicates the description id of the entension info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly descriptionId: number;
/**
* @default Indicates the icon id of the entension info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly iconId: number;
/**
* @default Indicates whether the entensionInfo can be visible or not
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly isVisible: boolean;
/**
* @default Enumerates types of the entension info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly extensionAbilityType: bundle.ExtensionAbilityType;
/**
* @default The permissions that others need to use this extension info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly permissions: Array<string>;
/**
* @default Obtains configuration information about an application
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly applicationInfo: ApplicationInfo;
/**
* @default Indicates the metadata of bundle
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly metadata: Array<Metadata>;
/**
* @default Indicates the src language to express extension info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly enabled: boolean;
/**
* @default Indicates the read permission extension ability info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly readPermission: string;
/**
* @default Indicates the write permission of extension ability info
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly writePermission: string;
}

38
api/bundle/hapModuleInfo.d.ts vendored
View File

@ -19,113 +19,113 @@ import { ExtensionAbilityInfo } from "./extensionAbilityInfo";
/**
* @name Obtains configuration information about an module.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface HapModuleInfo {
/**
* @default Indicates the name of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly name: string;
/**
* @default Describes the hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly description: string;
/**
* @default Indicates the description of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly descriptionId: number;
/**
* @default Indicates the icon of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly icon: string;
/**
* @default Indicates the label of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly label: string;
/**
* @default Indicates the label id of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly labelId: number;
/**
* @default Indicates the icon id of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly iconId: number;
/**
* @default Indicates the background img of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly backgroundImg: string;
/**
* @default Indicates the supported modes of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly supportedModes: number;
/**
* @default Indicates the req capabilities of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly reqCapabilities: Array<string>;
/**
* @default The device types that this hapmodule can run on
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly deviceTypes: Array<string>;
/**
* @default Obtains configuration information about ability
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly abilityInfo: Array<AbilityInfo>;
/**
* @default Indicates the name of the .hap package to which the capability belongs
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly moduleName: string;
/**
* @default Indicates the main ability name of this hapmodule
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly mainAbilityName: string;
/**
* @default Indicates whether free installation of the hapmodule is supported
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly installationFree: boolean;
/**
* @default Indicates main elementName of the module
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly mainElementName: string;
/**
* @default Obtains configuration information about extension ability
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly extensionAbilityInfo: Array<ExtensionAbilityInfo>;
}

28
api/bundle/launcherAbilityInfo.d.ts vendored
View File

@ -19,8 +19,8 @@
* such as the application Info , elementName, labelId, iconId, userId, installTime.
* @name Contains basic launcher Ability information, which uniquely identifies an LauncherAbilityInfo
* @since 8
* @sysCap SystemCapability.Appexecfwk
* @devices phone, tablet, tv, wearable, car
* @syscap SystemCapability.BundleManager.BundleFramework
*
* @permission N/A
* @systemapi Hide this for inner system use
*/
@ -32,54 +32,54 @@ export interface LauncherAbilityInfo {
/**
* @name Obtains application info information about an launcher ability.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
readonly applicationInfo: ApplicationInfo;
/**
* @name Obtains element name about an launcher ability.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
readonly elementName : ElementName;
/**
* @name Obtains labelId about an launcher ability.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
readonly labelId: number;
/**
* @name Obtains iconId about an launcher ability.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
readonly iconId: number;
/**
* @name Obtains userId about an launcher ability.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
readonly userId: number;
/**
* @name Obtains installTime about an launcher ability.
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
readonly installTime : number;
}

10
api/bundle/metadata.d.ts vendored
View File

@ -16,29 +16,29 @@
/**
* @name Indicates the Metadata
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface Metadata {
/**
* @default Indicates the metadata name
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
name: string;
/**
* @default Indicates the metadata value
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
value: string;
/**
* @default Indicates the metadata resource
* @since 9
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
resource: string;
}

12
api/bundle/moduleInfo.d.ts vendored
View File

@ -16,18 +16,18 @@
/**
* @name Stores module information about an application.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface ModuleInfo {
/**
* The module name.
*
* @default Indicates the name of the .hap package to which the capability belongs
* @devices phone, tablet, tv, wearable, car
*
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly moduleName: string;
@ -35,9 +35,9 @@
* The module source path.
*
* @default Indicates the module source dir of this module
* @devices phone, tablet, tv, wearable, car
*
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly moduleSourceDir: string;
}

30
api/bundle/moduleUsageRecord.d.ts vendored
View File

@ -16,88 +16,88 @@
/**
* @name Stores FA usage information.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
* @systemapi hide this for inner system use
*/
export interface ModuleUsageRecord {
/**
* @default Indicates the name of the bundle containing the module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly bundleName: string;
/**
* @default Indicates the app label id of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly appLabelId: number;
/**
* @default Indicates the name of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly name: string;
/**
* @default Indicates the label id of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly labelId: number;
/**
* @default Indicates the description id of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly descriptionId: number;
/**
* @default Indicates the ability name of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly abilityName: string;
/**
* @default Indicates the ability label id of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly abilityLabelId: number;
/**
* @default Indicates the ability description id of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly abilityDescriptionId: number;
/**
* @default Indicates the ability icon id of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly abilityIconId: number;
/**
* @default Indicates the launched count of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly launchedCount: number;
/**
* @default Indicates the last launch time of this module
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly lastLaunchTime: number;
/**
* @default Indicates whether the module is removed
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly isRemoved: boolean;
/**
* @default Indicates whether free installation of the module is supported
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly installationFreeSupported: boolean;
}

36
api/bundle/shortcutInfo.d.ts vendored
View File

@ -17,21 +17,21 @@
* @name Provides methods for obtaining information about the ability that a shortcut will start, including the target
* bundle name and ability class name.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface ShortcutWant{
/**
* @default Indicates the target bundle of the shortcut want
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly targetBundle: string;
/**
* @default Indicates the target class of the shortcut want
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly targetClass: string;
}
@ -39,81 +39,81 @@
/**
* @name Provides information about a shortcut, including the shortcut ID and label.
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
* @permission NA
* @devices phone, tablet, tv, wearable, car
*
*/
export interface ShortcutInfo {
/**
* @default Indicates the ID of the application to which this shortcut belongs
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly id: string;
/**
* @default Indicates the name of the bundle containing the shortcut
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly bundleName: string;
/**
* @default Indicates the host ability of the shortcut
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly hostAbility: string;
/**
* @default Indicates the icon of the shortcut
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly icon: string;
/**
* @default Indicate s the icon id of the shortcut
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly iconId: number;
/**
* @default Indicates the label of the shortcut
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly label: string;
/**
* @default Indicates the label id of the shortcut
* @since 8
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly labelId: number;
/**
* @default Indicates the disableMessage of the shortcut
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly disableMessage: string;
/**
* @default Indicates the wants of the shortcut
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly wants: Array<ShortcutWant>;
/**
* @default Indicates whether the shortcut is static
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly isStatic?: boolean
/**
* @default Indicates whether the shortcut is homeshortcut
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly isHomeShortcut?: boolean;
/**
* @default Indicates whether the shortcut is enabled
* @since 7
* @SysCap SystemCapability.Appexecfwk
* @syscap SystemCapability.BundleManager.BundleFramework
*/
readonly isEnabled?: boolean;
}