Exosphere.Bsky.Embed.External.External (Exosphere v0.4.0)

Copy Markdown View Source

Object schema app.bsky.embed.external##external.

Fields

  • associated_refs: StrongRefs (uri+cid) of the Atmosphere records that backed this view.
  • description: string
  • thumb: blob
  • title: string
  • uri: string, format uri

Summary

Functions

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

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

Build and validate, raising ArgumentError on error.

Encode to the wire-format map.

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

Types

t()

@type t() :: %Exosphere.Bsky.Embed.External.External{
  associated_refs: [Exosphere.ATProto.Repo.StrongRef.t()] | nil,
  description: String.t(),
  extra: term(),
  thumb: term() | nil,
  title: String.t(),
  uri: String.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.