WaitingRoomProps
Properties for defining a WaitingRoom.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-waitingroom
Initializer
using AlibabaCloud.SDK.ROS.CDK.Esa;
new WaitingRoomProps {
object CookieName,
object HostNameAndPath,
object NewUsersPerMinute,
object QueuingMethod,
object QueuingStatusCode,
object SessionDuration,
object SiteId,
object Status,
object TotalActiveUsers,
object WaitingRoomName,
object WaitingRoomType,
object CustomPageHtml = null,
object Description = null,
object DisableSessionRenewalEnable = null,
object JsonResponseEnable = null,
object Language = null,
object QueueAllEnable = null
};
Properties
| Name | Type | Description |
|---|---|---|
CookieName | object | Property cookieName: The name of the custom cookie. |
HostNameAndPath | object | Property hostNameAndPath: The hostname and path. |
NewUsersPerMinute | object | Property newUsersPerMinute: The maximum number of new users per minute. |
QueuingMethod | object | Property queuingMethod: The queuing method. |
QueuingStatusCode | object | Property queuingStatusCode: Waiting room status code. |
SessionDuration | object | Property sessionDuration: The maximum duration for which a session remains valid after a user leaves the origin. |
SiteId | object | Property siteId: The site ID. |
Status | object | Property status: Waiting room enabled status. |
TotalActiveUsers | object | Property totalActiveUsers: The maximum number of active users. |
WaitingRoomName | object | Property waitingRoomName: The name of the waiting room. |
WaitingRoomType | object | Property waitingRoomType: The type of the waiting room, support: - default: Indicates the default type. |
CustomPageHtml | object | Property customPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter. |
Description | object | Property description: Waiting room description. |
DisableSessionRenewalEnable | object | Property disableSessionRenewalEnable: Specifies whether to disable session renewal. |
JsonResponseEnable | object | Property jsonResponseEnable: The JSON response. |
Language | object | Property language: The language of the waiting room page. |
QueueAllEnable | object | Property queueAllEnable: Specifies whether to queue all requests. |
CookieNameRequired
public object CookieName { get; set; }
- Type: object
Property cookieName: The name of the custom cookie.
HostNameAndPathRequired
public object HostNameAndPath { get; set; }
- Type: object
Property hostNameAndPath: The hostname and path.
NewUsersPerMinuteRequired
public object NewUsersPerMinute { get; set; }
- Type: object
Property newUsersPerMinute: The maximum number of new users per minute.
QueuingMethodRequired
public object QueuingMethod { get; set; }
- Type: object
Property queuingMethod: The queuing method.
Value:
random: Users gain access to the origin randomly, regardless of the arrival time.fifo: Users gain access to the origin in order of arrival.Passthrough: Users pass through the waiting room and go straight to the origin.Reject-all: Users are blocked from reaching the origin.
QueuingStatusCodeRequired
public object QueuingStatusCode { get; set; }
- Type: object
Property queuingStatusCode: Waiting room status code.
Value:
200202429.
SessionDurationRequired
public object SessionDuration { get; set; }
- Type: object
Property sessionDuration: The maximum duration for which a session remains valid after a user leaves the origin.
Unit: minutes.
SiteIdRequired
public object SiteId { get; set; }
- Type: object
Property siteId: The site ID.
StatusRequired
public object Status { get; set; }
- Type: object
Property status: Waiting room enabled status.
Value:
- 'on': Enable waiting room
- 'off': Disabled waiting room
TotalActiveUsersRequired
public object TotalActiveUsers { get; set; }
- Type: object
Property totalActiveUsers: The maximum number of active users.
WaitingRoomNameRequired
public object WaitingRoomName { get; set; }
- Type: object
Property waitingRoomName: The name of the waiting room.
WaitingRoomTypeRequired
public object WaitingRoomType { get; set; }
- Type: object
Property waitingRoomType: The type of the waiting room, support: - default: Indicates the default type.
custom: indicates a custom type.
CustomPageHtmlOptional
public object CustomPageHtml { get; set; }
- Type: object
Property customPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter.
The incoming content needs to be base64 encoded.
DescriptionOptional
public object Description { get; set; }
- Type: object
Property description: Waiting room description.
DisableSessionRenewalEnableOptional
public object DisableSessionRenewalEnable { get; set; }
- Type: object
Property disableSessionRenewalEnable: Specifies whether to disable session renewal.
Value:
on: open.off: closed.
JsonResponseEnableOptional
public object JsonResponseEnable { get; set; }
- Type: object
Property jsonResponseEnable: The JSON response.
If the accept request header contains "application/json", JSON data is returned. Value:
on: open.off: closed.
LanguageOptional
public object Language { get; set; }
- Type: object
Property language: The language of the waiting room page.
When the waiting room type is the default type, it needs to be passed in. The following types are supported:
enus: English.zhcn: Simplified Chinese.zhhk: Traditional Chinese.
QueueAllEnableOptional
public object QueueAllEnable { get; set; }
- Type: object
Property queueAllEnable: Specifies whether to queue all requests.
Value:
on: open.off: closed.