Lexicon Garden

social.colibri.beta.actor.setStatus

Sets the requesting user's off-protocol presence. An absent field leaves the current value unchanged.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authorityactor.beta.colibri.social
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

customEmoji

ref

A custom emoji shown beside the status. The uri must name an emoji item record. Absent leaves the current value unchanged. Takes precedence over removeCustomEmoji.

Reference

emoji

string

A Unicode emoji shown beside the status. An empty string clears it. Absent leaves the current value unchanged.

expiresAt

string · datetime

When the status clears. Absent leaves the current value unchanged. Takes precedence over removeExpiresAt.

onlineState

string

Derived online state. Absent leaves the current value unchanged.

  • knownValues: online | away | dnd | offline

removeCustomEmoji

boolean

Removes the custom emoji. Ignored when customEmoji is also given.

removeExpiresAt

boolean

Removes the status expiry, so the status stays until it is changed. Ignored when expiresAt is also given.

showWhileOffline

boolean

Whether a client shows the status while the user is offline. Absent leaves the current value unchanged.

text

string

The status text. An empty string clears it. Absent leaves the current value unchanged.

  • maxLength: 64

Output

application/json

presence

requiredref

The requesting user's presence, after the update.

Reference

Errors

AuthRequired

The request has no valid service auth.

InvalidRequest

A field is present but does not hold an allowed value.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.