harmony(鸿蒙)FormInfo

  • 2022-08-09
  • 浏览 (710)

FormInfo

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

说明:

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

导入模块

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

FormInfo

卡片信息

系统能力:SystemCapability.Ability.Form

名称 读写属性 类型 描述
bundleName 只读 string 卡片所属包的包名。
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 卡片所属的相关联包名。
scheduledUpdateTime 只读 string 卡片更新时间。
formConfigAbility 只读 string 卡片配置ability。指定长按卡片弹出的选择框内,编辑选项所对应的ability。
updateDuration 只读 string 卡片更新周期。
defaultDimension 只读 number 表示卡片规格
supportDimensions 只读 Array<number> 卡片支持的规格。具体可选规格参考FormDimension
customizeData 只读 {[key: string]: [value: string]} 卡片用户数据。

FormType

支持的卡片类型枚举。

系统能力:SystemCapability.Ability.Form

名称 说明
JS 1 卡片类型为JS。
eTS 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” 指示指定要获取的捆绑包名称的键。

FormDimension

定义卡片尺寸枚举。

系统能力:SystemCapability.Ability.Form

名称 说明
Dimension_1_29+ 1 1 x 2 form。
Dimension_2_29+ 2 2 x 2 form。
Dimension_2_49+ 3 2 x 4 form。
Dimension_4_49+ 4 4 x 4 form。
Dimension_2_19+ 5 2 x 1 form。

FormInfoFilter9+

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

系统能力:SystemCapability.Ability.Form

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

VisibilityType9+

卡片当前可见类型枚举。

系统能力:SystemCapability.Ability.Form

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

你可能感兴趣的鸿蒙文章

harmony(鸿蒙)接口

harmony(鸿蒙)开发说明

harmony(鸿蒙)BundleStatusCallback

harmony(鸿蒙)innerBundleManager模块(deprecated)

harmony(鸿蒙)distributedBundle模块(JS端SDK接口)

harmony(鸿蒙)Bundle模块(JS端SDK接口)

harmony(鸿蒙)Context模块

harmony(鸿蒙)DataUriUtils模块

harmony(鸿蒙)EnterpriseAdminExtensionAbility

harmony(鸿蒙)延迟任务调度回调

0  赞