social.colibri.beta.channel.read Documentation (EN)

main record

Read state for one community's channels. The record key is the community DID, which bounds each record to a community's channel count and makes leaving a community a single delete.

Record Key any Any valid record key

Properties

community string did Required

The community these cursors belong to. Matches the record key.

cursors array of ref #cursor Required

One cursor per read channel.

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "community",
      "cursors"
    ],
    "properties": {
      "cursors": {
        "type": "array",
        "items": {
          "ref": "#cursor",
          "type": "ref"
        },
        "description": "One cursor per read channel."
      },
      "community": {
        "type": "string",
        "format": "did",
        "description": "The community these cursors belong to. Matches the record key."
      }
    }
  },
  "description": "Read state for one community's channels. The record key is the community DID, which bounds each record to a community's channel count and makes leaving a community a single delete."
}

cursor object

The last message read in one channel.

Properties

channel string record-key Required

The channel's space key.

cursor string tid Required

Record key of the last message read. Message keys are TIDs, so they order by time.

View raw schema

{
  "type": "object",
  "required": [
    "channel",
    "cursor"
  ],
  "properties": {
    "cursor": {
      "type": "string",
      "format": "tid",
      "description": "Record key of the last message read. Message keys are TIDs, so they order by time."
    },
    "channel": {
      "type": "string",
      "format": "record-key",
      "description": "The channel's space key."
    }
  },
  "description": "The last message read in one channel."
}