卡片提供方相關(guān)接口的能力

2024-01-23 12:53 更新

FormProvider模塊提供了卡片提供方相關(guān)接口的能力,開發(fā)者在開發(fā)卡片時,可通過該模塊提供接口實現(xiàn)更新卡片,設(shè)置卡片更新時間,獲取卡片信息,請求發(fā)布卡片等。

說明

本模塊首批接口從API version 9開始支持。后續(xù)版本的新增接口,采用上角標單獨標記接口的起始版本。

導(dǎo)入模塊

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

setFormNextRefreshTime

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

設(shè)置指定卡片的下一次更新時間,使用callback異步回調(diào)。

系統(tǒng)能力: SystemCapability.Ability.Form

參數(shù):

參數(shù)名

類型

必填

說明

formId

string

卡片標識。

minute

number

指定多久之后更新,單位分鐘,大于等于5。

callback

AsyncCallback<void>

回調(diào)函數(shù)。

錯誤碼:

錯誤碼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>

設(shè)置指定卡片的下一次更新時間,使用Promise異步回調(diào)。

系統(tǒng)能力: SystemCapability.Ability.Form

參數(shù):

參數(shù)名

類型

必填

說明

formId

string

卡片標識。

minute

number

指定多久之后更新,單位分鐘,大于等于5。

返回值:

類型

說明

Promise<void>

無返回結(jié)果的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異步回調(diào)。

系統(tǒng)能力: SystemCapability.Ability.Form

參數(shù):

參數(shù)名

類型

必填

說明

formId

string

請求更新的卡片標識。

formBindingData.FormBindingData

FormBindingData

用于更新的數(shù)據(jù)。

callback

AsyncCallback<void>

回調(diào)函數(shù)。

錯誤碼:

錯誤碼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異步回調(diào)。

系統(tǒng)能力: SystemCapability.Ability.Form

參數(shù):

參數(shù)名

類型

必填

說明

formId

string

請求更新的卡片標識。

formBindingData.FormBindingData

FormBindingData

用于更新的數(shù)據(jù)。

返回值:

類型

說明

Promise<void>

無返回結(jié)果的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

獲取設(shè)備上當(dāng)前應(yīng)用程序的卡片信息,使用callback異步回調(diào)。

系統(tǒng)能力: SystemCapability.Ability.Form

參數(shù):

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<FormInfo>>

回調(diào)函數(shù)。返回查詢到的卡片信息。

錯誤碼:

錯誤碼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

獲取設(shè)備上當(dāng)前應(yīng)用程序的卡片信息,并篩選符合條件的信息,使用callback異步回調(diào)。

系統(tǒng)能力: SystemCapability.Ability.Form

參數(shù):

參數(shù)名

類型

必填

說明

filter

formInfo.FormInfoFilter

卡片信息過濾器。

callback

AsyncCallback<Array<FormInfo>>

回調(diào)函數(shù)。返回查詢到符合條件的卡片信息。

錯誤碼:

錯誤碼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>>

獲取設(shè)備上當(dāng)前應(yīng)用程序的卡片信息,使用Promise異步回調(diào)。

系統(tǒng)能力: SystemCapability.Ability.Form

參數(shù):

參數(shù)名

類型

必填

說明

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. }
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號