app.bsky.actor.defs

Definition model for app.bsky.actor.defs. Metadata about the requesting account’s relationship with the subject account. Only has meaningful content for authed requests.

field activity_subscription: models.AppBskyNotificationDefs.ActivitySubscription | None = None

field blocked_by: bool | None = None: Blocked by.

field blocking: AtUri | None = None: Blocking.

field blocking_by_list: models.AppBskyGraphDefs.ListViewBasic | None = None: Blocking by list.

field followed_by: AtUri | None = None: Followed by.

field following: AtUri | None = None: Following.

field known_followers: models.AppBskyActorDefs.KnownFollowers | None = None

field muted: bool | None = None

field muted_by_list: models.AppBskyGraphDefs.ListViewBasic | None = None: Muted by list.

field muted_only_quoteposts: bool | None = None

field muted_only_reposts: bool | None = None

class atproto_client.models.app.bsky.actor.defs.KnownFollowers

Bases: ModelBase

Definition model for app.bsky.actor.defs. The subject’s followers whom you also follow.

field count: int [Required]: Count.

field followers: List[models.AppBskyActorDefs.ProfileViewBasic] [Required]

Followers.

Constraints:

min_length = 0
max_length = 5

class atproto_client.models.app.bsky.actor.defs.VerificationState

Bases: ModelBase

Definition model for app.bsky.actor.defs. Represents the verification information about the user this object is attached to.

field trusted_verifier_status: Literal['valid', 'invalid', 'none'] | str [Required]: The user’s status as a trusted verifier.

field verifications: List[models.AppBskyActorDefs.VerificationView] [Required]: All verifications issued by trusted verifiers on behalf of this user. Verifications by untrusted verifiers are not included.

field verified_status: Literal['valid', 'invalid', 'none'] | str [Required]: The user’s status as a verified account.

class atproto_client.models.app.bsky.actor.defs.VerificationView

Bases: ModelBase

Definition model for app.bsky.actor.defs. An individual verification for an associated subject.

field created_at: DateTime [Required]: Timestamp when the verification was created.

field is_valid: bool [Required]: True if the verification passes validation, otherwise false.

field issuer: Did [Required]: The user who issued this verification.

field issuer_display_name: str | None = None: The display name of the issuer.

field issuer_handle: Handle | None = None: The handle of the issuer.

field uri: AtUri [Required]: The AT-URI of the verification record.

class atproto_client.models.app.bsky.actor.defs.AdultContentPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field enabled: bool = False: Enabled.

class atproto_client.models.app.bsky.actor.defs.ContentLabelPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field label: str [Required]: Label.

field labeler_did: Did | None = None

field visibility: Literal['ignore', 'show', 'warn', 'hide'] | str [Required]: Visibility.

class atproto_client.models.app.bsky.actor.defs.SavedFeed

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field id: str [Required]: Id.

field pinned: bool [Required]: Pinned.

field type: Literal['feed', 'list', 'timeline'] | str [Required]: Type.

field value: str [Required]: Value.

class atproto_client.models.app.bsky.actor.defs.SavedFeedsPrefV2

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field items: List[models.AppBskyActorDefs.SavedFeed] [Required]: Items.

class atproto_client.models.app.bsky.actor.defs.SavedFeedsPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field pinned: List[AtUri] [Required]: Pinned.

field saved: List[AtUri] [Required]: Saved.

field timeline_index: int | None = None: Timeline index.

class atproto_client.models.app.bsky.actor.defs.PersonalDetailsPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field birth_date: DateTime | None = None: The birth date of account owner.

class atproto_client.models.app.bsky.actor.defs.DeclaredAgePref

Bases: ModelBase

Definition model for app.bsky.actor.defs. Read-only preference containing value(s) inferred from the user’s declared birthdate. Absence of this preference object in the response indicates that the user has not made a declaration.

field is_over_age13: bool | None = None: Indicates if the user has declared that they are over 13 years of age.

field is_over_age16: bool | None = None: Indicates if the user has declared that they are over 16 years of age.

field is_over_age18: bool | None = None: Indicates if the user has declared that they are over 18 years of age.

class atproto_client.models.app.bsky.actor.defs.FeedViewPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field feed: str [Required]: The URI of the feed, or an identifier which describes the feed.

field hide_quote_posts: bool | None = None: Hide quote posts in the feed.

field hide_replies: bool | None = None: Hide replies in the feed.

field hide_replies_by_like_count: int | None = None

field hide_replies_by_unfollowed: bool | None = True: Hide replies in the feed if they are not by followed users.

field hide_reposts: bool | None = None: Hide reposts in the feed.

class atproto_client.models.app.bsky.actor.defs.ThreadViewPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field sort: Literal['oldest', 'newest', 'most-likes', 'random', 'hotness'] | str | None = None

class atproto_client.models.app.bsky.actor.defs.InterestsPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field tags: List[str] [Required]

A list of tags which describe the account owner’s interests gathered during onboarding.

Constraints:

max_length = 100

field updated_at: DateTime | None = None

atproto_client.models.app.bsky.actor.defs.MutedWordTarget

Muted word target

alias of Literal[‘content’, ‘tag’] | str

