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
Name | Type | Mandatory | Description |
---|---|---|---|
formId | string | Yes | ID of a widget. |
minute | number | Yes | Refresh interval, in minutes. The value must be greater than or equal to 5. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
var formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
if (error.code) {
console.log('formProvider setFormNextRefreshTime, 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
Name | Type | Mandatory | Description |
---|---|---|---|
formId | string | Yes | ID of a widget. |
minute | number | Yes | Refresh interval, in minutes. The value must be greater than or equal to 5. |
Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
var formId = "12400633174999288";
formProvider.setFormNextRefreshTime(formId, 5).then(() => {
console.log('formProvider setFormNextRefreshTime success');
}).catch((error) => {
console.log('formProvider setFormNextRefreshTime, error:' + 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
Name | Type | Mandatory | Description |
---|---|---|---|
formId | string | Yes | ID of the widget to update. |
formBindingData | FormBindingData | Yes | Data to be used for the update. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
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.code) {
console.log('formProvider updateForm, error:' + 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
Name | Type | Mandatory | Description |
---|---|---|---|
formId | string | Yes | ID of the widget to update. |
formBindingData | FormBindingData | Yes | Data to be used for the update. |
Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
import formBindingData from '@ohos.application.formBindingData';
var formId = "12400633174999288";
let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
formProvider.updateForm(formId, obj).then(() => {
console.log('formProvider updateForm success');
}).catch((error) => {
console.log('formProvider updateForm, error:' + JSON.stringify(error));
});