IEpgSyncTaskScheduler

Brief

An interface that exposes functions to schedule an EPG Sync task.

Properties

cancelScheduledTasks()

cancelScheduledTasks: () => Promise<void>

Returns

Promise<void>

A Promise that resolves to void if the operation completed successfully.

Brief

Function to cancel the existing scheduled EPG sync tasks.

Details

This function will cancel the scheduled EPG sync tasks registered by scheduleTask() or scheduleTaskWithExecutionWindow(). It succeeds even if there are no currently scheduled tasks.

Throws

Throws an InternalError if the scheduler encounters an error when canceling the scheduled sync tasks.

---

scheduleTask()

scheduleTask: (componentId, interval) => Promise<void>

Parameters

componentId

string

The component Id for the JS background task that has to be scheduled.

interval

number

The time interval in mins the OS will wait before triggering the next sync task.

Returns

Promise<void>

A Promise that resolves to void if the operation completed successfully.

Brief

Function to schedule the provided EPG Sync Task at the given time interval.

Details

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.

Throws

Throws an InternalError if the scheduler encounters an error when scheduling the sync task.

---

scheduleTaskWithExecutionWindow()

scheduleTaskWithExecutionWindow: (componentId, timeProperties) => Promise<void>

Parameters

componentId

string

The component Id for the JS background task that has to be scheduled.

timeProperties

ITimeProperties

The time properties to associate with the EPG Sync Task.

Returns

Promise<void>

A Promise that resolves to void if the operation completed successfully.

Brief

Function to schedule the provided periodic EPG Sync Task with a specified time window constraint for execution.

Details

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.

Throws

Throws an InternalError if the scheduler encounters an error when scheduling the sync task.

---

Last updated: Sep 30, 2025