Methods

action(id)

lib/Schedule/Controller.js, line 51

Call an action This method is called from within a plugin and sends the id, the scheduler determines what should then happen

Parameters:

Name	Type	Description
id	number

cleanConfig(config) → {Object}

lib/Schedule/Controller.js, line 83

Cleans the configuration to store in the database

Parameters:

Name	Type	Description
config	Object

Returns:

Object

eventLoadType(event) → {Object}

lib/Schedule/Controller.js, line 112

Loads plugin based parameters These parameters are dynamic and aren't stored to the database, but are needed for the front end. For example, the configuration description.

Parameters:

Name	Type	Description
event	Object

Returns:

Object - Event object with plugin passed params

eventWatch(config, add)

lib/Schedule/Controller.js, line 131

Register or unregister an event from being watched

Parameters:

Name	Type	Default	Description
config	Object
add	boolean	true	Add or remove the event from the watch schedule

findEventIndex(id) → {number}

lib/Schedule/Controller.js, line 153

Get event index from an event ID

Parameters:

Name	Type	Description
id	number

Returns:

number

protected getBankButton(button) → {Array.<number>}

lib/Schedule/Controller.js, line 163

Get the bank and button number from a string

Parameters:

Name	Type	Description
button	string

Returns:

Array.<number>

protected getNextId() → {number}

lib/Schedule/Controller.js, line 175

Get the next unique event ID

Returns:

number

getPlugin(type) → nullable {Object}

lib/Schedule/Controller.js, line 198

Gets the plugin from a request type

Parameters:

Name	Type	Description
type	string

Returns:

Object

getSchedule(socket, cb)

lib/Schedule/Controller.js, line 214

Sends the event list to the callback

Parameters:

Name	Type	Description
socket	SocketIO
cb	scheduleGetCb

initConfig()

lib/Schedule/Controller.js, line 225

Initialize the configuration and start any schedules

loadPlugins()

lib/Schedule/Controller.js, line 234

Loads plugins from the schedule plugin directory

saveSchedule(socket, newData, cb)

lib/Schedule/Controller.js, line 260

Replaced an event configuration

Parameters:

Name	Type	Description
socket	SocketIO
newData	Object
cb	scheduleSaveCb

saveToDb()

lib/Schedule/Controller.js, line 291

Saves to database

sendPlugins(socket, cb)

lib/Schedule/Controller.js, line 301

Parameters:

Name	Type	Description
socket	SocketIO
cb	pluginCallback

startSchedule()

lib/Schedule/Controller.js, line 312

Starts all event schedules

updateSchedule(socket, id, newData, cb)

lib/Schedule/Controller.js, line 324

Updates a schedule Minor updates and deletions

Parameters:

Name	Type	Description
socket	SocketIO
id	number	Event ID
newData	Object	If deleted property is set, event is deleted
cb	scheduleUpdateCb