Skip to content

WaitingRoomEventProps

Properties for defining a WaitingRoomEvent.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-waitingroomevent

Initializer

using AlibabaCloud.SDK.ROS.CDK.Esa;
new WaitingRoomEventProps {
    object EndTime,
    object NewUsersPerMinute,
    object QueuingMethod,
    object QueuingStatusCode,
    object SessionDuration,
    object SiteId,
    object StartTime,
    object TotalActiveUsers,
    object WaitingRoomEventName,
    object WaitingRoomType,
    object CustomPageHtml = null,
    object Description = null,
    object DisableSessionRenewalEnable = null,
    object JsonResponseEnable = null,
    object Language = null,
    object PreQueueEnable = null,
    object PreQueueStartTime = null,
    object RandomPreQueueEnable = null,
    object WaitingRoomId = null
};

Properties

Name Type Description
EndTime object Property endTime: The timestamp of the end time of the event.
NewUsersPerMinute object Property newUsersPerMinute: Number of new users per minute.
QueuingMethod object Property queuingMethod: Way of queuing.
QueuingStatusCode object Property queuingStatusCode: Waiting room status code.
SessionDuration object Property sessionDuration: User session duration in minutes.
SiteId object Property siteId: The site ID, which can be obtained by calling the ListSites API.
StartTime object Property startTime: The timestamp of the event start time.
TotalActiveUsers object Property totalActiveUsers: Total number of active users.
WaitingRoomEventName object Property waitingRoomEventName: Event name, custom event description.
WaitingRoomType object Property waitingRoomType: Waiting room 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: Disable session renewal.
JsonResponseEnable object Property jsonResponseEnable: JSON response switch.
Language object Property language: Default language setting.
PreQueueEnable object Property preQueueEnable: Pre-queue switch.
PreQueueStartTime object Property preQueueStartTime: Pre-queue start time.
RandomPreQueueEnable object Property randomPreQueueEnable: Random queue switch.
WaitingRoomId object Property waitingRoomId: Waiting room ID, used to identify a specific waiting room.

EndTimeRequired

public object EndTime { get; set; }
  • Type: object

Property endTime: The timestamp of the end time of the event.


NewUsersPerMinuteRequired

public object NewUsersPerMinute { get; set; }
  • Type: object

Property newUsersPerMinute: Number of new users per minute.


QueuingMethodRequired

public object QueuingMethod { get; set; }
  • Type: object

Property queuingMethod: Way of queuing.

Value:

  • random: random.
  • fifo: first in, first out.
  • passthrough: through.
  • reject-all: reject all.

QueuingStatusCodeRequired

public object QueuingStatusCode { get; set; }
  • Type: object

Property queuingStatusCode: Waiting room status code.

Value:

  • 200
  • 202
  • 429.

SessionDurationRequired

public object SessionDuration { get; set; }
  • Type: object

Property sessionDuration: User session duration in minutes.


SiteIdRequired

public object SiteId { get; set; }
  • Type: object

Property siteId: The site ID, which can be obtained by calling the ListSites API.


StartTimeRequired

public object StartTime { get; set; }
  • Type: object

Property startTime: The timestamp of the event start time.


TotalActiveUsersRequired

public object TotalActiveUsers { get; set; }
  • Type: object

Property totalActiveUsers: Total number of active users.


WaitingRoomEventNameRequired

public object WaitingRoomEventName { get; set; }
  • Type: object

Property waitingRoomEventName: Event name, custom event description.


WaitingRoomTypeRequired

public object WaitingRoomType { get; set; }
  • Type: object

Property waitingRoomType: Waiting room type.

The following types are supported:

  • default: the default type.
  • custom: 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: Disable session renewal.

Value:

  • on: open.
  • off: closed.

JsonResponseEnableOptional

public object JsonResponseEnable { get; set; }
  • Type: object

Property jsonResponseEnable: JSON response switch.

Value:

  • on: open.
  • off: closed.

LanguageOptional

public object Language { get; set; }
  • Type: object

Property language: Default language setting.

Values include:

  • enus: English.
  • zhcn: Simplified Chinese.
  • zhhk: Traditional Chinese.

PreQueueEnableOptional

public object PreQueueEnable { get; set; }
  • Type: object

Property preQueueEnable: Pre-queue switch.

  • on: open.
  • off: closed.

PreQueueStartTimeOptional

public object PreQueueStartTime { get; set; }
  • Type: object

Property preQueueStartTime: Pre-queue start time.


RandomPreQueueEnableOptional

public object RandomPreQueueEnable { get; set; }
  • Type: object

Property randomPreQueueEnable: Random queue switch.

  • on: open.
  • off: closed.

WaitingRoomIdOptional

public object WaitingRoomId { get; set; }
  • Type: object

Property waitingRoomId: Waiting room ID, used to identify a specific waiting room.

It can be obtained by calling the listwaitingroom interface.