Exosphere.ATProto.Label.Defs.LabelValueDefinitionStrings (Exosphere v0.5.0)

Copy Markdown View Source

Strings which describe the label in the UI, localized into a specific language.

Object schema com.atproto.label.defs##labelValueDefinitionStrings.

Fields

  • description: A longer description of what the label means and why it might be applied.
  • lang: The code of the language these strings are written in.
  • name: A short human-readable name for the label.

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.ATProto.Label.Defs.LabelValueDefinitionStrings{
  description: String.t(),
  extra: term(),
  lang: 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.

type_id()

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

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