Cluster.scheduleRepeatingEvent()

Signature

void scheduleRepeatingEvent(String schedulerName, String workKey, SimpleEvent event, DateTime startingDate, long interval)

Domain

ACTION

Description

Schedules a simple event to be sent to the default destination beginning on startingDate, and repeating every interval milliseconds. It is recommended to specify starting date/time using DateTime.createTime() e.g. DateTime.createTime(2014, 0, 1, 0, 0, 0, null).

Parameters

NameTypeDescription
schedulerNameStringA unique id.
workKeyStringA unique key that identifies the work item. Hint: If persistence is used, removing previously scheduled repeating event should be considered. This will prevent creating too many repeating events, or violating unique keys. See Cluster.removeSchedule()
eventSimpleEventThe simple event to be scheduled.
startingDateDateTimeThe starting date/time of repeating scheduled event (date/time will be rolled into future, if defined in the past).
intervallongThe repeat interval of the scheduled event (if 0, event will be scheduled once for the exact date/time specified).

Returns

TypeDescription
void