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**系统API**: 此接口为系统接口，三方应用不支持调用。 22 23| 名称 | 类型 | 可读 | 可写 | 说明 | 24| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 25| bundleName | string | 是 | 否 | 卡片所属包的包名。 | 26| moduleName | string | 是 | 否 | 卡片所属模块的模块名。 | 27| abilityName | string | 是 | 否 | 卡片所属的Ability名称。 | 28| name | string | 是 | 否 | 卡片名称。 | 29| description | string | 是 | 否 | 卡片描述。 | 30| type | [FormType](#formtype) | 是 | 否 | 卡片类型。当前支持JS卡片。 | 31| jsComponentName | string | 是 | 否 | js卡片的组件名。 | 32| colorMode | [ColorMode](#colormode) | 是 | 否 | 卡片颜色模式。 | 33| isDefault | boolean | 是 | 否 | 卡片是否是默认卡片。 | 34| updateEnabled | boolean | 是 | 否 | 卡片是否使能更新。 | 35| formVisibleNotify | string | 是 | 否 | 卡片是否使能可见通知。 | 36| scheduledUpdateTime | string | 是 | 否 | 卡片更新时间。 | 37| formConfigAbility | string | 是 | 否 | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 | 38| updateDuration | string | 是 | 否 | 卡片更新周期。 | 39| defaultDimension | number | 是 | 否 | 表示卡片规格 | 40| supportDimensions | Array<number> | 是 | 否 | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) | 41| customizeData | {[key: string]: [value: string]} | 是 | 否 | 卡片用户数据。 | 42 43## FormType 44 45支持的卡片类型枚举。 46 47**系统能力**：SystemCapability.Ability.Form 48 49| 名称 | 值 | 说明 | 50| ----------- | ---- | ------------ | 51| JS | 1 | 卡片类型为JS。 | 52| eTS | 2 | 卡片类型为ArkTS。 | 53 54## ColorMode 55 56卡片支持的颜色模式枚举。 57 58**系统能力**：SystemCapability.Ability.Form 59 60| 名称 | 值 | 说明 | 61| ----------- | ---- | ------------ | 62| MODE_AUTO | -1 | 表示自动模式。 | 63| MODE_DARK | 0 | 表示暗色。 | 64| MODE_LIGHT | 1 | 表示亮色。 | 65 66## FormStateInfo 67 68卡片状态信息。 69 70**系统能力**：SystemCapability.Ability.Form 71 72| 名称 | 类型 | 可读 | 可写 | 说明 | 73| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 74| formState | [FormState](#formstate) | 是 | 否 | 卡片状态。 | 75| want | Want | 是 | 否 | Want文本内容。 | 76 77## FormState 78 79卡片状态枚举。 80 81**系统能力**：SystemCapability.Ability.Form 82 83| 名称 | 值 | 说明 | 84| ----------- | ---- | ------------ | 85| UNKNOWN | -1 | 表示未知状态。 | 86| DEFAULT | 0 | 表示默认状态。 | 87| READY | 1 | 表示就绪状态。 | 88 89## FormParam 90 91卡片参数枚举。 92 93**系统能力**：SystemCapability.Ability.Form 94 95| 名称 | 值 | 说明 | 96| ----------- | ---- | ------------ | 97| IDENTITY_KEY | "ohos.extra.param.key.form_identity" | 卡片标识。 | 98| DIMENSION_KEY | "ohos.extra.param.key.form_dimension" | 卡片规格样式。 | 99| NAME_KEY | "ohos.extra.param.key.form_name" | 卡片名称。 | 100| MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | 卡片所属模块名称。 | 101| WIDTH_KEY | "ohos.extra.param.key.form_width" | 卡片宽度。 | 102| HEIGHT_KEY | "ohos.extra.param.key.form_height" | 卡片高度。 | 103| TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 | 104| ABILITY_NAME_KEY | "ohos.extra.param.key.ability_name" | ability名称 | 105| DEVICE_ID_KEY | "ohos.extra.param.key.device_id" | 设备标识。<br/>**系统接口**: 此接口为系统接口。 | 106| BUNDLE_NAME_KEY | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。| 107 108## FormDimension 109 110定义卡片尺寸枚举。 111 112**系统能力**：SystemCapability.Ability.Form 113 114| 名称 | 值 | 说明 | 115| ----------- | ---- | ------------ | 116| Dimension_1_2 | 1 | 1 x 2 form。 | 117| Dimension_2_2 | 2 | 2 x 2 form。 | 118| Dimension_2_4 | 3 | 2 x 4 form。 | 119| Dimension_4_4 | 4 | 4 x 4 form。 | 120| Dimension_2_1 | 5 | 2 x 1 form。 | 121 122 123## FormInfoFilter 124 125卡片信息过滤器，仅将符合过滤器内要求的卡片信息返回。 126 127**系统能力**：SystemCapability.Ability.Form 128 129| 名称 | 说明 | 130| ----------- | ------------ | 131| moduleName | 仅保留moduleName与提供值相符的卡片信息。 | 132 133## VisibilityType 134 135卡片当前可见类型枚举。 136 137**系统能力**：SystemCapability.Ability.Form 138 139| 名称 | 值 | 说明 | 140| ----------- | ---- | ------------ | 141| UNKNOWN | 0 | 表示卡片为未知。 | 142| FORM_VISIBLE | 1 | 表示卡片为可见。 | 143| FORM_INVISIBLE | 2 | 表示卡片为不可见。 |