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

Package-level declarations

Types

data class BlockedAuthor(val did: <Error class: unknown class>, val viewer: ViewerState? = null)

data class BlockedPost(val author: BlockedAuthor, val blocked: Boolean, val uri: <Error class: unknown class>) : GetPostThreadResponseThreadUnion, ReplyRefParentUnion, ReplyRefRootUnion, ThreadViewPostParentUnion, ThreadViewPostRepliesUnion

FeedService

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

FeedViewPost

data class FeedViewPost(val feedContext: String? = null, val post: PostView, val reason: FeedViewPostReasonUnion? = null, val reply: ReplyRef? = null, val reqId: String? = null)

FeedViewPostReasonUnion

interface FeedViewPostReasonUnion

FeedViewPostReasonUnionSerializer

object FeedViewPostReasonUnionSerializer

FeedViewPostReasonUnionUnknownSerializer

object FeedViewPostReasonUnionUnknownSerializer

Generator

data class Generator(val acceptsInteractions: <Error class: unknown class><Boolean> = AtField.Missing, val avatar: <Error class: unknown class><<Error class: unknown class>> = AtField.Missing, val contentMode: <Error class: unknown class><String> = AtField.Missing, val createdAt: <Error class: unknown class>, val description: <Error class: unknown class><String> = AtField.Missing, val descriptionFacets: <Error class: unknown class><List<Facet>> = AtField.Missing, val did: <Error class: unknown class>, val displayName: String, val labels: <Error class: unknown class><GeneratorLabelsUnion> = AtField.Missing)

Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.

GeneratorLabelsUnion

interface GeneratorLabelsUnion

Self-label values

GeneratorLabelsUnionSerializer

object GeneratorLabelsUnionSerializer

GeneratorLabelsUnionUnknownSerializer

object GeneratorLabelsUnionUnknownSerializer

GeneratorView

data class GeneratorView(val acceptsInteractions: Boolean? = null, val avatar: <Error class: unknown class>? = null, val cid: <Error class: unknown class>, val contentMode: String? = null, val creator: ProfileView, val description: String? = null, val descriptionFacets: List<Facet>? = null, val did: <Error class: unknown class>, val displayName: String, val indexedAt: <Error class: unknown class>, val labels: List<Label>? = null, val likeCount: Long? = null, val uri: <Error class: unknown class>, val viewer: GeneratorViewerState? = null) : RecordViewRecordUnion

GeneratorViewerState

data class GeneratorViewerState(val like: <Error class: unknown class>? = null)

GetAuthorFeedRequest

data class GetAuthorFeedRequest(val actor: <Error class: unknown class>, val cursor: String? = null, val filter: String? = null, val includePins: Boolean? = null, val limit: Long? = null)

Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.

GetAuthorFeedResponse

data class GetAuthorFeedResponse(val cursor: String? = null, val feed: List<FeedViewPost>)

GetFeedGeneratorRequest

data class GetFeedGeneratorRequest(val feed: <Error class: unknown class>)

Get information about a feed generator. Implemented by AppView.

GetFeedGeneratorResponse

data class GetFeedGeneratorResponse(val isOnline: Boolean, val isValid: Boolean, val view: GeneratorView)

GetFeedRequest

data class GetFeedRequest(val cursor: String? = null, val feed: <Error class: unknown class>, val limit: Long? = null)

Get a hydrated feed from an actor's selected feed generator. Implemented by App View.

GetFeedResponse

data class GetFeedResponse(val cursor: String? = null, val feed: List<FeedViewPost>)

GetLikesLike

data class GetLikesLike(val actor: ProfileView, val createdAt: <Error class: unknown class>, val indexedAt: <Error class: unknown class>)

GetLikesRequest

data class GetLikesRequest(val cid: <Error class: unknown class>? = null, val cursor: String? = null, val limit: Long? = null, val uri: <Error class: unknown class>)

Get like records which reference a subject (by AT-URI and CID).

GetLikesResponse

data class GetLikesResponse(val cid: <Error class: unknown class>? = null, val cursor: String? = null, val likes: List<GetLikesLike>, val uri: <Error class: unknown class>)

GetPostsRequest

data class GetPostsRequest(val uris: List<<Error class: unknown class>>)

Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.

GetPostsResponse

data class GetPostsResponse(val posts: List<PostView>)

GetPostThreadRequest

data class GetPostThreadRequest(val depth: Long? = null, val parentHeight: Long? = null, val uri: <Error class: unknown class>)

Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.

