IEpgSyncTaskScheduler
简述
提供调度EPG Sync任务函数的接口。
属性
cancelScheduledTasks()
cancelScheduledTasks: () =>
Promise<void>
返回值
Promise<void>
操作成功时解析为无效的Promise。
简述
取消现有调度EPG同步任务的函数。
详情
此函数将取消由scheduleTask() 或scheduleTaskWithExecutionWindow() 注册的已调度的EPG同步任务。即使当前没有已调度的任务，也能成功执行。
抛出
如果调度程序在取消已调度同步任务时遇到错误，则抛出InternalError。
scheduleTask()
scheduleTask: (
componentId,interval) =>Promise<void>
参数
componentId
string
需要调度的JS后台任务的组件ID。
interval
number
操作系统在触发下一个同步任务前等待的时间间隔（单位：分钟）。
返回值
Promise<void>
操作成功时解析为无效的Promise。
简述
用于在指定时间间隔内调度所提供的EPG同步任务的函数。
详情
此函数将首先调度EPG任务立即运行。然后将调度EPG同步任务在指定的时间间隔内执行。传递给此函数的时间间隔应以分钟为单位，且必须在5分钟至1440分钟之间（含5分钟和1440分钟）。无论何时都只能调度一项EPG同步任务。最新的EPG同步任务方法调用将在重新启动时履行并保留。
抛出
如果调度程序在调度同步任务时遇到错误，则抛出InternalError。
scheduleTaskWithExecutionWindow()
scheduleTaskWithExecutionWindow: (
componentId,timeProperties) =>Promise<void>
参数
componentId
string
需要调度的JS后台任务的组件ID。
timeProperties
与EPG同步任务关联的时间属性。
返回值
Promise<void>
操作成功时解析为无效的Promise。
简述
用于调度所提供的定期EPG同步任务的函数，该任务需在指定时间窗口期内执行。
详情
此函数将首先调度EPG任务立即运行。然后将调度EPG同步任务在每日UTC的指定开始时间和执行窗口期内执行。无论何时都只能调度一项EPG同步任务。最新的EPG同步任务方法调用将在重新启动时履行并保留。
抛出
如果调度程序在调度同步任务时遇到错误，则抛出InternalError。
Last updated: 2025年10月2日
