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