social.colibri.community

colibri.social

Documentation

A community, or "server", is where users join to interact with each other on Colibri. Singleton record on the community DID's repo.

main record

A community, or "server", is where users join to interact with each other on Colibri. Singleton record on the community DID's repo.

Record Key literal:self Fixed literal value

Properties

$type string nsid Optional

The type of the record.

appview string did Optional

DID of the AppView that administers this community and acts as its off-protocol hub (Humming presence relay and voice SFU host). Written by the credential-holding AppView. Consumers that find this field absent fall back to did:web:api.colibri.social.

banner blob Optional

A banner for the community that will be shown to users.

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 bytes
Default:
linkEmbeds boolean Optional

Whether link previews are displayed in this community by default. Individual channels may override this.

Default: true
migratedFrom string at-uri Optional

Set on a community created by migrating a legacy community. Points at the legacy community record this one replaces.

migratedTo string at-uri Optional

Set on a legacy community record once it has been migrated. Points at the new community record that replaces it; consumers treat this community as retired and hide it.

name string Required

The name of the community.

maxLength: 32 bytesminLength: 1 bytes
Default: New Community
picture 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: true
View raw schema 
{
  "key": "literal:self",
  "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."
      },
      "banner": {
        "type": "blob",
        "accept": [
          "image/jpeg",
          "image/png",
          "image/gif",
          "image/webp"
        ],
        "description": "A banner for the community that will be shown to users."
      },
      "appview": {
        "type": "string",
        "format": "did",
        "description": "DID of the AppView that administers this community and acts as its off-protocol hub (Humming presence relay and voice SFU host). Written by the credential-holding AppView. Consumers that find this field absent fall back to did:web:api.colibri.social."
      },
      "picture": {
        "type": "blob",
        "accept": [
          "image/jpeg",
          "image/png",
          "image/gif",
          "image/webp"
        ],
        "description": "An image for the community that will be shown to users."
      },
      "linkEmbeds": {
        "type": "boolean",
        "default": true,
        "description": "Whether link previews are displayed in this community by default. Individual channels may override this."
      },
      "migratedTo": {
        "type": "string",
        "format": "at-uri",
        "description": "Set on a legacy community record once it has been migrated. Points at the new community record that replaces it; consumers treat this community as retired and hide it."
      },
      "description": {
        "type": "string",
        "default": "",
        "maxLength": 256,
        "description": "A description of the community."
      },
      "migratedFrom": {
        "type": "string",
        "format": "at-uri",
        "description": "Set on a community created by migrating a legacy community. Points at the legacy community record this one replaces."
      },
      "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. Singleton record on the community DID's repo."
}

Lexicon Garden

@