harmony 鸿蒙卡片定时刷新和定点刷新
卡片定时刷新和定点刷新
当前卡片框架提供了如下几种按时间刷新卡片的方式:
- 定时刷新:表示在一定时间间隔内调用onUpdateForm的生命周期回调函数自动刷新卡片内容。可以在form_config.json配置文件的
updateDuration
字段中进行设置。例如,可以将刷新时间设置为每小时一次。
说明:
在使用定时和定点刷新功能之前,需要在form_config.json配置文件中设置
updateEnabled
字段为true
,以启用周期性刷新功能。 当配置了updateDuration
(定时刷新)后,该设置会优先于scheduledUpdateTime
(定点刷新)生效,即使同时配置了两者,定点刷新也会被忽略。
{
"forms": [
{
"name": "widget",
"description": "This is a service widget.",
"src": "./ets/widget/pages/WidgetCard.ets",
"uiSyntax": "arkts",
"window": {
"designWidth": 720,
"autoDesignWidth": true
},
"colorMode": "auto",
"isDefault": true,
"updateEnabled": true,
"scheduledUpdateTime": "10:30",
"updateDuration": 2,
"defaultDimension": "2*2",
"supportDimensions": ["2*2"]
}
]
}
- 定点刷新:表示在每天的某个特定时间点自动刷新卡片内容。可以在form_config.json配置文件中的
scheduledUpdateTime
字段中进行设置。例如,可以将刷新时间设置为每天的上午10点30分。
说明:
当同时配置了定时刷新(
updateDuration
)和定点刷新(scheduledUpdateTime
)时,定时刷新的优先级更高。如果想要配置定点刷新,则需要将updateDuration
配置为0。
{
"forms": [
{
"name": "widget",
"description": "This is a service widget.",
"src": "./ets/widget/pages/WidgetCard.ets",
"uiSyntax": "arkts",
"window": {
"designWidth": 720,
"autoDesignWidth": true
},
"colorMode": "auto",
"isDefault": true,
"updateEnabled": true,
"scheduledUpdateTime": "10:30",
"updateDuration": 0,
"defaultDimension": "2*2",
"supportDimensions": ["2*2"]
}
]
}
- 下次刷新:表示指定卡片的下一次刷新时间。可以通过调用
setFormNextRefreshTime()
接口来实现。最短刷新时间为5分钟。例如,可以在接口调用后的5分钟内刷新卡片内容。
import formProvider from '@ohos.app.form.formProvider';
import Base from '@ohos.base';
let formId: string = '123456789'; // 实际业务场景需要使用正确的formId
try {
// 设置过5分钟后更新卡片内容
formProvider.setFormNextRefreshTime(formId, 5, (err: Base.BusinessError) => {
if (err) {
console.error(`Failed to setFormNextRefreshTime. Code: ${err.code}, message: ${err.message}`);
return;
} else {
console.info('Succeeded in setFormNextRefreshTimeing.');
}
});
} catch (err) {
console.error(`Failed to setFormNextRefreshTime. Code: ${(err as Base.BusinessError).code}, message: ${(err as Base.BusinessError).message}`);
}
在触发定时、定点或下次刷新后,系统会调用FormExtensionAbility的onUpdateForm()
生命周期回调,在回调中,可以使用updateForm()
进行提供方刷新卡片。onUpdateForm()
生命周期回调的使用请参见通过FormExtensionAbility刷新卡片内容。
说明: 1. 定时刷新有配额限制,每张卡片每天最多通过定时方式触发刷新50次,定时刷新包含卡片配置项updateDuration和调用
setFormNextRefreshTime()
方法两种方式,当达到50次配额后,无法通过定时方式再次触发刷新,刷新次数会在每天的0点重置。
当前定时刷新使用同一个计时器进行计时,因此卡片定时刷新的第一次刷新会有最多30分钟的偏差。比如第一张卡片A(每隔半小时刷新一次)在3点20分添加成功,定时器启动并每隔半小时触发一次事件,第二张卡片B(每隔半小时刷新一次)在3点40分添加成功,在3点50分定时器事件触发时,卡片A触发定时刷新,卡片B会在下次事件(4点20分)中才会触发。
定时刷新和定点刷新仅在屏幕亮屏情况下才会触发,在灭屏场景下仅会记录刷新动作,待亮屏时统一进行刷新。
如果使能了卡片代理刷新,定时刷新和下次刷新不生效。
你可能感兴趣的鸿蒙文章
harmony 鸿蒙FA模型访问Stage模型DataShareExtensionAbility
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