crux_structs v0.2.3 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

id_resolvable()

All available types that can be resolved into a user id.

t()

Functions

create(data)

Creates a t:Crux.Structs.Member.t/0 struct from raw data.

resolve_id(resolvable)

Resolves the id of a t:Crux.Structs.Member.t/0.

to_mention(member)

Converts a t:Crux.Structs.Member.t/0 into its discord mention format.

Link to this section Types

id_resolvable()

(since 0.2.1)

Specs

id_resolvable() :: Crux.Structs.User.id_resolvable()

All available types that can be resolved into a user id.

t()

(since 0.1.0)

Specs

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

Link to this section Functions

create(data)

(since 0.1.0)

Specs

create(data :: map()) :: t()

Creates a t:Crux.Structs.Member.t/0 struct from raw data.

Automatically invoked by Crux.Structs.create/2.

resolve_id(resolvable)

(since 0.2.1)

Specs

resolve_id(id_resolvable()) :: Crux.Structs.Snowflake.t() | nil

Resolves the id of a t:Crux.Structs.Member.t/0.

Automatically invoked by Crux.Structs.resolve_id/2.

iex> %Crux.Structs.Member{user: 218348062828003328}
...> |> Crux.Structs.Member.resolve_id()
218348062828003328

For more examples see Crux.Structs.User.resolve_id/1.

to_mention(member)

(since 0.1.1)

Specs

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

Converts a t:Crux.Structs.Member.t/0 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>"