Newroom

This help page is for Desktop Studio.This action is not currently available in Studio.

Establishes a chat room with a unique ID. This action is typically used towards the beginning of a script flow as the RoomID variable output is required for other actions to function, or in order to link actions to a correct session.

Supported Script Types

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

Chat

Input Properties

These properties define data that the action uses when executing.

Property

Description

Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

RoomIDVar The output variable name once the Newroom action has executed. This variable can be renamed as needed, but most subsequent actions adhere to the default of RoomID pre-configured in this field.

Output Properties

These properties contain variables that hold data returned from executing the action. They're available for reference and use when the action completes.

Property

Description

RoomID The unique identifier for the chat room, which is determined in the RoomIDVar parameter.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition

Description

Default

Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.