Document

data class Document(val bskyPostRef: StrongRef? = null, val content: DocumentContentUnion? = null, val contributors: List<DocumentContributor>? = null, val coverImage: Blob? = null, val description: String? = null, val labels: DocumentLabelsUnion? = null, val links: DocumentLinksUnion? = null, val path: String? = null, val publishedAt: Timestamp, val site: Uri, val tags: List<String>? = null, val textContent: String? = null, val title: String, val updatedAt: Timestamp? = null)

Parameters

bskyPostRef

Strong reference to a Bluesky post. Useful to keep track of comments off-platform.

content

Open union used to define the record's content. Each entry must specify a $type and may be extended with other lexicons to support additional content formats.

coverImage

Image to used for thumbnail or cover image. Less than 1MB is size.

description

A brief description or excerpt from the document.

labels

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

links

Array of values describing relationships between this document and external resources

path

Combine with site or publication url to construct a canonical URL to the document. Prepend with a leading slash.

publishedAt

Timestamp of the documents publish time.

site

Points to a publication record (at://) or a publication url (https://) for loose documents. Avoid trailing slashes.

tags

Array of strings used to tag or categorize the document. Avoid prepending tags with hashtags.

textContent

Plaintext representation of the documents contents. Should not contain markdown or other formatting.

title

Title of the document.

updatedAt

Timestamp of the documents last edit.

Constructors

Link copied to clipboard
constructor(bskyPostRef: StrongRef? = null, content: DocumentContentUnion? = null, contributors: List<DocumentContributor>? = null, coverImage: Blob? = null, description: String? = null, labels: DocumentLabelsUnion? = null, links: DocumentLinksUnion? = null, path: String? = null, publishedAt: Timestamp, site: Uri, tags: List<String>? = null, textContent: String? = null, title: String, updatedAt: Timestamp? = null)

Properties

Link copied to clipboard

Strong reference to a Bluesky post. Useful to keep track of comments off-platform.

Link copied to clipboard

Open union used to define the record's content. Each entry must specify a $type and may be extended with other lexicons to support additional content formats.

Link copied to clipboard
Link copied to clipboard

Image to used for thumbnail or cover image. Less than 1MB is size.

Link copied to clipboard

A brief description or excerpt from the document.

Link copied to clipboard

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

Link copied to clipboard

Array of values describing relationships between this document and external resources

Link copied to clipboard
val path: String?

Combine with site or publication url to construct a canonical URL to the document. Prepend with a leading slash.

Link copied to clipboard

Timestamp of the documents publish time.

Link copied to clipboard
val site: Uri

Points to a publication record (at://) or a publication url (https://) for loose documents. Avoid trailing slashes.

Link copied to clipboard

Array of strings used to tag or categorize the document. Avoid prepending tags with hashtags.

Link copied to clipboard

Plaintext representation of the documents contents. Should not contain markdown or other formatting.

Link copied to clipboard

Title of the document.

Link copied to clipboard

Timestamp of the documents last edit.