Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
58edb731
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
58edb731
编写于
5月 23, 2022
作者:
J
junyi233
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
完善md文档
Signed-off-by:
N
junyi233
<
zhengjun29@huawei.com
>
上级
a48d5699
变更
9
展开全部
隐藏空白更改
内联
并排
Showing
9 changed file
with
333 addition
and
273 deletion
+333
-273
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
+45
-273
zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md
...lication-dev/reference/apis/js-apis-bundle-AbilityInfo.md
+45
-0
zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md
...tion-dev/reference/apis/js-apis-bundle-ApplicationInfo.md
+41
-0
zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md
...plication-dev/reference/apis/js-apis-bundle-BundleInfo.md
+69
-0
zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md
...cation-dev/reference/apis/js-apis-bundle-CustomizeData.md
+22
-0
zh-cn/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md
...dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md
+31
-0
zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md
...cation-dev/reference/apis/js-apis-bundle-HapModuleInfo.md
+37
-0
zh-cn/application-dev/reference/apis/js-apis-bundle-Metadata.md
...application-dev/reference/apis/js-apis-bundle-Metadata.md
+22
-0
zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md
...plication-dev/reference/apis/js-apis-bundle-ModuleInfo.md
+21
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
浏览文件 @
58edb731
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md
0 → 100644
浏览文件 @
58edb731
# AbilityInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
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
\<
string> | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合 |
| deviceTypes | Array
\<
string> | 是 | 否 | Ability支持的设备类型 |
| deviceCapabilities | Array
\<
string> | 是 | 否 | Ability需要的设备能力 |
| readPermission | string | 是 | 否 | 读取Ability数据所需的权限 |
| writePermission | string | 是 | 否 | 向Ability写数据所需的权限 |
| applicationInfo |
[
ApplicationInfo
](
js-apis-bundle-ApplicationInfo.md
)
| 是 | 否 | 应用程序的配置信息 |
| uri | string | 是 | 否 | 获取Ability的统一资源标识符(URI) |
| labelId | number | 是 | 否 | Ability的标签id |
| subType | AbilitySubType | 是 | 否 | Ability中枚举使用的模板的子类型 |
| metaData
<sup>
8+
</sup>
| Array
\<
[
CustomizeData
](
js-apis-bundle-CustomizeData.md
)
> | 是 | 否 | ability的自定义信息 |
| metaData
<sup>
9+
</sup>
| Array
\<
[
Metadata
](
js-apis-bundle-Metadata.md
)
> | 是 | 否 | ability的元信息 |
| enabled
<sup>
8+
</sup>
| boolean | 是 | 否 | ability是否可用 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md
0 → 100644
浏览文件 @
58edb731
# ApplicationInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
应用程序信息
**系统能力**
: 以下各项对应的系统能力均为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
\<
string> | 是 | 否 | 应用程序的资源存放的相对路径 |
| permissions | Array
\<
string> | 是 | 否 | 访问应用程序所需的权限 |
| moduleInfos | Array
\<
[
ModuleInfo
](
js-apis-bundle-ModuleInfo.md
)
> | 是 | 否 | 应用程序的模块信息 |
| entryDir | string | 是 | 否 | 应用程序的文件保存路径 |
| codePath
<sup>
8+
</sup>
| string | 是 | 否 | 应用程序的安装目录 |
| metaData
<sup>
8+
</sup>
| Map
\<
string, Array
\<
[
CustomizeData
](
js-apis-bundle-CustomizeData.md
)
>> | 是 | 否 | 应用程序的自定义元信息 |
| metaData
<sup>
9+
</sup>
| Map
\<
string, Array
\<
[
Metadata
](
js-apis-bundle-Metadata.md
)
>> | 是 | 否 | 应用程序的元信息 |
| removable
<sup>
8+
</sup>
| boolean | 是 | 否 | 应用程序是否可以被移除 |
| accessTokenId
<sup>
8+
</sup>
| number | 是 | 否 | 应用程序的accessTokenId |
| uid
<sup>
8+
</sup>
| number | 是 | 否 | 应用程序的uid |
| entityType
<sup>
9+
</sup>
| string | 是 | 否 | 应用程序的实体类型 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md
0 → 100644
浏览文件 @
58edb731
# BundleInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
应用包的信息
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------ |
| name | string | 是 | 否 | 应用包的名称 |
| type | string | 是 | 否 | 应用包类型 |
| appId | string | 是 | 否 | 应用包里应用程序的id |
| uid | number | 是 | 否 | 应用包里应用程序的uid |
| installTime | number | 是 | 否 | HAP包安装时间 |
| updateTime | number | 是 | 否 | HAP包更新时间 |
| appInfo |
[
ApplicationInfo
](
js-apis-bundle-ApplicationInfo.md
)
| 是 | 否 | 应用程序的配置信息 |
| abilityInfos | Array
\<
[
AbilityInfo
](
js-apis-bundle-AbilityInfo.md
)
> | 是 | 否 | Ability的配置信息 |
| reqPermissions | Array
\<
string> | 是 | 否 | 应用运行时需向系统申请的权限集合 |
| 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是否支持免安装 |
| reqPermissionStates
<sup>
8+
</sup>
| Array
\<
number> | 是 | 否 | 申请权限的授予状态 |
| extensionAbilityInfo
<sup>
9+
</sup>
| Array
\<
[
ExtensionAbilityInfo
](
js-apis-bundle-ExtensionAbilityInfo.md
)
> | 是 | 否 | ability的可扩展信息 |
## ReqPermissionDetail
应用运行时需向系统申请的权限集合的详细信息
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------------- | ----------------------- | ---- | ---- | -------------------- |
| name | string | 是 | 是 | 需要使用的权限名称 |
| reason | string | 是 | 是 | 描述申请权限的原因 |
| reasonId
<sup>
9+
</sup>
| number | 是 | 是 | 描述申请权限的原因ID |
| usedScene |
[
UsedScene
](
#UsedScene
)
| 是 | 是 | 权限使用的场景和时机 |
## UsedScene
描述权限使用的场景和时机
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | -------------- | ---- | ---- | ------------------------- |
| abilities | Array
\<
string> | 是 | 是 | 使用到该权限的Ability集合 |
| when | string | 是 | 是 | 使用该权限的时机 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md
0 → 100644
浏览文件 @
58edb731
# CustomizeData
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
自定义元数据
**系统能力**
: 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | ------ | ---- | ---- | ---------------- |
| name | string | 是 | 是 | 自定义元数据名称 |
| value | string | 是 | 是 | 自定义元数据值 |
| extra
<sup>
8+
</sup>
| string | 是 | 是 | 自定义资源 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md
0 → 100644
浏览文件 @
58edb731
# ExtensionAbilityInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
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类型 |
| permissions | Array
\<
string> | 是 | 否 | 被其他应用ExtensionAbility调用时需要申请的权限集合 |
| applicationInfo |
[
ApplicationInfo
](
js-apis-bundle-ApplicationInfo.md
)
| 是 | 否 | 应用程序的配置信息 |
| metaData | Array
\<
[
Metadata
](
js-apis-bundle-Metadata.md
)
> | 是 | 否 | ExtensionAbility的元信息 |
| enabled | boolean | 是 | 否 | ExtensionAbility是否可用 |
| readPermission | string | 是 | 否 | 读取ExtensionAbility数据所需的权限 |
| writePermission | string | 是 | 否 | 向ExtensionAbility写数据所需的权限 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md
0 → 100644
浏览文件 @
58edb731
# HapModuleInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
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
\<
string> | 是 | 否 | 模块运行需要的能力 |
| deviceTypes | Array
\<
string> | 是 | 否 | 支持运行的设备类型 |
| abilityInfo | Array
\<
[
AbilityInfo
](
js-apis-bundle-AbilityInfo.md
)
> | 是 | 否 | Ability信息 |
| moduleName | string | 是 | 否 | 模块名 |
| mainAbilityName | string | 是 | 否 | 入口Ability名称 |
| installationFree | boolean | 是 | 否 | 是否支持免安装 |
| mainElementName
<sup>
9+
</sup>
| string | 是 | 否 | 入口ability信息 |
| extensionAbilityInfo
<sup>
9+
</sup>
| Array
\<
[
ExtensionAbilityInfo
](
js-apis-bundle-ExtensionAbilityInfo.md
)
> | 是 | 否 | extensionAbility信息 |
| metadata
<sup>
9+
</sup>
| Array
\<
[
Metadata
](
js-apis-bundle-Metadata.md
)
> | 是 | 否 | Ability的元信息 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-bundle-Metadata.md
0 → 100644
浏览文件 @
58edb731
# Metadata
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
元数据信息
**系统能力**
: 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | ------ | ---- | ---- | ---------- |
| name | string | 是 | 是 | 元数据名称 |
| value | string | 是 | 是 | 元数据值 |
| resource | string | 是 | 是 | 元数据资源 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md
0 → 100644
浏览文件 @
58edb731
# ModuleInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
应用程序的模块信息
**系统能力**
: 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------- | ------ | ---- | ---- | -------- |
| moduleName | string | 是 | 否 | 模块名称 |
| moduleSourceDir | string | 是 | 否 | 安装目录 |
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录