place.stream.badge.def Documentation (EN)

main record

Defines a badge's visual appearance and type. Created by the issuer and referenced by issuance records.

Record Key tid Timestamp-based ID

Properties

badgeType string Required

The category of this badge, used for scope and display rules.

Known values: place.stream.badge.defs#vip, place.stream.badge.defs#event

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

Optional description of the badge.

maxLength: 256 bytes

image blob Optional

Badge icon image.

maxSize: 262.1 KB

name string Required

Display name for this badge.

maxLength: 64 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "badgeType",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 64,
        "description": "Display name for this badge."
      },
      "image": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg",
          "image/gif",
          "image/webp"
        ],
        "maxSize": 262144,
        "description": "Badge icon image."
      },
      "badgeType": {
        "type": "string",
        "description": "The category of this badge, used for scope and display rules.",
        "knownValues": [
          "place.stream.badge.defs#vip",
          "place.stream.badge.defs#event"
        ]
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "description": {
        "type": "string",
        "maxLength": 256,
        "description": "Optional description of the badge."
      }
    }
  },
  "description": "Defines a badge's visual appearance and type. Created by the issuer and referenced by issuance records."
}