To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Group: AI Agents
Properties
| Property | Returns | Description |
|---|---|---|
| instructions | String | Instructions run when this timer fires. |
| name | String | Portable identifier for this timer, matched against a user override's timer name and not itself editable via the withXXX methods. |
| timerMultiple | Integer | How many units between firings, eg 3 for "every 3 days". A value of -1 marks the timer as disabled by a user override. |
| timerTime | String | If set, the time of day this timer's timeout is adjusted to. |
| timerUnit | String | The time unit this timer's interval is measured in, one of the values returned by AgentDef.getTimerUnits. |
Methods
withInstructions(String newInstructions) · withTimerUnit(String newProp) · withTimerMultiple(Integer newProp) · withTimerTime(String newProp) · withRemoval() · getName() · getInstructions() · getTimerUnit() · getTimerMultiple() · getTimerTime()
withInstructions(String newInstructions)
Returns: AgentDefTimer
Returns a copy of this timer with the given instructions.
| Parameter | Description |
|---|---|
newInstructions | the instructions to run when the timer fires |
withTimerUnit(String newProp)
Returns: AgentDefTimer
Returns a copy of this timer with the given time unit.
| Parameter | Description |
|---|---|
newProp | the time unit the timer runs on, one of the values returned by AgentDef.getTimerUnits |
withTimerMultiple(Integer newProp)
Returns: AgentDefTimer
Returns a copy of this timer with the given firing interval.
| Parameter | Description |
|---|---|
newProp | how many units between firings, eg 3 for "every 3 days" |
withTimerTime(String newProp)
Returns: AgentDefTimer
Returns a copy of this timer with the given time of day.
| Parameter | Description |
|---|---|
newProp | if set, the time of day the timeout is adjusted to |
withRemoval()
Returns: AgentDefTimer
Returns a copy of this timer configured to disable it. Used for building a user override that switches off a built-in timer, by setting its firing interval to -1.
getName()
Returns: String
Portable identifier for this timer, matched against a user override's timer name and not itself editable via the withXXX methods.
getInstructions()
Returns: String
Instructions run when this timer fires.
getTimerUnit()
Returns: String
The time unit this timer's interval is measured in, one of the values returned by AgentDef.getTimerUnits.
getTimerMultiple()
Returns: Integer
How many units between firings, eg 3 for "every 3 days". A value of -1 marks the timer as disabled by a user override.
getTimerTime()
Returns: String
If set, the time of day this timer's timeout is adjusted to.
© 2025 Kademi Ltd