GetWaitingRoomResult

data class GetWaitingRoomResult(val additionalRoutes: List<GetWaitingRoomAdditionalRoute>, val cookieAttributes: GetWaitingRoomCookieAttributes, val cookieSuffix: String, val createdOn: String, val customPageHtml: String, val defaultTemplateLanguage: String, val description: String, val disableSessionRenewal: Boolean, val enabledOriginCommands: List<String>, val host: String, val id: String, val jsonResponseEnabled: Boolean, val modifiedOn: String, val name: String, val newUsersPerMinute: Int, val nextEventPrequeueStartTime: String, val nextEventStartTime: String, val path: String, val queueAll: Boolean, val queueingMethod: String, val queueingStatusCode: Int, val sessionDuration: Int, val suspended: Boolean, val totalActiveUsers: Int, val turnstileAction: String, val turnstileMode: String, val waitingRoomId: String? = null, val zoneId: String)

A collection of values returned by getWaitingRoom.

Constructors

Link copied to clipboard
constructor(additionalRoutes: List<GetWaitingRoomAdditionalRoute>, cookieAttributes: GetWaitingRoomCookieAttributes, cookieSuffix: String, createdOn: String, customPageHtml: String, defaultTemplateLanguage: String, description: String, disableSessionRenewal: Boolean, enabledOriginCommands: List<String>, host: String, id: String, jsonResponseEnabled: Boolean, modifiedOn: String, name: String, newUsersPerMinute: Int, nextEventPrequeueStartTime: String, nextEventStartTime: String, path: String, queueAll: Boolean, queueingMethod: String, queueingStatusCode: Int, sessionDuration: Int, suspended: Boolean, totalActiveUsers: Int, turnstileAction: String, turnstileMode: String, waitingRoomId: String? = null, zoneId: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.

Link copied to clipboard

Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.

Link copied to clipboard

Appends a '' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(cfwaitingroom). If cookie_suffix is "abcd", the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes.

Link copied to clipboard
Link copied to clipboard

Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custompagehtml is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val id: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val waitingRoomId: String? = null
Link copied to clipboard

Identifier