Exosphere.Bsky.Graph.List (Exosphere v0.5.0)

Copy Markdown View Source

Record schema app.bsky.graph.list.

Fields

  • avatar: blob
  • created_at: string, format datetime
  • description: string
  • description_facets: array
  • labels: union
  • name: Display name for list; can not be empty.
  • purpose: ref app.bsky.graph.defs#listPurpose

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

type_id()

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

Types

t()

@type t() :: %Exosphere.Bsky.Graph.List{
  avatar: term() | nil,
  created_at: String.t(),
  description: String.t() | nil,
  description_facets: [Exosphere.Bsky.Richtext.Facet.t()] | nil,
  extra: term(),
  labels: Exosphere.ATProto.Label.Defs.SelfLabels.t() | map() | nil,
  name: String.t(),
  purpose: 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. Record schemas include "$type".

type_id()

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

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