app.bsky.embed.external

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

class atproto_client.models.app.bsky.embed.external.Main

Bases: ModelBase

Definition model for app.bsky.embed.external. A representation of some externally linked content (eg, a URL and ‘card’), embedded in a Bluesky record (eg, a post).

field external: models.AppBskyEmbedExternal.External [Required]: External.

class atproto_client.models.app.bsky.embed.external.External

Bases: ModelBase

Definition model for app.bsky.embed.external.

field associated_refs: List[models.ComAtprotoRepoStrongRef.Main] | None = None

field description: str [Required]: Description.

field thumb: BlobRef | None = None: Thumb.

field title: str [Required]: Title.

field uri: Uri [Required]: Uri.

class atproto_client.models.app.bsky.embed.external.View

Bases: ModelBase

Definition model for app.bsky.embed.external.

field external: models.AppBskyEmbedExternal.ViewExternal [Required]: External.

class atproto_client.models.app.bsky.embed.external.ViewExternal

Bases: ModelBase

Definition model for app.bsky.embed.external.

field associated_profiles: List[models.AppBskyActorDefs.ProfileViewBasic] | None = None

field associated_refs: List[models.ComAtprotoRepoStrongRef.Main] | None = None

field created_at: DateTime | None = None

field description: str [Required]: Description.

field labels: List[models.ComAtprotoLabelDefs.Label] | None = None: Labels.

field reading_time: int | None = None: Estimated reading time in minutes, if applicable and available.

field source: models.AppBskyEmbedExternal.ViewExternalSource | None = None: Source.

field thumb: Uri | None = None: Thumb.

field title: str [Required]: Title.

field updated_at: DateTime | None = None: When the external content was updated, if available.

field uri: Uri [Required]: Uri.

class atproto_client.models.app.bsky.embed.external.ViewExternalSource

Bases: ModelBase

Definition model for app.bsky.embed.external. The source of an external embed, such as a standard.site publication.

field description: str | None = None: Description.

field icon: Uri | None = None

field theme: models.AppBskyEmbedExternal.ViewExternalSourceTheme | None = None: Theme.

field title: str [Required]: Title.

field uri: Uri [Required]: URI of the source, if available. Example: the https:// URL of a site.standard.publication record.

class atproto_client.models.app.bsky.embed.external.ViewExternalSourceTheme

Bases: ModelBase

Definition model for app.bsky.embed.external. 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.

field accent_foreground_rgb: models.AppBskyEmbedExternal.ColorRGB | None = None: Accent foreground r g b.

field accent_rgb: models.AppBskyEmbedExternal.ColorRGB | None = None: Accent r g b.

field background_rgb: models.AppBskyEmbedExternal.ColorRGB | None = None: Background r g b.

field foreground_rgb: models.AppBskyEmbedExternal.ColorRGB | None = None: Foreground r g b.

class atproto_client.models.app.bsky.embed.external.ColorRGB

Bases: ModelBase

Definition model for app.bsky.embed.external. RGB color definition, inspired by site.standard.theme.color#rgb.

field b: int [Required]

Constraints:

ge = 0
le = 255

field g: int [Required]

Constraints:

ge = 0
le = 255

field r: int [Required]

Constraints:

ge = 0
le = 255

class atproto_client.models.app.bsky.embed.external.ViewArticle

Bases: ModelBase

Definition model for app.bsky.embed.external.

field associated_profiles: List[models.AppBskyActorDefs.ProfileViewBasic] | None = None: Associated profiles.

field associated_refs: List[models.ComAtprotoRepoStrongRef.Main] | None = None: Associated refs.

field created_at: DateTime | None = None: Created at.

field description: str [Required]: Description.

field image: Uri | None = None: Image.

field labels: List[models.ComAtprotoLabelDefs.Label] | None = None: Labels.

field like_count: int | None = None

Like count.

Constraints:

ge = 0

field likers: List[models.AppBskyActorDefs.ProfileViewBasic] | None = None

Constraints:

max_length = 3

field publisher: models.AppBskyEmbedExternal.ViewArticlePublication | None = None: Publisher.

field reading_time: int | None = None

Reading time.

Constraints:

ge = 1

field title: str [Required]: Title.

field updated_at: DateTime | None = None: Updated at.

field uri: Uri [Required]: Uri.

class atproto_client.models.app.bsky.embed.external.ViewArticlePublication

Bases: ModelBase

Definition model for app.bsky.embed.external.

field associated_profiles: List[models.AppBskyActorDefs.ProfileViewBasic] | None = None: Associated profiles.

field associated_refs: List[models.ComAtprotoRepoStrongRef.Main] | None = None: Associated refs.

field created_at: DateTime | None = None: Created at.

field description: str [Required]: Description.

field image: Uri | None = None: Image.

field labels: List[models.ComAtprotoLabelDefs.Label] | None = None: Labels.

field logo: Uri | None = None: Logo.

field subscribers: List[models.AppBskyActorDefs.ProfileViewBasic] | None = None

Constraints:

max_length = 3

field subscription_count: int | None = None

Subscription count.

Constraints:

ge = 0

field theme: models.AppBskyEmbedExternal.ViewArticlePublicationTheme | None = None: Theme.

field title: str [Required]: Title.

field updated_at: DateTime | None = None: Updated at.

field uri: Uri [Required]: Uri.

class atproto_client.models.app.bsky.embed.external.ViewArticlePublicationTheme

Bases: ModelBase

Definition model for app.bsky.embed.external.

field accent: str | None = None: Hex color string, if available. Example: ‘#ffffff’.

field accent_foreground: str | None = None: Hex color string, if available. Example: ‘#ffffff’.

field background: str | None = None: Hex color string, if available. Example: ‘#ffffff’.

field foreground: str | None = None: Hex color string, if available. Example: ‘#ffffff’.

class atproto_client.models.app.bsky.embed.external.ViewGallery

Bases: ModelBase

Definition model for app.bsky.embed.external.

field associated_profiles: List[models.AppBskyActorDefs.ProfileViewBasic] | None = None: Associated profiles.

field associated_refs: List[models.ComAtprotoRepoStrongRef.Main] | None = None: Associated refs.

field created_at: DateTime | None = None: Created at.

field description: str [Required]: Description.

field items: List[models.AppBskyEmbedExternal.ViewGalleryImage | DotDict] [Required]: The media items in the gallery. Each item may be of a different type, but all types must be supported by the client.

field labels: List[models.ComAtprotoLabelDefs.Label] | None = None: Labels.

field like_count: int | None = None

Like count.

Constraints:

ge = 0

field likers: List[models.AppBskyActorDefs.ProfileViewBasic] | None = None

Constraints:

max_length = 3

field title: str [Required]: Title.

field updated_at: DateTime | None = None: Updated at.

field uri: Uri [Required]: Uri.

class atproto_client.models.app.bsky.embed.external.ViewGalleryImage

Bases: ModelBase

Definition model for app.bsky.embed.external.

field alt: str | None = None: Alt text description of the image, for accessibility.

field aspect_ratio: models.AppBskyEmbedDefs.AspectRatio | None = None: Aspect ratio.

field fullsize: Uri [Required]: Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View.

field thumbnail: Uri [Required]: Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View.

class atproto_client.models.app.bsky.embed.external.ViewLivestream

Bases: ModelBase

Definition model for app.bsky.embed.external.