social.colibri.message Documentation (EN)

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.

attachments array of ref lex:social.colibri.message#attachment Optional

An array of attachment objects for this message.

channel string record-key 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

facets array of ref lex:social.colibri.richtext.facet Optional

Annotations of sections of the text.

parent string record-key Optional

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

text string Required

The message content.

maxLength: 2048 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "text",
      "createdAt",
      "channel"
    ],
    "properties": {
      "text": {
        "type": "string",
        "maxLength": 2048,
        "description": "The message content."
      },
      "$type": {
        "type": "string",
        "format": "nsid",
        "description": "The type of the record."
      },
      "edited": {
        "type": "boolean",
        "default": false,
        "description": "Whether this message has been edited."
      },
      "facets": {
        "type": "array",
        "items": {
          "ref": "lex:social.colibri.richtext.facet",
          "type": "ref"
        },
        "description": "Annotations of sections of the text."
      },
      "parent": {
        "type": "string",
        "format": "record-key",
        "description": "The record key of a message this message is replying to."
      },
      "channel": {
        "type": "string",
        "format": "record-key",
        "description": "The channel this message was sent in."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the message was sent."
      },
      "attachments": {
        "type": "array",
        "items": {
          "ref": "lex:social.colibri.message#attachment",
          "type": "ref"
        },
        "description": "An array of attachment objects for this message."
      }
    }
  },
  "description": "A message sent in a channel on Colibri"
}

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

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