鸿蒙OpenHarmony【@ohos.app.form.formInfo (formInfo)】ArkTS API

formInfo模块提供了卡片信息和状态等相关类型和枚举。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口，接纳上角标单独标志接口的起始版本。
导入模块

1. import { formInfo } from '@kit.FormKit';

复制代码

FormInfo

卡片配置信息。
体系本领：  SystemCapability.Ability.Form
名称类型可读可写说明bundleNamestring是否卡片所属包的Bundle名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。moduleNamestring是否卡片所属模块的模块名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。abilityNamestring是否卡片所属的Ability名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。namestring是否应用/元服务名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。displayName11+string是否卡片名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。displayNameId11+number是否卡片预览时标识卡片名称的ID。元服务API：  从API version 11开始，该接口支持在元服务中利用。descriptionstring是否卡片描述。元服务API：  从API version 11开始，该接口支持在元服务中利用。descriptionId10+number是否卡片描述id。元服务API：  从API version 11开始，该接口支持在元服务中利用。type[FormType]是否卡片类型。当前支持JS卡片、ArkTS卡片。元服务API：  从API version 11开始，该接口支持在元服务中利用。jsComponentNamestring是否js卡片的组件名。元服务API：  从API version 11开始，该接口支持在元服务中利用。colorMode[ColorMode]是否卡片颜色模式。元服务API：  从API version 11开始，该接口支持在元服务中利用。isDefaultboolean是否卡片是否是默认卡片。元服务API：  从API version 11开始，该接口支持在元服务中利用。updateEnabledboolean是否卡片是否使能更新。元服务API：  从API version 11开始，该接口支持在元服务中利用。formVisibleNotifyboolean是否卡片是否使能可见通知。元服务API：  从API version 11开始，该接口支持在元服务中利用。scheduledUpdateTimestring是否卡片更新时间。元服务API：  从API version 11开始，该接口支持在元服务中利用。formConfigAbilitystring是否卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。元服务API：  从API version 11开始，该接口支持在元服务中利用。updateDurationnumber是否卡片更新周期。元服务API：  从API version 11开始，该接口支持在元服务中利用。defaultDimensionnumber是否卡片规格元服务API：  从API version 11开始，该接口支持在元服务中利用。supportDimensionsArray是否卡片支持的规格。详细可选规格参考[FormDimension]元服务API：  从API version 11开始，该接口支持在元服务中利用。customizeDataRecord<string, string>是否卡片用户数据。元服务API：  从API version 11开始，该接口支持在元服务中利用。isDynamic10+boolean是否卡片是否为动态卡片。仅ArkTS卡片区分动静态卡片，JS卡片均为动态卡片。元服务API：  从API version 11开始，该接口支持在元服务中利用。transparencyEnabled11+boolean是否卡片是否支持设置配景透明度。ArkTS卡片由用户配置决定是否支持，JS卡片均不支持。元服务API：  从API version 11开始，该接口支持在元服务中利用。supportedShapes12+Array是否卡片支持的形状。详细可选形状参考[FormShape12+]元服务API：  从API version 12开始，该接口支持在元服务中利用。 FormType

支持的卡片类型枚举。
元服务API：  从API version 11开始，该接口支持在元服务中利用。
体系本领：  SystemCapability.Ability.Form
名称值说明JS1卡片类型为JS。eTS2卡片类型为ArkTS。 ColorMode

卡片支持的颜色模式枚举。
元服务API：  从API version 11开始，该接口支持在元服务中利用。
体系本领：  SystemCapability.Ability.Form
名称值说明MODE_AUTO-1表示自动模式。MODE_DARK0表示暗色。MODE_LIGHT1表示亮色。 FormStateInfo

卡片状态信息。
元服务API：  从API version 11开始，该接口支持在元服务中利用。
体系本领：  SystemCapability.Ability.Form
名称类型可读可写说明formState[FormState]是否卡片状态。want[Want]是否Want文本内容。 FormState

卡片状态枚举。
元服务API：  从API version 11开始，该接口支持在元服务中利用。
体系本领：  SystemCapability.Ability.Form
名称值说明UNKNOWN-1表示未知状态。DEFAULT0表示默认状态。READY1表示停当状态。 FormParam

