harmony 鸿蒙@ohos.app.form.formInfo (formInfo)

  • 2022-12-05
  • 浏览 (546)

@ohos.app.form.formInfo (formInfo)

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

说明:

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import formInfo from '@ohos.app.form.formInfo';

FormInfo

卡片信息

系统能力:SystemCapability.Ability.Form

名称 类型 可读 可写 说明
bundleName string 卡片所属包的Bundle名称。
moduleName string 卡片所属模块的模块名称。
abilityName string 卡片所属的Ability名称。
name string 卡片名称。
description string 卡片描述。
descriptionId10+ number 卡片描述id。
type FormType 卡片类型。当前支持JS卡片、ArkTS卡片。
jsComponentName string js卡片的组件名。
colorMode ColorMode 卡片颜色模式。
isDefault boolean 卡片是否是默认卡片。
updateEnabled boolean 卡片是否使能更新。
formVisibleNotify boolean 卡片是否使能可见通知。
scheduledUpdateTime string 卡片更新时间。
formConfigAbility string 卡片配置ability。指定长按卡片弹出的选择框内,编辑选项所对应的ability。
updateDuration number 卡片更新周期。
defaultDimension number 表示卡片规格
supportDimensions Array<number> 卡片支持的规格。具体可选规格参考FormDimension
customizeData {[key: string]: [value: string]} 卡片用户数据。
isDynamic10+ boolean 卡片是否为动态卡片。
仅ArkTS卡片区分动静态卡片,JS卡片均为动态卡片。
transparencyEnabled11+ boolean 卡片是否支持设置背景透明度。
ArkTS卡片由用户配置决定是否支持,JS卡片均不支持。

FormType

支持的卡片类型枚举。

系统能力:SystemCapability.Ability.Form

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

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’ 临时卡片。
ABILITY_NAME_KEY ‘ohos.extra.param.key.ability_name’ ability名称。
DEVICE_ID_KEY ‘ohos.extra.param.key.device_id’ 设备标识。
系统API: 此接口为系统接口,三方应用不支持调用。
BUNDLE_NAME_KEY ‘ohos.extra.param.key.bundle_name’ 指示指定要获取的捆绑Bundle名称的键。
LAUNCH_REASON_KEY10+ ‘ohos.extra.param.key.form_launch_reason’ 卡片创建原因。
PARAM_FORM_CUSTOMIZE_KEY10+ ‘ohos.extra.param.key.form_customize’ 自定义数据。

FormDimension

定义卡片尺寸枚举。

系统能力:SystemCapability.Ability.Form

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

FormInfoFilter

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

系统能力:SystemCapability.Ability.Form

名称 类型 必填 说明
moduleName string 选填。仅保留moduleName与提供值相符的卡片信息。
未填写时则不通过moduleName进行过滤。

VisibilityType

卡片当前可见类型枚举。

系统能力:SystemCapability.Ability.Form

名称 说明
UNKNOWN10+ 0 表示卡片为未知。
FORM_VISIBLE 1 表示卡片为可见。
FORM_INVISIBLE 2 表示卡片为不可见。

FormUsageState

卡片当前使用状态枚举。

系统能力:SystemCapability.Ability.Form

名称 说明
USED11+ 0 表示卡片在使用中。
UNUSED11+ 1 表示卡片未被使用。

RunningFormInfo10+

卡片使用方信息

系统能力:SystemCapability.Ability.Form

系统API: 此接口为系统接口,三方应用不支持调用。

名称 类型 可读 可写 说明
formId string 卡片标识。
bundleName10+ string 提供方卡片所属包的Bundle名称。
hostBundleName string 使用方卡片所属包的Bundle名称。
visibilityType VisibilityType 卡片当前可见类型枚举。
moduleName10+ string 卡片所属模块的模块名称。
abilityName10+ string 卡片所属的Ability名称。
formName10+ string 卡片名称。
dimension number 卡片规格。
formUsageState11+ FormUsageState 卡片当前使用状态枚举。

formProviderFilter10+

卡片提供方信息。

模型约束:此接口仅可在Stage模型下使用。

系统能力:SystemCapability.Ability.Form

系统API: 此接口为系统接口,三方应用不支持调用。

名称 类型 可读 可写 说明
bundleName string 提供方卡片所属包的Bundle名称。
formName string 卡片名称。
moduleName string 卡片所属模块的模块名称。
abilityName string 卡片所属的Ability名称。
isUnusedIncluded11+ boolean 是否包含未使用的卡片。

LaunchReason10+

卡片创建原因枚举。

系统能力:SystemCapability.Ability.Form

名称 说明
FORM_DEFAULT 1 表示卡片创建原因为默认创建。
FORM_SHARE 2 表示卡片创建原因为共享创建。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述(仅对系统应用开放)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0  赞