scheduler
(plugins.scheduler)
Overview
The scheduler
plugin enables the creation and management of background jobs in headless clients. It supports both cron-based schedules and custom intervals, allowing for versatile task automation.
The addCronJob
method schedules tasks using cron expressions, with options for specifying start and end dates, and passing arguments. This method is ideal for periodic tasks such as running jobs at specific times or intervals.
For more custom scheduling, the addJob
method allows tasks to be scheduled at a specific start date with options for repetition intervals, counts, and end dates. Additional arguments can be passed to provide further flexibility in task execution.
To monitor jobs, the getCurrentJobNames
method retrieves active jobs, and getLastRunJobName
provides the most recently executed job. The removeJob
method simplifies job management by enabling the deletion of specific tasks.
For more information, refer to the Scheduler API section of the documentation.
Methods Summarized
void
Adds a cron job to the scheduler.
void
Adds a cron job to the scheduler.
void
Adds a cron job to the scheduler.
void
Adds a cron job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
Returns an array with the current jobs.
Returns the last job run from the scheduler.
Removes a job from the scheduler.
Methods Detailed
addCronJob(jobname, cronTimings, method)
Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute).
Parameters
Returns: void
Sample
addCronJob(jobname, cronTimings, method, startDate)
Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute).
Parameters
Returns: void
Sample
addCronJob(jobname, cronTimings, method, startDate, endDate)
Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute).
Parameters
Returns: void
Sample
addCronJob(jobname, cronTimings, method, startDate, endDate, arguments)
Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute).
Parameters
String jobname ;
String cronTimings ;
Function method ;
Date startDate ;
Date endDate ;
Array arguments ;
Returns: void
Sample
addJob(jobname, startDate, method)
Adds a job to the scheduler.
Parameters
Returns: void
Sample
addJob(jobname, startDate, method, repeatInterval)
Adds a job to the scheduler.
Parameters
Returns: void
Sample
addJob(jobname, startDate, method, repeatInterval, repeatCount)
Adds a job to the scheduler.
Parameters
Returns: void
Sample
addJob(jobName, startDate, method, repeatInterval, repeatCount, endDate)
Adds a job to the scheduler.
Parameters
String jobName ;
Date startDate ;
Function method ;
Number repeatInterval ms
Number repeatCount ;
Date endDate ;
Returns: void
Sample
addJob(jobname, startDate, method, repeatInterval, repeatCount, endDate, arguments)
Adds a job to the scheduler.
Parameters
String jobname ;
Date startDate ;
Function method ;
Number repeatInterval ms
Number repeatCount ;
Date endDate ;
Array arguments ;
Returns: void
Sample
addJob(jobname, startDate, method, arguments)
Adds a job to the scheduler.
Parameters
Returns: void
Sample
getCurrentJobNames()
Returns an array with the current jobs.
Returns: Array
Sample
getLastRunJobName()
Returns the last job run from the scheduler.
Returns: String
Sample
removeJob(jobname)
Removes a job from the scheduler.
Parameters
String jobname ;
Returns: Boolean
Sample
Last updated