Document

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)

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.