Skip to content

place.stream.badge.def

Lexicon Version: 1

Type: record

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

Record Key: tid

Record Properties:

NameTypeReq’dDescriptionConstraints
namestringDisplay name for this badge.Max Length: 64
descriptionstringOptional description of the badge.Max Length: 256
imageblobBadge icon image.Accept: image/png, image/jpeg, image/gif, image/webp
Max Size: 262144 bytes
badgeTypestringThe category of this badge, used for scope and display rules.Known Values: place.stream.badge.defs#vip, place.stream.badge.defs#event
createdAtstringFormat: datetime

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