alchemy v0.6.0 Alchemy.User
This module contains functions and types related to discord users.
Summary
Types
Represents a discord User. The default values exist to cover missing fields
A shortened version of a Guild struct, through the view of a User
Types
t :: %Alchemy.User{avatar: String.t, bot: Boolean, discriminator: String.t, email: :hidden | String.t, id: String.t, username: String.t, verified: :hidden | Boolean}
Represents a discord User. The default values exist to cover missing fields.
id
represents a unique user id
username
represents a user’s current username
discriminator
4 digit tag to differenciate usernames
avatar
A string representing their avatar hash. Use
avatar_url
to get the corresponding url from aUser
objectbot
Whether or not the user is a bot - default:
false
A bot usually doesn’t have the authorization necessary to access these 2, so they’re usually missing.
verified
Whether the account is verified - default:
:hidden
email
The user’s email - default:
:hidden
user_guild :: %Alchemy.UserGuild{icon: String.t, id: snowflake, name: String.t, owner: Boolean, permissions: Integer}
A shortened version of a Guild struct, through the view of a User.
id
Represents the guild’s id.
name
Represents the guild’s name.
icon
A string representing the guild’s icon hash.
owner
Whether the user linked to the guild owns it.
permissions
Bitwise of the user’s enabled/disabled permissions.
Functions
Used to get the url for a user’s avatar
type
must be one of "png"
, "webp"
, "jpg"
, "gif"
size
must be one of 128
, 256
, 512
, 1024
, 2048
Examples
> User.avatar_url(user)
https://cdn.discordapp.com/avatars/...