Skip to content

WaitingRoomEventProps

Properties for defining a WaitingRoomEvent.

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

Initializer

import com.aliyun.ros.cdk.esa.WaitingRoomEventProps;
WaitingRoomEventProps.builder()
    .endTime(java.lang.String)
    .endTime(IResolvable)
    .newUsersPerMinute(java.lang.Number)
    .newUsersPerMinute(IResolvable)
    .queuingMethod(java.lang.String)
    .queuingMethod(IResolvable)
    .queuingStatusCode(java.lang.String)
    .queuingStatusCode(IResolvable)
    .sessionDuration(java.lang.Number)
    .sessionDuration(IResolvable)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
    .startTime(java.lang.String)
    .startTime(IResolvable)
    .totalActiveUsers(java.lang.Number)
    .totalActiveUsers(IResolvable)
    .waitingRoomEventName(java.lang.String)
    .waitingRoomEventName(IResolvable)
    .waitingRoomType(java.lang.String)
    .waitingRoomType(IResolvable)
//  .customPageHtml(java.lang.String)
//  .customPageHtml(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .disableSessionRenewalEnable(java.lang.String)
//  .disableSessionRenewalEnable(IResolvable)
//  .jsonResponseEnable(java.lang.String)
//  .jsonResponseEnable(IResolvable)
//  .language(java.lang.String)
//  .language(IResolvable)
//  .preQueueEnable(java.lang.String)
//  .preQueueEnable(IResolvable)
//  .preQueueStartTime(java.lang.String)
//  .preQueueStartTime(IResolvable)
//  .randomPreQueueEnable(java.lang.String)
//  .randomPreQueueEnable(IResolvable)
//  .waitingRoomId(java.lang.String)
//  .waitingRoomId(IResolvable)
    .build();

Properties

Name Type Description
endTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endTime: The timestamp of the end time of the event.
newUsersPerMinute java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property newUsersPerMinute: Number of new users per minute.
queuingMethod java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property queuingMethod: Way of queuing.
queuingStatusCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property queuingStatusCode: Waiting room status code.
sessionDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property sessionDuration: User session duration in minutes.
siteId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteId: The site ID, which can be obtained by calling the ListSites API.
startTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property startTime: The timestamp of the event start time.
totalActiveUsers java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property totalActiveUsers: Total number of active users.
waitingRoomEventName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property waitingRoomEventName: Event name, custom event description.
waitingRoomType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property waitingRoomType: Waiting room type.
customPageHtml java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property customPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Waiting room description.
disableSessionRenewalEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property disableSessionRenewalEnable: Disable session renewal.
jsonResponseEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property jsonResponseEnable: JSON response switch.
language java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property language: Default language setting.
preQueueEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property preQueueEnable: Pre-queue switch.
preQueueStartTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property preQueueStartTime: Pre-queue start time.
randomPreQueueEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property randomPreQueueEnable: Random queue switch.
waitingRoomId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property waitingRoomId: Waiting room ID, used to identify a specific waiting room.

endTimeRequired

public java.lang.Object getEndTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


newUsersPerMinuteRequired

public java.lang.Object getNewUsersPerMinute();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property newUsersPerMinute: Number of new users per minute.


queuingMethodRequired

public java.lang.Object getQueuingMethod();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queuingMethod: Way of queuing.

Value:

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

queuingStatusCodeRequired

public java.lang.Object getQueuingStatusCode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queuingStatusCode: Waiting room status code.

Value:

  • 200
  • 202
  • 429.

sessionDurationRequired

public java.lang.Object getSessionDuration();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property sessionDuration: User session duration in minutes.


siteIdRequired

public java.lang.Object getSiteId();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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


startTimeRequired

public java.lang.Object getStartTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property startTime: The timestamp of the event start time.


totalActiveUsersRequired

public java.lang.Object getTotalActiveUsers();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property totalActiveUsers: Total number of active users.


waitingRoomEventNameRequired

public java.lang.Object getWaitingRoomEventName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property waitingRoomEventName: Event name, custom event description.


waitingRoomTypeRequired

public java.lang.Object getWaitingRoomType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property waitingRoomType: Waiting room type.

The following types are supported:

  • default: the default type.
  • custom: custom type.

customPageHtmlOptional

public java.lang.Object getCustomPageHtml();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Waiting room description.


disableSessionRenewalEnableOptional

public java.lang.Object getDisableSessionRenewalEnable();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property disableSessionRenewalEnable: Disable session renewal.

Value:

  • on: open.
  • off: closed.

jsonResponseEnableOptional

public java.lang.Object getJsonResponseEnable();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property jsonResponseEnable: JSON response switch.

Value:

  • on: open.
  • off: closed.

languageOptional

public java.lang.Object getLanguage();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property language: Default language setting.

Values include:

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

preQueueEnableOptional

public java.lang.Object getPreQueueEnable();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property preQueueEnable: Pre-queue switch.

  • on: open.
  • off: closed.

preQueueStartTimeOptional

public java.lang.Object getPreQueueStartTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property preQueueStartTime: Pre-queue start time.


randomPreQueueEnableOptional

public java.lang.Object getRandomPreQueueEnable();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property randomPreQueueEnable: Random queue switch.

  • on: open.
  • off: closed.

waitingRoomIdOptional

public java.lang.Object getWaitingRoomId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

It can be obtained by calling the listwaitingroom interface.