Change to light theme (or icon here)

Timers

Timers

Contents

Description

Allows the setting, monitoring and triggering actions from timers. This gives teh ability to chain triggers/actions together with timed gaps etc

Triggers/Actions

Triggers and actions below are updated when the automatic document generation system is run and only contain triggers actions relating to this specific extension.

Table last updated: Thu, 24 Apr 2025 00:04:28 GMT

Triggers

name trigger description
TimerStart trigger_TimerStarted A timer was started
TimerEnd trigger_TimerEnded A timer has finished
TimerRunning trigger_TimerRunning A timer is running

Actions

name trigger description
TimerStart action_TimerStart Start/Restart a countdown timer, duration in seconds
TimerStop action_TimerStop Stop a running timer

"Timers" Extension Details...

Provides timers than can be used for things like triggering actions. Provides a method to create complex trigger action sequences by allowing chaining/delaying etc.
Source:

Methods

SaveConfigToServer()

Saves our config to the server
Source:

SendSettingsWidgetSmall(tochannel)

send some modal code
Parameters:
Name Type Description
tochannel String
Source:

StartOrRestartTimer(timerName)

Starts or restarts a time if one already exists
Parameters:
Name Type Description
timerName string
Source:

Timer(timerName)

Poll timer to check for expiry or update the time left value and sends out a trigger when the timer is updated or expired
Parameters:
Name Type Description
timerName object
Source:

findtriggerByMessageType(messagetype)

Finds a trigger by name
Parameters:
Name Type Description
messagetype string
Source:
Returns:
trigger

initialise(app, host, port, heartbeat)

Starts the extension using the given data.
Parameters:
Name Type Description
app object:Express
host string
port number
heartbeat number
Source:

onDataCenterConnect(socket)

Connection message handler
Parameters:
Name Type Description
socket *
Source:

onDataCenterDisconnect(reason)

Disconnection message sent from the server
Parameters:
Name Type Description
reason String
Source:

onDataCenterMessage(server_packet)

receives message from the socket
Parameters:
Name Type Description
server_packet data
Source:

sendEndTimer(timeData)

Sends out a trigger_TimerEnded when a timer ends
Parameters:
Name Type Description
timeData object
Source:

sendStartTimer(timeData)

sends out trigger_TimerStarted when a new timer is started
Parameters:
Name Type Description
timeData object
Source:

sendTimerData(timeData)

Sends out a trigger_TimerRunning message containing the current time left
Parameters:
Name Type Description
timeData object
Source: