Page History

table

Div

style	display:none

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.

Div

id	description

Note

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

Cache

id
index	true
refresh	100d

...

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
void

...

doc
showRefresh	true
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes

2100%

height: 30px;

2

Supported Clients

sWordListINLINE

SmartClient

sWordListINLINE

WebClient

sWordListINLINE

NGClient

servoy sSummary

12%

30%

58%

height: 30px;

3

Methods Summary

void

Adds a cron job to the scheduler.

...

void

...

Adds a cron job to the scheduler.

...

void

...

Adds a cron job to the scheduler.

...

void

...

Adds a cron job to the scheduler.

...

void

...

Adds a job to the scheduler.

...

void

...

Adds a job to the scheduler.

...

void

...

Adds a job to the scheduler.

...

void

...

Adds a job to the scheduler.

...

void

...

Adds a job to the scheduler.

...

void

...

Table Cell (td)
String[]

...

Adds a job to the scheduler.

...

Table Cell (td)
String

...

Returns an array with the current jobs.

...

Returns the last job run from the scheduler.

...

Table Cell (td)
Boolean

...

Removes a job from the scheduler.

...

function

...

servoy sDetail

...

2

...

100%

...

Col

...

height:30px

...

Table Head (th)

colspan	2

Method Details

...

id	addCronJob-String_String_Function

Table Row (tr)

id	name

Table Cell (td)
addCronJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCronJob

...

2

Methods Details

addCronJob

name

addCronJob(jobname, cronTimings, method)

...

des

...

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

...

prs

...

Parameters

...

id	addCronJob-String_String_Function_Date

Table Row (tr)

id	name

Table Cell (td)
addCronJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCronJob

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

jobname

;

cronTimings

;

method

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addCronJob

name

addCronJob(jobname, cronTimings, method, startDate)

...

des

...

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

...

prs

...

Parameters

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	addCronJob-String_String_Function_Date_Date

Table Row (tr)

id	name

Table Cell (td)
addCronJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCronJob

...

jobname

;

cronTimings

;

method

;

startDate

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addCronJob

name

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

...

des

...

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

...

prs

...

Parameters

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	addCronJob-String_String_Function_Date_Date_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
addCronJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addCronJob

...

jobname

;

cronTimings

;

method

;

startDate

;

endDate

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addCronJob

name

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

...

des

...

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

...

prs

...

Parameters

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	addJob-String_Date_Function

Table Row (tr)

id	name

Table Cell (td)
addJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addJob

...

jobname

;

cronTimings

;

method

;

startDate

;

endDate

;

arguments

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addJob

name

addJob(jobname, startDate, method)

...

des

...

sIndent

Adds a job to the scheduler.

...

prs

...

Parameters

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	addJob-String_Date_Function_Number

Table Row (tr)

id	name

Table Cell (td)
addJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addJob

...

jobname

;

startDate

;

method

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addJob

name

addJob(jobname, startDate, method, repeatInterval)

...

des

...

sIndent

Adds a job to the scheduler.

...

prs

...

Parameters

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	addJob-String_Date_Function_Number_Number

Table Row (tr)

id	name

Table Cell (td)
addJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addJob

...

jobname

;

startDate

;

method

;

repeatInterval

ms

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addJob

name

addJob(jobname, startDate, method, repeatInterval, repeatCount)

...

des

...

sIndent

Adds a job to the scheduler.

...

prs

...

Parameters

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	addJob-String_Date_Function_Number_Number_Date

Table Row (tr)

id	name

Table Cell (td)
addJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addJob

...

jobname

;

startDate

;

method

;

repeatInterval

ms

repeatCount

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addJob

name

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

...

des

...

sIndent

Adds a job to the scheduler.

...

prs

...

Parameters

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	addJob-String_Date_Function_Number_Number_Date_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
addJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addJob

...

jobName

;

startDate

;

method

;

repeatInterval

ms

repeatCount

;

endDate

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addJob

name

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

...

des

...

sIndent

Adds a job to the scheduler.

...

prs

...

Parameters

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	addJob-String_Date_Function_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
addJob

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addJob

...

jobname

;

startDate

;

method

;

repeatInterval

ms

repeatCount

;

endDate

;

arguments

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addJob

name

addJob(jobname, startDate, method, arguments)

...

des

...

sIndent

Adds a job to the scheduler.

...

prs

...

Parameters

...

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentJobNames

Table Row (tr)

id	name

Table Cell (td)
getCurrentJobNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getCurrentJobNames

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an array with the current jobs.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.scheduler.getCurrentJobNames()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLastRunJobName

Table Row (tr)

id	name

Table Cell (td)
getLastRunJobName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getLastRunJobName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the last job run from the scheduler.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.scheduler.getLastRunJobName();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

...

id	removeJob-String

Table Row (tr)

id	name

Table Cell (td)
removeJob

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeJob

Span
(jobname)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a job from the scheduler.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} jobname

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

...

class	lastDetailRow

...

sIndent

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

jobname

;

startDate

;

method

;

arguments

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getCurrentJobNames

name

getCurrentJobNames()

des

sIndent

Returns an array with the current jobs.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getLastRunJobName

name

getLastRunJobName()

des

sIndent

Returns the last job run from the scheduler.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

removeJob

name

removeJob(jobname)

des

sIndent

Removes a job from the scheduler.

prs

Parameters

sIndent

jobname

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 28

New Version 29

Key

addCronJob

addCronJob(jobname, cronTimings, method)

addCronJob

addCronJob(jobname, cronTimings, method, startDate)

addCronJob

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

des

addCronJob

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

des

addJob

addJob(jobname, startDate, method)

des

addJob

addJob(jobname, startDate, method, repeatInterval)

des

addJob

addJob(jobname, startDate, method, repeatInterval, repeatCount)

addJob

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

addJob

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

addJob

addJob(jobname, startDate, method, arguments)

getCurrentJobNames

getLastRunJobName

removeJob

getCurrentJobNames()

getLastRunJobName()

removeJob(jobname)