Skip to end of metadata
Go to start of metadata

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 Summary
void addCronJob(jobname, cronTimings, method)
Adds a cron job to the scheduler.
void addCronJob(jobname, cronTimings, method, startDate)
Adds a cron job to the scheduler.
void addCronJob(jobname, cronTimings, method, startDate, endDate)
Adds a cron job to the scheduler.
void addCronJob(jobname, cronTimings, method, startDate, endDate, arguments)
Adds a cron job to the scheduler.
void addJob(jobname, startDate, method)
Adds a job to the scheduler.
void addJob(jobname, startDate, method, repeatInterval)
Adds a job to the scheduler.
void addJob(jobname, startDate, method, repeatInterval, repeatCount)
Adds a job to the scheduler.
void addJob(jobName, startDate, method, repeatInterval, repeatCount, endDate)
Adds a job to the scheduler.
void addJob(jobname, startDate, method, repeatInterval, repeatCount, endDate, arguments)
Adds a job to the scheduler.
void addJob(jobname, startDate, method, arguments)
Adds a job to the scheduler.
String[] getCurrentJobNames()
Returns an array with the current jobs.
String getLastRunJobName()
Returns the last job run from the scheduler.
Boolean removeJob(jobname)
Removes a job from the scheduler.



Method Details

addCronJob

void 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

{String} jobname
{String} cronTimings
{Function} method

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 * * * ?',method)
// 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 ? * *',method,dateNow,date5Days)
 

addCronJob

void 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

{String} jobname
{String} cronTimings
{Function} method
{Date} startDate

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 * * * ?',method)
// 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 ? * *',method,dateNow,date5Days)
 

addCronJob

void 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

{String} jobname
{String} cronTimings
{Function} method
{Date} startDate
{Date} endDate

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 * * * ?',method)
// 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 ? * *',method,dateNow,date5Days)
 

addCronJob

void 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
{Object[]} 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 * * * ?',method)
// 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 ? * *',method,dateNow,date5Days)
 

addJob

void addJob (jobname, startDate, method)
Adds a job to the scheduler.

Parameters

{String} jobname
{Date} startDate
{Function} method

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,method,20000,40,endDate)
 

addJob

void addJob (jobname, startDate, method, repeatInterval)
Adds a job to the scheduler.

Parameters

{String} jobname
{Date} startDate
{Function} method
{Number} repeatInterval - ms

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,method,20000,40,endDate)
 

addJob

void addJob (jobname, startDate, method, repeatInterval, repeatCount)
Adds a job to the scheduler.

Parameters

{String} jobname
{Date} startDate
{Function} method
{Number} repeatInterval - ms
{Number} repeatCount

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,method,20000,40,endDate)
 

addJob

void 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

// 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,method,20000,40,endDate)
 

addJob

void 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
{Object[]} 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,method,20000,40,endDate)
 

addJob

void addJob (jobname, startDate, method, arguments)
Adds a job to the scheduler.

Parameters

{String} jobname
{Date} startDate
{Function} method
{Object[]} 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,method,20000,40,endDate)
 

getCurrentJobNames

String[] getCurrentJobNames ()
Returns an array with the current jobs.

Returns

Sample

plugins.scheduler.getCurrentJobNames()
 

getLastRunJobName

String getLastRunJobName ()
Returns the last job run from the scheduler.

Returns

Sample

plugins.scheduler.getLastRunJobName();
 

removeJob

Boolean removeJob (jobname)
Removes a job from the scheduler.

Parameters

{String} jobname

Returns

Sample

// removes a job 'myjob' from the scheduler
plugins.scheduler.removeJob('myjob');
 



  • No labels

1 Comment

  1. Anonymous

    Which "add job" method should be used it is not clear the difference between addCronJob and addJob.