social.colibri.message

colibri.social

Documentation

A message sent in a channel on Colibri

main record

A message sent in a channel on Colibri

Record Key tid Timestamp-based ID

Properties

$type string nsid Optional

The type of the record.

channel string at-uri Required

The channel this message was sent in.

createdAt string datetime Required

When the message was sent.

edited boolean Optional

Whether this message has been edited.

Default: false
parent string record-key Optional

The record key of a message this message is replying to.

suppressedEmbeds array of string uri Optional

URLs from this message's link facets whose embed the author has chosen not to display. Only the author writes this; moderator suppression is recorded separately in the community's moderation log.

text string Required

The message content.

maxLength: 2048 bytes
View raw schema 
{
  "description": "A message sent in a channel on Colibri",
  "key": "tid",
  "record": {
    "properties": {
      "$type": {
        "description": "The type of the record.",
        "format": "nsid",
        "type": "string"
      },
      "attachments": {
        "description": "An array of attachment objects for this message.",
        "items": {
          "ref": "lex:social.colibri.message#attachment",
          "type": "ref"
        },
        "type": "array"
      },
      "channel": {
        "description": "The channel this message was sent in.",
        "format": "at-uri",
        "type": "string"
      },
      "createdAt": {
        "description": "When the message was sent.",
        "format": "datetime",
        "type": "string"
      },
      "edited": {
        "default": false,
        "description": "Whether this message has been edited.",
        "type": "boolean"
      },
      "facets": {
        "description": "Annotations of sections of the text.",
        "items": {
          "ref": "lex:social.colibri.richtext.facet",
          "type": "ref"
        },
        "type": "array"
      },
      "parent": {
        "description": "The record key of a message this message is replying to.",
        "format": "record-key",
        "type": "string"
      },
      "suppressedEmbeds": {
        "description": "URLs from this message's link facets whose embed the author has chosen not to display. Only the author writes this; moderator suppression is recorded separately in the community's moderation log.",
        "items": {
          "format": "uri",
          "type": "string"
        },
        "type": "array"
      },
      "text": {
        "description": "The message content.",
        "maxLength": 2048,
        "type": "string"
      }
    },
    "required": [
      "text",
      "createdAt",
      "channel"
    ],
    "type": "object"
  },
  "type": "record"
}
attachment object

A file attached to a message.

Properties

blob blob Required

The attached file.

name string Optional

The original filename.

maxLength: 256 bytes
View raw schema 
{
  "description": "A file attached to a message.",
  "properties": {
    "blob": {
      "description": "The attached file.",
      "type": "blob"
    },
    "name": {
      "description": "The original filename.",
      "maxLength": 256,
      "type": "string"
    }
  },
  "required": [
    "blob"
  ],
  "type": "object"
}

Lexicon Garden

@