@ohos.app.form.formInfo (formInfo)(系统接口)

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

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 当前页面仅包含本模块的系统接口，其他公共接口参见@ohos.app.form.formInfo (formInfo)。

导入模块

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

FormParam

卡片参数枚举。

系统能力： SystemCapability.Ability.Form

名称	值	说明
DEVICE_ID_KEY	'ohos.extra.param.key.device_id'	设备标识。 系统接口： 此接口为系统接口。

FormUsageState

卡片当前使用状态枚举。

系统能力： SystemCapability.Ability.Form

系统接口： 此接口为系统接口。

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

RunningFormInfo¹⁰⁺

已添加的卡片信息，包括使用中的以及未使用的卡片。

系统能力： SystemCapability.Ability.Form

系统接口： 此接口为系统接口。

名称	类型	可读	可写	说明
formId	string	是	否	卡片标识。
bundleName10+	string	是	否	提供方卡片所属包的Bundle名称。
hostBundleName	string	是	否	使用方卡片所属包的Bundle名称。
visibilityType	VisibilityType	是	否	卡片当前可见类型枚举。
moduleName10+	string	是	否	卡片所属模块的模块名称。
abilityName10+	string	是	否	卡片所属的Ability名称。
formName10+	string	是	否	卡片名称。
dimension	number	是	否	卡片规格。
formUsageState11+	FormUsageState	是	否	卡片当前使用状态枚举。
formDescription11+	string	是	否	提供方卡片配置文件中的描述信息。
formLocation12+	FormLocation	是	否	卡片位置信息。

formProviderFilter¹⁰⁺

卡片提供方信息。

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

系统能力： SystemCapability.Ability.Form

系统接口： 此接口为系统接口。

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

FormInfoFilter

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

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Ability.Form

名称	类型	必填	说明
bundleName	string	否	选填，仅保留含bundleName与提供值相符的卡片信息，未填写时则不通过bundleName进行过滤。 系统接口： 此接口为系统接口。
supportedDimensions	Array<number>	否	选填，仅保留含supportedDimensions提供值相符的卡片信息，未填写时则不通过supportedDimensions进行过滤。 系统接口： 此接口为系统接口。
supportedShapes12+	Array<number>	否	选填，仅保留含supportedShapes提供值相符的卡片信息，未填写时则不通过supportedShapes进行过滤。 系统接口： 此接口为系统接口。

FormLocation¹²⁺

卡片当前位置枚举。

系统能力：SystemCapability.Ability.Form

名称	值	说明
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	表示卡片位于小艺建议推荐区。

PublishFormResult¹²⁺

发布卡片加桌结果。

系统能力： SystemCapability.Ability.Form

名称	类型	可读	可写	说明
code	PublishFormErrorCode	是	否	发布卡片加桌错误码。
message	string	是	否	设置卡片加桌结果返回信息。

PublishFormErrorCode¹²⁺

发布卡片加桌错误码枚举。

系统能力：SystemCapability.Ability.Form

名称	值	说明
SUCCESS	0	表示卡片加桌成功。
NO_SPACE	1	表示没有空间添加卡片。
PARAM_ERROR	2	表示参数检查失败。
INTERNAL_ERROR	3	表示卡片处理过程中出现内部错误。