Header menu logo FSharp.ATProto

FSharp.ATProto.Bluesky Namespace

Type/Module Description

ActorDidWitness

Witness type enabling SRTP-based overloading for actor DID parameters. Allows functions like follow, block, muteUser, and unmuteUser to accept a Did, ProfileSummary, or Profile directly. This type is an implementation detail and should not be used directly.

ActorWitness

Witness type enabling SRTP-based overloading for actor parameters. Allows functions like getProfile to accept Handle, Did, ProfileSummary, or Profile directly. This type is an implementation detail and should not be used directly.

AppBsky

AppBskyActor

AppBskyAgeassurance

AppBskyBookmark

AppBskyContact

AppBskyDraft

AppBskyEmbed

AppBskyFeed

AppBskyGraph

AppBskyLabeler

AppBskyNotification

AppBskyRichtext

AppBskyUnspecced

AppBskyVideo

BlobRef

A reference to an uploaded blob, as returned by com.atproto.repo.uploadBlob. Contains both the raw JSON (for passing back to the API in embeds) and typed convenience fields.

BlockRef

A reference to a block record, returned by Bluesky.block. Pass to Bluesky.unblock to undo.

Bluesky

High-level convenience methods for common Bluesky operations: posting, replying, liking, reposting, following, blocking, uploading blobs, and deleting records. All methods require an authenticated AtpAgent.

Chat

