status_set

Set your own presence (online, idle, and so on) and an optional line of status text. The server saves it and tells every connected member, filtered by what each one may see.

Request

{
  "cmd": "status_set",
  "status": "idle",
  "text": "back soon"
}

Field	Type	Required	Description
`status`	string	Yes	One of `online`, `idle`, `dnd`, `offline`, or `invisible`. Surrounding spaces are trimmed.
`text`	string	No	Custom status text, up to 100 characters. Defaults to `""`, which clears any previous text.

offline and invisible both hide you from ordinary members. You stay connected and can use the server as usual.

Response

{
  "cmd": "status_set",
  "status": {
    "status": "idle",
    "text": "back soon"
  }
}

The server then sends an event to every authenticated connection, including your own:

You, your other sessions, and members with manage_users receive status_get with your real status and an invisible boolean, followed by a user_clients frame.
If the new status is offline or invisible, everyone else receives user_disconnect with your masked user object.
Otherwise everyone else receives status_get with username and status. If you were hidden before, they first receive user_connect with your user object.

{
  "cmd": "status_get",
  "username": "alice",
  "status": {
    "status": "idle",
    "text": "back soon"
  }
}

Permissions

Any member can call it. It is blocked while you are timed out.

Errors

`val`	When
`Invalid status. Must be one of: online, idle, dnd, offline, invisible`	`status` is not one of the allowed values.
`Unable to save status`	The server could not write the change to storage.
Validation message	`status` is missing or blank, or `text` is longer than 100 characters.

See also