APIClient

APIClient is the base abstraction for interacting with the Discord API.

class APIClient {

string baseURL;

string token;

RateLimiter ratelimit;

Client client;

this(Client client);

APIResponse requestJSON(HTTPMethod method, U url);

APIResponse requestJSON(HTTPMethod method, U url, VibeJSON obj);

APIResponse requestJSON(HTTPMethod method, U url, string data, Duration timeout);

User user(Snowflake id);

User meSettings(string username, string avatar);

Guild[] meGuilds();

void meGuildLeave(Snowflake id);

Channel[] meDMChannels();

Channel meDMCreate(Snowflake recipientID);

Guild guild(Snowflake id);

void guildDelete(Snowflake id);

Channel[] guildChannels(Snowflake id);

void guildRemoveMember(Snowflake id, Snowflake user);

Message sendMessage(Snowflake chan, string content, string nonce, bool tts);

Message editMessage(Snowflake chan, Snowflake msg, string content);

void deleteMessage(Snowflake chan, Snowflake msg);

void bulkDeleteMessages(Snowflake chan, Snowflake[] msgs);

string gateway(int gatewayVersion);

}

Constructors

this this(Client client): Undocumented in source.

Members

Functions

bulkDeleteMessages void bulkDeleteMessages(Snowflake chan, Snowflake[] msgs): Deletes messages in bulk.
deleteMessage void deleteMessage(Snowflake chan, Snowflake msg): Deletes a message.
editMessage Message editMessage(Snowflake chan, Snowflake msg, string content): Edits a messages contents.
gateway string gateway(int gatewayVersion): Returns a valid Gateway Websocket URL
guild Guild guild(Snowflake id): Returns a Guild for a Snowflake ID.
guildChannels Channel[] guildChannels(Snowflake id): Returns a list of channels for a Guild.
guildDelete void guildDelete(Snowflake id): Deletes a guild.
guildRemoveMember void guildRemoveMember(Snowflake id, Snowflake user): Removes (kicks) a user from a Guild.
me User me(): Return the User object for the currently logged in user.
meDMChannels Channel[] meDMChannels(): Returns a list of Channel objects for the current user.
meDMCreate Channel meDMCreate(Snowflake recipientID): Creates a new DM for a recipient (user) ID. Returns a Channel object.
meGuildLeave void meGuildLeave(Snowflake id): Leaves a guild.
meGuilds Guild[] meGuilds(): Returns a list of Guild objects for the current user.
meSettings User meSettings(string username, string avatar): Modifies the current users settings. Returns a User object.
requestJSON APIResponse requestJSON(HTTPMethod method, U url): Makes a HTTP request to the API (with empty body), returning an APIResponse
requestJSON APIResponse requestJSON(HTTPMethod method, U url, VibeJSON obj): Makes a HTTP request to the API (with JSON body), returning an APIResponse
requestJSON APIResponse requestJSON(HTTPMethod method, U url, string data, Duration timeout): Makes a HTTP request to the API (with string body), returning an APIResponse
sendMessage Message sendMessage(Snowflake chan, string content, string nonce, bool tts): Sends a message to a channel.
user User user(Snowflake id): Return a User object for a Snowflake ID.

Variables

baseURL string baseURL;: Undocumented in source.
client Client client;: Undocumented in source.
log Logger log;: Undocumented in source.
ratelimit RateLimiter ratelimit;: Undocumented in source.
token string token;: Undocumented in source.

Meta

Source

See Implementation

dscord api client classes

APIClient