HarmonyOS API：通用能力的接口

joytrian

发布于 2023-3-31 17:52

浏览

0收藏

版本：v3.1 Beta

@ohos.app.form.formInfo (FormInfo)

更新时间: 2023-02-17 09:19

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

说明

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

导入模块

import formInfo from '@ohos.app.form.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	卡片类型为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名称
BUNDLE_NAME_KEY	"ohos.extra.param.key.bundle_name"	指示指定要获取的捆绑包名称的键。

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	仅保留moduleName与提供值相符的卡片信息。

VisibilityType

卡片当前可见类型枚举。

系统能力：SystemCapability.Ability.Form

名称	值	说明
FORM_VISIBLE	1	表示卡片为可见。
FORM_INVISIBLE	2	表示卡片为不可见。

@ohos.app.form.formProvider (FormProvider)

更新时间: 2023-02-17 09:19

FormProvider模块提供了卡片提供方相关接口的能力，开发者在开发卡片时，可通过该模块提供接口实现更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。

说明

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

导入模块

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

setFormNextRefreshTime

setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void

设置指定卡片的下一次更新时间，使用callback异步回调。

系统能力： SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
formId	string	是	卡片标识。
minute	number	是	指定多久之后更新，单位分钟，大于等于5。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	If the input parameter is not valid parameter.
以上错误码的详细介绍请参见卡片错误码。

示例：

var formId = "12400633174999288";
try {
  formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
    if (error) {
      console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
    } else {
      console.log(`formProvider setFormNextRefreshTime success`);
    }
  });
} catch (error) {
    console.log("error" + JSON.stringify(error))
}

setFormNextRefreshTime

setFormNextRefreshTime(formId: string, minute: number): Promise<void>

设置指定卡片的下一次更新时间，使用Promise异步回调。

系统能力： SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
formId	string	是	卡片标识。
minute	number	是	指定多久之后更新，单位分钟，大于等于5。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

错误码ID	错误信息
401	If the input parameter is not valid parameter.
以上错误码的详细介绍请参见卡片错误码。

示例：

var formId = "12400633174999288";
try {
  formProvider.setFormNextRefreshTime(formId, 5).then(() => {
  console.log('formProvider setFormNextRefreshTime success');
  }).catch((error) => {
    console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
  });
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

updateForm

updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback<void>): void

更新指定的卡片，使用callback异步回调。

系统能力： SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
formId	string	是	请求更新的卡片标识。
formBindingData.FormBindingData	FormBindingData	是	用于更新的数据。
callback	AsyncCallback<void>	是	回调函数。

错误码：

错误码ID	错误信息
401	If the input parameter is not valid parameter.
以上错误码的详细介绍请参见卡片错误码。

示例：

import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
try {
  let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
  formProvider.updateForm(formId, obj, (error, data) => {
    if (error) {
      console.log('formProvider updateForm, error:' + JSON.stringify(error));
    } else {
      console.log(`formProvider updateForm success`);
    }
  });
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

updateForm

updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise<void>

更新指定的卡片，使用Promise异步回调。

系统能力： SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
formId	string	是	请求更新的卡片标识。
formBindingData.FormBindingData	FormBindingData	是	用于更新的数据。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

错误码ID	错误信息
401	If the input parameter is not valid parameter.
以上错误码的详细介绍请参见卡片错误码。

示例：

import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
try {
  formProvider.updateForm(formId, obj).then(() => {
      console.log('formProvider updateForm success');
  }).catch((error) => {
      console.log('formProvider updateForm, error:' + JSON.stringify(error));
  });
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

getFormsInfo

getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void

获取设备上当前应用程序的卡片信息，使用callback异步回调。

系统能力： SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<FormInfo>>	是	回调函数。返回查询到的卡片信息。

错误码：

错误码ID	错误信息
401	If the input parameter is not valid parameter.
以上错误码的详细介绍请参见卡片错误码。

示例：

try {
  formProvider.getFormsInfo((error, data) => {
    if (error) {
      console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
    } else {
      console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
    }
  });
} catch (error) {
    console.log(`catch err->${JSON.stringify(error)}`);
}

getFormsInfo

getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array<formInfo.FormInfo>>): void

获取设备上当前应用程序的卡片信息，并筛选符合条件的信息，使用callback异步回调。

系统能力： SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
filter	formInfo.FormInfoFilter	是	卡片信息过滤器。
callback	AsyncCallback<Array<FormInfo>>	是	回调函数。返回查询到符合条件的卡片信息。

错误码：

错误码ID	错误信息
401	If the input parameter is not valid parameter.
以上错误码的详细介绍请参见卡片错误码。

示例：

import formInfo from '@ohos.application.formInfo';
const filter : formInfo.FormInfoFilter = {
    // get info of forms belong to module entry.
    moduleName : "entry"
};
try {
  formProvider.getFormsInfo(filter, (error, data) => {
    if (error) {
      console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
    } else {
      console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
    }
  });
} catch(error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

getFormsInfo

getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.FormInfo>>

获取设备上当前应用程序的卡片信息，使用Promise异步回调。

系统能力： SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
filter	formInfo.FormInfoFilter	否	卡片信息过滤器。

返回值：

类型	说明
Promise<Array<FormInfo>>	Promise对象。返回查询到符合条件的卡片信息。

错误码：

错误码ID	错误信息
401	If the input parameter is not valid parameter.
以上错误码的详细介绍请参见卡片错误码。

示例：

import formInfo from '@ohos.application.formInfo';
const filter : formInfo.FormInfoFilter = {
    // get info of forms belong to module entry.
    moduleName : "entry"
};
try {
  formProvider.getFormsInfo(filter).then((data) => {
    console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
  }).catch((error) => {
    console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
  });
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-app-form-formprovider-0000001478061837-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001478061837__导入模块

分类

卡片开发

三方件

标签

HarmonyOS API

已于2023-3-31 17:52:05修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：通用能力的接口

@ohos.app.form.formInfo (FormInfo)

导入模块

FormInfo

FormType

ColorMode

FormStateInfo

FormState

FormParam

FormDimension

FormInfoFilter

VisibilityType

@ohos.app.form.formProvider (FormProvider)

导入模块

setFormNextRefreshTime

setFormNextRefreshTime

updateForm

updateForm

getFormsInfo

getFormsInfo

getFormsInfo

目录

订阅鸿蒙技术特刊，精选内容抢先看