A community, or "server", is where users join to interact with each other on Colibri.
Record Key
tid
Timestamp-based ID
Properties
$type
string
nsid
Optional
The type of the record.
categoryOrder
array
of
string
record-key
Required
The order of the categories in this community.
description
string
Required
A description of the community.
maxLength: 256 bytesDefault:
name
string
Required
The name of the community.
maxLength: 32 bytesminLength: 1 bytesDefault:
New Communitypicture
blob
Optional
An image for the community that will be shown to users.
requiresApprovalToJoin
boolean
Required
Whether users can chat in this community without the owner having to create an acknowledgement record.
Default:
trueView raw schema
{
"key": "tid",
"type": "record",
"record": {
"type": "object",
"required": [
"name",
"description",
"categoryOrder",
"requiresApprovalToJoin"
],
"properties": {
"name": {
"type": "string",
"default": "New Community",
"maxLength": 32,
"minLength": 1,
"description": "The name of the community."
},
"$type": {
"type": "string",
"format": "nsid",
"description": "The type of the record."
},
"picture": {
"type": "blob",
"accept": [
"image/jpeg",
"image/png",
"image/gif"
],
"description": "An image for the community that will be shown to users."
},
"description": {
"type": "string",
"default": "",
"maxLength": 256,
"description": "A description of the community."
},
"categoryOrder": {
"type": "array",
"items": {
"type": "string",
"format": "record-key",
"description": "A category in this community."
},
"description": "The order of the categories in this community."
},
"requiresApprovalToJoin": {
"type": "boolean",
"default": true,
"description": "Whether users can chat in this community without the owner having to create an acknowledgement record."
}
}
},
"description": "A community, or \"server\", is where users join to interact with each other on Colibri."
}