GetPostThreadResponse

data class GetPostThreadResponse(val thread: GetPostThreadResponseThreadUnion, val threadgate: ThreadgateView? = null)

GetPostThreadResponseThreadUnion

interface GetPostThreadResponseThreadUnion

GetPostThreadResponseThreadUnionSerializer

object GetPostThreadResponseThreadUnionSerializer

GetPostThreadResponseThreadUnionUnknownSerializer

object GetPostThreadResponseThreadUnionUnknownSerializer

GetRepostedByRequest

data class GetRepostedByRequest(val cid: <Error class: unknown class>? = null, val cursor: String? = null, val limit: Long? = null, val uri: <Error class: unknown class>)

Get a list of reposts for a given post.

GetRepostedByResponse

data class GetRepostedByResponse(val cid: <Error class: unknown class>? = null, val cursor: String? = null, val repostedBy: List<ProfileView>, val uri: <Error class: unknown class>)

GetTimelineRequest

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

Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.

GetTimelineResponse

data class GetTimelineResponse(val cursor: String? = null, val feed: List<FeedViewPost>)

Interaction

data class Interaction(val event: String? = null, val feedContext: String? = null, val item: <Error class: unknown class>? = null, val reqId: String? = null)

data class Like(val createdAt: <Error class: unknown class>, val subject: StrongRef, val via: <Error class: unknown class><StrongRef> = AtField.Missing)

Record declaring a 'like' of a piece of subject content.

NotFoundPost

data class NotFoundPost(val notFound: Boolean, val uri: <Error class: unknown class>) : GetPostThreadResponseThreadUnion, ReplyRefParentUnion, ReplyRefRootUnion, ThreadViewPostParentUnion, ThreadViewPostRepliesUnion

Post

data class Post(val createdAt: <Error class: unknown class>, val embed: <Error class: unknown class><PostEmbedUnion> = AtField.Missing, val entities: <Error class: unknown class><List<PostEntity>> = AtField.Missing, val facets: <Error class: unknown class><List<Facet>> = AtField.Missing, val labels: <Error class: unknown class><PostLabelsUnion> = AtField.Missing, val langs: <Error class: unknown class><List<<Error class: unknown class>>> = AtField.Missing, val reply: <Error class: unknown class><PostReplyRef> = AtField.Missing, val tags: <Error class: unknown class><List<String>> = AtField.Missing, val text: String)

Record containing a Bluesky post.

PostEmbedUnion

interface PostEmbedUnion

PostEmbedUnionSerializer

object PostEmbedUnionSerializer

PostEmbedUnionUnknownSerializer

object PostEmbedUnionUnknownSerializer

PostEntity

data class PostEntity(val index: PostTextSlice, val type: String, val value: String)

Deprecated: use facets instead.

Postgate

data class Postgate(val createdAt: <Error class: unknown class>, val detachedEmbeddingUris: <Error class: unknown class><List<<Error class: unknown class>>> = AtField.Missing, val embeddingRules: <Error class: unknown class><List<PostgateEmbeddingRulesUnion>> = AtField.Missing, val post: <Error class: unknown class>)

Record defining interaction rules for a post. The record key (rkey) of the postgate record must match the record key of the post, and that record must be in the same repository.

PostgateDisableRule

class PostgateDisableRule : PostInteractionSettingsPrefPostgateEmbeddingRulesUnion, PostgateEmbeddingRulesUnion

Disables embedding of this post.

PostgateEmbeddingRulesUnion

interface PostgateEmbeddingRulesUnion

PostgateEmbeddingRulesUnionSerializer

object PostgateEmbeddingRulesUnionSerializer

PostgateEmbeddingRulesUnionUnknownSerializer

object PostgateEmbeddingRulesUnionUnknownSerializer

PostLabelsUnion

interface PostLabelsUnion

Self-label values for this post. Effectively content warnings.

PostLabelsUnionSerializer

object PostLabelsUnionSerializer

PostLabelsUnionUnknownSerializer

object PostLabelsUnionUnknownSerializer

PostReplyRef

data class PostReplyRef(val parent: StrongRef, val root: StrongRef)

PostTextSlice

data class PostTextSlice(val end: Long, val start: Long)

Deprecated. Use app.bsky.richtext instead -- A text segment. Start is inclusive, end is exclusive. Indices are for utf16-encoded strings.

PostView

