diff --git a/zh-cn/application-dev/quick-start/app-structure.md b/zh-cn/application-dev/quick-start/app-structure.md index b865b4bb2e485ca84117a61496c44ef49d447d81..3cfc6a9f1560db75f13cb32e847e578669afaafb 100644 --- a/zh-cn/application-dev/quick-start/app-structure.md +++ b/zh-cn/application-dev/quick-start/app-structure.md @@ -3,7 +3,7 @@ app对象包含应用全局配置信息，内部结构如下： -### **表1** **app对象内部结构说明** +**表1** **app对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -14,7 +14,9 @@ app对象包含应用全局配置信息，内部结构如下： | smartWindowSize | 标识应用在模拟器中运行时使用的屏幕尺寸。 | 字符串 | 可缺省，缺省值为空。 | | smartWindowDeviceType | 标识应用在模拟器中运行时可以模拟的设备。 | 字符串数组 | 可缺省，缺省值为空。 | -#### **表2** **version对象内部结构说明** +## version对象内部结构 + +**表2** **version对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -22,7 +24,9 @@ app对象包含应用全局配置信息，内部结构如下： | code | 标识应用的版本号，仅用于OpenHarmony管理该应用，不对应用的终端用户呈现。取值规则如下：API5及更早版本：二进制32位以内的非负整数，需要从version.name的值转换得到。转换规则为：code值=A \* 1,000,000 + B \* 1,000 + C例如，version.name字段取值为2.2.1，则code值为2002001。API6版本起：code的取值不与version.name字段的取值关联，开发者可自定义code取值，取值范围为2^31以内的非负整数，但是每次应用版本的更新，均需要更新code字段的值，新版本code取值必须大于旧版本code的值。 | 数值 | 不可缺省。 | | minCompatibleVersionCode | 标识应用可兼容的最低版本号，用于跨设备场景下，判断其他设备上该应用的版本是否兼容。格式与version.code字段的格式要求相同。 | 数值 | 可缺省，缺省值为code标签值。 | -#### **表3** **apiVersion内部结构** +## apiVersion内部结构 + +**表3** **apiVersion内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -30,7 +34,7 @@ app对象包含应用全局配置信息，内部结构如下： | target | 用于标识应用运行时使用的API版本，取值范围为0~2147483647。 | 数值 | 配置在build.profile中，打包时由IDE填充到config.json中。 | | releaseType | 用于标识应用运行时SDK的状态。
canary：面向特定开发者早期预览版本，不承诺质量，不承诺API稳定。
beta：公开发布的Beta版本，早期Beta版本不承诺API稳定，经历若干次发布后，通过Release Notes对开发者声明该Beta版本为API稳定里程碑，后续版本的API冻结。
release：正式发布版本，承诺质量，API不可变更。当版本处于此状态时版本号中不呈现Stage字段。 | 字符串 | 配置在build.profile中，打包时由IDE填充到config.json中。 | -### app对象示例 +app对象示例 ```json "app": { diff --git a/zh-cn/application-dev/quick-start/deviceconfig-structure.md b/zh-cn/application-dev/quick-start/deviceconfig-structure.md index f63652f6f5dc8209662faff81ecd2e43ee4d8ae6..b6e981883ba5452c972efbccbd82fe24c5b1b733 100644 --- a/zh-cn/application-dev/quick-start/deviceconfig-structure.md +++ b/zh-cn/application-dev/quick-start/deviceconfig-structure.md @@ -3,7 +3,9 @@ deviceConfig包含设备上的应用配置信息，可以包含default，tv，car，wearable等属性。default标签内的配置适用于所有通用设备，其他设备类型如果有特殊的需求，则需要在该设备类型的标签下进行配置。 -### **表1** **deviceConfig对象内部结构说明** +## deviceConfig对象内部结构 + +**表1** **deviceConfig对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -16,7 +18,9 @@ deviceConfig包含设备上的应用配置信息，可以包含default，tv，ca 上表中各类设备对象的内部结构说明请见表2。 -#### **表2** **deviceConfig设备对象内部结构说明** +## deviceConfig设备对象内部结构 + +**表2** **deviceConfig设备对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -26,27 +30,33 @@ deviceConfig包含设备上的应用配置信息，可以包含default，tv，ca | compressNativeLibs | 标识libs库是否以压缩存储的方式打包到HAP。如果配置为"false"，则libs库以不压缩的方式存储，HAP在安装时无需解压libs，运行时会直接从HAP内加载libs库。 | 布尔值 | 可缺省，缺省值为false。 | | network | 标识网络安全性配置。该标签允许应用通过配置文件的安全声明来自定义其网络安全，无需修改应用代码。 | 对象 | 可缺省，缺省值为空。 | -#### **表3** **network对象的内部结构说明** +## network对象的内部结构 + +**表3** **network对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | cleartextTraffic | 标识是否允许应用使用明文网络流量（例如，明文HTTP）。
true：允许应用使用明文流量的请求。false：拒绝应用使用明文流量的请求。 | 布尔值 | 可缺省，缺省值为false。 | | securityConfig | 标识应用的网络安全配置信息。 | 对象 | 可缺省，缺省为空。 | -#### **表4** **securityConfig对象的内部结构说明** +## securityConfig对象的内部结构 + +**表4** **securityConfig对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | domainSettings | 标识自定义的网域范围的安全配置，支持多层嵌套，即一个domainSettings对象中允许嵌套更小网域范围的domainSettings对象。 | 对象类型 | 可缺省，缺省为空。 | -#### **表5** **domainSettings对象内部结构说明** +## domainSettings对象内部结构 + +**表5** **domainSettings对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | cleartextPermitted | 标识自定义的网域范围内是否允许明文流量传输。当cleartextTraffic和security同时存在时，自定义网域是否允许明文流量传输以cleartextPermitted的取值为准。true：允许明文流量传输。false：拒绝明文流量传输。 | 布尔类型 | 可缺省，缺省值为空。 | | domains | 标识域名配置信息，包含两个参数：subdomains和name。subdomains(布尔类型)：表示是否包含子域名。如果为"true"，此网域规则将与相应网域及所有子网域（包括子网域的子网域）匹配。否则，该规则仅适用于精确匹配项。name(字符串)：表示域名名称。 | 对象数组 | 可缺省，缺省值为空。 | -### deviceConfig示例 +deviceConfig示例 ```json "deviceConfig": { diff --git a/zh-cn/application-dev/quick-start/module-structure.md b/zh-cn/application-dev/quick-start/module-structure.md index a47a7d713b20b99d305987c3a40edf169d053337..a1c8867f3d3577f3cefc2efdd143885430565b86 100644 --- a/zh-cn/application-dev/quick-start/module-structure.md +++ b/zh-cn/application-dev/quick-start/module-structure.md @@ -3,7 +3,7 @@ module对象包含HAP的配置信息。 -### **表1** **module对象内部结构说明** + **表1** **module对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -89,7 +89,9 @@ module示例： } ``` -#### **表2** **distro对象内部结构说明** +## distro对象内部结构 + +**表2** **distro对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -110,7 +112,9 @@ distro示例： } ``` -#### **表3** **metadata对象内部结构说明** +## metadata对象内部结构 + +**表3** **metadata对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -118,7 +122,9 @@ distro示例： | results | 标识Ability返回值的元信息。每个返回值的元信息由以下三个标签组成：description、name、type。 | 对象数组 | 可缺省，缺省值为空。 | | customizeData | 该标签标识父级组件的自定义元信息，Parameters和results在application不可配。 | 对象数组 | 可缺省，缺省值为空。 | -#### **表4** **parameters对象内部结构说明** +## parameters对象内部结构 + +**表4** **parameters对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -126,7 +132,9 @@ distro示例： | name | 标识调用参数的名称。该标签最大长度为255个字节。 | 字符串 | 不可缺省。 | | type | 标识调用参数的类型，如Integer。 | 字符串 | 不可缺省。 | -#### **表5** **results对象内部结构说明** +## results对象内部结构 + +**表5** **results对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -134,7 +142,9 @@ distro示例： | name | 标识返回值的名字。该标签最大长度为255个字节。 | 字符串 | 可缺省，缺省值为空。 | | type | 标识返回值的类型，如Integer。 | 字符串 | 不可缺省 | -#### **表6** **customizeData对象的内部结构说明** +## customizeData对象的内部结构 + +**表6** **customizeData对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -166,7 +176,9 @@ metadata对象示例： } ``` -#### **表7** **deviceType标签配置说明** +## deviceType标签 + +**表7** **deviceType标签配置说明** | 设备类型 | 枚举值 | 说明 | | -------- | -------- | -------- | @@ -176,7 +188,9 @@ metadata对象示例： | 车机 | car | - | | 默认设备 | default | 能够使用全部系统能力的OpenHarmony设备。 | -#### **表8** **abilities对象的内部结构说明** +## abilities对象的内部结构 + +**表8** **abilities对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -210,7 +224,9 @@ metadata对象示例： | startWindowBackground | 标识该Ability启动页面背景颜色资源文件的索引。该标签仅适用于page类型的Ability。取值示例：$color:red。 | 字符串 | 可缺省，缺省值为空。 | | removeMissionAfterTerminate | 该标签标识Ability销毁后是否从任务列表中移除任务。该标签仅适用于page类型的Ability。true表示销毁后移除任务， false表示销毁后不移除任务。 | 布尔值 | 可缺省，缺省值为false。 | -#### **表9** **uriPermission对象的内部结构说明** +## uriPermission对象的内部结构 + +**表9** **uriPermission对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -286,8 +302,9 @@ abilities示例： } ] ``` +## skills对象的内部结构 -#### **表10** **skills对象的内部结构说明** +**表10** **skills对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -295,7 +312,9 @@ abilities示例： | entities | 标识能够接收的want的Ability的类别（如视频、桌面应用等），可以包含一个或多个entity。 | 字符串数组 | 可缺省，缺省值为空。 | | uris | 该标签标识向want过滤器添加数据规范集合。该规范可以是只有数据类型（mimeType属性），可以是只有URI，也可以是既有数据类型又有URI。
URI由其各个部分的单独属性指定：<scheme>://<host>:<port>[<path>\|<pathStartWith>\|<pathRegex>]。该标签可缺省，缺省值为空。
其中，scheme字段配置为uri时必配；当只设置数据类型（mimeType）时，则scheme字段为非必配项。 | 对象数组 | 可缺省，缺省值为空。 | -#### **表11** **uris对象的内部结构说明** +## uris对象的内部结构 + +**表11** **uris对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -332,7 +351,9 @@ skills示例： ] ``` -#### **表12** **reqPermissions权限申请字段说明** +## reqPermissions权限申请 + +**表12** **reqPermissions权限申请字段说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -340,14 +361,18 @@ skills示例： | reason | 描述申请权限的原因。需要做多语种适配。 | 字符串 | 分情况：当申请的权限为user_grant时，必须填写此字段，否则不允许在应用市场上架；其他权限可缺省，缺省为空 | | usedScene | 描述权限使用的场景和时机。场景类型如下两种：
- ability：ability的名称，可配置多个。
- when：调用时机，可填的值有inuse（使用时）、always（始终）。 | 对象 | 可缺省，缺省值为空。
when可缺省，缺省值为"inuse" | -#### **表13** **usedScene对象内部结构说明** +## usedScene对象内部结构 + +**表13** **usedScene对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | ability | 标识哪些Ability需要此权限，里面配置Ability的名称。 | 字符串数组 | 可以缺省，缺省表示所有Ability都需要此权限。 | | when | 标识此权限的使用时间：
inuse: 使用时需要此权限。
always: 所有时间都需要此权限。 | 枚举值 | 可缺省，缺省值为空。 | -#### **表14** **js对象的内部结构说明** +## js对象的内部结构 + +**表14** **js对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -357,14 +382,18 @@ skills示例： | type | 标识JS应用的类型。取值范围如下：
normal：标识该JS Component为应用实例。
form：标识该JS Component为卡片实例。 | 字符串 | 可缺省，缺省值为"normal"。 | |mode | 定义JS组件的开发模式。 | 对象 | 可缺省，缺省值为空。 | -#### **表15** **window对象的内部结构说明** +## window对象的内部结构 + +**表15** **window对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | designWidth | 标识页面设计基准宽度。以此为基准，根据实际设备宽度来缩放元素大小。 | 数值 | 可缺省，缺省值为720px。 | | autoDesignWidth | 标识页面设计基准宽度是否自动计算。当配置为true时，designWidth将会被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。 | 布尔值 | 可缺省，缺省值为false。 | -#### **表16** **mode对象的内部结构说明** +## mode对象的内部结构 + +**表16** **mode对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -391,7 +420,9 @@ js示例： ] ``` -#### **表17** **shortcuts对象的内部结构说明** +## shortcuts对象的内部结构 + +**表17** **shortcuts对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -400,7 +431,9 @@ js示例： | icon | 标识快捷方式的图标信息。取值为表示icon的资源索引。 | 字符串 | 可缺省，缺省为空。 | | intents | 标识快捷方式内定义的目标intent信息集合，每个intent可配置两个子标签，targetClass, targetBundle。 | 对象数组 | 可缺省，缺省为空。 | -#### **表18** **intents对象的内部结构说明** +## intents对象的内部结构 + +**表18** **intents对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -426,7 +459,9 @@ shortcuts示例： ] ``` -#### **表19** **forms对象的内部结构说明** +## forms对象的内部结构 + +**表19** **forms对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -445,7 +480,9 @@ shortcuts示例： | metaData | 标识卡片的自定义信息，包含customizeData数组标签。 | 对象 | 可缺省，缺省值为空。 | | customizeData | 标识自定义的卡片信息。 | 对象数组 | 可缺省，缺省值为空。 | -#### **表20** **customizeData对象内部结构说明** +## customizeData对象内部结构 + +**表20** **customizeData对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -507,7 +544,9 @@ forms示例： ] ``` -#### **表21** **distroFilter对象的内部结构说明** +## distroFilter对象的内部结构 + +**表21** **distroFilter对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -517,35 +556,45 @@ forms示例： |screenDensity | 标识屏幕的像素密度（dpi：Dots Per Inch）。 | 对象数组 | 可缺省，缺省值为空。 | | countryCode | 标识分发应用时的国家码。具体值参考ISO-3166-1的标准，支持多个国家和地区的枚举定义。 | 对象数组 | 可缺省，缺省值为空。 | -#### **表22** **apiVersion对象的内部结构说明** +## apiVersion对象的内部结构 + +**表22** **apiVersion对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | policy | 标识该子属性取值规则。配置为“exclude”或“include”。
- exclude：表示需要排除的value属性。
- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | | value | 支持的取值为API Version存在的整数值，例如4、5、6。场景示例：某应用，针对相同设备型号，同时在网的为使用API 5和API 6开发的两个软件版本，则允许上架2个entry类型的安装包，分别支持到对应设备侧软件版本的分发。 | 数组 | 不可缺省。 | -#### **表23** **screenShape对象的内部结构说明** +## screenShape对象的内部结构 + +**表23** **screenShape对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | policy | 标识该子属性取值规则。配置为“exclude”或“include”。
- exclude：表示需要排除的value属性。
- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | | value | 支持的取值为API Version存在的整数值，例如4、5、6。场景示例：某应用，针对相同设备型号，同时在网的为使用API 5和API 6开发的两个软件版本，则允许上架2个entry类型的安装包，分别支持到对应设备侧软件版本的分发。 | 数组 | 不可缺省。 | -#### **表24** **screenWindow对象的内部结构说明** +## screenWindow对象的内部结构 + +**表24** **screenWindow对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | policy | 标识该子属性取值规则。配置为“exclude”或“include”。
- exclude：表示需要排除的value属性。
- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | | value | 支持的取值为API Version存在的整数值，例如4、5、6。场景示例：某应用，针对相同设备型号，同时在网的为使用API 5和API 6开发的两个软件版本，则允许上架2个entry类型的安装包，分别支持到对应设备侧软件版本的分发。 | 数组 | 不可缺省。 | -#### **表25** **screenDensity对象的内部结构说明** +## screenDensity对象的内部结构 + +**表25** **screenDensity对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | | policy | 标识该子属性取值规则。配置为“exclude”或“include”。
- exclude：表示需要排除的value属性。
- include：表示需要包含的value属性。 | 字符串 | 不可缺省。 | | value | 取值范围如下：
sdpi：表示小规模的屏幕密度（Small-scale Dots Per Inch），适用于dpi取值为（0,120]的设备。
mdpi：表示中规模的屏幕密度(Medium-scale Dots Per Inch)，适用于dpi取值为（120,160]的设备。
ldpi：表示大规模的屏幕密度(Large-scale Dots Per Inch)，适用于dpi取值为（160,240]的设备。
xldpi：表示特大规模的屏幕密度(Extra Large-scale Dots Per Inch)，适用于dpi取值为（240,320]的设备。
xxldpi：表示超大规模的屏幕密度(Extra Extra Large-scale Dots Per Inch)，适用于dpi取值为（320,480]的设备。
xxxldpi：表示超特大规模的屏幕密度(Extra Extra Extra Large-scale Dots Per Inch)，适用于dpi取值为（480,640]的设备。 | 数组 | 不可缺省。 | -#### **表26** **countryCode对象的内部结构说明** +## countryCode对象的内部结构 + +**表26** **countryCode对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -580,7 +629,9 @@ distroFilter示例： } ``` -#### **表27** **commonEvents对象的内部结构说明** +## commonEvents对象的内部结构 + +**表27** **commonEvents对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -610,7 +661,9 @@ commonEvents示例： ] ``` -#### **表28** **testRunner对象的内部结构说明** +## testRunner对象的内部结构 + +**表28** **testRunner对象的内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | @@ -627,7 +680,8 @@ commonEvents示例： definePermission仅支持系统应用配置，三方应用配置不生效。 -#### **表29** **definePermissions对象内部结构说明** +## definePermissions对象内部结构 +**表29** **definePermissions对象内部结构说明** | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- |