DiscordBotList v0.1.0 DiscordBotList.Struct.VoteUser View Source

Module representing the type of user you get when you access the /bot/:id/vote endpoint. This is a subset of the DiscordBotList.Struct.User struct.

Link to this section Summary

Types

avatar()

The avatar hash of the user's avatar.

discriminator()

The discriminator of the user.

id()

The id of the user.

t()

The username 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_bot(config \\ [])

Get the vote users for the bot with the specified token and id. See DiscordBotList.Struct.Bot.get_single/1 for more info arguments. This can maximally index 1000 users. Use webhooks if you want to track for more than 1000 users.

Link to this section Types

avatar()

avatar() :: String.t()

The avatar hash of the user's avatar.

discriminator()

discriminator() :: String.t()

The discriminator of the user.

id()

id() :: String.t()

The id of the user.

t()

t() :: %DiscordBotList.Struct.VoteUser{
  avatar: String.t(),
  discriminator: String.t(),
  id: String.t(),
  username: String.t()
}

username()

username() :: String.t()

The username of the user.

Link to this section Functions

add_data(arg, map_key, struct_key)

add_data(
  {map(),
   %DiscordBotList.Struct.VoteUser{
     avatar: term(),
     discriminator: term(),
     id: term(),
     username: term()
   }},
  String.t(),
  atom()
) ::
  {map(),
   %DiscordBotList.Struct.VoteUser{
     avatar: term(),
     discriminator: term(),
     id: term(),
     username: 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.VoteUser{
     avatar: term(),
     discriminator: term(),
     id: term(),
     username: term()
   }},
  [atom()]
) ::
  {map(),
   %DiscordBotList.Struct.VoteUser{
     avatar: term(),
     discriminator: term(),
     id: term(),
     username: 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.VoteUser{
     avatar: term(),
     discriminator: term(),
     id: term(),
     username: term()
   }}

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

extract_struct!(arg)

extract_struct!(
  {map(),
   %DiscordBotList.Struct.VoteUser{
     avatar: term(),
     discriminator: term(),
     id: term(),
     username: term()
   }}
) :: %DiscordBotList.Struct.VoteUser{
  avatar: term(),
  discriminator: term(),
  id: term(),
  username: term()
}

Extract the struct from the map - struct pipeline.

get_for_bot(config \\ [])

get_for_bot(keyword()) :: [t()]

Get the vote users for the bot with the specified token and id. See DiscordBotList.Struct.Bot.get_single/1 for more info arguments. This can maximally index 1000 users. Use webhooks if you want to track for more than 1000 users.