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 * * * ?', |
|
|
|
| globalMethodmethod)
// 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 ? * *', |
|
|
|
| globalMethodmethod,dateNow,date5Days) |
|
|
|
|
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=48A0B259-8A55-4543-98FB-EC02C1CA2737}{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, globalMethod, repeatInterval(ms), repeatCount, endDate, arguments]]/ [arguments){span}{td}{tr}{tr:id=des}{td}{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_des|text=|trigger=button}{sub-section}{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_des|trigger=none|class=sIndent}Adds a job to the scheduler.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_prs|trigger=none}jobname
startDate
globalMethod
\[repeatInterval(ms)\]
\[repeatCount\]
\[endDate\]
\[arguments]]/ [arguments\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_ret|text=|trigger=button}{sub-section}{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_see|text=|trigger=button}{sub-section}{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_see|text=|trigger=button}{sub-section}{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_sam|text=|trigger=button}{sub-section}{sub-section:48A0B259-8A55-4543-98FB-EC02C1CA2737_sam|class=sIndent|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,globalMethod,20000,40,endDate)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=014C6B52-17B6-4A81-AB98-EFD3D3F61093}{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:014C6B52-17B6-4A81-AB98-EFD3D3F61093_des|text=|trigger=button}{sub-section}{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_des|trigger=none|class=sIndent}Returns an array with the current jobs.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_ret|text=|trigger=button}{sub-section}{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_ret|trigger=none|class=sIndent}[String]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_see|text=|trigger=button}{sub-section}{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_see|text=|trigger=button}{sub-section}{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_sam|text=|trigger=button}{sub-section}{sub-section:014C6B52-17B6-4A81-AB98-EFD3D3F61093_sam|class=sIndent|trigger=none}{code:language=javascript}
// Returns an array of current jobnames
plugins.scheduler.getCurrentJobNames()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=1159CF52-E0E1-40A8-9E2F-C2C612D89229}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_des|text=|trigger=button}{sub-section}{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_ret|text=|trigger=button}{sub-section}{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_see|text=|trigger=button}{sub-section}{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_see|text=|trigger=button}{sub-section}{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_sam|text=|trigger=button}{sub-section}{sub-section:1159CF52-E0E1-40A8-9E2F-C2C612D89229_sam|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=F1ACE388-7314-4865-B176-9B16ABE0E3FC}{tr:id=name}{td}h6.removeJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{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:F1ACE388-7314-4865-B176-9B16ABE0E3FC_des|text=|trigger=button}{sub-section}{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_des|trigger=none|class=sIndent}Removes a job from the scheduler.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_prs|trigger=none}jobname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_ret|text=|trigger=button}{sub-section}{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_see|text=|trigger=button}{sub-section}{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_see|text=|trigger=button}{sub-section}{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_sam|text=|trigger=button}{sub-section}{sub-section:F1ACE388-7314-4865-B176-9B16ABE0E3FC_sam|class=sIndent|trigger=none}{code:language=javascript}
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) |
|
|
|
|
Table Body (tbody) |
---|
id | addCronJob-String_String_Function_Date_Date_ObjectArray |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
addCronJob |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
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 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 |
---|
| 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 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_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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |