Lexicon Garden

social.colibri.actor.setState

Sets the authenticated user's online presence state.

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

Checks

Valid
  • unlimited-string defs.main.parameters.properties.stateNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.onlineStateNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Sets the authenticated user's online presence state.",
      "errors": [
        {
          "description": "Missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The given state is not one of the accepted values.",
          "name": "InvalidState"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "onlineState": {
              "type": "string"
            }
          },
          "required": [
            "onlineState"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "state": {
            "description": "The presence state to set.",
            "knownValues": [
              "online",
              "away",
              "dnd",
              "offline"
            ],
            "type": "string"
          }
        },
        "required": [
          "state"
        ],
        "type": "params"
      },
      "type": "procedure"
    }
  },
  "id": "social.colibri.actor.setState",
  "lexicon": 1
}