Xmtp.Metadata.GroupAppData (xmtp_elixir_sdk v0.1.2)

Copy Markdown

Regent group appData codec.

The appData document is a small JSON object with one Regent-owned section. Product apps can put room and member display metadata here without exposing raw XMTP group internals to UI code.

Summary

Functions

decode(data)
encode(attrs)
get_member_profile(app_data, principal_id)
put_member_profile(app_data, principal_id, profile)

Functions

decode(data)

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

encode(attrs)

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

get_member_profile(app_data, principal_id)

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

put_member_profile(app_data, principal_id, profile)

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