1# @ohos.application.formInfo (formInfo) 2<!--Kit: Form Kit--> 3<!--Subsystem: Ability--> 4<!--Owner: @cx983299475--> 5<!--Designer: @xueyulong--> 6<!--Tester: @chenmingze--> 7<!--Adviser: @Brilliantry_Rui--> 8formInfo模块提供了卡片信息和状态等相关类型和枚举。 9 10> **说明：** 11> 12> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 13> 从API version 9 开始不再维护，建议使用[formInfo](js-apis-app-form-formInfo.md)替代。 14 15## 导入模块 16 17```ts 18import formInfo from '@ohos.application.formInfo'; 19``` 20 21## FormInfo 22 23卡片信息。 24 25**系统能力：** SystemCapability.Ability.Form 26 27| 名称 | 类型 | 可读 | 可写 | 说明 | 28| ----------- | -------- |-------- | -------------------- | ------------------------------------------------------------ | 29| bundleName | string | 是 | 否 | 表示卡片所属包的Bundle名称。 | 30| moduleName | string | 是 | 否 | 表示卡片所属模块的模块名。 | 31| abilityName | string | 是 | 否 | 表示卡片所属的Ability名称。 | 32| name | string | 是 | 否 | 表示卡片名称。 | 33| description | string | 是 | 否 | 表示卡片描述。 | 34| type | [FormType](#formtype) | 是 | 否 | 表示卡片类型，当前支持JS卡片。 | 35| jsComponentName | string | 是 | 否 | 表示JS卡片的组件名。 | 36| colorMode | [ColorMode](#colormode) | 是 | 否 | 表示卡片颜色模式。 | 37| isDefault | boolean | 是 | 否 | 表示是否是默认卡片。 | 38| updateEnabled | boolean | 是 | 否 | 表示卡片是否使能更新。 | 39| formVisibleNotify | boolean | 是 | 否 | 表示卡片是否使能可见通知。 | 40| relatedBundleName | string | 是 | 否 | 表示卡片所属的相关联Bundle名称。 | 41| scheduledUpdateTime | string | 是 | 否 | 表示卡片更新时间。 | 42| formConfigAbility | string | 是 | 否 | 表示卡片配置ability。 | 43| updateDuration | number | 是 | 否 | 表示卡片更新周期。 | 44| defaultDimension | number | 是 | 否 | 表示卡片规格。 | 45| supportDimensions | Array<number> | 是 | 否 | 表示卡片支持的规格。 | 46| customizeData | {[key: string]: [value: string]} | 是 | 否 | 表示卡片用户数据。 | 47 48## FormType 49 50支持的卡片类型枚举。 51 52**系统能力：** SystemCapability.Ability.Form 53 54| 名称 | 值 | 说明 | 55| ----------- | ---- | ------------ | 56| JS | 1 | 卡片类型为JS。 | 57 58## ColorMode 59 60卡片支持的颜色模式枚举。 61 62**系统能力：** SystemCapability.Ability.Form 63 64| 名称 | 值 | 说明 | 65| ----------- | ---- | ------------ | 66| MODE_AUTO | -1 | 表示自动模式。 | 67| MODE_DARK | 0 | 表示暗色。 | 68| MODE_LIGHT | 1 | 表示亮色。 | 69 70## FormStateInfo 71 72卡片状态信息。 73 74**系统能力：** SystemCapability.Ability.Form 75 76| 名称 | 类型 | 可读 | 可写 | 说明 | 77| ----------- | -------- |-------- | -------------------- | ------------------------------------------------------------ | 78| formState | [FormState](#formstate) | 是 | 否 | 表示卡片状态。 | 79| want | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | 是 | 否 | Want文本内容。 | 80 81## FormState 82 83卡片状态枚举。 84 85**系统能力：** SystemCapability.Ability.Form 86 87| 名称 | 值 | 说明 | 88| ----------- | ---- | ------------ | 89| UNKNOWN | -1 | 表示未知状态。 | 90| DEFAULT | 0 | 表示默认状态。 | 91| READY | 1 | 表示就绪状态。 | 92 93## FormParam 94 95卡片参数枚举。 96 97**系统能力：** SystemCapability.Ability.Form 98 99| 名称 | 值 | 说明 | 100| ----------- | ---- | ------------ | 101| DIMENSION_KEY | 'ohos.extra.param.key.form_dimension' | 卡片规格样式。 | 102| NAME_KEY | 'ohos.extra.param.key.form_name' | 卡片名称。 | 103| MODULE_NAME_KEY | 'ohos.extra.param.key.module_name' | 卡片所属模块名称。 | 104| WIDTH_KEY | 'ohos.extra.param.key.form_width' | 卡片宽度。 | 105| HEIGHT_KEY | 'ohos.extra.param.key.form_height' | 卡片高度。 | 106| TEMPORARY_KEY | 'ohos.extra.param.key.form_temporary' | 临时卡片。 | 107 108