@ohos.app.form.formProvider (formProvider)

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	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

let formId = '12400633174999288';
try {
  formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
    if (error) {
      console.error(`callback error, code: ${error.code}, message: ${error.message})`);
    } else {
      console.log(`formProvider setFormNextRefreshTime success`);
    }
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

setFormNextRefreshTime

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

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

系统能力： SystemCapability.Ability.Form

参数：

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

返回值：

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

错误码：

错误码ID	错误信息
401	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

let formId = '12400633174999288';
try {
  formProvider.setFormNextRefreshTime(formId, 5).then(() => {
    console.log(`formProvider setFormNextRefreshTime success`);
  }).catch((error) => {
    console.error(`promise error, code: ${error.code}, message: ${error.message})`);
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12

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	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

let formId = '12400633174999288';
try {
  let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
  formProvider.updateForm(formId, obj, (error, data) => {
    if (error) {
      console.error(`callback error, code: ${error.code}, message: ${error.message})`);
    } else {
      console.log(`formProvider updateForm success`);
    }
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

updateForm

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

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

系统能力： SystemCapability.Ability.Form

参数：

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

返回值：

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

错误码：

错误码ID	错误信息
401	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

let 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.error(`promise error, code: ${error.code}, message: ${error.message})`);
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

getFormsInfo

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

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

系统能力： SystemCapability.Ability.Form

参数：

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

错误码：

错误码ID	错误信息
401	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13

getFormsInfo

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

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

系统能力： SystemCapability.Ability.Form

参数：

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

错误码：

错误码ID	错误信息
401	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

const filter: formInfo.FormInfoFilter = {
  // get info of forms belong to module entry.
  moduleName: 'entry'
};
try {
  formProvider.getFormsInfo(filter, (error, data) => {
    if (error) {
      console.error(`callback error, code: ${error.code}, message: ${error.message})`);
    } else {
      console.log('formProvider getFormsInfo, data: ${JSON.stringify(data)}');
    }
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

getFormsInfo

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

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

系统能力： SystemCapability.Ability.Form

参数：

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

返回值：

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

错误码：

错误码ID	错误信息
401	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

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.error(`promise error, code: ${error.code}, message: ${error.message})`);
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

requestPublishForm

requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback<string>): void

请求发布一张卡片到使用方。使用方通常为桌面。

系统能力： SystemCapability.Ability.Form

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
want	Want	是	发布请求。需包含以下字段。 abilityName: 目标卡片ability parameters: 'ohos.extra.param.key.form_dimension' 'ohos.extra.param.key.form_name' 'ohos.extra.param.key.module_name'
formBindingData	formBindingData.FormBindingData	是	创建卡片的数据。
callback	AsyncCallback<string>	是	回调函数。返回卡片标识。

错误码：

错误码ID	错误信息
401	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

let want = {
  abilityName: 'FormAbility',
  parameters: {
    'ohos.extra.param.key.form_dimension': 2,
    'ohos.extra.param.key.form_name': 'widget',
    'ohos.extra.param.key.module_name': 'entry'
  }
};
try {
  let obj = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' });
  formProvider.requestPublishForm(want, obj, (error, data) => {
    if (error) {
      console.error(`callback error, code: ${error.code}, message: ${error.message})`);
    } else {
      console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}');
    }
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

requestPublishForm

requestPublishForm(want: Want, callback: AsyncCallback<string>): void

请求发布一张卡片到使用方。使用方通常为桌面。

系统能力： SystemCapability.Ability.Form

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
want	Want	是	发布请求。需包含以下字段。 abilityName: 目标卡片ability parameters: 'ohos.extra.param.key.form_dimension' 'ohos.extra.param.key.form_name' 'ohos.extra.param.key.module_name'
callback	AsyncCallback<string>	是	回调函数。返回卡片标识。

错误码：

错误码ID	错误信息
401	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

let want = {
  abilityName: 'FormAbility',
  parameters: {
    'ohos.extra.param.key.form_dimension': 2,
    'ohos.extra.param.key.form_name': 'widget',
    'ohos.extra.param.key.module_name': 'entry'
  }
};
try {
  formProvider.requestPublishForm(want, (error, data) => {
    if (error) {
      console.error(`callback error, code: ${error.code}, message: ${error.message})`);
    } else {
      console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}');
    }
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

requestPublishForm

requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise<string>

请求发布一张卡片到使用方。使用方通常为桌面。

系统能力： SystemCapability.Ability.Form

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
want	Want	是	发布请求。需包含以下字段。 abilityName: 目标卡片ability parameters: 'ohos.extra.param.key.form_dimension' 'ohos.extra.param.key.form_name' 'ohos.extra.param.key.module_name'
formBindingData	formBindingData.FormBindingData	否	创建卡片的数据。

返回值：

类型	说明
Promise<string>	Promise对象。返回卡片标识。

错误码：

错误码ID	错误信息
401	调用接口入参错误。
以上错误码的详细介绍请参见卡片错误码。

示例：

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

let want = {
  abilityName: 'FormAbility',
  parameters: {
    'ohos.extra.param.key.form_dimension': 2,
    'ohos.extra.param.key.form_name': 'widget',
    'ohos.extra.param.key.module_name': 'entry'
  }
};
try {
  formProvider.requestPublishForm(want).then((data) => {
    console.log('formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}');
  }).catch((error) => {
    console.error(`promise error, code: ${error.code}, message: ${error.message})`);
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

isRequestPublishFormSupported

isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void

查询是否支持发布一张卡片到使用方。

系统接口: 此接口为系统接口。

系统能力： SystemCapability.Ability.Form

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	回调函数。返回是否支持发布一张卡片到使用方。

示例：

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

try {
  formProvider.isRequestPublishFormSupported((error, isSupported) => {
    if (error) {
      console.error(`callback error, code: ${error.code}, message: ${error.message})`);
    } else {
      if (isSupported) {
        var want = {
          abilityName: 'FormAbility',
          parameters: {
            'ohos.extra.param.key.form_dimension': 2,
            'ohos.extra.param.key.form_name': 'widget',
            'ohos.extra.param.key.module_name': 'entry'
          }
        };
        try {
          formProvider.requestPublishForm(want, (error, data) => {
            if (error) {
              console.error(`callback error, code: ${error.code}, message: ${error.message})`);
            } else {
              console.log('formProvider requestPublishForm, form ID is: ${JSON.stringify(data)}');
            }
          });
        } catch (error) {
          console.error(`catch error, code: ${error.code}, message: ${error.message})`);
        }
      }
    }
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

isRequestPublishFormSupported

isRequestPublishFormSupported(): Promise<boolean>

查询是否支持发布一张卡片到使用方。

系统接口: 此接口为系统接口。

系统能力： SystemCapability.Ability.Form

返回值：

类型	说明
Promise<boolean>	Promise对象。返回是否支持发布一张卡片到使用方。

示例：

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

try {
  formProvider.isRequestPublishFormSupported().then((isSupported) => {
    if (isSupported) {
      var want = {
        abilityName: 'FormAbility',
        parameters: {
          'ohos.extra.param.key.form_dimension': 2,
          'ohos.extra.param.key.form_name': 'widget',
          'ohos.extra.param.key.module_name': 'entry'
        }
      };
      try {
        formProvider.requestPublishForm(want).then((data) => {
          console.log('formProvider requestPublishForm success, form ID is : ${JSON.stringify(data)}');
        }).catch((error) => {
          console.error(`promise error, code: ${error.code}, message: ${error.message})`);
        });
      } catch (error) {
        console.error(`catch error, code: ${error.code}, message: ${error.message})`);
      }
    }
  }).catch((error) => {
    console.error(`promise error, code: ${error.code}, message: ${error.message})`);
  });
} catch (error) {
  console.error(`catch error, code: ${error.code}, message: ${error.message})`);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

@ohos.app.form.formProvider (formProvider)

@ohos.app.form.formProvider (formProvider)

导入模块

setFormNextRefreshTime

setFormNextRefreshTime

updateForm

updateForm

getFormsInfo

getFormsInfo

getFormsInfo

requestPublishForm

requestPublishForm

requestPublishForm

isRequestPublishFormSupported

isRequestPublishFormSupported

Description