social.colibri.channel Documentation (EN)

main record

A channel that belongs to a category on Colibri.

Record Key tid Timestamp-based ID

Properties

$type string nsid Optional

The type of the record.

category string record-key Required

The category this channel belongs to.

community string record-key Required

The record key of the community this channel belongs to.

description string Optional

A description of the channel.

maxLength: 256 bytes

Default:

name string Required

The name of the channel.

maxLength: 32 bytesminLength: 1 bytes

Default: New channel

type string Required

The type of the channel.

Allowed: text, voice, forum

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "type",
      "category",
      "community"
    ],
    "properties": {
      "name": {
        "type": "string",
        "default": "New channel",
        "maxLength": 32,
        "minLength": 1,
        "description": "The name of the channel."
      },
      "type": {
        "enum": [
          "text",
          "voice",
          "forum"
        ],
        "type": "string",
        "description": "The type of the channel."
      },
      "$type": {
        "type": "string",
        "format": "nsid",
        "description": "The type of the record."
      },
      "category": {
        "type": "string",
        "format": "record-key",
        "description": "The category this channel belongs to."
      },
      "community": {
        "type": "string",
        "format": "record-key",
        "description": "The record key of the community this channel belongs to."
      },
      "description": {
        "type": "string",
        "default": "",
        "maxLength": 256,
        "description": "A description of the channel."
      }
    }
  },
  "description": "A channel that belongs to a category on Colibri."
}