Exosphere.Bsky.Graph.Starterpack (Exosphere v0.3.0)

Copy Markdown View Source

Record schema app.bsky.graph.starterpack.

Fields

  • created_at: string, format datetime
  • description: string
  • description_facets: array
  • feeds: array
  • list: Reference (AT-URI) to the list record.
  • name: Display name for starter pack; can not be empty.

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. Record schemas include "$type".

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

Types

t()

@type t() :: %Exosphere.Bsky.Graph.Starterpack{
  created_at: String.t(),
  description: String.t() | nil,
  description_facets: [Exosphere.Bsky.Richtext.Facet.t()] | nil,
  extra: term(),
  feeds: [Exosphere.Bsky.Graph.Starterpack.FeedItem.t()] | nil,
  list: String.t(),
  name: 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. Record schemas include "$type".

type_id()

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

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