social.colibri.channel.defs

colibri.social

Documentation

attachment object

A file attached to a message.

Properties

blob blob Required

No description available.

height integer Optional

Pixel height of the attachment's intrinsic dimensions, when it is a decodable image or video.

name string Optional

No description available.

width integer Optional

Pixel width of the attachment's intrinsic dimensions, when it is a decodable image or video. Lets a client reserve the correct box before the bytes arrive.

View raw schema 
{
  "type": "object",
  "required": [
    "blob"
  ],
  "properties": {
    "blob": {
      "type": "blob"
    },
    "name": {
      "type": "string"
    },
    "width": {
      "type": "integer",
      "description": "Pixel width of the attachment's intrinsic dimensions, when it is a decodable image or video. Lets a client reserve the correct box before the bytes arrive."
    },
    "height": {
      "type": "integer",
      "description": "Pixel height of the attachment's intrinsic dimensions, when it is a decodable image or video."
    }
  },
  "description": "A file attached to a message."
}
message object

A hydrated message as served by the AppView.

Properties

channel string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

createdAt string datetime Required

An RFC 3339 formatted timestamp.

edited boolean Required

No description available.

modSuppressedEmbeds array of stringuri Optional

URLs whose embed a moderator suppressed, derived from the community's moderation log. Only the moderator who can hide messages may clear these.

suppressedEmbeds array of stringuri Optional

URLs whose embed the author suppressed, mirrored from the message record.

text string Required

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "text",
    "facets",
    "channel",
    "community",
    "author",
    "attachments",
    "reactions",
    "createdAt",
    "edited"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "text": {
      "type": "string"
    },
    "author": {
      "ref": "lex:social.colibri.actor.defs#actorView",
      "type": "ref"
    },
    "edited": {
      "type": "boolean"
    },
    "facets": {
      "type": "array",
      "items": {
        "ref": "lex:social.colibri.richtext.facet",
        "type": "ref"
      }
    },
    "parent": {
      "ref": "lex:social.colibri.channel.defs#message",
      "type": "ref",
      "description": "The message this one replies to, if any. Never itself nested (the parent's own parent is omitted)."
    },
    "channel": {
      "type": "string",
      "format": "at-uri"
    },
    "community": {
      "type": "string",
      "format": "at-uri"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "reactions": {
      "type": "array",
      "items": {
        "ref": "lex:social.colibri.channel.defs#reactionView",
        "type": "ref"
      }
    },
    "attachments": {
      "type": "array",
      "items": {
        "ref": "lex:social.colibri.channel.defs#attachment",
        "type": "ref"
      }
    },
    "suppressedEmbeds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "URLs whose embed the author suppressed, mirrored from the message record."
    },
    "modSuppressedEmbeds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "URLs whose embed a moderator suppressed, derived from the community's moderation log. Only the moderator who can hide messages may clear these."
    }
  },
  "description": "A hydrated message as served by the AppView."
}
reactionView object

An aggregated reaction on a message.

Properties

count integer Required

No description available.

emoji string Required

No description available.

reactorDIDs array of stringdid Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "emoji",
    "count",
    "reactorDIDs"
  ],
  "properties": {
    "count": {
      "type": "integer"
    },
    "emoji": {
      "type": "string"
    },
    "reactorDIDs": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "did"
      }
    }
  },
  "description": "An aggregated reaction on a message."
}
readCursor object

The authenticated user's read cursor for a channel.

Properties

channel string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

cursor string Required

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cursor",
    "channel"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "cursor": {
      "type": "string"
    },
    "channel": {
      "type": "string",
      "format": "at-uri"
    }
  },
  "description": "The authenticated user's read cursor for a channel."
}
unreadStatus object

Per-channel unread state for the authenticated user.

Properties

channelUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

hasUnreadMessages boolean Required

No description available.

unreadPingCount integer Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "channelUri",
    "hasUnreadMessages",
    "unreadPingCount"
  ],
  "properties": {
    "channelUri": {
      "type": "string",
      "format": "at-uri"
    },
    "unreadPingCount": {
      "type": "integer"
    },
    "hasUnreadMessages": {
      "type": "boolean"
    }
  },
  "description": "Per-channel unread state for the authenticated user."
}

Lexicon Garden

@