scheduler

Unknown macro: {div}

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR

Unknown macro: {div}

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

addCronJob(jobname, cronTimings, method)
Adds a cron job to the scheduler.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

addCronJob(jobname, cronTimings, method, startDate)
Adds a cron job to the scheduler.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

addCronJob(jobname, cronTimings, method, startDate, endDate)
Adds a cron job to the scheduler.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

addCronJob(jobname, cronTimings, method, startDate, endDate, arguments)
Adds a cron job to the scheduler.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

addJob(jobName, startDate, method, repeatInterval, repeatCount, endDate)
Adds a job to the scheduler.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String[]

Unknown macro: {td}

getCurrentJobNames()
Returns an array with the current jobs.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

removeJob(jobname)
Removes a job from the scheduler.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addCronJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addCronJob

Unknown macro: {span}

(jobname, cronTimings, method)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addCronJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addCronJob

Unknown macro: {span}

(jobname, cronTimings, method, startDate)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addCronJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addCronJob

Unknown macro: {span}

(jobname, cronTimings, method, startDate, endDate)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addCronJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addCronJob

Unknown macro: {span}

(jobname, cronTimings, method, startDate, endDate, arguments)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} jobname
{String} cronTimings
{Function} method
{Date} startDate
{Date} endDate
{Object[]} arguments

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addJob

Unknown macro: {span}

(jobname, startDate, method)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addJob

Unknown macro: {span}

(jobname, startDate, method, repeatInterval)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addJob

Unknown macro: {span}

(jobname, startDate, method, repeatInterval, repeatCount)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addJob

Unknown macro: {span}

(jobName, startDate, method, repeatInterval, repeatCount, endDate)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} jobName
{Date} startDate
{Function} method
{Number} repeatInterval – ms
{Number} repeatCount
{Date} endDate

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addJob

Unknown macro: {span}

(jobname, startDate, method, repeatInterval, repeatCount, endDate, arguments)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} jobname
{Date} startDate
{Function} method
{Number} repeatInterval – ms
{Number} repeatCount
{Date} endDate
{Object[]} arguments

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

addJob

Unknown macro: {span}

(jobname, startDate, method, arguments)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} jobname
{Date} startDate
{Function} method
{Object[]} arguments

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

// 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)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCurrentJobNames

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String[]

Unknown macro: {span}

getCurrentJobNames

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String[]

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

plugins.scheduler.getCurrentJobNames()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getLastRunJobName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getLastRunJobName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

plugins.scheduler.getLastRunJobName();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

removeJob

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

removeJob

Unknown macro: {span}

(jobname)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} jobname

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Child pages

scheduler

addCronJob

addCronJob

addCronJob

addCronJob

addJob

addJob

addJob

addJob

addJob

addJob

getCurrentJobNames

getLastRunJobName

removeJob