Xmtp.Metadata.Profile (xmtp_elixir_sdk v0.1.2)

Copy Markdown

Regent profile metadata codec for silent profile updates and room display.

Summary

Types

product()
t()

Functions

decode(data)
encode_regent_profile(attrs)
silent_message(attrs)

Types

product()

@type product() :: :platform | :autolaunch | :techtree

t()

@type t() :: %{
  :schema => String.t(),
  :product => product(),
  :principal_type => :human | :agent,
  :principal_id => String.t(),
  optional(:display_name) => String.t(),
  optional(:avatar_url) => String.t(),
  optional(:profile_url) => String.t(),
  optional(:wallet_address) => String.t(),
  optional(:inbox_id) => String.t(),
  optional(:overlays) => map()
}

Functions

decode(data)

@spec decode(String.t()) :: {:ok, t()} | {:error, term()}

encode_regent_profile(attrs)

@spec encode_regent_profile(map()) :: {:ok, String.t()} | {:error, term()}

silent_message(attrs)

@spec silent_message(map()) :: {:ok, map()} | {:error, term()}