place.stream.badge.defs

did:web:stream.place

Documentation

badgeIssuanceView object

A resolved view of a badge issuance, including def fields for display.

Properties

badgeType string Required

No description available.

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

Description from the badge definition.

imageUrl string uri Optional

Resolved image URL for the badge icon.

issuanceCid string Optional

CID of the place.stream.badge.issuance record.

issuanceUri string at-uri Required

AT URI of the place.stream.badge.issuance record.

issuer string did Required

DID of the badge issuer.

name string Optional

Display name from the badge definition.

selected boolean Optional

Whether this badge is currently in the user's chat profile selection.

View raw schema
{
  "type": "object",
  "required": [
    "issuanceUri",
    "badgeType",
    "issuer"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name from the badge definition."
    },
    "issuer": {
      "type": "string",
      "format": "did",
      "description": "DID of the badge issuer."
    },
    "imageUrl": {
      "type": "string",
      "format": "uri",
      "description": "Resolved image URL for the badge icon."
    },
    "selected": {
      "type": "boolean",
      "description": "Whether this badge is currently in the user's chat profile selection."
    },
    "badgeType": {
      "type": "string",
      "knownValues": [
        "place.stream.badge.defs#vip",
        "place.stream.badge.defs#event"
      ]
    },
    "description": {
      "type": "string",
      "description": "Description from the badge definition."
    },
    "issuanceCid": {
      "type": "string",
      "description": "CID of the place.stream.badge.issuance record."
    },
    "issuanceUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the place.stream.badge.issuance record."
    }
  },
  "description": "A resolved view of a badge issuance, including def fields for display."
}
badgeSlot object

A display slot containing available issuance-based badges and which one (if any) is currently selected.

Properties

selected ref #badgeIssuanceView Optional

The currently selected badge in this slot, if any.

View raw schema
{
  "type": "object",
  "required": [
    "available"
  ],
  "properties": {
    "selected": {
      "ref": "#badgeIssuanceView",
      "type": "ref",
      "description": "The currently selected badge in this slot, if any."
    },
    "available": {
      "type": "array",
      "items": {
        "ref": "#badgeIssuanceView",
        "type": "ref"
      },
      "description": "All badges available for this slot."
    }
  },
  "description": "A display slot containing available issuance-based badges and which one (if any) is currently selected."
}
badgeView object

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.

Properties

badgeType string Required

No description available.

Known values: 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
description string Optional

Description from the badge definition.

imageUrl string uri Optional

Resolved image URL for the badge icon.

issuer string did Required

DID of the badge issuer.

name string Optional

Display name from the badge definition.

recipient string did Required

DID of the badge recipient.

signature string Optional

TODO: Cryptographic signature of the badge (of a place.stream.key).

View raw schema
{
  "type": "object",
  "required": [
    "badgeType",
    "issuer",
    "recipient"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name from the badge definition."
    },
    "issuer": {
      "type": "string",
      "format": "did",
      "description": "DID of the badge issuer."
    },
    "imageUrl": {
      "type": "string",
      "format": "uri",
      "description": "Resolved image URL for the badge icon."
    },
    "badgeType": {
      "type": "string",
      "knownValues": [
        "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": {
      "type": "string",
      "format": "did",
      "description": "DID of the badge recipient."
    },
    "signature": {
      "type": "string",
      "description": "TODO: Cryptographic signature of the badge (of a place.stream.key)."
    },
    "description": {
      "type": "string",
      "description": "Description from the badge definition."
    }
  },
  "description": "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."
}
bot token

This user is a bot. Self-applied via place.stream.chat.profile selfLabels.

Referenceplace.stream.badge.defs#bot

Tokens have no data representation. Use the reference string as a value.

View raw schema
{
  "type": "token",
  "description": "This user is a bot. Self-applied via place.stream.chat.profile selfLabels."
}
event token

This user has won or earned a special event or contest badge.

Referenceplace.stream.badge.defs#event

Tokens have no data representation. Use the reference string as a value.

View raw schema
{
  "type": "token",
  "description": "This user has won or earned a special event or contest badge."
}
mod token

This user is a moderator. Displayed with a sword icon.

Referenceplace.stream.badge.defs#mod

Tokens have no data representation. Use the reference string as a value.

View raw schema
{
  "type": "token",
  "description": "This user is a moderator. Displayed with a sword icon."
}
streamer token

This user is the streamer. Displayed with a star icon.

Referenceplace.stream.badge.defs#streamer

Tokens have no data representation. Use the reference string as a value.

View raw schema
{
  "type": "token",
  "description": "This user is the streamer. Displayed with a star icon."
}
vip token

This user is a very important person.

Referenceplace.stream.badge.defs#vip

Tokens have no data representation. Use the reference string as a value.

View raw schema
{
  "type": "token",
  "description": "This user is a very important person."
}

Lexicon Garden

@