Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 71de8cab 编写于 作者: S SoftSquirrel
浏览文件
操作

Issue:#I5XZRW 

Description: optimize package-structure and stage-structure
Sig: SIG_ApplicaitonFramework
Feature or Bugfix: Feature
Binary Source: No
Signed-off-by: NSoftSquirrel <xuhao47@huawei.com>
上级 a82096b1
隐藏空白更改
内联 并排
Showing with 578 addition and 470 deletion
zh-cn/application-dev/quick-start/package-structure.md
浏览文件 @ 71de8cab
...@@ -92,9 +92,6 @@ app对象包含应用全局配置信息，内部结构说明参见表2。 ...@@ -92,9 +92,6 @@ app对象包含应用全局配置信息，内部结构说明参见表2。
| vendor | 标识对应用开发厂商的描述。字符串长度不超过255字节。 | 字符串 | 可缺省，缺省值为空 | | vendor | 标识对应用开发厂商的描述。字符串长度不超过255字节。 | 字符串 | 可缺省，缺省值为空 |
| version | 标识应用的版本信息。参考表3。 | 对象 | 否 | | version | 标识应用的版本信息。参考表3。 | 对象 | 否 |
| apiVersion | 标识应用程序所依赖的OpenHarmony API版本。参考表4。 | 对象 | 可缺省，缺省值为空 | | apiVersion | 标识应用程序所依赖的OpenHarmony API版本。参考表4。 | 对象 | 可缺省，缺省值为空 |
| singleton | 标识应用是否开启单例模式，仅支持系统应用，三方应用配置不生效。如果配置为true，在多用户场景下，该应用仍然单实例运行，不会随用户切换而变动,该字段从API8开始支持。 | 布尔值 | 可缺省，缺省值为false |
| removable | 标识应用是否可卸载，仅支持系统应用，三方应用配置不生效，该字段从API8开始支持。 | 布尔值 | 可缺省，缺省值为true |
| userDataClearable | 标识是否允许应用清除用户数据，仅支持系统应用，三方应用配置不生效，该字段从API8开始支持。 | 布尔值 | 可缺省，缺省值为true |
表3 version内部结构说明 表3 version内部结构说明
......
zh-cn/application-dev/quick-start/stage-structure.md
浏览文件 @ 71de8cab
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
# 应用包结构配置文件的说明 # 应用包结构配置文件的说明
在开发FA模型下的应用程序时，需要在config.json文件中对应用的包结构进行申明；同样的，在开发stage模型下的应用程序时，需要在module.json5和app.json配置文件中对应用的包结构进行声明。 在开发stage模型的应用程序时，需要在app.json5和module.json5配置文件中对应用的包结构进行声明。
## 配置文件内部结构 ## 配置文件内部结构
...@@ -12,18 +12,41 @@ ...@@ -12,18 +12,41 @@
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | -------- | ---------- | | -------- | ------------------------------------------------------------ | -------- | ---------- |
| app | 标识应用的全局配置信息。参考[app对象内部结构](#app对象内部结构)。 | 对象 | 否 | | app | 标识应用的全局配置信息。参考[app对象内部结构](#app对象内部结构)。 | 对象 | 不可缺省。 |
| module | 标识HAP包的配置信息。该标签下的配置只对当前HAP包生效。参考[module对象内部结构](#module对象内部结构)。 | 对象 | 否 | | module | 标识HAP包的配置信息。该标签下的配置只对当前HAP包生效。参考[module对象内部结构](#module对象内部结构)。 | 对象 | 不可缺省。 |
### app对象内部结构 ### app对象内部结构
app.json示例： 该标签为整个应用的属性，影响应用中所有HAP及组件。该标签的内部结构参见表2。
表2 app对象的内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ------------------------------ | ------------------------------------------------------------ | -------- | ------------------------------------------- |
| bundleName | 该标签标识应用的包名，用于标识应用的唯一性。标签的值命名规则 :<br /> 1）字符串以字母、数字、下划线和符号”.”组成；<br /> 2）以字母开头；<br /> 3）最小长度7字节，最大长度127个字节。<br /> 推荐采用反域名形式命名（如 :com.example.xxx，建议第一级为域名后缀com，第二级为厂商/个人名，第三级为应用名，也可以多级）。 | 字符串 | 不可缺省。 |
| debug | 该标签标识应用是否可调试。该标签由IDE编译构建时产生。 | 布尔值 | 可缺省，缺省值为false。 |
| icon | 该标签标识应用的图标，标签值为图标资源文件的索引。 | 字符串 | 不可缺省。 |
| label | 该标签标识应用的的名称，标签值为字符串资源的索引。 | 字符串 | 不可缺省。 |
| description | 该标签标识App的描述信息，标签值是是字符串类型或对描述内容的字符串资源索引。 | 字符串 | 可缺省，缺省值为空。 |
| vendor | 该标签是对应用开发厂商的描述。最大长度255字节。 | 字符串 | 可缺省，缺省值为空。 |
| versionCode | 该标签标识应用的版本号，该标签值为32位非负整数。此数字仅用于确定某个版本是否比另一个版本更新，数值越大表示版本越高。开发者可以将该值设置为任何正整数，但是必须确保应用的新版本都使用比旧版本更大的值。versionCode 值应小于2的31次方。 | 数值 | 不可缺省。 |
| versionName | 该标签标识版本号的文字描述，用于向用户展示。<br />该标签仅由数字和点构成，推荐采用“A.B.C.D”四段式的形式。四段式推荐的含义如下所示。<br/>第一段 :主版本号/Major，范围0-99，重大修改的版本，如实现新的大功能或重大变化。<br/>第二段 :次版本号/Minor，范围0-99，表示实现较突出的特点，如新功能添加和大问题修复。<br/>第三段 :特性版本号/Feature，范围0-99，标识规划的新版本特性。<br/>第四段 :修订版本号/Patch，范围0-999，表示维护版本，修复bug。 | 字符串 | 不可缺省。 |
| minCompatibleVersionCode | 该标签标识该app能够兼容的最低历史版本号，用于跨设备兼容性判断。 | 数值 | 可缺省。缺省值等于versionCode标签值。|
| minAPIVersion | 该标签标识应用运行需要的SDK的API最小版本。 | 数值 | 可缺省，缺省值为bundle-profile.json5中的compatibleSdkVersion。|
| targetAPIVersion | 该标签标识应用运行需要的API目标版本。 | 数值 | 可缺省，缺省值为bundle-profile.json5中的compileSdkVersion。|
| apiReleaseType | 该标签标识应用运行需要的API目标版本的类型，采用字符串类型表示。取值为“CanaryN”、“BetaN”或者“Release”，其中，N代表大于零的整数。<br />Canary :受限发布的版本。<br/>Beta :公开发布的Beta版本。<br/>Release :公开发布的正式版本。<br/>该字段由IDE读取当前使用的SDK的stage来生成。 | 字符串 | 可缺省，由IDE生成并覆盖。 |
| distributedNotificationEnabled | 该标签标记该应用是否开启分布式通知。 | 布尔值 | 可缺省，缺省值为true。 |
| entityType | 该标签标记该应用的类别，具体有 :游戏类(game)，影音类（media）、社交通信类（communication）、新闻类（news）、出行类（travel）、工具类（utility）、购物类（shopping）、教育类（education）、少儿类（kids）、商务类（business）、拍摄类（photography）。 | 字符串 | 可缺省，缺省值为"unspecified"。 |
| multiProjects | 标识当前工程是否支持多工程。 | 布尔值 | 可缺省，缺省值为false。 |
| 设备类型 | 该标签可以配置多个，表示具体设备上的特殊配置信息，具体的设备类型有："tablet"、"tv"、"wearable"、"car"、"default"，可包含的字段有：minAPIVersion、distributedNotificationEnabled。 | 对象 | 可缺省，缺省值使用app下面相关的字段。 |
app.json示例 ：
```json ```json
{ {
"app": { "app": {
"bundleName": "com.application.music", "bundleName": "bundleName",
"vendor": "application", "vendor": "vendorName",
"versionCode": 1, "versionCode": 1,
"versionName": "1.0", "versionName": "1.0",
"minCompatibleVersionCode": 1, "minCompatibleVersionCode": 1,
...@@ -32,76 +55,73 @@ app.json示例： ...@@ -32,76 +55,73 @@ app.json示例：
"apiReleaseType": "Release", "apiReleaseType": "Release",
"debug": false, "debug": false,
"icon": "$media:app_icon", "icon": "$media:app_icon",
"label": "$string:app_name", "label": "$string:app_label",
"description": "$string:description_application", "description": "$string:app_description",
"distributedNotificationEnabled": true, "distributedNotificationEnabled": true,
"entityType": "game", "entityType": "game",
"car": { "car": {
"apiCompatibleVersion": 8 "minAPIVersion": 8
} }
} }
} }
``` ```
该标签为整个应用的属性，影响应用中所有hap及组件。该标签的内部结构参见表2。 ### module对象内部结构
表2 app对象的内部结构说明 HAP包的配置信息，该标签下的配置只对当前HAP包生效。
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 表3 module对象内部结构说明
| ------------------------------ | ------------------------------------------------------------ | -------- | ------------------------------------------- |
| bundleName | 该标签标识应用的包名，用于标识应用的唯一性。该标签不可缺省。标签的值命名规则 :<br /> 1）字符串以字母、数字、下划线和符号”.”组成；<br /> 2）以字母开头；<br /> 3）最小长度7个字节，最大长度127个字节。<br /> 推荐采用反域名形式命名（如 :com.example.xxx，建议第一级为域名后缀com，第二级为厂商/个人名，第三级为应用名，也可以多级）。<br /> 其中，随系统源码编译的应用需命名为”com.ohos.xxx”形式， ohos标识OpenHarmony系统应用。 | 字符串 | 否 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| debug | 该标签标识应用是否可调试。 | 布尔值 | 该标签可以缺省，缺省为false。 | | -------------------- | ------------------------------------------------------------ | ---------- | ------------------------------------------------------------ |
| icon | 该标签标识应用的图标，标签值为资源文件的索引。 | 字符串 | 该标签不可缺省。 | | name | 该标签标识当前module的名字，module打包成HAP后，表示HAP的名称，标签值采用字符串表示（最大长度31字节），该名称在整个应用要唯一。 | 字符串 | 不可缺省。 |
| label | 该标签标识应用的的名称，标签值为资源文件的索引，以支持多语言。 | 字符串 | 该标签不可缺省。 | | type | 该标签标识当前Module的类型。类型有两种，分别是entry、feature。 | 字符串 | 不可缺省。 |
| description | 该标签标识App的描述信息，标签值是是字符串类型或对描述内容的资源索引，以支持多语言。 | 字符串 | 该标签可缺省，缺省值为空。 | | srcEntrance | 该标签标识HAP所对应的入口js代码路径，标签值为字符串（最大长度127字节）。 | 字符串 | 可缺省。缺省值为空。 |
| vendor | 该标签是对应用开发厂商的描述。该标签的值是字符串类型（最大255个字节）。 | 字符串 | 该标签可以缺省，缺省为空。 | | description | 该标签标识HAP包的描述信息，标签值是是字符串类型或对描述内容的字符串资源索引。 | 字符串 | 可缺省，缺省值为空。 |
| versionCode | 该标签标识应用的版本号，该标签值为32位非负整数。此数字仅用于确定某个版本是否比另一个版本更新，数值越大表示版本越高。开发者可以将该值设置为任何正整数，但是必须确保应用的新版本都使用比旧版本更大的值。该标签不可缺省，versionCode 值应小于2的31方。 | 数值 | 该标签不可缺省 | | process | 该标签标识HAP的进程名，标签值为字符串类型（最大长度31字节）。如果在HAP标签下配置了process，该应用的所有ability都运行在该进程中。该标签只支持系统应用配置。 | 字符串 | 可缺省，缺省值为app标签下的bundleName。 |
| versionName | 该标签标识版本号的文字描述，用于向用户展示。<br />该标签仅由数字和点构成，推荐采用“A.B.C.D”四段式的形式。四段式推荐的含义如下所示。<br/>第一段 :主版本号/Major，范围0-99，重大修改的版本，如实现新的大功能或重大变化。<br/>第二段 :次版本号/Minor，范围0-99，表示实现较突出的特点，如新功能添加和大问题修复。<br/>第三段 :特性版本号/Feature，范围0-99，标识规划的新版本特性。<br/>第四段 :修订版本号/Patch，范围0-999，表示维护版本，修复bug。 | 字符串 | 该标签不可缺省 | | mainElement | 该标签标识HAP的入口Ability名称或者Extension名称。只有配置为mainElement的Ability或者Extension才允许在服务中心露出。 | 字符串 | 创建OpenHarmony原子化服务时，不可缺省。OpenHarmony应用下，可缺省。缺省值为空。 |
| minCompatibleVersionCode | 该标签标识该app能够兼容的最低历史版本号，用于跨设备兼容性判断。 | 数值 | 该标签可缺省。缺省值等于versionCode标签值。| | deviceTypes | 该标签标识HAP可以运行在哪类设备上，标签值采用字符串数组的表示，系统预定义的设备类型见表4。 | 字符串数组 | 不可缺省。 |
| minAPIVersion | 该标签标识应用运行需要的API最小版本。 | 整形 | 该标签可缺省，缺省值为bundle-profile.json5中的compatibleSdkVersion。| | deliveryWithInstall | 该标签标识当前HAP是否在用户主动安装的时候安装，true表示主动安装时安装，false表示主动安装时不安装。 | 布尔值 | 不可缺省。 |
| targetAPIVersion | 该标签标识应用运行需要的API目标版本。 | 整形 | 该标签可缺省，缺省值为bundle-profile.json5中的compileSdkVersion。| | installationFree | 标识当前HAP是否支持免安装特性。所有Hap包都需要配置不可缺省。<br/>true :表示支持免安装特性，且符合免安装约束。<br/>false :表示不支持免安装特性。<br/><br/>当entry.hap该字段配置为true时，与该entry.hap相关的所有feature.hap该字段也需要配置为true。<br/>当entry.hap该字段配置为false时，与该entry.hap相关的各feature.hap该字段可按业务需求配置true或false。 | 布尔值 | 不可缺省。 |
| apiReleaseType | 该标签标识应用运行需要的API目标版本的类型，采用字符串类型表示。取值为“CanaryN”、“BetaN”或者“Release”，其中，N代表大于零的整数。<br />Canary :受限发布的版本。<br/>Beta :公开发布的Beta版本。<br/>Release :公开发布的正式版本。 | 字符串 | 该标签可缺省，缺省为“Release”。 | | virtualMachine | 该标签用于标识当前HAP运行的目标虚拟机类型，供云端分发使用，如应用市场和分发中心。<br/>该标签值为字符串。如果目标虚拟机类型为方舟虚拟机，则其值为"ark + 版本号"。 该标签由IDE构建HAP的时候自动插入。 | 字符串 | 该标签由IDE构建HAP的时候自动插入。 |
| distributedNotificationEnabled | 该标签标记该应用是否开启分布式通知。 | 布尔值 | 该标签可缺省，缺省值为true。 | | uiSyntax(deprecated) | syntax定义该JS Component的语法类型。<br />hml标识该JS Component使用hml/css/js进行开发；<br/>ets标识该JS Component使用ets声明式语法进行开发。 | 字符串 | 可缺省，缺省值为hml，该字段从API9开始废弃。 |
| entityType | 该标签标记该应用的类别，具体有 :游戏类(game)，影音类（media）、社交通信类（communication）、新闻类（news）、出行类（travel）、工具类（utility）、购物类（shopping）、教育类（education）、少儿类（kids）、商务类（business）、拍摄类（photography）。 | 字符串 | 该标签可以缺省，缺省为unspecified。 | | pages | 该标签是一个profile资源，用于列举JS Component中每个页面信息。可以配置window标签定义与显示窗口相关的配置。window参考[window对象内部结构](#window对象内部结构)。 | 字符串 | 在有ability的场景下，不可缺省。 |
| singleton | 标识该应用开启单例模式，仅支持系统应用配置，三方应用配置不生效。配置为true时，在多用户场景下，该应用仍然单实例运行，不会随用户切换而变动。采用布尔类型，该字段从API8开始支持。 | 布尔值 | 可缺省，缺省值为false。 | | metadata | 该标签标识Hap的自定义元信息。参考[metadata对象内部结构](#metadata对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| removable | 标识应用是否可卸载，仅支持系统应用配置，三方应用配置不生效，该字段从API8开始支持。 | 布尔值 | 可缺省，缺省值为true。 | | abilities | 描述元能力的配置信息，该标签下的配置只对当前ability生效。参考[abilities对象内部结构](#abilities对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| keepAlive | 标识应用是否始终保持运行状态，仅支持系统应用配置，三方应用配置不生效。标签值为布尔类型，如果为true，应用将始终保持为运行状态，并且在系统启动的时候会被系统启动起来，应用进程退出后，系统也会重新启动该应用进程。 | 布尔值 | 可缺省，缺省值为false。 | | extensionAbilities | 描述extensionAbilities的配置信息，该标签下的配置只对当前extensionAbility生效。参考[extensionAbilities对象内部结构](#extensionabilities对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| userDataClearable | 标识是否允许应用清除用户数据，仅支持系统应用配置，三方应用配置不生效，该字段从API8开始支持。 | 布尔值 | 可缺省，缺省值为true。 | | definePermissions | 标识HAP定义的权限，仅支持系统应用配置，三方应用配置不生效。参考[definePermissions对象内部结构](#definepermissions对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| accessible | 标识应用的安装目录是否是可访问的，仅支持系统应用配置，三方应用配置不生效。配置为true表示安装目录可以被三方应用访问，false表示不能被三方应用访问。 | 布尔值 | 可缺省，缺省值为false。 | | requestPermissions | 该标签标识应用运行时需向系统申请的权限集合。参考[requestPermissions对象内部结构](#requestpermissions对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| multiProjects | 标识当前工程是否支持多工程。 | 布尔值 | 可缺省，缺省值为false。 | | testRunner | 该标签用于支持对测试框架的配置，参考[testRunner对象内部结构说明](#testrunner对象内部结构)。 | 对象 | 可缺省，缺省值为空。 |
| 设备类型 | 该标签可以配置多个，表示具体设备上的特殊配置信息，具体的设备类型有："tablet"、"tv"、"wearable"、"car"，可能包含的字段有：minAPIVersion、distributedNotificationEnabled、keepAlive、removable。 | 对象 | 该标签可缺省，缺省值使用app下面相关的字段。 |
### module对象内部结构
module.json5示例: module.json5示例:
```json ```json
{ {
"module": { "module": {
"name": "myHapName", "name": "moduleName",
"type": "entry|feature|har", "type": "entry",
"srcEntrance" : "./MyAbilityStage.js", "srcEntrance" : "./abilityStage.js",
"description" : "$string:description_application", "description" : "$string:description_application",
"mainElement": "MainAbility", "mainElement": "MainAbility",
"pages": "$profile:pages_config",
"deviceTypes": [ "deviceTypes": [
"tablet", "tablet",
"tv", "tv",
"wearable", "wearable",
"car", "car"
"router"
], ],
"deliveryWithInstall": true, "deliveryWithInstall": true,
"installationFree": false, "installationFree": false,
"virtualMachine": "ark | default",
"metadata": [ "metadata": [
{ {
"name": "string", "name": "name1",
"value": "string", "value": "value1",
"resource": "$profile:config_file1" "resource": "$profile:config_file1"
}, },
{ {
"name": "string", "name": "name2",
"value": "string", "value": "value2",
"resource": "$profile:config_file2" "resource": "$profile:config_file2"
} }
], ],
...@@ -111,7 +131,7 @@ module.json5示例: ...@@ -111,7 +131,7 @@ module.json5示例:
"srcEntrance" : "./login/MyMainAbility.ts", "srcEntrance" : "./login/MyMainAbility.ts",
"description": "$string:description_main_ability", "description": "$string:description_main_ability",
"icon": "$media:icon", "icon": "$media:icon",
"label": "HiMusic", "label": "$string:label",
"visible": true, "visible": true,
"skills": [ "skills": [
{ {
...@@ -121,7 +141,7 @@ module.json5示例: ...@@ -121,7 +141,7 @@ module.json5示例:
"entities": [ "entities": [
"entity.system.home" "entity.system.home"
], ],
"uris": [ ] "uris": []
} }
], ],
"backgroundModes": [ "backgroundModes": [
...@@ -143,7 +163,7 @@ module.json5示例: ...@@ -143,7 +163,7 @@ module.json5示例:
"srcEntrance" : "./login/sampleAbility.ts", "srcEntrance" : "./login/sampleAbility.ts",
"description": "$string:description_sample_ability", "description": "$string:description_sample_ability",
"icon": "$media:icon", "icon": "$media:icon",
"label": "HiMusic", "label": "$string:label",
"visible": true, "visible": true,
"startWindowIcon": "$media:icon", "startWindowIcon": "$media:icon",
"startWindowBackground": "$color:red" "startWindowBackground": "$color:red"
...@@ -151,7 +171,7 @@ module.json5示例: ...@@ -151,7 +171,7 @@ module.json5示例:
], ],
"requestPermissions": [ "requestPermissions": [
{ {
"name": "ohos.abilitydemo.permission.PROVIDER", "name": "permissionName",
"reason": "$string:reason", "reason": "$string:reason",
"usedScene": { "usedScene": {
"abilities": [ "abilities": [
...@@ -165,80 +185,76 @@ module.json5示例: ...@@ -165,80 +185,76 @@ module.json5示例:
} }
``` ```
hap包的配置信息，该标签下的配置只对当前hap包生效。 pages示例 ：
表3 module对象内部结构 1.在开发视图的resources/base/profile下面定义配置文件pages_config.json（文件名称可由开发者定义）：
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | ```json
| -------------------- | ------------------------------------------------------------ | ---------- | ------------------------------------------------------------ | {
| name | 该标签标识当前module的名字，module打包成hap后，表示hap的名称，标签值采用字符串表示（最大长度31个字节），该名称在整个应用要唯一。 | 字符串 | 该标签不可缺省。 | "src": [
| type | 该标签标识当前hap的类型。类型有三种，分别是entry、feature和har。 | 字符串 | 该标签不可缺省。 | "pages/index/index",
| srcEntrance | 该标签标识hap所对应的入口js代码路径，标签值为字符串（最长为127字节）。 | 字符串 | 该标签可缺省。 | "pages/second/second",
| description | 该标签标识hap包的描述信息，标签值是是字符串类型或对描述内容的资源索引，以支持多语言。 | 字符串 | 该标签可缺省，缺省值为空。 | "pages/third/third",
| process | 该标签标识hap的进程名，标签值为字符串类型（最长为31个字节）。如果在hap标签下配置了process，该应用的所有ability都运行在该进程中。该标签只支持系统应用配置。 | 字符串 | 可缺省，缺省为app标签下的bundleName。 | "pages/four/four"
| mainElement | 该标签标识hap的入口ability名称或者extension名称。只有配置为mainElement的ability或者extension才允许在服务中心露出。创建OpenHarmony原子化服务时，该标签不可缺省。 | 字符串 | OpenHarmony应用下，该标签可缺省。 | ],
| deviceTypes | 该标签标识hap可以运行在哪类设备上，标签值采用字符串数组的表示，系统预定义的设备类型见表4。<br />与syscap不同的是，deviceTypes是以设备类型为粒度，而syscap是以设备能力(例如蓝牙、wifi)为粒度。 | 字符串数组 | 该标签不可缺省，可以为空值。 | "window": {
| deliveryWithInstall | 该标签标识当前hap是否在用户主动安装的时候安装，true表示主动安装时安装，false表示主动安装时不安装。 | 布尔值 | 该标签不可缺省。 | "designWidth": 720,
| installationFree | 标识当前HAP是否支持免安装特性。所有Hap包都需要配置不可缺省。<br/>true :表示支持免安装特性，且符合免安装约束。<br/>false :表示不支持免安装特性。<br/><br/>当entry.hap该字段配置为true时，与该entry.hap相关的所有feature.hap该字段也需要配置为true。<br/>当entry.hap该字段配置为false时，与该entry.hap相关的各feature.hap该字段可按业务需求配置true或false。 | 布尔值 | 该标签不可缺省。 | "autoDesignWidth": false
| virtualMachine | 该标签用于标识当前hap运行的目标虚拟机类型，供云端分发使用，如应用市场和分发中心。<br/>该标签值为字符串。如果目标虚拟机类型为方舟虚拟机，则其值为”ark”； 如果目标虚拟机类型不是方舟虚拟机，则其值为”default”。该标签由IDE构建hap的时候自动插入。解包工具解析时，如果hap包没有该标签，设置该标签值为”default”。 | 字符串 | 该标签可缺省，缺省值为“default”。 | }
| uiSyntax(deprecated) | syntax定义该JS Component的语法类型。<br />hml标识该JS Component使用hml/css/js进行开发；<br/>ets标识该JS Component使用ets声明式语法进行开发。 | 字符串 | 该标签可缺省，默认值为hml，该字段从API9开始废弃。 | }
| pages | 该标签是一个profile资源，用于列举JS Component中每个页面信息。pages使用参考pages示例。 | 对象 | 在有ability的场景下，该标签不可缺省。 | ```
| metadata | 该标签标识Hap的自定义元信息，标签值为数组类型，该标签下的配置只对当前module、或者ability、或者extensionAbility生效。metadata参考[metadata对象内部结构](#metadata对象内部结构)。 | 数组 | 该标签可缺省，缺省值为空。 |
| abilities | 描述元能力的配置信息，标签值为数组类型，该标签下的配置只对当前ability生效。abilities参考[abilities对象内部结构](#abilities对象内部结构)。 | 对象 | 该标签可缺省，缺省值为空。 |
| extensionAbilities | 描述extensionAbilities的配置信息，标签值为数组类型，该标签下的配置只对当前extensionAbility生效。extensionAbilities参考[extensionAbility对象的内部结构说明](#extensionability对象的内部结构说明)。 | 对象 | 该标签可缺省，缺省值为空。 |
| definePermissions | 标识hap定义的权限，仅支持系统应用配置，三方应用配置不生效。该应用的调用者必须申请这些权限才能正常调用该应用。definePermissions参考[definePermissions对象内部结构](#definepermissions对象内部结构) | 对象 | 该标签可缺省，缺省值为空，表示调用者无需任何权限即可调用该应用。 |
| requestPermissions | 该标签标识应用运行时需向系统申请的权限集合，标签值为数组类型。requestPermissions参考[requestPermissions对象内部结构](#requestpermissions对象内部结构)。 | 对象 | 该标签可缺省，缺省值为空。 |
| testRunner | 此标签用于支持对测试框架的配置，参考[testRunner对象内部结构说明](#testrunner对象内部结构)说明。 | 对象 | 可缺省，缺省值为空 |
表4 deviceTypes对象的系统预定义设备
| 中文 | 英文 | 枚举值 | 设备类型 |
| -------- | ----------- | -------- | -------------------------------------------------------- |
| 平板 | tablet | tablet | 平板，带屏音箱 |
| 智慧屏 | smart TV | tv | 智慧屏 |
| 智能手表 | smart watch | wearable | 智能手表，儿童手表，特指资源较丰富的的手表，具备电话功能 |
| 车机 | head unit | car | 车机 |
| 路由器 | router | router | 路由器 |
deviceTypes示例 : 2.在module.json5的module标签下定义pages信息 ：
```json ```json
{ {
"module": { "module": {
"name": "myHapName", "pages": "$profile:pages_config"
"type": "har",
"deviceTypes" : [
"wearable"
]
} }
} }
``` ```
pages示例 : 表4 deviceTypes对象的系统预定义设备
| 设备类型 | 枚举值 | 说明 |
| -------- | ----------- | -------- |
| 平板 | tablet | - |
| 智慧屏 | tv | - |
| 智能手表 | wearable | 系统能力较丰富的的手表，具备电话功能。 |
| 车机 | car | - |
| 默认设备 | default | 能够使用全部系统能力的OpenHarmony设备。 |
deviceTypes示例 ：
```json ```json
{ {
"module": { "module": {
"name": "myHapName",
"type": "har",
"deviceTypes" : [ "deviceTypes" : [
"wearable" "wearable"
], ]
"pages": "$profile:pages_config"
} }
} }
``` ```
pages_config配置文件 #### window对象内部结构
定义与显示窗口相关的配置。
表5 window对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | -------- | -------------------------- |
| designWidth | 定义页面设计基准宽度，根据实际设备宽度来缩放元素大小。 | 数值 | 可缺省，缺省值为750。 |
| autoDesignWidth | 定义页面设计基准宽度是否自动计算，当设置为true时，designWidth将被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。 | 布尔值 | 可缺省，缺省值为false。 |
window示例 :
```json ```json
{ {
"src": [ "window": {
"pages/index/index", "designWidth": 720,
"pages/second/second", "autoDesignWidth": false
"pages/third/third", }
"pages/four/four"
]
} }
``` ```
...@@ -248,112 +264,32 @@ pages_config配置文件 ...@@ -248,112 +264,32 @@ pages_config配置文件
描述的module、ability、extensionAbility配置信息，标签值为数组类型，该标签下的配置只对当前module、或者ability、或者extensionAbility生效。 描述的module、ability、extensionAbility配置信息，标签值为数组类型，该标签下的配置只对当前module、或者ability、或者extensionAbility生效。
表5 metadata对象内部结构说明 表6 metadata对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | -------- | -------------------------- | | -------- | ------------------------------------------------------------ | -------- | -------------------------- |
| name | 该标签标识数据项的键名称，字符串类型（最大长度255字节）。 | 字符串 | 该标签可缺省，缺省值为空。 | | name | 该标签标识数据项的键名称，最大长度255字节。 | 字符串 | 可缺省，缺省值为空。 |
| value | 该标签标识数据项的值，标签值为字符串（最大长度255字节）。 | 字符串 | 可缺省，缺省为空。 | | value | 该标签标识数据项的值，最大长度255字节。 | 字符串 | 可缺省，缺省值为空。 |
| resource | 该标签标识定义用户自定义数据格式，标签值为标识该数据的资源的索引值。 | 字符串 | 可缺省，缺省为空。 | | resource | 该标签标识定义用户自定义数据格式，标签值为标识该数据的资源的索引值。 | 字符串 | 可缺省，缺省值为空。 |
metadata示例 : metadata示例 ：
```json ```json
{ {
"module": { "module": {
"metadata": [ "metadata": [
{ {
"name": "string", "name": "name1",
"value": "string", "value": "value1",
"resource": "$profile:config_file" "resource": "$profile:config_file1"
}, },
{ {
"name": "string", "name": "name2",
"value": "string", "value": "value2",
"resource": "$profile:config_file" "resource": "$profile:config_file2"
} }
]
}
}
```
#### abilities对象内部结构
abilities描述ability的配置信息，标签值为数组类型。
表6 abilities对象内部结构说明
| 属性 | 含义 | 数据类型 | 是否可缺省 |
| --------------- | ------------------------------------------------------------ | ---------- | ------------------------------------------------------------ |
| name | 该标签标识当前ability的逻辑名，该名称在整个应用要唯一，标签值采用字符串表示（最大长度127个字节）。 | 字符串 | 该标签不可缺省。 |
| srcEntrance | 该标签标识ability所对应的js代码路径，标签值为字符串（最长为127字节）。。 | 字符串 | 该标签不可缺省。 |
| launchType | 该标签标示ability的启动模式，标签值可选“standard”、“singleton”、“specified”。该标签缺省为"singleton"。standard表示普通多实例，specified表示指定实例，运行时由ability内部业务决定是否创建多实例，singleton表示单实例。 | 字符串 | 可缺省，该标签缺省为"singleton" |
| description | 该标签标识ability的描述，标签值是是字符串类型或对描述内容的资源索引，要求采用用资源索引方式，以支持多语言。 | 字符串 | 该标签可缺省，缺省值为空。 |
| icon | 该标签标识ability图标，标签值为资源文件的索引。该标签可缺省，缺省值为空。<br/>如果ability被配置为MainElement，该标签必须配置。 | 字符串 | 该标签可缺省，缺省值为空。<br/>如果ability被配置为MainElement，该标签必须配置。 |
| permissions | 该标签标识被其它应用的ability调用时需要申请的权限的集合，一个数组元素为一个权限名称。通常采用反向域名格式（最大255字节），取值为系统预定义的权限。 | 字符串数组 | 该标签可缺省，缺省值为空。 |
| metadata | 该标签标识ability的元信息。metadata参考[metadata对象内部结构](#metadata对象内部结构)。 | 数组 | 该标签可缺省，缺省值为空。 |
| visible | 该标签标识ability是否可以被其它应用调用，为布尔类型，true表示可以被其它应用调用， false表示不可以被其它应用调用。 | 布尔值 | 该标签可缺省，缺省值为false。 |
| continuable | 该标签标识ability是否可以迁移，为布尔类型，true表示可以被迁移， false表示不可以被迁移。 | 布尔值 | 该标签可缺省，缺省值为false。 |
| skills | 该标签标识ability能够接收的意图的特征集，为数组格式。<br />配置规则 : entry包可以配置多个具有入口能力的skills标签（配置了action.system.home和entity.system.home）的ability，其中第一个配置了skills标签的ability中的label和icon作为OpenHarmony服务或应用的label和icon。<br/>OpenHarmony服务的Feature包不能配置具有入口能力的skills标签。<br/>OpenHarmony应用的Feature包可以配置具有入口能力的skills标签。 <br />skills内部结构参考[skills对象内部结构](#skills对象内部结构)。 | 数组 | 该标签可缺省，缺省值为空。 |
| backgroundModes | 该标签标识ability长时任务集合。指定用于满足特定类型的长时任务。<br />长时任务类型有如下 :<br/>dataTransfer :通过网络/对端设备进行数据下载、备份、分享、传输等业务。<br/>audioPlayback :音频输出业务。<br/>audioRecording :音频输入业务。<br/>location :定位、导航业务。<br/>bluetoothInteraction :蓝牙扫描、连接、传输业务（穿戴）。<br/>multiDeviceConnection :多设备互联业务。<br/>wifiInteraction :Wifi扫描、连接、传输业务（克隆 多屏）。<br/>voip :音视频电话，VOIP业务。<br/>taskKeeping :计算业务。 <br/> | 字符串 | 可缺省，缺省为空。 |
| startWindowIcon | 标识该Ability启动页面图标资源文件的索引。取值示例：$media:icon。 | 字符串 | 不可缺省。|
| startWindowBackground | 标识该Ability启动页面背景颜色资源文件的索引。取值示例：$color:red。 | 字符串 | 不可缺省。|
| removeMissionAfterTerminate | 该标签标识ability销毁后是否从任务列表中移除任务。为布尔类型，true表示销毁后移除任务， false表示销毁后不移除任务。 | 布尔值 | 该标签可缺省，缺省值为false。|
| orientation | 标识该ability启动时的方向。该方向的取值范围包括：<br/>unspecified: 未指定方向，由系统自动判断显示方向，<br/>landscape：横屏，<br/> portrait：竖屏，<br/>landscape_inverted: 反向横屏， <br/>portrait_inverted: 反向竖屏， <br/>auto_rotation: 随传感器旋转， <br/>auto_rotation_landscape: 传感器横屏旋转，包括了横屏和反向横屏，<br/>auto_rotation_portrait: 传感器竖屏旋转，包括了竖屏和反向竖屏，<br/>auto_rotation_restricted: 传感器开关打开，方向可随传感器旋转，<br/>auto_rotation_landscape_restricted: 传感器开关打开，方向可随传感器旋转为横屏， 包括了横屏和反向横屏， <br/>auto_rotation_portrait_restricted: 传感器开关打开，方向随可传感器旋转为竖屏， 包括了横屏和反向横屏， <br/>locked: 传感器开关关闭，方向锁定。 | 字符串 | 该标签可缺省，缺省值为unspecified。|
|supportWindowMode|标识该ability所支持的窗口模式，包含：<br/> fullscreen: 全屏模式， <br /> split: 分屏模式， <br />floating: 悬浮窗模式。 |数组 | 该标签可缺省，缺省值为<br/>["fullscreen", "split", "floating"]。|
|priority|标识ability的优先级，仅支持系统应用配置，三方应用配置不生效。隐式查询时，优先级越高，ability在返回列表越靠前。该标签取值为integer类型，取值范围0-10。数值越大，优先级越高。 |数值 | 该标签可缺省，缺省值为0。 |
|maxWindowRatio|标识该ability支持的最大的宽高比。| 数值 |该标签可缺省，缺省值为平台支持的最大的宽高比。|
|minWindowRatio|标识该ability支持的最小的宽高比。| 数值 |该标签可缺省，缺省值为平台支持的最小的宽高比。|
|maxWindowWidth|标识该ability支持的最大的窗口宽度，宽度单位为vp。| 数值 |该标签可缺省，缺省值为平台支持的最大的窗口宽度。|
|minWindowWidth|标识该ability支持的最小的窗口宽度, 宽度单位为vp。| 数值 |该标签可缺省，缺省值为平台支持的最小的窗口宽度。|
|maxWindowHeight|标识该ability支持的最大的窗口高度, 高度单位为vp。| 数值 |该标签可缺省，缺省值为平台支持的最大的窗口高度。|
|minWindowHeight|标识该ability支持的最小的窗口高度, 高度单位为vp。| 数值 |该标签可缺省，缺省值为平台支持的最小的窗口高度。|
| excludeFromMissions | 该标签标识ability是否在最近任务列表中显示，仅支持系统应用配置，三方应用配置不生效。为布尔类型，true表示不在任务列表中显示，false表示在任务列表中显示。 | 布尔值 | 该标签可缺省，缺省值为false。|
abilities示例
```json
{
"abilities": [{
"name": "MainAbility",
"srcEntrance": "./ets/login/MyLoginAbility.ts",
"launchType":"standard",
"description": "$string:description_main_ability",
"icon": "$media:icon",
"label": "Login",
"permissions": [],
"metadata": [],
"visible": true,
"continuable": true,
"skills": [{
"actions": ["action.system.home"],
"entities": ["entity.system.home"],
"uris": []
}],
"backgroundModes": [
"dataTransfer",
"audioPlayback",
"audioRecording",
"location",
"bluetoothInteraction",
"multiDeviceConnection",
"wifiInteraction",
"voip",
"taskKeeping"
], ],
"startWindowIcon": "$media:icon", }
"startWindowBackground": "$color:red",
"removeMissionAfterTerminate": true,
"orientation": " ",
"supportWindowMode": ["fullscreen", "split", "floating"],
"maxWindowRatio": 3.5,
"minWindowRatio": 0.5,
"maxWindowWidth": 2560,
"minWindowWidth": 1400,
"maxWindowHeight": 300,
"minWindowHeight": 200,
"excludeFromMissions": false
}]
} }
``` ```
...@@ -361,231 +297,374 @@ abilities示例 ...@@ -361,231 +297,374 @@ abilities示例
该标签标识ability或者extension能够接收的意图的特征。 该标签标识ability或者extension能够接收的意图的特征。
表7 skills内部结构示例 表7 skill对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | ---------- | -------------------- | | -------- | ------------------------------------------------------------ | ---------- | -------------------- |
| actions | 该标签标识能够接收的意图的action值的集合，取值通常为系统预定义的action值，也允许自定义。 | 字符串数组 | 可缺省，缺省值为空。 | | actions | 该标签标识能够接收的意图的action值的集合，取值通常为系统预定义的action值，也允许自定义。 | 字符串数组 | 可缺省，缺省值为空。 |
| entities | 该标签标识能够接收Want的元能力的类别集合，取值通常为系统预定义的类别，也允许自定义。 | 字符串数组 | 可缺省，缺省值为空。 | | entities | 该标签标识能够接收Want的元能力的类别集合，取值通常为系统预定义的类别，也允许自定义。 | 字符串数组 | 可缺省，缺省值为空。 |
| uris | 该标签标识向 want过滤器添加数据规范集合。该规范可以是只有数据类型（mimeType 属性），可以是只有 URI，也可以是既有数据类型又有 URI。uris内部结构参考表8。 | 对象数组 | 可缺省，缺省值为空。 | | uris | 该标签标识与意图中URI（Uniform Resource Identifier）相匹配的集合。uris内部结构参考表8。 | 对象数组 | 可缺省，缺省值为空。 |
表8 uris对象的内部结构说明 表8 uris对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------- | -------- | -------------------- | | -------- | ------------------- | -------- | -------------------- |
| scheme | 标识uri的scheme值。 | 字符串 | 不可缺省。 | | scheme | 标识URI的协议名部分，常见的有http、https、file、ftp等。 | 字符串 | 当配置type时可缺省，缺省值为空。没有配置type时不可缺省。 |
| host | 标识uri的host值。 | 字符串 | 可缺省，缺省值为空。 | | host | 标识URI的主机地址部分，常见的有域名的方式，如example.com，ip地址的方式，如192.0.0.1。该字段要在scheme存在时才有意义。 | 字符串 | 可缺省，缺省值为空。 |
| port | 标识uri的port值。 | 字符串 | 可缺省，缺省值为空。 | | port | 标识URI的端口部分。如http默认端口为80，https默认端口是443，ftp默认端口是21。该字段要在scheme和host都存在时才有意义。| 字符串 | 可缺省，缺省值为空。 |
| path | 标识uri的path值。 | 字符串 | 可缺省，缺省值为空。 | | path \| pathStartWith \| pathRegex | 标识URI的路径部分，path、pathStartWith和pathRegex配置时三选一。path标识URI与want中的路径部分全匹配，pathStartWith标识URI与want中的路径部分允许前缀匹配，pathRegex标识URI与want中的路径部分允许正则匹配。该字段要在scheme和host都存在时才有意义。| 字符串 | 可缺省，缺省值为空。 |
| type | 标识uri的type值。 | 字符串 | 可缺省，缺省值为空。 | | type | 标识数据类型，使用MIME（Multipurpose Internet Mail Extensions）类型规范。可与scheme同时配置，也可以单独配置。| 字符串 | 可缺省，缺省值为空。 |
skills示例 skills示例 ：
```json ```json
{ {
"abilities": [ "module": {
{ "abilities": [
"skills": [ {
{ "skills": [
"actions": [ {
"action.system.home" "actions": [
], "action.system.home"
"entities": [ ],
"entity.system.home" "entities": [
], "entity.system.home"
"uris": [ ],
{ "uris": [
"scheme":"uri2", {
"host":"host2", "scheme":"https",
"port":"port2", "host":"www.example.com",
"pathStartWith":"path2", "port":"8080",
"pathRegex":"/query/.*", "path":"query/student/name",
"path":"path", "pathStartWith":"query/student",
"type": "text/*" "pathRegex":"query/.*/name",
} "type": "text/*"
] }
} ]
] }
} ]
], }
"extensionAbilities": [ ],
{ "extensionAbilities": [
"skills": [ {
{ "skills": [
"actions": [ {
], "actions": [
"entities": [ "actionName"
], ],
"uris": [ "entities": [
{ "entityName"
"scheme":"uri2", ],
"host":"host2", "uris": [
"port":"port2", {
"pathStartWith":"path2", "scheme":"https",
"pathRegex":"/query/.*", "host":"www.example.com",
"path":"path", "port":"8080",
"type": "text/*" "path":"query/student/name",
} "pathStartWith":"query/student",
] "pathRegex":"query/.*/name",
} "type": "text/*"
] }
} ]
] }
]
}
]
}
}
```
#### abilities对象内部结构
abilities描述Ability组件的配置信息，标签值为数组类型。
表9 ability对象内部结构说明
| 属性 | 含义 | 数据类型 | 是否可缺省 |
| --------------- | ------------------------------------------------------------ | ---------- | ------------------------------------------------------------ |
| name | 该标签标识当前Ability组件的逻辑名，该名称在整个应用要唯一，标签值采用字符串表示（最大长度127字节）。 | 字符串 | 不可缺省。 |
| srcEntrance | 该标签标识Ability组件所对应的js代码路径，标签值为字符串（最大长度127字节）。 | 字符串 | 不可缺省。 |
| launchType | 该标签标识Ability组件的启动模式，可选标签值：<br/>"standard"：多实例，每次启动创建一个新的实例。<br/>"singleton"：单实例，仅第一次启动创建新实例。<br/>"specified"：运行时由开发者决定是否创建新实例。 | 字符串 | 可缺省，缺省值为"singleton" |
| description | 该标签标识Ability组件的描述信息，标签值是是字符串类型或对描述内容的资源索引，要求采用资源索引方式，以支持多语言。 | 字符串 | 可缺省，缺省值为空。 |
| icon | 该标签标识Ability组件的图标，标签值为图标资源文件的索引。 | 字符串 | 可缺省，缺省值为空。<br/>如果Ability组件被配置为MainElement，该标签必须配置。 |
| permissions | 该标签标识被其它应用的Ability组件调用时需要申请的权限的集合，一个数组元素为一个权限名称。通常采用反向域名格式（最大长度255字节），取值为系统预定义的权限。 | 字符串数组 | 可缺省，缺省值为空。 |
| metadata | 该标签标识Ability组件的元信息。参考[metadata对象内部结构](#metadata对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| visible | 该标签标识Ability组件是否可以被其它应用调用，true表示可以被其它应用调用， false表示不可以被其它应用调用。 | 布尔值 | 可缺省，缺省值为false。 |
| continuable | 该标签标识Ability组件是否可以迁移，true表示可以被迁移， false表示不可以被迁移。 | 布尔值 | 可缺省，缺省值为false。 |
| skills | 该标签标识Ability组件能够接收的意图的特征集。<br />配置规则 : entry包可以配置多个具有入口能力的skills标签（配置了action.system.home和entity.system.home）的Ability组件，其中第一个配置了skills标签的Ability组件中的label和icon作为OpenHarmony服务或应用的label和icon。<br/>OpenHarmony服务的Feature包不能配置具有入口能力的skills标签。<br/>OpenHarmony应用的Feature包可以配置具有入口能力的skills标签。 <br />参考[skills对象内部结构](#skills对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| backgroundModes | 该标签标识Ability组件的长时任务集合。指定用于满足特定类型的长时任务。<br />长时任务类型有如下 :<br/>dataTransfer :通过网络/对端设备进行数据下载、备份、分享、传输等业务。<br/>audioPlayback :音频输出业务。<br/>audioRecording :音频输入业务。<br/>location :定位、导航业务。<br/>bluetoothInteraction :蓝牙扫描、连接、传输业务（穿戴）。<br/>multiDeviceConnection :多设备互联业务。<br/>wifiInteraction :Wifi扫描、连接、传输业务（克隆 多屏）。<br/>voip :音视频电话，VOIP业务。<br/>taskKeeping :计算业务。 <br/> | 字符串 | 可缺省，缺省值为空。 |
| startWindowIcon | 标识该Ability组件启动页面图标资源文件的索引。取值示例：$media:icon。 | 字符串 | 不可缺省。|
| startWindowBackground | 标识该Ability组件启动页面背景颜色资源文件的索引。取值示例：$color:red。 | 字符串 | 不可缺省。|
| removeMissionAfterTerminate | 该标签标识Ability组件销毁后是否从任务列表中移除任务。true表示销毁后移除任务， false表示销毁后不移除任务。 | 布尔值 | 可缺省，缺省值为false。|
| orientation | 标识该Ability组件启动时的方向。取值范围包括：<br/>unspecified: 未指定方向，由系统自动判断显示方向，<br/>landscape：横屏，<br/> portrait：竖屏，<br/>landscape_inverted: 反向横屏， <br/>portrait_inverted: 反向竖屏， <br/>auto_rotation: 随传感器旋转， <br/>auto_rotation_landscape: 传感器横屏旋转，包括了横屏和反向横屏，<br/>auto_rotation_portrait: 传感器竖屏旋转，包括了竖屏和反向竖屏，<br/>auto_rotation_restricted: 传感器开关打开，方向可随传感器旋转，<br/>auto_rotation_landscape_restricted: 传感器开关打开，方向可随传感器旋转为横屏， 包括了横屏和反向横屏， <br/>auto_rotation_portrait_restricted: 传感器开关打开，方向随可传感器旋转为竖屏， 包括了横屏和反向横屏， <br/>locked: 传感器开关关闭，方向锁定。 | 字符串 | 可缺省，缺省值为"unspecified"。|
|supportWindowMode|标识该Ability组件所支持的窗口模式，取值范围包括：<br/> fullscreen: 全屏模式， <br /> split: 分屏模式， <br />floating: 悬浮窗模式。 |字符串数组 | 可缺省，缺省值为<br/>["fullscreen", "split", "floating"]。|
|maxWindowRatio|标识该Ability组件支持的最大的宽高比。| 数值 |可缺省，缺省值为平台支持的最大的宽高比。|
|minWindowRatio|标识该Ability组件支持的最小的宽高比。| 数值 |可缺省，缺省值为平台支持的最小的宽高比。|
|maxWindowWidth|标识该Ability组件支持的最大的窗口宽度，宽度单位为vp。| 数值 |可缺省，缺省值为平台支持的最大的窗口宽度。|
|minWindowWidth|标识该Ability组件支持的最小的窗口宽度, 宽度单位为vp。| 数值 |可缺省，缺省值为平台支持的最小的窗口宽度。|
|maxWindowHeight|标识该Ability组件支持的最大的窗口高度, 高度单位为vp。| 数值 |可缺省，缺省值为平台支持的最大的窗口高度。|
|minWindowHeight|标识该Ability组件支持的最小的窗口高度, 高度单位为vp。| 数值 |可缺省，缺省值为平台支持的最小的窗口高度。|
abilities示例 ：
```json
{
"module": {
"abilities": [
{
"name": "MainAbility",
"srcEntrance": "./ets/login/LoginAbility.ts",
"launchType":"standard",
"description": "$string:description",
"icon": "$media:icon",
"label": "$string:label",
"permissions": [],
"metadata": [],
"visible": true,
"continuable": true,
"skills": [
{
"actions": ["action.system.home"],
"entities": ["entity.system.home"],
"uris": []
}
],
"backgroundModes": [
"dataTransfer",
"audioPlayback",
"audioRecording",
"location",
"bluetoothInteraction",
"multiDeviceConnection",
"wifiInteraction",
"voip",
"taskKeeping"
],
"startWindowIcon": "$media:icon",
"startWindowBackground": "$color:red",
"removeMissionAfterTerminate": true,
"orientation": "landscape",
"supportWindowMode": ["fullscreen", "split", "floating"],
"maxWindowRatio": 3.5,
"minWindowRatio": 0.5,
"maxWindowWidth": 2560,
"minWindowWidth": 1400,
"maxWindowHeight": 300,
"minWindowHeight": 200
}
]
}
} }
``` ```
#### extensionAbility对象的内部结构说明
描述extensionAbility的配置信息，标签值为数组类型，该标签下的配置只对当前extensionAbility生效。 #### extensionAbilities对象内部结构
extensionAbilities描述extensionAbility的配置信息，标签值为数组类型。
表9 extensionAbility对象内部结构说明 表10 extensionAbility对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ----------- | ------------------------------------------------------------ | ---------- | ----------------------------- | | ----------- | ------------------------------------------------------------ | ---------- | ----------------------------- |
| name | 该标签标识当前extensionAbility的逻辑名，标签值采用字符串表示（最大长度127个字节），该名称在整个应用要唯一。 | 字符串 | 该标签不可缺省。 | | name | 该标签标识当前ExtensionAbility组件的逻辑名，标签值采用字符串表示（最大长度127字节），该名称在整个应用要唯一。 | 字符串 | 不可缺省。 |
| srcEntrance | 该标签标识extensionAbility所对应的js代码路径，标签值为字符串（最长为127字节）。 | 字符串 | 该标签不可缺省。 | | srcEntrance | 该标签标识ExtensionAbility组件所对应的js代码路径，标签值为字符串（最大长度127字节）。 | 字符串 | 不可缺省。 |
| description | 该标签标识extensionAbility的描述，标签值是是字符串类型或对描述内容的资源索引，以支持多语言。 | 字符串 | 该标签可缺省，缺省值为空。 | | description | 该标签标识ExtensionAbility组件的描述，标签值是是字符串类型或对描述内容的资源索引，以支持多语言。 | 字符串 | 可缺省，缺省值为空。 |
| icon | 该标签标识extensionAbility图标，标签值为资源文件的索引。如果extensionAbility被配置为MainElement，该标签必须配置。 | 字符串 | 该标签可缺省，缺省值为空。 | | icon | 该标签标识ExtensionAbility组件图标，标签值为资源文件的索引。 | 字符串 | 可缺省，缺省值为空。如果ExtensionAbility组件被配置为MainElement，不可缺省。 |
| label | 该标签标识extensionAbility对用户显示的名称，标签值配置为该名称的资源索引以支持多语言。<br/>如果extensionAbility被配置为MainElement，该标签必须配置，且应用内唯一。 | 字符串 | 该标签不可缺省。 | | label | 该标签标识ExtensionAbility组件对用户显示的名称，标签值配置为该名称的资源索引以支持多语言。 | 字符串 | 可缺省，缺省值为空。如果ExtensionAbility组件被配置为MainElement，该标签必须配置，且应用内唯一。 |
| type | 该标签标识extensionAbility的类型，取值为form、workScheduler、inputMethod、service、accessibility、dataShare、fileShare、staticSubscriber、wallpaper、backup、window、enterpriseAdmin、thumbnail、preview其中之一。 | 字符串 | 该标签不可缺省。 | | type | 该标签标识ExtensionAbility组件的类型，取值为form、workScheduler、inputMethod、service、accessibility、dataShare、fileShare、staticSubscriber、wallpaper、backup、window、enterpriseAdmin、thumbnail、preview其中之一。 | 字符串 | 不可缺省。 |
| permissions | 该标签标识被其它应用的ability调用时需要申请的权限的集合，字符串数组类型，每个数组元素为一个权限名称，通常采用反向域名方式表示（最大255字节），可以是系统预定义的权限，也可以是该应用自定义的权限。如果是后者，需与defPermissions标签中定义的某个权限的name标签值一致。 | 字符串数组 | 该标签可缺省，缺省值为空。 | | permissions | 该标签标识被其它应用的ability调用时需要申请的权限的集合，字符串数组类型，每个数组元素为一个权限名称，通常采用反向域名方式表示（最大长度255字节），取值为系统预定义权限或者应用自定义权限，如果是后者，需与defPermissions标签中定义的某个权限的name标签值一致。 | 字符串数组 | 可缺省，缺省值为空。 |
| uri | 该标签标识ability提供的数据uri，为字符数组类型（最大长度255），用反向域名的格式表示。该标签在type为dataShare类型的extensionAbility时，不可缺省。 | 字符串 | 该标签可缺省，缺省值为空。 | | uri | 该标签标识ability提供的数据URI，为字符数组类型（最大长度255字节），用反向域名的格式表示。 | 字符串 | 可缺省，缺省值为空。该标签在type为dataShare类型的ExtensionAbility组件时，不可缺省。 |
| skills | 该标签标识ability能够接收的意图的特征集，为数组格式。<br />配置规则 : entry包可以配置多个具有入口能力的skills标签（配置了action.system.home和entity.system.home）的ability，其中第一个配置了skills标签的ability中的label和icon作为OpenHarmony服务或应用的label和icon。<br/>OpenHarmony服务的Feature包不能配置具有入口能力的skills标签。<br/>OpenHarmony应用的Feature包可以配置具有入口能力的skills标签。 <br />skills内部结构参考[skills对象内部结构](#skills对象内部结构)。 | 数组 | 该标签可缺省，缺省值为空。 | | skills | 该标签标识ability能够接收的意图的特征集，为数组格式。<br />配置规则 : entry包可以配置多个具有入口能力的skills标签（配置了action.system.home和entity.system.home）的ability，其中第一个配置了skills标签的ability中的label和icon作为OpenHarmony服务或应用的label和icon。<br/>OpenHarmony服务的Feature包不能配置具有入口能力的skills标签。<br/>OpenHarmony应用的Feature包可以配置具有入口能力的skills标签。 <br />参考[skills对象内部结构](#skills对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| metadata | 该标签标识extensionAbility的元信息。metadata内部结构参考[metadata对象内部结构](#metadata对象内部结构)。 | 对象 | 该标签可缺省，缺省值为空。 | | metadata | 该标签标识ExtensionAbility组件的元信息。参考[metadata对象内部结构](#metadata对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| visible | 该标签标识extensionAbility是否可以被其它应用调用，为布尔类型。true表示可以被其它应用调用， false表示不可以被其它应用调用。 | 布尔值 | 该标签可缺省，缺省值为false。 | | visible | 该标签标识ExtensionAbility组件是否可以被其它应用调用。true表示可以被其它应用调用， false表示不可以被其它应用调用。 | 布尔值 | 可缺省，缺省值为false。 |
| readPermission | 该标签标识读取ExtensionAbility组件的数据所需的权限。最大长度255字节。type为dataShare类型的ExtensionAbility组件支持该配置。该标签只对系统应用生效。 | 字符串 | 可缺省，缺省值为空。 |
extensionAbility示例 : | writePermission | 该标签标识向ExtensionAbility组件写数据所需的权限。最大长度255字节。type为dataShare类型的ExtensionAbility组件支持该配置。该标签只对系统应用生效。 | 字符串 | 可缺省，缺省值为空。 |
extensionAbilities示例 ：
```json ```json
{ {
"extensionAbilities": [ "module": {
{ "extensionAbilities": [
"name": "FormName", {
"srcEntrance": "./form/MyForm.ts", "name": "extensionName",
"icon": "$media:icon", "srcEntrance": "./extension/FormExtension.ts",
"label" : "$string:extension_name", "icon": "$media:icon",
"description": "$string:form_description", "label" : "$string:label",
"type": "form", "description": "$string:description",
"permissions": ["ohos.abilitydemo.permission.PROVIDER"], "type": "form",
"readPermission": "", "permissions": ["permissionName"],
"writePermission": "", "readPermission": "",
"visible": true, "writePermission": "",
"uri":"scheme://authority/path/query" "visible": true,
"skills": [{ "uri":"scheme://authority/path/query"
"actions": [], "skills": [
"entities": [], {
"uris": [] "actions": [],
}], "entities": [],
"metadata": [ "uris": []
{ }
"name": "ohos.extability.form", ],
"resource": "$profile:form_config", "metadata": [
} {
] "name": "ohos.extability.form",
} "resource": "$profile:form_config",
] }
]
}
]
}
} }
``` ```
#### definePermissions对象内部结构 #### definePermissions对象内部结构
该标签标识hap定义的权限。 该标签标识HAP定义的权限。该标签只支持系统应用配置。
表10 definePermissions定义权限字段说明 表11 definePermission对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ---------------------- | ------------------------------------------------------------ | -------- | ------------------------------ | | ---------------------- | ------------------------------------------------------------ | -------- | ------------------------------ |
| name | 标识权限的名称。 | 字符串 | 不可缺省 | | name | 标识权限的名称。 | 字符串 | 不可缺省。 |
| grantMode | 标识权限的授予方式，授予模式如下：<br />system_grant：安装后系统自动授予该权限。<br />user_grant：使用动态申请，用户授权后才可使用 | 字符串 | 可缺省，缺省值为system_grant。 | | grantMode | 标识权限的授予方式，授予模式如下：<br />system_grant：安装后系统自动授予该权限。<br />user_grant：应用动态申请，用户授权后才可使用 | 字符串 | 可缺省，缺省值为"system_grant"。 |
| availableLevel | 标识权限限制门限，可选值为"system_core"、"system_basic"、"normal"。该标签有缺省值，缺省值为normal。权限范围如下：<br />system_core：系统核心权限。<br />system_basic：系统基础权限。<br />normal：普通权限。所有应用允许申请的权限。 | 字符串 | 可缺省，缺省值为"normal" | | availableLevel | 标识权限限制门限，可选值为system_core、system_basic、normal。<br />system_core：系统核心权限。<br />system_basic：系统基础权限。<br />normal：普通权限。所有应用允许申请的权限。 | 字符串 | 可缺省，缺省值为"normal"。 |
| provisionEnable | 标识权限是否支持证书方式申请权限，包括高级别的权限，true标识需要开发者可以通过provision证书acls方式申请权限。 | 布尔值 | 可缺省，缺省值为true | | provisionEnable | 标识权限是否支持证书方式申请权限，包括高级别的权限，true标识需要开发者可以通过provision证书acls方式申请权限。 | 布尔值 | 可缺省，缺省值为true。 |
| distributedSceneEnable | 标识权限是否支持分布式场景下使用该权限。 | 布尔值 | 可缺省，缺省值为false | | distributedSceneEnable | 标识权限是否支持分布式场景下使用该权限。 | 布尔值 | 可缺省，缺省值为false。 |
| label | 标识权限的简短描述，配置为对描述内容的资源索引。 | 字符串 | 可缺省，缺省值为空 | | label | 标识权限的简短描述，配置为对描述内容的资源索引。 | 字符串 | 可缺省，缺省值为空。 |
| description | 标识权限的详细描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引。 | 字符串 | 可缺省，缺省值为空 | | description | 标识权限的详细描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引。 | 字符串 | 可缺省，缺省值为空。 |
definePermissions示例 ：
```json
{
"module": {
"definePermissions": [
{
"name": "permissionName",
"grantMode": "user_grant",
"availableLevel": "system_basic",
"provisionEnable": false,
"distributedSceneEnable": true,
"label" : "$string:label",
"description": "$string:description"
}
]
}
}
```
#### requestPermissions对象内部结构 #### requestPermissions对象内部结构
该标签标识应用运行时需向系统申请的权限集合。 该标签标识应用运行时需向系统申请的权限集合。
表11 requestPermissions权限申请字段说明 表12 requestPermission对象内部结构说明
| 属性名称 | 含义 | **类型** | **取值范围** | **默认值** | **规则约束** | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| --------- | ------------------------------------------------------------ | ---------------------------------------- | ------------------------------------------------------------ | -------------------- | ------------------------------------------------------------ | | ------| ------| -------- | ------------------------------ |
| name | 必须，填写需要使用的权限名称。 | 字符串 | 自定义 | 无 | 未填写时，解析失败。 | | name | 需要申请的的权限名称。| 字符串 | 不可缺省。 |
| reason | 可选，当申请的权限为user_grant权限时此字段必填。描述申请权限的原因。 | 字符串 | 使用string类资源引用。格式为`$string: ***`。 | 空 | user_grant权限必填，否则不允许在应用市场上架。需做多语种适配。 | | reason | 申请权限的原因。配置为描述内容的资源索引，以支持多语言。 | 字符串 | 可缺省，缺省值为空。当申请权限的grantMode为user_grant时不可缺省。 |
| usedScene | 可选，当申请的权限为user_grant权限时此字段必填。描述权限使用的场景和时机。场景类型有 :ability、when（调用时机）。可配置多个ability。 | abilities:ability字符串数组，when:字符串 | abilities:ability的名称，when:inuse（使用时）、always（始终） | abilities:空 when:空 | user_grant权限必填abilities，可选填when。 | | usedScene | 权限使用的场景和时机。参考[usedScene对象内部结构](#usedscene对象内部结构)。| 对象 | 可缺省，缺省值为空。当申请权限的grantMode为user_grant时不可缺省。 |
requestPermissions示例 : requestPermissions示例 ：
```json ```json
{ {
"name": "ohos.abilitydemo.permission.PROVIDER", "module": {
"reason": "$string:reason", "requestPermissions": [
"usedScene": { {
"abilities": [ "name": "permissionName",
"AudioAbility", "reason": "$string:reason",
"VideoAbility", "usedScene": {
], "abilities": [
"when": "inuse" "AudioAbility",
} "VideoAbility"
],
"when": "inuse"
}
}
]
}
} }
``` ```
权限访问的更多说明，可参考[访问控制开发指导](../security/accesstoken-guidelines.md) 权限访问的更多说明，可参考[访问控制开发指导](../security/accesstoken-guidelines.md)
#### form对象内部结构 #### usedScene对象内部结构
该标签标识权限使用的场景和时机。
表13 usedScene对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ------- | --------------------| -------- | ------ |
| abilities | 标识需要使用到该权限的ability。| 字符串数组 | 不可缺省。 |
| when | 标识使用该权限的时机，可选值为inuse和always。inuse表示仅前台使用，always表示前后台都可使用 | 字符串 | 可缺省，缺省值为空。 |
forms标签标识卡片的配置，form卡片是可以嵌入桌面上并接收定期更新的应用简要视图。在以下场景中可以包含form标签。
1. extensions中指定type为form。 usedScene示例 ：
```json
{
"module": {
"requestPermissions": [
{
"usedScene": {
"abilities": [
"AudioAbility",
"VideoAbility"
],
"when": "inuse"
}
}
]
}
}
```
#### forms对象内部结构
2. metadata中指定form信息，其中 : forms标签标识卡片的配置，form卡片是可以嵌入桌面上并接收定期更新的应用简要视图。<br/>
name :指定form的名称。使用ohos.extability.form作为form信息的标识。 配置方式如下：<br/>
resource :指定form信息的资源位置。 extensionAbility标签配置type为form，并配置metadata信息：name :"ohos.extability.form"。resource :指定form信息的资源位置。
表12 forms对象的内部结构说明 表14 form对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ------------------- | ------------------------------------------------------------ | ---------- | ----------------------------- | | ------------------- | ------------------------------------------------------------ | ---------- | ----------------------------- |
| name | 标识卡片的类名。字符串最大长度为127字节。 | 字符串 | 否 | | name | 标识卡片的名称。最大长度为127字节。 | 字符串 | 不可缺省。 |
| description | 标识卡片的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。字符串最大长度为255字节。 | 字符串 | 可缺省，缺省为空。 | | description | 标识卡片的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。最大长度为255字节。 | 字符串 | 可缺省，缺省值为空。 |
| src | 该标签标识JS卡片对应的UI代码。建议开发者通过自适应布局显示不同规格卡片，如果不同规格卡片布局相差较大，建议通过不同卡片来区分。 | 字符串 | 可缺省，缺省为空。 | | src | 该标签标识JS卡片对应的UI代码。建议开发者通过自适应布局显示不同规格卡片，如果不同规格卡片布局相差较大，建议通过不同卡片来区分。 | 字符串 | 可缺省，缺省值为空。 |
| window | 该标签标识JS卡片的自适应能力。window结构参考表12。 | 对象 | 可缺省，缺省为空。 | | window | 该标签标识JS卡片的自适应能力。参考[window对象内部结构](#window对象内部结构)。 | 对象 | 可缺省，缺省值为空。 |
| isDefault | 标识该卡片是否为默认卡片，每个Ability有且只有一个默认卡片。 true :默认卡片。 false :非默认卡片。 | 布尔值 | 否 | | isDefault | 标识该卡片是否为默认卡片，每个Ability有且只有一个默认卡片。 true :默认卡片。 false :非默认卡片。 | 布尔值 | 不可缺省。 |
| colorMode | 标识卡片的主题样式，取值范围如下 : auto :自适应。 dark :深色主题。 light :浅色主题。 | 字符串 | 可缺省，缺省值为“auto”。 | | colorMode | 标识卡片的主题样式，取值范围如下 : <br/>auto :自适应。<br/> dark :深色主题。<br/> light :浅色主题。<br/>| 字符串 | 可缺省，缺省值为“auto”。 |
| supportDimensions | 标识卡片支持的外观规格，取值范围 : 1 * 2 :表示1行2列的二宫格。 2 * 1 :表示2行1列的二宫格。 2 * 2 :表示2行2列的四宫格。 2 * 4 :表示2行4列的八宫格。 4 * 4 :表示4行4列的十六宫格。 | 字符串数组 | 否 | | supportDimensions | 标识卡片支持的外观规格，取值范围 :<br/>1 * 2 :表示1行2列的二宫格。<br/> 2 * 1 :表示2行1列的二宫格。<br/> 2 * 2 :表示2行2列的四宫格。<br/> 2 * 4 :表示2行4列的八宫格。<br/> 4 * 4 :表示4行4列的十六宫格。 | 字符串数组 | 不可缺省。 |
| defaultDimension | 标识卡片的默认外观规格，取值必须在该卡片supportDimensions配置的列表中。 | 字符串 | 否 | | defaultDimension | 标识卡片的默认外观规格，取值必须在该卡片supportDimensions配置的列表中。 | 字符串 | 不可缺省。 |
| updateEnabled | 该标签标识该卡片是否支持实时刷新，true标识卡片支持实时刷新，false标识不支持。 | 布尔值 | 否 | | updateEnabled | 该标签标识该卡片是否支持实时刷新，true标识卡片支持实时刷新，false表示不支持。 | 布尔值 | 不可缺省。 |
| scheduledUpdateTime | 该标签标识卡片定点刷新的时间，采用24小时计数，精确到分钟。 | 字符串 | 是 | | scheduledUpdateTime | 该标签标识卡片定点刷新的时间，采用24小时计数，精确到分钟。 | 字符串 | 可缺省，缺省值为空。 |
| updateDuration | 该标签标识卡片定时刷新的更新频率，单位为30分钟，取值为30的倍数值。卡片的最高频率为每30分钟刷新一次，和定点刷新二选一，二者都配置的情况下，定时优先。 | 数值 | 可缺省，缺省为空。 | | updateDuration | 该标签标识卡片定时刷新的更新频率，单位为30分钟，取值为30的倍数。卡片的最高频率为每30分钟刷新一次，和定点刷新二选一，二者都配置的情况下，定时优先。 | 数值 | 可缺省，缺省值为空。 |
| metadata | 该标签标识卡片的自定义信息。metadata内部结构参考表5。 | 对象 | 可缺省，缺省为空。 | | metadata | 该标签标识卡片的元信息。参考[metadata对象内部结构](#metadata对象内部结构)。 | 对象数组 | 可缺省，缺省值为空。 |
| formConfigAbility | 该标签标识卡片调整的Ability名称。标签值为字符串类型（最长127字符）。该标签值必须满足下面的格式 :<br/>ability://单个ability名字<br/>单个ability名字必须为本应用的ability。 | 字符串 | 可缺省，缺省为空。 | | formConfigAbility | 该标签标识卡片调整的Ability名称。最大长度127字节。该标签值必须满足下面的格式 :<br/>ability://单个ability名字<br/>单个ability名字必须为本应用的ability。 | 字符串 | 可缺省，缺省值为空。 |
| formVisibleNotify | 该标签标识卡片是否被允许使用卡片可见性通知。标签值为true或false | 布尔值 | 该标签可缺省，默认值为false。 | | formVisibleNotify | 该标签标识卡片是否被允许使用卡片可见性通知。 | 布尔值 | 可缺省，缺省值为false。 |
表13 window内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| --------------- | ------------------------------------------------------------ | -------- | -------------------- |
| designWidth | 指示页面设计的基线宽度，以像素为单位。 元素的大小由实际设备宽度缩放。 这个标签是一个整数。 | 数值 | 可缺省，缺省值为空。 |
| autoDesignWidth | 指定是否自动计算页面设计的基线宽度。 如果设置为true，则designWidth属性无效。基线宽度根据设备宽度和屏幕密度计算。 | 布尔值 | 可缺省，缺省值为空。 |
form示例 : form示例 :
在开发视图的resources/base/profile下面定义配置文件form_config.json（文件名称可由开发者定义） 1.在开发视图的resources/base/profile下面定义配置文件form_config.json（文件名称可由开发者定义）：
```json ```json
{ {
"forms": [ "forms": [
{ {
"name": "Form_Js", "name": "Form_Js",
"description": "$string:form_description", "description": "$string:description",
"src": "./js/pages/card/index", "src": "./js/pages/card/index",
"window": { "window": {
"designWidth": 720, "designWidth": 720,
"autoDesignWidth": true "autoDesignWidth": true
}, },
"colorMode": "auto", "colorMode": "auto",
"formConfigAbility": "ability://xxxxx", "formConfigAbility": "ability://xxx",
"formVisibleNotify": false, "formVisibleNotify": false,
"isDefault": true, "isDefault": true,
"updateEnabled": true, "updateEnabled": true,
...@@ -593,200 +672,221 @@ form示例 : ...@@ -593,200 +672,221 @@ form示例 :
"updateDuration": 1, "updateDuration": 1,
"defaultDimension": "2*2", "defaultDimension": "2*2",
"updateEnabled": true, "updateEnabled": true,
"scheduledUpdateTime": "21:33",
"supportDimensions": [ "supportDimensions": [
"2*2" "2*2"
], ],
"metadata": [ "metadata": [
{ {
"name": "string", "name": "name",
"value": "string", "value": "value",
"resource": "$profile:config_file" "resource": "$profile:resource"
} }
] ]
} }
] ]
} }
``` ```
在module.json5的extension组件下面定义metadata信息 2.在module.json5的extensionAbilities标签下定义metadata信息 ：
```json ```json
{ {
"extensionAbilities": [{ "module": {
"name": "MyForm", "extensionAbilities": [
"type": "form", {
"metadata": [{ "type": "form",
"name": "ohos.extability.form", "metadata": [
"resource": "$profile:form_config" {
}] "name": "ohos.extability.form",
}] "resource": "$profile:form_config"
}
]
}
]
}
} }
``` ```
#### shortcuts对象内部结构 #### shortcuts对象内部结构
标识应用的快捷方式信息。标签值为数组，最多可以配置四个快捷方式。其包含四个子标签shortcutId、label、icon、wants。 标识应用的快捷方式信息。最多可以配置四个快捷方式。<br/>
配置方式如下：<br/>
metadata中指定shortcut信息，其中 : ability标签配置metadata信息。name :"ohos.ability.shortcuts"。resource :指定shortcuts信息的资源位置。
1）name :指定shortcuts的名称。使用ohos.ability.shortcuts作为shortcuts信息的标识。
2）resource :指定shortcuts信息的资源位置。
表14 shortcuts对象的内部结构说明 表15 shortcut对象内部结构说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ---------- | ------------------------------------------------------------ | -------- | -------------------------- | | ---------- | ------------------------------------------------------------ | -------- | -------------------------- |
| shortcutId | 标识快捷方式的ID。字符串的最大长度为63字节。 | 字符串 | 否 | | shortcutId | 标识快捷方式的ID。最大长度为63字节。 | 字符串 | 不可缺省。 |
| label | 标识快捷方式的标签信息，即快捷方式对外显示的文字描述信息。取值可以是描述性内容，也可以是标识label的资源索引。字符串最大长度为63字节。 | 字符串 | 可缺省，缺省为空。 | | label | 标识快捷方式的标签信息，即快捷方式对外显示的文字描述信息。取值可以是描述性内容，也可以是标识label的资源索引。字符串最大长度为63字节。 | 字符串 | 可缺省，缺省值为空。 |
| icon | 该标签标识shortcut的图标，标签值为资源文件的索引。 | 字符串 | 该标签可缺省，缺省值为空。 | | icon | 该标签标识shortcut的图标，标签值为资源文件的索引。 | 字符串 | 可缺省，缺省值为空。 |
| wants | 该标签标识快捷方式内定义的目标wants信息集合，每个want可配置两个子标签，bundleName，abilityName。<br />bundleName :快捷方式目标包名，字符串类型。<br />abilityName :快捷方式的目标组件名，字符串类型。 | 对象 | 该标签可缺省，缺省为空。 | | wants | 该标签标识快捷方式内定义的目标wants信息集合，每个want可配置两个子标签，bundleName，abilityName。<br />bundleName :快捷方式目标包名，字符串类型。<br />abilityName :快捷方式的目标组件名，字符串类型。 | 对象数组 | 可缺省，缺省值为空。 |
在开发视图的resources/base/profile下面定义配置文件shortcut_config.json（文件名称可由开发者定义）。 shortcuts示例 :
1.在开发视图的resources/base/profile下面定义配置文件shortcuts_config.json（文件名称可由开发者定义）：
```json ```json
{ {
"shortcuts": [{ "shortcuts": [
"shortcutId": "id_test1", {
"label": "$string:shortcut", "shortcutId": "shortcut_id",
"icon": "$media:aa_icon", "label": "$string:label",
"wants": [{ "icon": "$media:icon",
"bundleName": "com.ohos.hello", "wants": [
"abilityName": "MainAbility" {
}] "bundleName": "bundleName",
}] "abilityName": "abilityName"
}
]
}
]
} }
``` ```
在module.json5的module下面定义metadata信息，如下 : 2.在module.json5的abilities标签下定义metadata信息 ：
```json ```json
{ {
"module": { "module": {
"name": "MyAbilityStage", "abilities": [
"abilities": [{ {
"name": "MyAbility", "name": "MainAbility",
"srcEntrance": "./abilities/MyAbility.ts", "srcEntrance": "./abilities/MainAbility.ts",
"skills": [{ "skills": [
"actions": ["action.system.home"], {
"entities": ["entity.system.home"], "actions": ["action.system.home"],
"uris": [] "entities": ["entity.system.home"]
}], }
"metadata": [{ ],
"name": "ohos.ability.shortcuts", "metadata": [
"resource": "$profile:shortcuts_config" {
}] "name": "ohos.ability.shortcuts",
}] "resource": "$profile:shortcuts_config"
}
]
}
]
} }
} }
``` ```
#### commonEvents对象内部结构 #### commonEvents对象内部结构
commonEvents标签标识注册静态公共事件信息。标签值为数组。 commonEvents标签标识注册静态公共事件信息。<br/>
metadata中指定commonEvent信息，其中 : 配置方式如下：<br/>
extensionAbility标签配置type为staticSubscriber，并配置metadata信息：name :"ohos.extability.staticSubscriber"。resource :指定commonEvents信息的资源位置。
1. name :指定commonEvent的名称。使用ohos.extability.staticSubscriber作为commonEvent信息的标识。
2. resource :指定commonEvent信息的资源位置。 表16 commonEvent对象内部结构
表15 commonEvents对象内部结构
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ---------- | ------------------------------------------------------------ | ---------- | -------------------------- | | ---------- | ------------------------------------------------------------ | ---------- | -------------------------- |
| name | 该标签指明当前静态公共事件对应的ability名，该类需要在ability中标明。 | 字符串 | 该标签不可缺省。 | | name | 该标签指明当前静态公共事件对应的ability名，该类需要在ability中标明。 | 字符串 | 不可缺省。 |
| permission | 该标签标识实现该静态公共事件需要申请的权限，以字符串类型表示一个权限名称，通常采用反向域名方式表示（最大255字节）。 | 字符串 | 可缺省，缺省值为空。 | | permission | 该标签标识实现该静态公共事件需要申请的权限，以字符串类型表示一个权限名称，通常采用反向域名方式表示（最大255字节）。 | 字符串 | 可缺省，缺省值为空。 |
| types | 该标签配置当前静态公共事件的类别数组，字符串数组类型，每个数组元素为一个类别名称。 | 字符串数组 | 该标签可缺省，缺省值为空。 | | types | 该标签配置当前静态公共事件的类别数组，字符串数组类型，每个数组元素为一个类别名称。 | 字符串数组 | 可缺省，缺省值为空。 |
| events | 该标签标识能够接收的意图的event值的集合，取值通常为系统预定义的event值，也允许自定义。 | 字符串数组 | 该标签不可缺省。 | | events | 该标签标识能够接收的意图的event值的集合，取值通常为系统预定义的event值，也允许自定义。 | 字符串数组 | 不可缺省。 |
commonEvents示例 :
在开发视图的resources/base/profile下面定义配置文件common_event_config.json（文件名称可由开发者定义）。 1.在开发视图的resources/base/profile下面定义配置文件common_event_config.json（文件名称可由开发者定义）：
```json ```json
{ {
"commonEvents": [{ "commonEvents": [
"name": "abilityName", {
"permission": "string", "name": "abilityName",
"types": [ "permission": "permissionName",
"string", "types": [
"string" "type1",
], "type2"
"events": [ ],
"string", "events": [
"string" "event1",
] "event2"
}] ]
}
]
} }
``` ```
在module.json5的extension组件下面定义metadata信息，如下 : 2.在module.json5的extensionAbilities标签下定义metadata信息 ：
```json ```json
"extensionAbilities": [ {
{ "module": {
"name": "mySubscriber", "extensionAbilities": [
"srcEntrance": "./extension/my_subscriber.js", {
"type": "staticSubscriber", "name": "subscriber",
"metadata": [{ "srcEntrance": "./extension/subscriber.js",
"name": "ohos.extability.staticSubscriber", "type": "staticSubscriber",
"resource": "$profile:common_event_config", "metadata": [
}], {
"name": "ohos.extability.staticSubscriber",
"resource": "$profile:common_event_config"
}
]
}
]
} }
] }
``` ```
#### distroFilter对象内部结构 #### distroFilter对象内部结构
标识应用的分发规则。 标识应用的分发规则。
该标签用于定义HAP包对应的细分设备规格的分发策略，以便在应用市场进行云端分发应用包时做精准匹配。该标签可配置的分发策略维度包括API Version、屏幕形状、屏幕分辨率。在进行分发时，通过deviceType与这三个属性的匹配关系，唯一确定一个用于分发到设备的HAP。 该标签用于定义HAP包对应的细分设备规格的分发策略，以便在应用市场进行云端分发应用包时做精准匹配。该标签可配置的分发策略维度包括API Version、屏幕形状、窗口分辨率、屏幕分辨率、国家码。在进行分发时，通过deviceType与这五个属性的匹配关系，唯一确定一个用于分发到设备的HAP。<br/>
配置方式如下：<br/>
module标签配置metadata信息。name :"ohos.module.distro"。resource :指定distroFilter信息的资源位置。
表16 distroFilter对象内部结构 表17 distroFilter对象内部结构
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ------------- | ------------------------------------------------------------ | -------- | -------------------------- | | ------------- | ------------------------------------------------------------ | -------- | -------------------------- |
| apiVersion | 标识支持的apiVersion范围。参考表16。 | 对象数组 | 该标签可缺省，缺省值为空。 | | apiVersion | 标识支持的apiVersion。 | 对象 | 可缺省，缺省值为空。 |
| screenShape | 标识屏幕形状的支持策略。 | 对象数组 | 该标签可缺省，缺省值为空。 | | screenShape | 标识屏幕形状的支持策略。仅支持liteWearable设备配置。 | 对象 | 可缺省，缺省值为空。 |
| screenWindow | 标识应用运行时窗口的分辨率支持策略。该字段仅支持对轻量级智能穿戴设备进行配置。 | 对象数组 | 该标签可缺省，缺省值为空。 | | screenWindow | 标识应用运行时窗口的分辨率支持策略。仅支持liteWearable设备配置。 | 对象 | 可缺省，缺省值为空。 |
| screenDensity | 该标签标识屏幕的像素密度（dpi :Dot Per Inch）。该字段可选，如果配置了该字段，取值必须合法。该标签为字符串数组，字符串范围如下。<br />sdpi :表示小规模的屏幕密度（Small-scale Dots per Inch），适用于dpi取值为（0,120]的设备。<br />mdpi :表示中规模的屏幕密度(Medium-scale Dots Per Inch)，适用于dpi取值为(120,160]的设备。<br />ldpi :表示大规模的屏幕密度(Large-scale Dots Per Inch)，适用于dpi取值为(160,240]的设备。<br /> xldpi :表示大规模的屏幕密度(Extra Large-scale Dots Per Inch)，适用于dpi取值为(240,320]的设备。<br />xxldpi :表示大规模的屏幕密度(Extra Extra Large-scale Dots Per Inch)，适用于dpi取值为(320，480]的设备。<br />xxxldpi :表示大规模的屏幕密度(Extra Extra Extra Large-scale Dots Per Inch)，适用于dpi取值为(480, 640]的设备。 | 对象数组 | 该标签可缺省，缺省值为空。 | | screenDensity | 标识屏幕的像素密度（dpi : Dot Per Inch）。 | 对象 | 可缺省，缺省值为空。 |
| countryCode | 该标签标识应用需要分发的国家地区码，具体值以ISO-3166-1标准为准。支持多个国家和地区枚举定义。该字段可选，如果配置了该字段，取值必须合法。标签值字符串数组，子串表示所支持的国家或地区，由两个大写字母组成。 | 对象数组 | 该标签可缺省，缺省值为空。 | | countryCode | 标识应用需要分发的国家地区码。具体值以ISO-3166-1标准为准。 | 对象 | 可缺省，缺省值为空。 |
表17 apiVersion对象的内部结构说明 表18 apiVersion对象内部结构
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | -------- | -------------------- | | -------- | ------------------------------------------------------------ | -------- | -------------------- |
| policy | 标识该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 | | policy | 标识该子属性取值的黑白名单规则。配置为"exclude"或"include"。"include"表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 |
| value | 支持的取值为API Version存在的整数值，例如4、5、6。场景示例 :某应用，针对相同设备型号，同时在网的为使用API 5和API 6开发的两个软件版本，则允许上架2个entry类型的安装包，分别支持到对应设备侧软件版本的分发。 | 数组 | 可缺省，缺省值为空。 | | value | 支持的取值为API Version存在的整数值，例如4、5、6，最小取值为3。场景示例 :某应用，针对相同设备型号，同时在网的为使用API 5和API 6开发的两个软件版本，则允许上架2个entry类型的安装包，分别支持到对应设备侧软件版本的分发。 | 数值数组 | 可缺省，缺省值为空。 |
表18 screenShape对象的内部结构说明 表19 screenShape对象内部结构
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | -------- | -------------------- | | -------- | ------------------------------------------------------------ | -------- | -------------------- |
| policy | 标识该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 | | policy | 标识该子属性取值的黑白名单规则。配置为"exclude"或"include"。"include"表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 |
| value | 支持的取值为circle（圆形）、rect（矩形）。场景示例 :针对智能穿戴设备，可为圆形表盘和矩形表盘分别提供不同的HAP。 | 数组 | 可缺省，缺省值为空。 | | value | 支持的取值为circle（圆形屏幕）、rect（矩形屏幕）。场景示例:针对智能穿戴设备，可为圆形表盘和矩形表盘分别提供不同的HAP。 | 字符串数组 | 可缺省，缺省值为空。 |
表19 screenWindow对象的内部结构说明 表20 screenWindow对象内部结构
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | -------- | -------------------- | | -------- | ------------------------------------------------------------ | -------- | -------------------- |
| policy | 标识该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 | | policy | 标识该子属性取值的黑白名单规则。配置为"include"。"include"表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 |
| value | 单个字符串的取值格式为 :“宽 * 高”，取值为整数像素值，例如“454 * 454”。 | 数组 | 可缺省，缺省值为空。 | | value | 单个字符串的取值格式为 :“宽 * 高”，取值为整数像素值，例如“454 * 454”。 | 字符串数组 | 可缺省，缺省值为空。 |
表20 screenDensity对象的内部结构说明 表21 screenDensity对象内部结构
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | -------- | -------------------- | | -------- | ------------------------------------------------------------ | -------- | -------------------- |
| policy | 标识该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 | | policy | 标识该子属性取值的黑白名单规则。配置为"exclude"或"include"。"include"表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 |
| value | 该标签标识屏幕的像素密度（dpi :Dot Per Inch）。 | 数组 | 可缺省，缺省值为空。 | | value | 字符串范围如下：<br />sdpi :表示小规模的屏幕密度（Small-scale Dots per Inch），适用于dpi取值为（0,120]的设备。<br />mdpi :表示中规模的屏幕密度(Medium-scale Dots Per Inch)，适用于dpi取值为(120,160]的设备。<br />ldpi :表示大规模的屏幕密度(Large-scale Dots Per Inch)，适用于dpi取值为(160,240]的设备。<br /> xldpi :表示大规模的屏幕密度(Extra Large-scale Dots Per Inch)，适用于dpi取值为(240,320]的设备。<br />xxldpi :表示大规模的屏幕密度(Extra Extra Large-scale Dots Per Inch)，适用于dpi取值为(320，480]的设备。<br />xxxldpi :表示大规模的屏幕密度(Extra Extra Extra Large-scale Dots Per Inch)，适用于dpi取值为(480, 640]的设备。 | 字符串数组 | 可缺省，缺省值为空。 |
表21 countryCode对象的内部结构说明 表22 countryCode对象内部结构
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ------------------------------------------------------------ | -------- | -------------------- | | -------- | ------------------------------------------------------------ | -------- | -------------------- |
| policy | 标识该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 | | policy | 标识该子属性取值的黑白名单规则。配置为"exclude"或"include"。"include"表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 |
| value | 该标签标识应用需要分发的国家地区码。 | 数组 | 可缺省，缺省值为空。 | | value | 支持多个国家和地区枚举定义。字符串表示所支持的国家或地区，由两个大写字母组成。 | 字符串数组 | 可缺省，缺省值为空。 |
distroFilter示例 : distroFilter示例 :
在开发视图的resources/base/profile下面定义配置文件distroFilter_config.json（文件名称可由开发者定义）。 1.在开发视图的resources/base/profile下面定义配置文件distro_filter_config.json（文件名称可由开发者定义）：
```json ```json
"distroFilter": [ "distroFilter": [
...@@ -802,39 +902,50 @@ distroFilter示例 : ...@@ -802,39 +902,50 @@ distroFilter示例 :
"screenWindow": { "screenWindow": {
"policy": "include", "policy": "include",
"value": ["454*454", "466*466"] "value": ["454*454", "466*466"]
},
"screenDensity": {
"policy": "exclude",
"value": ["ldpi", "xldpi"]
},
"countryCode": {
"policy": "include",
"value": ["CN", "HK"]
} }
} }
] ]
``` ```
在module.json5的extensionAbilities组件下面定义metadata信息，如下 : 2.在module.json5的module标签下定义metadata信息 ：
```json ```json
"extensionAbilities": [ {
{ "module":{
"name": "mySubscriber", "metadata": [
"srcEntrance": "./extension/my_subscriber.js", {
"type": "staticSubscriber", "name": "ohos.module.distro",
"metadata": [{ "resource": "$profile:distro_filter_config"
"name": "ohos.extability.staticSubscriber", }
"resource": "$profile:distroFilter_config", ]
}],
} }
] }
``` ```
#### testRunner对象内部结构 #### testRunner对象内部结构
表22 testRunner对象内部结构说明 该标签用于支持对测试框架的配置
表23 testRunner对象内部结构
| 属性名称 | 含义 | 数据类型 | 是否可缺省 | | 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | ---------------------- | -------- | ---------- | | -------- | ---------------------- | -------- | ---------- |
| name | 标识测试框架对象名称。 | 字符串 | 不可缺省。 | | name | 标识测试框架对象名称。 | 字符串 | 不可缺省。 |
| srcPath | 标识测试框架代码路径。 | 字符串 | 不可缺省。 | | srcPath | 标识测试框架代码路径。 | 字符串 | 不可缺省。 |
testRunner示例 :
``` ```
"testRunner": { "testRunner": {
"name": "myTestRUnnerName", "name": "testRunnerName",
"srcPath": "etc/test/TestRunner.ts" "srcPath": "etc/test/TestRunner.ts"
} }
``` ```
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或