Exosphere.Bsky.Embed.RecordWithMedia (Exosphere v0.5.0)

Copy Markdown View Source

A representation of a record embedded in a Bluesky record (eg, a post), alongside other compatible embeds. For example, a quote post and image, or a quote post and external URL card.

Object schema app.bsky.embed.recordWithMedia.

Fields

  • media: union
  • record: ref app.bsky.embed.record

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.RecordWithMedia{
  extra: term(),
  media:
    Exosphere.Bsky.Embed.Images.t()
    | Exosphere.Bsky.Embed.Video.t()
    | Exosphere.Bsky.Embed.Gallery.t()
    | Exosphere.Bsky.Embed.External.t()
    | map(),
  record: Exosphere.Bsky.Embed.Record.t()
}

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.