GetWaitingRoomEventResult

data class GetWaitingRoomEventResult(val createdOn: String, val customPageHtml: String, val description: String, val disableSessionRenewal: Boolean, val eventEndTime: String, val eventId: String? = null, val eventStartTime: String, val id: String, val modifiedOn: String, val name: String, val newUsersPerMinute: Int, val prequeueStartTime: String, val queueingMethod: String, val sessionDuration: Int, val shuffleAtEventStart: Boolean, val suspended: Boolean, val totalActiveUsers: Int, val waitingRoomId: String, val zoneId: String)

A collection of values returned by getWaitingRoomEvent.

Constructors

Link copied to clipboard
constructor(createdOn: String, customPageHtml: String, description: String, disableSessionRenewal: Boolean, eventEndTime: String, eventId: String? = null, eventStartTime: String, id: String, modifiedOn: String, name: String, newUsersPerMinute: Int, prequeueStartTime: String, queueingMethod: String, sessionDuration: Int, shuffleAtEventStart: Boolean, suspended: Boolean, totalActiveUsers: Int, waitingRoomId: String, zoneId: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard

If set, the event will override the waiting room's custom_page_html property while it is active. If null, the event will inherit it.

Link copied to clipboard

A note that you can use to add more details about the event.

Link copied to clipboard

If set, the event will override the waiting room's disable_session_renewal property while it is active. If null, the event will inherit it.

Link copied to clipboard

An ISO 8601 timestamp that marks the end of the event.

Link copied to clipboard
val eventId: String? = null
Link copied to clipboard

An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before event_end_time.

Link copied to clipboard
val id: String

The ID of this resource.

Link copied to clipboard
Link copied to clipboard

A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.

Link copied to clipboard

If set, the event will override the waiting room's new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event's total_active_users property is also set.

Link copied to clipboard

An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before event_start_time.

Link copied to clipboard

If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.

Link copied to clipboard

If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.

Link copied to clipboard

If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.

Link copied to clipboard

Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.

Link copied to clipboard

If set, the event will override the waiting room's total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event's new_users_per_minute property is also set.

Link copied to clipboard
Link copied to clipboard

Identifier