FormProvider

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

Provides APIs related to the widget provider.

Modules to Import

import formProvider from '@ohos.application.formProvider';

Required Permissions

None.

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

Example

var formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
    if (error) {
        console.log('formProvider setFormNextRefreshTime, error:' + error.code);
    }
});

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

Example

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

updateForm

updateForm(formId: string, 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

Example

import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.updateForm(formId, obj, (error, data) => {
    if (error) {
        console.log('formProvider updateForm, error:' + error.code);
    }
});

updateForm

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

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

System capability

SystemCapability.Ability.Form

Parameters

Return value

Example

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