Spotlight (search)
- Print
- DarkLight
- PDF
Spotlight (search)
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Search for rooms or users.
Method | Requires Auth |
|---|---|
| Yes |
Payload parameters
Argument | Example | Required | Description |
|---|---|---|---|
|
| Required | The term to be searched for. |
|
| Optional | Any items to exclude from the results (e.g. users you already know about). |
|
| 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": []
}
}
Was this article helpful?