From cd994ef016f84f1a9e63b03d16c014a8b57e8e06 Mon Sep 17 00:00:00 2001 From: longwei Date: Thu, 10 Mar 2022 10:43:34 +0800 Subject: [PATCH] fix config json Signed-off-by: longwei Change-Id: Ie2e17e6f974c8d976d3d28090ca85a53aef2298a --- .../quick-start/package-structure.md | 175 ++++++++++-------- 1 file changed, 101 insertions(+), 74 deletions(-) diff --git a/zh-cn/application-dev/quick-start/package-structure.md b/zh-cn/application-dev/quick-start/package-structure.md index 43a78f2056..599bd61b6d 100644 --- a/zh-cn/application-dev/quick-start/package-structure.md +++ b/zh-cn/application-dev/quick-start/package-structure.md @@ -88,7 +88,7 @@ app对象包含应用全局配置信息，内部结构说明参见表2。 | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | ---------- | ------------------------------------------------------------ | -------- | ------------------ | -| bundleName | 表示应用的包名，用于标识应用的唯一性。包名是由字母、数字、下划线（_）和点号（.）组成的字符串，必须以字母开头。支持的字符串长度为7~127字节。包名通常采用反域名形式表示（例如，"com.example.myapplication"）。建议第一级为域名后缀"com"，第二级为厂商/个人名，也可以采用多级。 | 字符串 | 否 | +| bundleName | 表示应用的包名，用于标识应用的唯一性。包名是由字母、数字、下划线（_）和点号（.）组成的字符串，必须以字母开头。支持的字符串长度为7~127字节。包名通常采用反向域名形式表示（例如，"com.example.myapplication"）。建议第一级为域名后缀"com"，第二级为厂商/个人名，也可以采用多级。 | 字符串 | 否 | | vendor | 表示对应用开发厂商的描述。字符串长度不超过255字节。 | 字符串 | 可缺省，缺省值为空 | | version | 表示应用的版本信息。参考表3。 | 对象 | 否 | | apiVersion | 标识应用程序所依赖的OpenHarmony API版本。参考表4。 | 对象 | 可缺省，缺省值为空 | @@ -97,8 +97,8 @@ app对象包含应用全局配置信息，内部结构说明参见表2。 | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | ------------------------ | ------------------------------------------------------------ | -------- | -------------------------- | -| name | 表示应用的版本号，用于向应用的终端用户呈现。取值可以自定义，长度不超过127字节。自定义规则如下：
API5及更早的版本：推荐使用三段数字版本号（也兼容两段式版本号），如A.B.C(也兼容A.B)，其中A、B、C取值为0-999范围内的整数。初次之外不支持其他格式。
A段，一般表示主版本号（Major）。
B段，一般表示次版本号（Minor）。
C段，一般表示修订版本号（Patch）。
API6版本起：推荐采用四段式数字版本号，如A.B.C.D，其中A、B、C取值为0-99范围内的整数，D的取值为0-999范围内的整数。
A段，一般表示主版本号（Major）。
B段，一般表示次版本号（Minor）。
C段，一般表示特性版本号（Feature）。
D段，一般表示修订版本号（Patch）。 | 数值 | 不可缺省 | -| 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的值。 | 数值 | 不可缺省 | +| name | 表示应用的版本号，用于向应用的终端用户呈现。取值可以自定义，长度不超过127字节。自定义规则如下：
API5及更早的版本：推荐使用三段数字版本号（也兼容两段式版本号），如A.B.C(也兼容A.B)，其中A、B、C取值为0-999范围内的整数。除此之外不支持其他格式。
A段，一般表示主版本号（Major）。
B段，一般表示次版本号（Minor）。
C段，一般表示修订版本号（Patch）。
API6版本起：推荐采用四段式数字版本号，如A.B.C.D，其中A、B、C取值为0-99范围内的整数，D的取值为0-999范围内的整数。
A段，一般表示主版本号（Major）。
B段，一般表示次版本号（Minor）。
C段，一般表示特性版本号（Feature）。
D段，一般表示修订版本号（Patch）。 | 数值 | 不可缺省 | +| 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标签值 | 表4 apiVersion内部结构 @@ -107,7 +107,7 @@ app对象包含应用全局配置信息，内部结构说明参见表2。 | ----------- | ----------------------------------------------------------- | -------- | ---------- | | compatible | 运行应用所需要的最低API版本，取值范围为0~2147483647。 | 整数 | 可缺省 | | target | 用于标识应用运行所需的目标API版本，取值范围为0~2147483647。 | 整数 | 可缺省 | -| releaseType | 用于标识应用运行所需的目标API版本。 | 字符串 | 可缺省 | +| releaseType | 用于标识应用运行所需的目标API版本的类型。 | 字符串 | 可缺省 | app实例： @@ -149,7 +149,7 @@ default、phone、tablet、tv、car、wearable、liteWearble等对象的内部 | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | ------------------ | ------------------------------------------------------------ | -------- | ----------------------- | -| process | 表示应用或者Ability的进程名。如果在deviceConfig标签下配置了process标签，则该应用的所有Ability都运行在这个进程中。如果在abilities标签下也为某个Ability配置了process标签，则该Ability就运行在这个进程中。该标签仅适用于手机、平板、智慧屏、车机、智慧穿戴。 | 字符串 | 是 | +| process | 表示应用或者Ability的进程名。如果在deviceConfig标签下配置了process标签，则该应用的所有Ability都运行在这个进程中。如果在abilities标签下也为某个Ability配置了process标签，则该Ability就运行在这个进程中。该标签仅适用于手机、平板、智慧屏、车机、智慧穿戴。该标签最大长度为31。 | 字符串 | 是 | | supportBackup | 表示应用是否支持备份和恢复。如果配置为"false"，则不支持为该应用执行备份或恢复操作。
该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 布尔值 | 可缺省，缺省值为"false" | | compressNativeLibs | 表示libs库是否以压缩存储的方式打包到HAP包。如果配置为"false"，则libs库以不压缩的方式存储，HAP包在安装时无需解压libs，运行时会直接从HAP内加载libs库。
该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 布尔值 | 可缺省，缺省值为"true" | | directLaunch | 指定设备被锁定时是否可以启动应用程序。如果要在不解锁设备的情况下启动应用程序，请将此设备设置为"true"。运行OHOS的设备不支持此属性。 | 布尔值 | 可缺省，缺省值为"false" | @@ -165,10 +165,10 @@ default、phone、tablet、tv、car、wearable、liteWearble等对象的内部 表8 reqVersion对象内部结构说明 -| 属性名称 | 含义 | 数据类型 | 是否可缺省 | -| ---------- | ------------------------------- | -------- | ---------- | -| compatible | 表示支持应用程序的最低maple版本 | 整数 | 不可缺省 | -| target | 指定maple应用程序的类型 | 整数 | 不可缺省 | +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| ---------- | -------------------------------------------------------- | -------- | ---------- | +| compatible | 表示支持应用程序的最低maple版本,采用32位无符号整形表示。 | 整数 | 不可缺省 | +| target | 指定maple应用程序的类型,采用32位无符号整形表示。 | 整数 | 不可缺省 | 表9 network对象的内部结构说明 @@ -181,7 +181,7 @@ default、phone、tablet、tv、car、wearable、liteWearble等对象的内部 | 属性名称 | 子属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------------- | ------------------ | ------------------------------------------------------------ | -------- | ---------------- | -| domainSettings | - | 表示自定义的网域范围的安全配置，支持多层嵌套，即一个domainSettings对象中允许嵌套更小网域范围的domainSettings对象。 | 布尔类型 | 可缺省，缺省为空 | +| domainSettings | - | 表示自定义的网域范围的安全配置，支持多层嵌套，即一个domainSettings对象中允许嵌套更小网域范围的domainSettings对象。 | 对象类型 | 可缺省，缺省为空 | | | cleartextPermitted | 表示自定义的网域范围内是否允许明文流量传输。当cleartextTraffic和security同时存在时，自定义网域是否允许明文流量传输以cleartextPermitted的取值为准。
true：允许明文流量传输。
false：拒绝明文流量传输 | 布尔类型 | 否 | | | domains | 表示域名配置信息，包含两个参数：subdomains和name。
subdomains(布尔类型)：表示是否包含子域名。如果为"true"，此网域规则将与相应网域及所有子网域（包括子网域的子网域）匹配。否则，该规则仅适用于精确匹配项。
name(字符串)：表示域名名称 | 对象数组 | 否 | @@ -231,11 +231,11 @@ module对象包含HAP包的配置信息，内部结构说明参见表11。 | shortcuts | 表示应用的快捷方式信息。采用对象数组格式，其中的每个元素表示一个快捷方式对象。参考表25。 | 对象数组 | 可缺省，缺省值为空 | | reqPermissions | 表示应用运行时向系统申请的权限。参考表21。 | 对象数组 | 可缺省，缺省值为空 | | colorMode | 表示应用自身的颜色模式。
dark：表示按照深色模式选取资源。
light：表示按照浅色模式选取资源。
auto：表示跟随系统的颜色模式值选取资源。
该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省，缺省值为"auto" | -| distroFilter | 表示应用的分发规则。
该标签用于定义HAP包对应的细分设备规格的分发策略，以便在应用市场进行云端分发应用包时做精准匹配。该标签可配置的分发策略维度包括API Verion、屏幕形状、屏幕分辨率。在进行分发时，通过deviceType与这三个属性的匹配关系，唯一确定一个用于分发到设备的HAP。参考表29。 | 对象数组 | 可缺省，缺省值为空。但当应用中包含多个entry模块时，必须配置该标签。 | +| distroFilter | 表示应用的分发规则。
该标签用于定义HAP包对应的细分设备规格的分发策略，以便在应用市场进行云端分发应用包时做精准匹配。该标签可配置的分发策略维度包括API Verion、屏幕形状、屏幕分辨率。在进行分发时，通过deviceType与这三个属性的匹配关系，唯一确定一个用于分发到设备的HAP。参考表29。 | 对象 | 可缺省，缺省值为空。但当应用中包含多个entry模块时，必须配置该标签。 | | reqCapabilities | 表示运行应用程序所需的设备能力 | 字符串数组 | 可缺省，缺省为空 | -| commonEvents | 静态广播，参考表33。 | 对象数组 | 可缺省，缺省为空 | +| commonEvents | 静态广播，参考表35。 | 对象数组 | 可缺省，缺省为空 | | allowClassMap | HAP的元信息。标记值为true或false。如果标记值为true，则hap使用OpenHarmony框架提供的Java对象代理机制。默认值为false。 | 布尔值 | 不可缺省，缺省值为false | -| entryTheme | 此标签表示OpenHarmony内部主题的关键字。将标记值设置为名称的资源索引 | 字符串 | 可缺省，缺省值为 | +| entryTheme | 此标签表示OpenHarmony内部主题的关键字。将标记值设置为名称的资源索引 | 字符串 | 可缺省，缺省值为空 | module示例： @@ -275,7 +275,7 @@ module示例： | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | ---------------- | ------------------------------------------------------------ | -------- | ---------- | -| moduleName | 表示当前HAP的名称。 | 字符串 | 不可缺省 | +| moduleName | 表示当前HAP的名称，最大长度为31。 | 字符串 | 不可缺省 | | moduleType | 表示当前HAP的类型，包括两种类型：entry和feature。另外，如果表示HAR类型，请设置为har。 | 字符串 | 不可缺省 | | installationFree | 表示当前HAP是否支持免安装特性。
true：表示支持免安装特性，且符合免安装约束。
false：表示不支持免安装特性。
另外还需注意：
当entry.hap该字段配置为true时，与该entry.hap相关的所有feature.hap该字段也需要配置为true。
当entry.hap该字段配置为false时，与该entry.hap相关的各feature.hap该字段可按业务 需求配置true或false。 | 布尔值 | 否 | @@ -291,25 +291,26 @@ distro示例： 表13 metaData对象的内部结构说明 -| 属性名称 | 含义 | 数据类型 | 是否可缺省 | -| ---------- | ------------------------------------------------------------ | -------- | -------------------- | -| parameters | 表示调用Ability时所有调用参数的元信息。每个调用参数参数的元信息由一下三个标签组成：description、name、type。参考表14。 | 对象 | 可缺省，缺省值为空 | -| results | 表示Ability返回值的元信息。每个返回值的元信息由以下三个标签组成：description、name、type。参考表15。 | 对象 | 可缺省，缺省值为空。 | +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| ------------- | ------------------------------------------------------------ | -------- | -------------------- | +| parameters | 表示调用Ability时所有调用参数的元信息。每个调用参数的元信息由以下三个标签组成：description、name、type。参考表14。 | 对象数组 | 可缺省，缺省值为空 | +| results | 表示Ability返回值的元信息。每个返回值的元信息由以下三个标签组成：description、name、type。参考表15。 | 对象数组 | 可缺省，缺省值为空。 | +| customizeData | 该标签标识父级组件的自定义元信息，Parameters和results在application不可配。参考表16 | 对象数组 | 可缺省，缺省值为空。 | 表14 parameters对象的内部结构说明 | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | ----------- | ------------------------------------------------------------ | -------- | ------------------ | -| description | 表示对调用参数的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。 | 字符串 | 可缺省，缺省值为空 | -| name | 表示调用参数的名称。 | 字符串 | 可缺省，缺省值为空 | +| description | 表示对调用参数的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。该标签最大长度为255。 | 字符串 | 可缺省，缺省值为空 | +| name | 表示调用参数的名称。该标签最大长度为255。 | 字符串 | 可缺省，缺省值为空 | | type | 表示调用参数的类型，如Integer。 | 字符串 | 不可缺省 | 表15 results对象的内部结构说明 | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | ----------- | ------------------------------------------------------------ | -------- | -------------------- | -| description | 表示对返回值的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。 | 字符串 | 可缺省，缺省值为空。 | -| name | 表示返回值的名字。 | 字符串 | 可缺省，缺省值为空。 | +| description | 表示对返回值的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。该标签最大长度为255。 | 字符串 | 可缺省，缺省值为空。 | +| name | 表示返回值的名字。该标签最大长度为255。 | 字符串 | 可缺省，缺省值为空。 | | type | 表示返回值的类型，如Integer。 | 字符串 | 否 | 表16 customizeData对象的内部结构说明 @@ -317,7 +318,7 @@ distro示例： | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | -------- | ---------------------------------------------------------- | -------- | -------------------- | | name | 表示数据项的键名称，字符串类型（最大长度255字节）。 | 字符串 | 可缺省，缺省值为空。 | -| value | 表示数据项的键名称，字符串类型（最大长度255字节）。 | 字符串 | 可缺省，缺省值为空。 | +| value | 表示数据项的值名称，字符串类型（最大长度255字节）。 | 字符串 | 可缺省，缺省值为空。 | | extra | 表示用户自定义数据格式，标签值为标识该数据的资源的索引值。 | 字符串 | 可缺省，缺省值为空。 | metaData示例： @@ -347,11 +348,11 @@ metaData示例： | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | ---------------- | ------------------------------------------------------------ | ---------- | -------------------------------------------------------- | | process | 运行应用程序或Ability的进程名称。如果在deviceConfig标记中配置了进程，则应用程序的所有能力都在此进程中运行。您还可以为特定能力设置流程属性，以便该能力可以在此流程中运行。如果此属性设置为与其他应用程序相同的进程名称，则所有这些应用程序可以在同一进程中运行，前提是他们具有相同的联合用户ID和相同的签名。运行OHOS的设备不支持此属性。 | 字符串 | 可缺省，缺省值为空。 | -| name | 表示Ability名称。取值可采用反向域名方式表示，由包名和类名组成，如“com.example.myapplication.MainAbility”；也可采用“.”开头的类名方式表示，如“.MainAbility”。
Ability的名称，需在一个应用的范围内保证唯一。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。
说明：在使用DevEco Studio新建项目时，默认生成首个Ability的配置，包括生成“MainAbility.java”文件，及“config.json”中“MainAbility”的配置。如使用其他IDE工具，可自定义名称。 | 字符串 | 否 | -| description | 表示对Ability的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。 | 字符串 | 可缺省，缺省值为空。 | +| name | 表示Ability名称。取值可采用反向域名方式表示，由包名和类名组成，如“com.example.myapplication.MainAbility”；也可采用“.”开头的类名方式表示，如“.MainAbility”。
Ability的名称，需在一个应用的范围内保证唯一。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。
说明：在使用DevEco Studio新建项目时，默认生成首个Ability的配置，包括生成“MainAbility.java”文件，及“config.json”中“MainAbility”的配置。如使用其他IDE工具，可自定义名称。该标签最大长度为127。 | 字符串 | 否 | +| description | 表示对Ability的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。该标签最大长度为255。 | 字符串 | 可缺省，缺省值为空。 | | icon | 表示Ability图标资源文件的索引。取值示例：$media:ability_icon。如果在该Ability的skills属性中，actions的取值包含 “action.system.home”，entities取值中包含“entity.system.home”，则该Ability的icon将同时作为应用的icon。如果存在多个符合条件的Ability，则取位置靠前的Ability的icon作为应用的icon。
说明：应用的“icon”和“label”是用户可感知配置项，需要区别于当前所有已有的应用“icon”或“label”（至少有一个不同）。 | 字符串 | 可缺省，缺省值为空。 | -| label | 表示Ability对用户显示的名称。取值可以是Ability名称，也可以是对该名称的资源索引，以支持多语言。如果在该Ability的skills属性中，actions的取值包含 “action.system.home”，entities取值中包含“entity.system.home”，则该Ability的label将同时作为应用的label。如果存在多个符合条件的Ability，则取位置靠前的Ability的label作为应用的label。
说明： 应用的“icon”和“label”是用户可感知配置项，需要区别于当前所有已有的应用“icon”或“label”（至少有一个不同）。 | 字符串 | 可缺省，缺省值为空。 | -| uri | 表示Ability的统一资源标识符。 | 字符串 | 可缺省，对于data类型的Ability不可缺省。 | +| label | 表示Ability对用户显示的名称。取值可以是Ability名称，也可以是对该名称的资源索引，以支持多语言。如果在该Ability的skills属性中，actions的取值包含 “action.system.home”，entities取值中包含“entity.system.home”，则该Ability的label将同时作为应用的label。如果存在多个符合条件的Ability，则取位置靠前的Ability的label作为应用的label。
说明： 应用的“icon”和“label”是用户可感知配置项，需要区别于当前所有已有的应用“icon”或“label”（至少有一个不同）。该标签最大长度为255。 | 字符串 | 可缺省，缺省值为空。 | +| uri | 表示Ability的统一资源标识符。该标签最大长度为255。 | 字符串 | 可缺省，对于data类型的Ability不可缺省。 | | launchType | 表示Ability的启动模式，支持“standard”、“singleMission”和“singleton”三种模式：
standard：表示该Ability可以有多实例。
“standard”模式适用于大多数应用场景。
singleMission：表示此Ability在每个任务栈中只能有一个实例。
singleton：表示该Ability在所有任务栈中仅可以有一个实例。例如，具有全局唯一性的呼叫来电界面即采用“singleton”模式。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 | 字符串 | 可缺省，缺省值为“standard”。 | | visible | 表示Ability是否可以被其他应用调用。
true：可以被其他应用调用。
false：不能被其他应用调用。 | 布尔类型 | 可缺省，缺省值为“false”。 | | permissions | 表示其他应用的Ability调用此Ability时需要申请的权限。通常采用反向域名格式，取值可以是系统预定义的权限，也可以是开发者自定义的权限。 | 字符串数组 | 可缺省，缺省值为空。 | @@ -373,14 +374,14 @@ metaData示例： | forms | 表示服务卡片的属性。该标签仅当formsEnabled为“true”时，才能生效。参考表27。 | 对象数组 | 可缺省，缺省值为空。 | | srcLanguage | Ability开发语言的类型。 | 字符串 | 取值为java、js或ets | | srcPath | 该标签表示Ability对应的JS组件代码路径 | 字符串 | 可缺省，缺省值为空。 | -| uriPermission | 表示该Ability有权访问的应用程序数据。此属性由模式和路径子属性组成。此属性仅对类型提供的能力有效。运行OHOS的设备不支持此属性。参考表18。 | 对象 | 可缺省，缺省值为空。 | +| uriPermission | 表示该Ability有权访问的应用程序数据。此属性由模式和路径子属性组成。此属性仅对类型提供者的能力有效。运行OHOS的设备不支持此属性。参考表18。 | 对象 | 可缺省，缺省值为空。 | 表18 uriPermission对象的内部结构说明 -| 属性名称 | 含义 | 数据类型 | 是否可缺省 | -| -------- | ----------------------- | -------- | ----------------------- | -| path | uriPermission标识的路径 | 字符串 | 不可缺省 | -| mode | uriPeimission的匹配模式 | 字符串 | 可缺省，缺省值为false。 | +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| -------- | ----------------------- | -------- | ------------------------- | +| path | uriPermission标识的路径 | 字符串 | 不可缺省 | +| mode | uriPeimission的匹配模式 | 字符串 | 可缺省，缺省值为default。 | abilities示例： @@ -457,13 +458,15 @@ abilities示例： 表20 uris对象的内部结构说明 -| 属性名称 | 含义 | 数据类型 | 是否可缺省 | -| -------- | ------------------- | -------- | -------------------- | -| scheme | 表示uri的scheme值。 | 字符串 | 不可缺省。 | -| host | 表示uri的host值。 | 字符串 | 可缺省，缺省值为空。 | -| port | 表示uri的port值。 | 字符串 | 可缺省，缺省值为空。 | -| path | 表示uri的path值。 | 字符串 | 可缺省，缺省值为空。 | -| type | 表示uri的type值。 | 字符串 | 可缺省，缺省值为空。 | +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| ------------- | -------------------------- | -------- | -------------------- | +| scheme | 表示uri的scheme值。 | 字符串 | 不可缺省。 | +| host | 表示uri的host值。 | 字符串 | 可缺省，缺省值为空。 | +| port | 表示uri的port值。 | 字符串 | 可缺省，缺省值为空。 | +| pathStartWith | 表示uri的pathStartWith值。 | 字符串 | 字符串 | +| path | 表示uri的path值。 | 字符串 | 可缺省，缺省值为空。 | +| pathRegx | 表示uri的pathRegx值。 | 字符串 | 可缺省，缺省值为空。 | +| type | 表示uri的type值。 | 字符串 | 可缺省，缺省值为空。 | skills示例： @@ -491,11 +494,11 @@ skills示例： 表21 reqPermissions权限申请字段说明 -| 属性名称 | 含义 | **类型** | **取值范围** | **默认值** | **规则约束** | -| --------- | ------------------------------------------------------------ | ------------------------------- | ----------------------------------------------------------- | ---------------------- | ------------------------------------------------------------ | -| name | 必须，填写需要使用的权限名称。 | 字符串 | 自定义 | 无 | 未填写时，解析失败。 | -| reason | 可选，当申请的权限为user_grant权限时此字段必填。描述申请权限的原因。 | 字符串 | 显示文字长度不能超过256个字节。 | 空 | user_grant权限必填，否则不允许在应用市场上架。需做多语种适配。 | -| usedScene | 可选，当申请的权限为user_grant权限时此字段必填。描述权限使用的场景和时机。场景类型有：ability、when（调用时机）。可配置多个ability。 | ability：字符串数组when：字符串 | ability：ability的名称when：inuse（使用时）、always（始终） | ability：空when：inuse | user_grant权限必填ability，可选填when。 | +| 属性名称 | 含义 | **类型** | **取值范围** | **默认值** | **规则约束** | +| --------- | ------------------------------------------------------------ | -------- | ----------------------------------------------------------- | ---------------------- | ------------------------------------------------------------ | +| name | 必须，填写需要使用的权限名称。 | 字符串 | 自定义 | 无 | 未填写时，解析失败。 | +| reason | 可选，当申请的权限为user_grant权限时此字段必填。描述申请权限的原因。 | 字符串 | 显示文字长度不能超过256个字节。 | 空 | user_grant权限必填，否则不允许在应用市场上架。需做多语种适配。 | +| usedScene | 可选，当申请的权限为user_grant权限时此字段必填。描述权限使用的场景和时机。场景类型有：ability、when（调用时机）。可配置多个ability。 | 对象 | ability：ability的名称when：inuse（使用时）、always（始终） | ability：空when：inuse | user_grant权限必填ability，可选填when。 | 表22 js对象的内部结构说明 @@ -516,10 +519,10 @@ skills示例： 表24 mode对象的内部结构说明 -| 属性名称 | 含义 | 数据类型 | 是否可缺省 | -| -------- | -------------------- | ----------------------------------- | -------------------------- | -| type | 定义JS组件的功能类型 | 字符串，取值为"pageAbility"、"form" | 可缺省，缺省值为pageAbilit | -| syntax | 定义JS组件的语法类型 | 字符串，取值为"hml"，"ets" | 是，默认值为"hml" | +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| -------- | -------------------- | ----------------------------------- | --------------------------- | +| type | 定义JS组件的功能类型 | 字符串，取值为"pageAbility"、"form" | 可缺省，缺省值为pageAbility | +| syntax | 定义JS组件的语法类型 | 字符串，取值为"hml"，"ets" | 是，默认值为"hml" | js示例： @@ -546,6 +549,7 @@ js示例： | ---------- | ------------------------------------------------------------ | -------- | ------------------ | | shortcutId | 表示快捷方式的ID。字符串的最大长度为63字节。 | 字符串 | 否 | | label | 表示快捷方式的标签信息，即快捷方式对外显示的文字描述信息。取值可以是描述性内容，也可以是标识label的资源索引。字符串最大长度为63字节。 | 字符串 | 可缺省，缺省为空。 | +| icon | 表示快捷方式的图标信息。取值为表示icon的资源索引。 | 字符串 | 可缺省，缺省为空。 | | intents | 表示快捷方式内定义的目标intent信息集合，每个intent可配置两个子标签，targetClass, targetBundle。参考表26。 | 对象数组 | 可缺省，缺省为空。 | 表26 intents对象的内部结构说明 @@ -588,7 +592,7 @@ shortcuts示例： | updateEnabled | 表示卡片是否支持周期性刷新，取值范围：
true：表示支持周期性刷新，可以在定时刷新（updateDuration）和定点刷新（scheduledUpdateTime）两种方式任选其一，优先选择定时刷新。
false：表示不支持周期性刷新。 | 布尔类型 | 否 | | scheduledUpdateTime | 表示卡片的定点刷新的时刻，采用24小时制，精确到分钟。 | 字符串 | 可缺省，缺省值为“0:0”。 | | updateDuration | 表示卡片定时刷新的更新周期，单位为30分钟，取值为自然数。
当取值为0时，表示该参数不生效。
当取值为正整数N时，表示刷新周期为30*N分钟。 | 数值 | 可缺省，缺省值为“0”。 | -| formConfigAbility | 表示卡片的配置跳转链接，采用URI格式。 | 字符串 | 可缺省，缺省值为空。 | +| formConfigAbility | 表示用于调整卡片的设施或活动的名称。 | 字符串 | 可缺省，缺省值为空。 | | formVisibleNotify | 标识是否允许卡片使用卡片可见性通知 | 字符串 | 可缺省，缺省值为空。 | | jsComponentName | 表示JS卡片的Component名称。字符串最大长度为127字节。仅当卡片类型为JS卡片时，需要配置该标签。 | 字符串 | 否 | | metaData | 表示卡片的自定义信息，包含customizeData数组标签。参考表13。 | 对象 | 可缺省，缺省值为空。 | @@ -596,10 +600,11 @@ shortcuts示例： 表28 customizeData对象内部结构说明 -| 属性名称 | 含义 | 数据类型 | 是否可缺省 | -| -------- | --------------------------------------------- | -------- | -------------------- | -| name | 表示数据项的键名称。字符串最大长度为255字节。 | 字符串 | 可缺省，缺省值为空。 | -| value | 表示数据项的值。字符串最大长度为255字节。 | 字符串 | 可缺省，缺省值为空。 | +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| -------- | --------------------------------------------------- | -------- | -------------------- | +| name | 表示数据项的键名称。字符串最大长度为255字节。 | 字符串 | 可缺省，缺省值为空。 | +| value | 表示数据项的值。字符串最大长度为255字节。 | 字符串 | 可缺省，缺省值为空。 | +| extra | 表示当前custom数据的格式，取值为表示extra的资源值。 | 字符串 | 可缺省，缺省值为空。 | forms示例： @@ -656,11 +661,13 @@ forms示例： 表29 distroFilter对象的内部结构说明 -| 属性名称 | 含义 | 数据类型 | 是否可缺省 | -| ------------ | ------------------------------------------------------------ | -------- | ---------- | -| apiVersion | 表示支持的apiVersion范围。参考表30。 | 对象数组 | 可选 | -| screenShape | 表示屏幕形状的支持策略。参考表31。 | 对象数组 | 可选 | -| screenWindow | 表示应用运行时窗口的分辨率支持策略。该字段仅支持对轻量级智能穿戴设备进行配置。参考表32。 | 对象数组 | 可选 | +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| ------------- | ------------------------------------------------------------ | -------- | ---------- | +| apiVersion | 表示支持的apiVersion范围。参考表30。 | 对象 | 可选 | +| screenShape | 表示屏幕形状的支持策略。参考表31。 | 对象数组 | 可选 | +| screenWindow | 表示应用运行时窗口的分辨率支持策略。该字段仅支持对轻量级智能穿戴设备进行配置。参考表32。 | 对象数组 | 可选 | +| screenDensity | 表示屏幕的像素密度（dpi：Dots Per Inch）。参考表33。 | 对象数组 | 可选 | +| countryCode | 表示分发应用时的国家码。具体值参考ISO-3166-1的标准，支持多个国家和地区的枚举定义。参考表34。 | 对象数组 | 可选 | 表30 apiVersion对象的内部结构说明 @@ -683,28 +690,48 @@ forms示例： | policy | 表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 | | value | 单个字符串的取值格式为：“宽 * 高”，取值为整数像素值，例如“454 * 454”。 | 数组 | 可缺省，缺省值为空。 | +表33 screenDensity对象的内部结构说明 + +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| -------- | ------------------------------------------------------------ | -------- | -------------------- | +| policy | 表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“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]的设备。 | 数组 | 可缺省，缺省值为空。 | + +表34 countryCode对象的内部结构说明 + +| 属性名称 | 含义 | 数据类型 | 是否可缺省 | +| -------- | ------------------------------------------------------------ | ---------- | -------------------- | +| policy | 表示该子属性取值的黑白名单规则。配置为“exclude”或“include”。“include”表示该字段取值为白名单，满足value枚举值匹配规则的表示匹配该属性。 | 字符串 | 可缺省，缺省值为空。 | +| value | 该标签表示应用需要分发的国家码，标签为字符串数组，子串表示支持的国家或地区，由两个大写字母表示。 | 字符串数组 | 可缺省，缺省值为空。 | + distroFilter示例： ```json -"distroFilter": [ - { - "apiVersion": { - "policy": "include", - "value": [4,5] - }, - "screenShape": { - "policy": "include", - "value": ["circle","rect"] - }, - "screenWindow": { - "policy": "include", - "value": ["454*454","466*466"] - } +"distroFilter": { + "apiVersion": { + "policy": "include", + "value": [4,5] + }, + "screenShape": { + "policy": "include", + "value": ["circle","rect"] + }, + "screenWindow": { + "policy": "include", + "value": ["454*454","466*466"] + }， + “screenDensity”:{ + "policy": "exclude", + "value": ["ldpi","xldpi"] + }, + "countryCode": { + "policy":"include", + "value":["CN", "HK"] } -] +} ``` -表33 commonEvents对象的内部结构说明 +表35 commonEvents对象的内部结构说明 | 属性名称 | 含义 | 数据类型 | 是否可缺省 | | ---------- | ------------------------------------------------------------ | ---------- | ------------------ | -- GitLab