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 | 是 | 否 | 卡片所属包的Bundle名称。 | 24| moduleName | string | 是 | 否 | 卡片所属模块的模块名称。 | 25| abilityName | string | 是 | 否 | 卡片所属的Ability名称。 | 26| name | string | 是 | 否 | 卡片名称。 | 27| description | string | 是 | 否 | 卡片描述。 | 28| descriptionId<sup>10+</sup> | number | 是 | 否 | 卡片描述id。 | 29| type | [FormType](#formtype) | 是 | 否 | 卡片类型。当前支持JS卡片、ArkTS卡片。 | 30| jsComponentName | string | 是 | 否 | js卡片的组件名。 | 31| colorMode | [ColorMode](#colormode) | 是 | 否 | 卡片颜色模式。 | 32| isDefault | boolean | 是 | 否 | 卡片是否是默认卡片。 | 33| updateEnabled | boolean | 是 | 否 | 卡片是否使能更新。 | 34| formVisibleNotify | boolean | 是 | 否 | 卡片是否使能可见通知。 | 35| scheduledUpdateTime | string | 是 | 否 | 卡片更新时间。 | 36| formConfigAbility | string | 是 | 否 | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 | 37| updateDuration | number | 是 | 否 | 卡片更新周期。 | 38| defaultDimension | number | 是 | 否 | 表示卡片规格 | 39| supportDimensions | Array<number> | 是 | 否 | 卡片支持的规格。具体可选规格参考[FormDimension](#formdimension) | 40| customizeData | {[key: string]: [value: string]} | 是 | 否 | 卡片用户数据。 | 41| isDynamic<sup>10+</sup> | boolean | 是 | 否 | 卡片是否为动态卡片。<br/>仅ArkTS卡片区分动静态卡片，JS卡片均为动态卡片。 | 42 43## FormType 44 45支持的卡片类型枚举。 46 47**系统能力**：SystemCapability.Ability.Form 48 49| 名称 | 值 | 说明 | 50| ----------- | ---- | ------------ | 51| JS | 1 | 卡片类型为JS。 | 52| eTS | 2 | 卡片类型为ArkTS。 | 53 54## ColorMode 55 56卡片支持的颜色模式枚举。 57 58**系统能力**：SystemCapability.Ability.Form 59 60| 名称 | 值 | 说明 | 61| ----------- | ---- | ------------ | 62| MODE_AUTO | -1 | 表示自动模式。 | 63| MODE_DARK | 0 | 表示暗色。 | 64| MODE_LIGHT | 1 | 表示亮色。 | 65 66## FormStateInfo 67 68卡片状态信息。 69 70**系统能力**：SystemCapability.Ability.Form 71 72| 名称 | 类型 | 可读 | 可写 | 说明 | 73| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 74| formState | [FormState](#formstate) | 是 | 否 | 卡片状态。 | 75| want | [Want](js-apis-app-ability-want.md) | 是 | 否 | Want文本内容。 | 76 77## FormState 78 79卡片状态枚举。 80 81**系统能力**：SystemCapability.Ability.Form 82 83| 名称 | 值 | 说明 | 84| ----------- | ---- | ------------ | 85| UNKNOWN | -1 | 表示未知状态。 | 86| DEFAULT | 0 | 表示默认状态。 | 87| READY | 1 | 表示就绪状态。 | 88 89## FormParam 90 91卡片参数枚举。 92 93**系统能力**：SystemCapability.Ability.Form 94 95| 名称 | 值 | 说明 | 96| ----------- | ---- | ------------ | 97| IDENTITY_KEY | 'ohos.extra.param.key.form_identity' | 卡片标识。 | 98| DIMENSION_KEY | 'ohos.extra.param.key.form_dimension' | 卡片规格样式。 | 99| NAME_KEY | 'ohos.extra.param.key.form_name' | 卡片名称。 | 100| MODULE_NAME_KEY | 'ohos.extra.param.key.module_name' | 卡片所属模块名称。 | 101| WIDTH_KEY | 'ohos.extra.param.key.form_width' | 卡片宽度。 | 102| HEIGHT_KEY | 'ohos.extra.param.key.form_height' | 卡片高度。 | 103| TEMPORARY_KEY | 'ohos.extra.param.key.form_temporary' | 临时卡片。 | 104| ABILITY_NAME_KEY | 'ohos.extra.param.key.ability_name' | ability名称。 | 105| DEVICE_ID_KEY | 'ohos.extra.param.key.device_id' | 设备标识。 <br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | 106| BUNDLE_NAME_KEY | 'ohos.extra.param.key.bundle_name' | 指示指定要获取的捆绑Bundle名称的键。 | 107| LAUNCH_REASON_KEY<sup>10+</sup> | 'ohos.extra.param.key.form_launch_reason' | 卡片创建原因。 | 108| PARAM_FORM_CUSTOMIZE_KEY<sup>10+</sup> | 'ohos.extra.param.key.form_customize' | 自定义数据。 | 109 110## FormDimension 111 112定义卡片尺寸枚举。 113 114**系统能力**：SystemCapability.Ability.Form 115 116| 名称 | 值 | 说明 | 117| ----------- | ---- | ------------ | 118| Dimension_1_2 | 1 | 1 x 2 form。 | 119| Dimension_2_2 | 2 | 2 x 2 form。 | 120| Dimension_2_4 | 3 | 2 x 4 form。 | 121| Dimension_4_4 | 4 | 4 x 4 form。 | 122| Dimension_2_1 | 5 | 2 x 1 form。 | 123 124 125## FormInfoFilter 126 127卡片信息过滤器，仅将符合过滤器内要求的卡片信息返回。 128 129**系统能力**：SystemCapability.Ability.Form 130 131| 名称 | 类型 | 必填 |说明 | 132| ----------- | ---- | ------------ |------------ | 133| moduleName | string |否 | 选填。仅保留moduleName与提供值相符的卡片信息。<br>未填写时则不通过moduleName进行过滤。 | 134 135## VisibilityType 136 137卡片当前可见类型枚举。 138 139**系统能力**：SystemCapability.Ability.Form 140 141| 名称 | 值 | 说明 | 142| ----------- | ---- | ------------ | 143| UNKNOWN<sup>10+</sup> | 0 | 表示卡片为未知。 | 144| FORM_VISIBLE | 1 | 表示卡片为可见。 | 145| FORM_INVISIBLE | 2 | 表示卡片为不可见。 | 146 147## RunningFormInfo<sup>10+</sup> 148 149卡片使用方信息 150 151**系统能力**：SystemCapability.Ability.Form 152 153**系统API**: 此接口为系统接口，三方应用不支持调用。 154 155| 名称 | 类型 | 可读 | 可写 | 说明 | 156| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 157| formId | string | 是 | 否 | 卡片标识。 | 158| bundleName<sup>10+</sup> | string | 是 | 否 | 提供方卡片所属包的Bundle名称。 | 159| hostBundleName | string | 是 | 否 | 使用方卡片所属包的Bundle名称。 | 160| visibilityType | [VisibilityType](#visibilitytype) | 是 | 否 | 卡片当前可见类型枚举。 | 161| moduleName<sup>10+</sup> | string | 是 | 否 | 卡片所属模块的模块名称。 | 162| abilityName<sup>10+</sup> | string | 是 | 否 | 卡片所属的Ability名称。 | 163| formName<sup>10+</sup> | string | 是 | 否 | 卡片名称。 | 164| dimension | number | 是 | 否 | 卡片规格。 | 165 166## formProviderFilter<sup>10+</sup> 167 168卡片提供方信息 169 170**系统能力**：SystemCapability.Ability.Form 171 172**系统API**: 此接口为系统接口，三方应用不支持调用。 173 174| 名称 | 类型 | 可读 | 可写 | 说明 | 175| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | 176| bundleName | string | 是 | 否 | 提供方卡片所属包的Bundle名称。<br>**模型约束：** 此接口仅可在Stage模型下使用。<br> | 177| formName | string | 是 | 否 | 卡片名称。<br>**模型约束：** 此接口仅可在Stage模型下使用。<br> | 178| moduleName | string | 是 | 否 | 卡片所属模块的模块名称。<br>**模型约束：** 此接口仅可在Stage模型下使用。<br> | 179| abilityName | string | 是 | 否 | 卡片所属的Ability名称。<br>**模型约束：** 此接口仅可在Stage模型下使用。<br> | 180 181## LaunchReason<sup>10+</sup> 182 183卡片创建原因枚举。 184 185**系统能力**：SystemCapability.Ability.Form 186 187| 名称 | 值 | 说明 | 188| ----------- | ---- | ------------ | 189| FORM_DEFAULT | 1 | 表示卡片创建原因为默认创建。 | 190| FORM_SHARE | 2 | 表示卡片创建原因为共享创建。 | 191