DiscordBotList v0.1.0 DiscordBotList.Struct.User View Source

Module defining the Users and functions corresponding to them.

Link to this section Summary

Types

admin()

The admin status of the user.

avatar()

The avatar hash of the user's avatar.

banner()

The banner image url of the user.

bio()

The bio of the user.

certified_dev()

The certified status of the user.

color()

The custom hex color of the user.

The cdn hash of the user's avatar if the user has none.

discriminator()

The discriminator of the user.

id()

The id of the user.

mod()

The mod status of the user.

social()

The social usernames of the user.

The supporter status of the user.

t()

The username of the user.

The website moderator status of the user.

Functions

add_data(arg, map_key, struct_key)

Import a value from the string map to the atom struct. This is used when they have different names.

add_raws(arg, raws)

Import from string map values to the struct where the string key of the map is same as the atom key of the struct.

create_empty!(map)

Create an empty struct corresponding to the specified map and called module.

extract_struct!(arg)

Extract the struct from the map - struct pipeline.

get_for_user(id \\ "", token \\ nil)

Get the data about a user when supplying the user id.

Link to this section Types

admin()

admin() :: boolean()

The admin status of the user.

avatar()

avatar() :: String.t()

The avatar hash of the user's avatar.

bio()

bio() :: String.t()

The bio of the user.

certified_dev()

certified_dev() :: boolean()

The certified status of the user.

color()

color() :: String.t()

The custom hex color of the user.

def_avatar()

def_avatar() :: String.t()

The cdn hash of the user's avatar if the user has none.

discriminator()

discriminator() :: String.t()

The discriminator of the user.

id()

id() :: String.t()

The id of the user.

mod()

mod() :: boolean()

The mod status of the user.

supporter()

supporter() :: boolean()

The supporter status of the user.

t()

t() :: %DiscordBotList.Struct.User{
  admin: boolean(),
  avatar: String.t(),
  banner: String.t(),
  bio: String.t(),
  certified_dev: boolean(),
  color: String.t(),
  def_avatar: String.t(),
  discriminator: String.t(),
  id: String.t(),
  mod: boolean(),
  social: DiscordBotList.Struct.Social.t(),
  supporter: boolean(),
  username: String.t(),
  web_mod: boolean()
}

username()

username() :: String.t()

The username of the user.

web_mod()

web_mod() :: boolean()

The website moderator status of the user.

Link to this section Functions

add_data(arg, map_key, struct_key)

add_data(
  {map(),
   %DiscordBotList.Struct.User{
     admin: term(),
     avatar: term(),
     banner: term(),
     bio: term(),
     certified_dev: term(),
     color: term(),
     def_avatar: term(),
     discriminator: term(),
     id: term(),
     mod: term(),
     social: term(),
     supporter: term(),
     username: term(),
     web_mod: term()
   }},
  String.t(),
  atom()
) ::
  {map(),
   %DiscordBotList.Struct.User{
     admin: term(),
     avatar: term(),
     banner: term(),
     bio: term(),
     certified_dev: term(),
     color: term(),
     def_avatar: term(),
     discriminator: term(),
     id: term(),
     mod: term(),
     social: term(),
     supporter: term(),
     username: term(),
     web_mod: term()
   }}

Import a value from the string map to the atom struct. This is used when they have different names.

add_raws(arg, raws)

add_raws(
  {map(),
   %DiscordBotList.Struct.User{
     admin: term(),
     avatar: term(),
     banner: term(),
     bio: term(),
     certified_dev: term(),
     color: term(),
     def_avatar: term(),
     discriminator: term(),
     id: term(),
     mod: term(),
     social: term(),
     supporter: term(),
     username: term(),
     web_mod: term()
   }},
  [atom()]
) ::
  {map(),
   %DiscordBotList.Struct.User{
     admin: term(),
     avatar: term(),
     banner: term(),
     bio: term(),
     certified_dev: term(),
     color: term(),
     def_avatar: term(),
     discriminator: term(),
     id: term(),
     mod: term(),
     social: term(),
     supporter: term(),
     username: term(),
     web_mod: term()
   }}

Import from string map values to the struct where the string key of the map is same as the atom key of the struct.

create_empty!(map)

create_empty!(map()) ::
  {map(),
   %DiscordBotList.Struct.User{
     admin: term(),
     avatar: term(),
     banner: term(),
     bio: term(),
     certified_dev: term(),
     color: term(),
     def_avatar: term(),
     discriminator: term(),
     id: term(),
     mod: term(),
     social: term(),
     supporter: term(),
     username: term(),
     web_mod: term()
   }}

Create an empty struct corresponding to the specified map and called module.

extract_struct!(arg)

extract_struct!(
  {map(),
   %DiscordBotList.Struct.User{
     admin: term(),
     avatar: term(),
     banner: term(),
     bio: term(),
     certified_dev: term(),
     color: term(),
     def_avatar: term(),
     discriminator: term(),
     id: term(),
     mod: term(),
     social: term(),
     supporter: term(),
     username: term(),
     web_mod: term()
   }}
) :: %DiscordBotList.Struct.User{
  admin: term(),
  avatar: term(),
  banner: term(),
  bio: term(),
  certified_dev: term(),
  color: term(),
  def_avatar: term(),
  discriminator: term(),
  id: term(),
  mod: term(),
  social: term(),
  supporter: term(),
  username: term(),
  web_mod: term()
}

Extract the struct from the map - struct pipeline.

get_for_user(id \\ "", token \\ nil)

get_for_user(id :: String.t() | integer(), token :: String.t() | nil) :: t()

Get the data about a user when supplying the user id.