bluesky/app.bsky.actor

Package-level declarations

Types

data class AdultContentPref(val enabled: Boolean)

data class BskyAppProgressGuide(val guide: String)

If set, an active progress guide. Once completed, can be set to undefined. Should have unspecced fields tracking progress.

BskyAppStatePref

@Serializable

data class BskyAppStatePref(val activeProgressGuide: BskyAppProgressGuide? = null, val queuedNudges: List<String>? = null, val nuxs: List<Nux>? = null)

A grab bag of state that's specific to the bsky.app program. Third-party apps shouldn't use this.

ContentLabelPref

@Serializable

data class ContentLabelPref(val labelerDid: Did? = null, val label: String, val visibility: ContentLabelPrefVisibility)

ContentLabelPrefVisibility

@Serializable(with = ContentLabelPrefVisibilitySerializer::class)

sealed class ContentLabelPrefVisibility : AtpEnum

ContentLabelPrefVisibilitySerializer

class ContentLabelPrefVisibilitySerializer : KSerializer<ContentLabelPrefVisibility>

DeclaredAgePref

@Serializable

data class DeclaredAgePref(val isOverAge13: Boolean? = null, val isOverAge16: Boolean? = null, val isOverAge18: Boolean? = null)

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.

FeedViewPref

@Serializable

data class FeedViewPref(val feed: String, val hideReplies: Boolean? = null, val hideRepliesByUnfollowed: Boolean? = true, val hideRepliesByLikeCount: Long? = null, val hideReposts: Boolean? = null, val hideQuotePosts: Boolean? = null)

GetPreferencesResponse

@Serializable

data class GetPreferencesResponse(val preferences: List<PreferencesUnion>)

GetProfileQueryParams

@Serializable

data class GetProfileQueryParams(val actor: AtIdentifier)

GetProfileResponse

typealias GetProfileResponse = ProfileViewDetailed

GetProfilesQueryParams

@Serializable

data class GetProfilesQueryParams(val actors: List<AtIdentifier>)

GetProfilesResponse

@Serializable

data class GetProfilesResponse(val profiles: List<ProfileViewDetailed>)

GetSuggestionsQueryParams

@Serializable

data class GetSuggestionsQueryParams(val limit: Long? = 50, val cursor: String? = null)

GetSuggestionsResponse

@Serializable

data class GetSuggestionsResponse(val cursor: String? = null, val actors: List<ProfileView>, val recId: Long? = null, val recIdStr: String? = null)

HiddenPostsPref

@Serializable

data class HiddenPostsPref(val items: List<AtUri>)

InterestsPref

@Serializable

data class InterestsPref(val tags: List<String>)

KnownFollowers

@Serializable

data class KnownFollowers(val count: Long, val followers: List<ProfileViewBasic>)

The subject's followers whom you also follow

LabelerPrefItem

@Serializable

data class LabelerPrefItem(val did: Did)

LabelersPref

@Serializable

data class LabelersPref(val labelers: List<LabelerPrefItem>)

LiveEventPreferences

@Serializable

data class LiveEventPreferences(val hiddenFeedIds: List<String>? = null, val hideAllFeeds: Boolean? = false)

Preferences for live events.

MutedWord

@Serializable

data class MutedWord(val id: String? = null, val value: String, val targets: List<MutedWordTarget>, val actorTarget: MutedWordActorTarget? = MutedWordActorTarget.All, val expiresAt: Timestamp? = null)

A word that the account owner has muted.

MutedWordActorTarget

@Serializable(with = MutedWordActorTargetSerializer::class)

sealed class MutedWordActorTarget : AtpEnum

Groups of users to apply the muted word to. If undefined, applies to all users.

MutedWordActorTargetSerializer

class MutedWordActorTargetSerializer : KSerializer<MutedWordActorTarget>

MutedWordsPref

@Serializable

data class MutedWordsPref(val items: List<MutedWord>)

MutedWordTarget

@Serializable(with = MutedWordTargetSerializer::class)

sealed class MutedWordTarget : AtpEnum

MutedWordTargetSerializer

class MutedWordTargetSerializer : KSerializer<MutedWordTarget>

Nux

@Serializable

data class Nux(val id: String, val completed: Boolean, val data: String? = null, val expiresAt: Timestamp? = null)

A new user experiences (NUX) storage object

PersonalDetailsPref

@Serializable

data class PersonalDetailsPref(val birthDate: Timestamp? = null)

PostInteractionSettingsPref

@Serializable

data class PostInteractionSettingsPref(val threadgateAllowRules: List<PostInteractionSettingsPrefThreadgateAllowRuleUnion>? = null, val postgateEmbeddingRules: List<PostInteractionSettingsPrefPostgateEmbeddingRuleUnion>? = null)

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.

PostInteractionSettingsPrefPostgateEmbeddingRuleUnion

@Serializable

