app.protoimsg.chat.ban Documentation (EN)

main record

A ban issued by a room owner or moderator. Lives in the issuer's repo.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

Timestamp of ban.

reason string Optional

Reason for the ban.

maxLength: 300 bytes

room string at-uri Required

AT-URI of the room the ban applies to.

subject string did Required

DID of the banned user.

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "room",
      "subject",
      "createdAt"
    ],
    "properties": {
      "room": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the room the ban applies to."
      },
      "reason": {
        "type": "string",
        "maxLength": 300,
        "description": "Reason for the ban."
      },
      "subject": {
        "type": "string",
        "format": "did",
        "description": "DID of the banned user."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of ban."
      }
    }
  },
  "description": "A ban issued by a room owner or moderator. Lives in the issuer's repo."
}