Lexicon Garden

social.colibri.beta.channel.read

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.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · record, key any
Kindrecord
Record keyany
Authoritychannel.beta.colibri.social
Indexed
Compare Edit in builder → Fork →

Record

record · key any

Properties

community

requiredstring · did

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

cursors

requiredarray

One cursor per read channel.

itemsref
Reference

#cursor

object

The last message read in one channel.

Properties

channel

requiredstring · record-key

The channel's space key.

cursor

requiredstring · tid

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

Similar lexicons

semantic match

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

  • social.colibri.channel.read

    record

    A read cursor for a Colibri channel, indicating the last read message by a user.

  • social.colibri.beta.channel.putReadCursors

    procedure

    Pushes the requesting user's read cursors for one community to the AppView, so unread counts update immediately instead of waiting for a sync notification. The client writes its social.colibri.beta.channel.read record for the community to its own personal space first, then calls this. Clients should debounce this rather than calling it on every message. The user's other sessions receive the cursors that moved as a social.colibri.beta.sync.defs#readCursorEvent.

  • social.colibri.channel.getReadCursor

    query

    Returns the authenticated user's read cursor for a channel.

  • social.colibri.beta.channel.listSummaries

    query

    Gets the latest message of every text channel in a community that the requesting user may read, for channel list previews. Channels with no message the user may see are absent.

  • social.colibri.beta.channel.listMessages

    query

    Lists messages in a channel or in a thread, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy. Messages moved in from another space are included in their move order, and messages moved out are absent.