place.stream.badge.defs

Shared type definitions.

atproto_client.models.place.stream.badge.defs.Bot

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

alias of Literal[‘place.stream.badge.defs#bot’]

atproto_client.models.place.stream.badge.defs.Mod

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

alias of Literal[‘place.stream.badge.defs#mod’]

atproto_client.models.place.stream.badge.defs.Vip

This user is a very important person.

alias of Literal[‘place.stream.badge.defs#vip’]

atproto_client.models.place.stream.badge.defs.Event

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

alias of Literal[‘place.stream.badge.defs#event’]

atproto_client.models.place.stream.badge.defs.Streamer

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

alias of Literal[‘place.stream.badge.defs#streamer’]

class atproto_client.models.place.stream.badge.defs.BadgeSlot

Bases: ModelBase

Definition model for place.stream.badge.defs. A display slot containing available issuance-based badges and which one (if any) is currently selected.

field available: List[models.PlaceStreamBadgeDefs.BadgeIssuanceView] [Required]

All badges available for this slot.

field selected: models.PlaceStreamBadgeDefs.BadgeIssuanceView | None = None

class atproto_client.models.place.stream.badge.defs.BadgeView

Bases: ModelBase

Definition model for place.stream.badge.defs. 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.

field badge_type: models.PlaceStreamBadgeDefs.Mod | models.PlaceStreamBadgeDefs.Streamer | models.PlaceStreamBadgeDefs.Vip | models.PlaceStreamBadgeDefs.Event | models.PlaceStreamBadgeDefs.Bot | str [Required]

Badge type.

field description: str | None = None

Description from the badge definition.

field image_url: Uri | None = None

Resolved image URL for the badge icon.

field issuer: Did [Required]

DID of the badge issuer.

field name: str | None = None

Display name from the badge definition.

field recipient: Did [Required]

DID of the badge recipient.

field signature: str | None = None

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

class atproto_client.models.place.stream.badge.defs.BadgeIssuanceView

Bases: ModelBase

Definition model for place.stream.badge.defs. A resolved view of a badge issuance, including def fields for display.

field badge_type: models.PlaceStreamBadgeDefs.Vip | models.PlaceStreamBadgeDefs.Event | str [Required]

Badge type.

field description: str | None = None

Description from the badge definition.

field image_url: Uri | None = None

Resolved image URL for the badge icon.

field issuance_cid: str | None = None

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

field issuance_uri: AtUri [Required]

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

field issuer: Did [Required]

DID of the badge issuer.

field name: str | None = None

Display name from the badge definition.

field selected: bool | None = None

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