app.bsky.draft.defs

Shared type definitions.

class atproto_client.models.app.bsky.draft.defs.DraftWithId

Bases: ModelBase

Definition model for app.bsky.draft.defs. A draft with an identifier, used to store drafts in private storage (stash).

field draft: models.AppBskyDraftDefs.Draft [Required]

Draft.

field id: Tid [Required]

A TID to be used as a draft identifier.

class atproto_client.models.app.bsky.draft.defs.Draft

Bases: ModelBase

Definition model for app.bsky.draft.defs. A draft containing an array of draft posts.

field device_id: str | None = None
Constraints:

  • max_length = 100

field device_name: str | None = None
Constraints:

  • max_length = 100

field langs: List[Language] | None = None
Constraints:

  • max_length = 3

field postgate_embedding_rules: List[models.AppBskyFeedPostgate.DisableRule | DotDict] | None = None
Constraints:

  • max_length = 5

field posts: List[models.AppBskyDraftDefs.DraftPost] [Required]

Array of draft posts that compose this draft.

Constraints:

  • min_length = 1

  • max_length = 100

field threadgate_allow: List[models.AppBskyFeedThreadgate.MentionRule | models.AppBskyFeedThreadgate.FollowerRule | models.AppBskyFeedThreadgate.FollowingRule | models.AppBskyFeedThreadgate.ListRule | DotDict] | None = None
Constraints:

  • max_length = 5

class atproto_client.models.app.bsky.draft.defs.DraftPost

Bases: ModelBase

Definition model for app.bsky.draft.defs. One of the posts that compose a draft.

field embed_externals: List[models.AppBskyDraftDefs.DraftEmbedExternal] | None = None
Constraints:

  • max_length = 1

Embed gallery.

field embed_images: List[models.AppBskyDraftDefs.DraftEmbedImage] | None = None
Constraints:

  • max_length = 4

field embed_records: List[models.AppBskyDraftDefs.DraftEmbedRecord] | None = None
Constraints:

  • max_length = 1

field embed_videos: List[models.AppBskyDraftDefs.DraftEmbedVideo] | None = None
Constraints:

  • max_length = 1

field labels: models.ComAtprotoLabelDefs.SelfLabels | DotDict | None = None
field text: str [Required]

The primary post content. It has a higher limit than post contents to allow storing a larger text that can later be refined into smaller posts.

Constraints:

  • max_length = 10000

class atproto_client.models.app.bsky.draft.defs.DraftView

Bases: ModelBase

Definition model for app.bsky.draft.defs. View to present drafts data to users.

field created_at: DateTime [Required]

The time the draft was created.

field draft: models.AppBskyDraftDefs.Draft [Required]

Draft.

field id: Tid [Required]

A TID to be used as a draft identifier.

field updated_at: DateTime [Required]

The time the draft was last updated.

class atproto_client.models.app.bsky.draft.defs.DraftEmbedLocalRef

Bases: ModelBase

Definition model for app.bsky.draft.defs.

field path: str [Required]

Local, on-device ref to file to be embedded. Embeds are currently device-bound for drafts.

Constraints:

  • min_length = 1

  • max_length = 1024

class atproto_client.models.app.bsky.draft.defs.DraftEmbedCaption

Bases: ModelBase

Definition model for app.bsky.draft.defs.

field content: str [Required]

Content.

Constraints:

  • max_length = 10000

field lang: Language [Required]

Lang.

class atproto_client.models.app.bsky.draft.defs.DraftEmbedGallery

Bases: ModelBase

Definition model for app.bsky.draft.defs.

field items: models.AppBskyDraftDefs.DraftEmbedGalleryItems [Required]

Items.

Constraints:

  • max_length = 20

class atproto_client.models.app.bsky.draft.defs.DraftEmbedImage

Bases: ModelBase

Definition model for app.bsky.draft.defs.

field alt: str | None = None

Alt.

field local_ref: models.AppBskyDraftDefs.DraftEmbedLocalRef [Required]

Local ref.

class atproto_client.models.app.bsky.draft.defs.DraftEmbedVideo

Bases: ModelBase

Definition model for app.bsky.draft.defs.

field alt: str | None = None

Alt.

field captions: List[models.AppBskyDraftDefs.DraftEmbedCaption] | None = None
Constraints:

  • max_length = 20

field local_ref: models.AppBskyDraftDefs.DraftEmbedLocalRef [Required]

Local ref.

class atproto_client.models.app.bsky.draft.defs.DraftEmbedExternal

Bases: ModelBase

Definition model for app.bsky.draft.defs.

field uri: Uri [Required]

Uri.

class atproto_client.models.app.bsky.draft.defs.DraftEmbedRecord

Bases: ModelBase

Definition model for app.bsky.draft.defs.

field record: models.ComAtprotoRepoStrongRef.Main [Required]

Record.

type atproto_client.models.app.bsky.draft.defs.DraftEmbedGalleryItems

The items a draft gallery embed can hold.