Room Selector

The Room Selector is an element that allows users to find and select both rooms or persons. It behaves the same way as the chat selector you see when you forward a message and select where the message should be forwarded.

When a user starts typing in the field, a list of conversations and people will be displayed for selection. Only the chats that the user has access to will be displayed.

Attributes

Attribute	Type	Required?	Description
name	String	Yes	Identifies the room selector.
placeholder	String	No	Specifies a short hint that describes the expected value of the field.
required	Boolean	No	If true, at least one chat or person must be selected to be able to submit the form.
label	String	No	Label displayed on top of the Room Selector.
value	Array of string	No	Default values that will be preselected in the Room Selector. The array can contain both streamIds, as well as userIds. Please note that if the user does not have access to these users or conversations, they will not be displayed.

Rules and Limitations

• The Room Selector element supports multi selection which means that you can search for more than one chat or person.

• The Room Selector is not yet available on Symphony Mobile. Mobile will be supported in a future release.

Example

MessageML

Example of a room selector with both a room and a user pre-selected. Please note that pre-selected streamIds must follow URL Safe Base64 encoded StreamID.

<messageML>
     <form id="test"> 
        <room-selector name="room-selector" 
            label="Select the chats where the alert will be sent." 
            value="['rsxB51ieSYfPLQ0jgFKg93___nUqhvz4dA','9139691037944']"  
            placeholder="Select rooms"/>
        <button name="submit_button" type="action">Create Alert</button>    
    </form>
</messageML>

Datafeed Payload

Resulting payload when a user submitted the form afer having selected two chats and one user in the Room Selector.

"payload": {
    "symphonyElementsAction": {
        "stream": {
            "streamId": "9vwxSTElsJDEqmRt2CWQpn___nRRfCVgdA",
            "streamType": "IM"
        },
        "formMessageId": "t2AFSQooaBvh_OrDrNDR53___nGF6NqybQ",
        "formId": "test",
        "formValues": {
            "action": "submit_button",
            "room-selector": {
                "userIds": [
                    "9139691037944"
                ],
                "streamIds": [
                    "fy0RUFUt6pkiiV3nPZVr5X///nJeKqjMdA==",
                    "5fXylrRrqEb1vH4bvBMWNn///nWQegjtdA=="
                ]
            }
        }
    }
}

Versions and Compatibility

Main features introduced	Agent needed to parse message sent by the bot	Client 2.0 release	Backward client-compatibility behavior (e.g. external rooms)
Feature introduced	23.11	C2 24.4 (April 2024)	Not available yet. Room Selector is not displayed.