app.protoimsg.chat.channel Documentation (EN)

main record

A channel within a chat room. Created by the room owner.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

Timestamp of channel creation.

description string Optional

What the channel is about.

maxLength: 500 bytes

name string Required

Display name for the channel.

maxLength: 100 bytes

position integer Optional

Sort position within the room. Lower numbers appear first.

minimum: 0

postPolicy string Optional

Who can post messages in this channel.

Known values: everyone, owner, moderators

room string at-uri Required

AT-URI of the room this channel belongs to.

View raw schema

{
  "description": "A channel within a chat room. Created by the room owner.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "Timestamp of channel creation.",
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "description": "What the channel is about.",
        "maxLength": 500,
        "type": "string"
      },
      "name": {
        "description": "Display name for the channel.",
        "maxLength": 100,
        "type": "string"
      },
      "position": {
        "description": "Sort position within the room. Lower numbers appear first.",
        "minimum": 0,
        "type": "integer"
      },
      "postPolicy": {
        "description": "Who can post messages in this channel.",
        "knownValues": [
          "everyone",
          "owner",
          "moderators"
        ],
        "type": "string"
      },
      "room": {
        "description": "AT-URI of the room this channel belongs to.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "room",
      "name",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}