Exosphere.Bsky.Embed.Images.Image (Exosphere v0.5.0)

Copy Markdown View Source

A set of images embedded in a Bluesky record (eg, a post).

Object schema app.bsky.embed.images##image.

Fields

  • alt: Alt text description of the image, for accessibility.
  • aspect_ratio: ref app.bsky.embed.defs#aspectRatio
  • image: The raw image file. May be up to 2 MB, formerly limited to 1 MB.

Summary

Types

t()

Functions

from_map(map)

Decode a wire-format map. Delegates to new/1.

new(attrs)

Build and validate from a map of attrs (atom or wire string keys).

new!(attrs)

Build and validate, raising ArgumentError on error.

to_map(struct)

Encode to the wire-format map.

type_id()

The lexicon type ID (nsid or nsid#def) this module was generated from.

Types

t()

@type t() :: %Exosphere.Bsky.Embed.Images.Image{
  alt: String.t(),
  aspect_ratio: Exosphere.Bsky.Embed.Defs.AspectRatio.t() | nil,
  extra: term(),
  image: term()
}

Functions

from_map(map)

@spec from_map(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Decode a wire-format map. Delegates to new/1.

new(attrs)

@spec new(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Build and validate from a map of attrs (atom or wire string keys).

Unknown keys are kept in extra and re-emitted by to_map/1.

new!(attrs)

@spec new!(map()) :: t()

Build and validate, raising ArgumentError on error.

to_map(struct)

@spec to_map(t()) :: map()

Encode to the wire-format map.

type_id()

@spec type_id() :: String.t()

The lexicon type ID (nsid or nsid#def) this module was generated from.