sealed interface PostInteractionSettingsPrefPostgateEmbeddingRuleUnion

PostInteractionSettingsPrefThreadgateAllowRuleUnion

@Serializable

sealed interface PostInteractionSettingsPrefThreadgateAllowRuleUnion

PreferencesUnion

@Serializable

sealed interface PreferencesUnion

Profile

@Serializable

data class Profile(val displayName: String? = null, val description: String? = null, val pronouns: String? = null, val website: Uri? = null, val avatar: Blob? = null, val banner: Blob? = null, val labels: ProfileLabelsUnion? = null, val joinedViaStarterPack: StrongRef? = null, val pinnedPost: StrongRef? = null, val createdAt: Timestamp? = null)

ProfileAssociated

@Serializable

data class ProfileAssociated(val lists: Long? = null, val feedgens: Long? = null, val starterPacks: Long? = null, val labeler: Boolean? = null, val chat: ProfileAssociatedChat? = null, val activitySubscription: ProfileAssociatedActivitySubscription? = null, val germ: ProfileAssociatedGerm? = null)

ProfileAssociatedActivitySubscription

@Serializable

data class ProfileAssociatedActivitySubscription(val allowSubscriptions: ProfileAssociatedActivitySubscriptionAllowSubscriptions)

ProfileAssociatedActivitySubscriptionAllowSubscriptions

@Serializable(with = ProfileAssociatedActivitySubscriptionAllowSubscriptionsSerializer::class)

sealed class ProfileAssociatedActivitySubscriptionAllowSubscriptions : AtpEnum

ProfileAssociatedActivitySubscriptionAllowSubscriptionsSerializer

class ProfileAssociatedActivitySubscriptionAllowSubscriptionsSerializer : KSerializer<ProfileAssociatedActivitySubscriptionAllowSubscriptions>

ProfileAssociatedChat

@Serializable

data class ProfileAssociatedChat(val allowIncoming: ProfileAssociatedChatAllowIncoming, val allowGroupInvites: ProfileAssociatedChatAllowGroupInvites? = null)

ProfileAssociatedChatAllowGroupInvites

@Serializable(with = ProfileAssociatedChatAllowGroupInvitesSerializer::class)

sealed class ProfileAssociatedChatAllowGroupInvites : AtpEnum

ProfileAssociatedChatAllowGroupInvitesSerializer

class ProfileAssociatedChatAllowGroupInvitesSerializer : KSerializer<ProfileAssociatedChatAllowGroupInvites>

ProfileAssociatedChatAllowIncoming

@Serializable(with = ProfileAssociatedChatAllowIncomingSerializer::class)

sealed class ProfileAssociatedChatAllowIncoming : AtpEnum

ProfileAssociatedChatAllowIncomingSerializer

class ProfileAssociatedChatAllowIncomingSerializer : KSerializer<ProfileAssociatedChatAllowIncoming>

ProfileAssociatedGerm

@Serializable

data class ProfileAssociatedGerm(val messageMeUrl: Uri, val showButtonTo: ProfileAssociatedGermShowButtonTo)

ProfileAssociatedGermShowButtonTo

@Serializable(with = ProfileAssociatedGermShowButtonToSerializer::class)

sealed class ProfileAssociatedGermShowButtonTo : AtpEnum

ProfileAssociatedGermShowButtonToSerializer

class ProfileAssociatedGermShowButtonToSerializer : KSerializer<ProfileAssociatedGermShowButtonTo>

ProfileLabelsUnion

@Serializable

sealed interface ProfileLabelsUnion

ProfileView

@Serializable

data class ProfileView(val did: Did, val handle: Handle, val displayName: String? = null, val pronouns: String? = null, val description: String? = null, val avatar: Uri? = null, val associated: ProfileAssociated? = null, val indexedAt: Timestamp? = null, val createdAt: Timestamp? = null, val viewer: ViewerState? = null, val labels: List<Label>? = null, val verification: VerificationState? = null, val status: StatusView? = null, val debug: JsonContent? = null)

ProfileViewBasic

@Serializable

data class ProfileViewBasic(val did: Did, val handle: Handle, val displayName: String? = null, val pronouns: String? = null, val avatar: Uri? = null, val associated: ProfileAssociated? = null, val viewer: ViewerState? = null, val labels: List<Label>? = null, val createdAt: Timestamp? = null, val verification: VerificationState? = null, val status: StatusView? = null, val debug: JsonContent? = null)

ProfileViewDetailed

@Serializable

data class ProfileViewDetailed(val did: Did, val handle: Handle, val displayName: String? = null, val description: String? = null, val pronouns: String? = null, val website: Uri? = null, val avatar: Uri? = null, val banner: Uri? = null, val followersCount: Long? = null, val followsCount: Long? = null, val postsCount: Long? = null, val associated: ProfileAssociated? = null, val joinedViaStarterPack: StarterPackViewBasic? = null, val indexedAt: Timestamp? = null, val createdAt: Timestamp? = null, val viewer: ViewerState? = null, val labels: List<Label>? = null, val pinnedPost: StrongRef? = null, val verification: VerificationState? = null, val status: StatusView? = null, val debug: JsonContent? = null)

