com.welistskyblue.graph.group Documentation (EN)

main record

A group that bundles accounts together.

Record Key tid Timestamp-based ID

Properties

avatar blob Optional

Avatar image for the group.

maxSize: 1.0 MB

createdAt string datetime Required

Group creation timestamp.

description string Optional

A short description of the group.

maxLength: 300 bytesmaxGraphemes: 3000 graphemes

name string Required

The display name of the group.

maxLength: 100 bytesminLength: 1 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1,
        "description": "The display name of the group."
      },
      "avatar": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg"
        ],
        "maxSize": 1000000,
        "description": "Avatar image for the group."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Group creation timestamp."
      },
      "description": {
        "type": "string",
        "maxLength": 300,
        "description": "A short description of the group.",
        "maxGraphemes": 3000
      }
    }
  },
  "description": "A group that bundles accounts together."
}