crux_structs v0.1.6 Crux.Structs.Member View Source

Represents a Discord Guild Member Object.

Differences opposed to the Discord API Object:

:user is just the user id

Link to this section Summary

Types

t()

Functions

create(data)

Creates a Crux.Structs.Member struct from raw data

to_mention(member)

Converts a Crux.Structs.Member into its discord mention format

Link to this section Types

t() (since 0.1.0)

t() :: %Crux.Structs.Member{
  deaf: boolean() | nil,
  guild_id: Crux.Rest.snowflake() | nil,
  joined_at: String.t(),
  mute: boolean() | nil,
  nick: String.t() | nil,
  roles: MapSet.t(Crux.Rest.snowflake()),
  user: Crux.Rest.snowflake()
}

Link to this section Functions

create(data) (since 0.1.0)

Creates a Crux.Structs.Member struct from raw data.

Automatically invoked by Crux.Structs.create/2.

to_mention(member) (since 0.1.1)

to_mention(user :: Crux.Structs.Member.t()) :: String.t()

Converts a Crux.Structs.Member into its discord mention format.

Examples

# Without nickname
iex> %Crux.Structs.Member{user: 218348062828003328, nick: nil}
...> |> Crux.Structs.Member.to_mention()
"<@218348062828003328>"

# With nickname
iex> %Crux.Structs.Member{user: 218348062828003328, nick: "weltraum"}
...> |> Crux.Structs.Member.to_mention()
"<@!218348062828003328>"