crux_structs v0.1.6 Crux.Structs.User View Source

Represents a Discord User Object

Link to this section Summary

Types

t()

Functions

create(data)

Creates a Crux.Structs.User struct from raw data

to_mention(user)

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

Link to this section Types

t() (since 0.1.0)

t() :: %Crux.Structs.User{
  avatar: String.t() | nil,
  bot: boolean(),
  discriminator: String.t(),
  id: Crux.Rest.snowflake(),
  username: String.t()
}

Link to this section Functions

create(data) (since 0.1.0)

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

Automatically invoked by Crux.Structs.create/2.

to_mention(user) (since 0.1.1)

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

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

iex> %Crux.Structs.User{id: 218348062828003328}
...> |> Crux.Structs.User.to_mention()
"<@218348062828003328>"