bluesky/app.bsky.embed

Package-level declarations

Types

data class AspectRatio(val width: Long, val height: Long)

width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit.

External

@Serializable

data class External(val external: ExternalExternal)

A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).

ExternalColorRGB

@Serializable

data class ExternalColorRGB(val r: Long, val g: Long, val b: Long)

RGB color definition, inspired by site.standard.theme.color#rgb

ExternalExternal

@Serializable

data class ExternalExternal(val uri: Uri, val title: String, val description: String, val thumb: Blob? = null, val associatedRefs: List<StrongRef>? = null)

ExternalView

@Serializable

data class ExternalView(val external: ExternalViewExternal)

ExternalViewExternal

@Serializable

data class ExternalViewExternal(val uri: Uri, val title: String, val description: String, val thumb: Uri? = null, val createdAt: Timestamp? = null, val updatedAt: Timestamp? = null, val readingTime: Long? = null, val labels: List<Label>? = null, val source: ExternalViewExternalSource? = null, val associatedRefs: List<StrongRef>? = null, val associatedProfiles: List<ProfileViewBasic>? = null)

ExternalViewExternalSource

@Serializable

data class ExternalViewExternalSource(val uri: Uri, val icon: Uri? = null, val title: String, val description: String? = null, val theme: ExternalViewExternalSourceTheme? = null)

The source of an external embed, such as a standard.site publication.

ExternalViewExternalSourceTheme

@Serializable

data class ExternalViewExternalSourceTheme(val backgroundRGB: ExternalColorRGB? = null, val foregroundRGB: ExternalColorRGB? = null, val accentRGB: ExternalColorRGB? = null, val accentForegroundRGB: ExternalColorRGB? = null)

The theme colors of an external source, such as a site.standard.publication. These colors may be used when rendering an embed from that source.

Gallery

@Serializable

data class Gallery(val items: List<GalleryItemUnion>)

GalleryImage

@Serializable

data class GalleryImage(val image: Blob, val alt: String, val aspectRatio: AspectRatio)

GalleryItemUnion

@Serializable

sealed interface GalleryItemUnion

GalleryView

@Serializable

data class GalleryView(val items: List<GalleryViewItemUnion>)

GalleryViewImage

@Serializable

data class GalleryViewImage(val thumbnail: Uri, val fullsize: Uri, val alt: String, val aspectRatio: AspectRatio)

GalleryViewItemUnion

@Serializable

sealed interface GalleryViewItemUnion

GetEmbedExternalViewQueryParams

@Serializable

data class GetEmbedExternalViewQueryParams(val url: Uri, val uris: List<AtUri>)

GetEmbedExternalViewResponse

@Serializable

data class GetEmbedExternalViewResponse(val view: ExternalView? = null, val associatedRefs: List<StrongRef>? = null, val associatedRecords: List<JsonContent>? = null)

Images

@Serializable

data class Images(val images: List<ImagesImage>)

ImagesImage

@Serializable

data class ImagesImage(val image: Blob, val alt: String, val aspectRatio: AspectRatio? = null)

ImagesView

@Serializable

data class ImagesView(val images: List<ImagesViewImage>)

ImagesViewImage

@Serializable

data class ImagesViewImage(val thumb: Uri, val fullsize: Uri, val alt: String, val aspectRatio: AspectRatio? = null)

Record

@Serializable

data class Record(val record: StrongRef)

RecordView

@Serializable

data class RecordView(val record: RecordViewRecordUnion)

RecordViewBlocked

@Serializable

data class RecordViewBlocked(val uri: AtUri, val blocked: Boolean, val author: BlockedAuthor)

RecordViewDetached

@Serializable

data class RecordViewDetached(val uri: AtUri, val detached: Boolean)

RecordViewNotFound

@Serializable

data class RecordViewNotFound(val uri: AtUri, val notFound: Boolean)

RecordViewRecord

@Serializable

data class RecordViewRecord(val uri: AtUri, val cid: Cid, val author: ProfileViewBasic, val value: JsonContent, val labels: List<Label>? = null, val replyCount: Long? = null, val repostCount: Long? = null, val likeCount: Long? = null, val quoteCount: Long? = null, val embeds: List<RecordViewRecordEmbedUnion>? = null, val indexedAt: Timestamp)

RecordViewRecordEmbedUnion

@Serializable

sealed interface RecordViewRecordEmbedUnion

RecordViewRecordUnion

@Serializable

sealed interface RecordViewRecordUnion

RecordWithMedia

@Serializable

data class RecordWithMedia(val record: Record, val media: RecordWithMediaMediaUnion)

RecordWithMediaMediaUnion

@Serializable

sealed interface RecordWithMediaMediaUnion

RecordWithMediaView

@Serializable

data class RecordWithMediaView(val record: RecordView, val media: RecordWithMediaViewMediaUnion)

RecordWithMediaViewMediaUnion

@Serializable

sealed interface RecordWithMediaViewMediaUnion

Video

@Serializable

data class Video(val video: Blob, val captions: List<VideoCaption>? = null, val alt: String? = null, val aspectRatio: AspectRatio? = null, val presentation: VideoPresentation? = null)

VideoCaption

@Serializable

data class VideoCaption(val lang: Language, val file: Blob)

VideoPresentation

@Serializable(with = VideoPresentationSerializer::class)

sealed class VideoPresentation : AtpEnum

A hint to the client about how to present the video.

VideoPresentationSerializer

class VideoPresentationSerializer : KSerializer<VideoPresentation>

VideoView

@Serializable

data class VideoView(val cid: Cid, val playlist: Uri, val thumbnail: Uri? = null, val alt: String? = null, val aspectRatio: AspectRatio? = null, val presentation: VideoViewPresentation? = null)

VideoViewPresentation

@Serializable(with = VideoViewPresentationSerializer::class)

sealed class VideoViewPresentation : AtpEnum

A hint to the client about how to present the video.

VideoViewPresentationSerializer

class VideoViewPresentationSerializer : KSerializer<VideoViewPresentation>