@ohos.application.formInfo (FormInfo)


@ohos.application.formInfo (FormInfo)

FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询的能力。

说明:

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

导入模块

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

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 string 表示卡片是否使能可见通知。
relatedBundleName string 表示卡片所属的相关联Bundle名称。
scheduledUpdateTime string 表示卡片更新时间。
formConfigAbility string 表示卡片配置ability。
updateDuration string 表示卡片更新周期。
defaultDimension number 表示卡片规格
supportDimensions Array<number> 表示卡片支持的规格。
customizeData {[key: string]: [value: string]} 表示卡片用户数据。

FormType

支持的卡片类型枚举。

系统能力:SystemCapability.Ability.Form

名称 说明
JS 1 卡片类型为JS。
eTS9+ 2 卡片类型为eTS。

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_KEY9+ "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" 临时卡片。
ABILITY_NAME_KEY9+ "ohos.extra.param.key.ability_name" ability名称
DEVICE_ID_KEY9+ "ohos.extra.param.key.device_id" 设备标识。
系统接口: 此接口为系统接口。
BUNDLE_NAME_KEY9+ "ohos.extra.param.key.bundle_name" 指示指定要获取的捆绑包名称的键。

FormDimension9+

定义卡片尺寸枚举。

系统能力:SystemCapability.Ability.Form

名称 说明
Dimension_1_2 9+ 1 1 x 2 form。
Dimension_2_2 9+ 2 2 x 2 form。
Dimension_2_4 9+ 3 2 x 4 form。
Dimension_4_4 9+ 4 4 x 4 form。
Dimension_2_1 9+ 5 2 x 1 form。

VisibilityType

卡片可见性。

系统能力:SystemCapability.Ability.Form

名称 说明
FORM_VISIBLE9+ 1 卡片状态为可见。
FORM_INVISIBLE9+ 2 卡片状态为不可见。

FormInfoFilter9+

卡片信息过滤器,仅将符合过滤器内要求的卡片信息返回。

系统能力:SystemCapability.Ability.Form

名称 说明
moduleName9+ 仅保留moduleName与提供值相符的卡片信息。

VisibilityType9+

卡片当前可见类型枚举。

系统能力:SystemCapability.Ability.Form

名称 说明
FORM_VISIBLE9+ 1 表示卡片为可见。
FORM_INVISIBLE9+ 2 表示卡片为不可见。