@ohos.app.form.formProvider (formProvider)

The FormProvider module provides APIs related to the widget provider. You can use the APIs to update a widget, set the next refresh time for a widget, obtain widget information, and request a widget release.

NOTE The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

setFormNextRefreshTime

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

Sets the next refresh time for a widget. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.Form

Parameters

Error codes

Example

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

setFormNextRefreshTime

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

Sets the next refresh time for a widget. This API uses a promise to return the result.

System capability: SystemCapability.Ability.Form

Parameters

Return value

Error codes

Example

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

Updates a widget. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.Form

Parameters

Error codes

Example

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

updateForm

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

Updates a widget. This API uses a promise to return the result.

System capability: SystemCapability.Ability.Form

Parameters

Return value

Error codes

Example

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

Obtains the application's widget information on the device. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.Form

Parameters

Error codes

Example

try {
  formProvider.getFormsInfo((error, data) => {
    if (error) {
      console.log('formProvider getFormsInfo, error:' + JSON.stringify(error));
      return;
    }
    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

Obtains the application's widget information that meets a filter criterion on the device. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.Form

Parameters

Error codes

Example

import formInfo from '@ohos.app.form.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));
      return;
    }
    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>>

Obtains the application's widget information on the device. This API uses a promise to return the result.

System capability: SystemCapability.Ability.Form

Parameters

Return value

Error codes

Example

import formInfo from '@ohos.app.form.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)}`);
}

requestPublishForm

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

Requests to publish a widget carrying data to the widget host. This API uses an asynchronous callback to return the result. This API is usually called by the home screen.

System capability: SystemCapability.Ability.Form

System API: This is a system API.

Parameters

Error codes

Example

import formBindingData from '@ohos.application.formBindingData';
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 {
  let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
  formProvider.requestPublishForm(want, obj, (error, data) => {
    if (error) {
      console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
      return;
    }
    console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
  });
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

requestPublishForm

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

Requests to publish a widget to the widget host. This API uses an asynchronous callback to return the result. This API is usually called by the home screen.

System capability: SystemCapability.Ability.Form

System API: This is a system API.

Parameters

Error codes

Example

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.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
      return;
    }
    console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
  });
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

requestPublishForm

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

Requests to publish a widget to the widget host. This API uses a promise to return the result. This API is usually called by the home screen.

System capability: SystemCapability.Ability.Form

System API: This is a system API.

Parameters

Return value

Error codes

Example

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.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
  });
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

isRequestPublishFormSupported

isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void

Checks whether a widget can be published to the widget host. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Ability.Form

Parameters

Error codes

Example

try {
  formProvider.isRequestPublishFormSupported((error, isSupported) => {
  if (error) {
    console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error));
  } 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.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
          } else {
            console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data));
          }
      });
      } catch (error) {
        console.log(`catch err->${JSON.stringify(error)}`);
      }

    }
  }
});
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}

isRequestPublishFormSupported

isRequestPublishFormSupported(): Promise<boolean>

Checks whether a widget can be published to the widget host. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Ability.Form

Return value

Error codes

Example

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.log('formProvider requestPublishForm, error: ' + JSON.stringify(error));
        });
      } catch (error) {
        console.log(`catch err->${JSON.stringify(error)}`);
      }

    }
  }).catch((error) => {
    console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error));
  });
} catch (error) {
  console.log(`catch err->${JSON.stringify(error)}`);
}