place.stream.badge.defs
#bot
TOKEN: This user is a bot. Self-applied via place.stream.chat.profile selfLabels.
#mod
TOKEN: This user is a moderator. Displayed with a sword icon.
#vip
TOKEN: This user is a very important person.
#event
TOKEN: This user has won or earned a special event or contest badge.
#streamer
TOKEN: This user is the streamer. Displayed with a star icon.
#badgeSlot
A display slot containing available issuance-based badges and which one (if any) is currently selected.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| selected | #badgeIssuanceView | - | ❌ | - |
| available | array of #badgeIssuanceView | - | ✅ | All badges available for this slot. |
#badgeView
View of a badge record, with fields resolved for display. If the DID in issuer is not the current streamplace node, the signature field shall be required.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| name | string | - | ❌ | Display name from the badge definition. |
| issuer | string (did) | - | ✅ | DID of the badge issuer. |
| imageUrl | string (uri) | - | ❌ | Resolved image URL for the badge icon. |
| badgeType | string | place.stream.badge.defs#mod place.stream.badge.defs#streamer place.stream.badge.defs#vip place.stream.badge.defs#event place.stream.badge.defs#bot | ✅ | - |
| recipient | string (did) | - | ✅ | DID of the badge recipient. |
| signature | string | - | ❌ | TODO: Cryptographic signature of the badge (of a place.stream.key). |
| description | string | - | ❌ | Description from the badge definition. |
#badgeIssuanceView
A resolved view of a badge issuance, including def fields for display.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| name | string | - | ❌ | Display name from the badge definition. |
| issuer | string (did) | - | ✅ | DID of the badge issuer. |
| imageUrl | string (uri) | - | ❌ | Resolved image URL for the badge icon. |
| selected | boolean | - | ❌ | Whether this badge is currently in the user's chat profile selection. |
| badgeType | string | place.stream.badge.defs#vip place.stream.badge.defs#event | ✅ | - |
| description | string | - | ❌ | Description from the badge definition. |
| issuanceCid | string | - | ❌ | CID of the place.stream.badge.issuance record. |
| issuanceUri | string (at-uri) | - | ✅ | AT URI of the place.stream.badge.issuance record. |