class atproto_client.models.app.bsky.actor.defs.MutedWord

Bases: ModelBase

Definition model for app.bsky.actor.defs. A word that the account owner has muted.

field actor_target: Literal['all', 'exclude-following'] | str | None = 'all'

field expires_at: DateTime | None = None

field id: str | None = None: Id.

field targets: List[models.AppBskyActorDefs.MutedWordTarget] [Required]: The intended targets of the muted word.

field value: str [Required]

The muted word itself.

Constraints:

max_length = 10000

class atproto_client.models.app.bsky.actor.defs.MutedWordsPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field items: List[models.AppBskyActorDefs.MutedWord] [Required]: A list of words the account owner has muted.

class atproto_client.models.app.bsky.actor.defs.HiddenPostsPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field items: List[AtUri] [Required]: A list of URIs of posts the account owner has hidden.

class atproto_client.models.app.bsky.actor.defs.LabelersPref

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field labelers: List[models.AppBskyActorDefs.LabelerPrefItem] [Required]: Labelers.

class atproto_client.models.app.bsky.actor.defs.LabelerPrefItem

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field did: Did [Required]: Did.

class atproto_client.models.app.bsky.actor.defs.BskyAppStatePref

Bases: ModelBase

Definition model for app.bsky.actor.defs. A grab bag of state that’s specific to the bsky.app program. Third-party apps shouldn’t use this.

field active_progress_guide: models.AppBskyActorDefs.BskyAppProgressGuide | None = None: Active progress guide.

field is_beta_user: bool | None = None: Indicates if the user is participating in the beta features program.

field nuxs: List[models.AppBskyActorDefs.Nux] | None = None

Constraints:

max_length = 100

field queued_nudges: List[str] | None = None

Constraints:

max_length = 1000

class atproto_client.models.app.bsky.actor.defs.BskyAppProgressGuide

Bases: ModelBase

Definition model for app.bsky.actor.defs. If set, an active progress guide. Once completed, can be set to undefined. Should have unspecced fields tracking progress.

field guide: str [Required]

Guide.

Constraints:

max_length = 100

class atproto_client.models.app.bsky.actor.defs.Nux

Bases: ModelBase

Definition model for app.bsky.actor.defs. A new user experiences (NUX) storage object.

field completed: bool = False: Completed.

field data: str | None = None

Constraints:

max_length = 3000

field expires_at: DateTime | None = None

field id: str [Required]

Id.

Constraints:

max_length = 100

class atproto_client.models.app.bsky.actor.defs.VerificationPrefs

Bases: ModelBase

Definition model for app.bsky.actor.defs. Preferences for how verified accounts appear in the app.

field hide_badges: bool | None = False: Hide the blue check badges for verified accounts and trusted verifiers.

class atproto_client.models.app.bsky.actor.defs.LiveEventPreferences

Bases: ModelBase

Definition model for app.bsky.actor.defs. Preferences for live events.

field hidden_feed_ids: List[str] | None = None: A list of feed IDs that the user has hidden from live events.

field hide_all_feeds: bool | None = False: Whether to hide all feeds from live events.

class atproto_client.models.app.bsky.actor.defs.PostInteractionSettingsPref

Bases: ModelBase

Definition model for app.bsky.actor.defs. Default post interaction settings for the account. These values should be applied as default values when creating new posts. These refs should mirror the threadgate and postgate records exactly.

field postgate_embedding_rules: List[models.AppBskyFeedPostgate.DisableRule | DotDict] | None = None

Constraints:

max_length = 5

Constraints:

max_length = 5

class atproto_client.models.app.bsky.actor.defs.StatusView

Bases: ModelBase

Definition model for app.bsky.actor.defs.

field cid: Cid | None = None: Cid.

field embed: models.AppBskyEmbedExternal.View | DotDict | None = None

field expires_at: DateTime | None = None

field is_active: bool | None = None

field is_disabled: bool | None = None

field labels: List[models.ComAtprotoLabelDefs.Label] | None = None: Labels.

field record: UnknownType [Required]

Record.

Constraints:

__module__ = atproto_client.models.unknown_union
__firstlineno__ = 72
__doc__ = Annotation for lexicon unknown fields: any registered record type, else DotDict. Record types are looked up in the runtime registry rather than in a union fixed at import time, so a record defined by a package generated from custom lexicons is decoded to its own model.
__get_pydantic_core_schema__ = <bound method UnknownRecordFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownRecordFallback’>>
__static_attributes__ = ()
__dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 72, ‘__doc__’: ‘Annotation for lexicon unknown fields: any registered record type, else DotDict.nnRecord types are looked up in the runtime registry rather than in a union fixed at import time,nso a record defined by a package generated from custom lexicons is decoded to its own model.n’, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownRecordFallback.__get_pydantic_core_schema__ at 0x7bdd14e57100>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownRecordFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>}
__weakref__ = <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>

field status: models.AppBskyActorStatus.Live | str [Required]: The status for the account.

field uri: AtUri | None = None: Uri.

type atproto_client.models.app.bsky.actor.defs.Preferences: The preferences of an account, in the order the service returned them.