1# module对象内部结构 2 3 4module对象包含HAP的配置信息。 5 6 **表1** **module对象内部结构说明** 7 8| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 9| -------- | -------- | -------- | -------- | 10| mainAbility | 服务中心图标露出的Ability，常驻进程拉起时会启动mainAbility。 | 字符串 | 可缺省，缺省值为空。 | 11| package | 标识HAP的包结构名称，在应用内保证唯一性。采用反向域名格式（建议与HAP的工程目录保持一致）。字符串长度为1-127个字节。 | 字符串 | 不可缺省。 | 12| name | 标识HAP的类名。采用反向域名方式标识，前缀要与同级的package标签指定的包名一致，也可采用"."开头的命名方式。字符串长度不超过255字节。 | 字符串 | 可缺省，缺省值为空。 | 13| description | 标识HAP的描述信息。字符串长度不超过255字节。如果字符串超出长度或者需要支持多语言，可以采用资源索引的方式添加描述内容。 | 字符串 | 可缺省，缺省值为空。 | 14| supportedModes | 标识应用支持的运行模式，当前只定义了驾驶模式（drive）。该标签只适用于车机。 | 字符串数组 | 可缺省，缺省值为空。 | 15|deviceType | <!--RP1-->标识允许Ability运行的设备类型。系统预定义的设备类型包括：tablet(平板)、tv（智慧屏）、car(车机)、wearable(智能穿戴)等。<!--RP1End--> | 字符串数组 | 不可缺省。 | 16|distro | 标识HAP发布的具体描述。 | 对象 | 不可缺省。 | 17|metaData | 标识HAP的元信息。 | 对象 | 可缺省，缺省值为空。 | 18| abilities | 标识当前模块内的所有Ability。采用对象数据格式。 | 对象数组 | 可缺省，缺省值为空。 | 19| js | 标识基于ArkUI框架开发的JS模块集合，其中的每个元素代表一个JS模块的信息。 | 对象数组 | 可缺省，缺省值为空。 | 20| shortcuts | 标识应用的快捷方式信息。采用对象数组格式，其中的每个元素表示一个快捷方式对象。 | 对象数组 | 可缺省，缺省值为空。 | 21| reqPermissions | 标识应用运行时向系统申请的权限。 | 对象数组 | 可缺省，缺省值为空。 | 22| colorMode | 标识应用自身的颜色模式，目前支持如下三种模式：<br/>- dark：表示按照深色模式选取资源。<br/>- light：表示按照浅色模式选取资源。<br/>- auto：表示跟随系统的颜色模式值选取资源。 | 字符串 | 可缺省，缺省值为"auto"。 | 23| distroFilter | 该标签下的子标签均为可选字段，用于定义HAP对应的细分设备规格的分发策略，以便应用市场在云端分发HAP时做精准匹配。该标签需要配置在/resource/profile资源目录下；在进行分发时，通过deviceType与下表属性的匹配关系，唯一确定一个用于分发到设备的HAP。 | 对象 | 可缺省，缺省值为空。但当应用中包含多个entry模块时，必须配置该标签。 | 24|commonEvents | 定义了公共事件静态订阅者的信息，该字段中需要声明静态订阅者的名称、权限要求及订阅事件列表信息，当订阅的公共事件发送时，该公共事件静态订阅者将被拉起。这里的静态订阅者区分于常用的动态订阅者，前者无需在业务代码中主动调用订阅事件的接口，在公共事件发布时可能未被拉起，而动态订阅者则在业务代码中主动调用公共事件订阅的相关API，因此需要应用处于活动状态。 | 对象数组 | 可缺省，缺省为空。 | 25| entryTheme | 此标签标识系统内部主题的关键字。将标记值设置为名称的资源索引。 | 字符串 | 可缺省，缺省值为空。 | 26|testRunner | 此标签用于支持对测试框架的配置。 | 对象 | 可缺省，缺省值为空。 | 27|generateBuildHash |标识当前HAP/HSP是否由打包工具生成哈希值。如果存在，则在系统OTA升级但应用的[version下的code](./app-structure.md#version对象内部结构)保持不变时，可根据哈希值判断应用是否需要升级。**<br/>注：该字段仅对预置应用生效。**|布尔值|该标签可缺省, 缺省值为false。| 28|libIsolation |用于区分同应用不同hap下的so文件，以防止so冲突。<br/>- true：当前hap的so会储存在libs目录中以Module名命名的路径下。<br/>- false：当前hap的so会直接储存在libs目录中。|布尔值|该标签可缺省, 缺省值为false。| 29 30module示例： 31 32```json 33{ 34 "module": { 35 "mainAbility": ".EntryAbility", 36 "deviceType": [ 37 "default", 38 "tablet" 39 ], 40 "abilities": [ 41 { 42 "skills": [ 43 { 44 "entities": [ 45 "entity.system.home" 46 ], 47 "actions": [ 48 "action.system.home" 49 ] 50 } 51 ], 52 "orientation": "unspecified", 53 "visible": true, 54 "srcPath": "EntryAbility", 55 "name": ".EntryAbility", 56 "srcLanguage": "ets", 57 "icon": "$media:icon", 58 "description": "$string:MainAbility_desc", 59 "formsEnabled": false, 60 "label": "$string:MainAbility_label", 61 "type": "page", 62 "launchType": "multiton" 63 } 64 ], 65 "distro": { 66 "moduleType": "entry", 67 "installationFree": false, 68 "deliveryWithInstall": true, 69 "moduleName": "entry" 70 }, 71 "package": "com.example.entry", 72 "srcPath": "", 73 "name": ".entry", 74 "js": [ 75 { 76 "mode": { 77 "syntax": "ets", 78 "type": "pageAbility" 79 }, 80 "pages": [ 81 "pages/Index" 82 ], 83 "name": ".EntryAbility", 84 "window": { 85 "designWidth": 720, 86 "autoDesignWidth": false 87 } 88 } 89 ] 90 } 91} 92``` 93 94## distro对象内部结构 95 96**表2** **distro对象内部结构说明** 97 98| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 99| -------- | -------- | -------- | -------- | 100| moduleName | 标识当前HAP的名称，最大长度为31个字节。 在应用升级时，该名称允许修改，但需要应用适配Module相关数据目录的迁移，可使用[文件操作接口](../reference/apis-core-file-kit/js-apis-file-fs.md#fscopydir10)。| 字符串 | 不可缺省。 | 101| moduleType | 标识当前HAP的类型，包括三种类型：entry、feature和har。 | 字符串 | 不可缺省。 | 102| installationFree | 标识当前HAP是否支持免安装特性。true：表示支持免安装特性，且符合免安装约束。false：表示不支持免安装特性。另外还需注意：当entry.hap该字段配置为true时，与该entry.hap相关的所有feature.hap该字段也需要配置为true。当entry.hap该字段配置为false时，与该entry.hap相关的各feature.hap该字段可按业务需求配置true或false。 | 布尔值 | 不可缺省。 | 103| deliveryWithInstall | 标识当前HAP是否在用户主动安装HAP所在应用的时候一起安装。true： 安装应用时当前HAP随应用一起下载安装。false：安装应用时当前HAP并不下载安装，后续使用是按需下载。 | 布尔值 | 不可缺省。 | 104 105 106distro示例： 107 108```json 109"distro": { 110 "moduleName": "ohos_entry", 111 "moduleType": "entry", 112 "installationFree": true, 113 "deliveryWithInstall": true 114} 115``` 116 117## metadata对象内部结构 118 119**表3** **metadata对象内部结构说明** 120 121| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 122| -------- | -------- | -------- | -------- | 123| parameters | 标识调用Ability时所有调用参数的元信息。每个调用参数的元信息由以下三个标签组成：description、name、type。 | 对象数组 | 可缺省，缺省值为空 | 124| results | 标识Ability返回值的元信息。每个返回值的元信息由以下三个标签组成：description、name、type。 | 对象数组 | 可缺省，缺省值为空。 | 125| customizeData | 该标签标识父级组件的自定义元信息，Parameters和results在application不可配。 | 对象数组 | 可缺省，缺省值为空。 | 126 127## parameters对象内部结构 128 129**表4** **parameters对象内部结构说明** 130 131| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 132| -------- | -------- | -------- | -------- | 133| description | 标识对调用参数的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。该标签最大长度为255个字节。 | 字符串 | 可缺省，缺省值为空。 | 134| name | 标识调用参数的名称。该标签最大长度为255个字节。 | 字符串 | 不可缺省。 | 135| type | 标识调用参数的类型，如Integer。 | 字符串 | 不可缺省。 | 136 137## results对象内部结构 138 139**表5** **results对象内部结构说明** 140 141| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 142| -------- | -------- | -------- | -------- | 143| description | 标识对返回值的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。该标签最大长度为255个字节。 | 字符串 | 可缺省，缺省值为空。 | 144| name | 标识返回值的名字。该标签最大长度为255个字节。 | 字符串 | 可缺省，缺省值为空。 | 145| type | 标识返回值的类型，如Integer。 | 字符串 | 不可缺省 | 146 147## customizeData对象的内部结构 148 149**表6** **customizeData对象的内部结构说明** 150 151| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 152| -------- | -------- | -------- | -------- | 153| name | 标识数据项的键名称，字符串类型（最大长度255字节）。 | 字符串 | 可缺省，缺省值为空。 | 154| value | 标识数据项的值名称，字符串类型（最大长度255字节）。 | 字符串 | 可缺省，缺省值为空。 | 155| extra | 标识用户自定义数据格式，标签值为标识该数据的资源的索引值。 | 字符串 | 可缺省，缺省值为空。 | 156 157 158metadata对象示例： 159 160```json 161"metaData": { 162 "parameters" : [{ 163 "name" : "a test for metadata parameter", 164 "type" : "Float", 165 // "$string:parameters_description"为文件资源索引值 166 "description" : "$string:parameters_description" 167 }], 168 "results" : [{ 169 "name" : "a test for metadata result", 170 "type" : "Float", 171 "description" : "$string:results_description" 172 }], 173 "customizeData" : [{ 174 "name" : "a customizeData", 175 "value" : "string", 176 "extra" : "$string:customizeData_description" 177 }] 178} 179``` 180 181## deviceType标签 182 183**表7** **deviceType标签配置说明** 184 185<!--RP2--> 186| 设备类型 | 枚举值 | 说明 | 187| -------- | -------- | -------- | 188| 平板 | tablet | - | 189| 智慧屏 | tv | - | 190| 智能手表 | wearable | 系统能力较丰富的手表，具备电话功能。 | 191| 运动表 | litewearable | - | 192| 车机 | car | - | 193| 默认设备 | default | 能够使用全部系统能力的设备。 | 194<!--RP2End--> 195 196## abilities对象的内部结构 197 198**表8** **abilities对象的内部结构说明** 199 200| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 201| -------- | -------- | -------- | -------- | 202| process | 运行应用程序或Ability的进程名称。如果在deviceConfig标记中配置了进程，则应用程序的所有能力都在此进程中运行。您还可以为特定能力设置流程属性，以便该能力可以在此流程中运行。如果此属性设置为与其他应用程序相同的进程名称，则所有这些应用程序可以在同一进程中运行，前提是他们具有相同的联合用户ID和相同的签名。该标签最大字节数为31个字节。 | 字符串 | 可缺省，缺省值为空。 | 203| name | 标识Ability名称。取值可采用反向域名方式表示，由包名和类名组成，如"com.example.myapplication.EntryAbility"；也可采用"."开头的类名方式表示，如".EntryAbility"。<br/>Ability的名称，需在一个应用的范围内保证唯一。说明：在使用DevEco Studio新建项目时，默认生成首个Ability的配置，即"config.json"中"EntryAbility"的配置。如使用其他IDE工具，可自定义名称。该标签最大长度为127个字节。 | 字符串 | 不可缺省 | 204| description | 标识对Ability的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。该标签最大长度为255个字节。 | 字符串 | 可缺省，缺省值为空。 | 205| icon | 标识Ability图标资源文件的索引。取值示例：$media:ability_icon。如果在该Ability的skills属性中，actions的取值包含 "action.system.home"，entities取值中包含"entity.system.home"，则该Ability的icon将同时作为应用的icon。如果存在多个符合条件的Ability，则取位置靠前的Ability的icon作为应用的icon。<br/>说明：应用的"icon"和"label"是用户可感知配置项，需要区别于当前所有已有的应用"icon"或"label"（至少有一个不同）。 | 字符串 | 可缺省，缺省值为空。 | 206| label | 标识Ability对用户显示的名称。取值是对该名称的资源索引，支持多语言，例：$string:ability_label。如果在该Ability的skills属性中，actions的取值包含 "action.system.home"，entities取值中包含"entity.system.home"，则该Ability的label将同时作为应用的label。如果存在多个符合条件的Ability，则取位置靠前的Ability的label作为应用的label。<br/>说明： 应用的"icon"和"label"是用户可感知配置项，需要区别于当前所有已有的应用"icon"或"label"（至少有一个不同）。该标签为资源文件中定义的字符串的引用，或以"{}"包括的字符串。该标签最大长度为255个字节。 | 字符串 | 可缺省，缺省值为空。 | 207| uri | 标识Ability的统一资源标识符。该标签最大长度为255个字节。 | 字符串 | 可缺省，对于data类型的Ability不可缺省。 | 208| launchType | 标识Ability的启动模式，支持"multiton"和"singleton"两种模式：<br/>multiton：表示该Ability可以有多实例。该模式适用于大多数应用场景。<br/>singleton：表示该Ability在所有任务栈中仅可以有一个实例。例如，具有全局唯一性的呼叫来电界面即采用"singleton"模式。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省，缺省值为"singleton"。 | 209| visible | 标识Ability是否可以被其他应用调用。<br/>true：可以被其他应用调用。<br/>false：不能被其他应用调用，包括无法被aa工具命令拉起应用。 | 布尔类型 | 可缺省，缺省值为"false"。 | 210| permissions | 标识其他应用的Ability调用此Ability时需要申请的权限集合，一个数组元素为一个权限名称。通常采用反向域名格式（最大255字节），取值为系统预定义的权限。 | 字符串数组 | 可缺省，缺省值为空。 | 211|skills | 标识Ability能够接收的want的特征。 | 对象数组 | 可缺省，缺省值为空。 | 212| deviceCapability | 标识Ability运行时要求设备具有的能力，采用字符串数组的格式表示。该标签为数组，支持最多配置512个元素，单个元素最大字节长度为64。 | 字符串数组 | 可缺省，缺省值为空。 | 213| metaData | 元数据。 | 对象 | 可缺省，缺省值为空。 | 214| type | 标识Ability的类型。取值范围如下：<br/>page：表示基于Page模板开发的FA，用于提供与用户交互的能力。<br/>service：表示基于Service模板开发的PA，用于提供后台运行任务的能力。<br/>data：表示基于Data模板开发的PA，用于对外部提供统一的数据访问对象。<br/>CA：表示支持其他应用以窗口方式调起该Ability。 | 字符串 | 不可缺省。 | 215| orientation | 标识该Ability的显示模式。该标签仅适用于page类型的Ability。取值范围如下：<br/>unspecified：由系统自动判断显示方向。<br/>landscape：横屏模式。<br/>portrait：竖屏模式。<br/>followRecent：跟随栈中最近的应用。 | 字符串 | 可缺省，缺省值为"unspecified"。 | 216| backgroundModes | 标识后台服务的类型，可以为一个服务配置多个后台服务类型。该标签仅适用于service类型的Ability。取值范围如下：<br/>dataTransfer：通过网络/对端设备进行数据下载、备份、分享、传输等。<br/>audioPlayback：音频播放。<br/>audioRecording：录音。<br/>pictureInPicture：画中画、小窗口播放视频。<br/>voip：音视频电话、VOIP。<br/>location：定位、导航。<br/>bluetoothInteraction：蓝牙扫描、连接、传输。<br/>wifiInteraction：Wi-Fi扫描、连接、传输。<br/>screenFetch：录屏、截屏。<br/>multiDeviceConnection：多设备互联。 | 字符串数组 | 可缺省，缺省值为空。 | 217| grantPermission | 指定是否可以向Ability内任何数据授予权限。 | 布尔值 | 可缺省，缺省值为空。 | 218| readPermission | 标识读取Ability的数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。该标签仅适用于默认设备、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省，缺省为空。 | 219| writePermission | 标识向Ability写数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。 | 字符串 | 可缺省，缺省为空。 | 220| configChanges | 标识Ability关注的系统配置集合。当已关注的配置发生变更后，Ability会收到onConfigurationUpdated回调。取值范围：<br/>mcc：表示IMSI移动设备国家/地区代码（MCC）发生变更。典型场景：检测到SIM并更新MCC。<br/>mnc：IMSI移动设备网络代码（MNC）发生变更。典型场景：检测到SIM并更新MNC。<br/>locale：表示语言区域发生变更。典型场景：用户已为设备文本的文本显示选择新的语言类型。<br/>layout：表示屏幕布局发生变更。典型场景：当前有不同的显示形态都处于活跃状态。<br/>fontSize：表示字号发生变更。典型场景：用户已设置新的全局字号。<br/>orientation：表示屏幕方向发生变更。典型场景：用户旋转设备。<br/>density：表示显示密度发生变更。典型场景：用户可能指定不同的显示比例，或当前有不同的显示形态同时处于活跃状态。<br/>size：显示窗口大小发生变更。<br/>smallestSize：显示窗口较短边的边长发生变更。<br/>colorMode：颜色模式发生变更。 | 字符串数组 | 可缺省，缺省为空。 | 221| mission | 标识Ability指定的任务栈。该标签仅适用于page类型的Ability。默认情况下应用中所有Ability同属一个任务栈。 | 字符串 | 可缺省，缺省为应用的包名。 | 222| targetAbility | 标识当前Ability重用的目标Ability。该标签仅适用于page类型的Ability。如果配置了targetAbility属性，则当前Ability（即别名Ability）的属性中仅name、icon、label、visible、permissions、skills生效，其他属性均沿用targetAbility中的属性值。目标Ability必须与别名Ability在同一应用中，且在配置文件中目标Ability必须在别名之前进行声明。 | 字符串 | 可缺省，缺省值为空。表示当前Ability不是一个别名Ability。 | 223| formsEnabled | 标识Ability是否支持卡片（forms）功能。该标签仅适用于page类型的Ability。<br/>true：支持卡片能力。<br/>false：不支持卡片能力。 | 布尔值 | 可缺省，缺省值为false。 | 224| forms | 标识服务卡片的属性。该标签仅当formsEnabled为"true"时，才能生效。 | 对象数组 | 可缺省，缺省值为空。 | 225| srcLanguage | Ability开发语言的类型，开发者创建工程时由开发者手动选择开发语言。取值如下："js"、"ets"、"java"。 | 字符串 | 可缺省，缺省值为"js"。 | 226| srcPath | 该标签标识Ability对应的JS组件代码路径，该标签最大长度为127字节。 | 字符串 | 不可缺省。 | 227| uriPermission | 标识该Ability有权访问的应用程序数据。此属性由模式和路径子属性组成。此属性仅对类型提供者的能力有效。 | 对象 | 可缺省，缺省值为空。 | 228| startWindowIcon | 标识该Ability启动页面图标资源文件的索引。该标签仅适用于page类型的Ability。取值示例：$media:icon。 | 字符串 | 可缺省，缺省值为空。 | 229| startWindowBackground | 标识该Ability启动页面背景颜色资源文件的索引。该标签仅适用于page类型的Ability。取值示例：$color:red。 | 字符串 | 可缺省，缺省值为空。 | 230| removeMissionAfterTerminate | 该标签标识Ability销毁后是否从任务列表中移除任务。该标签仅适用于page类型的Ability。true表示销毁后移除任务， false表示销毁后不移除任务。 | 布尔值 | 可缺省，缺省值为false。 | 231 232 233**不允许应用隐藏入口图标** 234 235系统对无图标应用实施严格管控，防止一些恶意应用故意配置无入口图标，导致用户找不到软件所在的位置，无法操作卸载应用，在一定程度上保证用户终端设备的安全。 236 237**入口图标的设置:** 需要在配置文件（config.json）中abilities配置下设置icon，label以及skills，而且skills的配置下必须同时包含“ohos.want.action.home” 和 “entity.system.home”。 238``` 239{ 240 "module":{ 241 242 ... 243 244 "abilities": [{ 245 "icon": "$media:icon", 246 "label": "Login", 247 "skills": [{ 248 "actions": ["ohos.want.action.home"], 249 "entities": ["entity.system.home"], 250 "uris": [] 251 }] 252 }], 253 254 ... 255 256 } 257} 258``` 259 260如果应用确需隐藏入口图标，需要配置AllowAppDesktopIconHide应用特权<!--Del-->，具体配置方式参考[应用特权配置指南](../../device-dev/subsystems/subsys-app-privilege-config-guide.md)<!--DelEnd-->。详细的入口图标及入口标签的显示规则如下。 261* HAP中包含Page类型的PageAbility 262 * 配置文件（config.json）中abilities配置中设置了入口图标 263 * 该应用没有隐藏图标的特权 264 * 系统将使用该PageAbility配置的icon作为入口图标，并显示在桌面上。用户点击该图标，页面跳转到该PageAbility首页。 265 * 系统将使用该PageAbility配置的label作为入口标签，并显示在桌面上（如果没有配置label，返回包名）。 266 * 该应用具有隐藏图标的特权 267 * 桌面查询时不返回应用信息，不会在桌面上显示对应的入口图标和标签。 268 * 配置文件（config.json）中abilities配置中未设置入口图标 269 * 该应用没有隐藏图标的特权 270 * 系统将使用系统默认图标作为入口图标，并显示在桌面上。用户点击该图标，页面跳转到应用管理中对应的应用详情页面（参考下图）。 271 * 系统将使用应用的包名作为入口标签，并显示在桌面上。 272 * 该应用具有隐藏图标的特权 273 * 桌面查询时不返回应用信息，不会在桌面上显示对应的入口图标和标签。 274* HAP中不包含Page类型的PageAbility 275 * 该应用没有隐藏图标的特权 276 * 系统将使用系统默认图标作为入口图标，并显示在桌面上。用户点击该图标，页面跳转到应用管理中对应的应用详情页面（参考下图）。 277 * 系统将使用应用的包名作为入口标签，并显示在桌面上。 278 * 该应用具有隐藏图标的特权 279 * 桌面查询时不返回应用信息，不会在桌面上显示对应的入口图标和标签。 280 281**图1** 应用的详情页示意图 282 283 284 285注：应用详情页面中显示的label可能与桌面上显示的不同。如果非Page类型的PageAbility配置了入口图标和label，那么详情页中显示的即为配置的。<br> 286## uriPermission对象的内部结构 287 288**表9** **uriPermission对象的内部结构说明** 289 290| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 291| -------- | -------- | -------- | -------- | 292| path | uriPermission标识的路径，该标签最大字节长度为255个字节。 | 字符串 | 不可缺省。 | 293| mode | uriPermission的匹配模式。 | 字符串 | 可缺省，缺省值为default。 | 294 295 296abilities示例： 297 298```json 299"abilities": [ 300 { 301 "name": ".EntryAbility", 302 "description": "test main ability", 303 // $media:ic_launcher 为媒体类资源 304 "icon": "$media:ic_launcher", 305 // $string:example 为字符串类资源 306 "label": "$string:example", 307 "launchType": "multiton", 308 "orientation": "unspecified", 309 "permissions": [], 310 "visible": true, 311 "skills": [ 312 { 313 "actions": [ 314 "action.system.home" 315 ], 316 "entities": [ 317 "entity.system.home" 318 ] 319 } 320 ], 321 "configChanges": [ 322 "locale", 323 "layout", 324 "fontSize", 325 "orientation" 326 ], 327 "type": "page", 328 "startWindowIcon": "$media:icon", 329 "startWindowBackground": "$color:red", 330 "removeMissionAfterTerminate": true 331 }, 332 { 333 "name": ".PlayService", 334 "description": "example play ability", 335 "icon": "$media:ic_launcher", 336 "label": "$string:example", 337 "launchType": "multiton", 338 "orientation": "unspecified", 339 "visible": false, 340 "skills": [ 341 { 342 "actions": [ 343 "action.play.music", 344 "action.stop.music" 345 ], 346 "entities": [ 347 "entity.audio" 348 ] 349 } 350 ], 351 "type": "service", 352 "backgroundModes": [ 353 "audioPlayback" 354 ] 355 }, 356 { 357 "name": ".UserADataAbility", 358 "type": "data", 359 "uri": "dataability://com.example.world.test.UserADataAbility", 360 "visible": true 361 } 362] 363``` 364## skills对象的内部结构 365 366**表10** **skills对象的内部结构说明** 367 368| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 369| -------- | -------- | -------- | -------- | 370| actions | 标识能够接收的want的action值，可以包含一个或多个action。取值通常为系统预定义的action值。 | 字符串数组 | 可缺省，缺省值为空。 | 371| entities | 标识能够接收的want的Ability的类别（如视频、桌面应用等），可以包含一个或多个entity。 | 字符串数组 | 可缺省，缺省值为空。 | 372| uris | 该标签标识向want过滤器添加数据规范集合。该规范可以是只有数据类型（mimeType属性），可以是只有URI，也可以是既有数据类型又有URI。<br/>URI由其各个部分的单独属性指定：<scheme>://<host>:<port>[<path>\|<pathStartWith>\|<pathRegex>]。该标签可缺省，缺省值为空。<br/>其中，scheme字段配置为uri时必配；当只设置数据类型（mimeType）时，则scheme字段为非必配项。 | 对象数组 | 可缺省，缺省值为空。 | 373 374## uris对象的内部结构 375 376**表11** **uris对象的内部结构说明** 377 378| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 379| -------- | -------- | -------- | -------- | 380| scheme | 标识uri的scheme值。 | 字符串 | 不可缺省。 | 381| host | 标识uri的host值。 | 字符串 | 可缺省，缺省值为空。 | 382| port | 标识uri的port值。 | 字符串 | 可缺省，缺省值为空。 | 383| pathStartWith | 标识uri的pathStartWith值。 | 字符串 | 可缺省，缺省值为空。 | 384| path | 标识uri的path值。 | 字符串 | 可缺省，缺省值为空。 | 385| pathRegx | 标识uri的pathRegx值。 | 字符串 | 可缺省，缺省值为空。 | 386| type | 标识uri的type值。type为MIME-TYPE属性，为资源的媒体类型，常见的类型有"audio/aac"，"text/css"等。<br/>注意：只支持*/*、mainType/*的通配符格式，不支持mainType/subType.*的通配符格式，mainType为标准媒体类型。| 字符串 | 可缺省，缺省值为空。 | 387 388 389skills示例： 390 391```json 392"skills": [ 393 { 394 "actions": [ 395 "action.system.home" 396 ], 397 "entities": [ 398 "entity.system.home" 399 ], 400 "uris": [ 401 { 402 "scheme": "http", 403 "host": "www.example.com", 404 "port": "8080", 405 "path": "query/student/name", 406 "type": "text/*" 407 } 408 ] 409 } 410] 411``` 412 413## reqPermissions权限申请 414 415**表12** **reqPermissions权限申请字段说明** 416 417| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 418| -------- | -------- | -------- | -------- | 419| name | 需要使用的权限名称。 | 字符串 | 否 | 420| reason | 描述申请权限的原因。需要做多语种适配。 | 字符串 | 分情况：当申请的权限为user_grant时，必须填写此字段，否则不允许在应用市场上架；其他权限可缺省，缺省为空 | 421| usedScene | 描述权限使用的场景和时机。场景类型如下两种：<br/>- ability：ability的名称，可配置多个。<br/>- when：调用时机，可填的值有inuse（使用时）、always（始终）。 | 对象 | 可缺省，缺省值为空。<br/>when可缺省，缺省值为"inuse" | 422 423## usedScene对象内部结构 424 425**表13** **usedScene对象内部结构说明** 426 427| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 428| -------- | -------- | -------- | -------- | 429| ability | 标识哪些Ability需要此权限，里面配置Ability的名称。 | 字符串数组 | 可以缺省，缺省表示所有Ability都需要此权限。 | 430| when | 标识此权限的使用时间：<br/>inuse: 使用时需要此权限。<br/>always: 所有时间都需要此权限。 | 枚举值 | 可缺省，缺省值为空。 | 431 432## js对象的内部结构 433 434**表14** **js对象的内部结构说明** 435 436| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 437| -------- | -------- | -------- | -------- | 438| name | 标识JS Component的名字。 | 字符串 | 不可缺省。 | 439| pages | 标识JS Component的页面用于列举JS Component中每个页面的路由信息，格式为“页面路径+页面名称”。其中，页面路径是以当前Ability的srcPath字段取值为基准，例如srcPath取值为EntryAbility，则JS Component页面路径需要从EntryAbility的下一层开始描述。该标签取值为数组，数组第一个元素代表JS FA首页。 | 字符串数组 | 不可缺省。 | 440| window | 用于定义与显示窗口相关的配置。 | 对象 | 可缺省，缺省值见表15。 | 441| type | 标识JS应用的类型。取值范围如下：<br/>normal：标识该JS Component为应用实例。<br/>form：标识该JS Component为卡片实例。 | 字符串 | 可缺省，缺省值为"normal"。 | 442|mode | 定义JS组件的开发模式。 | 对象 | 可缺省，缺省值为空。 | 443 444## window对象的内部结构 445 446**表15** **window对象的内部结构说明** 447 448| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 449| -------- | -------- | -------- | -------- | 450| designWidth | 标识页面设计基准宽度。以此为基准，根据实际设备宽度来缩放元素大小。 | 数值 | 可缺省，缺省值为720px。 | 451| autoDesignWidth | 标识页面设计基准宽度是否自动计算。当配置为true时，designWidth将会被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。 | 布尔值 | 可缺省，缺省值为false。 | 452 453## mode对象的内部结构 454 455**表16** **mode对象的内部结构说明** 456 457| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 458| -------- | -------- | -------- | -------- | 459| type | 定义JS组件的功能类型。 | 字符串，取值为"pageAbility"、"form" | 可缺省，缺省值为pageAbility。 | 460| syntax | 定义JS组件的语法类型。 | 字符串，取值为"hml"，"ets" | 可缺省，默认值为"hml"。 | 461 462 463js示例： 464 465```json 466"js": [ 467 { 468 "name": ".EntryAbility", 469 "pages": [ 470 "pages/index", 471 "pages/detail/detail" 472 ], 473 "window": { 474 "designWidth": 720, 475 "autoDesignWidth": false 476 }, 477 "type": "form", 478 "mode": { 479 "syntax": "ets", 480 "type": "pageAbility" 481 } 482 } 483] 484``` 485 486## shortcuts对象的内部结构 487 488**表17** **shortcuts对象的内部结构说明** 489 490| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 491| -------- | -------- | -------- | -------- | 492| shortcutId | 标识快捷方式的ID。字符串的最大长度为63字节。 | 字符串 | 不可缺省。 | 493| label | 标识快捷方式的标签信息，即快捷方式对外显示的文字描述信息。取值可以是描述性内容，也可以是标识label的资源索引。字符串最大长度为63字节。 | 字符串 | 可缺省，缺省为空。 | 494| icon | 标识快捷方式的图标信息。取值为表示icon的资源索引。 | 字符串 | 可缺省，缺省为空。 | 495| intents | 标识快捷方式内定义的目标intent信息集合，每个intent可配置两个子标签，targetClass, targetBundle。 | 对象数组 | 可缺省，缺省为空。 | 496 497## intents对象的内部结构 498 499**表18** **intents对象的内部结构说明** 500 501| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 502| -------- | -------- | -------- | -------- | 503| targetClass | 标识快捷方式目标类名。 | 字符串 | 可缺省，缺省值为空。 | 504| targetBundle | 标识快捷方式目标Ability所在应用的包名。 | 字符串 | 可缺省，缺省值为空。 | 505 506 507shortcuts示例： 508 509```json 510"shortcuts": [ 511 { 512 "shortcutId": "id", 513 // $string:shortcut 为配置的字符串资源值 514 "label": "$string:shortcut", 515 "intents": [ 516 { 517 "targetBundle": "com.example.world.test", 518 "targetClass": "com.example.world.test.entry.EntryAbility" 519 } 520 ] 521 } 522] 523``` 524 525## forms对象的内部结构 526 527**表19** **forms对象的内部结构说明** 528 529| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 530| -------- | -------- | -------- | -------- | 531| name | 标识卡片的类名。字符串最大长度为127字节。 | 字符串 | 不可缺省。 | 532| description | 标识卡片的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。字符串最大长度为255字节。 | 字符串 | 可缺省，缺省为空。 | 533| isDefault | 标识该卡片是否为默认卡片，每个Ability有且只有一个默认卡片。<br/>true：默认卡片。<br/>false：非默认卡片。 | 布尔值 | 不可缺省。 | 534| type | 标识卡片的类型。取值范围如下：<br/>JS：JS卡片。<br/>Java：Java卡片。 | 字符串 | 不可缺省。 | 535| colorMode | 标识卡片的主题样式，取值范围如下：<br/>auto：自适应。<br/>dark：深色主题。<br/>light：浅色主题。 | 字符串 | 可缺省，缺省值为"auto"。 | 536| 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列的十六宫格。 | 字符串数组 | 不可缺省。 | 537| defaultDimension | 标识卡片的默认外观规格，取值必须在该卡片supportDimensions配置的列表中。 | 字符串 | 不可缺省。 | 538| updateEnabled | 标识卡片是否支持周期性刷新，取值范围：<br/>true：表示支持周期性刷新，可以在定时刷新（updateDuration）和定点刷新（scheduledUpdateTime）两种方式任选其一，优先选择定时刷新。<br/>false：表示不支持周期性刷新。 | 布尔类型 | 不可缺省。 | 539| scheduledUpdateTime | 标识卡片的定点刷新的时刻，采用24小时制，精确到分钟。 | 字符串 | 可缺省，缺省值为"0:0"。 | 540| updateDuration | 标识卡片定时刷新的更新周期，单位为30分钟，取值为自然数。<br/>当取值为0时，表示该参数不生效。<br/>当取值为正整数N时，表示刷新周期为30\*N分钟。 | 数值 | 可缺省，缺省值为"0"。 | 541| formConfigAbility | 标识用于调整卡片的设施或活动的名称。 | 字符串 | 可缺省，缺省值为空。 | 542| jsComponentName | 标识JS卡片的Component名称。字符串最大长度为127字节。仅当卡片类型为JS卡片时，需要配置该标签。 | 字符串 | 可缺省，缺省值为空。 | 543| metaData | 标识卡片的自定义信息，包含customizeData数组标签。 | 对象 | 可缺省，缺省值为空。 | 544| formVisibleNotify | 标识是否允许卡片使用卡片可见性通知。<br/>true：允许。<br/>false：不允许。 | 布尔值 | 可缺省，缺省值为false。 | 545 546## customizeData对象内部结构 547 548**表20** **customizeData对象内部结构说明** 549 550| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 551| -------- | -------- | -------- | -------- | 552| name | 标识数据项的键名称。字符串最大长度为255字节。 | 字符串 | 可缺省，缺省值为空。 | 553| value | 标识数据项的值。字符串最大长度为255字节。 | 字符串 | 可缺省，缺省值为空。 | 554| extra | 标识当前custom数据的格式，取值为表示extra的资源值。 | 字符串 | 可缺省，缺省值为空。 | 555 556 557forms示例： 558 559```json 560"forms": [ 561 { 562 "name": "Form_Js", 563 "description": "It's Js Form", 564 "type": "JS", 565 "jsComponentName": "card", 566 "colorMode": "auto", 567 "isDefault": true, 568 "updateEnabled": true, 569 "scheduledUpdateTime": "11:00", 570 "updateDuration": 1, 571 "defaultDimension": "2*2", 572 "supportDimensions": [ 573 "2*2", 574 "2*4", 575 "4*4" 576 ] 577 }, 578 { 579 "name": "Form_Js", 580 "description": "It's JS Form", 581 "type": "Js", 582 "colorMode": "auto", 583 "isDefault": false, 584 "updateEnabled": true, 585 "scheduledUpdateTime": "21:05", 586 "updateDuration": 1, 587 "defaultDimension": "1*2", 588 "supportDimensions": [ 589 "1*2" 590 ], 591 "landscapeLayouts": [ 592 "$layout:ability_form" 593 ], 594 "portraitLayouts": [ 595 "$layout:ability_form" 596 ], 597 "formConfigAbility": "ability://com.example.myapplication.fa/.EntryAbility", 598 "metaData": { 599 "customizeData": [ 600 { 601 "name": "originWidgetName", 602 "value": "com.example.weather.testWidget" 603 } 604 ] 605 } 606 } 607] 608``` 609 610## distroFilter对象的内部结构 611 612**表21** **distroFilter对象的内部结构说明** 613 614| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 615| -------- | -------- | -------- | -------- | 616| apiVersion | 标识支持的apiVersion范围。 | 对象数组 | 可缺省，缺省值为空。 | 617|screenShape | 标识屏幕形状的支持策略。 | 对象数组 | 可缺省，缺省值为空。 | 618| screenWindow | 标识应用运行时窗口的分辨率支持策略。该字段仅支持对轻量级智能穿戴设备进行配置。 | 对象数组 | 可缺省，缺省值为空。 | 619|screenDensity | 标识屏幕的像素密度（dpi：Dots Per Inch）。 | 对象数组 | 可缺省，缺省值为空。 | 620| countryCode | 标识分发应用时的国家码。具体值参考ISO-3166-1的标准，支持多个国家和地区的枚举定义。 | 对象数组 | 可缺省，缺省值为空。 | 621 622## apiVersion对象的内部结构 623 624**表22** **apiVersion对象的内部结构说明** 625 626| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 627| -------- | -------- | -------- | -------- | 628| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示需要排除的value属性。<br/>- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | 629| value | 支持的取值为API Version存在的整数值，例如4、5、6。场景示例：某应用，针对相同设备型号，同时在网的为使用API 5和API 6开发的两个软件版本，则允许上架2个entry类型的安装包，分别支持到对应设备侧软件版本的分发。 | 数组 | 不可缺省。 | 630 631## screenShape对象的内部结构 632 633**表23** **screenShape对象的内部结构说明** 634 635| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 636| -------- | -------- | -------- | -------- | 637| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示需要排除的value属性。<br/>- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | 638| value | 支持的取值为API Version存在的整数值，例如4、5、6。场景示例：某应用，针对相同设备型号，同时在网的为使用API 5和API 6开发的两个软件版本，则允许上架2个entry类型的安装包，分别支持到对应设备侧软件版本的分发。 | 数组 | 不可缺省。 | 639 640## screenWindow对象的内部结构 641 642**表24** **screenWindow对象的内部结构说明** 643 644| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 645| -------- | -------- | -------- | -------- | 646| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示需要排除的value属性。<br/>- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | 647| value | 支持的取值为API Version存在的整数值，例如4、5、6。场景示例：某应用，针对相同设备型号，同时在网的为使用API 5和API 6开发的两个软件版本，则允许上架2个entry类型的安装包，分别支持到对应设备侧软件版本的分发。 | 数组 | 不可缺省。 | 648 649## screenDensity对象的内部结构 650 651**表25** **screenDensity对象的内部结构说明** 652 653| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 654| -------- | -------- | -------- | -------- | 655| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示需要排除的value属性。<br/>- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | 656| 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]的设备。 | 数组 | 不可缺省。 | 657 658## countryCode对象的内部结构 659 660**表26** **countryCode对象的内部结构说明** 661 662| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 663| -------- | -------- | -------- | -------- | 664| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示需要排除的value属性。<br/>- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | 665| value | 该标签标识应用需要分发的国家码，标签为字符串数组，子串表示支持的国家或地区，由两个大写字母表示。 | 字符串数组 | 不可缺省。 | 666 667 668distroFilter示例： 669 670```json 671"distroFilter": { 672 "apiVersion": { 673 "policy": "include", 674 "value": [4,5] 675 }, 676 "screenShape": { 677 "policy": "include", 678 "value": ["circle","rect"] 679 }, 680 "screenWindow": { 681 "policy": "include", 682 "value": ["454*454","466*466"] 683 }, 684 "screenDensity":{ 685 "policy": "exclude", 686 "value": ["ldpi","xldpi"] 687 }, 688 "countryCode": { 689 "policy":"include", 690 "value":["CN","HK"] 691 } 692} 693``` 694 695## commonEvents对象的内部结构 696 697**表27** **commonEvents对象的内部结构说明** 698 699| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 700| -------- | -------- | -------- | -------- | 701| name | 标识静态公共事件名称，该标签最大长度为127字节。 | 字符串 | 不可缺省。 | 702| permission | 此标签标识实现静态公共事件所需要申请的权限，该标签最大长度为255字节。 | 字符串 | 可缺省，缺省值为空。 | 703| data | 标识配置当前静态公共事件要携带的附加数据数组。 | 字符串数组 | 可缺省，缺省值为空。 | 704| type | 该标签用于配置当前静态公共事件的分类数组。 | 字符串数组 | 可缺省，缺省值为空。 | 705| events | 此标签标识可接收的意图的一组事件值。一般由系统预定义，也可以自定义。 | 字符串数组 | 不可缺省。 | 706 707 708commonEvents示例： 709 710```json 711"commonEvents": [ 712 { 713 "name": ".EntryAbility", 714 "permission": "ohos.permission.GET_BUNDLE_INFO", 715 "data": [ 716 "com.example.demo", 717 "100" 718 ], 719 "events": [ 720 "install", 721 "update" 722 ] 723 } 724] 725``` 726 727## testRunner对象的内部结构 728 729**表28** **testRunner对象的内部结构说明** 730 731| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 732| -------- | -------- | -------- | -------- | 733| name | 标识测试框架对象名称，该标签最大长度为255字节。 | 字符串 | 不可缺省。 | 734| srcPath | 标识测试框架代码路径，该标签最大长度为255字节。 | 字符串 | 不可缺省。 | 735 736```json 737"testRunner": { 738 "name": "myTestRunnerName", 739 "srcPath": "etc/test/TestRunner.ts" 740} 741``` 742 743 744definePermission仅支持系统应用配置，三方应用配置不生效。 745 746## definePermissions对象内部结构 747**表29** **definePermissions对象内部结构说明** 748 749| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 750| -------- | -------- | -------- | -------- | 751| name | 标识权限的名称，该标签最大长度为255字节。 | 字符串 | 不可缺省。 | 752| grantMode | 标识权限的授予方式，支持如下两种授予模式如下：<br/>- system_grant：安装后系统自动授予该权限。<br/>- user_grant：使用时动态申请，用户授权后才可使用。 | 字符串 | 可缺省，缺省值为system_grant。 | 753| availableLevel | 标识权限限制类别，可选值如下：<br/>- system_core：系统核心权限。<br/>- system_basic：系统基础权限。<br/>- normal：普通权限。所有应用允许申请的权限。 | 字符串 | 可缺省，缺省值为normal。 | 754| provisionEnable | 标识权限是否支持证书方式申请权限，包括高级别的权限。配置为true标识开发者可以通过provision方式申请权限。 | 布尔值 | 可缺省，缺省值为true。 | 755| distributedSceneEnabled | 标识权限是否支持分布式场景下使用该权限。 | 布尔值 | 可缺省，缺省值为false。 | 756| label | 标识权限的简短描述，配置为对描述内容的资源索引。 | 字符串 | 可缺省，缺省值为空。 | 757| description | 标识权限的详细描述，可以是字符串（最大长度为255字节），或者为对描述内容的资源索引。 | 字符串 | 可缺省，缺省值为空。 | 758
