A channel's configuration. Lives at key 'self' in the channel's own space. The space type says whether it is a text or voice channel, and the space key is the channel's identity.
literal:self
Fixed literal value
Properties
allowedMembers
array
of
string
did
Optional
Members allowed to post here in addition to allowedRoles.
allowedRoles
array
of
string
record-key
Optional
Roles allowed to post here. Empty means no role restriction.
description
string
Optional
The channel's topic.
maxLength: 256 byteslinkEmbeds
boolean
Optional
Whether link previews are shown here. Absent means the community default.
migratedFrom
string
at-uri
Optional
Set on a channel created by migrating a repo-backed community. Points at the legacy channel record whose history is served alongside this channel.
name
string
Required
The channel's name.
maxLength: 32 bytesminLength: 1 bytesownerOnly
boolean
Optional
Whether only community admins may post.
falsevisibleToMembers
array
of
string
did
Optional
Members that may read this channel in addition to visibleToRoles.
visibleToRoles
array
of
string
record-key
Optional
Roles that may read this channel. Empty or absent means every member may read it. A non-empty list makes the channel private: the community declines space credentials for it to anyone outside the list, so it is enforced by the protocol rather than only by a read handler.
View raw schema
{
"key": "literal:self",
"type": "record",
"record": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "The channel's name."
},
"ownerOnly": {
"type": "boolean",
"default": false,
"description": "Whether only community admins may post."
},
"linkEmbeds": {
"type": "boolean",
"description": "Whether link previews are shown here. Absent means the community default."
},
"description": {
"type": "string",
"maxLength": 256,
"description": "The channel's topic."
},
"allowedRoles": {
"type": "array",
"items": {
"type": "string",
"format": "record-key",
"description": "A role permitted to post."
},
"description": "Roles allowed to post here. Empty means no role restriction."
},
"migratedFrom": {
"type": "string",
"format": "at-uri",
"description": "Set on a channel created by migrating a repo-backed community. Points at the legacy channel record whose history is served alongside this channel."
},
"allowedMembers": {
"type": "array",
"items": {
"type": "string",
"format": "did",
"description": "A member permitted to post."
},
"description": "Members allowed to post here in addition to allowedRoles."
},
"visibleToRoles": {
"type": "array",
"items": {
"type": "string",
"format": "record-key",
"description": "A role permitted to read."
},
"description": "Roles that may read this channel. Empty or absent means every member may read it. A non-empty list makes the channel private: the community declines space credentials for it to anyone outside the list, so it is enforced by the protocol rather than only by a read handler."
},
"visibleToMembers": {
"type": "array",
"items": {
"type": "string",
"format": "did",
"description": "A member permitted to read."
},
"description": "Members that may read this channel in addition to visibleToRoles."
}
}
},
"description": "A channel's configuration. Lives at key 'self' in the channel's own space. The space type says whether it is a text or voice channel, and the space key is the channel's identity."
}