Interface ISchedulerModify

This accessor provides methods to work with the Job Scheduler

Hierarchy

ISchedulerModify

Index

Methods

cancelAllJobs cancelJob scheduleOnce scheduleRecurring

Methods

cancelAllJobs

cancelAllJobs(): Promise<void>
Cancels all the running jobs from the app

Returns Promise<void>
- Defined in src/definition/accessors/ISchedulerModify.ts:30

cancelJob

cancelJob(jobId): Promise<void>
Cancels a running job given its jobId
Parameters
- jobId: string
Returns Promise<void>
- Defined in src/definition/accessors/ISchedulerModify.ts:26

scheduleOnce

scheduleOnce(job): Promise<string | void>
Schedules a registered processor to run once.
Parameters
- job: IOnetimeSchedule
Returns Promise<string | void>
jobid as string
- Defined in src/definition/accessors/ISchedulerModify.ts:13

scheduleRecurring

scheduleRecurring(job): Promise<string | void>
Schedules a registered processor to run in recurrencly according to a given interval
Parameters
- job: IRecurringSchedule
Returns Promise<string | void>
jobid as string
- Defined in src/definition/accessors/ISchedulerModify.ts:20

Generated using TypeDoc