diff --git a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md index 49bbbc8d22da80f1b715d58cf6cd81cb9faedaa6..43a69fa0501f414060b38cb274da3ceb64a7a13d 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md @@ -47,7 +47,7 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | ------------------------- | ------------------ | -| Promise\ | Promise形式返回应用程序信息。 | +| Promise\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | Promise形式返回应用程序信息。 | **示例：** @@ -86,7 +86,7 @@ SystemCapability.BundleManager.BundleFramework | bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | -| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回应用程序信息。 | +| callback | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是 | 程序启动作为入参的回调函数，返回应用程序信息。 | **示例：** @@ -124,7 +124,7 @@ SystemCapability.BundleManager.BundleFramework | ----------- | ------------------------------- | ---- | --------------------------------------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | -| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回应用程序信息。 | +| callback | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是 | 程序启动作为入参的回调函数，返回应用程序信息。 | **示例：** @@ -166,7 +166,7 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | --------------------------- | -------------------------- | -| Promise> | Promise形式返回所有可用的BundleInfo | +| Promise> | Promise形式返回所有可用的BundleInfo | **示例：** @@ -202,7 +202,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | --------------------------------- | ---- | --------------------------------------- | | bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 | **示例：** @@ -238,7 +238,7 @@ SystemCapability.BundleManager.BundleFramework | ---------- | --------------------------------- | ---- | --------------------------------------- | | bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 | **示例：** @@ -276,13 +276,13 @@ SystemCapability.BundleManager.BundleFramework | ----------- | ------------- | ---- | --------------------------------------- | | bundleName | string | 是 | 包名 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | -| options | BundleOptions | 否 | 包含userid。 | +| options | [BundleOptions](#BundleOptions) | 否 | 包含userid。 | **返回值：** | 类型 | 说明 | | -------------------- | ---------------------------- | -| Promise\ | 返回值为Promise对象，Promise中包含包信息。 | +| Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 返回值为Promise对象，Promise中包含包信息。 | **示例：** @@ -322,7 +322,7 @@ SystemCapability.BundleManager.BundleFramework | ----------- | -------------------------- | ---- | --------------------------------------- | | bundleName | string | 是 | 包名 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | -| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回包信息。 | +| callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数，返回包信息。 | **示例：** @@ -359,8 +359,8 @@ SystemCapability.BundleManager.BundleFramework | ----------- | -------------------------- | ---- | --------------------------------------- | | bundleName | string | 是 | 包名 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | -| options | BundleOptions | 是 | 包含userid。 | -| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回包信息。 | +| options | [BundleOptions](#BundleOptions) | 是 | 包含userid。 | +| callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数，返回包信息。 | **示例：** @@ -405,7 +405,7 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | -------------------------------- | ------------------------------- | -| Promise> | 返回值为Promise对象，Promise中包含应用信息列表。 | +| Promise> | 返回值为Promise对象，Promise中包含应用信息列表。 | **示例：** @@ -442,7 +442,7 @@ SystemCapability.BundleManager.BundleFramework | ----------- | -------------------------------------- | ---- | --------------------------------------- | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回应用信息列表。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回应用信息列表。 | **示例：** @@ -478,7 +478,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | -------------------------------------- | ---- | --------------------------------------- | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回应用信息列表。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回应用信息列表。 | **示例：** @@ -518,7 +518,7 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | --------------------- | --------------------- | -| Promise\ | Promise形式返回Ability信息。 | +| Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | Promise形式返回Ability信息。 | **示例：** @@ -553,7 +553,7 @@ SystemCapability.BundleManager.BundleFramework | ----------- | ------------ | ---- | ---------------- | | bundleName | string | 是 | 应用程序包名。 | | abilityName | string | 是 | Ability名称。 | -| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | +| callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | **示例：** @@ -663,7 +663,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---- | ----------- | ---- | ------------ | -| info | AbilityInfo | 是 | Ability的配置信息 | +| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是 | Ability的配置信息 | **返回值：** @@ -704,7 +704,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------- | ----------------------- | ---- | --------------- | -| info | AbilityInfo | 是 | Ability的配置信息 | +| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是 | Ability的配置信息 | | callback | AsyncCallback\ | 是 | 返回boolean代表是否启用 | **示例：** @@ -813,7 +813,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------ | ---- | ------------------------------------- | -| want | Want | 是 | 包含要查询的应用程序包名称的意图。 | +| want | [Want](js-apis-application-Want.md) | 是 | 包含要查询的应用程序包名称的意图。 | | bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | @@ -821,7 +821,7 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | ---------------------------- | --------------------- | -| Promise> | Promise形式返回Ability信息。 | +| Promise> | Promise形式返回Ability信息。 | **示例：** @@ -856,10 +856,10 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ---------------------------------- | ---- | ------------------------------------- | -| want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 | +| want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | | bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | **示例：** @@ -893,9 +893,9 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ---------------------------------- | ---- | ------------------------------------- | -| want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 | +| want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | | bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | **示例：** @@ -939,7 +939,7 @@ SystemCapability.BundleManager.BundleFramework **返回值：** | 类型 | 说明 | | -------------- | -------------------------------------- | -| Promise\ | 返回值为Promise对象，Promise中包含拉起指定应用的Want对象。 | +| Promise\<[Want](js-apis-application-Want.md)> | 返回值为Promise对象，Promise中包含拉起指定应用的Want对象。 | **示例：** @@ -972,7 +972,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | -------------------- | ---- | ------------------------------ | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回拉起指定应用的want对象。 | +| callback | AsyncCallback\<[Want](js-apis-application-Want.md)> | 是 | 程序启动作为入参的回调函数，返回拉起指定应用的want对象。 | **示例：** @@ -1146,7 +1146,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------------- | ------ | ---- | ---------------------------------------- | -| want | Want | 是 | 包含要查询的应用程序包名称的意图。 | +| want | [Want](js-apis-application-Want.md) | 是 | 包含要查询的应用程序包名称的意图。 | | extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | @@ -1154,7 +1154,7 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | ------------------------------------- | ------------------------------ | -| Promise> | Promise形式返回ExtensionAbility信息。 | +| Promise> | Promise形式返回ExtensionAbility信息。 | **示例：** @@ -1193,10 +1193,10 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------------- | ---------------------------------------- | ---- | ---------------------------------------- | -| want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 | +| want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | | extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：枚举值，大于等于0。 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。 | **示例：** @@ -1234,9 +1234,9 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------------- | ---------------------------------------- | ---- | ---------------------------------------- | -| want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 | +| want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | | extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。 | **示例：** @@ -1255,18 +1255,6 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { }) ``` -## ElementName - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 读写属性 | 类型 | 必填 | 描述 | -| ----------- | ---- | ------ | ---- | ---------------------------------------- | -| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 | -| bundleName | 只读 | string | 是 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | -| abilityName | 只读 | string | 是 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | -| uri | 只读 | string | 否 | 资源标识符。 | -| shortName | 只读 | string | 否 | ElementName的简名。 | - ## InstallErrorCode **系统能力:** SystemCapability.BundleManager.BundleFramework @@ -1326,181 +1314,6 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { | ------ | ------ | ---- | ---- | ---------------------------- | | userId | number | 是 | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | -## BundleInfo - -应用包的信息 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------------------- | ---------------------------- | ---- | ---- | --------------------- | -| name | string | 是 | 否 | 应用包的名称 | -| type | string | 是 | 否 | 应用包类型 | -| appId | string | 是 | 否 | 应用包里应用程序的id | -| uid | number | 是 | 否 | 应用包里应用程序的uid | -| installTime | number | 是 | 否 | HAP包安装时间 | -| updateTime | number | 是 | 否 | HAP包更新时间 | -| appInfo | ApplicationInfo | 是 | 否 | 应用程序的配置信息 | -| abilityInfos | Array\ | 是 | 否 | Ability的配置信息 | -| reqPermissions | Array\ | 是 | 否 | 应用运行时需向系统申请的权限集合 | -| reqPermissionDetails | Array\ | 是 | 否 | 应用运行时需向系统申请的权限集合的详细信息 | -| vendor | string | 是 | 否 | 应用包的供应商 | -| versionCode | number | 是 | 否 | 应用包的版本号 | -| versionName | string | 是 | 否 | 应用包的版本文本描述信息 | -| compatibleVersion | number | 是 | 否 | 运行应用包所需要最低的SDK版本号 | -| targetVersion | number | 是 | 否 | 运行应用包所需要最高SDK版本号 | -| isCompressNativeLibs | boolean | 是 | 否 | 是否压缩应用包的本地库，默认为true | -| hapModuleInfos | Array\ | 是 | 否 | 模块的配置信息 | -| entryModuleName | string | 是 | 否 | Entry的模块名称 | -| cpuAbi | string | 是 | 否 | 应用包的cpuAbi信息 | -| isSilentInstallation | string | 是 | 否 | 是否通过静默安装 | -| minCompatibleVersionCode | number | 是 | 否 | 分布式场景下的应用包兼容的最低版本 | -| entryInstallationFree | boolean | 是 | 否 | Entry是否支持免安装 | -| reqPermissionStates8+ | Array\ | 是 | 否 | 申请权限的授予状态 | -| extensionAbilityInfo9+ | Array\ | 是 | 否 | ability的可扩展信息 | - -## ApplicationInfo - -应用程序信息 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------------------------- | ---------------------------------- | ---- | ---- | --------------------- | -| name | string | 是 | 否 | 应用程序的名称 | -| description | string | 是 | 否 | 应用程序的描述 | -| descriptionId | number | 是 | 否 | 应用程序的描述id | -| systemApp | boolean | 是 | 否 | 判断是否为系统应用程序，默认为false | -| enabled | boolean | 是 | 否 | 判断应用程序是否可以使用，默认为true | -| label | string | 是 | 否 | 应用程序的标签 | -| labelId | string | 是 | 否 | 应用程序的标签id | -| icon | string | 是 | 否 | 应用程序的图标 | -| iconId | string | 是 | 否 | 应用程序的图标id | -| process | string | 是 | 否 | 应用程序的进程，如果不设置，默认为包的名称 | -| supportedModes | number | 是 | 否 | 应用程序支持的运行模式 | -| moduleSourceDirs | Array\ | 是 | 否 | 应用程序的资源存放的相对路径 | -| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限 | -| moduleInfos | Array\ | 是 | 否 | 应用程序的模块信息 | -| entryDir | string | 是 | 否 | 应用程序的文件保存路径 | -| codePath8+ | string | 是 | 否 | 应用程序的安装目录 | -| metaData8+ | Map> | 是 | 否 | 应用程序的自定义元信息 | -| metaData9+ | Map> | 是 | 否 | 应用程序的元信息 | -| removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除 | -| accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId | -| uid8+ | number | 是 | 否 | 应用程序的uid | -| entityType9+ | string | 是 | 否 | 应用程序的实体类型 | - -## ModuleInfo - -应用程序的模块信息 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------- | ------ | ---- | ---- | ---- | -| moduleName | string | 是 | 否 | 模块名称 | -| moduleSourceDir | string | 是 | 否 | 安装目录 | - -## CustomizeData - -自定义元数据 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------------ | ------ | ---- | ---- | -------- | -| name | string | 是 | 是 | 自定义元数据名称 | -| value | string | 是 | 是 | 自定义元数据值 | -| extra8+ | string | 是 | 是 | 自定义资源 | - - -## HapModuleInfo - -Hap模块信息 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------------------- | ---------------------------- | ---- | ---- | ------------------ | -| name | string | 是 | 否 | 模块名称 | -| description | string | 是 | 否 | 模块描述信息 | -| descriptionId | number | 是 | 否 | 描述信息ID | -| icon | string | 是 | 否 | 模块图标 | -| label | string | 是 | 否 | 模块标签 | -| labelId | number | 是 | 否 | 模块标签ID | -| iconId | number | 是 | 否 | 模块图标ID | -| backgroundImg | string | 是 | 否 | 模块背景图片 | -| supportedModes | number | 是 | 否 | 模块支持的模式 | -| reqCapabilities | Array\ | 是 | 否 | 模块运行需要的能力 | -| deviceTypes | Array\ | 是 | 否 | 支持运行的设备类型 | -| abilityInfo | Array\ | 是 | 否 | Ability信息 | -| moduleName | string | 是 | 否 | 模块名 | -| mainAbilityName | string | 是 | 否 | 入口Ability名称 | -| installationFree | boolean | 是 | 否 | 是否支持免安装 | -| mainElementName9+ | string | 是 | 否 | 入口ability信息 | -| extensionAbilityInfo9+ | Array\ | 是 | 否 | extensionAbility信息 | -| metadata9+ | Array\ | 是 | 否 | Ability的元信息 | - -## ReqPermissionDetail - -应用运行时需向系统申请的权限集合的详细信息 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------- | --------- | ---- | ---- | ---------- | -| name | string | 是 | 是 | 需要使用的权限名称 | -| reason | string | 是 | 是 | 描述申请权限的原因 | -| usedScene | UsedScene | 是 | 是 | 权限使用的场景和时机 | - -## UsedScene - -描述权限使用的场景和时机 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------- | -------------- | ---- | ---- | ---------------- | -| abilities | Array\ | 是 | 是 | 使用到该权限的Ability集合 | -| when | string | 是 | 是 | 使用该权限的时机 | - - -## AbilityInfo - -Ability信息 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------- | --------------------- | ---- | ---- | ------------------------ | -| bundleName | string | 是 | 否 | 应用包名 | -| name | string | 是 | 否 | Ability名称 | -| label | string | 是 | 否 | Ability对用户显示的名称 | -| description | string | 是 | 否 | Ability的描述 | -| icon | string | 是 | 否 | Ability的图标资源文件索引 | -| descriptionId | number | 是 | 否 | Ability的描述id | -| iconId | number | 是 | 否 | Ability的图标id | -| moduleName | string | 是 | 否 | Ability所属的HAP包的名称 | -| process | string | 是 | 否 | Ability的进程，如果不设置，默认为包的名称 | -| targetAbility | string | 是 | 否 | 当前Ability重用的目标Ability | -| backgroundModes | number | 是 | 否 | 表示后台服务的类型 | -| isVisible | boolean | 是 | 否 | 判断Ability是否可以被其他应用调用 | -| formEnabled | boolean | 是 | 否 | 判断Ability是否提供卡片能力 | -| type | AbilityType | 是 | 否 | Ability类型 | -| orientation | DisplayOrientation | 是 | 否 | Ability的显示模式 | -| launchMode | LaunchMode | 是 | 否 | Ability的启动模式 | -| permissions | Array\ | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合 | -| deviceTypes | Array\ | 是 | 否 | Ability支持的设备类型 | -| deviceCapabilities | Array\ | 是 | 否 | Ability需要的设备能力 | -| readPermission | string | 是 | 否 | 读取Ability数据所需的权限 | -| writePermission | string | 是 | 否 | 向Ability写数据所需的权限 | -| applicationInfo | ApplicationInfo | 是 | 否 | 应用程序的配置信息 | -| uri | string | 是 | 否 | 获取Ability的统一资源标识符（URI） | -| labelId | number | 是 | 否 | Ability的标签id | -| subType | AbilitySubType | 是 | 否 | Ability中枚举使用的模板的子类型 | -| metaData8+ | Array\ | 是 | 否 | ability的自定义信息 | -| metaData9+ | Array\ | 是 | 否 | ability的元信息 | -| enabled8+ | boolean | 是 | 否 | ability是否可用 | ## AbilityType @@ -1550,7 +1363,6 @@ Ability的子类型 | UNSPECIFIED | 0 | 未定义Ability子类型 | | CA | 1 | Ability子类型是带有 UI 的服务 | - ## ExtensionAbilityType9+ ExtensionAbility的类型 @@ -1583,7 +1395,6 @@ ExtensionAbility的类型 | GET_EXTENSION_INFO_WITH_APPLICATION9+ | 0x00000004 | 获取携带应用信息的extensionAbilityInfo | | GET_EXTENSION_INFO_WITH_METADATA9+ | 0x00000020 | 获取携带元数据信息的extensionAbilityInfo | - ## ColorMode 颜色模式 @@ -1596,7 +1407,6 @@ ExtensionAbility的类型 | DARK_MODE | 0 | 黑色模式 | | LIGHT_MODE | 1 | 亮度模式 | - ## GrantStatus 授予状态 @@ -1608,39 +1418,3 @@ ExtensionAbility的类型 | PERMISSION_DENIED | -1 | 拒绝许可 | | PERMISSION_GRANTED | 0 | 批准 | - -## ExtensionAbilityInfo9+ - -ExtensionAbility信息 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------------------- | --------------------------- | ---- | ---- | --------------------------------- | -| bundleName9+ | string | 是 | 否 | 应用包名 | -| moduleName9+ | string | 是 | 否 | ExtensionAbility所属的HAP包的名称 | -| name9+ | string | 是 | 否 | ExtensionAbility名称 | -| labelId9+ | number | 是 | 否 | ExtensionAbility的标签id | -| descriptionId9+ | number | 是 | 否 | ExtensionAbility的描述id | -| iconId9+ | number | 是 | 否 | ExtensionAbility的图标id | -| isVisible9+ | boolean | 是 | 否 | 判断ExtensionAbility是否可以被其他应用调用 | -| extensionAbilityType9+ | bundle.ExtensionAbilityType | 是 | 否 | ExtensionAbility类型 | -| permissions9+ | Array\ | 是 | 否 | 被其他应用ExtensionAbility调用时需要申请的权限集合 | -| applicationInfo9+ | ApplicationInfo | 是 | 否 | 应用程序的配置信息 | -| metaData9+ | Array\ | 是 | 否 | ExtensionAbility的元信息 | -| enabled9+ | boolean | 是 | 否 | ExtensionAbility是否可用 | -| readPermission9+ | string | 是 | 否 | 读取ExtensionAbility数据所需的权限 | -| writePermission9+ | string | 是 | 否 | 向ExtensionAbility写数据所需的权限 | - - -## Metadata9+ - -元数据信息 - - **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------- | ------ | ---- | ---- | ----- | -| name9+ | string | 是 | 是 | 元数据名称 | -| value9+ | string | 是 | 是 | 元数据值 | -| resource9+ | string | 是 | 是 | 元数据资源 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..06f7f5120a4024c639a2a8ab0fd6df0a400ba527 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md @@ -0,0 +1,40 @@ +## AbilityInfo + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> API9 当前为Canary版本，仅供试用，不保证接口可稳定调用。 + +Ability信息 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------- | --------------------- | ---- | ---- | ------------------------ | +| bundleName | string | 是 | 否 | 应用包名 | +| name | string | 是 | 否 | Ability名称 | +| label | string | 是 | 否 | Ability对用户显示的名称 | +| description | string | 是 | 否 | Ability的描述 | +| icon | string | 是 | 否 | Ability的图标资源文件索引 | +| descriptionId | number | 是 | 否 | Ability的描述id | +| iconId | number | 是 | 否 | Ability的图标id | +| moduleName | string | 是 | 否 | Ability所属的HAP包的名称 | +| process | string | 是 | 否 | Ability的进程，如果不设置，默认为包的名称 | +| targetAbility | string | 是 | 否 | 当前Ability重用的目标Ability | +| backgroundModes | number | 是 | 否 | 表示后台服务的类型 | +| isVisible | boolean | 是 | 否 | 判断Ability是否可以被其他应用调用 | +| formEnabled | boolean | 是 | 否 | 判断Ability是否提供卡片能力 | +| type | AbilityType | 是 | 否 | Ability类型 | +| orientation | DisplayOrientation | 是 | 否 | Ability的显示模式 | +| launchMode | LaunchMode | 是 | 否 | Ability的启动模式 | +| permissions | Array\ | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合 | +| deviceTypes | Array\ | 是 | 否 | Ability支持的设备类型 | +| deviceCapabilities | Array\ | 是 | 否 | Ability需要的设备能力 | +| readPermission | string | 是 | 否 | 读取Ability数据所需的权限 | +| writePermission | string | 是 | 否 | 向Ability写数据所需的权限 | +| applicationInfo | ApplicationInfo | 是 | 否 | 应用程序的配置信息 | +| uri | string | 是 | 否 | 获取Ability的统一资源标识符（URI） | +| labelId | number | 是 | 否 | Ability的标签id | +| subType | AbilitySubType | 是 | 否 | Ability中枚举使用的模板的子类型 | +| metaData8+ | Array\<[CustomizeData](js-apis-bundle-CustomizeData.md)> | 是 | 否 | ability的自定义信息 | +| metaData9+ | Array\<[Metadata](js-apis-bundle-Metadata.md)> | 是 | 否 | ability的元信息 | +| enabled8+ | boolean | 是 | 否 | ability是否可用 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..e41a3b533c0e11f790cb3ceff4bf42a79005fa67 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md @@ -0,0 +1,34 @@ +## ApplicationInfo + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> API9 当前为Canary版本，仅供试用，不保证接口可稳定调用。 + +应用程序信息 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------------------------- | ---------------------------------- | ---- | ---- | --------------------- | +| name | string | 是 | 否 | 应用程序的名称 | +| description | string | 是 | 否 | 应用程序的描述 | +| descriptionId | number | 是 | 否 | 应用程序的描述id | +| systemApp | boolean | 是 | 否 | 判断是否为系统应用程序，默认为false | +| enabled | boolean | 是 | 否 | 判断应用程序是否可以使用，默认为true | +| label | string | 是 | 否 | 应用程序的标签 | +| labelId | string | 是 | 否 | 应用程序的标签id | +| icon | string | 是 | 否 | 应用程序的图标 | +| iconId | string | 是 | 否 | 应用程序的图标id | +| process | string | 是 | 否 | 应用程序的进程，如果不设置，默认为包的名称 | +| supportedModes | number | 是 | 否 | 应用程序支持的运行模式 | +| moduleSourceDirs | Array\ | 是 | 否 | 应用程序的资源存放的相对路径 | +| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限 | +| moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | 是 | 否 | 应用程序的模块信息 | +| entryDir | string | 是 | 否 | 应用程序的文件保存路径 | +| codePath8+ | string | 是 | 否 | 应用程序的安装目录 | +| metaData8+ | Map\> | 是 | 否 | 应用程序的自定义元信息 | +| metaData9+ | Map\> | 是 | 否 | 应用程序的元信息 | +| removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除 | +| accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId | +| uid8+ | number | 是 | 否 | 应用程序的uid | +| entityType9+ | string | 是 | 否 | 应用程序的实体类型 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..128c1a5c8e133fabddbeb8db8c0068d09c6a1207 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md @@ -0,0 +1,59 @@ +## BundleInfo + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> API9 当前为Canary版本，仅供试用，不保证接口可稳定调用。 + +应用包的信息 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------------------- | ---------------------------- | ---- | ---- | --------------------- | +| name | string | 是 | 否 | 应用包的名称 | +| type | string | 是 | 否 | 应用包类型 | +| appId | string | 是 | 否 | 应用包里应用程序的id | +| uid | number | 是 | 否 | 应用包里应用程序的uid | +| installTime | number | 是 | 否 | HAP包安装时间 | +| updateTime | number | 是 | 否 | HAP包更新时间 | +| appInfo | ApplicationInfo | 是 | 否 | 应用程序的配置信息 | +| abilityInfos | Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 否 | Ability的配置信息 | +| reqPermissions | Array\ | 是 | 否 | 应用运行时需向系统申请的权限集合 | +| reqPermissionDetails | Array\<[ReqPermissionDetail](#reqpermissiondetail)> | 是 | 否 | 应用运行时需向系统申请的权限集合的详细信息 | +| vendor | string | 是 | 否 | 应用包的供应商 | +| versionCode | number | 是 | 否 | 应用包的版本号 | +| versionName | string | 是 | 否 | 应用包的版本文本描述信息 | +| compatibleVersion | number | 是 | 否 | 运行应用包所需要最低的SDK版本号 | +| targetVersion | number | 是 | 否 | 运行应用包所需要最高SDK版本号 | +| isCompressNativeLibs | boolean | 是 | 否 | 是否压缩应用包的本地库，默认为true | +| hapModuleInfos | Array\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是 | 否 | 模块的配置信息 | +| entryModuleName | string | 是 | 否 | Entry的模块名称 | +| cpuAbi | string | 是 | 否 | 应用包的cpuAbi信息 | +| isSilentInstallation | string | 是 | 否 | 是否通过静默安装 | +| minCompatibleVersionCode | number | 是 | 否 | 分布式场景下的应用包兼容的最低版本 | +| entryInstallationFree | boolean | 是 | 否 | Entry是否支持免安装 | +| reqPermissionStates8+ | Array\ | 是 | 否 | 申请权限的授予状态 | +| extensionAbilityInfo9+ | Array\<[ExtensionAbilityInfo](js-apis-bundle-ExtensionAbilityInfo.md)> | 是 | 否 | ability的可扩展信息 | + +## ReqPermissionDetail + +应用运行时需向系统申请的权限集合的详细信息 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------- | --------- | ---- | ---- | ---------- | +| name | string | 是 | 是 | 需要使用的权限名称 | +| reason | string | 是 | 是 | 描述申请权限的原因 | +| usedScene | [UsedScene](#usedscene) | 是 | 是 | 权限使用的场景和时机 | + +## UsedScene + +描述权限使用的场景和时机 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------- | -------------- | ---- | ---- | ---------------- | +| abilities | Array\ | 是 | 是 | 使用到该权限的Ability集合 | +| when | string | 是 | 是 | 使用该权限的时机 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md new file mode 100644 index 0000000000000000000000000000000000000000..4311375a6c8f0fc03e74202cb4c3fbd7e1e35779 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md @@ -0,0 +1,14 @@ +## CustomizeData + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +自定义元数据 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------ | ------ | ---- | ---- | -------- | +| name | string | 是 | 是 | 自定义元数据名称 | +| value | string | 是 | 是 | 自定义元数据值 | +| extra8+ | string | 是 | 是 | 自定义资源 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..8c48d7c2a85516be22d089d723d80794e50f41eb --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md @@ -0,0 +1,26 @@ +## ExtensionAbilityInfo + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> API9 当前为Canary版本，仅供试用，不保证接口可稳定调用。 + +ExtensionAbility信息 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------------------- | --------------------------- | ---- | ---- | --------------------------------- | +| bundleName | string | 是 | 否 | 应用包名 | +| moduleName | string | 是 | 否 | ExtensionAbility所属的HAP包的名称 | +| name | string | 是 | 否 | ExtensionAbility名称 | +| labelId | number | 是 | 否 | ExtensionAbility的标签id | +| descriptionId | number | 是 | 否 | ExtensionAbility的描述id | +| iconId | number | 是 | 否 | ExtensionAbility的图标id | +| isVisible | boolean | 是 | 否 | 判断ExtensionAbility是否可以被其他应用调用 | +| extensionAbilityType | bundle.ExtensionAbilityType | 是 | 否 | ExtensionAbility类型 | +| permissionsp> | Array\ | 是 | 否 | 被其他应用ExtensionAbility调用时需要申请的权限集合 | +| applicationInfo | ApplicationInfo | 是 | 否 | 应用程序的配置信息 | +| metaData | Array\<[Metadata](js-apis-bundle-Metadata.md)> | 是 | 否 | ExtensionAbility的元信息 | +| enabled | boolean | 是 | 否 | ExtensionAbility是否可用 | +| readPermission | string | 是 | 否 | 读取ExtensionAbility数据所需的权限 | +| writePermission | string | 是 | 否 | 向ExtensionAbility写数据所需的权限 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..0a1e2c6d65ddc08492e896afb704be9448411b49 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md @@ -0,0 +1,30 @@ +## HapModuleInfo + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> API9 当前为Canary版本，仅供试用，不保证接口可稳定调用。 + +Hap模块信息 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------------------- | ---------------------------- | ---- | ---- | ------------------ | +| name | string | 是 | 否 | 模块名称 | +| description | string | 是 | 否 | 模块描述信息 | +| descriptionId | number | 是 | 否 | 描述信息ID | +| icon | string | 是 | 否 | 模块图标 | +| label | string | 是 | 否 | 模块标签 | +| labelId | number | 是 | 否 | 模块标签ID | +| iconId | number | 是 | 否 | 模块图标ID | +| backgroundImg | string | 是 | 否 | 模块背景图片 | +| supportedModes | number | 是 | 否 | 模块支持的模式 | +| reqCapabilities | Array\ | 是 | 否 | 模块运行需要的能力 | +| deviceTypes | Array\ | 是 | 否 | 支持运行的设备类型 | +| abilityInfo | Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 否 | Ability信息 | +| moduleName | string | 是 | 否 | 模块名 | +| mainAbilityName | string | 是 | 否 | 入口Ability名称 | +| installationFree | boolean | 是 | 否 | 是否支持免安装 | +| mainElementName9+ | string | 是 | 否 | 入口ability信息 | +| extensionAbilityInfo9+ | Array\<[ExtensionAbilityInfo](js-apis-bundle-ExtensionAbilityInfo.md)> | 是 | 否 | extensionAbility信息 | +| metadata9+ | Array\<[Metadata](js-apis-bundle-Metadata.md)> | 是 | 否 | Ability的元信息 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-Metadata.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-Metadata.md new file mode 100644 index 0000000000000000000000000000000000000000..c73dc68cc292ea7554aa8f716fbf61b89312cf56 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-Metadata.md @@ -0,0 +1,15 @@ +## Metadata + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> API9 当前为Canary版本，仅供试用，不保证接口可稳定调用。 + +元数据信息 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------- | ------ | ---- | ---- | ----- | +| name | string | 是 | 是 | 元数据名称 | +| value | string | 是 | 是 | 元数据值 | +| resource | string | 是 | 是 | 元数据资源 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..8aeebc5b3a6417a6c8b1965815ef880af22bafa1 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md @@ -0,0 +1,13 @@ +## ModuleInfo + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +应用程序的模块信息 + + **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------- | ------ | ---- | ---- | ---- | +| moduleName | string | 是 | 否 | 模块名称 | +| moduleSourceDir | string | 是 | 否 | 安装目录 |