models/io.github.kikin81.atproto.app.bsky.actor

Package-level declarations

Types

class ActorService(client: <Error class: unknown class>)

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

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

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

ContentLabelPref

data class ContentLabelPref(val label: String, val labelerDid: <Error class: unknown class>? = null, val visibility: String)

DeclaredAgePref

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

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

GetPreferencesRequest

class GetPreferencesRequest

Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.

GetPreferencesResponse

data class GetPreferencesResponse(val preferences: <Error class: unknown class>)

GetProfileRequest

data class GetProfileRequest(val actor: <Error class: unknown class>)

Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.

GetProfileResponse

typealias GetProfileResponse = ProfileViewDetailed

GetProfilesRequest

data class GetProfilesRequest(val actors: List<<Error class: unknown class>>)

Get detailed profile views of multiple actors.

GetProfilesResponse

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

GetSuggestionsRequest

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

Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.

GetSuggestionsResponse

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

HiddenPostsPref

data class HiddenPostsPref(val items: List<<Error class: unknown class>>)

InterestsPref

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

KnownFollowers

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

The subject's followers whom you also follow

LabelerPrefItem

data class LabelerPrefItem(val did: <Error class: unknown class>)

LabelersPref

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

LiveEventPreferences

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

Preferences for live events.

MutedWord

data class MutedWord(val actorTarget: String? = null, val expiresAt: <Error class: unknown class>? = null, val id: String? = null, val targets: List<MutedWordTarget>, val value: String)

A word that the account owner has muted.

MutedWordsPref

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

MutedWordTarget

typealias MutedWordTarget = String

Nux

data class Nux(val completed: Boolean, val data: String? = null, val expiresAt: <Error class: unknown class>? = null, val id: String)

A new user experiences (NUX) storage object

PersonalDetailsPref

data class PersonalDetailsPref(val birthDate: <Error class: unknown class>? = null)

PostInteractionSettingsPref

data class PostInteractionSettingsPref(val postgateEmbeddingRules: List<PostInteractionSettingsPrefPostgateEmbeddingRulesUnion>? = null, val threadgateAllowRules: List<PostInteractionSettingsPrefThreadgateAllowRulesUnion>? = 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.

PostInteractionSettingsPrefPostgateEmbeddingRulesUnion

interface PostInteractionSettingsPrefPostgateEmbeddingRulesUnion

PostInteractionSettingsPrefPostgateEmbeddingRulesUnionSerializer

object PostInteractionSettingsPrefPostgateEmbeddingRulesUnionSerializer

PostInteractionSettingsPrefPostgateEmbeddingRulesUnionUnknownSerializer

object PostInteractionSettingsPrefPostgateEmbeddingRulesUnionUnknownSerializer

PostInteractionSettingsPrefThreadgateAllowRulesUnion

interface PostInteractionSettingsPrefThreadgateAllowRulesUnion

PostInteractionSettingsPrefThreadgateAllowRulesUnionSerializer

object PostInteractionSettingsPrefThreadgateAllowRulesUnionSerializer

PostInteractionSettingsPrefThreadgateAllowRulesUnionUnknownSerializer

object PostInteractionSettingsPrefThreadgateAllowRulesUnionUnknownSerializer

Profile

data class Profile(val avatar: <Error class: unknown class><<Error class: unknown class>> = AtField.Missing, val banner: <Error class: unknown class><<Error class: unknown class>> = AtField.Missing, val createdAt: <Error class: unknown class><<Error class: unknown class>> = AtField.Missing, val description: <Error class: unknown class><String> = AtField.Missing, val displayName: <Error class: unknown class><String> = AtField.Missing, val joinedViaStarterPack: <Error class: unknown class><StrongRef> = AtField.Missing, val labels: <Error class: unknown class><ProfileLabelsUnion> = AtField.Missing, val pinnedPost: <Error class: unknown class><StrongRef> = AtField.Missing, val pronouns: <Error class: unknown class><String> = AtField.Missing, val website: <Error class: unknown class><<Error class: unknown class>> = AtField.Missing)

A declaration of a Bluesky account profile.

ProfileAssociated

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

ProfileAssociatedActivitySubscription

data class ProfileAssociatedActivitySubscription(val allowSubscriptions: String)

ProfileAssociatedChat

data class ProfileAssociatedChat(val allowIncoming: String)

ProfileAssociatedGerm

data class ProfileAssociatedGerm(val messageMeUrl: <Error class: unknown class>, val showButtonTo: String)

ProfileLabelsUnion

interface ProfileLabelsUnion

Self-label values, specific to the Bluesky application, on the overall account.

ProfileLabelsUnionSerializer

object ProfileLabelsUnionSerializer

ProfileLabelsUnionUnknownSerializer

object ProfileLabelsUnionUnknownSerializer

ProfileView

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

ProfileViewBasic

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

ProfileViewDetailed

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

PutPreferencesRequest

data class PutPreferencesRequest(val preferences: <Error class: unknown class>)

Set the private preferences attached to the account.

SavedFeed

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

SavedFeedsPref

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

SavedFeedsPrefV2

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

SearchActorsRequest

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

Find actors (profiles) matching search criteria. Does not require auth.

SearchActorsResponse

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

SearchActorsTypeaheadRequest

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

Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.

SearchActorsTypeaheadResponse

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

Status

data class Status(val createdAt: <Error class: unknown class>, val durationMinutes: <Error class: unknown class><Long> = AtField.Missing, val embed: <Error class: unknown class><StatusEmbedUnion> = AtField.Missing, val status: String)

A declaration of a Bluesky account status.

StatusEmbedUnion

interface StatusEmbedUnion

An optional embed associated with the status.

StatusEmbedUnionSerializer

object StatusEmbedUnionSerializer

StatusEmbedUnionUnknownSerializer

object StatusEmbedUnionUnknownSerializer

StatusView

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

StatusViewEmbedUnion

interface StatusViewEmbedUnion

An optional embed associated with the status.

StatusViewEmbedUnionSerializer

object StatusViewEmbedUnionSerializer

StatusViewEmbedUnionUnknownSerializer

object StatusViewEmbedUnionUnknownSerializer

ThreadViewPref

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

VerificationPrefs

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

Preferences for how verified accounts appear in the app.

VerificationState

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

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

VerificationView

data class VerificationView(val createdAt: <Error class: unknown class>, val isValid: Boolean, val issuer: <Error class: unknown class>, val uri: <Error class: unknown class>)

An individual verification for an associated subject.

ViewerState

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

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

Functions

searchActorsFlow

fun ActorService.searchActorsFlow(request: SearchActorsRequest = SearchActorsRequest()): <Error class: unknown class><ProfileView>

Find actors (profiles) matching search criteria. Does not require auth.

searchActorsPageFlow

fun ActorService.searchActorsPageFlow(request: SearchActorsRequest = SearchActorsRequest()): <Error class: unknown class><List<ProfileView>>

Find actors (profiles) matching search criteria. Does not require auth.

suggestionsFlow

fun ActorService.suggestionsFlow(request: GetSuggestionsRequest = GetSuggestionsRequest()): <Error class: unknown class><ProfileView>

Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.

suggestionsPageFlow

fun ActorService.suggestionsPageFlow(request: GetSuggestionsRequest = GetSuggestionsRequest()): <Error class: unknown class><List<ProfileView>>

Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.