data class PostView(val author: ProfileViewBasic, val bookmarkCount: Long? = null, val cid: <Error class: unknown class>, val debug: <Error class: unknown class>? = null, val embed: PostViewEmbedUnion? = null, val indexedAt: <Error class: unknown class>, val labels: List<Label>? = null, val likeCount: Long? = null, val quoteCount: Long? = null, val record: <Error class: unknown class>, val replyCount: Long? = null, val repostCount: Long? = null, val threadgate: ThreadgateView? = null, val uri: <Error class: unknown class>, val viewer: ViewerState? = null) : ReplyRefParentUnion, ReplyRefRootUnion

PostViewEmbedUnion

interface PostViewEmbedUnion

PostViewEmbedUnionSerializer

object PostViewEmbedUnionSerializer

PostViewEmbedUnionUnknownSerializer

object PostViewEmbedUnionUnknownSerializer

ReasonPin

class ReasonPin : FeedViewPostReasonUnion

ReasonRepost

data class ReasonRepost(val by: ProfileViewBasic, val cid: <Error class: unknown class>? = null, val indexedAt: <Error class: unknown class>, val uri: <Error class: unknown class>? = null) : FeedViewPostReasonUnion

ReplyRef

data class ReplyRef(val grandparentAuthor: ProfileViewBasic? = null, val parent: ReplyRefParentUnion, val root: ReplyRefRootUnion)

ReplyRefParentUnion

interface ReplyRefParentUnion

ReplyRefParentUnionSerializer

object ReplyRefParentUnionSerializer

ReplyRefParentUnionUnknownSerializer

object ReplyRefParentUnionUnknownSerializer

ReplyRefRootUnion

interface ReplyRefRootUnion

ReplyRefRootUnionSerializer

object ReplyRefRootUnionSerializer

ReplyRefRootUnionUnknownSerializer

object ReplyRefRootUnionUnknownSerializer

Repost

data class Repost(val createdAt: <Error class: unknown class>, val subject: StrongRef, val via: <Error class: unknown class><StrongRef> = AtField.Missing)

Record representing a 'repost' of an existing Bluesky post.

SearchPostsRequest

data class SearchPostsRequest(val author: <Error class: unknown class>? = null, val cursor: String? = null, val domain: String? = null, val lang: <Error class: unknown class>? = null, val limit: Long? = null, val mentions: <Error class: unknown class>? = null, val q: String, val since: String? = null, val sort: String? = null, val tag: List<String>? = null, val until: String? = null, val url: <Error class: unknown class>? = null)

Find posts matching search criteria, returning views of those posts. Note that this API endpoint may require authentication (eg, not public) for some service providers and implementations.

SearchPostsResponse

data class SearchPostsResponse(val cursor: String? = null, val hitsTotal: Long? = null, val posts: List<PostView>)

SkeletonFeedPost

data class SkeletonFeedPost(val feedContext: String? = null, val post: <Error class: unknown class>, val reason: SkeletonFeedPostReasonUnion? = null)

SkeletonFeedPostReasonUnion

interface SkeletonFeedPostReasonUnion

SkeletonFeedPostReasonUnionSerializer

object SkeletonFeedPostReasonUnionSerializer

SkeletonFeedPostReasonUnionUnknownSerializer

object SkeletonFeedPostReasonUnionUnknownSerializer

SkeletonReasonPin

class SkeletonReasonPin : SkeletonFeedPostReasonUnion

SkeletonReasonRepost

data class SkeletonReasonRepost(val repost: <Error class: unknown class>) : SkeletonFeedPostReasonUnion

ThreadContext

data class ThreadContext(val rootAuthorLike: <Error class: unknown class>? = null)

Metadata about this post within the context of the thread it is in.

Threadgate

data class Threadgate(val allow: <Error class: unknown class><List<ThreadgateAllowUnion>> = AtField.Missing, val createdAt: <Error class: unknown class>, val hiddenReplies: <Error class: unknown class><List<<Error class: unknown class>>> = AtField.Missing, val post: <Error class: unknown class>)

Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository.

ThreadgateAllowUnion

interface ThreadgateAllowUnion

ThreadgateAllowUnionSerializer

object ThreadgateAllowUnionSerializer

ThreadgateAllowUnionUnknownSerializer

object ThreadgateAllowUnionUnknownSerializer

ThreadgateFollowerRule

class ThreadgateFollowerRule : PostInteractionSettingsPrefThreadgateAllowRulesUnion, ThreadgateAllowUnion

Allow replies from actors who follow you.

ThreadgateFollowingRule

