Exosphere.Bsky.Actor.Profile (Exosphere v0.5.0)

Copy Markdown View Source

Record schema app.bsky.actor.profile.

Fields

  • avatar: Small image to be displayed next to posts from account. AKA, 'profile picture'
  • banner: Larger horizontal image to display behind profile view.
  • created_at: string, format datetime
  • description: Free-form profile description text.
  • display_name: string
  • joined_via_starter_pack: ref com.atproto.repo.strongRef
  • labels: Self-label values, specific to the Bluesky application, on the overall account.
  • pinned_post: ref com.atproto.repo.strongRef
  • pronouns: Free-form pronouns text.
  • website: string, format uri

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.Actor.Profile{
  avatar: term() | nil,
  banner: term() | nil,
  created_at: String.t() | nil,
  description: String.t() | nil,
  display_name: String.t() | nil,
  extra: term(),
  joined_via_starter_pack: Exosphere.ATProto.Repo.StrongRef.t() | nil,
  labels: Exosphere.ATProto.Label.Defs.SelfLabels.t() | map() | nil,
  pinned_post: Exosphere.ATProto.Repo.StrongRef.t() | nil,
  pronouns: String.t() | nil,
  website: String.t() | nil
}

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.