IEpgSyncTaskScheduler
An interface that exposes functions to schedule an EPG Sync task.
Properties
scheduleTask
scheduleTask:
(componentId: string, interval: number) => Promise<void>
Function to schedule the provided EPG Sync Task at the given time interval.
This function will first schedule the EPG task to be run immediately. And then it will schedule the EPG Sync Task to be executed at the interval specified. The interval passed to this function is be in minutes and should be between 5 mins and 1440 mins inclusive. Only one EPG Sync Task can be scheduled at any point in time. The most recent EPG Sync Task method call will be fulfilled and persisted across reboots.
scheduleTaskWithExecutionWindow
scheduleTaskWithExecutionWindow:
(componentId: string, timeProperties:ITimeProperties) => Promise<void>
Function to schedule the provided periodic EPG Sync Task with a specified time window constraint for execution.
This function will first schedule the EPG task to be run immediately. And then it will schedule the EPG Sync Task to be executed at the given start time and execution window in UTC everyday. Only one EPG Sync Task can be scheduled at any point in time. The most recent EPG Sync Task method call will be fulfilled and persisted across reboots.
cancelScheduledTasks
cancelScheduledTasks:
() => Promise<void>
Function to cancel the existing scheduled EPG sync tasks.
This function will cancel the scheduled EPG sync tasks registered by scheduleTask() or scheduleTaskWithExecutionWindow(). It succeeds even if there are no currently scheduled tasks.
Last updated: Jul 22, 2026
