1# @ohos.app.form.formInfo (formInfo) 2 3formInfo模块提供了卡片信息和状态等相关类型和枚举。 4 5> **说明：** 6> 7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8 9## 导入模块 10 11```ts 12import { formInfo } from '@kit.FormKit'; 13``` 14 15## FormInfo 16 17卡片配置信息。 18 19**系统能力：** SystemCapability.Ability.Form 20 21| 名称 | 类型 | 可读 | 可写 | 说明 | 22| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 23| bundleName | string | 是 | 否 | 卡片所属包的Bundle名称。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 24| moduleName | string | 是 | 否 | 卡片所属模块的模块名称。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 25| abilityName | string | 是 | 否 | 卡片所属的Ability名称。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 26| name | string | 是 | 否 | 应用/原子化服务名称。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 27| displayName<sup>11+</sup> | string | 是 | 否 | 卡片名称。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 28| displayNameId<sup>11+</sup> | number | 是 | 否 | 卡片预览时标识卡片名称的ID。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 29| description | string | 是 | 否 | 卡片描述。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 30| descriptionId<sup>10+</sup> | number | 是 | 否 | 卡片描述id。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 31| type | [FormType](#formtype) | 是 | 否 | 卡片类型。当前支持JS卡片、ArkTS卡片。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 32| jsComponentName | string | 是 | 否 | js卡片的组件名。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 33| colorMode | [ColorMode](#colormode) | 是 | 否 | 卡片颜色模式。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 34| isDefault | boolean | 是 | 否 | 卡片是否是默认卡片。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 35| updateEnabled | boolean | 是 | 否 | 卡片是否使能更新。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 36| formVisibleNotify | boolean | 是 | 否 | 卡片是否使能可见通知。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 37| scheduledUpdateTime | string | 是 | 否 | 卡片更新时间。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 38| formConfigAbility | string | 是 | 否 | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 39| updateDuration | number | 是 | 否 | 卡片更新周期。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 40| defaultDimension | number | 是 | 否 | 卡片规格 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 41| supportDimensions | Array<number> | 是 | 否 | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 42| customizeData | Record\<string, string> | 是 | 否 | 卡片用户数据。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 43| isDynamic<sup>10+</sup> | boolean | 是 | 否 | 卡片是否为动态卡片。<br/>仅ArkTS卡片区分动静态卡片，JS卡片均为动态卡片。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 44| transparencyEnabled<sup>11+</sup> | boolean | 是 | 否 | 卡片是否支持设置背景透明度。<br/>ArkTS卡片由用户配置决定是否支持，JS卡片均不支持。 <br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 45| supportedShapes<sup>12+</sup> | Array<number> | 是 | 否 | 卡片支持的形状。具体可选形状参考[FormShape<sup>12+</sup>](#formshape12) <br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 46 47## FormType 48 49支持的卡片类型枚举。 50 51**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 52 53**系统能力：** SystemCapability.Ability.Form 54 55| 名称 | 值 | 说明 | 56| ----------- | ---- | ------------ | 57| JS | 1 | 卡片类型为JS。 | 58| eTS | 2 | 卡片类型为ArkTS。 | 59 60## ColorMode 61 62卡片支持的颜色模式枚举。 63 64**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 65 66**系统能力：** SystemCapability.Ability.Form 67 68| 名称 | 值 | 说明 | 69| ----------- | ---- | ------------ | 70| MODE_AUTO | -1 | 表示自动模式。 | 71| MODE_DARK | 0 | 表示暗色。 | 72| MODE_LIGHT | 1 | 表示亮色。 | 73 74## FormStateInfo 75 76卡片状态信息。 77 78**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 79 80**系统能力：** SystemCapability.Ability.Form 81 82| 名称 | 类型 | 可读 | 可写 | 说明 | 83| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 84| formState | [FormState](#formstate) | 是 | 否 | 卡片状态。 | 85| want | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | 是 | 否 | Want文本内容。 | 86 87## FormState 88 89卡片状态枚举。 90 91**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 92 93**系统能力：** SystemCapability.Ability.Form 94 95| 名称 | 值 | 说明 | 96| ----------- | ---- | ------------ | 97| UNKNOWN | -1 | 表示未知状态。 | 98| DEFAULT | 0 | 表示默认状态。 | 99| READY | 1 | 表示就绪状态。 | 100 101## FormParam 102 103卡片参数枚举。 104 105**系统能力：** SystemCapability.Ability.Form 106 107| 名称 | 值 | 说明 | 108| ----------- | ---- | ------------ | 109| IDENTITY_KEY | 'ohos.extra.param.key.form_identity' | 卡片标识。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 110| DIMENSION_KEY | 'ohos.extra.param.key.form_dimension' | 卡片规格样式。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 111| NAME_KEY | 'ohos.extra.param.key.form_name' | 卡片名称。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 112| MODULE_NAME_KEY | 'ohos.extra.param.key.module_name' | 卡片所属模块名称。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 113| WIDTH_KEY | 'ohos.extra.param.key.form_width' | 卡片宽度。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 114| HEIGHT_KEY | 'ohos.extra.param.key.form_height' | 卡片高度。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 115| TEMPORARY_KEY | 'ohos.extra.param.key.form_temporary' | 临时卡片。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 116| ABILITY_NAME_KEY | 'ohos.extra.param.key.ability_name' | ability名称。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 117| BUNDLE_NAME_KEY | 'ohos.extra.param.key.bundle_name' | Bundle名称。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 118| LAUNCH_REASON_KEY<sup>10+</sup> | 'ohos.extra.param.key.form_launch_reason' | 卡片创建原因。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 119| PARAM_FORM_CUSTOMIZE_KEY<sup>10+</sup> | 'ohos.extra.param.key.form_customize' | 自定义数据。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 120| FORM_RENDERING_MODE_KEY<sup>11+</sup> | 'ohos.extra.param.key.form_rendering_mode' | 卡片渲染模式。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 121| HOST_BG_INVERSE_COLOR_KEY<sup>12+</sup> | 'ohos.extra.param.key.host_bg_inverse_color' | 卡片使用方的背景反色颜色值。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 122| FORM_LOCATION_KEY<sup>12+</sup> | 'ohos.extra.param.key.form_location' | 卡片位置。 <br>OTHER -1 (其他位置) <br>DESKTOP 0 (桌面) <br>FORM_CENTER 1 (桌面的卡片中心) <br>FORM_MANAGER 2 (桌面的卡片管理器) <br>NEGATIVE_SCREEN 3 (负一屏) <br>FORM_CENTER_NEGATIVE_SCREEN 4 (负一屏的服务中心) <br>FORM_MANAGER_NEGATIVE_SCREEN 5 (负一屏的卡片管理器) <br>SCREEN_LOCK 6 (锁屏) <br>AI_SUGGESTION 7 (小艺建议推荐区) 123| FORM_PERMISSION_NAME_KEY<sup>12+</sup> | 'ohos.extra.param.key.permission_name' | 用户授权权限名称。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 124| FORM_PERMISSION_GRANTED_KEY<sup>12+</sup> | 'ohos.extra.param.key.permission_granted' | 用户是否授权。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 125 126## FormDimension 127 128定义卡片尺寸枚举。 129 130**系统能力：** SystemCapability.Ability.Form 131 132| 名称 | 值 | 说明 | 133| ----------- | ---- | ------------ | 134| Dimension_1_2 | 1 | 1 x 2 form。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 135| Dimension_2_2 | 2 | 2 x 2 form。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 136| Dimension_2_4 | 3 | 2 x 4 form。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 137| Dimension_4_4 | 4 | 4 x 4 form。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 138| Dimension_2_1 | 5 | 2 x 1 form。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 139| DIMENSION_1_1<sup>11+<sup> | 6 | 1 x 1 form。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 140| DIMENSION_6_4<sup>12+<sup> | 7 | 6 x 4 form。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 141 142## FormShape<sup>12+</sup> 143 144定义卡片形状枚举。 145 146**系统能力：** SystemCapability.Ability.Form 147 148| 名称 | 值 | 说明 | 149| ----------- | ---- | ------------ | 150| RECT | 1 | 方形 form。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 151| CIRCLE | 2 | 圆形 form。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 152 153## FormInfoFilter 154 155卡片信息过滤器，仅将符合过滤器内要求的卡片信息返回。 156 157**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 158 159**系统能力：** SystemCapability.Ability.Form 160 161| 名称 | 类型 | 必填 |说明 | 162| ----------- | ---- | ------------ |------------ | 163| moduleName | string |否 | 选填，仅保留含moduleName与提供值相符的卡片信息，<br>未填写时则不通过moduleName进行过滤。 | 164 165 166 167## VisibilityType 168 169卡片当前可见类型枚举。 170 171**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 172 173**系统能力：** SystemCapability.Ability.Form 174 175| 名称 | 值 | 说明 | 176| ----------- | ---- | ------------ | 177| UNKNOWN<sup>10+</sup> | 0 | 表示卡片为未知。 | 178| FORM_VISIBLE | 1 | 表示卡片为可见。 | 179| FORM_INVISIBLE | 2 | 表示卡片为不可见。 | 180 181 182## LaunchReason<sup>10+</sup> 183 184卡片创建原因枚举。 185 186**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 187 188**系统能力：** SystemCapability.Ability.Form 189 190| 名称 | 值 | 说明 | 191| ----------- | ---- | ------------ | 192| FORM_DEFAULT | 1 | 表示卡片创建原因为默认创建。 | 193| FORM_SHARE | 2 | 表示卡片创建原因为共享创建。 | 194