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