卡片提供方相关接口的能力

2024-01-23 12:53 更新

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

说明

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

导入模块

  1. 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.

以上错误码的详细介绍请参见卡片错误码

 

示例:

  1. var formId = '12400633174999288';
  2. try {
  3. formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
  4. if (error) {
  5. console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
  6. } else {
  7. console.log(`formProvider setFormNextRefreshTime success`);
  8. }
  9. });
  10. } catch (error) {
  11. console.log('error' + JSON.stringify(error))
  12. }

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.

以上错误码的详细介绍请参见卡片错误码

 

示例:

  1. var formId = '12400633174999288';
  2. try {
  3. formProvider.setFormNextRefreshTime(formId, 5).then(() => {
  4. console.log('formProvider setFormNextRefreshTime success');
  5. }).catch((error) => {
  6. console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
  7. });
  8. } catch (error) {
  9. console.log(`catch err->${JSON.stringify(error)}`);
  10. }

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.

以上错误码的详细介绍请参见卡片错误码

 

示例:

  1. import formBindingData from '@ohos.application.formBindingData';
  2. var formId = '12400633174999288';
  3. try {
  4. let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
  5. formProvider.updateForm(formId, obj, (error, data) => {
  6. if (error) {
  7. console.log('formProvider updateForm, error:' + JSON.stringify(error));
  8. } else {
  9. console.log(`formProvider updateForm success`);
  10. }
  11. });
  12. } catch (error) {
  13. console.log(`catch err->${JSON.stringify(error)}`);
  14. }

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.

以上错误码的详细介绍请参见卡片错误码

 

示例:

  1. import formBindingData from '@ohos.application.formBindingData';
  2. var formId = '12400633174999288';
  3. let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
  4. try {
  5. formProvider.updateForm(formId, obj).then(() => {
  6. console.log('formProvider updateForm success');
  7. }).catch((error) => {
  8. console.log('formProvider updateForm, error:' + JSON.stringify(error));
  9. });
  10. } catch (error) {
  11. console.log(`catch err->${JSON.stringify(error)}`);
  12. }

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.

以上错误码的详细介绍请参见卡片错误码

 

示例:

  1. try {
  2. formProvider.getFormsInfo((error, data) => {
  3. if (error) {
  4. console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
  5. } else {
  6. console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
  7. }
  8. });
  9. } catch (error) {
  10. console.log(`catch err->${JSON.stringify(error)}`);
  11. }

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.

以上错误码的详细介绍请参见卡片错误码

 

示例:

  1. import formInfo from '@ohos.app.form.formInfo';
  2. const filter : formInfo.FormInfoFilter = {
  3. // get info of forms belong to module entry.
  4. moduleName : 'entry'
  5. };
  6. try {
  7. formProvider.getFormsInfo(filter, (error, data) => {
  8. if (error) {
  9. console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
  10. } else {
  11. console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
  12. }
  13. });
  14. } catch(error) {
  15. console.log(`catch err->${JSON.stringify(error)}`);
  16. }

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.

以上错误码的详细介绍请参见卡片错误码

 

示例:

  1. import formInfo from '@ohos.app.form.formInfo';
  2. const filter : formInfo.FormInfoFilter = {
  3. // get info of forms belong to module entry.
  4. moduleName : 'entry'
  5. };
  6. try {
  7. formProvider.getFormsInfo(filter).then((data) => {
  8. console.log('formProvider getFormsInfo, data:' + JSON.stringify(data));
  9. }).catch((error) => {
  10. console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
  11. });
  12. } catch (error) {
  13. console.log(`catch err->${JSON.stringify(error)}`);
  14. }
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号