DiscordBotList v0.1.0 DiscordBotList.Struct.Bot View Source

Get info about a single bot. Returns DiscordBotList.Struct.Bot struct. If you had not supplied the application already or want to override the token and id for a single call, you can suplly it here.

Link to this section Types

avatar()

avatar() :: String.t()

The avatar hash of the bot's avatar.

certified_bot()

certified_bot() :: boolean()

The certified status of the bot.

date()

date() :: DateTime.t()

The date when the bot was approved.

def_avatar()

def_avatar() :: String.t()

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

discriminator()

discriminator() :: String.t()

The discriminator of the bot.

donatebot_guild_id()

donatebot_guild_id() :: String.t()

The guild id for the donatebot setup.

github()

github() :: String.t()

The link to the github repo of the bot.

guilds()

guilds() :: [String.t()]

The guilds featured on the bot page.

id()

id() :: String.t()

The id of the bot.

invite()

invite() :: String.t()

The custom bot invite url of the bot

lib()

lib() :: String.t()

The library of the bot.

longdesc()

longdesc() :: String.t()

The long description of the bot. Can contain HTML and/or Markdown.

owners()

owners() :: [String.t()]

The owners of the bot. First one in the array is the main owner.

points()

points() :: integer()

The amount of upvotes the bot has this month.

prefix()

prefix() :: String.t()

The prefix of the bot.

shortdesc()

shortdesc() :: String.t()

The short description of the bot.

support()

support() :: String.t()

The support server invite code of the bot.

t()

t() :: %DiscordBotList.Struct.Bot{
  avatar: String.t(),
  certified_bot: boolean(),
  date: DateTime.t(),
  def_avatar: String.t(),
  discriminator: String.t(),
  donatebot_guild_id: String.t(),
  github: String.t(),
  guilds: [String.t()],
  id: String.t(),
  invite: String.t(),
  lib: String.t(),
  longdesc: String.t(),
  monthly_points: integer(),
  owners: [String.t()],
  points: integer(),
  prefix: String.t(),
  shortdesc: String.t(),
  support: String.t(),
  tags: [String.t()],
  username: String.t(),
  vanity: String.t(),
  website: String.t()
}

tags()

tags() :: [String.t()]

The tags of the bot.

username()

username() :: String.t()

The username of the bot.

vanity()

vanity() :: String.t()

The vanity url of the bot.

website()

website() :: String.t()

The website url of the bot.

Link to this section Functions

add_data(arg, map_key, struct_key)

add_data(
  {map(),
   %DiscordBotList.Struct.Bot{
     avatar: term(),
     certified_bot: term(),
     date: term(),
     def_avatar: term(),
     discriminator: term(),
     donatebot_guild_id: term(),
     github: term(),
     guilds: term(),
     id: term(),
     invite: term(),
     lib: term(),
     longdesc: term(),
     monthly_points: term(),
     owners: term(),
     points: term(),
     prefix: term(),
     shortdesc: term(),
     support: term(),
     tags: term(),
     username: term(),
     vanity: term(),
     website: term()
   }},
  String.t(),
  atom()
) ::
  {map(),
   %DiscordBotList.Struct.Bot{
     avatar: term(),
     certified_bot: term(),
     date: term(),
     def_avatar: term(),
     discriminator: term(),
     donatebot_guild_id: term(),
     github: term(),
     guilds: term(),
     id: term(),
     invite: term(),
     lib: term(),
     longdesc: term(),
     monthly_points: term(),
     owners: term(),
     points: term(),
     prefix: term(),
     shortdesc: term(),
     support: term(),
     tags: term(),
     username: term(),
     vanity: term(),
     website: 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.Bot{
     avatar: term(),
     certified_bot: term(),
     date: term(),
     def_avatar: term(),
     discriminator: term(),
     donatebot_guild_id: term(),
     github: term(),
     guilds: term(),
     id: term(),
     invite: term(),
     lib: term(),
     longdesc: term(),
     monthly_points: term(),
     owners: term(),
     points: term(),
     prefix: term(),
     shortdesc: term(),
     support: term(),
     tags: term(),
     username: term(),
     vanity: term(),
     website: term()
   }},
  [atom()]
) ::
  {map(),
   %DiscordBotList.Struct.Bot{
     avatar: term(),
     certified_bot: term(),
     date: term(),
     def_avatar: term(),
     discriminator: term(),
     donatebot_guild_id: term(),
     github: term(),
     guilds: term(),
     id: term(),
     invite: term(),
     lib: term(),
     longdesc: term(),
     monthly_points: term(),
     owners: term(),
     points: term(),
     prefix: term(),
     shortdesc: term(),
     support: term(),
     tags: term(),
     username: term(),
     vanity: term(),
     website: 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.Bot{
     avatar: term(),
     certified_bot: term(),
     date: term(),
     def_avatar: term(),
     discriminator: term(),
     donatebot_guild_id: term(),
     github: term(),
     guilds: term(),
     id: term(),
     invite: term(),
     lib: term(),
     longdesc: term(),
     monthly_points: term(),
     owners: term(),
     points: term(),
     prefix: term(),
     shortdesc: term(),
     support: term(),
     tags: term(),
     username: term(),
     vanity: term(),
     website: term()
   }}

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

extract_struct!(arg)

extract_struct!(
  {map(),
   %DiscordBotList.Struct.Bot{
     avatar: term(),
     certified_bot: term(),
     date: term(),
     def_avatar: term(),
     discriminator: term(),
     donatebot_guild_id: term(),
     github: term(),
     guilds: term(),
     id: term(),
     invite: term(),
     lib: term(),
     longdesc: term(),
     monthly_points: term(),
     owners: term(),
     points: term(),
     prefix: term(),
     shortdesc: term(),
     support: term(),
     tags: term(),
     username: term(),
     vanity: term(),
     website: term()
   }}
) :: %DiscordBotList.Struct.Bot{
  avatar: term(),
  certified_bot: term(),
  date: term(),
  def_avatar: term(),
  discriminator: term(),
  donatebot_guild_id: term(),
  github: term(),
  guilds: term(),
  id: term(),
  invite: term(),
  lib: term(),
  longdesc: term(),
  monthly_points: term(),
  owners: term(),
  points: term(),
  prefix: term(),
  shortdesc: term(),
  support: term(),
  tags: term(),
  username: term(),
  vanity: term(),
  website: term()
}

Extract the struct from the map - struct pipeline.

get_multi(config \\ [])

get_multi(keyword()) :: %{
  bots: [t()] | nil,
  count: integer() | nil,
  limit: integer() | nil,
  offset: integer() | nil,
  total: integer() | nil
}

Get info about multiple bots. You can use custom parameters here to get the wanted info.

## Parameters

token :: String.t(), usage: token: your_token.
limit :: integer() usage: limit: 10 (default is 50, maximum is 500).
offset :: integer() usage: offset: 10.
search :: keyword() usage: search: [username: "my_name"].
sort :: String.t() usage: sort: "id".

Examples

iex> get_multi() iex> get_multi(limit: 25, offset: 5, search: [username: "Poke"]) iex> get_multi(limit: 10, sort: "id")

get_single(config \\ [])

get_single(config :: keyword()) :: t()