Set User Presence
- Print
- DarkLight
- PDF
Set User Presence
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Set the user presence status. By default, there are four different statuses available in your workspace:
online
busy
away
offline
Set default user presence status
Method | Requires Auth |
---|---|
| Yes |
/Payload parameters
Argument | Example | Required | Description |
---|---|---|---|
|
| Required | The user presence status to be set as default. |
Example call
{
"msg": "method",
"method": "UserPresence:setDefaultStatus",
"id": "42",
"params": [ "online" ]
}
Example response
{
"msg": "result",
"id": "42",
"result": true
}
Set temporary user presence status
To set a temporary status, send a request to UserPresence:{status}
with empty parameters. It only accepts either of these two status options: away
and online
. It is particularly useful when the client detects that the user is currently not actively using the application (thus "away") and when the user returns, indicating they are "online" again.
Method | Requires Auth |
---|---|
| Yes |
Example call
{
"msg": "method",
"method": "UserPresence:away",
"id": "47",
"params":[]
}
Example response
{
"msg": "result",
"id": "42",
"result": true
}
Was this article helpful?