Skip to content
OriginChats

channel_update

channel_update is implemented by handleChannelUpdate in src/api/handlers/channel/channel_update.osl.

Updates channel metadata. When the channel is a separator, updates.size controls the UI spacing/padding rendered around it.

Access

Section titled “Access”
Gate Requirement
Authentication Required by the central API gate.
Central permission manage_channels
Broadcast Not marked global directly by this adapter. A helper may emit focused or server-wide updates.

Request

Section titled “Request”

Every request includes cmd: "channel_update" and may include an opaque listener correlation value.

Field Validation / meaning
current_name schema.string().minLen(1)
updates schema.object({

Validator source

Section titled “Validator source”

The handler and shared validation path use these OSL schema definitions before normalization:

*schema.Schema schemaChannelUpdate = schema.object({
  current_name: schema.string().minLen(1),
  updates: schema.object({
    name: schema.string().trim().minLen(1).maxLen(64).optional(),
    type: schema.enum(["text", "voice", "forum", "separator"]).optional(),
    description: schema.string().nullable().optional(),
    display_name: schema.string().nullable().optional(),
    permissions: schema.record(schema.any()).optional(),
    size: schema.number().nullable().optional(),
    max_message_age: schema.number().min(0).optional(),
    slow_mode_cooldown: schema.number().min(0).optional()
  }).minLen(1)
})

Processing path

Section titled “Processing path”
  1. handleCmd enforces authentication and the manage_channels permission.
  2. dispatchCmd routes channel_update to handleChannelUpdate.
  3. The adapter validates and normalizes input, then calls its domain collaborators.
  4. Durable mutations complete before the response or event is returned.
  5. onMessage adds the request listener to direct responses and performs any marked broadcast.

Direct collaborators visible in the handler: channelGet, pick, channelNameError, channelUpdate, auditRecord, newName, refreshChannels

Responses and events

Section titled “Responses and events”

Response/event command names visible in this adapter: channel_update.

Validation and domain failures use:

{
  "cmd": "error",
  "val": "<message>",
  "src": "channel_update",
  "listener": "<copied from request>"
}