Lexicon Garden

social.colibri.beta.sync.defs

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · defs
Kinddefs
Authoritysync.beta.colibri.social
Indexed
Compare Edit in builder → Fork →

#ack

object

Answers a heartbeat.

Properties

#activity

object

Reports that the user is actively using this client, which holds back push notifications to their other devices for a few minutes. Clients send it while visible and focused.

Properties

#applicationEvent

object

The pending-application queue changed. Only sent to members who can manage approvals.

Properties

application

ref

The application. Absent on approve.

Reference

community

requiredstring · did

The community.

event

requiredstring

What happened.

  • knownValues: create | approve | dismiss | undismiss

subject

requiredstring · did

The applicant.

#bridgeEvent

object

A registration held by the connected bridge was changed or removed. Sent only to the bridge, which should fetch its configuration again.

Properties

community

requiredstring · did

The community the registration belongs to.

event

requiredstring

What happened.

  • knownValues: update | delete

registration

requiredstring · tid

Record key of the registration.

#categoryEvent

object

A category was created, changed, or deleted.

Properties

category

ref

The category. Absent on delete.

Reference

community

requiredstring · did

The community it belongs to.

event

requiredstring

What happened.

  • knownValues: create | update | delete

rkey

string · record-key

Which category, for deletes.

#channelEvent

object

A channel was created, changed, or deleted.

Properties

channel

ref

The channel. Absent on delete.

Reference

community

requiredstring · did

The community it belongs to.

event

requiredstring

What happened.

  • knownValues: create | update | delete

space

string · space-ref

Which channel, for deletes.

#communityEvent

object

A community's profile or settings changed.

Properties

community

requiredstring · did

The community.

event

requiredstring

What happened.

  • knownValues: update | delete

view

ref

The community. Absent on delete.

Reference

#communityProgressEvent

object

Progress while a community is being created or migrated, which takes several PDS round-trips.

Properties

community

string · did

The community, once its account exists.

completed

requiredinteger

Steps finished.

message

string

Human-readable detail, set on failure.

step

requiredstring

What the AppView is doing now.

  • knownValues: creatingAccount | creatingSpaces | writingProfile | creatingOwnerRole | creatingStarterChannels | readingLegacyRepo | writingSettings | migratingRoles | migratingMembers | migratingBans | migratingChannels | migratingCategories | mirroringMessages | retiringLegacyCommunity | done | failed

total

requiredinteger

Steps in total.

#drainNotice

object

This node is going offline. Clients move their event socket to another node from listNodes. When no other node exists, clients warn the user that the connection may drop at the deadline.

Properties

deadline

requiredstring · datetime

When the node closes its remaining connections.

reason

string

Why the node goes offline.

  • knownValues: update | maintenance | retire

#emojiEvent

object

A community's custom emoji or packs changed. Sent to the community's subscribers. Carries the whole catalog so clients replace it in one step.

Properties

catalog

requiredref

The catalog after the change.

Reference

owner

requiredstring · did

The community whose catalog changed.

#emojiLibraryEvent

object

The user's emoji library changed. Sent to a user's own connections when their own emoji change, a follow is added or removed, or the owner of something they follow changes their emoji. Carries the whole library so clients replace it in one step.

Properties

library

requiredref

The user's whole library after the change.

Reference

#error

object

Something the client sent could not be acted on.

Properties

error

requiredstring

Error name.

  • knownValues: InvalidFrame | Forbidden | NotFound | RateLimited | ReadOnly

message

string

Human-readable detail.

#heartbeat

object

Keeps the connection alive and tells the AppView the user is still present. The server answers with an ack.

Properties

#invitationEvent

object

A community's invitation list changed. Only sent to members who can create invitations.

Properties

code

requiredstring

The invitation code that was created or deleted.

community

requiredstring · did

The community.

event

requiredstring

What happened.

  • knownValues: create | delete

#labelEvent

object

A label was applied or retracted on a record in a subscribed space.

Properties

event

requiredstring

What happened.

  • knownValues: create | negate

space

requiredstring · space-ref

The space the labelled record lives in.

src

requiredstring · did

The labeler.

subject

requiredref

The labelled record.

Reference

val

requiredstring

The label value.

#memberEvent

object

Someone joined, left, or had their roles changed.

Properties

community

requiredstring · did

The community.

event

requiredstring

What happened. A kick or a ban arrives as a leave.

  • knownValues: join | leave | update

member

ref

The member. Absent on leave.

Reference

subject

string · did

Who, for leaves.

#messageEvent

object

A message was written, edited, or deleted in a subscribed channel.

Properties

channel

requiredstring · space-ref

The channel it happened in.

event

requiredstring

What happened.

  • knownValues: create | update | delete

imported

boolean

Set when a bridge imported the message from earlier history. Clients show it without marking the channel unread.

message

ref

The message. Absent on delete, where the reference alone identifies it.

Reference

subject

ref

Which message, for deletes.

Reference

subjectUri

string · at-uri

The record URI of the message, for deletes.

#moderationEvent

object

A moderation action was logged. Only sent to members who can read the log.

Properties

community

requiredstring · did

The community.

entry

requiredref

The log entry.

Reference

#notificationEvent

object

A notification was raised for the connected user.

Properties

#preferencesEvent

object

The connected user changed their own preferences somewhere else.

Properties

preferences

