chat.bsky.group.defs

Shared type definitions.

atproto_client.models.chat.bsky.group.defs.LinkEnabledStatus

Link enabled status

alias of Literal[‘enabled’, ‘disabled’] | str

atproto_client.models.chat.bsky.group.defs.JoinRule

Join rule

alias of Literal[‘anyone’, ‘followedByOwner’] | str

class atproto_client.models.chat.bsky.group.defs.JoinLinkView

Bases: ModelBase

Definition model for chat.bsky.group.defs. Join link view to be used within a group view, so the convo is surrounding, not specified inside this view.

field code: str [Required]

Code.

field created_at: DateTime [Required]

Created at.

field enabled_status: models.ChatBskyGroupDefs.LinkEnabledStatus [Required]

Enabled status.

field join_rule: models.ChatBskyGroupDefs.JoinRule [Required]

Join rule.

field require_approval: bool [Required]

Require approval.

class atproto_client.models.chat.bsky.group.defs.JoinLinkPreviewView

Bases: ModelBase

Definition model for chat.bsky.group.defs. Preview that can be shown in feeds, including to unauthenticated viewers.

field code: str [Required]

Code.

field convo: models.ChatBskyConvoDefs.ConvoView | None = None

field convo_id: str [Required]

Convo id.

field join_rule: models.ChatBskyGroupDefs.JoinRule [Required]

Join rule.

field member_count: int [Required]

Member count.

field member_limit: int [Required]

Member limit.

field name: str [Required]

Name.

field owner: models.ChatBskyActorDefs.ProfileViewBasic [Required]

Owner.

field require_approval: bool [Required]

Require approval.

field viewer: models.ChatBskyGroupDefs.JoinLinkViewerState | None = None

Viewer.

class atproto_client.models.chat.bsky.group.defs.DisabledJoinLinkPreviewView

Bases: ModelBase

Definition model for chat.bsky.group.defs. Preview for a disabled join link. Carries only the code so clients can correlate with the input and render a disabled state.

field code: str [Required]

Code.

class atproto_client.models.chat.bsky.group.defs.InvalidJoinLinkPreviewView

Bases: ModelBase

Definition model for chat.bsky.group.defs. Preview for a join link code that does not map to an existing link. Carries only the code so clients can correlate with the input and render an invalid state.

field code: str [Required]

Code.

class atproto_client.models.chat.bsky.group.defs.JoinLinkViewerState

Bases: ModelBase

Definition model for chat.bsky.group.defs.

field requested_at: DateTime | None = None

Requested at.

class atproto_client.models.chat.bsky.group.defs.JoinRequestView

Bases: ModelBase

Definition model for chat.bsky.group.defs. A join request from the perspective of the group owner.

field convo_id: str [Required]

Convo id.

field requested_at: DateTime [Required]

Requested at.

field requested_by: models.ChatBskyActorDefs.ProfileViewBasic [Required]

Requested by.

class atproto_client.models.chat.bsky.group.defs.JoinRequestConvoView

Bases: ModelBase

Definition model for chat.bsky.group.defs. A join request from the perspective of the requester, including enough group context to render the request in a list (e.g. group name, owner, member count).

field convo_id: str [Required]

Convo id.

field member_count: int [Required]

Member count.

field member_limit: int [Required]

Member limit.

field name: str [Required]

Name.

field owner: models.ChatBskyActorDefs.ProfileViewBasic [Required]

Owner.

field viewer: models.ChatBskyGroupDefs.JoinLinkViewerState [Required]

Viewer.