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