"description":"Specifies whether the .hap file is installed when the user installs the application.true: The .hap file is installed during the application installation.false: The .hap file is not installed during the application installation.This label cannot be left blank.",
"type":"boolean"
},
"installationFree":{
"description":"Indicates whether free installation of the current hap is supported.If installationFree is true, this module is a service.OtherWise, this module is an application",
"type":"boolean"
},
"virtualMachine":{
"description":"Identify the type of target virtual machine currently running hap.",
"type":"string",
"enum":[
"ark",
"default"
],
"default":"default"
},
"uiSyntax":{
"description":"Indicates the syntax type of ETS Component.Default is hml.",
"deprecationMessage":"Deprecated since api 9",
"type":"string",
"enum":[
"ets",
"hml"
],
"default":"hml"
},
"pages":{
"description":"Used to list the information of each page in ETS Component.",
"description":"Indicates the metadata of the module.",
"type":"array",
"items":{
"type":"object",
"propertyNames":{
"enum":[
"name",
"value",
"resource"
]
},
"properties":{
"name":{
"description":"Indicates the key of a data element. The value is a string with a maximum of 255 bytes.",
"type":"string",
"maxLength":255
},
"value":{
"description":"Indicates the value of a data element. The value is a string with a maximum of 255 bytes.",
"type":"string",
"maxLength":255
},
"resource":{
"description":"Indicates the resource of a data element.",
"type":"string",
"pattern":"^[$]profile:[0-9a-zA-Z_.]+$",
"maxLength":255
}
}
}
},
"abilities":{
"description":"Indicates all abilities in the current module. The value is an array of objects, each of which represents an ability.This label can be left blank by default,and indicates no capability exists in the current module.",
"description":"Indicates the priority of the ability.Only for system application.This field is used for implicit query.Range from 0 to 10, default value is 0.",
"type":"integer",
"minimum":0,
"maximum":10
},
"name":{
"description":"Indicates the name of the ability.",
"type":"string",
"pattern":"^[a-zA-Z][0-9a-zA-Z_.]*$",
"maxLength":127
},
"srcEntrance":{
"description":"Indicates the js code path corresponding to the ability.",
"type":"string",
"deprecationMessage":"Deprecated since api 9, use srcEntry instead.",
"maxLength":127
},
"srcEntry":{
"description":"Indicates the js code path corresponding to the ability.",
"type":"string",
"maxLength":127
},
"launchType":{
"description":"Indicates the boot mode of ability.",
"type":"string",
"enum":[
"standard",
"singleton",
"specified",
"multiton"
],
"default":"singleton"
},
"description":{
"description":"Describes the ability.",
"type":"string",
"maxLength":255
},
"icon":{
"description":"Indicates the index to the ability icon file, in the format of \"$media:ability_icon\".This label can be left blank by default.",
"description":"Indicates the permissions required for abilities of another application to call the current ability, generally in the format of a reverse domain name. The value can be either the permissions predefined in the OS or those customized by your application. If a custom permission is used, the value must be the same as the name value of a specific permission defined in the definePermissions attribute.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string",
"maxLength":255
}
},
"metadata":{
"description":"Indicates the metadata of the ability.",
"type":"array",
"items":{
"type":"object",
"propertyNames":{
"enum":[
"name",
"value",
"resource"
]
},
"properties":{
"name":{
"description":"Indicates the key of a data element. The value is a string with a maximum of 255 bytes.",
"type":"string",
"maxLength":255
},
"value":{
"description":"Indicates the value of a data element. The value is a string with a maximum of 255 bytes.",
"type":"string",
"maxLength":255
},
"resource":{
"description":"Indicates the resource of a data element.",
"description":"Specifies whether the ability can be called by other applications.The \"true\" indicates the ability can be called by other applications.The \"false\" indicates the ability cannot be called by other applications.This tag is optional. The default value is false.",
"type":"boolean",
"deprecationMessage":"Deprecated since api 9, use exported instead.",
"default":false
},
"exported":{
"description":"Specifies whether the ability can be called by other applications.The \"true\" indicates the ability can be called by other applications.The \"false\" indicates the ability cannot be called by other applications.This tag is optional. The default value is false.",
"type":"boolean",
"default":false
},
"skills":{
"description":"Indicates the types of the intent that can be accepted by the ability.",
"type":"array",
"items":{
"type":"object",
"uniqueItems":true,
"propertyNames":{
"enum":[
"actions",
"entities",
"uris",
"permissions",
"domainVerify"
]
},
"properties":{
"actions":{
"description":"Indicates the actions of the intent that can be accepted by the ability. The value can have one or multiple actions predefined in the system.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string"
}
},
"entities":{
"description":"Indicates the entities of the intent that can be accepted by the ability, such as video and Home application. The value can have one or multiple entities either predefined in the system or be customized.",
"type":"array",
"items":{
"type":"string"
},
"uniqueItems":true
},
"uris":{
"description":"This tag identifies the collection of data specifications to be added to the Intent filter.",
"type":"array",
"items":{
"anyOf":[
{
"type":"object",
"propertyNames":{
"enum":[
"scheme",
"host",
"port",
"pathStartWith",
"path",
"pathRegex",
"type",
"utd",
"maxFileSupported",
"linkFeature"
]
},
"required":[
"scheme"
],
"properties":{
"scheme":{
"description":"This label is a string type.",
"type":"string"
},
"host":{
"description":"This label is a string type.",
"type":"string"
},
"port":{
"description":"This label is a string type.",
"type":"string"
},
"pathStartWith":{
"description":"This label is a string type.",
"type":"string"
},
"path":{
"description":"This label is a string type.",
"type":"string"
},
"pathRegex":{
"description":"This label is a string type.",
"type":"string"
},
"type":{
"description":"This label is a string type.",
"type":"string"
},
"utd":{
"description":"Indicates the uniform file type supported by the ability. Please refer to https://gitee.com/openharmony/interface_sdk-js/blob/master/api/@ohos.data.uniformTypeDescriptor.d.ts for detailed information",
"type":"string"
},
"maxFileSupported":{
"description":"Indicates the maximum number of files that can be received.",
"type":"integer"
},
"linkFeature":{
"description":"Indicates the uri feature.",
"type":"string",
"pattern":"^[a-zA-Z][0-9a-zA-Z_.]*$",
"maxLength":127
}
}
},
{
"type":"object",
"propertyNames":{
"enum":[
"type"
]
},
"properties":{
"type":{
"description":"This label is a string type.",
"type":"string"
}
}
}
]
}
},
"permissions":{
"description":"Indicates the permissions required for abilities of another application to call the current ability, generally in the format of a reverse domain name. The value can be either the permissions predefined in the OS or those customized by your application. If a custom permission is used, the value must be the same as the name value of a specific permission defined in the definePermissions attribute.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z_.]*$",
"maxLength":255
}
},
"domainVerify":{
"description":"Specifies whether the ability support domain verification. The \"true\" indicates the ability support domain verification. The \"false\" indicates the ability does not support domain verification. This tag is optional. The default value is false.",
"type":"boolean",
"default":false
}
}
}
},
"backgroundModes":{
"description":"Indicates the background service addressing a specific usage scenario. This attribute is dedicated to the abilities using the Service template. You can assign multiple background service types to a specific ability using the Service template.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string",
"enum":[
"dataTransfer",
"audioPlayback",
"audioRecording",
"location",
"bluetoothInteraction",
"multiDeviceConnection",
"wifiInteraction",
"voip",
"taskKeeping"
]
}
},
"continuable":{
"description":"Identifies whether the ability can be migrated. The default value is false.",
"description":"Indicates the priority of the ability.Only for system application.This field is used for implicit query.Range from 0 to 10, default value is 0.",
"type":"integer",
"minimum":0,
"maximum":10
},
"name":{
"description":"Indicates the name of the extension.",
"pattern":"^[a-zA-Z][0-9a-zA-Z_.]*$",
"type":"string",
"maxLength":127
},
"srcEntrance":{
"description":"Indicates the js code path corresponding to the extension.",
"deprecationMessage":"Deprecated since api 9, use srcEntry instead.",
"type":"string",
"maxLength":127
},
"srcEntry":{
"description":"Indicates the js code path corresponding to the extension.",
"type":"string",
"maxLength":127
},
"icon":{
"description":"Indicates the index to the extension icon file.If the extension is configured as MainElement, the tag must be configured",
"description":"Describes the extension. The value can be a string or a resource index to descriptions in multiple languages.This label can be left blank by default.",
"type":"string",
"maxLength":255
},
"type":{
"description":"Indicates the type of the extension.",
"description":"Indicates the permissions required for extensionAbilities of another application to call the current extension.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string",
"maxLength":255
}
},
"uri":{
"description":"Identifies the provided uri data for current extension.",
"type":"string",
"maxLength":255
},
"readPermission":{
"description":"Indicates the readPermission required for extensionAbilities of another application to call the current extension.",
"type":"string",
"maxLength":255
},
"writePermission":{
"description":"Indicates the writePermission required for extensionAbilities of another application to call the current extension.",
"type":"string",
"maxLength":255
},
"visible":{
"description":"Specifies whether the extension can be called by other applications.",
"deprecationMessage":"Deprecated since api 9, use exported instead.",
"type":"boolean",
"default":false
},
"exported":{
"description":"Specifies whether the extension can be called by other applications.",
"type":"boolean",
"default":false
},
"skills":{
"description":"Indicates the types of the intent that can be accepted by the extension.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"object",
"propertyNames":{
"enum":[
"actions",
"entities",
"uris",
"permissions"
]
},
"properties":{
"actions":{
"description":"Indicates the actions of the intent that can be accepted by the extension. The value can have one or multiple actions predefined in the system.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string"
}
},
"entities":{
"description":"Indicates the entities of the intent that can be accepted by the extension, such as video and Home application. The value can have one or multiple entities either predefined in the system or be customized.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string"
}
},
"uris":{
"description":"This tag identifies the collection of data specifications to be added to the Intent filter.",
"type":"array",
"uniqueItems":true,
"items":{
"anyOf":[
{
"type":"object",
"propertyNames":{
"enum":[
"scheme",
"host",
"port",
"pathStartWith",
"path",
"pathRegex",
"type",
"utd",
"maxFileSupported"
]
},
"required":[
"scheme"
],
"properties":{
"scheme":{
"description":"This label is a string type.",
"type":"string"
},
"host":{
"description":"This label is a string type.",
"type":"string"
},
"port":{
"description":"This label is a string type.",
"type":"string"
},
"pathStartWith":{
"description":"This label is a string type.",
"type":"string"
},
"path":{
"description":"This label is a string type.",
"type":"string"
},
"pathRegex":{
"description":"This label is a string type.",
"type":"string"
},
"type":{
"description":"This label is a string type.",
"type":"string"
},
"utd":{
"description":"Indicates the uniform file type supported by the ability. Please refer to https://gitee.com/openharmony/interface_sdk-js/blob/master/api/@ohos.data.uniformTypeDescriptor.d.ts for detailed information",
"type":"string"
},
"maxFileSupported":{
"description":"Indicates the maximum number of files that can be received.",
"type":"integer"
}
}
},
{
"type":"object",
"propertyNames":{
"enum":[
"type"
]
},
"properties":{
"type":{
"description":"This label is a string type.",
"type":"string"
}
}
}
]
}
},
"permissions":{
"description":"Indicates the permissions required for extensionAbilities of another application to call the current extension.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z_.]*$",
"maxLength":255
}
}
}
}
},
"metadata":{
"description":"Indicates the metadata of the extension.",
"type":"array",
"items":{
"type":"object",
"propertyNames":{
"enum":[
"name",
"value",
"resource"
]
},
"properties":{
"name":{
"description":"Indicates the key of a data element. The value is a string with a maximum of 255 bytes.",
"type":"string",
"maxLength":255
},
"value":{
"description":"Indicates the value of a data element. The value is a string with a maximum of 255 bytes.",
"type":"string",
"maxLength":255
},
"resource":{
"description":"Indicates the resource of a data element.",
"description":"This tag indicates the detailed description of the permission.",
"type":"string"
}
}
}
},
"requestPermissions":{
"description":"Indicates the permissions that the application applies for from the system before its running.This label can be left blank by default.",
"type":"array",
"items":{
"type":"object",
"propertyNames":{
"enum":[
"name",
"reason",
"usedScene"
]
},
"required":[
"name"
],
"properties":{
"name":{
"description":"Specifies the permission name to be used.",
"type":"string"
},
"reason":{
"description":"Describe the reason for applying for the permission.",
"description":"This section describes the scenarios and timing of permission usage.",
"type":"object",
"propertyNames":{
"enum":[
"abilities",
"when"
]
},
"properties":{
"abilities":{
"description":"This tag identifies the abilities that need the permission.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"string"
}
},
"when":{
"description":"This tag identifies the time when the permission is used.",
"type":"string",
"enum":[
"inuse",
"always"
]
}
}
}
}
}
},
"testRunner":{
"description":"This tag is used for configure the test properties.",
"type":"object",
"required":[
"name",
"srcPath"
],
"propertyNames":{
"enum":[
"name",
"srcPath"
]
},
"properties":{
"name":{
"description":"Indicates the name of testRunner, The value is a string with a maximum of 255 bytes",
"type":"string",
"maxLength":255
},
"srcPath":{
"description":"Indicates the srcPath testRunner, The value is a string with a maximum of 255 bytes",
"type":"string",
"maxLength":255
}
}
},
"dependencies":{
"description":"Indicates the module names that this module depends on.",
"type":"array",
"uniqueItems":true,
"items":{
"type":"object",
"propertyNames":{
"enum":[
"bundleName",
"moduleName",
"versionCode"
]
},
"required":[
"moduleName"
],
"properties":{
"bundleName":{
"description":"Indicates the bundle name of the dependency shared library. It uniquely identifies the dependency shared library. The value is a string with 7 to 128 bytes of a reverse domain name, for example, com.huawei.himusic. It is recommended that the first label of this attribute is the top-level domain com, the second label is the vendor or individual name, and the third label is the dependency shared library name. This label is a string type and cannot be defaulted.",
"type":"string",
"maxLength":128,
"minLength":7,
"pattern":"^[a-zA-Z][0-9a-zA-Z_.]+$"
},
"moduleName":{
"description":"Indicates the module name of the dependency shared library.",
"type":"string",
"maxLength":128
},
"versionCode":{
"description":"Indicates the versionCode number of the dependency shared library. The value is an integer greater than 0. A larger value generally represents a later version.The system determines the dependency shared library version based on the tag value.This label cannot be left blank.",
"type":"integer",
"minimum":0,
"maximum":2147483647
}
}
}
},
"libIsolation":{
"description":"Indicates whether to isolate the shared libraries in this module.",
"type":"boolean"
},
"compressNativeLibs":{
"description":"Specifies whether the libs libraries of the .hap file are compressed for storage. If this attribute is set to false, the libs libraries are stored without being compressed and will be directly loaded during the installation of the .hap file.",