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