A session is identified by its session id (
sid), returned when you start a session. Pass that sid to every subsequent session method.getSessionReservations
Returns the sessions currently reserved/scheduled for your organization.Parameters
Player | table | number
required
The requesting host. See the actor object.
Returns
object[]
An array of reservation records. Empty if there are none or the request failed.
startSession
Starts hosting a session.Parameters
Player | table | number
required
The host starting the session. See the actor object.
table
required
Session options.
Returns
table | nil
The started-session payload (including its
sid) on success, or nil on failure.Example
sessionUpdateAttendees
Adds or removes attendees from a running session.Parameters
Player | table | number
required
The host performing the update.
table
required
Returns
table | nil
The update result on success, or
nil on failure.sessionUpdateMark
Sets or clears a phase mark for a specific attendee (e.g. marking a checkpoint as passed).Parameters
Player | table | number
required
The host performing the update.
table
required
Returns
table | nil
The update result on success, or
nil on failure.sessionUpdateStrike
Adds or removes a strike against an attendee.Parameters
Player | table | number
required
The host performing the update.
table
required
Returns
table | nil
The update result on success, or
nil on failure.sessionUpdatePhase
Adds, removes, or renames a phase within a session.Parameters
Player | table | number
required
The host performing the update.
table
required
Returns
table | nil
The update result on success, or
nil on failure.sessionUpdateSession
Transitions the session’s state (e.g. moving it to a new status).Parameters
Player | table | number
required
The host performing the update.
table
required
Returns
table | nil
The update result on success, or
nil on failure.