social.colibri.community.defs Documentation (EN)

applicationView object

A pending or dismissed membership application.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

data ref lex:social.colibri.actor.defs#actorData Required

No description available.

did string did Required

A decentralized identifier (DID).

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

membership string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "handle",
    "membership",
    "createdAt",
    "data"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "data": {
      "ref": "lex:social.colibri.actor.defs#actorData",
      "type": "ref"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "membership": {
      "type": "string",
      "format": "at-uri"
    }
  },
  "description": "A pending or dismissed membership application."
}

categoryView object

No description available.

Properties

channelOrder array of stringat-uri Required

No description available.

name string Required

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "name",
    "channelOrder"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "channelOrder": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      }
    }
  }
}

channelOverrideView object

No description available.

Properties

allow array of string Optional

No description available.

channel string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

deny array of string Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "channel"
  ],
  "properties": {
    "deny": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allow": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "channel": {
      "type": "string",
      "format": "at-uri"
    }
  }
}

channelView object

No description available.

Properties

allowedMembers array of stringdid Optional

No description available.

allowedRoles array of stringat-uri Optional

No description available.

category string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

description string Optional

No description available.

linkEmbeds boolean Optional

No description available.

name string Required

No description available.

ownerOnly boolean Optional

No description available.

type string nsid Required

A namespaced identifier (e.g., app.bsky.feed.post).

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "name",
    "type",
    "category"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "format": "nsid"
    },
    "category": {
      "type": "string",
      "format": "at-uri"
    },
    "ownerOnly": {
      "type": "boolean"
    },
    "linkEmbeds": {
      "type": "boolean"
    },
    "description": {
      "type": "string"
    },
    "allowedRoles": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      }
    },
    "allowedMembers": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "did"
      }
    }
  }
}

communityInfo object

Core community record data, hydrated with its AT-URI.

Properties

appview string did Required

A decentralized identifier (DID).

banner blob Optional

No description available.

categoryOrder array of stringat-uri Required

No description available.

description string Required

No description available.

linkEmbeds boolean Optional

No description available.

name string Required

No description available.

picture blob Optional

No description available.

requiresApprovalToJoin boolean Required

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "name",
    "description",
    "categoryOrder",
    "requiresApprovalToJoin",
    "appview"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "banner": {
      "type": "blob"
    },
    "appview": {
      "type": "string",
      "format": "did"
    },
    "picture": {
      "type": "blob"
    },
    "linkEmbeds": {
      "type": "boolean"
    },
    "description": {
      "type": "string"
    },
    "categoryOrder": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      }
    },
    "requiresApprovalToJoin": {
      "type": "boolean"
    }
  },
  "description": "Core community record data, hydrated with its AT-URI."
}

invitationProfileView object

An invitation with its creator hydrated as an actor.

Properties

active boolean Required

No description available.

code string Required

No description available.

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

createdBy ref lex:social.colibri.actor.defs#actorView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "code",
    "community",
    "createdBy",
    "active"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "community": {
      "type": "string",
      "format": "at-uri"
    },
    "createdBy": {
      "ref": "lex:social.colibri.actor.defs#actorView",
      "type": "ref"
    }
  },
  "description": "An invitation with its creator hydrated as an actor."
}

invitationView object

An invitation with its creator as a bare DID.

Properties

active boolean Required

No description available.

code string Required

No description available.

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

createdBy string did Required

A decentralized identifier (DID).

View raw schema

{
  "type": "object",
  "required": [
    "code",
    "community",
    "createdBy",
    "active"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "community": {
      "type": "string",
      "format": "at-uri"
    },
    "createdBy": {
      "type": "string",
      "format": "did"
    }
  },
  "description": "An invitation with its creator as a bare DID."
}

memberView object

A community member, hydrated with their actor data.

Properties

data ref lex:social.colibri.actor.defs#actorData Required

No description available.

did string did Required

A decentralized identifier (DID).

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

roles array of stringat-uri Required

No description available.

vc string at-uri Optional

AT-URI of the voice channel the member is currently connected to, if any.

vcDeafened boolean Optional

Whether the member is deafened in the voice channel.

vcMuted boolean Optional

Whether the member's microphone is muted in the voice channel.

vcServerDeafened boolean Optional

Whether the member has been server-deafened by a moderator in the voice channel.

vcServerMuted boolean Optional

Whether the member has been server-muted by a moderator in the voice channel.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "handle",
    "roles",
    "data"
  ],
  "properties": {
    "vc": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the voice channel the member is currently connected to, if any."
    },
    "did": {
      "type": "string",
      "format": "did"
    },
    "data": {
      "ref": "lex:social.colibri.actor.defs#actorData",
      "type": "ref"
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      }
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "vcMuted": {
      "type": "boolean",
      "description": "Whether the member's microphone is muted in the voice channel."
    },
    "vcDeafened": {
      "type": "boolean",
      "description": "Whether the member is deafened in the voice channel."
    },
    "vcServerMuted": {
      "type": "boolean",
      "description": "Whether the member has been server-muted by a moderator in the voice channel."
    },
    "vcServerDeafened": {
      "type": "boolean",
      "description": "Whether the member has been server-deafened by a moderator in the voice channel."
    }
  },
  "description": "A community member, hydrated with their actor data."
}

resolvedInvitationView object

An invitation hydrated with its community's public details, for the invite accept screen.

Properties

active boolean Required

No description available.

banner blob Optional

No description available.

code string Required

No description available.

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

createdBy string did Required

A decentralized identifier (DID).

memberCount integer Required

No description available.

name string Required

No description available.

onlineCount integer Required

No description available.

picture blob Optional

No description available.

requiresApprovalToJoin boolean Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "code",
    "community",
    "createdBy",
    "active",
    "name",
    "memberCount",
    "onlineCount",
    "requiresApprovalToJoin"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "banner": {
      "type": "blob"
    },
    "picture": {
      "type": "blob"
    },
    "community": {
      "type": "string",
      "format": "at-uri"
    },
    "createdBy": {
      "type": "string",
      "format": "did"
    },
    "memberCount": {
      "type": "integer"
    },
    "onlineCount": {
      "type": "integer"
    },
    "requiresApprovalToJoin": {
      "type": "boolean"
    }
  },
  "description": "An invitation hydrated with its community's public details, for the invite accept screen."
}

roleView object

No description available.

Properties

channelOverrides array of reflex:social.colibri.community.defs#channelOverrideView Optional

No description available.

color string Optional

No description available.

hoisted boolean Optional

No description available.

mentionable boolean Optional

No description available.

name string Required

No description available.

permissions array of string Required

No description available.

position integer Required

No description available.

protected boolean Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "name",
    "permissions",
    "position"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "color": {
      "type": "string"
    },
    "hoisted": {
      "type": "boolean"
    },
    "position": {
      "type": "integer"
    },
    "protected": {
      "type": "boolean"
    },
    "mentionable": {
      "type": "boolean"
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "channelOverrides": {
      "type": "array",
      "items": {
        "ref": "lex:social.colibri.community.defs#channelOverrideView",
        "type": "ref"
      }
    }
  }
}