fyi.opensocial.subscribeSpaces

Changes to a group's spaces, as they happen, for one of its members: a #change for each change to a space the caller may read now, saying which space and its new revision, and nothing of what changed. A member who hears one reads again with listSpaceRecords. Members only, with service auth for this method, sent as a Bearer token or, as a browser's WebSocket can't send one, as `token`. The site's own pages hear the same changes at /space-events (server-sent events, with who's online).

Details · subscription
Kindsubscription
Authorityopensocial.fyi
Indexed

Showing version bafyreiacytx5jofu3slwfrqdi67nfcnrg5v765yegyxaw4zeagfnf46vsi. Show the latest

cid bafyreiacytx5jofu3slwfrqdi67nfcnrg5v765yegyxaw4zeagfnf46vsi

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "change": {
      "properties": {
        "rev": {
          "description": "The space's revision after the change.",
          "type": "string"
        },
        "seq": {
          "description": "Its place among the host's changes, to resume from with cursor.",
          "type": "integer"
        },
        "space": {
          "format": "at-uri",
          "type": "string"
        },
        "time": {
          "format": "datetime",
          "type": "string"
        }
      },
      "required": [
        "seq",
        "space",
        "rev"
      ],
      "type": "object"
    },
    "info": {
      "properties": {
        "message": {
          "type": "string"
        },
        "name": {
          "knownValues": [
            "OutdatedCursor"
          ],
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    },
    "main": {
      "description": "Changes to a group's spaces, as they happen, for one of its members: a #change for each change to a space the caller may read now, saying which space and its new revision, and nothing of what changed. A member who hears one reads again with listSpaceRecords. Members only, with service auth for this method, sent as a Bearer token or, as a browser's WebSocket can't send one, as `token`. The site's own pages hear the same changes at /space-events (server-sent events, with who's online).",
      "errors": [
        {
          "name": "FutureCursor"
        }
      ],
      "message": {
        "schema": {
          "refs": [
            "#change",
            "#info"
          ],
          "type": "union"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "The seq of the last #change heard: the changes after it that the host still holds are sent first. Older than it holds, an #info OutdatedCursor comes first, and the caller should read everything again.",
            "type": "integer"
          },
          "group": {
            "format": "did",
            "type": "string"
          },
          "token": {
            "description": "Service auth for this method, for a client that can't send an Authorization header.",
            "type": "string"
          }
        },
        "required": [
          "group"
        ],
        "type": "params"
      },
      "type": "subscription"
    }
  },
  "id": "fyi.opensocial.subscribeSpaces",
  "lexicon": 1
}