卡片参数枚举。
体系本领：  SystemCapability.Ability.Form
名称值说明IDENTITY_KEY‘ohos.extra.param.key.form_identity’卡片标识。元服务API：  从API version 11开始，该接口支持在元服务中利用。DIMENSION_KEY‘ohos.extra.param.key.form_dimension’卡片规格样式。元服务API：  从API version 11开始，该接口支持在元服务中利用。NAME_KEY‘ohos.extra.param.key.form_name’卡片名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。MODULE_NAME_KEY‘ohos.extra.param.key.module_name’卡片所属模块名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。WIDTH_KEY‘ohos.extra.param.key.form_width’卡片宽度。元服务API：  从API version 11开始，该接口支持在元服务中利用。HEIGHT_KEY‘ohos.extra.param.key.form_height’卡片高度。元服务API：  从API version 11开始，该接口支持在元服务中利用。TEMPORARY_KEY‘ohos.extra.param.key.form_temporary’暂时卡片。元服务API：  从API version 11开始，该接口支持在元服务中利用。ABILITY_NAME_KEY‘ohos.extra.param.key.ability_name’ability名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。BUNDLE_NAME_KEY‘ohos.extra.param.key.bundle_name’Bundle名称。元服务API：  从API version 11开始，该接口支持在元服务中利用。LAUNCH_REASON_KEY10+‘ohos.extra.param.key.form_launch_reason’卡片创建原因。元服务API：  从API version 11开始，该接口支持在元服务中利用。PARAM_FORM_CUSTOMIZE_KEY10+‘ohos.extra.param.key.form_customize’自界说数据。元服务API：  从API version 11开始，该接口支持在元服务中利用。FORM_RENDERING_MODE_KEY11+‘ohos.extra.param.key.form_rendering_mode’卡片渲染模式。元服务API：  从API version 12开始，该接口支持在元服务中利用。HOST_BG_INVERSE_COLOR_KEY12+‘ohos.extra.param.key.host_bg_inverse_color’卡片利用方的配景反色颜色值。元服务API：  从API version 12开始，该接口支持在元服务中利用。FORM_LOCATION_KEY12+‘ohos.extra.param.key.form_location’卡片位置。OTHER -1 (其他位置)DESKTOP 0 (桌面)FORM_CENTER 1 (桌面的卡片中心)FORM_MANAGER 2 (桌面的卡片管理器)NEGATIVE_SCREEN 3 (负一屏)FORM_CENTER_NEGATIVE_SCREEN 4 (负一屏的服务中心)FORM_MANAGER_NEGATIVE_SCREEN 5 (负一屏的卡片管理器)SCREEN_LOCK 6 (锁屏)AI_SUGGESTION 7 (小艺发起保举区)FORM_PERMISSION_NAME_KEY12+‘ohos.extra.param.key.permission_name’用户授权权限名称。元服务API：  从API version 12开始，该接口支持在元服务中利用。FORM_PERMISSION_GRANTED_KEY12+‘ohos.extra.param.key.permission_granted’用户是否授权。元服务API：  从API version 12开始，该接口支持在元服务中利用。 FormDimension

界说卡片尺寸枚举。
体系本领：  SystemCapability.Ability.Form
名称值说明Dimension_1_211 x 2 form。元服务API：  从API version 11开始，该接口支持在元服务中利用。Dimension_2_222 x 2 form。元服务API：  从API version 11开始，该接口支持在元服务中利用。Dimension_2_432 x 4 form。元服务API：  从API version 11开始，该接口支持在元服务中利用。Dimension_4_444 x 4 form。元服务API：  从API version 11开始，该接口支持在元服务中利用。Dimension_2_152 x 1 form。元服务API：  从API version 11开始，该接口支持在元服务中利用。DIMENSION_1_111+61 x 1 form。元服务API：  从API version 11开始，该接口支持在元服务中利用。DIMENSION_6_412+76 x 4 form。元服务API：  从API version 12开始，该接口支持在元服务中利用。 FormShape12+

界说卡片形状枚举。
体系本领：  SystemCapability.Ability.Form
名称值说明RECT1方形 form。元服务API：  从API version 12开始，该接口支持在元服务中利用。CIRCLE2圆形 form。元服务API：  从API version 12开始，该接口支持在元服务中利用。 FormInfoFilter

卡片信息过滤器，仅将符合过滤器内要求的卡片信息返回。
元服务API：  从API version 11开始，该接口支持在元服务中利用。
体系本领：  SystemCapability.Ability.Form
名称类型必填说明moduleNamestring否选填，仅保留含moduleName与提供值相符的卡片信息，未填写时则不通过moduleName进行过滤。 VisibilityType

卡片当前可见类型枚举。
元服务API：  从API version 11开始，该接口支持在元服务中利用。
体系本领：  SystemCapability.Ability.Form
名称值说明UNKNOWN10+0表示卡片为未知。FORM_VISIBLE1表示卡片为可见。FORM_INVISIBLE2表示卡片为不可见。 LaunchReason10+

卡片创建原因枚举。
元服务API：  从API version 11开始，该接口支持在元服务中利用。
体系本领：  SystemCapability.Ability.Form
名称值说明FORM_DEFAULT1表示卡片创建原因为默认创建。FORM_SHARE2表示卡片创建原因为共享创建。
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。