@ohos.application.formInfo (formInfo)

formInfo模块提供了卡片信息和状态等相关类型和枚举。

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 从API version 9 开始不再维护，建议使用formInfo替代。

导入模块

import formInfo from '@ohos.application.formInfo';

FormInfo

卡片信息

系统能力：SystemCapability.Ability.Form

名称 类型 可读 可写 说明
bundleName string 是 否 表示卡片所属包的Bundle名称。
moduleName string 是 否 表示卡片所属模块的模块名。
abilityName string 是 否 表示卡片所属的Ability名称。
name string 是 否 表示卡片名称。
description string 是 否 表示卡片描述。
type FormType 是 否 表示卡片类型，当前支持JS卡片。
jsComponentName string 是 否 表示js卡片的组件名。
colorMode ColorMode 是 否 表示卡片颜色模式。
isDefault boolean 是 否 表示是否是默认卡片。
updateEnabled boolean 是 否 表示卡片是否使能更新。
formVisibleNotify boolean 是 否 表示卡片是否使能可见通知。
relatedBundleName string 是 否 表示卡片所属的相关联Bundle名称。
scheduledUpdateTime string 是 否 表示卡片更新时间。
formConfigAbility string 是 否 表示卡片配置ability。
updateDuration number 是 否 表示卡片更新周期。
defaultDimension number 是 否 表示卡片规格
supportDimensions Array<number> 是 否 表示卡片支持的规格。
customizeData {[key: string]: [value: string]} 是 否 表示卡片用户数据。

FormType

支持的卡片类型枚举。

系统能力：SystemCapability.Ability.Form

名称 值 说明
JS 1 卡片类型为JS。

ColorMode

卡片支持的颜色模式枚举。

系统能力：SystemCapability.Ability.Form

名称 值 说明
MODE_AUTO -1 表示自动模式。
MODE_DARK 0 表示暗色。
MODE_LIGHT 1 表示亮色。

FormStateInfo

卡片状态信息。

系统能力：SystemCapability.Ability.Form

名称 类型 可读 可写 说明
formState FormState 是 否 表示卡片状态。
want Want 是 否 Want文本内容。

FormState

卡片状态枚举。

系统能力：SystemCapability.Ability.Form

名称 值 说明
UNKNOWN -1 表示未知状态。
DEFAULT 0 表示默认状态。
READY 1 表示就绪状态。

FormParam

卡片参数枚举。

系统能力：SystemCapability.Ability.Form

名称 值 说明
IDENTITY_KEY 'ohos.extra.param.key.form_identity' 卡片标识。
系统接口: 此接口为系统接口。
DIMENSION_KEY 'ohos.extra.param.key.form_dimension' 卡片规格样式。
NAME_KEY 'ohos.extra.param.key.form_name' 卡片名称。
MODULE_NAME_KEY 'ohos.extra.param.key.module_name' 卡片所属模块名称。
WIDTH_KEY 'ohos.extra.param.key.form_width' 卡片宽度。
HEIGHT_KEY 'ohos.extra.param.key.form_height' 卡片高度。
TEMPORARY_KEY 'ohos.extra.param.key.form_temporary' 临时卡片。