requiredref

Their preferences as they now stand.

Reference

#presenceEvent

object

Someone's presence changed.

Properties

did

requiredstring · did

Whose presence changed.

presence

requiredref

Their new presence.

Reference

#reactionEvent

object

A reaction was added or removed in a subscribed channel.

Properties

actor

requiredstring · did

Who reacted.

bridged

ref

Present when someone on another service reacted through a bridge. The actor is then the community that wrote the reaction.

Reference

channel

requiredstring · space-ref

The channel it happened in.

customEmoji

ref

The emoji record behind a custom shortcode.

Reference

emoji

requiredstring

The emoji or custom shortcode.

event

requiredstring

What happened.

  • knownValues: create | delete

reaction

ref

The reaction record itself.

Reference

target

requiredref

The message reacted to.

Reference

uri

string · at-uri

The record URI of the message reacted to.

#readCursorEvent

object

The connected user's read cursors for one community moved, possibly from another of their sessions. Each cursor is the newest the AppView holds for that channel or thread, so applying the event never moves a cursor backwards.

Properties

community

requiredstring · did

The community the cursors belong to.

cursors

requiredarray

The cursors that changed.

#roleEvent

object

A role was created, changed, or deleted.

Properties

community

requiredstring · did

The community it belongs to.

event

requiredstring

What happened.

  • knownValues: create | update | delete

rkey

string · record-key

Which role, for deletes.

role

ref

The role. Absent on delete.

Reference

#seenEvent

object

The connected user marked notifications seen somewhere else, so this client should clear the same badges.

Properties

channel

string · space-ref

The channel that was marked seen, when it was a single channel.

clearedAt

string · datetime

Set when the user cleared their inbox. Notifications raised at or before this time are gone from it.

message

ref

The message whose notifications were marked seen, when it was a single message.

Reference

seenAt

string · datetime

The point everything was marked seen up to.

unread

requiredinteger

The user's remaining unread count.

#setPresence

object

Updates the user's own presence over the socket.

Properties

onlineState

string

Requested online state.

  • knownValues: online | away | dnd | offline

voice

ref

The user's own voice state, when connected to a voice channel.

Reference

#subscribe

object

Adds communities, channels and threads to what this connection receives. Subscription is explicit: a connection is sent nothing it did not ask for.

Properties

channels

array

Channels and threads to start receiving messages for.

itemsstring · space-ref

A channel or a thread.

communities

array

Communities to start receiving events for.

itemsstring · did

A community.

#subscribed

object

Confirms what this connection is now receiving, after a subscribe or unsubscribe. Anything the user is not entitled to read is silently absent.

Properties

channels

requiredarray

Channels and threads being received.

itemsstring · space-ref

A channel or a thread.

communities

requiredarray

Communities being received.

itemsstring · did

A community.

#threadEvent

object

A thread was opened, changed, deleted, or written to. This rides the community's topic rather than a topic per thread, so a client keeps every thread's activity age and unread dot live without subscribing to each one.

Properties

channel

string · space-ref

The channel the thread belongs to.

community

requiredstring · did

The community it belongs to.

event

requiredstring

What happened. `activity` means someone posted, which moves the thread's last activity and nothing else.

  • knownValues: create | update | delete | activity

lastActivityAt

string · datetime

The thread's new last activity, on activity events.

space

string · space-ref

Which thread, for deletes and for activity.

thread

ref

The thread. Absent on delete and on activity.

Reference

#typing

object

Reports that the user is typing in a channel.

Properties

channel

requiredstring · space-ref

The channel being typed in.

#typingEvent

object

Someone is typing in a subscribed channel.

Properties

channel

requiredstring · space-ref

Where.

did

requiredstring · did

Who is typing.

#unsubscribe

object

Removes communities, channels and threads from what this connection receives.

Properties

channels

array

Channels and threads to stop receiving messages for.

itemsstring · space-ref

A channel or a thread.

communities

array

Communities to stop receiving events for.

itemsstring · did

A community.

#viewChannel

object

Reports which channel the user is looking at, which drives read state and away detection. An absent channel means they are looking at none.

Properties

channel

string · space-ref

The channel now in view.

#voiceEvent

object

A voice channel's participants changed.

Properties

channel

requiredstring · space-ref

The voice channel.

did

requiredstring · did

Who.

event

requiredstring

What happened.

  • knownValues: join | leave | update | speaking

speaking

boolean

Whether they are currently speaking, on speaking events.

voice

ref

Their voice state. Absent on leave.

Reference

#voiceSelfState

object

A user's own voice state.

Properties

channel

requiredstring · space-ref

The voice channel.

deafened

boolean

Whether the user has deafened themselves.

muted

boolean

Whether the microphone is muted.

#writeState

object

Whether this node can take writes right now. Sent on connect and whenever it changes.

Properties

mode

requiredstring

'normal' accepts writes. 'queued' accepts writes and applies them once the network can take them again. 'readOnly' rejects writes with a ReadOnly error.

  • knownValues: normal | queued | readOnly

#wroteTo

object

Reports that the user just wrote a record to a space, so the AppView can pull it without waiting for the space host to forward a notification. Honoured only for a space this connection already receives.

Properties

rev

string · tid

The revision the write produced, when the client knows it.

space

requiredstring · space-ref

The space that was written to.

Similar lexicons

semantic match

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