View Source

{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}void{td}{td}[#addCronJob]\(jobname, cronTimings, globalMethod, startDate, endDate, arguments)
Adds a cron job to the scheduler.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addJob]\(jobname, startDate, globalMethod, repeatInterval(ms), repeatCount, endDate, arguments]]/ [arguments)
Adds a job to the scheduler.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getCurrentJobNames]\()
Returns an array with the current jobs.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getLastRunJobName]\()
{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#removeJob]\(jobname)
Removes a job from the scheduler.{td}{tr}{tbody}{table}\\{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=389FDC43-B7C4-4361-B659-778A2B8BE483}{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, globalMethod, startDate, endDate, arguments){span}{td}{tr}{tr:id=des}{td}{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_des|text=|trigger=button}{sub-section}{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_des|trigger=none|class=sIndent}Adds a cron job to the scheduler.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_prs|trigger=none}jobname
cronTimings
globalMethod
\[startDate\]
\[endDate\]
\[arguments\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_ret|text=|trigger=button}{sub-section}{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_see|text=|trigger=button}{sub-section}{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_see|text=|trigger=button}{sub-section}{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_sam|text=|trigger=button}{sub-section}{sub-section:389FDC43-B7C4-4361-B659-778A2B8BE483_sam|class=sIndent|trigger=none}{code:language=javascript}
// see: http://quartz.sourceforge.net/firstTutorial.html#cronTriggers 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)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=F4A9ED9D-4017-4E93-A965-2E6AC0E05009}{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:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_des|text=|trigger=button}{sub-section}{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_des|trigger=none|class=sIndent}Adds a job to the scheduler.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_prs|trigger=none}jobname
startDate
globalMethod
\[repeatInterval(ms)\]
\[repeatCount\]
\[endDate\]
\[arguments]]/ [arguments\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_ret|text=|trigger=button}{sub-section}{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_see|text=|trigger=button}{sub-section}{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_see|text=|trigger=button}{sub-section}{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_sam|text=|trigger=button}{sub-section}{sub-section:F4A9ED9D-4017-4E93-A965-2E6AC0E05009_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=20337F4C-4E8E-4CBF-8A88-A5D6970D4830}{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:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_des|text=|trigger=button}{sub-section}{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_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:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_ret|text=|trigger=button}{sub-section}{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_ret|trigger=none|class=sIndent}[String]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_see|text=|trigger=button}{sub-section}{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_see|text=|trigger=button}{sub-section}{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_sam|text=|trigger=button}{sub-section}{sub-section:20337F4C-4E8E-4CBF-8A88-A5D6970D4830_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=A6A084CD-1714-4EA8-8EEE-24777FD3AA5F}{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:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_des|text=|trigger=button}{sub-section}{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_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:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_ret|text=|trigger=button}{sub-section}{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_see|text=|trigger=button}{sub-section}{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_see|text=|trigger=button}{sub-section}{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_sam|text=|trigger=button}{sub-section}{sub-section:A6A084CD-1714-4EA8-8EEE-24777FD3AA5F_sam|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FCDAC563-A67A-471B-BC17-38FA372C1558}{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:FCDAC563-A67A-471B-BC17-38FA372C1558_des|text=|trigger=button}{sub-section}{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_des|trigger=none|class=sIndent}Removes a job from the scheduler.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_prs|trigger=none}jobname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_ret|text=|trigger=button}{sub-section}{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_see|text=|trigger=button}{sub-section}{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_see|text=|trigger=button}{sub-section}{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_sam|text=|trigger=button}{sub-section}{sub-section:FCDAC563-A67A-471B-BC17-38FA372C1558_sam|class=sIndent|trigger=none}{code:language=javascript}
// removes a job 'myjob' from the scheduler
plugins.scheduler.removeJob('myjob')
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}