Table Head (thead) |
---|
Table Row (tr) |
---|
| Table Head (th) |
---|
| Method Details |
|
|
Table Body (tbody) |
---|
id | addCronJob-String_String_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
addCronJob |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobname, cronTimings, method) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // 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) |
|
|
|
|
Table Body (tbody) |
---|
id | addCronJob-String_String_Function_Date |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
addCronJob |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobname, cronTimings, method, startDate) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // 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) |
|
|
|
|
Table Body (tbody) |
---|
id | addCronJob-String_String_Function_Date_Date |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
addCronJob |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobname, cronTimings, method, startDate, endDate) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // 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) |
|
|
|
|
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id= Table Body (tbody) |
---|
id | addCronJob-String_String_Function_Date_Date |
---|
| |class=node}{tr:id=name}{td}h6.addCronJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; | Table Row (tr) |
---|
| Table Cell (td) |
---|
addCronJob |
|
| }{span}{span:id=iets|style=float: left; font-weight: bold;}addCronJob{span}{span:id=iets|style=float: left;}\(jobname, cronTimings, method, startDate){span}{td}{tr}{tr:id=des}{td}{sub-section:addCronJob-String_String_Function_Date_des|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_des|trigger=none|class=sIndent}Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addCronJob-String_String_Function_Date_snc|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addCronJob-String_String_Function_Date_prs|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_prs|trigger=none|class=sIndent}\{[String]} jobname
\{[String]} cronTimings
\{[Function]} method
\{[Date]} startDate
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addCronJob-String_String_Function_Date_ret|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addCronJob-String_String_Function_Date_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addCronJob-String_String_Function_Date_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addCronJob-String_String_Function_Date_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_sam|trigger=none}{code:language=javascript}
// see: http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html for more info
Span |
---|
(jobname, cronTimings, method, startDate, endDate, arguments) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // 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) |
|
|
|
|
Table Body (tbody) |
---|
id | addJob-String_Date_Function |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobname, startDate, method) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a job to the scheduler. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // 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) |
|
|
|
|
Table Body (tbody) |
---|
id | addJob-String_Date_Function_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobname, startDate, method, repeatInterval) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a job to the scheduler. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // add a job that runs |
|
|
|
| every20minutes after the hour0,,40)
plugins.scheduler.addCronJob('20mins','0 0/20 * * * ?',method seconds in the future)
// |
|
|
|
| addajobthatrunseverydayat23:30betweennowand5daysfromnowvardateNownewDate(;date5Days(dateNow.getTime()+5*24*60*60*1000();
startDate.setTime(startDate.getTime()+20000);
var endDate = new Date(startDate.getTime()+100000);
plugins.scheduler. |
|
|
|
| addCronJob23:30'0 30 23 ? * *'dateNowdate5Days)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addCronJob-String_String_Function_Date_Date|class=node}{tr:id=name}{td}h6.addCronJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addCronJob{span}{span:id=iets|style=float: left;}\(jobname, cronTimings, method, startDate, endDate){span}{td}{tr}{tr:id=des}{td}{sub-section:addCronJob-String_String_Function_Date_Date_des|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_Date_des|trigger=none|class=sIndent}Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addCronJob-String_String_Function_Date_Date_snc|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_Date_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addCronJob-String_String_Function_Date_Date_prs|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_Date_prs|trigger=none|class=sIndent}\{[String]} jobname
\{[String]} cronTimings
\{[Function]} method
\{[Date]} startDate
\{[Date]} endDate
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addCronJob-String_String_Function_Date_Date_ret|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_Date_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addCronJob-String_String_Function_Date_Date_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_Date_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addCronJob-String_String_Function_Date_Date_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_Date_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addCronJob-String_String_Function_Date_Date_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_Date_sam|trigger=none}{code:language=javascript}
// see: http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html for more info
Table Body (tbody) |
---|
id | addJob-String_Date_Function_Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobname, startDate, method, repeatInterval, repeatCount) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a job to the scheduler. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // 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) |
|
|
|
|
Table Body (tbody) |
---|
id | addJob-String_Date_Function_Number_Number_Date |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobName, startDate, method, repeatInterval, repeatCount, endDate) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a job to the scheduler. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // 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) |
|
|
|
|
Table Body (tbody) |
---|
id | addJob-String_Date_Function_Number_Number_Date_ObjectArray |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobname, startDate, method, repeatInterval, repeatCount, endDate, arguments) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a job to the scheduler. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // add a job that runs |
|
|
|
| every minutesafterhour (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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addCronJob-String_String_Function_Date_Date_ObjectArray|class=node}{tr:id=name}{td}h6.addCronJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addCronJob{span}{span:id=iets|style=float: left;}\(jobname, cronTimings, method, startDate, endDate, arguments){span}{td}{tr}{tr:id=des}{td}{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_des|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_des|trigger=none|class=sIndent}Adds a cron job to the scheduler. A cron job must have at least one minute between each execution (otherwise it won't execute).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_snc|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_prs|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_prs|trigger=none|class=sIndent}\{[String]} jobname
\{[String]} cronTimings
\{[Function]} method
\{[Date]} startDate
\{[Date]} endDate
\{[Object]\[]} arguments
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_ret|trigger=button|text=}{sub-section}{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addCronJob-String_String_Function_Date_Date_ObjectArray_sam|trigger=none}{code:language=javascript}
// 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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addJob-String_Date_Function|class=node}{tr:id=name}{td}h6.addJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addJob{span}{span:id=iets|style=float: left;}\(jobname, startDate, method){span}{td}{tr}{tr:id=des}{td}{sub-section:addJob-String_Date_Function_des|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_des|trigger=none|class=sIndent}Adds a job to the scheduler.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addJob-String_Date_Function_snc|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addJob-String_Date_Function_prs|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_prs|trigger=none|class=sIndent}\{[String]} jobname
\{[Date]} startDate
\{[Function]} method
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addJob-String_Date_Function_ret|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addJob-String_Date_Function_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addJob-String_Date_Function_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addJob-String_Date_Function_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_sam|trigger=none}{code:language=javascript}
// 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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addJob-String_Date_Function_Number|class=node}{tr:id=name}{td}h6.addJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addJob{span}{span:id=iets|style=float: left;}\(jobname, startDate, method, repeatInterval){span}{td}{tr}{tr:id=des}{td}{sub-section:addJob-String_Date_Function_Number_des|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_des|trigger=none|class=sIndent}Adds a job to the scheduler.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addJob-String_Date_Function_Number_snc|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addJob-String_Date_Function_Number_prs|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_prs|trigger=none|class=sIndent}\{[String]} jobname
\{[Date]} startDate
\{[Function]} method
\{[Number]} repeatInterval -- ms
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addJob-String_Date_Function_Number_ret|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addJob-String_Date_Function_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addJob-String_Date_Function_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addJob-String_Date_Function_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_sam|trigger=none}{code:language=javascript}
// 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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addJob-String_Date_Function_Number_Number|class=node}{tr:id=name}{td}h6.addJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addJob{span}{span:id=iets|style=float: left;}\(jobname, startDate, method, repeatInterval, repeatCount){span}{td}{tr}{tr:id=des}{td}{sub-section:addJob-String_Date_Function_Number_Number_des|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_des|trigger=none|class=sIndent}Adds a job to the scheduler.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addJob-String_Date_Function_Number_Number_snc|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addJob-String_Date_Function_Number_Number_prs|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_prs|trigger=none|class=sIndent}\{[String]} jobname
\{[Date]} startDate
\{[Function]} method
\{[Number]} repeatInterval -- ms
\{[Number]} repeatCount
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addJob-String_Date_Function_Number_Number_ret|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addJob-String_Date_Function_Number_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addJob-String_Date_Function_Number_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addJob-String_Date_Function_Number_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_sam|trigger=none}{code:language=javascript}
// 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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addJob-String_Date_Function_Number_Number_Date|class=node}{tr:id=name}{td}h6.addJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addJob{span}{span:id=iets|style=float: left;}\(jobName, startDate, method, repeatInterval, repeatCount, endDate){span}{td}{tr}{tr:id=des}{td}{sub-section:addJob-String_Date_Function_Number_Number_Date_des|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_Date_des|trigger=none|class=sIndent}Adds a job to the scheduler.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_snc|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_Date_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_prs|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_Date_prs|trigger=none|class=sIndent}\{[String]} jobName
\{[Date]} startDate
\{[Function]} method
\{[Number]} repeatInterval -- ms
\{[Number]} repeatCount
\{[Date]} endDate
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_ret|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_Date_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_Date_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_Date_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_Date_sam|trigger=none}{code:language=javascript}
// 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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addJob-String_Date_Function_Number_Number_Date_ObjectArray|class=node}{tr:id=name}{td}h6.addJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addJob{span}{span:id=iets|style=float: left;}\(jobname, startDate, method, repeatInterval, repeatCount, endDate, arguments){span}{td}{tr}{tr:id=des}{td}{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_des|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_des|trigger=none|class=sIndent}Adds a job to the scheduler.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_snc|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_prs|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_prs|trigger=none|class=sIndent}\{[String]} jobname
\{[Date]} startDate
\{[Function]} method
\{[Number]} repeatInterval -- ms
\{[Number]} repeatCount
\{[Date]} endDate
\{[Object]\[]} arguments
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_ret|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_Number_Number_Date_ObjectArray_sam|trigger=none}{code:language=javascript}
// 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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=addJob-String_Date_Function_ObjectArray|class=node}{tr:id=name}{td}h6.addJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addJob{span}{span:id=iets|style=float: left;}\(jobname, startDate, method, arguments){span}{td}{tr}{tr:id=des}{td}{sub-section:addJob-String_Date_Function_ObjectArray_des|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_ObjectArray_des|trigger=none|class=sIndent}Adds a job to the scheduler.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addJob-String_Date_Function_ObjectArray_snc|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_ObjectArray_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addJob-String_Date_Function_ObjectArray_prs|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_ObjectArray_prs|trigger=none|class=sIndent}\{[String]} jobname
\{[Date]} startDate
\{[Function]} method
\{[Object]\[]} arguments
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addJob-String_Date_Function_ObjectArray_ret|trigger=button|text=}{sub-section}{sub-section:addJob-String_Date_Function_ObjectArray_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addJob-String_Date_Function_ObjectArray_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_ObjectArray_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addJob-String_Date_Function_ObjectArray_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_ObjectArray_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addJob-String_Date_Function_ObjectArray_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addJob-String_Date_Function_ObjectArray_sam|trigger=none}{code:language=javascript}
// 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)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentJobNames|class=node}{tr:id=name}{td}h6.getCurrentJobNames{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getCurrentJobNames{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getCurrentJobNames_des|trigger=button|text=}{sub-section}{sub-section:getCurrentJobNames_des|trigger=none|class=sIndent}Returns an array with the current jobs.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getCurrentJobNames_snc|trigger=button|text=}{sub-section}{sub-section:getCurrentJobNames_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getCurrentJobNames_prs|trigger=button|text=}{sub-section}{sub-section:getCurrentJobNames_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getCurrentJobNames_ret|trigger=button|text=}{sub-section}{sub-section:getCurrentJobNames_ret|trigger=none|class=sIndent}[String]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getCurrentJobNames_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentJobNames_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getCurrentJobNames_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentJobNames_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getCurrentJobNames_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getCurrentJobNames_sam|trigger=none}{code:language=javascript}
plugins.scheduler.getCurrentJobNames()
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLastRunJobName|class=node}{tr:id=name}{td}h6.getLastRunJobName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getLastRunJobName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getLastRunJobName_des|trigger=button|text=}{sub-section}{sub-section:getLastRunJobName_des|trigger=none|class=sIndent}Returns the last job run from the scheduler.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getLastRunJobName_snc|trigger=button|text=}{sub-section}{sub-section:getLastRunJobName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getLastRunJobName_prs|trigger=button|text=}{sub-section}{sub-section:getLastRunJobName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getLastRunJobName_ret|trigger=button|text=}{sub-section}{sub-section:getLastRunJobName_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getLastRunJobName_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLastRunJobName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getLastRunJobName_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLastRunJobName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getLastRunJobName_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLastRunJobName_sam|trigger=none}{code:language=javascript}
plugins.scheduler.getLastRunJobName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeJob|class=node}{tr:id=name}{td}h6.removeJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}removeJob{span}{span:id=iets|style=float: left;}\(jobname){span}{td}{tr}{tr:id=des}{td}{sub-section:removeJob_des|trigger=button|text=}{sub-section}{sub-section:removeJob_des|trigger=none|class=sIndent}Removes a job from the scheduler.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:removeJob_snc|trigger=button|text=}{sub-section}{sub-section:removeJob_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:removeJob_prs|trigger=button|text=}{sub-section}{sub-section:removeJob_prs|trigger=none|class=sIndent}\{[String]} jobname
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:removeJob_ret|trigger=button|text=}{sub-section}{sub-section:removeJob_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:removeJob_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:removeJob_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:removeJob_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:removeJob_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:removeJob_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:removeJob_sam|trigger=none}{code:language=javascript}
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) |
|
|
|
|
Table Body (tbody) |
---|
id | addJob-String_Date_Function_ObjectArray |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(jobname, startDate, method, arguments) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a job to the scheduler. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // 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) |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getCurrentJobNames |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an array with the current jobs. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| plugins.scheduler.getCurrentJobNames() |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getLastRunJobName |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the last job run from the scheduler. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| plugins.scheduler.getLastRunJobName(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Removes a job from the scheduler. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // removes a job 'myjob' from the scheduler
plugins.scheduler.removeJob('myjob'); |
|
|
|
|
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |