Person Selector

Important

Symphony Elements Beta is only available on pods that have been updated to 1.55.3 and running an agent 2.55.9 or above.

The Person Selector is an element used for finding and selecting people. Person Selectors are used in many places within Symphony, so you should be familiar with how they work.

When a user types the person's name, a drop-down will be displayed with the results found for the data the user entered. The following example shows how three people with the same name (Vincent) have been found.

For a list of all the available elements, refer to Elements.

Attributes

Attribute
Type
Required?
Description

name

String

Yes

Identifies the person selector

placeholder

String

No

Specifies a short hint that describes the expected value of the input field.

required

Boolean

No

If true, it specifies that the person selector must be filled out before submitting the form, which means that at least one person must be "selected"
Accepted values; true and false.

Rules and Limitations

The Person Selector element supports multi-user selection which means that you can search for more than one person using the same selector.

Examples

<messageML> 
    <form id="form_id">
        <person-selector name="awesome-users" placeholder="Search for someone" required="true"/>
        <button type="reset">Reset</button>  
        <button name="example-button" type="action">Submit</button> 
    </form>    
</messageML>
[
    {
        "id": "RJ4MqQ",
        "messageId": "BnjUz2Q26tKI_kQiplv0IX___pP-I0xXbQ",
        "timestamp": 1563399336872,
        "type": "SYMPHONYELEMENTSACTION",
        "initiator": {
            "user": {
                "userId": 7078106482890,
                "firstName": "User",
                "lastName": "Bot",
                "displayName": "User",
                "email": "[email protected]",
                "username": "user_bot"
            }
        },
        "payload": {
            "symphonyElementsAction": {
                "actionStream": {
                    "streamId": "0YeiA-neZa1PrdHy1L82jX___pQjntU-dA"
                },
                "formStream": {
                    "streamId": "YuK1c2y2yuie6+UfQnjSPX///pQEn69idA=="
                },
                "formMessageId": "ojfA0Eei0kSymzDpX72ysX///pP+I7LjdA==5615",
                "formId": "form_id",
                "formValues": {
                    "action": "example-button",
                    "awesome-users": [
                        7078106482890
                    ]
                }
            }
        }
    }
]

Updated 6 months ago


Person Selector


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.