回复
HarmonyOS API：通用能力的接口
joytrian
发布于 2023-3-31 18:04
浏览
0收藏
版本：v3.1 Beta
@ohos.application.formError (FormError)
更新时间: 2023-02-17 09:19
FormError模块提供获取卡片错误码的能力。
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
从API version 9 开始不再维护，建议使用Form错误码替代。
导入模块
import formError from '@ohos.application.formError';
权限
无
FormError
枚举，支持的卡片类型
系统能力：
SystemCapability.Ability.Form
名称 | 值 | 说明 |
ERR_COMMON | 1 | 默认错误码。 |
ERR_PERMISSION_DENY | 2 | 没有操作权限。 |
ERR_GET_INFO_FAILED | 4 | 查询卡片信息失败。 |
ERR_GET_BUNDLE_FAILED | 5 | 查询应用信息失败。 |
ERR_GET_LAYOUT_FAILED | 6 | 查询布局信息失败。 |
ERR_ADD_INVALID_PARAM | 7 | 无效参数。 |
ERR_CFG_NOT_MATCH_ID | 8 | 卡片ID不匹配。 |
ERR_NOT_EXIST_ID | 9 | 卡片ID不存在。 |
ERR_BIND_PROVIDER_FAILED | 10 | 绑定卡片提供方失败。 |
ERR_MAX_SYSTEM_FORMS | 11 | 系统卡片实例数量超过限制。 |
ERR_MAX_INSTANCES_PER_FORM | 12 | 每张卡片实例数量超过限制。 |
ERR_OPERATION_FORM_NOT_SELF | 13 | 操作非自己应用申请的卡片。 |
ERR_PROVIDER_DEL_FAIL | 14 | 卡片提供方删除卡片失败。 |
ERR_MAX_FORMS_PER_CLIENT | 15 | 使用方申请卡片实例数超过限制。 |
ERR_MAX_SYSTEM_TEMP_FORMS | 16 | 临时卡片实例数超过限制。 |
ERR_FORM_NO_SUCH_MODULE | 17 | 模块不存在。 |
ERR_FORM_NO_SUCH_ABILITY | 18 | ability组件不存在。 |
ERR_FORM_NO_SUCH_DIMENSION | 19 | 卡片尺寸不存在。 |
ERR_FORM_FA_NOT_INSTALLED | 20 | 卡片所在FA未安装。 |
ERR_SYSTEM_RESPONSES_FAILED | 30 | 系统服务响应失败。 |
ERR_FORM_DUPLICATE_ADDED | 31 | 重复添加卡片。 |
ERR_IN_RECOVERY | 36 | 卡片数据覆盖失败。 |
@ohos.application.formInfo (FormInfo)
更新时间: 2023-02-17 09:19
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 | 是 | 否 | 表示卡片类型，当前支持JS卡片。 | |
jsComponentName | string | 是 | 否 | 表示js卡片的组件名。 |
colorMode | 是 | 否 | 表示卡片颜色模式。 | |
isDefault | boolean | 是 | 否 | 表示是否是默认卡片。 |
updateEnabled | boolean | 是 | 否 | 表示卡片是否使能更新。 |
formVisibleNotify | string | 是 | 否 | 表示卡片是否使能可见通知。 |
relatedBundleName | string | 是 | 否 | 表示卡片所属的相关联包名。 |
scheduledUpdateTime | string | 是 | 否 | 表示卡片更新时间。 |
formConfigAbility | string | 是 | 否 | 表示卡片配置ability。 |
updateDuration | string | 是 | 否 | 表示卡片更新周期。 |
defaultDimension | number | 是 | 否 | 表示卡片规格 |
supportDimensions | Array<number> | 是 | 否 | 表示卡片支持的规格。 |
customizeData | {[key: string]: [value: string]} | 是 | 否 | 表示卡片用户数据。 |
FormType
支持的卡片类型枚举。
系统能力：SystemCapability.Ability.Form
名称 | 值 | 说明 |
JS | 1 | 卡片类型为JS。 |
eTS9+ | 2 | 卡片类型为ArkTS。 |
ColorMode
卡片支持的颜色模式枚举。
系统能力：SystemCapability.Ability.Form
名称 | 值 | 说明 |
MODE_AUTO | -1 | 表示自动模式。 |
MODE_DARK | 0 | 表示暗色。 |
MODE_LIGHT | 1 | 表示亮色。 |
FormStateInfo
卡片状态信息。
系统能力：SystemCapability.Ability.Form
名称 | 类型 | 可读 | 可写 | 说明 |
formState | 是 | 否 | 表示卡片状态。 | |
want | Want | 是 | 否 | Want文本内容。 |
FormState
卡片状态枚举。
系统能力：SystemCapability.Ability.Form
名称 | 值 | 说明 |
UNKNOWN | -1 | 表示未知状态。 |
DEFAULT | 0 | 表示默认状态。 |
READY | 1 | 表示就绪状态。 |
FormParam
卡片参数枚举。
系统能力：SystemCapability.Ability.Form
名称 | 值 | 说明 |
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名称 |
BUNDLE_NAME_KEY9+ | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。 |
FormDimension9+
定义卡片尺寸枚举。
系统能力：SystemCapability.Ability.Form
名称 | 值 | 说明 |
Dimension_1_2 9+ | 1 | 1 x 2 form。 |
Dimension_2_2 9+ | 2 | 2 x 2 form。 |
Dimension_2_4 9+ | 3 | 2 x 4 form。 |
Dimension_4_4 9+ | 4 | 4 x 4 form。 |
Dimension_2_1 9+ | 5 | 2 x 1 form。 |
VisibilityType
卡片可见性。
系统能力：SystemCapability.Ability.Form
名称 | 值 | 说明 |
FORM_VISIBLE9+ | 1 | 卡片状态为可见。 |
FORM_INVISIBLE9+ | 2 | 卡片状态为不可见。 |
FormInfoFilter9+
卡片信息过滤器，仅将符合过滤器内要求的卡片信息返回。
系统能力：SystemCapability.Ability.Form
名称 | 说明 |
moduleName9+ | 仅保留moduleName与提供值相符的卡片信息。 |
VisibilityType9+
卡片当前可见类型枚举。
系统能力：SystemCapability.Ability.Form
名称 | 值 | 说明 |
FORM_VISIBLE9+ | 1 | 表示卡片为可见。 |
FORM_INVISIBLE9+ | 2 | 表示卡片为不可见。 |
已于2023-3-31 18:04:36修改
赞
收藏
回复
相关推荐