PutPreferencesRequest

@Serializable

data class PutPreferencesRequest(val preferences: List<PreferencesUnion>)

SavedFeed

@Serializable

data class SavedFeed(val id: String, val type: SavedFeedType, val value: String, val pinned: Boolean)

SavedFeedsPref

@Serializable

data class SavedFeedsPref(val pinned: List<AtUri>, val saved: List<AtUri>, val timelineIndex: Long? = null)

SavedFeedsPrefV2

@Serializable

data class SavedFeedsPrefV2(val items: List<SavedFeed>)

SavedFeedType

@Serializable(with = SavedFeedTypeSerializer::class)

sealed class SavedFeedType : AtpEnum

SavedFeedTypeSerializer

class SavedFeedTypeSerializer : KSerializer<SavedFeedType>

SearchActorsQueryParams

@Serializable

data class SearchActorsQueryParams(val term: String? = null, val q: String? = null, val limit: Long? = 25, val cursor: String? = null)

SearchActorsResponse

@Serializable

data class SearchActorsResponse(val cursor: String? = null, val actors: List<ProfileView>)

SearchActorsTypeaheadQueryParams

@Serializable

data class SearchActorsTypeaheadQueryParams(val term: String? = null, val q: String? = null, val limit: Long? = 10)

SearchActorsTypeaheadResponse

@Serializable

data class SearchActorsTypeaheadResponse(val actors: List<ProfileViewBasic>)

Status

@Serializable

data class Status(val status: String, val embed: StatusEmbedUnion? = null, val durationMinutes: Long? = null, val createdAt: Timestamp)

StatusEmbedUnion

@Serializable

sealed interface StatusEmbedUnion

StatusToken

@Serializable(with = StatusTokenSerializer::class)

sealed class StatusToken : AtpEnum

StatusTokenSerializer

class StatusTokenSerializer : KSerializer<StatusToken>

StatusView

@Serializable

data class StatusView(val uri: AtUri? = null, val cid: Cid? = null, val status: String, val record: JsonContent, val embed: StatusViewEmbedUnion? = null, val labels: List<Label>? = null, val expiresAt: Timestamp? = null, val isActive: Boolean? = null, val isDisabled: Boolean? = null)

StatusViewEmbedUnion

@Serializable

sealed interface StatusViewEmbedUnion

ThreadViewPref

@Serializable

data class ThreadViewPref(val sort: ThreadViewPrefSort? = null)

ThreadViewPrefSort

@Serializable(with = ThreadViewPrefSortSerializer::class)

sealed class ThreadViewPrefSort : AtpEnum

Sorting mode for threads.

ThreadViewPrefSortSerializer

class ThreadViewPrefSortSerializer : KSerializer<ThreadViewPrefSort>

VerificationPrefs

@Serializable

data class VerificationPrefs(val hideBadges: Boolean? = false)

Preferences for how verified accounts appear in the app.

VerificationState

@Serializable

data class VerificationState(val verifications: List<VerificationView>, val verifiedStatus: VerificationStateVerifiedStatus, val trustedVerifierStatus: VerificationStateTrustedVerifierStatus)

Represents the verification information about the user this object is attached to.

VerificationStateTrustedVerifierStatus

@Serializable(with = VerificationStateTrustedVerifierStatusSerializer::class)

sealed class VerificationStateTrustedVerifierStatus : AtpEnum

The user's status as a trusted verifier.

VerificationStateTrustedVerifierStatusSerializer

class VerificationStateTrustedVerifierStatusSerializer : KSerializer<VerificationStateTrustedVerifierStatus>

VerificationStateVerifiedStatus

@Serializable(with = VerificationStateVerifiedStatusSerializer::class)

sealed class VerificationStateVerifiedStatus : AtpEnum

The user's status as a verified account.

VerificationStateVerifiedStatusSerializer

class VerificationStateVerifiedStatusSerializer : KSerializer<VerificationStateVerifiedStatus>

VerificationView

@Serializable

data class VerificationView(val issuer: Did, val issuerDisplayName: String? = null, val issuerHandle: Handle? = null, val uri: AtUri, val isValid: Boolean, val createdAt: Timestamp)

An individual verification for an associated subject.

ViewerState

@Serializable

data class ViewerState(val muted: Boolean? = null, val mutedByList: ListViewBasic? = null, val blockedBy: Boolean? = null, val blocking: AtUri? = null, val blockingByList: ListViewBasic? = null, val following: AtUri? = null, val followedBy: AtUri? = null, val knownFollowers: KnownFollowers? = null, val activitySubscription: ActivitySubscription? = null)

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.