Set and get the user's chat status, also called their availability.
- Source:
Namespaces
Methods
(async, static) get()
Return the current user's availability status.
- Source:
Example
_converse.api.user.status.get();(async, static) get()
Return the current user's availability status.
Example
_converse.api.user.status.get();(async, static) set(value, messageopt)
The user's status can be set to one of the following values:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
string | The user's chat status (e.g. 'away', 'dnd', 'offline', 'online', 'unavailable' or 'xa') |
|
message |
string |
<optional> |
A custom status message |
- Source:
Examples
_converse.api.user.status.set('dnd');_converse.api.user.status.set('dnd', 'In a meeting');(async, static) set(value, messageopt)
The user's status can be set to one of the following values:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
string | The user's chat status (e.g. 'away', 'dnd', 'offline', 'online', 'unavailable' or 'xa') |
|
message |
string |
<optional> |
A custom status message |
Examples
_converse.api.user.status.set('dnd');_converse.api.user.status.set('dnd', 'In a meeting');