Where is the method executed?
The scheduled methods are executed in the client in which they are started. This means that if the client is closed, the scheduled method(s) will not run anymore. See Batch Processors for information how to continuously run methods in the background, in a client that will not be closed (automatically)
Method Summery | |
---|---|
void | #addCronJob(jobname, cronTimings, globalMethod, [startDate], [endDate], [arguments]) Adds a cron job to the scheduler. |
void | #addJob(jobname, startDate, globalMethod, [repeatInterval(ms)], [repeatCount], [endDate], [arguments]) Adds a job to the scheduler. |
String[] | #getCurrentJobNames() Returns an array with the current jobs. |
String | #getLastRunJobName() |
void | #removeJob(jobname) Removes a job from the scheduler. |
Method Details |
---|
addCronJob |
void addCronJob (jobname, cronTimings, globalMethod, [startDate], [endDate], [arguments]) |
Adds a cron job to the scheduler. |
Parameters jobname cronTimings globalMethod [startDate] [endDate] [arguments] |
Returns void |
Sample// see: http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html for more info // add a job that runs every 20 minutes after the hour (0,20,40) plugins.scheduler.addCronJob('20mins','0 0/20 * * * ?',globalMethod) // add a job that runs every day at 23:30 between now and 5 days from now var dateNow = new Date(); var date5Days = new Date(dateNow.getTime()+5*24*60*60*1000); plugins.scheduler.addCronJob('23:30','0 30 23 ? * *',globalMethod,dateNow,date5Days) |
addJob |
void addJob (jobname, startDate, globalMethod, [repeatInterval(ms)], [repeatCount], [endDate], [arguments]) |
Adds a job to the scheduler. |
Parameters jobname startDate globalMethod [repeatInterval(ms)] [repeatCount] [endDate] [arguments] |
Returns void |
Sample// add a job that runs at the given date (20 seconds in the future) // and repeats that every 20 seconds for 40 times or the enddate is reached (0 for no repeats = just one call) var startDate = new Date(); startDate.setTime(startDate.getTime()+20000); var endDate = new Date(startDate.getTime()+100000); plugins.scheduler.addJob('in20seconds',startDate,globalMethod,20000,40,endDate) |
getCurrentJobNames |
String[] getCurrentJobNames () |
Returns an array with the current jobs. |
Returns String[] |
Sample// Returns an array of current jobnames plugins.scheduler.getCurrentJobNames() |
getLastRunJobName |
String getLastRunJobName () |
Replace with description |
Returns String |
removeJob |
void removeJob (jobname) |
Removes a job from the scheduler. |
Parameters jobname |
Returns void |
Sample// removes a job 'myjob' from the scheduler plugins.scheduler.removeJob('myjob') |