class ThreadgateFollowingRule : PostInteractionSettingsPrefThreadgateAllowRulesUnion, ThreadgateAllowUnion

Allow replies from actors you follow.

ThreadgateListRule

data class ThreadgateListRule(val list: <Error class: unknown class>) : PostInteractionSettingsPrefThreadgateAllowRulesUnion, ThreadgateAllowUnion

Allow replies from actors on a list.

ThreadgateMentionRule

class ThreadgateMentionRule : PostInteractionSettingsPrefThreadgateAllowRulesUnion, ThreadgateAllowUnion

Allow replies from actors mentioned in your post.

ThreadgateView

data class ThreadgateView(val cid: <Error class: unknown class>? = null, val lists: List<ListViewBasic>? = null, val record: <Error class: unknown class>? = null, val uri: <Error class: unknown class>? = null)

ThreadViewPost

data class ThreadViewPost(val parent: ThreadViewPostParentUnion? = null, val post: PostView, val replies: List<ThreadViewPostRepliesUnion>? = null, val threadContext: ThreadContext? = null) : GetPostThreadResponseThreadUnion, ThreadViewPostParentUnion, ThreadViewPostRepliesUnion

ThreadViewPostParentUnion

interface ThreadViewPostParentUnion

ThreadViewPostParentUnionSerializer

object ThreadViewPostParentUnionSerializer

ThreadViewPostParentUnionUnknownSerializer

object ThreadViewPostParentUnionUnknownSerializer

ThreadViewPostRepliesUnion

interface ThreadViewPostRepliesUnion

ThreadViewPostRepliesUnionSerializer

object ThreadViewPostRepliesUnionSerializer

ThreadViewPostRepliesUnionUnknownSerializer

object ThreadViewPostRepliesUnionUnknownSerializer

ViewerState

data class ViewerState(val bookmarked: Boolean? = null, val embeddingDisabled: Boolean? = null, val like: <Error class: unknown class>? = null, val pinned: Boolean? = null, val replyDisabled: Boolean? = null, val repost: <Error class: unknown class>? = null, val threadMuted: Boolean? = null)

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

Functions

authorFeedFlow

fun FeedService.authorFeedFlow(request: GetAuthorFeedRequest): <Error class: unknown class><FeedViewPost>

Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.

authorFeedPageFlow

fun FeedService.authorFeedPageFlow(request: GetAuthorFeedRequest): <Error class: unknown class><List<FeedViewPost>>

Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.

feedFlow

fun FeedService.feedFlow(request: GetFeedRequest): <Error class: unknown class><FeedViewPost>

Get a hydrated feed from an actor's selected feed generator. Implemented by App View.

feedPageFlow

fun FeedService.feedPageFlow(request: GetFeedRequest): <Error class: unknown class><List<FeedViewPost>>

Get a hydrated feed from an actor's selected feed generator. Implemented by App View.

likesFlow

fun FeedService.likesFlow(request: GetLikesRequest): <Error class: unknown class><GetLikesLike>

Get like records which reference a subject (by AT-URI and CID).

likesPageFlow

fun FeedService.likesPageFlow(request: GetLikesRequest): <Error class: unknown class><List<GetLikesLike>>

Get like records which reference a subject (by AT-URI and CID).

repostedByFlow

fun FeedService.repostedByFlow(request: GetRepostedByRequest): <Error class: unknown class><ProfileView>

Get a list of reposts for a given post.

repostedByPageFlow

fun FeedService.repostedByPageFlow(request: GetRepostedByRequest): <Error class: unknown class><List<ProfileView>>

Get a list of reposts for a given post.

searchPostsFlow

fun FeedService.searchPostsFlow(request: SearchPostsRequest): <Error class: unknown class><PostView>

Find posts matching search criteria, returning views of those posts. Note that this API endpoint may require authentication (eg, not public) for some service providers and implementations.

searchPostsPageFlow

fun FeedService.searchPostsPageFlow(request: SearchPostsRequest): <Error class: unknown class><List<PostView>>

Find posts matching search criteria, returning views of those posts. Note that this API endpoint may require authentication (eg, not public) for some service providers and implementations.

timelineFlow

fun FeedService.timelineFlow(request: GetTimelineRequest = GetTimelineRequest()): <Error class: unknown class><FeedViewPost>

Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.

timelinePageFlow

fun FeedService.timelinePageFlow(request: GetTimelineRequest = GetTimelineRequest()): <Error class: unknown class><List<FeedViewPost>>

Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.