DiscordBotList v0.1.0 DiscordBotList.Struct.BotStats View Source

Module representing the bot stats from the DiscordBotList API.

Link to this section Summary

Types

The amount of servers the bot is in. If an Array it acts like shards. Required if shards is not defined.

The amount of shards the bot has.

The zero-indexed id of the shard posting. Makes server_count set the shard specific server count.

shards()

The amount of servers the bot is in per shard. Not required unless server_count is not defined.

t()

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_stats_about_bot(config \\ [])

Get the stats about the bot. See DiscordBotList.Struct.Bot.get_single/1 for configs in the call.

post_updated_data(config \\ [])

Post the BotStats struct data to the server. You always needs to supply stats. To override the dault token and id see DiscordBotList.Struct.Bot.get_single/1.

Link to this section Types

server_count()

server_count() :: integer() | [integer()]

The amount of servers the bot is in. If an Array it acts like shards. Required if shards is not defined.

shard_count()

shard_count() :: integer()

The amount of shards the bot has.

shard_id()

shard_id() :: integer()

The zero-indexed id of the shard posting. Makes server_count set the shard specific server count.

shards()

shards() :: [integer()]

The amount of servers the bot is in per shard. Not required unless server_count is not defined.

t()

t() :: %DiscordBotList.Struct.BotStats{
  server_count: integer(),
  shard_count: integer(),
  shard_id: integer(),
  shards: [integer()]
}

Link to this section Functions

add_data(arg, map_key, struct_key)

add_data(
  {map(),
   %DiscordBotList.Struct.BotStats{
     server_count: term(),
     shard_count: term(),
     shard_id: term(),
     shards: term()
   }},
  String.t(),
  atom()
) ::
  {map(),
   %DiscordBotList.Struct.BotStats{
     server_count: term(),
     shard_count: term(),
     shard_id: term(),
     shards: 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.BotStats{
     server_count: term(),
     shard_count: term(),
     shard_id: term(),
     shards: term()
   }},
  [atom()]
) ::
  {map(),
   %DiscordBotList.Struct.BotStats{
     server_count: term(),
     shard_count: term(),
     shard_id: term(),
     shards: 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.BotStats{
     server_count: term(),
     shard_count: term(),
     shard_id: term(),
     shards: term()
   }}

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

extract_struct!(arg)

extract_struct!(
  {map(),
   %DiscordBotList.Struct.BotStats{
     server_count: term(),
     shard_count: term(),
     shard_id: term(),
     shards: term()
   }}
) :: %DiscordBotList.Struct.BotStats{
  server_count: term(),
  shard_count: term(),
  shard_id: term(),
  shards: term()
}

Extract the struct from the map - struct pipeline.

get_stats_about_bot(config \\ [])

get_stats_about_bot(keyword()) :: t()

Get the stats about the bot. See DiscordBotList.Struct.Bot.get_single/1 for configs in the call.

post_updated_data(config \\ [])

post_updated_data(keyword()) :: {:error, String.t() | atom()} | {:ok, nil}

Post the BotStats struct data to the server. You always needs to supply stats. To override the dault token and id see DiscordBotList.Struct.Bot.get_single/1.

## Examples iex> data = %DiscordBotList.Struct.BotStats{server_count: 10, shard_count: 5} iex> post_updated_data(stats: data)