ArkTS Api详解(FormInfo)

3 阅读2分钟

@ohos.app.form.formInfo (FormInfo)

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

FormInfo

卡片信息

名称类型可读可写说明
bundleNamestring卡片所属包的包名。
moduleNamestring卡片所属模块的模块名。
abilityNamestring卡片所属的Ability名称。
namestring卡片名称。
descriptionstring卡片描述。
typeFormType卡片类型。当前支持JS卡片。
jsComponentNamestringjs卡片的组件名。
colorModeColorMode卡片颜色模式。
isDefaultboolean卡片是否是默认卡片。
updateEnabledboolean卡片是否使能更新。
formVisibleNotifystring卡片是否使能可见通知。
scheduledUpdateTimestring卡片更新时间。
formConfigAbilitystring卡片配置ability。指定长按卡片弹出的选择框内,编辑选项所对应的ability。
updateDurationstring卡片更新周期。
defaultDimensionnumber表示卡片规格
supportDimensionsArray卡片支持的规格。具体可选规格参考FormDimension
customizeData{[key: string]: [value: string]}卡片用户数据。

FormType

支持的卡片类型枚举。

名称说明
JS1卡片类型为JS。
eTS2卡片类型为eTS。

ColorMode

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

名称说明
MODE_AUTO-1表示自动模式。
MODE_DARK0表示暗色。
MODE_LIGHT1表示亮色。

FormStateInfo

卡片状态信息。

名称类型可读可写说明
formStateFormState卡片状态。
wantWantWant文本内容。

FormState

卡片状态枚举。

名称说明
UNKNOWN-1表示未知状态。
DEFAULT0表示默认状态。
READY1表示就绪状态。

FormParam

卡片参数枚举。

名称说明
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"临时卡片。
ABILITY_NAME_KEY"ohos.extra.param.key.ability_name"ability名称
BUNDLE_NAME_KEY"ohos.extra.param.key.bundle_name"指示指定要获取的捆绑包名称的键。

FormDimension

定义卡片尺寸枚举。

名称说明
Dimension_1_211 x 2 form。
Dimension_2_222 x 2 form。
Dimension_2_432 x 4 form。
Dimension_4_444 x 4 form。
Dimension_2_152 x 1 form。

FormInfoFilter

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

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

VisibilityType

卡片当前可见类型枚举。

名称说明
FORM_VISIBLE1表示卡片为可见。
FORM_INVISIBLE2表示卡片为不可见。