Spotlight Search (Realtime)

Search for rooms or users.

Method	Requires Auth
`spotlight`	Yes

Payload parameters

Argument	Example	Required	Description
`searchString`	`test`	Required	The term to be searched for.
`exclude`	`test.rc`	Optional	Any items to exclude from the results (e.g. users you already know about).
`options`	`{ "users": true, "rooms": false }`	Required	The kind of fields to search for.

Example call

{
    "msg": "method",
    "method": "spotlight",
    "params": ["test", ["testrc"], {
        "users": true,
        "rooms": false
    }],
    "id": "74290"
}

Example response

{
    "msg": "result",
    "id": "74290",
    "result": {
        "users": [
            {
                "_id": "ZoJM4tvohREwJbtAh",
                "username": "testrc",
                "status": "offline",
                "name": "TestRc",
                "outside": true
            }
        ],
        "rooms": []
    }
}