social.colibri.beta.actor.setStatus
Sets the requesting user's off-protocol presence. An absent field leaves the current value unchanged.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | actor.beta.colibri.social |
| Indexed |
Showing version bafyreibvqccpt6ozjocecvifpsqirkpp5llqqik6kadotmta24vg6vrtte. Show the latest
Procedure
procedure · POSTInput
application/jsonemoji
stringAn emoji shown beside the status. Absent leaves the current value unchanged.
expiresAt
string · datetimeWhen the status clears. Absent leaves the current value unchanged. Takes precedence over removeExpiresAt.
onlineState
stringDerived online state. Absent leaves the current value unchanged.
knownValues: online | away | dnd | offline
removeExpiresAt
booleanRemoves the status expiry, so the status stays until it is changed. Ignored when expiresAt is also given.
showWhileOffline
booleanWhether a client shows the status while the user is offline. Absent leaves the current value unchanged.
text
stringThe status text. Absent leaves the current value unchanged.
maxLength: 64
Output
application/jsonThe requesting user's presence, after the update.
Errors
AuthRequired
The request has no valid service auth.
InvalidRequest
A field is present but does not hold an allowed value.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
social.colibri.actor.setState
procedureSets the authenticated user's online presence state.