farm.lore.banished Documentation (EN)

main record

1 example

Bans a user from participating in a world. Only the world owner may create banishment records.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

Timestamp of the banishment.

reason string Optional

Optional reason for the banishment.

maxLength: 1024 bytes

subject string did Required

The DID of the user being banished.

world string Required

The world domain the user is being banished from.

maxLength: 253 bytes

View raw schema

{
  "description": "Bans a user from participating in a world. Only the world owner may create banishment records.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "Timestamp of the banishment.",
        "format": "datetime",
        "type": "string"
      },
      "reason": {
        "description": "Optional reason for the banishment.",
        "maxLength": 1024,
        "type": "string"
      },
      "subject": {
        "description": "The DID of the user being banished.",
        "format": "did",
        "type": "string"
      },
      "world": {
        "description": "The world domain the user is being banished from.",
        "maxLength": 253,
        "type": "string"
      }
    },
    "required": [
      "world",
      "subject",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}