View Source Nostrum.Struct.User (Nostrum v0.10.0)

Struct representing a Discord user.

Mentioning Users in Messages

A Nostrum.Struct.User can be mentioned in message content using the String.Chars protocol or mention/1.

user = %Nostrum.Struct.User{id: 120571255635181568}
Nostrum.Api.create_message!(184046599834435585, "#{user}")
%Nostrum.Struct.Message{content: "<@120571255635181568>"}

user = %Nostrum.Struct.User{id: 89918932789497856}
Nostrum.Api.create_message!(280085880452939778, "#{Nostrum.Struct.User.mention(user)}")
%Nostrum.Struct.Message{content: "<@89918932789497856>"}

User vs. Member

A user contains only general information about that user such as a username and an avatar. A member has everything that a user has, but also additional information on a per guild basis. This includes things like a nickname and a list of roles.

Summary

Types

avatar()

User's avatar hash

bot()

Whether the user is a bot

discriminator()

The user's 4--digit discord-tag

global_name()

The user's display name, if it is set

id()

The user's id

public_flags()

The user's public flags, as a bitset.

t()

username()

The user's username

Functions

avatar_url(user, image_format \\ "webp")

Returns the URL of a user's display avatar.

full_name(user)

Returns a user's :global_name if present, otherwise returns their :username and :discriminator separated by a hashtag.

mention(user)

Formats an Nostrum.Struct.User into a mention.

Types

avatar()

@type avatar() :: String.t() | nil

User's avatar hash

bot()

@type bot() :: boolean() | nil

Whether the user is a bot

discriminator()

@type discriminator() :: String.t()

The user's 4--digit discord-tag

global_name()

(since 0.9.0)

@type global_name() :: String.t() | nil

The user's display name, if it is set

id()

@type id() :: Nostrum.Snowflake.t()

The user's id

public_flags()

@type public_flags() :: Nostrum.Struct.User.Flags.raw_flags()

The user's public flags, as a bitset.

To parse these, use Nostrum.Struct.User.Flags.from_integer/1.

t()

@type t() :: %Nostrum.Struct.User{
  avatar: avatar(),
  bot: bot(),
  discriminator: discriminator(),
  global_name: global_name(),
  id: id(),
  public_flags: public_flags(),
  username: username()
}

username()

@type username() :: String.t()

The user's username

Functions

avatar_url(user, image_format \\ "webp")

@spec avatar_url(t(), String.t()) :: String.t()

Returns the URL of a user's display avatar.

If :avatar is nil, the default avatar url is returned.

Supported image formats are PNG, JPEG, WebP, and GIF.

Examples

iex> user = %Nostrum.Struct.User{avatar: "8342729096ea3675442027381ff50dfe",
...>                             id: 80351110224678912}
iex> Nostrum.Struct.User.avatar_url(user)
"https://cdn.discordapp.com/avatars/80351110224678912/8342729096ea3675442027381ff50dfe.webp"
iex> Nostrum.Struct.User.avatar_url(user, "png")
"https://cdn.discordapp.com/avatars/80351110224678912/8342729096ea3675442027381ff50dfe.png"

iex> user = %Nostrum.Struct.User{avatar: nil,
...>                             id: 80351110224678912,
...>                             discriminator: "0"}
iex> Nostrum.Struct.User.avatar_url(user)
"https://cdn.discordapp.com/embed/avatars/5.png"

iex> user = %Nostrum.Struct.User{avatar: nil,
...>                             discriminator: "1337"}
iex> Nostrum.Struct.User.avatar_url(user)
"https://cdn.discordapp.com/embed/avatars/2.png"

full_name(user)

@spec full_name(t()) :: String.t()

Returns a user's :global_name if present, otherwise returns their :username and :discriminator separated by a hashtag.

Examples

iex> user = %Nostrum.Struct.User{global_name: "TheRealJason",
...>                             username: "therealjason",
...>                             discriminator: "0"}
iex> Nostrum.Struct.User.full_name(user)
"TheRealJason"

iex> user = %Nostrum.Struct.User{username: "b1nzy",
...>                             discriminator: "0852"}
iex> Nostrum.Struct.User.full_name(user)
"b1nzy#0852"

mention(user)

@spec mention(t()) :: String.t()

Formats an Nostrum.Struct.User into a mention.

Examples

iex> user = %Nostrum.Struct.User{id: 177888205536886784}
...> Nostrum.Struct.User.mention(user)
"<@177888205536886784>"