SessionInfo

@Serializable
data class SessionInfo(val guid: String, val label: String, val symbol: String? = null, val performanceOrder: PerformanceOrder, val timeWindowGuids: List<String>? = null, val minutesToComplete: Int? = null, val notifications: List<NotificationInfo>? = null, val type: String? = null)

Information about a session in order to render it in a UI prior to execution.

Parameters

guid

The unique identifier for this model.

label

A required name for this session that will be shown to schedule authors, and can be used as a label for participants if no label can be found.

symbol

A unicode symbol or token identifier (32 characters or less) for a compact/symbolic representation of a session in UI tools.

performanceOrder
timeWindowGuids

A list of all the time window GUIDs for this session. The number of time windows in a session can be useful information for some UI grouping tasks.

minutesToComplete
notifications
type

SessionInfo

Constructors

Link copied to clipboard
constructor(guid: String, label: String, symbol: String? = null, performanceOrder: PerformanceOrder, timeWindowGuids: List<String>? = null, minutesToComplete: Int? = null, notifications: List<NotificationInfo>? = null, type: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "guid")
val guid: String
Link copied to clipboard
@SerialName(value = "label")
val label: String
Link copied to clipboard
@SerialName(value = "minutesToComplete")
val minutesToComplete: Int? = null
Link copied to clipboard
@SerialName(value = "notifications")
val notifications: List<NotificationInfo>? = null
Link copied to clipboard
@SerialName(value = "performanceOrder")
val performanceOrder: PerformanceOrder
Link copied to clipboard
@SerialName(value = "symbol")
val symbol: String? = null
Link copied to clipboard
@SerialName(value = "timeWindowGuids")
val timeWindowGuids: List<String>? = null
Link copied to clipboard
@SerialName(value = "type")
val type: String? = null