app.protoimsg.chat.community Documentation (EN)

main record

The user's community list. Portable across any app implementing the Lexicon.

Record Key literal:self Fixed literal value

Properties

groups array of ref #communityGroup Required

Named groups of community members, like AIM's buddy list categories.

maxLength: 50 items

View raw schema

{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "groups"
    ],
    "properties": {
      "groups": {
        "type": "array",
        "items": {
          "ref": "#communityGroup",
          "type": "ref"
        },
        "maxLength": 50,
        "description": "Named groups of community members, like AIM's buddy list categories."
      }
    }
  },
  "description": "The user's community list. Portable across any app implementing the Lexicon."
}

communityGroup object

A named group of community members.

Properties

isInnerCircle boolean Optional

Whether this is an inner circle group for presence visibility.

members array of ref#communityMember Required

DIDs of group members.

maxLength: 500 items

name string Required

Group label.

maxLength: 100 bytes

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "members"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "description": "Group label."
    },
    "members": {
      "type": "array",
      "items": {
        "ref": "#communityMember",
        "type": "ref"
      },
      "maxLength": 500,
      "description": "DIDs of group members."
    },
    "isInnerCircle": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is an inner circle group for presence visibility."
    }
  },
  "description": "A named group of community members."
}

communityMember object

A member in a community group.

Properties

addedAt string datetime Required

When this member was added.

did string did Required

The member's DID.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "addedAt"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "The member's DID."
    },
    "addedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When this member was added."
    }
  },
  "description": "A member in a community group."
}