1# @ohos.app.form.formInfo (formInfo) 2 3formInfo模块提供了卡片信息和状态等相关类型和枚举。 4 5> **说明：** 6> 7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8 9## 导入模块 10 11```ts 12import formInfo from '@ohos.app.form.formInfo'; 13``` 14 15## FormInfo 16 17卡片信息 18 19**系统能力**：SystemCapability.Ability.Form 20 21| 名称 | 类型 | 可读 | 可写 | 说明 | 22| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 23| bundleName | string | 是 | 否 | 卡片所属包的Bundle名称。 | 24| moduleName | string | 是 | 否 | 卡片所属模块的模块名称。 | 25| abilityName | string | 是 | 否 | 卡片所属的Ability名称。 | 26| name | string | 是 | 否 | 应用/元服务名称。 | 27| displayName<sup>11+</sup> | string | 是 | 否 | 卡片名称。 | 28| description | string | 是 | 否 | 卡片描述。 | 29| descriptionId<sup>10+</sup> | number | 是 | 否 | 卡片描述id。 | 30| type | [FormType](#formtype) | 是 | 否 | 卡片类型。当前支持JS卡片、ArkTS卡片。 | 31| jsComponentName | string | 是 | 否 | js卡片的组件名。 | 32| colorMode | [ColorMode](#colormode) | 是 | 否 | 卡片颜色模式。 | 33| isDefault | boolean | 是 | 否 | 卡片是否是默认卡片。 | 34| updateEnabled | boolean | 是 | 否 | 卡片是否使能更新。 | 35| formVisibleNotify | boolean | 是 | 否 | 卡片是否使能可见通知。 | 36| scheduledUpdateTime | string | 是 | 否 | 卡片更新时间。 | 37| formConfigAbility | string | 是 | 否 | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 | 38| updateDuration | number | 是 | 否 | 卡片更新周期。 | 39| defaultDimension | number | 是 | 否 | 表示卡片规格 | 40| supportDimensions | Array<number> | 是 | 否 | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) | 41| customizeData | Record\<string, string> | 是 | 否 | 卡片用户数据。 | 42| isDynamic<sup>10+</sup> | boolean | 是 | 否 | 卡片是否为动态卡片。<br/>仅ArkTS卡片区分动静态卡片，JS卡片均为动态卡片。 | 43| transparencyEnabled<sup>11+</sup> | boolean | 是 | 否 | 卡片是否支持设置背景透明度。<br/>ArkTS卡片由用户配置决定是否支持，JS卡片均不支持。 | 44 45## FormType 46 47支持的卡片类型枚举。 48 49**系统能力**：SystemCapability.Ability.Form 50 51| 名称 | 值 | 说明 | 52| ----------- | ---- | ------------ | 53| JS | 1 | 卡片类型为JS。 | 54| eTS | 2 | 卡片类型为ArkTS。 | 55 56## ColorMode 57 58卡片支持的颜色模式枚举。 59 60**系统能力**：SystemCapability.Ability.Form 61 62| 名称 | 值 | 说明 | 63| ----------- | ---- | ------------ | 64| MODE_AUTO | -1 | 表示自动模式。 | 65| MODE_DARK | 0 | 表示暗色。 | 66| MODE_LIGHT | 1 | 表示亮色。 | 67 68## FormStateInfo 69 70卡片状态信息。 71 72**系统能力**：SystemCapability.Ability.Form 73 74| 名称 | 类型 | 可读 | 可写 | 说明 | 75| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 76| formState | [FormState](#formstate) | 是 | 否 | 卡片状态。 | 77| want | [Want](js-apis-app-ability-want.md) | 是 | 否 | Want文本内容。 | 78 79## FormState 80 81卡片状态枚举。 82 83**系统能力**：SystemCapability.Ability.Form 84 85| 名称 | 值 | 说明 | 86| ----------- | ---- | ------------ | 87| UNKNOWN | -1 | 表示未知状态。 | 88| DEFAULT | 0 | 表示默认状态。 | 89| READY | 1 | 表示就绪状态。 | 90 91## FormParam 92 93卡片参数枚举。 94 95**系统能力**：SystemCapability.Ability.Form 96 97| 名称 | 值 | 说明 | 98| ----------- | ---- | ------------ | 99| IDENTITY_KEY | 'ohos.extra.param.key.form_identity' | 卡片标识。 | 100| DIMENSION_KEY | 'ohos.extra.param.key.form_dimension' | 卡片规格样式。 | 101| NAME_KEY | 'ohos.extra.param.key.form_name' | 卡片名称。 | 102| MODULE_NAME_KEY | 'ohos.extra.param.key.module_name' | 卡片所属模块名称。 | 103| WIDTH_KEY | 'ohos.extra.param.key.form_width' | 卡片宽度。 | 104| HEIGHT_KEY | 'ohos.extra.param.key.form_height' | 卡片高度。 | 105| TEMPORARY_KEY | 'ohos.extra.param.key.form_temporary' | 临时卡片。 | 106| ABILITY_NAME_KEY | 'ohos.extra.param.key.ability_name' | ability名称。 | 107| BUNDLE_NAME_KEY | 'ohos.extra.param.key.bundle_name' | 指示指定要获取的捆绑Bundle名称的键。 | 108| LAUNCH_REASON_KEY<sup>10+</sup> | 'ohos.extra.param.key.form_launch_reason' | 卡片创建原因。 | 109| PARAM_FORM_CUSTOMIZE_KEY<sup>10+</sup> | 'ohos.extra.param.key.form_customize' | 自定义数据。 | 110 111## FormDimension 112 113定义卡片尺寸枚举。 114 115**系统能力**：SystemCapability.Ability.Form 116 117| 名称 | 值 | 说明 | 118| ----------- | ---- | ------------ | 119| Dimension_1_2 | 1 | 1 x 2 form。 | 120| Dimension_2_2 | 2 | 2 x 2 form。 | 121| Dimension_2_4 | 3 | 2 x 4 form。 | 122| Dimension_4_4 | 4 | 4 x 4 form。 | 123| Dimension_2_1 | 5 | 2 x 1 form。 | 124| DIMENSION_1_1 | 6 | 1 x 1 form。 | 125 126 127## FormInfoFilter 128 129卡片信息过滤器，仅将符合过滤器内要求的卡片信息返回。 130 131**系统能力**：SystemCapability.Ability.Form 132 133| 名称 | 类型 | 必填 |说明 | 134| ----------- | ---- | ------------ |------------ | 135| moduleName | string |否 | 选填。仅保留moduleName与提供值相符的卡片信息。<br>未填写时则不通过moduleName进行过滤。 | 136 137## VisibilityType 138 139卡片当前可见类型枚举。 140 141**系统能力**：SystemCapability.Ability.Form 142 143| 名称 | 值 | 说明 | 144| ----------- | ---- | ------------ | 145| UNKNOWN<sup>10+</sup> | 0 | 表示卡片为未知。 | 146| FORM_VISIBLE | 1 | 表示卡片为可见。 | 147| FORM_INVISIBLE | 2 | 表示卡片为不可见。 | 148 149## LaunchReason<sup>10+</sup> 150 151卡片创建原因枚举。 152 153**系统能力**：SystemCapability.Ability.Form 154 155| 名称 | 值 | 说明 | 156| ----------- | ---- | ------------ | 157| FORM_DEFAULT | 1 | 表示卡片创建原因为默认创建。 | 158| FORM_SHARE | 2 | 表示卡片创建原因为共享创建。 | 159