1e41f4b71Sopenharmony_ci# Unpacking Tool 2e41f4b71Sopenharmony_ci 3e41f4b71Sopenharmony_ci 4e41f4b71Sopenharmony_ciThe unpacking tool is a commissioning tool used to unpack HAP (an application package), HSP (dynamically shared library), and APP (application set to launch to the application market) files. It also provides Java APIs to parse the HAP, HSP, and APP files. 5e41f4b71Sopenharmony_ci 6e41f4b71Sopenharmony_ci 7e41f4b71Sopenharmony_ciThe **app_unpacking_tool.jar** package can be found in the OpenHarmony SDK downloaded locally. 8e41f4b71Sopenharmony_ci 9e41f4b71Sopenharmony_ci 10e41f4b71Sopenharmony_ci## Constraints 11e41f4b71Sopenharmony_ci 12e41f4b71Sopenharmony_ciThe unpacking tool must run in Java8 or later. 13e41f4b71Sopenharmony_ci 14e41f4b71Sopenharmony_ci 15e41f4b71Sopenharmony_ci## Unpacking Commands 16e41f4b71Sopenharmony_ci 17e41f4b71Sopenharmony_ci### Unpacking Commands for HAP Files 18e41f4b71Sopenharmony_ci 19e41f4b71Sopenharmony_ciYou can use the JAR package of the unpacking tool to unpack an HAP file by importing unpacking options and file paths. 20e41f4b71Sopenharmony_ci 21e41f4b71Sopenharmony_ci#### Example 22e41f4b71Sopenharmony_ci 23e41f4b71Sopenharmony_ci``` 24e41f4b71Sopenharmony_cijava -jar app_unpacking_tool.jar --mode hap --hap-path <path> --out-path <path> [--force true] 25e41f4b71Sopenharmony_ci``` 26e41f4b71Sopenharmony_ci 27e41f4b71Sopenharmony_ci#### Parameters 28e41f4b71Sopenharmony_ci 29e41f4b71Sopenharmony_ci| Name | Mandatory| Option | Description | 30e41f4b71Sopenharmony_ci| ---------- | ---------- | ------------- | ------------------------------------------------------------ | 31e41f4b71Sopenharmony_ci| --mode | Yes | hap | Unpacking mode. | 32e41f4b71Sopenharmony_ci| --hap-path | Yes | NA | Path of the HAP file. | 33e41f4b71Sopenharmony_ci| --rpcid | No | true or false| Whether to extract the rpcid file from the HAP file to a specified directory. If the value is **true**, only the rpcid file is extracted and the HAP file is not unpacked.| 34e41f4b71Sopenharmony_ci| --out-path | Yes | NA | Path of the target files. | 35e41f4b71Sopenharmony_ci| --force | No | true or false| The default value is **false**. If the value is **true**, an existing target file will be forcibly deleted during unpacking. | 36e41f4b71Sopenharmony_ci 37e41f4b71Sopenharmony_ci### Unpacking Commands for APP Files 38e41f4b71Sopenharmony_ci 39e41f4b71Sopenharmony_ciYou can use the JAR package of the unpacking tool to unpack an APP file by importing unpacking options and file paths. 40e41f4b71Sopenharmony_ci 41e41f4b71Sopenharmony_ci#### Example 42e41f4b71Sopenharmony_ci 43e41f4b71Sopenharmony_ci``` 44e41f4b71Sopenharmony_cijava -jar app_unpacking_tool.jar --mode app --app-path <path> --out-path <path> [--force true] 45e41f4b71Sopenharmony_ci``` 46e41f4b71Sopenharmony_ci 47e41f4b71Sopenharmony_ci#### Parameters 48e41f4b71Sopenharmony_ci 49e41f4b71Sopenharmony_ci| Name | Mandatory| Option | Description | 50e41f4b71Sopenharmony_ci| ---------- | ---------- |-------------| ----------------------------------------------------------- | 51e41f4b71Sopenharmony_ci| --mode | Yes | app | Unpacking mode. | 52e41f4b71Sopenharmony_ci| --app-path | Yes | NA | Path of the APP file. | 53e41f4b71Sopenharmony_ci| --out-path | Yes | NA | Path of the target files. | 54e41f4b71Sopenharmony_ci| --force | No | true or false| The default value is **false**. If the value is **true**, an existing target file will be forcibly deleted during unpacking.| 55e41f4b71Sopenharmony_ci 56e41f4b71Sopenharmony_ci### Obtaining the rpcid File from the HAP File 57e41f4b71Sopenharmony_ci 58e41f4b71Sopenharmony_ciYou can use the JAR package of the unpacking tool to unpack an HAP file to obtain the rpcid file by importing unpacking options and file paths. 59e41f4b71Sopenharmony_ci 60e41f4b71Sopenharmony_ci#### Example 61e41f4b71Sopenharmony_ci 62e41f4b71Sopenharmony_ci``` 63e41f4b71Sopenharmony_cijava -jar app_unpacking_tool.jar --mode hap --rpcid true --hap-path <path> --out-path <path> [--force true] 64e41f4b71Sopenharmony_ci``` 65e41f4b71Sopenharmony_ci 66e41f4b71Sopenharmony_ci#### Parameters 67e41f4b71Sopenharmony_ci 68e41f4b71Sopenharmony_ci| Name | Mandatory| Option | Description | 69e41f4b71Sopenharmony_ci| ---------- | ---------- | ------------- | ------------------------------------------------------------ | 70e41f4b71Sopenharmony_ci| --mode | Yes | hap | Unpacking mode. | 71e41f4b71Sopenharmony_ci| --rpcid | No | true or false| Whether to extract the rpcid file from the HAP file to a specified directory. If the value is **true**, only the rpcid file is extracted and the HAP file is not unpacked.| 72e41f4b71Sopenharmony_ci| --hap-path | Yes | NA | Path of the HAP file. | 73e41f4b71Sopenharmony_ci| --out-path | Yes | NA | Path of the target rpcid file. | 74e41f4b71Sopenharmony_ci| --force | No | true or false| The default value is **false**. If the value is **true**, an existing target file will be forcibly deleted during unpacking. | 75e41f4b71Sopenharmony_ci 76e41f4b71Sopenharmony_ci### Unpacking Commands for HSP Files 77e41f4b71Sopenharmony_ci 78e41f4b71Sopenharmony_ciYou can use the JAR package of the unpacking tool to unpack an HSP file by importing unpacking options and file paths. 79e41f4b71Sopenharmony_ci 80e41f4b71Sopenharmony_ci#### Example 81e41f4b71Sopenharmony_ci 82e41f4b71Sopenharmony_ci``` 83e41f4b71Sopenharmony_cijava -jar app_unpacking_tool.jar --mode hsp --hsp-path <path> --out-path <path> [--force true] 84e41f4b71Sopenharmony_ci``` 85e41f4b71Sopenharmony_ci 86e41f4b71Sopenharmony_ci#### Parameters 87e41f4b71Sopenharmony_ci 88e41f4b71Sopenharmony_ci| Name | Mandatory| Option | Description | 89e41f4b71Sopenharmony_ci|------------| ---------- | ------------- |------------------------------------| 90e41f4b71Sopenharmony_ci| --mode | Yes | hsp | Unpacking mode. | 91e41f4b71Sopenharmony_ci| --hsp-path | Yes | NA | Path of the HSP file. | 92e41f4b71Sopenharmony_ci| --out-path | Yes | NA | Path of the target files. | 93e41f4b71Sopenharmony_ci| --force | No | true or false| The default value is **false**. If the value is **true**, an existing target file will be forcibly deleted during unpacking.| 94e41f4b71Sopenharmony_ci 95e41f4b71Sopenharmony_ci### Unpacking Commands for APPQF Files 96e41f4b71Sopenharmony_ci 97e41f4b71Sopenharmony_ciYou can use the JAR package of the unpacking tool to unpack an APPQF file by importing unpacking options and file paths. 98e41f4b71Sopenharmony_ci 99e41f4b71Sopenharmony_ci#### Example 100e41f4b71Sopenharmony_ci 101e41f4b71Sopenharmony_ci``` 102e41f4b71Sopenharmony_cijava -jar app_unpacking_tool.jar --mode appqf --appqf-path <path> --out-path <path> [--force true] 103e41f4b71Sopenharmony_ci``` 104e41f4b71Sopenharmony_ci 105e41f4b71Sopenharmony_ci#### Parameters 106e41f4b71Sopenharmony_ci 107e41f4b71Sopenharmony_ci| Name | Mandatory| Option | Description | 108e41f4b71Sopenharmony_ci|--------------| ---------- |-------------|------------------------------------| 109e41f4b71Sopenharmony_ci| --mode | Yes | appqf | Unpacking mode. | 110e41f4b71Sopenharmony_ci| --appqf-path | Yes | NA | Path of the APPQF file. | 111e41f4b71Sopenharmony_ci| --out-path | Yes | NA | Path of the target files. | 112e41f4b71Sopenharmony_ci| --force | No | true or false| The default value is **false**. If the value is **true**, an existing target file will be forcibly deleted during unpacking.| 113e41f4b71Sopenharmony_ci 114e41f4b71Sopenharmony_ci## Package Parsing APIs 115e41f4b71Sopenharmony_ci 116e41f4b71Sopenharmony_ciThe package parsing APIs are used by the application market to parse an HAP, HSP, or APP file and obtain information such as the configuration file. 117e41f4b71Sopenharmony_ci 118e41f4b71Sopenharmony_ci### Available APIs 119e41f4b71Sopenharmony_ci 120e41f4b71Sopenharmony_ci| Class | Prototype | Type | Description | 121e41f4b71Sopenharmony_ci| ------------------ | ------------------------------------------------------------ | -------- |-------------------------------------------------------------------| 122e41f4b71Sopenharmony_ci| UncompressEntrance | UncompressResult parseApp(String appPath,String parseMode,String deviceType,String hapName) | Java| Function: Parses **pack.info** in the APP file.<br>Input parameters: **appPath**, which specifies the path of the APP file.<br>Return value: **UncompressResult**.| 123e41f4b71Sopenharmony_ci| UncompressEntrance | UncompressResult parseApp(InputStream input,String parseMode,String deviceType,String hapName,String outPath) | Java| Function: Parses **pack.info** in the APP file.<br>Input parameters: **input**, which specifies the stream of the APP file.<br>Return value: **UncompressResult**.| 124e41f4b71Sopenharmony_ci| UncompressEntrance | UncompressResult parseHap(String hapPath) | Java| Function: Parses the JSON file in the APP file.<br>Input parameters: **hapPath**, which specifies the path of the HAP file.<br>Return value: **UncompressResult**. | 125e41f4b71Sopenharmony_ci| UncompressEntrance | UncompressResult parseHap(InputStream input) | Java| Function: Parses the JSON file in the APP file.<br>Input parameters: **input**, which specifies the stream of the HAP file.<br>Return value: **UncompressResult**. | 126e41f4b71Sopenharmony_ci 127e41f4b71Sopenharmony_ci## Fields of the Unpacking Tool 128e41f4b71Sopenharmony_ci 129e41f4b71Sopenharmony_ci### UncompressResult (Bundle Information) Struct 130e41f4b71Sopenharmony_ci 131e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 132e41f4b71Sopenharmony_ci| ----------------| ------------------ |----------------------------------------| ---- | 133e41f4b71Sopenharmony_ci| result | boolean | Whether the parsing is successful. | NA | 134e41f4b71Sopenharmony_ci| message | String | Failure cause returned if the parsing fails. | NA | 135e41f4b71Sopenharmony_ci| packInfos | List\<PackInfo> | Information about **packages** in the **pack.info** file of the bundle. | NA | 136e41f4b71Sopenharmony_ci| profileInfos | List\<profileInfo> | Configuration information of the application. | NA | 137e41f4b71Sopenharmony_ci| profileInfosStr | List\<String> | Configuration information of the application.| NA | 138e41f4b71Sopenharmony_ci| icon | String | Path of the icon of the entry component. If there is no entry component, the icon path of the first component is returned.| NA | 139e41f4b71Sopenharmony_ci| label | String | Label of the entry component. If there is no entry component, the label of the first component is returned.| NA | 140e41f4b71Sopenharmony_ci| packageSize | long | Size of the APP file, in bytes.| NA | 141e41f4b71Sopenharmony_ci 142e41f4b71Sopenharmony_ci### PackInfo Struct 143e41f4b71Sopenharmony_ci 144e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 145e41f4b71Sopenharmony_ci| ------------------- | ------------- | --------------------------------------- | ---- | 146e41f4b71Sopenharmony_ci| name | String | Bundle name. | NA | 147e41f4b71Sopenharmony_ci| moduleName | String | HAP (module) name. | NA | 148e41f4b71Sopenharmony_ci| moduleType | String | Module type. | NA | 149e41f4b71Sopenharmony_ci| deviceType | List\<String> | Device type supported by the current HAP. | NA | 150e41f4b71Sopenharmony_ci| deliveryWithInstall | boolean | Whether the HAP is installed when the user installs the application.| NA | 151e41f4b71Sopenharmony_ci 152e41f4b71Sopenharmony_ci### ProfileInfo Struct 153e41f4b71Sopenharmony_ci 154e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 155e41f4b71Sopenharmony_ci| ------------ | ------------------------------ | ------------------------------------------ | ------------------------------------------------------------ | 156e41f4b71Sopenharmony_ci| hapName | String | Name of the HAP file that is being parsed. | NA | 157e41f4b71Sopenharmony_ci| appInfo | AppInfo struct (see **AppInfo Struct** below)| Struct of the application information. For details, see **AppInfo Struct** below. | NA | 158e41f4b71Sopenharmony_ci| deviceConfig | Map\<String,DeviceConfig> | Device information. | The storage type is Map\<String,String>, which indicates the device type name and device type value, respectively. In the stage model, this field is stored in the **app** struct.| 159e41f4b71Sopenharmony_ci| hapInfo | HapInfo struct (see **HapInfo Struct** below)| Module information in the HAP file. For details, see **HapInfo Struct** below.| NA | 160e41f4b71Sopenharmony_ci 161e41f4b71Sopenharmony_ci### AppInfo Struct 162e41f4b71Sopenharmony_ci 163e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 164e41f4b71Sopenharmony_ci|--------------------------------|---------|-------------------------------------------------------------------------------|-------------| 165e41f4b71Sopenharmony_ci| bundleName | String | Bundle name of the application. | NA | 166e41f4b71Sopenharmony_ci| vendor | String | Vendor of the application. | NA | 167e41f4b71Sopenharmony_ci| relatedBundleName | String | Related bundle name of the application. | NA | 168e41f4b71Sopenharmony_ci| versionName | String | Version name of the application. | NA | 169e41f4b71Sopenharmony_ci| versionCode | String | Version code of the application. | NA | 170e41f4b71Sopenharmony_ci| targetApiVersion | int | Target API version required for running the application. | NA | 171e41f4b71Sopenharmony_ci| compatibleApiVersion | int | API version compatible with the application. | NA | 172e41f4b71Sopenharmony_ci| appName | String | Label of the ability displayed on the home screen. | NA | 173e41f4b71Sopenharmony_ci| appNameEN | String | Label of the ability displayed on the home screen. | NA | 174e41f4b71Sopenharmony_ci| releaseType | String | Release type of the target API version required for running the application. | NA | 175e41f4b71Sopenharmony_ci| shellVersionCode | String | API version number of the application. | NA | 176e41f4b71Sopenharmony_ci| shellVersionName | String | API version name of the application. | NA | 177e41f4b71Sopenharmony_ci| multiFrameworkBundle | boolean | Application framework. | NA | 178e41f4b71Sopenharmony_ci| debug | boolean | Whether the application can be debugged. | NA | 179e41f4b71Sopenharmony_ci| icon | String | Path of the application icon. | NA | 180e41f4b71Sopenharmony_ci| label | String | Label of the application. | NA | 181e41f4b71Sopenharmony_ci| description | String | Description of the application. | This field is newly added to the stage model. | 182e41f4b71Sopenharmony_ci| minCompatibleVersionCode | int | Earliest compatible version of the application. | NA | 183e41f4b71Sopenharmony_ci| distributedNotificationEnabled | boolean | Whether the distributed notification feature is enabled for the application. | This field is newly added to the stage model. | 184e41f4b71Sopenharmony_ci| bundleType | String | Bundle type.<br>- **app**: The bundle is used for an application.<br>- **atomicService**: The bundle is used for an atomic service.<br>- **shared**: The bundle is used for a shared library.| NA | 185e41f4b71Sopenharmony_ci| compileSdkVersion | String | SDK version used for compiling the application. | This field is valid only for API version 10 and later. | 186e41f4b71Sopenharmony_ci| compileSdkType | String | SDK type used for compiling the application. | This field is valid only for API version 10 and later. | 187e41f4b71Sopenharmony_ci| labels | HashMap\<String, String> | Labels of the application in multiple languages.| NA | 188e41f4b71Sopenharmony_ci| descriptions | HashMap\<String, String> | Descriptions of the application in multiple languages.| NA | 189e41f4b71Sopenharmony_ci 190e41f4b71Sopenharmony_ci### HapInfo Struct 191e41f4b71Sopenharmony_ci 192e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 193e41f4b71Sopenharmony_ci| ---------------------|-----------------------------------------------|------------------------------------| ---------------------------------------| 194e41f4b71Sopenharmony_ci| appModel | AppModel enumerated value | Application framework model.<br>- FA: FA model<br>- STAGE: stage model| NA | 195e41f4b71Sopenharmony_ci| packageStr | String | Package information about the application. | This field is unique to the FA model. | 196e41f4b71Sopenharmony_ci| name | String | Name of the module. | NA | 197e41f4b71Sopenharmony_ci| description | String | Description of the HAP. | This field is unique to the FA model. | 198e41f4b71Sopenharmony_ci| supportedModes | List\<String> | Modes supported by the HAP. | NA | 199e41f4b71Sopenharmony_ci| abilities | List\<AbilityInfo> | Ability information of the HAP file. | NA | 200e41f4b71Sopenharmony_ci| defPermissions | List\<DefPermission> | Default permissions of the HAP. | NA | 201e41f4b71Sopenharmony_ci| definePermissions | List\<DefinePermission> | Defined permissions of the HAP. | NA | 202e41f4b71Sopenharmony_ci| defPermissionsGroups | List\<DefPermissionsGroups> | Default permission groups of the HAP. | NA | 203e41f4b71Sopenharmony_ci| distro | Distro struct | Distro description of the HAP file. | NA | 204e41f4b71Sopenharmony_ci| reqCapabilities | List\<String> | Required capabilities of the HAP. | NA | 205e41f4b71Sopenharmony_ci| deviceType | List\<String> | Type of devices on which the HAP can run. | This field corresponds to **deviceTypes** in the stage model. | 206e41f4b71Sopenharmony_ci| metaData | metaData struct (see **metaData Struct** below) | Custom metadata of the HAP. | NA | 207e41f4b71Sopenharmony_ci| dependencies | List\<DependencyItem> | Dependencies of the HAP. | NA | 208e41f4b71Sopenharmony_ci| isJs | boolean | Whether the application is a JS application. | This field is unique to the FA model. | 209e41f4b71Sopenharmony_ci| reqPermissions | list\<ReqPermission> | Permissions requested by the application. | This field corresponds to **requestPermissions** in the stage model.| 210e41f4b71Sopenharmony_ci| commonEvents | CommonEvent struct (see **CommonEvent Struct** below) | Static event. | NA | 211e41f4b71Sopenharmony_ci| shortcuts | list\<Shortcut> | Shortcuts used by the application. | NA | 212e41f4b71Sopenharmony_ci| distroFilter | DistroFilter struct | Information distributed by the application market by device form. | NA | 213e41f4b71Sopenharmony_ci| srcEntrance | String | Entry code path of the application. | This field is newly added to the stage model. | 214e41f4b71Sopenharmony_ci| process | String | Process name of the HAP. | This field is newly added to the stage model. | 215e41f4b71Sopenharmony_ci| mainElement | String | Entry ability name or ExtensionAbility name of the HAP file.| This field is newly added to the stage model. In the FA model , the value of **mainAbility** is automatically assigned to **mainElement**.| 216e41f4b71Sopenharmony_ci| uiSyntax | String | Syntax type of a JS component. | This field is newly added to the stage model. | 217e41f4b71Sopenharmony_ci| pages | List\<String> | Information about each page in a JS component. | This field is newly added to the stage model. | 218e41f4b71Sopenharmony_ci| extensionAbilityInfos| List\<ExtensionAbilityInfo> | Information about the ExtensionAbility. | This field is newly added to the stage model. | 219e41f4b71Sopenharmony_ci| moduleAtomicService | ModuleAtomicService struct (see **ModuleAtomicService Struct** below)| Information about the atomic service in the HAP. | NA | 220e41f4b71Sopenharmony_ci| formInfos | List\<AbilityFormInfo> | Widget information. | NA | 221e41f4b71Sopenharmony_ci| descriptions | HashMap\<String, String> | Description of the HAP. | NA | 222e41f4b71Sopenharmony_ci| compressedSize | long | Size of the compressed HAP file, in bytes. | NA | 223e41f4b71Sopenharmony_ci| originalSize | long | Original size of the HAP file, in bytes. | NA | 224e41f4b71Sopenharmony_ci 225e41f4b71Sopenharmony_ci### AbilityInfo Struct 226e41f4b71Sopenharmony_ci 227e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 228e41f4b71Sopenharmony_ci|-------------------|--------------------------| ------------------------------------------------- | ------------------------------- | 229e41f4b71Sopenharmony_ci| name | String | Logical name of the ability. | NA | 230e41f4b71Sopenharmony_ci| description | String | Description of the ability. | NA | 231e41f4b71Sopenharmony_ci| descriptionRes | String | Description of the ability. | NA | 232e41f4b71Sopenharmony_ci| icon | String | Icon of the ability. | NA | 233e41f4b71Sopenharmony_ci| iconPath | String | Path of the ability icon. | NA | 234e41f4b71Sopenharmony_ci| label | String | Ability name visible to users. | NA | 235e41f4b71Sopenharmony_ci| labelRes | String | Ability name visible to users. | NA | 236e41f4b71Sopenharmony_ci| type | String | Ability type. | In the stage model, the value is directly assigned to the **page** field.| 237e41f4b71Sopenharmony_ci| formsEnabled | boolean | Whether the widget is enabled for the ability. | NA | 238e41f4b71Sopenharmony_ci| formInfo | FormInfo struct | Widget information. | NA | 239e41f4b71Sopenharmony_ci| uri | String | URI of the ability. | This field is supported only in the FA model. | 240e41f4b71Sopenharmony_ci| launchType | String | Launcher type of the ability. | NA | 241e41f4b71Sopenharmony_ci| orientation | String | Orientation of the ability. | NA | 242e41f4b71Sopenharmony_ci| visible | boolean | Whether the ability is visible. | NA | 243e41f4b71Sopenharmony_ci| grantPermission | boolean | Granted permissions of the ability. | NA | 244e41f4b71Sopenharmony_ci| readPermission | String | Read permissions of the ability. | NA | 245e41f4b71Sopenharmony_ci| writePermission | String | Write permissions of the ability. | NA | 246e41f4b71Sopenharmony_ci| uriPermissionMode | String | URI permission mode of the ability. | NA | 247e41f4b71Sopenharmony_ci| uriPermissionPath | String | URI permission path of the ability. | NA | 248e41f4b71Sopenharmony_ci| directLaunch | boolean | Whether the ability can be directly launched. | NA | 249e41f4b71Sopenharmony_ci| mission | String | Mission of the ability. | NA | 250e41f4b71Sopenharmony_ci| targetAbility | String | Target ability of the ability. | NA | 251e41f4b71Sopenharmony_ci| multiUserShared | boolean | Whether the ability can be shared by multiple users. | NA | 252e41f4b71Sopenharmony_ci| supportPipMode | boolean | Whether the ability supports the PIP mode. | NA | 253e41f4b71Sopenharmony_ci| srcLanguage | String | Source language of the ability. | NA | 254e41f4b71Sopenharmony_ci| srcPath | String | Source path of the ability. | NA | 255e41f4b71Sopenharmony_ci| srcEntrance | String | Source entrance of the ability. | NA | 256e41f4b71Sopenharmony_ci| continuable | boolean | Whether the ability can be continued on another device. | NA | 257e41f4b71Sopenharmony_ci| metaData | MetaData struct (see **MetaData Struct** below)| Custom metadata of the ability. | NA | 258e41f4b71Sopenharmony_ci| configChanges | List\<String> | Configuration changes of the ability. | NA | 259e41f4b71Sopenharmony_ci| formInfos | List\<AbilityFormInfo> | Widgets of the ability. | NA | 260e41f4b71Sopenharmony_ci| permissions | List\<String> | Permissions of the ability. | NA | 261e41f4b71Sopenharmony_ci| skills | List\<SkillInfo> | Skills of the ability. | NA | 262e41f4b71Sopenharmony_ci| backgroundModes | List\<String> | Background modes of the ability. | NA | 263e41f4b71Sopenharmony_ci| labels | HashMap\<String, String> | Names of the ability displayed to users in multiple languages. | NA | 264e41f4b71Sopenharmony_ci| descriptions | HashMap\<String, String> | Descriptions of the ability in multiple languages. | NA | 265e41f4b71Sopenharmony_ci 266e41f4b71Sopenharmony_ci### Distro Struct 267e41f4b71Sopenharmony_ci 268e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 269e41f4b71Sopenharmony_ci| ------------------- |---------| --------------------------------------- | ------------------------------------------------------------ | 270e41f4b71Sopenharmony_ci| moduleName | String | Name of the module. | This field corresponds to the **moduleName** field under the **module** struct in the stage model. | 271e41f4b71Sopenharmony_ci| moduleType | String | Type of the HAP. | This field corresponds to the **moduleType** field under the **module** struct in the stage model. | 272e41f4b71Sopenharmony_ci| deliveryWithInstall | boolean | Whether the HAP is installed when the user installs the application.| This field corresponds to the **deliveryWithInstall** field under the **module** struct in the stage model. | 273e41f4b71Sopenharmony_ci| installationFree | int | Whether the HAP file supports the installation-free feature. | This parameter corresponds to the **installationFree** field under the **module** struct in the stage model. In the JSON file, if this parameter is set to **true**, **1** is returned; if this parameter is set to **false**, **0** is returned; if this parameter is not set, **2** is returned.| 274e41f4b71Sopenharmony_ci| virtualMachine | String | Type of the target virtual machine (VM) where the HAP is running. It is used for cloud distribution, such as the application market and distribution center.| This field corresponds to the **virtualMachine** field under the **module** struct in the stage model.| 275e41f4b71Sopenharmony_ci 276e41f4b71Sopenharmony_ci### MetaData Struct 277e41f4b71Sopenharmony_ci 278e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 279e41f4b71Sopenharmony_ci| -------------- |----------------------| -------------------------------- | ------------------------- | 280e41f4b71Sopenharmony_ci| parameters | List\<MetaDataInfo> | Metadata information. | This field is unique to the FA model. It is deprecated in the stage model. | 281e41f4b71Sopenharmony_ci| results | List\<MetaDataInfo> | Result information of the metadata. | This field is unique to the FA model. It is deprecated in the stage model. | 282e41f4b71Sopenharmony_ci| customizeDatas | List\<CustomizeData> | Custom data of the metadata.| NA | 283e41f4b71Sopenharmony_ci 284e41f4b71Sopenharmony_ci### MetaDataInfo Struct 285e41f4b71Sopenharmony_ci 286e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 287e41f4b71Sopenharmony_ci| ----------- | ------ | --------------------------------- | ------------------------- | 288e41f4b71Sopenharmony_ci| name | String | Name of the **MetaDataInfo** struct. | This field is unique to the FA model. It is deprecated in the stage model. | 289e41f4b71Sopenharmony_ci| description | String | Description of the **MetaDataInfo** struct.| This field is unique to the FA model. It is deprecated in the stage model. | 290e41f4b71Sopenharmony_ci| type | String | Type of the **MetaDataInfo** struct. | This field is unique to the FA model. It is deprecated in the stage model. | 291e41f4b71Sopenharmony_ci 292e41f4b71Sopenharmony_ci### CustomizeData Struct 293e41f4b71Sopenharmony_ci 294e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 295e41f4b71Sopenharmony_ci| ----- | ------ | ---------------------------- | ----------------------- | 296e41f4b71Sopenharmony_ci| name | String | Name of the **CustomizeData** struct. | This field corresponds to **metadata** in the stage model.| 297e41f4b71Sopenharmony_ci| value | String | Value of the **CustomizeData** struct.| This field corresponds to **metadata** in the stage model.| 298e41f4b71Sopenharmony_ci| extra | String | Extra information of the **CustomizeData** struct.| This field corresponds to **metadata** in the stage model.| 299e41f4b71Sopenharmony_ci 300e41f4b71Sopenharmony_ci### ReqPermission Struct 301e41f4b71Sopenharmony_ci 302e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 303e41f4b71Sopenharmony_ci| --------- | ---------------------------------- |------------------------------------------------------------| ---- | 304e41f4b71Sopenharmony_ci| name | String | Name of the requested permission. | NA | 305e41f4b71Sopenharmony_ci| reason | String | Reason for requesting the permission. This field is mandatory for a user_grant permission.| NA | 306e41f4b71Sopenharmony_ci| usedScene | UsedScene struct (see **UsedScene Struct** below)| Application scenario of the permission. The value can be **ability** or **when**. Multiple abilities can be configured.| NA | 307e41f4b71Sopenharmony_ci| reasons | HashMap\<String, String> | Reason for requesting the permission. This field is mandatory for a user_grant permission.| NA | 308e41f4b71Sopenharmony_ci 309e41f4b71Sopenharmony_ci### UsedScene Struct 310e41f4b71Sopenharmony_ci 311e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 312e41f4b71Sopenharmony_ci| ------- | ------------- | ------------------------------------------------------------ | ---- | 313e41f4b71Sopenharmony_ci| ability | List\<String> | Abilities that use the permission. The value is an array. | NA | 314e41f4b71Sopenharmony_ci| when | String | Time when the permission is used. The value can be **inuse** (the permission can be used only in the foreground) or **always** (the permission can be used in foreground and background).| NA | 315e41f4b71Sopenharmony_ci 316e41f4b71Sopenharmony_ci### Shortcut Struct 317e41f4b71Sopenharmony_ci 318e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 319e41f4b71Sopenharmony_ci| ---------- | ---------------------- | :----------------------------------------------------------- | ---- | 320e41f4b71Sopenharmony_ci| shortcutId | String | ID of the **ShortCut** struct. | NA | 321e41f4b71Sopenharmony_ci| label | String | Label of the **ShortCut** struct. | NA | 322e41f4b71Sopenharmony_ci| icon | String | Icon of the **ShortCut** struct. | NA | 323e41f4b71Sopenharmony_ci| intents | List\<IntentInfo> | Intents to which the shortcut points. The attribute consists of the **targetClass** and **targetBundle** sub-attributes.| NA | 324e41f4b71Sopenharmony_ci| labels | HashMap\<String, String> | Shortcut names displayed to users in multiple languages. | NA | 325e41f4b71Sopenharmony_ci 326e41f4b71Sopenharmony_ci### IntentInfo Struct 327e41f4b71Sopenharmony_ci 328e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 329e41f4b71Sopenharmony_ci| ------------ | ------ | ---------------- | ---- | 330e41f4b71Sopenharmony_ci| targetClass | String | Class name for the target ability of the shortcut.| NA | 331e41f4b71Sopenharmony_ci| targetBundle | String | Target bundle name of the shortcut.| NA | 332e41f4b71Sopenharmony_ci 333e41f4b71Sopenharmony_ci### DistroFilter Struct 334e41f4b71Sopenharmony_ci 335e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 336e41f4b71Sopenharmony_ci| ------------- | ------------------- | ------------------------------------- | ---- | 337e41f4b71Sopenharmony_ci| apiVersion | ApiVersion struct | API version of the **DistroFilter** struct. | NA | 338e41f4b71Sopenharmony_ci| screenShape | ScreenShape struct | Screen shape of the **DistroFilter** struct. | NA | 339e41f4b71Sopenharmony_ci| screenDensity | ScreenDensity struct| Screen density of the **DistroFilter** struct.| NA | 340e41f4b71Sopenharmony_ci| screenWindow | ScreenWindow struct | Screen window of the **DistroFilter** struct. | NA | 341e41f4b71Sopenharmony_ci| countryCode | CountryCode struct | Country code of the **DistroFilter** struct. | NA | 342e41f4b71Sopenharmony_ci 343e41f4b71Sopenharmony_ci### ApiVersion Struct 344e41f4b71Sopenharmony_ci 345e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 346e41f4b71Sopenharmony_ci| ------ | ------------- | ------------------------ | ---- | 347e41f4b71Sopenharmony_ci| policy | String | Policy information in the struct.| NA | 348e41f4b71Sopenharmony_ci| value | List\<String> | Value information in the struct. | NA | 349e41f4b71Sopenharmony_ci 350e41f4b71Sopenharmony_ci### ScreenShape Struct 351e41f4b71Sopenharmony_ci 352e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 353e41f4b71Sopenharmony_ci| ------ | ------------- | ------------------------ | ---- | 354e41f4b71Sopenharmony_ci| policy | String | Policy information in the struct.| NA | 355e41f4b71Sopenharmony_ci| value | List\<String> | Value information in the struct. | NA | 356e41f4b71Sopenharmony_ci 357e41f4b71Sopenharmony_ci### ScreenDensity Struct 358e41f4b71Sopenharmony_ci 359e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 360e41f4b71Sopenharmony_ci| ------ | ------------- | ------------------------ | ---- | 361e41f4b71Sopenharmony_ci| policy | String | Policy information in the struct.| NA | 362e41f4b71Sopenharmony_ci| value | List\<String> | Value information in the struct. | NA | 363e41f4b71Sopenharmony_ci 364e41f4b71Sopenharmony_ci### ScreenWindow Struct 365e41f4b71Sopenharmony_ci 366e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 367e41f4b71Sopenharmony_ci| ------ | ------------- | ------------------------ | ---- | 368e41f4b71Sopenharmony_ci| policy | String | Policy information in the struct.| NA | 369e41f4b71Sopenharmony_ci| value | List\<String> | Value information in the struct. | NA | 370e41f4b71Sopenharmony_ci 371e41f4b71Sopenharmony_ci### CountryCode Struct 372e41f4b71Sopenharmony_ci 373e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 374e41f4b71Sopenharmony_ci| ------ | ------------- | ------------------------ | ---- | 375e41f4b71Sopenharmony_ci| policy | String | Policy information in the struct.| NA | 376e41f4b71Sopenharmony_ci| value | List\<String> | Value information in the struct. | NA | 377e41f4b71Sopenharmony_ci 378e41f4b71Sopenharmony_ci### ExtensionAbilityInfo Struct 379e41f4b71Sopenharmony_ci 380e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 381e41f4b71Sopenharmony_ci| --------------- | ------------------------ | ----------------------------------------------------- | ----------------------------------- | 382e41f4b71Sopenharmony_ci| name | String | Logical name of the ExtensionAbility. | This field is supported only in the stage model. | 383e41f4b71Sopenharmony_ci| srcEntrance | String | JS code path of the ExtensionAbility. | This field is supported only in the stage model. | 384e41f4b71Sopenharmony_ci| icon | String | Icon ID of the ExtensionAbility. | This field is supported only in the stage model. | 385e41f4b71Sopenharmony_ci| label | String | ExtensionAbility name visible to users. | This field is supported only in the stage model. | 386e41f4b71Sopenharmony_ci| description | String | Description of the ExtensionAbility. | This field is supported only in the stage model. | 387e41f4b71Sopenharmony_ci| type | String | Type of the ExtensionAbility, which can be **form**, **workScheduler**, **inputMethod**, **service**, **accessibility**, **dataShare**, **fileShare**, **wallpaper**, or **backup**.| This field is supported only in the stage model. Currently, only **form** and **staticSubscriber** information is parsed. The information of other types is not parsed. | 388e41f4b71Sopenharmony_ci| permissions | List\<String> | Permissions required when the ExtensionAbility is called by the ability of another application. | This field is supported only in the stage model. | 389e41f4b71Sopenharmony_ci| readPermission | String | Permission required for reading data in the ExtensionAbility. | This field is supported only in the stage model. | 390e41f4b71Sopenharmony_ci| writePermission | String | Permission required for writing data to the ExtensionAbility. | This field is supported only in the stage model. | 391e41f4b71Sopenharmony_ci| visible | boolean | Whether the ExtensionAbility can be called by other applications. | This field is supported only in the stage model. | 392e41f4b71Sopenharmony_ci| skills | List\<SkillInfo> | Skills of the Want that the extensionAbility can receive. | This field is supported only in the stage model. | 393e41f4b71Sopenharmony_ci| metadataInfos | List\<ModuleMetadataInfo>| Metadata that the ExtensionAbility can receive. | This field is supported only in the stage model. | 394e41f4b71Sopenharmony_ci| metadata | MetaData Struct | Metadata of the ExtensionAbility. | The information in **metadata** is assigned to **CustomizeData**.| 395e41f4b71Sopenharmony_ci| uri | String | URI of the data provided by the ExtensionAbility. | This field is supported only in the stage model. | 396e41f4b71Sopenharmony_ci| descriptions | HashMap\<String, String> | Descriptions of the ExtensionAbility in multiple languages. | NA | 397e41f4b71Sopenharmony_ci| labels | HashMap\<String, String> | Names of the ExtensionAbility displayed to users in multiple languages. | NA | 398e41f4b71Sopenharmony_ci 399e41f4b71Sopenharmony_ci### SkillInfo Struct 400e41f4b71Sopenharmony_ci 401e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 402e41f4b71Sopenharmony_ci| -------- | ------------------- |----------------------| ---- | 403e41f4b71Sopenharmony_ci| actions | List\<String> | Actions of the Want that the ExtensionAbility can receive.| NA | 404e41f4b71Sopenharmony_ci| entities | List\<String> | Entities of the Want that the ExtensionAbility can receive. | NA | 405e41f4b71Sopenharmony_ci 406e41f4b71Sopenharmony_ci### UriInfo Struct 407e41f4b71Sopenharmony_ci 408e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 409e41f4b71Sopenharmony_ci| ------------- | ------ |------------------------| ---- | 410e41f4b71Sopenharmony_ci| schema | String | Schema information of the **ModuleUriInfo** struct. | NA | 411e41f4b71Sopenharmony_ci| host | String | Host of the **ModuleUriInfo** struct. | NA | 412e41f4b71Sopenharmony_ci| port | String | Port of the **ModuleUriInfo** struct. | NA | 413e41f4b71Sopenharmony_ci| pathStartWith | String | Path prefix of the **ModuleUriInfo** struct. | NA | 414e41f4b71Sopenharmony_ci| pathRegex | String | Path regular expression of the **ModuleUriInfo** struct.| NA | 415e41f4b71Sopenharmony_ci| path | String | Path information of the **ModuleUriInfo** struct. | NA | 416e41f4b71Sopenharmony_ci| type | String | Type of the **ModuleUriInfo** struct. | NA | 417e41f4b71Sopenharmony_ci 418e41f4b71Sopenharmony_ci### AbilityFormInfo Struct 419e41f4b71Sopenharmony_ci 420e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 421e41f4b71Sopenharmony_ci| ------------------- | -------------------------| ------------------------------------------------------------ |-----------| 422e41f4b71Sopenharmony_ci| name | String | Name of the widget. | NA | 423e41f4b71Sopenharmony_ci| type | String | Type of the widget. | NA | 424e41f4b71Sopenharmony_ci| updateEnabled | boolean | Whether the widget supports scheduled refresh. | NA | 425e41f4b71Sopenharmony_ci| scheduledUpdateTime | String | Scheduled time to update the widget. The value is in 24-hour format and accurate to the minute. | NA | 426e41f4b71Sopenharmony_ci| updateDuration | int | Interval to update the widget. The unit is 30 minutes. The value is a multiple of 30. | NA | 427e41f4b71Sopenharmony_ci| supportDimensions | List\<String> | Dimensions supported by the widget, which can be **1 * 2**, **2 * 2**, **2 * 4**, or **4 * 4**. | NA | 428e41f4b71Sopenharmony_ci| defaultDimension | String | Default dimensions of the widget. The value must be available in the **supportDimensions** array of the widget.| NA | 429e41f4b71Sopenharmony_ci| MetaData | MetaData | Custom data of the widget. | NA | 430e41f4b71Sopenharmony_ci| description | String | Description of the widget. | This field is newly added to the stage model.| 431e41f4b71Sopenharmony_ci| src | String | JS code of the widget. | NA | 432e41f4b71Sopenharmony_ci| windowInfo | ModuleWindowInfo struct | Window information of the ability. | NA | 433e41f4b71Sopenharmony_ci| isDefault | boolean | Whether the widget is a default one. Each HAP has only one default widget. | NA | 434e41f4b71Sopenharmony_ci| colorMode | String | Color mode of the widget, which can be **auto**, **dark**, or **light**. | NA | 435e41f4b71Sopenharmony_ci| formConfigAbility | String | Ability name for widget adjustment. | NA | 436e41f4b71Sopenharmony_ci| formVisibleNotify | String | Whether the widget is allowed to use the visibility notification. | NA | 437e41f4b71Sopenharmony_ci| providerAbility | String | Ability or ExtensionAbility name of the widget provider.<br>- FA model: If the widget is configured in an ability of the Service type, set **providerAbility** to **mainAbility**.<br/>- FA model: If the widget is configured in an ability of the Page type, set **providerAbility** to the current ability.<br/>- FA model: If **mainAbility** is not configured, set **providerAbility** to the ability that preferentially uses **system.home** in the current HAP. Otherwise, set **providerAbility** to the ability of the first page.<br/>- Stage model: Set **providerAbility** to **mainElement**.| NA | 438e41f4b71Sopenharmony_ci| descriptions | HashMap\<String, String> | Descriptions of the ability in multiple languages. | NA | 439e41f4b71Sopenharmony_ci 440e41f4b71Sopenharmony_ci 441e41f4b71Sopenharmony_ci### CommonEvent Struct 442e41f4b71Sopenharmony_ci 443e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks | 444e41f4b71Sopenharmony_ci| ---------- | ------------- | -------------------------------------- | ------------------------------------------------ | 445e41f4b71Sopenharmony_ci| name | String | Name of the class corresponding to the current static common event. | In the stage model, the value is obtained from the StaticSubscriberExtensionAbility.| 446e41f4b71Sopenharmony_ci| permission | String | Permissions required to implement the static common event. | In the stage model, the value is obtained from the StaticSubscriberExtensionAbility.| 447e41f4b71Sopenharmony_ci| data | List\<String> | Additional data array to be carried in the static common event.| In the stage model, the value is obtained from the StaticSubscriberExtensionAbility.| 448e41f4b71Sopenharmony_ci| type | List\<String> | Type array for configuring the static common event. | In the stage model, the value is obtained from the StaticSubscriberExtensionAbility.| 449e41f4b71Sopenharmony_ci| events | List\<String> | Events of the Want that the ExtensionAbility can receive. | In the stage model, the value is obtained from the StaticSubscriberExtensionAbility.| 450e41f4b71Sopenharmony_ci 451e41f4b71Sopenharmony_ci### DependencyItem Struct 452e41f4b71Sopenharmony_ci 453e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 454e41f4b71Sopenharmony_ci|--------------| ------ |--------------| ---- | 455e41f4b71Sopenharmony_ci| bundleName | String | Bundle name of the shared package.| NA | 456e41f4b71Sopenharmony_ci| moduleName | String | Module name of the shared package.| NA | 457e41f4b71Sopenharmony_ci| versionCode | String | Version number of the shared bundle. | NA | 458e41f4b71Sopenharmony_ci 459e41f4b71Sopenharmony_ci### ModuleAtomicService Struct 460e41f4b71Sopenharmony_ci 461e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 462e41f4b71Sopenharmony_ci|--------------|------------------------|----------------| ---- | 463e41f4b71Sopenharmony_ci| preloadItems | list\<PreloadItem> | Preloaded objects. | NA | 464e41f4b71Sopenharmony_ci 465e41f4b71Sopenharmony_ci### PreloadItem Struct 466e41f4b71Sopenharmony_ci 467e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 468e41f4b71Sopenharmony_ci|--------------|--------|----------------| ---- | 469e41f4b71Sopenharmony_ci| moduleName | String | Name of the preloaded module.| NA | 470e41f4b71Sopenharmony_ci 471e41f4b71Sopenharmony_ci### DeviceConfig Struct 472e41f4b71Sopenharmony_ci 473e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 474e41f4b71Sopenharmony_ci|--------------------------------|-------- |------------------------------------------| ---- | 475e41f4b71Sopenharmony_ci| targetReqSdk | String | Target SDK version requested. | NA | 476e41f4b71Sopenharmony_ci| compatibleReqSdk | String | Compatible SDK version requested. | NA | 477e41f4b71Sopenharmony_ci| jointUserid | String | Joint user ID. | NA | 478e41f4b71Sopenharmony_ci| process | String | Process. | NA | 479e41f4b71Sopenharmony_ci| arkFlag | String | ArkCompiler flag. | NA | 480e41f4b71Sopenharmony_ci| targetArkVersion | String | Target ArkCompiler version.| NA | 481e41f4b71Sopenharmony_ci| compatibleArkVersion | String | Compatible ArkCompiler version. | NA | 482e41f4b71Sopenharmony_ci| directLaunch | boolean | Whether direct launch is supported. | NA | 483e41f4b71Sopenharmony_ci| distributedNotificationEnabled | boolean | Whether distributed notification is enabled.| NA | 484e41f4b71Sopenharmony_ci 485e41f4b71Sopenharmony_ci### DefPermission Struct 486e41f4b71Sopenharmony_ci 487e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 488e41f4b71Sopenharmony_ci|----------------|--------------------------|-------------------------------------------| ---- | 489e41f4b71Sopenharmony_ci| name | String | Name of the default permission. | NA | 490e41f4b71Sopenharmony_ci| grantMode | String | Grant mode of the default permission. | NA | 491e41f4b71Sopenharmony_ci| group | String | Group of the default permission. | NA | 492e41f4b71Sopenharmony_ci| label | String | Label of the default permission. | NA | 493e41f4b71Sopenharmony_ci| description | String | Description of the default permission. | NA | 494e41f4b71Sopenharmony_ci| availableScope | List\<String> | Available scope of the default permission. | NA | 495e41f4b71Sopenharmony_ci| labels | HashMap\<String, String> | Labels of the default permission in multiple languages. | NA | 496e41f4b71Sopenharmony_ci| descriptions | HashMap\<String, String> | Descriptions of the default permission in multiple languages. | NA | 497e41f4b71Sopenharmony_ci 498e41f4b71Sopenharmony_ci### DefinePermission Struct 499e41f4b71Sopenharmony_ci 500e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 501e41f4b71Sopenharmony_ci|------------------------|--------------------------|----------------------------------------------------| ---- | 502e41f4b71Sopenharmony_ci| name | String | Name of the defined permission. | NA | 503e41f4b71Sopenharmony_ci| grantMode | String | Grant mode of the defined permission. | NA | 504e41f4b71Sopenharmony_ci| availableLevel | String | Group of the defined permission. | NA | 505e41f4b71Sopenharmony_ci| provisionEnable | boolean | Whether the defined permission is enabled. | NA | 506e41f4b71Sopenharmony_ci| distributedSceneEnable | boolean | Whether the distributed scene is enabled for the defined permission.| NA | 507e41f4b71Sopenharmony_ci| label | String | Label of the defined permission. | NA | 508e41f4b71Sopenharmony_ci| description | String | Description of the defined permission. | NA | 509e41f4b71Sopenharmony_ci| descriptions | HashMap\<String, String> | Descriptions of the defined permission in multiple languages. | NA | 510e41f4b71Sopenharmony_ci| labels | HashMap\<String, String> | Labels of the defined permission in multiple languages. | NA | 511e41f4b71Sopenharmony_ci 512e41f4b71Sopenharmony_ci### DefPermissionsGroups Struct 513e41f4b71Sopenharmony_ci 514e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 515e41f4b71Sopenharmony_ci|-------------|---------|------------------------------| ---- | 516e41f4b71Sopenharmony_ci| name | String | Name of the default permission group.| NA | 517e41f4b71Sopenharmony_ci| order | String | Sequence of the default permission group. | NA | 518e41f4b71Sopenharmony_ci| icon | String | Icon of the default permission group.| NA | 519e41f4b71Sopenharmony_ci| label | String | Label of the default permission group.| NA | 520e41f4b71Sopenharmony_ci| description | String | Description of the default permission group.| NA | 521e41f4b71Sopenharmony_ci| request | boolean | Request for the default permission group.| NA | 522e41f4b71Sopenharmony_ci 523e41f4b71Sopenharmony_ci### FormInfo Struct 524e41f4b71Sopenharmony_ci 525e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 526e41f4b71Sopenharmony_ci|---------------|---------------|--------------------------| ---- | 527e41f4b71Sopenharmony_ci| formEntity | List\<String> | Widget entity.| NA | 528e41f4b71Sopenharmony_ci| minHeight | String | Minimum height of the widget. | NA | 529e41f4b71Sopenharmony_ci| defaultHeight | String | Default height of the widget. | NA | 530e41f4b71Sopenharmony_ci| minWidth | String | Minimum width of the widget | NA | 531e41f4b71Sopenharmony_ci| defaultWidth | String | Default width of the widget. | NA | 532e41f4b71Sopenharmony_ci 533e41f4b71Sopenharmony_ci### ModuleMetadataInfo Struct 534e41f4b71Sopenharmony_ci 535e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 536e41f4b71Sopenharmony_ci|----------|---------|------------------------------| ---- | 537e41f4b71Sopenharmony_ci| name | String | Name of the ModuleMetadataInfo.| NA | 538e41f4b71Sopenharmony_ci| value | String | Value of the ModuleMetadataInfo. | NA | 539e41f4b71Sopenharmony_ci| resource | String | Resource of the ModuleMetadataInfo.| NA | 540e41f4b71Sopenharmony_ci 541e41f4b71Sopenharmony_ci### ModuleWindowInfo Struct 542e41f4b71Sopenharmony_ci 543e41f4b71Sopenharmony_ci| Field | Type | Description | Remarks| 544e41f4b71Sopenharmony_ci|-----------------|---------|-------------------------------------| ---- | 545e41f4b71Sopenharmony_ci| designWidth | int | Designed width of the used scene of the module. | NA | 546e41f4b71Sopenharmony_ci| autoDesignWidth | boolean | Automatically designed width of the used scene of the module.| NA | 547