Class SchedulerService

Scheduler API service

Index

Constructors

Properties

Methods

addTask editTask getTask listTasks removeAllTasks removeTask startTask stopTask

Constructors

constructor

new SchedulerService(): SchedulerService
Returns SchedulerService

Properties

`Static` `Readonly`ClientID

ClientID: "SchedulerMessaging" = 'SchedulerMessaging'

Methods

`Static`addTask

addTask(
record: SchedulerRecord,
options: DaemonMessageOptions,
): DaemonMessageOptions
Add new scheduler task
Parameters
- record: SchedulerRecord
  Scheduler task
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/SchedulerService.ts:19

`Static`editTask

editTask(
record: SchedulerRecord,
options: DaemonMessageOptions,
): DaemonMessageOptions
Edit existing scheduler task
Parameters
- record: SchedulerRecord
  Scheduler task
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/SchedulerService.ts:36

`Static`getTask

getTask(taskId: string, options: DaemonMessageOptions): DaemonMessageOptions
Fetches task by ID
Parameters
- taskId: string
  Task ID
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/SchedulerService.ts:53

`Static`listTasks

listTasks(details: boolean, options: DaemonMessageOptions): DaemonMessageOptions
Fetches list of scheduler tasks
Parameters
- details: boolean
  Include full task details in response
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/SchedulerService.ts:73

`Static`removeAllTasks

removeAllTasks(options: DaemonMessageOptions): DaemonMessageOptions
Removes all scheduler tasks
Parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/SchedulerService.ts:92

`Static`removeTask

removeTask(taskId: string, options: DaemonMessageOptions): DaemonMessageOptions
Remove scheduler task by ID
Parameters
- taskId: string
  Task ID
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/SchedulerService.ts:111

`Static`startTask

startTask(taskId: string, options: DaemonMessageOptions): DaemonMessageOptions
Start task by ID
Parameters
- taskId: string
  Task ID
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/SchedulerService.ts:131

`Static`stopTask

stopTask(taskId: string, options: DaemonMessageOptions): DaemonMessageOptions
Stop task by ID
Parameters
- taskId: string
  Task ID
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/SchedulerService.ts:151