Convenience methods for Bluesky direct message (DM) and chat operations. Wraps the chat.bsky.convo.* XRPC endpoints with a simplified API. All methods require an authenticated AtpAgent. The chat proxy header (atproto-proxy: did:web:api.bsky.chat#bsky_chat) is applied automatically -- callers do not need to use withChatProxy manually.

ChatBsky

ChatBskyActor

ChatBskyConvo

ChatBskyModeration

ChatMessage (Module)

ChatMessage (Type)

A message in a chat conversation.

ComAtprotoAdmin

ComAtprotoIdentity

ComAtprotoLabel

ComAtprotoLexicon

ComAtprotoModeration

ComAtprotoRepo

ComAtprotoServer

ComAtprotoSync

ComAtprotoTemp

ComGermnetwork

CommunicationTemplate (Module)

CommunicationTemplate (Type)

A communication template used by the Ozone moderation service.

ConvoSummary (Module)

ConvoSummary (Type)

A summary of a chat conversation.

ConvoWitness

Witness type enabling SRTP-based overloading for conversation parameters. Allows Chat functions to accept either a ConvoSummary or a string convo ID directly. This type is an implementation detail and should not be used directly.

FeedGenerator (Module)

FeedGenerator (Type)

A custom feed generator.

FeedItem (Module)

FeedItem (Type)

A single item in a feed or timeline.

FeedReason

Reason a post appeared in a feed.

FollowRef

A reference to a follow record, returned by Bluesky.follow. Pass to Bluesky.unfollow to undo.

Identity

AT Protocol identity resolution: DID documents, handle resolution, and bidirectional verification. Supports both did:plc (via PLC directory) and did:web (via .well-known) methods.

IdentityError

Errors that can occur during identity resolution.

ImageMime (Module)

Functions for working with ImageMime values.

ImageMime (Type)

Supported image MIME types for blob upload. Use the named cases for common image types, or Custom for other MIME types.

ImageUpload

Image data for upload with a post.

LastMessage

Summary of the last message in a conversation.

LikeRef

A reference to a like record, returned by Bluesky.like. Pass to Bluesky.unlike to undo.

ListBlockRef

A reference to a list block record, returned by Bluesky.blockModList. Pass to Bluesky.unblockModList to undo.

ListDetail

A list with its member profiles, returned by getList.

ListItemRef

A reference to a list item record, returned by Bluesky.addListItem.

ListRef

A reference to a list record, returned by Bluesky.createList.

ListView (Module)

ListView (Type)

A user-created list (curate list, mod list, or reference list).

ModerationAction

A type-safe union of moderation events that can be emitted via Ozone.emitEvent. Each case maps to the corresponding tools.ozone.moderation.defs#modEvent* type.

Notification (Module)

Notification (Type)

A notification from the user's notification feed.

NotificationContent

The content of a notification, varying by kind.

Ozone

Convenience methods for Ozone moderation tooling (tools.ozone.* endpoints). Wraps the generated XRPC types with a simplified, type-safe API.

Ozone endpoints require the agent to be proxied to the moderation service. Pass the labeler/moderation service DID via the serviceDid parameter. The proxy header (atproto-proxy: {did}#atproto_labeler) is applied automatically -- callers do not need to configure proxy headers manually.

OzoneSubject

The subject of an Ozone moderation action: either an account (by DID) or a record (by AT-URI + CID).

Page<'T>

A paginated result containing a list of items and an optional cursor for the next page.

PostEmbed (Module)

PostEmbed (Type)

Embedded content in a post (images, video, link card, quoted post, or combination).

PostExtensions

Extension properties on PostView for convenient access to post content.

PostExternalLink

An external link card attached to a post.

PostImage

An image attached to a post.

PostMediaEmbed

Media within a record-with-media embed.

PostRef

A reference to a specific version of a post record. Contains both the AT-URI (identifying the record) and the CID (identifying the exact version). Accepted by like, repost, and replyTo.

PostRefWitness

Witness type enabling SRTP-based overloading for post reference parameters. Allows functions like like, repost, and replyTo to accept either a PostRef or a TimelinePost directly. This type is an implementation detail and should not be used directly.

PostUriWitness

Witness type enabling SRTP-based overloading for post AT-URI parameters. Allows functions like deleteRecord, muteThread, getLikes, and getPostThread to accept an AtUri, PostRef, or TimelinePost directly. This type is an implementation detail and should not be used directly.

PostVideo

A video attached to a post.

Profile (Module)

Profile (Type)

A full user profile with engagement counts and relationship state. Maps from ProfileViewDetailed.

ProfileSummary (Module)

ProfileSummary (Type)

A lightweight profile summary used in feeds, notifications, and conversations. Maps from ProfileViewBasic / ProfileView.

Relationship (Module)

Relationship (Type)

A bi-directional relationship between the authenticated user and another actor.

ReportSubject

The subject of a content report.

RepostRef

A reference to a repost record, returned by Bluesky.repost. Pass to Bluesky.unrepost to undo.

RichText

Rich text processing for Bluesky posts. Detects mentions, links, and hashtags in text and resolves them to facets with correct UTF-8 byte offsets as required by the AT Protocol.

StarterPackRef

A reference to a starter pack record, returned by Bluesky.createStarterPack.

TeamMember (Module)

TeamMember (Type)

A member of an Ozone moderation team.

TeamRole

The role of a team member in an Ozone moderation service.

TestFactory

Factory methods for creating domain objects with sensible defaults. Useful for testing consumers of the library without needing a live API. All parameters are optional; unspecified fields use deterministic default values.

ThreadNode (Module)

ThreadNode (Type)

A node in a post thread tree.

ThreadPost

A post within a thread, with parent and reply context.

ThreadResult

Type alias for the thread union returned by getPostThread. Simplifies pattern matching when working with thread responses.

TimelinePost (Module)

TimelinePost (Type)

A post with engagement counts and viewer state, used in feeds and timelines. Maps from PostView.

ToolsOzoneCommunication

ToolsOzoneHosting

ToolsOzoneModeration

ToolsOzoneReport

ToolsOzoneSafelink

ToolsOzoneServer

ToolsOzoneSet

ToolsOzoneSetting

ToolsOzoneSignature

ToolsOzoneTeam

ToolsOzoneVerification

UndoResult

Result of an undo operation. Undone means the record was deleted; WasNotPresent means there was nothing to undo (e.g., the post was not liked).

UndoWitness

Witness type enabling SRTP-based overloading for undo operations. Allows the generic Bluesky.undo function to accept any ref type (LikeRef, RepostRef, FollowRef, BlockRef). This type is an implementation detail and should not be used directly.

VideoMime (Module)

VideoMime (Type)

Supported video MIME types for video upload.

Type something to start searching.