Skip to content

WaitingRoomEventProps

Properties for defining a WaitingRoomEvent.

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

Initializer

import { WaitingRoomEventProps } from '@alicloud/ros-cdk-esa'
const waitingRoomEventProps: WaitingRoomEventProps = { ... }

Properties

Name Type Description
endTime string | @alicloud/ros-cdk-core.IResolvable Property endTime: The timestamp of the end time of the event.
newUsersPerMinute number | @alicloud/ros-cdk-core.IResolvable Property newUsersPerMinute: Number of new users per minute.
queuingMethod string | @alicloud/ros-cdk-core.IResolvable Property queuingMethod: Way of queuing.
queuingStatusCode string | @alicloud/ros-cdk-core.IResolvable Property queuingStatusCode: Waiting room status code.
sessionDuration number | @alicloud/ros-cdk-core.IResolvable Property sessionDuration: User session duration in minutes.
siteId number | @alicloud/ros-cdk-core.IResolvable Property siteId: The site ID, which can be obtained by calling the ListSites API.
startTime string | @alicloud/ros-cdk-core.IResolvable Property startTime: The timestamp of the event start time.
totalActiveUsers number | @alicloud/ros-cdk-core.IResolvable Property totalActiveUsers: Total number of active users.
waitingRoomEventName string | @alicloud/ros-cdk-core.IResolvable Property waitingRoomEventName: Event name, custom event description.
waitingRoomType string | @alicloud/ros-cdk-core.IResolvable Property waitingRoomType: Waiting room type.
customPageHtml string | @alicloud/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 string | @alicloud/ros-cdk-core.IResolvable Property description: Waiting room description.
disableSessionRenewalEnable string | @alicloud/ros-cdk-core.IResolvable Property disableSessionRenewalEnable: Disable session renewal.
jsonResponseEnable string | @alicloud/ros-cdk-core.IResolvable Property jsonResponseEnable: JSON response switch.
language string | @alicloud/ros-cdk-core.IResolvable Property language: Default language setting.
preQueueEnable string | @alicloud/ros-cdk-core.IResolvable Property preQueueEnable: Pre-queue switch.
preQueueStartTime string | @alicloud/ros-cdk-core.IResolvable Property preQueueStartTime: Pre-queue start time.
randomPreQueueEnable string | @alicloud/ros-cdk-core.IResolvable Property randomPreQueueEnable: Random queue switch.
waitingRoomId string | @alicloud/ros-cdk-core.IResolvable Property waitingRoomId: Waiting room ID, used to identify a specific waiting room.

endTimeRequired

public readonly endTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


newUsersPerMinuteRequired

public readonly newUsersPerMinute: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property newUsersPerMinute: Number of new users per minute.


queuingMethodRequired

public readonly queuingMethod: string | IResolvable;
  • Type: string | @alicloud/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 readonly queuingStatusCode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property queuingStatusCode: Waiting room status code.

Value: - 200 - 202 - 429.


sessionDurationRequired

public readonly sessionDuration: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property sessionDuration: User session duration in minutes.


siteIdRequired

public readonly siteId: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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


startTimeRequired

public readonly startTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property startTime: The timestamp of the event start time.


totalActiveUsersRequired

public readonly totalActiveUsers: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property totalActiveUsers: Total number of active users.


waitingRoomEventNameRequired

public readonly waitingRoomEventName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property waitingRoomEventName: Event name, custom event description.


waitingRoomTypeRequired

public readonly waitingRoomType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property waitingRoomType: Waiting room type.

The following types are supported: - default: the default type. - custom: custom type.


customPageHtmlOptional

public readonly customPageHtml: string | IResolvable;
  • Type: string | @alicloud/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 readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Waiting room description.


disableSessionRenewalEnableOptional

public readonly disableSessionRenewalEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property disableSessionRenewalEnable: Disable session renewal.

Value: - on: open. - off: closed.


jsonResponseEnableOptional

public readonly jsonResponseEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property jsonResponseEnable: JSON response switch.

Value: - on: open. - off: closed.


languageOptional

public readonly language: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property language: Default language setting.

Values include: - enus: English. - zhcn: Simplified Chinese. - zhhk: Traditional Chinese.


preQueueEnableOptional

public readonly preQueueEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property preQueueEnable: Pre-queue switch.

on: open. - off: closed.


preQueueStartTimeOptional

public readonly preQueueStartTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property preQueueStartTime: Pre-queue start time.


randomPreQueueEnableOptional

public readonly randomPreQueueEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property randomPreQueueEnable: Random queue switch.

on: open. - off: closed.


waitingRoomIdOptional

public readonly waitingRoomId: string | IResolvable;
  • Type: string | @alicloud/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.