D++ (DPP)
C++ Discord API Bot Library
dpp::cluster Class Reference

The cluster class represents a group of shards and a command queue for sending and receiving commands from discord via HTTP. You should usually instantiate a cluster object at the very least to make use of the library. More...

#include <cluster.h>

+ Collaboration diagram for dpp::cluster:

Public Member Functions

 cluster (const std::string &token, uint32_t intents=i_default_intents, uint32_t shards=0, uint32_t cluster_id=0, uint32_t maxclusters=1, bool compressed=true, cache_policy_t policy={cp_aggressive, cp_aggressive, cp_aggressive})
 Constructor for creating a cluster. All but the token are optional. More...
 
 cluster (const cluster &)=delete
 dpp::cluster is non-copyable More...
 
 cluster (const cluster &&)=delete
 dpp::cluster is non-moveable More...
 
virtual ~cluster ()
 Destroy the cluster object. More...
 
clusterset_websocket_protocol (websocket_protocol_t mode)
 Set the websocket protocol for all shards on this cluster. You should call this method before cluster::start. Generally ws_etf is faster, but provides less facilities for debugging should something go wrong. It is recommended to use ETF in production and JSON in development. More...
 
clusterset_audit_reason (const std::string &reason)
 Set the audit log reason for the next REST call to be made. This is set per-thread, so you must ensure that if you call this method, your request that is associated with the reason happens on the same thread where you set the reason. Once the next call is made, the audit log reason is cleared for this thread automatically. More...
 
clusterclear_audit_reason ()
 Clear the audit log reason for the next REST call to be made. This is set per-thread, so you must ensure that if you call this method, your request that is associated with the reason happens on the same thread where you set the reason. Once the next call is made, the audit log reason is cleared for this thread automatically. More...
 
std::string get_audit_reason ()
 Get the audit reason set for the next REST call to be made on this thread. This is set per-thread, so you must ensure that if you call this method, your request that is associated with the reason happens on the same thread where you set the reason. Once the next call is made, the audit log reason is cleared for this thread automatically. More...
 
void log (dpp::loglevel severity, const std::string &msg) const
 Log a message to whatever log the user is using. The logged message is passed up the chain to the on_log event in user code which can then do whatever it wants to do with it. More...
 
timer start_timer (timer_callback_t on_tick, uint64_t frequency, timer_callback_t on_stop={})
 Start a timer. Every frequency seconds, the callback is called. More...
 
bool stop_timer (timer t)
 Stop a ticking timer. More...
 
snowflake get_dm_channel (snowflake user_id)
 Get the dm channel for a user id. More...
 
void set_dm_channel (snowflake user_id, snowflake channel_id)
 Set the dm channel id for a user id. More...
 
dpp::utility::uptime uptime ()
 Returns the uptime of the cluster. More...
 
void start (bool return_after=true)
 Start the cluster, connecting all its shards. More...
 
void set_presence (const class dpp::presence &p)
 Set the presence for all shards on the cluster. More...
 
discord_clientget_shard (uint32_t id)
 Get a shard by id, returning the discord_client. More...
 
const shard_listget_shards ()
 Get the list of shards. More...
 
void post_rest (const std::string &endpoint, const std::string &major_parameters, const std::string &parameters, http_method method, const std::string &postdata, json_encode_t callback, const std::string &filename="", const std::string &filecontent="")
 Post a REST request. Where possible use a helper method instead like message_create. More...
 
void post_rest_multipart (const std::string &endpoint, const std::string &major_parameters, const std::string &parameters, http_method method, const std::string &postdata, json_encode_t callback, const std::vector< std::string > &filename={}, const std::vector< std::string > &filecontent={})
 Post a multipart REST request. Where possible use a helper method instead like message_create. More...
 
void request (const std::string &url, http_method method, http_completion_event callback, const std::string &postdata="", const std::string &mimetype="text/plain", const std::multimap< std::string, std::string > &headers={})
 Make a HTTP(S) request. For use when wanting asynchronous access to HTTP APIs outside of Discord. More...
 
void interaction_response_create (snowflake interaction_id, const std::string &token, const interaction_response &r, command_completion_event_t callback={})
 Respond to a slash command. More...
 
void interaction_response_edit (const std::string &token, const message &r, command_completion_event_t callback={})
 Respond to a slash command. More...
 
void global_command_create (const slashcommand &s, command_completion_event_t callback={})
 Create a global slash command (a bot can have a maximum of 100 of these). More...
 
void global_command_get (snowflake id, command_completion_event_t callback={})
 Get a global slash command. More...
 
void guild_auditlog_get (snowflake guild_id, command_completion_event_t callback)
 Get the audit log for a guild. More...
 
void guild_command_create (const slashcommand &s, snowflake guild_id, command_completion_event_t callback={})
 Create a slash command local to a guild. More...
 
void guild_bulk_command_create (const std::vector< slashcommand > &commands, snowflake guild_id, command_completion_event_t callback={})
 Create/overwrite guild slash commands. Any existing guild slash commands on this guild will be deleted and replaced with these. More...
 
void global_bulk_command_create (const std::vector< slashcommand > &commands, command_completion_event_t callback={})
 Create/overwrite global slash commands. Any existing global slash commands will be deleted and replaced with these. More...
 
void global_command_edit (const slashcommand &s, command_completion_event_t callback={})
 Edit a global slash command (a bot can have a maximum of 100 of these) More...
 
void guild_command_get (snowflake id, snowflake guild_id, command_completion_event_t callback={})
 Get a slash command of a guild. More...
 
void guild_command_edit (const slashcommand &s, snowflake guild_id, command_completion_event_t callback={})
 Edit a slash command local to a guild. More...
 
void guild_command_edit_permissions (const slashcommand &s, snowflake guild_id, command_completion_event_t callback={})
 Edit slash command permissions of a guild. More...
 
void guild_command_get_permissions (snowflake id, snowflake guild_id, command_completion_event_t callback={})
 Get the permissions for a slash command of a guild. More...
 
void guild_bulk_command_edit_permissions (const std::vector< slashcommand > &commands, snowflake guild_id, command_completion_event_t callback={})
 Edit/Overwrite the permissions of all existing slash commands in a guild. More...
 
void global_command_delete (snowflake id, command_completion_event_t callback={})
 Delete a global slash command (a bot can have a maximum of 100 of these) More...
 
void guild_command_delete (snowflake id, snowflake guild_id, command_completion_event_t callback={})
 Delete a slash command local to a guild. More...
 
void guild_commands_get (snowflake guild_id, command_completion_event_t callback)
 Get the application's slash commands for a guild. More...
 
void guild_commands_get_permissions (snowflake guild_id, command_completion_event_t callback)
 Get all slash command permissions of a guild. More...
 
void global_commands_get (command_completion_event_t callback)
 Get the application's global slash commands. More...
 
void direct_message_create (snowflake user_id, const message &m, command_completion_event_t callback={})
 Create a direct message, also create the channel for the direct message if needed. More...
 
void message_get (snowflake message_id, snowflake channel_id, command_completion_event_t callback)
 Get a message. More...
 
void messages_get (snowflake channel_id, snowflake around, snowflake before, snowflake after, uint32_t limit, command_completion_event_t callback)
 Get multiple messages. More...
 
void message_create (const struct message &m, command_completion_event_t callback={})
 Send a message to a channel. The callback function is called when the message has been sent. More...
 
void message_crosspost (snowflake message_id, snowflake channel_id, command_completion_event_t callback={})
 Crosspost a message. The callback function is called when the message has been sent. More...
 
void message_edit (const struct message &m, command_completion_event_t callback={})
 Edit a message on a channel. The callback function is called when the message has been edited. More...
 
void message_add_reaction (const struct message &m, const std::string &reaction, command_completion_event_t callback={})
 Add a reaction to a message. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_delete_own_reaction (const struct message &m, const std::string &reaction, command_completion_event_t callback={})
 Delete own reaction from a message. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_delete_reaction (const struct message &m, snowflake user_id, const std::string &reaction, command_completion_event_t callback={})
 Delete a user's reaction from a message. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_get_reactions (const struct message &m, const std::string &reaction, snowflake before, snowflake after, snowflake limit, command_completion_event_t callback)
 Get reactions on a message for a particular emoji. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_delete_all_reactions (const struct message &m, command_completion_event_t callback={})
 Delete all reactions on a message. More...
 
void message_delete_reaction_emoji (const struct message &m, const std::string &reaction, command_completion_event_t callback={})
 Delete all reactions on a message using a particular emoji. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_add_reaction (snowflake message_id, snowflake channel_id, const std::string &reaction, command_completion_event_t callback={})
 Add a reaction to a message by id. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_delete_own_reaction (snowflake message_id, snowflake channel_id, const std::string &reaction, command_completion_event_t callback={})
 Delete own reaction from a message by id. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_delete_reaction (snowflake message_id, snowflake channel_id, snowflake user_id, const std::string &reaction, command_completion_event_t callback={})
 Delete a user's reaction from a message by id. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_get_reactions (snowflake message_id, snowflake channel_id, const std::string &reaction, snowflake before, snowflake after, snowflake limit, command_completion_event_t callback)
 Get reactions on a message for a particular emoji by id. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_delete_all_reactions (snowflake message_id, snowflake channel_id, command_completion_event_t callback={})
 Delete all reactions on a message by id. More...
 
void message_delete_reaction_emoji (snowflake message_id, snowflake channel_id, const std::string &reaction, command_completion_event_t callback={})
 Delete all reactions on a message using a particular emoji by id. The reaction string must be either an emojiname:id or a unicode character. More...
 
void message_delete (snowflake message_id, snowflake channel_id, command_completion_event_t callback={})
 Delete a message from a channel. The callback function is called when the message has been edited. More...
 
void message_delete_bulk (const std::vector< snowflake > &message_ids, snowflake channel_id, command_completion_event_t callback={})
 Bulk delete messages from a channel. The callback function is called when the message has been edited. More...
 
void channel_get (snowflake c, command_completion_event_t callback)
 Get a channel. More...
 
void channels_get (snowflake guild_id, command_completion_event_t callback)
 Get all channels for a guild. More...
 
void channel_create (const class channel &c, command_completion_event_t callback={})
 Create a channel. More...
 
void channel_edit (const class channel &c, command_completion_event_t callback={})
 Edit a channel. More...
 
void channel_edit_positions (const std::vector< channel > &c, command_completion_event_t callback={})
 Edit multiple channels positions. More...
 
void channel_edit_permissions (const class channel &c, const snowflake overwrite_id, const uint32_t allow, const uint32_t deny, const bool member, command_completion_event_t callback={})
 Edit a channel's permissions. More...
 
void channel_edit_permissions (const snowflake channel_id, const snowflake overwrite_id, const uint32_t allow, const uint32_t deny, const bool member, command_completion_event_t callback={})
 Edit a channel's permissions. More...
 
void channel_delete (snowflake channel_id, command_completion_event_t callback={})
 Delete a channel. More...
 
void invite_get (const std::string &invite, command_completion_event_t callback)
 Get details about an invite. More...
 
void invite_delete (const std::string &invite, command_completion_event_t callback={})
 Delete an invite. More...
 
void channel_invites_get (const class channel &c, command_completion_event_t callback)
 Get invites for a channel. More...
 
void channel_invite_create (const class channel &c, const class invite &i, command_completion_event_t callback={})
 Create invite for a channel. More...
 
void channel_pins_get (snowflake channel_id, command_completion_event_t callback)
 Get a channel's pins. More...
 
void gdm_add (snowflake channel_id, snowflake user_id, const std::string &access_token, const std::string &nick, command_completion_event_t callback={})
 Adds a recipient to a Group DM using their access token. More...
 
void gdm_remove (snowflake channel_id, snowflake user_id, command_completion_event_t callback={})
 Removes a recipient from a Group DM. More...
 
void channel_delete_permission (const class channel &c, snowflake overwrite_id, command_completion_event_t callback={})
 Remove a permission from a channel. More...
 
void channel_follow_news (const class channel &c, snowflake target_channel_id, command_completion_event_t callback={})
 Follow a news channel. More...
 
void channel_typing (const class channel &c, command_completion_event_t callback={})
 Trigger channel typing indicator. More...
 
void channel_typing (snowflake cid, command_completion_event_t callback={})
 Trigger channel typing indicator. More...
 
void message_pin (snowflake channel_id, snowflake message_id, command_completion_event_t callback={})
 Pin a message. More...
 
void message_unpin (snowflake channel_id, snowflake message_id, command_completion_event_t callback={})
 Unpin a message. More...
 
void guild_get (snowflake g, command_completion_event_t callback)
 Get a guild. More...
 
void guild_get_preview (snowflake g, command_completion_event_t callback)
 Get a guild preview. Returns a guild object but only a subset of the fields will be populated. More...
 
void guild_get_member (snowflake guild_id, snowflake user_id, command_completion_event_t callback)
 Get a guild member. More...
 
void guild_search_members (snowflake guild_id, const std::string &query, uint16_t limit, command_completion_event_t callback)
 Search for guild members based on whether their username or nickname starts with the given string. More...
 
void guild_get_members (snowflake guild_id, uint16_t limit, snowflake after, command_completion_event_t callback)
 Get all guild members. More...
 
void guild_add_member (const guild_member &gm, const std::string &access_token, command_completion_event_t callback={})
 Add guild member. Needs a specific oauth2 scope, from which you get the access_token. More...
 
void guild_edit_member (const guild_member &gm, command_completion_event_t callback={})
 Edit the properties of an existing guild member. More...
 
void guild_member_move (const snowflake channel_id, const snowflake guild_id, const snowflake user_id, command_completion_event_t callback={})
 Moves the guild member to a other voice channel, if member is connected to one. More...
 
void guild_set_nickname (snowflake guild_id, const std::string &nickname, command_completion_event_t callback={})
 Change current user nickname. More...
 
void guild_member_add_role (snowflake guild_id, snowflake user_id, snowflake role_id, command_completion_event_t callback={})
 Add role to guild member. More...
 
void guild_member_delete_role (snowflake guild_id, snowflake user_id, snowflake role_id, command_completion_event_t callback={})
 Remove role from guild member. More...
 
void guild_member_delete (snowflake guild_id, snowflake user_id, command_completion_event_t callback={})
 Remove (kick) a guild member. More...
 
void guild_ban_add (snowflake guild_id, snowflake user_id, uint32_t delete_message_days, const std::string &reason, command_completion_event_t callback={})
 Add guild ban. More...
 
void guild_ban_delete (snowflake guild_id, snowflake user_id, command_completion_event_t callback={})
 Delete guild ban. More...
 
void guild_get_bans (snowflake guild_id, command_completion_event_t callback)
 Get guild ban list. More...
 
void guild_get_ban (snowflake guild_id, snowflake user_id, command_completion_event_t callback)
 Get single guild ban. More...
 
void template_get (const std::string &code, command_completion_event_t callback)
 Get a template. More...
 
void guild_create_from_template (const std::string &code, const std::string &name, command_completion_event_t callback={})
 Create a new guild based on a template. More...
 
void guild_templates_get (snowflake guild_id, command_completion_event_t callback)
 Get guild templates. More...
 
void guild_template_create (snowflake guild_id, const std::string &name, const std::string &description, command_completion_event_t callback)
 Creates a template for the guild. More...
 
void guild_template_sync (snowflake guild_id, const std::string &code, command_completion_event_t callback={})
 Syncs the template to the guild's current state. More...
 
void guild_template_modify (snowflake guild_id, const std::string &code, const std::string &name, const std::string &description, command_completion_event_t callback={})
 Modifies the template's metadata. More...
 
void guild_template_delete (snowflake guild_id, const std::string &code, command_completion_event_t callback={})
 Deletes the template. More...
 
void guild_create (const class guild &g, command_completion_event_t callback={})
 Create a guild. More...
 
void guild_edit (const class guild &g, command_completion_event_t callback={})
 Edit a guild. More...
 
void guild_delete (snowflake guild_id, command_completion_event_t callback={})
 Delete a guild. More...
 
void guild_emojis_get (snowflake guild_id, command_completion_event_t callback)
 Get all emojis for a guild. More...
 
void guild_emoji_get (snowflake guild_id, snowflake emoji_id, command_completion_event_t callback)
 Get a single emoji. More...
 
void guild_emoji_create (snowflake guild_id, const class emoji &newemoji, command_completion_event_t callback={})
 Create single emoji. You must ensure that the emoji passed contained image data using the emoji::load_image() method. More...
 
void guild_emoji_edit (snowflake guild_id, const class emoji &newemoji, command_completion_event_t callback={})
 Edit a single emoji. More...
 
void guild_emoji_delete (snowflake guild_id, snowflake emoji_id, command_completion_event_t callback={})
 Delete a guild emoji. More...
 
void guild_get_prune_counts (snowflake guild_id, const struct prune &pruneinfo, command_completion_event_t callback)
 Get prune counts. More...
 
void guild_begin_prune (snowflake guild_id, const struct prune &pruneinfo, command_completion_event_t callback={})
 Begin guild prune. More...
 
void guild_get_voice_regions (snowflake guild_id, command_completion_event_t callback)
 Get guild voice regions. More...
 
void guild_get_invites (snowflake guild_id, command_completion_event_t callback)
 Get guild invites. More...
 
void guild_get_integrations (snowflake guild_id, command_completion_event_t callback)
 Get guild integrations. More...
 
void guild_modify_integration (snowflake guild_id, const class integration &i, command_completion_event_t callback={})
 Modify guild integration. More...
 
void guild_delete_integration (snowflake guild_id, snowflake integration_id, command_completion_event_t callback={})
 Delete guild integration. More...
 
void guild_sync_integration (snowflake guild_id, snowflake integration_id, command_completion_event_t callback={})
 Sync guild integration. More...
 
void guild_get_widget (snowflake guild_id, command_completion_event_t callback)
 Get guild widget. More...
 
void guild_edit_widget (snowflake guild_id, const class guild_widget &gw, command_completion_event_t callback={})
 Edit guild widget. More...
 
void guild_get_vanity (snowflake guild_id, command_completion_event_t callback)
 Get guild vanity url, if enabled. More...
 
void create_webhook (const class webhook &w, command_completion_event_t callback={})
 Create a webhook. More...
 
void get_guild_webhooks (snowflake guild_id, command_completion_event_t callback)
 Get guild webhooks. More...
 
void get_channel_webhooks (snowflake channel_id, command_completion_event_t callback)
 Get channel webhooks. More...
 
void get_webhook (snowflake webhook_id, command_completion_event_t callback)
 Get webhook. More...
 
void get_webhook_with_token (snowflake webhook_id, const std::string &token, command_completion_event_t callback)
 Get webhook using token. More...
 
void edit_webhook (const class webhook &wh, command_completion_event_t callback={})
 Edit webhook. More...
 
void edit_webhook_with_token (const class webhook &wh, command_completion_event_t callback={})
 Edit webhook with token (token is encapsulated in the webhook object) More...
 
void delete_webhook (snowflake webhook_id, command_completion_event_t callback={})
 Delete a webhook. More...
 
void delete_webhook_with_token (snowflake webhook_id, const std::string &token, command_completion_event_t callback={})
 Delete webhook with token. More...
 
void execute_webhook (const class webhook &wh, const struct message &m, bool wait=false, snowflake thread_id=0, command_completion_event_t callback={})
 Execute webhook. More...
 
void get_webhook_message (const class webhook &wh, command_completion_event_t callback={})
 Get webhook message. More...
 
void edit_webhook_message (const class webhook &wh, const struct message &m, command_completion_event_t callback={})
 Edit webhook message. More...
 
void delete_webhook_message (const class webhook &wh, snowflake message_id, command_completion_event_t callback={})
 Delete webhook message. More...
 
void roles_get (snowflake guild_id, command_completion_event_t callback)
 Get a role for a guild. More...
 
void role_create (const class role &r, command_completion_event_t callback={})
 Create a role on a guild. More...
 
void role_edit (const class role &r, command_completion_event_t callback={})
 Edit a role on a guild. More...
 
void roles_edit_position (snowflake guild_id, const std::vector< role > &roles, command_completion_event_t callback={})
 Edit multiple role's position in a guild. Returns a list of all roles of the guild on success. More...
 
void role_delete (snowflake guild_id, snowflake role_id, command_completion_event_t callback={})
 Delete a role. More...
 
void user_get (snowflake user_id, command_completion_event_t callback)
 Get a user by id. More...
 
void current_user_get (command_completion_event_t callback)
 Get current (bot) user. More...
 
void current_application_get (command_completion_event_t callback)
 Get current (bot) application. More...
 
void guild_current_member_edit (snowflake guild_id, const std::string &nickname, command_completion_event_t callback={})
 Modify current member. More...
 
void current_user_connections_get (command_completion_event_t callback)
 Get current user's connections (linked accounts, e.g. steam, xbox). This call requires the oauth2 connections scope and cannot be executed against a bot token. More...
 
void current_user_get_guilds (command_completion_event_t callback)
 Get current (bot) user guilds. More...
 
void current_user_edit (const std::string &nickname, const std::string &image_blob="", const image_type type=i_png, command_completion_event_t callback={})
 Edit current (bot) user. More...
 
void current_user_get_dms (command_completion_event_t callback)
 Get current user DM channels. More...
 
void create_dm_channel (snowflake user_id, command_completion_event_t callback={})
 Create a dm channel. More...
 
void current_user_leave_guild (snowflake guild_id, command_completion_event_t callback={})
 Leave a guild. More...
 
void thread_create (const std::string &thread_name, snowflake channel_id, uint16_t auto_archive_duration, channel_type thread_type, bool invitable, uint16_t rate_limit_per_user, command_completion_event_t callback={})
 Create a thread. More...
 
void thread_create_with_message (const std::string &thread_name, snowflake channel_id, snowflake message_id, uint16_t auto_archive_duration, uint16_t rate_limit_per_user, command_completion_event_t callback={})
 Create a thread with a message (Discord: ID of a thread is same as message ID) More...
 
void current_user_join_thread (snowflake thread_id, command_completion_event_t callback={})
 Join a thread. More...
 
void current_user_leave_thread (snowflake thread_id, command_completion_event_t callback={})
 Leave a thread. More...
 
void thread_member_add (snowflake thread_id, snowflake user_id, command_completion_event_t callback={})
 Add a member to a thread. More...
 
void thread_member_remove (snowflake thread_id, snowflake user_id, command_completion_event_t callback={})
 Remove a member from a thread. More...
 
void thread_member_get (const snowflake thread_id, const snowflake user_id, command_completion_event_t callback)
 Get a thread member. More...
 
void thread_members_get (snowflake thread_id, command_completion_event_t callback)
 Get members of a thread. More...
 
void threads_get_active (snowflake channel_id, command_completion_event_t callback)
 Get active threads in a channel (Sorted by ID in descending order) More...
 
void threads_get_public_archived (snowflake channel_id, time_t before_timestamp, uint16_t limit, command_completion_event_t callback)
 Get public archived threads in a channel (Sorted by archive_timestamp in descending order) More...
 
void threads_get_private_archived (snowflake channel_id, time_t before_timestamp, uint16_t limit, command_completion_event_t callback)
 Get private archived threads in a channel (Sorted by archive_timestamp in descending order) More...
 
void threads_get_joined_private_archived (snowflake channel_id, snowflake before_id, uint16_t limit, command_completion_event_t callback)
 Get private archived threads in a channel which current user has joined (Sorted by ID in descending order) More...
 
void guild_sticker_create (sticker &s, command_completion_event_t callback={})
 Create a sticker in a guild. More...
 
void guild_sticker_modify (sticker &s, command_completion_event_t callback={})
 Modify a sticker in a guild. More...
 
void guild_sticker_delete (snowflake sticker_id, snowflake guild_id, command_completion_event_t callback={})
 Delete a sticker from a guild. More...
 
void nitro_sticker_get (snowflake id, command_completion_event_t callback)
 Get a nitro sticker. More...
 
void guild_sticker_get (snowflake id, snowflake guild_id, command_completion_event_t callback)
 Get a guild sticker. More...
 
void guild_stickers_get (snowflake guild_id, command_completion_event_t callback)
 Get all guild stickers. More...
 
void sticker_packs_get (command_completion_event_t callback)
 Get sticker packs. More...
 
void stage_instance_create (const stage_instance &instance, command_completion_event_t callback={})
 Create a stage instance on a stage channel. More...
 
void stage_instance_get (const snowflake channel_id, command_completion_event_t callback)
 Get the stage instance associated with the channel id, if it exists. More...
 
void stage_instance_edit (const stage_instance &instance, command_completion_event_t callback={})
 Edit a stage instance. More...
 
void stage_instance_delete (const snowflake channel_id, command_completion_event_t callback={})
 Delete a stage instance. More...
 
void get_voice_regions (command_completion_event_t callback)
 Get all voice regions. More...
 
void get_gateway_bot (command_completion_event_t callback)
 Get the gateway information for the bot using the token. More...
 
void guild_events_get (snowflake guild_id, command_completion_event_t callback)
 Get all scheduled events for a guild. More...
 
void guild_event_users_get (snowflake guild_id, snowflake event_id, command_completion_event_t callback, uint8_t limit=100, snowflake before=0, snowflake after=0)
 Get users RSVP'd to an event. More...
 
void guild_event_create (const scheduled_event &event, command_completion_event_t callback={})
 Create a scheduled event on a guild. More...
 
void guild_event_delete (snowflake event_id, snowflake guild_id, command_completion_event_t callback={})
 Delete a scheduled event from a guild. More...
 
void guild_event_edit (const scheduled_event &event, command_completion_event_t callback={})
 Edit/modify a scheduled event on a guild. More...
 
void guild_event_get (snowflake guild_id, snowflake event_id, command_completion_event_t callback)
 Get a scheduled event for a guild. More...
 
void current_user_set_voice_state (snowflake guild_id, snowflake channel_id, bool suppress=false, time_t request_to_speak_timestamp=0, command_completion_event_t callback={})
 Set the bot's voice state on a stage channel. More...
 
void user_set_voice_state (snowflake user_id, snowflake guild_id, snowflake channel_id, bool suppress=false, command_completion_event_t callback={})
 Set a user's voice state on a stage channel. More...
 

Public Attributes

std::string token
 Current bot token for all shards on this cluster and all commands sent via HTTP. More...
 
time_t last_identify
 Last time the bot sent an IDENTIFY. More...
 
uint32_t intents
 Current bitmask of gateway intents. More...
 
uint32_t numshards
 Total number of shards across all clusters. More...
 
uint32_t cluster_id
 ID of this cluster, between 0 and MAXCLUSTERS-1 inclusive. More...
 
uint32_t maxclusters
 Total number of clusters that are active. More...
 
double rest_ping
 REST latency (HTTPS ping) in seconds. More...
 
dpp::user me
 The details of the bot user. This is assumed to be identical across all shards in the cluster. Each connecting shard updates this information. More...
 
cache_policy_t cache_policy
 Current cache policy for the cluster. More...
 
websocket_protocol_t ws_mode
 Websocket mode for all shards in the cluster, either ws_json or ws_etf. Production bots should use ETF, while development bots should use JSON. More...
 
event_router_t< voice_state_update_ton_voice_state_update
 on voice state update event More...
 
event_router_t< voice_client_disconnect_ton_voice_client_disconnect
 on voice client disconnect event More...
 
event_router_t< voice_client_speaking_ton_voice_client_speaking
 on voice client speaking event More...
 
event_router_t< log_ton_log
 Called when a log message is to be written to the log. You can attach any logging system here you wish, e.g. spdlog, or even just a simple use of std::cout or printf. If nothing attaches this log event, then the library will be silent. More...
 
event_router_t< guild_join_request_delete_ton_guild_join_request_delete
 on guild join request delete. Triggered when a user declines the membership screening questionnaire for a guild. More...
 
event_router_t< interaction_create_ton_interaction_create
 Called when a new interaction is created. Interactions are created by discord when commands you have registered are issued by a user. For an example of this in action please see Using Slash Commands and Interactions. More...
 
event_router_t< button_click_ton_button_click
 Called when a button is clicked attached to a message. Button clicks are triggered by discord when buttons are clicked which you have associated with a message using dpp::component. More...
 
event_router_t< autocomplete_ton_autocomplete
 Called when an auto completed field needs suggestions to present to the user This is triggered by discord when option choices have auto completion enabled which you have associated with a dpp::slashcommand. More...
 
event_router_t< select_click_ton_select_click
 Called when a select menu is clicked attached to a message. Select menu clicks are triggered by discord when select menus are clicked which you have associated with a message using dpp::component. More...
 
event_router_t< form_submit_ton_form_submit
 Called when a modal dialog is submitted. Form submits are triggered by discord when modal dialogs are submitted which you have associated with a slash command using dpp::interaction_modal_response. More...
 
event_router_t< guild_delete_ton_guild_delete
 Called when a guild is deleted. A guild can be deleted via the bot being kicked, the bot leaving the guild explicitly with dpp::guild_delete, or via the guild being unavailable due to an outage. More...
 
event_router_t< channel_delete_ton_channel_delete
 Called when a channel is deleted from a guild. The channel will still be temporarily available in the cache. Pointers to the channel should not be retained long-term as they will be deleted by the garbage collector. More...
 
event_router_t< channel_update_ton_channel_update
 Called when a channel is edited on a guild. The new channel details have already been applied to the guild when you receive this event. More...
 
event_router_t< ready_ton_ready
 Called when a shard is connected and ready. A set of on_guild_create events will follow this event. More...
 
event_router_t< message_delete_ton_message_delete
 Called when a message is deleted. The message has already been deleted from Discord when you receive this event. More...
 
event_router_t< guild_member_remove_ton_guild_member_remove
 Called when a user leaves a guild (either through being kicked, or choosing to leave) More...
 
event_router_t< resumed_ton_resumed
 Called when a connection to a shard successfully resumes. A resumed session does not need to re-synchronise guilds, members, etc. This is generally non-fatal and informational only. More...
 
event_router_t< guild_role_create_ton_guild_role_create
 Called when a new role is created on a guild. More...
 
event_router_t< typing_start_ton_typing_start
 Called when a user is typing on a channel. More...
 
event_router_t< message_reaction_add_ton_message_reaction_add
 Called when a new reaction is added to a message. More...
 
event_router_t< guild_members_chunk_ton_guild_members_chunk
 Called when a set of members is received for a guild. D++ will request these for all new guilds if needed, after the on_guild_create events. More...
 
event_router_t< message_reaction_remove_ton_message_reaction_remove
 Called when a single reaction is removed from a message. More...
 
event_router_t< guild_create_ton_guild_create
 Called when a new guild is created. D++ will request members for the guild for its cache using guild_members_chunk. More...
 
event_router_t< channel_create_ton_channel_create
 Called when a new channel is created on a guild. More...
 
event_router_t< message_reaction_remove_emoji_ton_message_reaction_remove_emoji
 Called when all reactions for a particular emoji are removed from a message. More...
 
event_router_t< message_delete_bulk_ton_message_delete_bulk
 Called when multiple messages are deleted from a channel or DM. More...
 
event_router_t< guild_role_update_ton_guild_role_update
 Called when an existing role is updated on a guild. More...
 
event_router_t< guild_role_delete_ton_guild_role_delete
 Called when a role is deleted in a guild. More...
 
event_router_t< channel_pins_update_ton_channel_pins_update
 Called when a message is pinned. Note that the pinned message is not returned to this event, just the timestamp of the last pinned message. More...
 
event_router_t< message_reaction_remove_all_ton_message_reaction_remove_all
 Called when all reactions are removed from a message. More...
 
event_router_t< voice_server_update_ton_voice_server_update
 Called when we are told which voice server we can use. This will be sent either when we establish a new voice channel connection, or as discord rearrange their infrastructure. More...
 
event_router_t< guild_emojis_update_ton_guild_emojis_update
 Called when new emojis are added to a guild. The complete set of emojis is sent every time. More...
 
event_router_t< guild_stickers_update_ton_guild_stickers_update
 Called when new stickers are added to a guild. The complete set of stickers is sent every time. More...
 
event_router_t< presence_update_ton_presence_update
 Called when a user's presence is updated. To receive these you will need the GUILD_PRESENCES privileged intent. You will receive many of these, very often, and receiving them will significantly increase your bot's CPU usage. If you don't need them it is recommended to not ask for them. More...
 
event_router_t< webhooks_update_ton_webhooks_update
 Called when the webhooks for a guild are updated. More...
 
event_router_t< guild_member_add_ton_guild_member_add
 Called when a new member joins a guild. More...
 
event_router_t< invite_delete_ton_invite_delete
 Called when an invite is deleted from a guild. More...
 
event_router_t< guild_update_ton_guild_update
 Called when details of a guild are updated. More...
 
event_router_t< guild_integrations_update_ton_guild_integrations_update
 Called when an integration is updated for a guild. This returns the complete list. An integration is a connection to a guild of a user's associated accounts, e.g. youtube or twitch, for automatic assignment of roles etc. More...
 
event_router_t< guild_member_update_ton_guild_member_update
 Called when details of a guild member (e.g. their roles or nickname) are updated. More...
 
event_router_t< invite_create_ton_invite_create
 Called when a new invite is created for a guild. More...
 
event_router_t< message_update_ton_message_update
 Called when a message is updated (edited). More...
 
event_router_t< user_update_ton_user_update
 Called when a user is updated. This is separate to guild_member_update and includes things such as an avatar change, username change, discriminator change or change in subscription status for nitro. More...
 
event_router_t< message_create_ton_message_create
 Called when a new message arrives from discord. Note that D++ does not cache messages. If you want to cache these objects you should create something yourself within your bot. Caching of messages is not on the roadmap to be supported as it consumes excessive amounts of RAM. More...
 
event_router_t< guild_ban_add_ton_guild_ban_add
 Called when a ban is added to a guild. More...
 
event_router_t< guild_ban_remove_ton_guild_ban_remove
 Called when a ban is removed from a guild. More...
 
event_router_t< integration_create_ton_integration_create
 Called when a new integration is attached to a guild by a user. An integration is a connection to a guild of a user's associated accounts, e.g. youtube or twitch, for automatic assignment of roles etc. More...
 
event_router_t< integration_update_ton_integration_update
 Called when an integration is updated by a user. This returns details of just the single integration that has changed. An integration is a connection to a guild of a user's associated accounts, e.g. youtube or twitch, for automatic assignment of roles etc. More...
 
event_router_t< integration_delete_ton_integration_delete
 Called when an integration is removed by a user. An integration is a connection to a guild of a user's associated accounts, e.g. youtube or twitch, for automatic assignment of roles etc. More...
 
event_router_t< thread_create_ton_thread_create
 Called when a thread is created Note: Threads are not cached by D++, but a list of thread IDs is accessible in a guild object. More...
 
event_router_t< thread_update_ton_thread_update
 Called when a thread is updated. More...
 
event_router_t< thread_delete_ton_thread_delete
 Called when a thread is deleted. More...
 
event_router_t< thread_list_sync_ton_thread_list_sync
 Called when thread list is synced (upon gaining access to a channel) Note: Threads are not cached by D++, but a list of thread IDs is accessible in a guild object. More...
 
event_router_t< thread_member_update_ton_thread_member_update
 Called when current user's thread member object is updated. More...
 
event_router_t< thread_members_update_ton_thread_members_update
 Called when a thread's member list is updated (without GUILD_MEMBERS intent, is only called for current user) More...
 
event_router_t< guild_scheduled_event_create_ton_guild_scheduled_event_create
 Called when a new scheduled event is created. More...
 
event_router_t< guild_scheduled_event_update_ton_guild_scheduled_event_update
 Called when a new scheduled event is updated. More...
 
event_router_t< guild_scheduled_event_delete_ton_guild_scheduled_event_delete
 Called when a new scheduled event is deleted. More...
 
event_router_t< guild_scheduled_event_user_add_ton_guild_scheduled_event_user_add
 Called when a user is added to a scheduled event. More...
 
event_router_t< guild_scheduled_event_user_remove_ton_guild_scheduled_event_user_remove
 Called when a user is removed to a scheduled event. More...
 
event_router_t< voice_buffer_send_ton_voice_buffer_send
 Called when packets are sent from the voice buffer. The voice buffer contains packets that are already encoded with Opus and encrypted with Sodium, and merged into packets by the repacketizer, which is done in the dpp::discord_voice_client::send_audio method. You should use the buffer size properties of dpp::voice_buffer_send_t to determine if you should fill the buffer with more content. More...
 
event_router_t< voice_user_talking_ton_voice_user_talking
 Called when a user is talking on a voice channel. More...
 
event_router_t< voice_ready_ton_voice_ready
 Called when a voice channel is connected and ready to send audio. Note that this is not directly attached to the READY event of the websocket, as there is further connection that needs to be done before audio is ready to send. More...
 
event_router_t< voice_receive_ton_voice_receive
 Called when new audio data is received. Each separate user's audio from the voice channel will arrive tagged with their user id in the event, if a user can be attributed to the received audio. More...
 
event_router_t< voice_track_marker_ton_voice_track_marker
 Called when sending of audio passes over a track marker. Track markers are arbitrarily placed "bookmarks" in the audio buffer, placed by the bot developer. Each track marker can have a string value associated with it which is specified in dpp::discord_voice_client::insert_marker and returned to this event. More...
 
event_router_t< stage_instance_create_ton_stage_instance_create
 Called when a new stage instance is created on a stage channel. More...
 
event_router_t< stage_instance_update_ton_stage_instance_update
 Called when a stage instance is updated. More...
 
event_router_t< stage_instance_delete_ton_stage_instance_delete
 Called when an existing stage instance is deleted from a stage channel. More...
 

Friends

class discord_client
 
class discord_voice_client
 

Detailed Description

The cluster class represents a group of shards and a command queue for sending and receiving commands from discord via HTTP. You should usually instantiate a cluster object at the very least to make use of the library.

Constructor & Destructor Documentation

◆ cluster() [1/3]

dpp::cluster::cluster ( const std::string &  token,
uint32_t  intents = i_default_intents,
uint32_t  shards = 0,
uint32_t  cluster_id = 0,
uint32_t  maxclusters = 1,
bool  compressed = true,
cache_policy_t  policy = {cp_aggressivecp_aggressivecp_aggressive} 
)

Constructor for creating a cluster. All but the token are optional.

Parameters
tokenThe bot token to use for all HTTP commands and websocket connections
intentsA bitmask of dpd::intents values for all shards on this cluster. This is required to be sent for all bots with over 100 servers.
shardsThe total number of shards on this bot. If there are multiple clusters, then (shards / clusters) actual shards will run on this cluster. If you omit this value, the library will attempt to query the Discord API for the correct number of shards to start.
cluster_idThe ID of this cluster, should be between 0 and MAXCLUSTERS-1
maxclustersThe total number of clusters that are active, which may be on separate processes or even separate machines.
compressedWhether or not to use compression for shards on this cluster. Saves a ton of bandwidth at the cost of some CPU
policySet the user caching policy for the cluster, either lazy (only cache users/members when they message the bot) or aggressive (request whole member lists on seeing new guilds too)
Exceptions
dpp::exceptionThrown on windows, if WinSock fails to initialise, or on any other system if a dpp::request_queue fails to construct

◆ cluster() [2/3]

dpp::cluster::cluster ( const cluster )
delete

dpp::cluster is non-copyable

◆ cluster() [3/3]

dpp::cluster::cluster ( const cluster &&  )
delete

dpp::cluster is non-moveable

◆ ~cluster()

virtual dpp::cluster::~cluster ( )
virtual

Destroy the cluster object.

Member Function Documentation

◆ channel_create()

void dpp::cluster::channel_create ( const class channel c,
command_completion_event_t  callback = {} 
)

Create a channel.

Create a new channel object for the guild. Requires the MANAGE_CHANNELS permission. If setting permission overwrites, only permissions your bot has in the guild can be allowed/denied. Setting MANAGE_ROLES permission in channels is only possible for guild administrators. Returns the new channel object on success. Fires a Channel Create Gateway event.

All parameters to this endpoint are optional excluding name

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
cChannel to create
callbackFunction to call when the API call completes. On success the callback will contain a dpp::channel object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_delete()

void dpp::cluster::channel_delete ( snowflake  channel_id,
command_completion_event_t  callback = {} 
)

Delete a channel.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
channel_idChannel id to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_delete_permission()

void dpp::cluster::channel_delete_permission ( const class channel c,
snowflake  overwrite_id,
command_completion_event_t  callback = {} 
)

Remove a permission from a channel.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
cChannel to remove permission from
overwrite_idOverwrite to remove, user or channel ID
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_edit()

void dpp::cluster::channel_edit ( const class channel c,
command_completion_event_t  callback = {} 
)

Edit a channel.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
cChannel to edit/update
callbackFunction to call when the API call completes. On success the callback will contain a dpp::channel object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_edit_permissions() [1/2]

void dpp::cluster::channel_edit_permissions ( const class channel c,
const snowflake  overwrite_id,
const uint32_t  allow,
const uint32_t  deny,
const bool  member,
command_completion_event_t  callback = {} 
)

Edit a channel's permissions.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
cChannel to set permissions for
overwrite_idOverwrite to change (a user or role ID)
allowallow permissions
denydeny permissions
membertrue if the overwrite_id is a user id, false if it is a channel id
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_edit_permissions() [2/2]

void dpp::cluster::channel_edit_permissions ( const snowflake  channel_id,
const snowflake  overwrite_id,
const uint32_t  allow,
const uint32_t  deny,
const bool  member,
command_completion_event_t  callback = {} 
)

Edit a channel's permissions.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
channel_idID of the channel to set permissions for
overwrite_idOverwrite to change (a user or role ID)
allowallow permissions
denydeny permissions
membertrue if the overwrite_id is a user id, false if it is a channel id
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_edit_positions()

void dpp::cluster::channel_edit_positions ( const std::vector< channel > &  c,
command_completion_event_t  callback = {} 
)

Edit multiple channels positions.

Modify the positions of a set of channel objects for the guild. Requires MANAGE_CHANNELS permission. Fires multiple Channel Update Gateway events. Only channels to be modified are required.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
cChannel to change the position for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_follow_news()

void dpp::cluster::channel_follow_news ( const class channel c,
snowflake  target_channel_id,
command_completion_event_t  callback = {} 
)

Follow a news channel.

Parameters
cChannel id to follow
target_channel_idChannel to subscribe the channel to
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_get()

void dpp::cluster::channel_get ( snowflake  c,
command_completion_event_t  callback 
)

Get a channel.

Parameters
cChannel ID to retrieve
callbackFunction to call when the API call completes. On success the callback will contain a dpp::channel object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_invite_create()

void dpp::cluster::channel_invite_create ( const class channel c,
const class invite i,
command_completion_event_t  callback = {} 
)

Create invite for a channel.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
cChannel to create an invite on
iInvite to create
callbackFunction to call when the API call completes. On success the callback will contain a dpp::invite object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_invites_get()

void dpp::cluster::channel_invites_get ( const class channel c,
command_completion_event_t  callback 
)

Get invites for a channel.

Parameters
cChannel to get invites for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::invite_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_pins_get()

void dpp::cluster::channel_pins_get ( snowflake  channel_id,
command_completion_event_t  callback 
)

Get a channel's pins.

Parameters
channel_idChannel ID to get pins for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_typing() [1/2]

void dpp::cluster::channel_typing ( const class channel c,
command_completion_event_t  callback = {} 
)

Trigger channel typing indicator.

Parameters
cChannel to set as typing on
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channel_typing() [2/2]

void dpp::cluster::channel_typing ( snowflake  cid,
command_completion_event_t  callback = {} 
)

Trigger channel typing indicator.

Parameters
cidChannel ID to set as typing on
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ channels_get()

void dpp::cluster::channels_get ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get all channels for a guild.

Parameters
guild_idGuild ID to retrieve channels for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::channel_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ clear_audit_reason()

cluster & dpp::cluster::clear_audit_reason ( )

Clear the audit log reason for the next REST call to be made. This is set per-thread, so you must ensure that if you call this method, your request that is associated with the reason happens on the same thread where you set the reason. Once the next call is made, the audit log reason is cleared for this thread automatically.

Example:

bot.set_audit_reason("Won't be sent")
.clear_audit_reason()
.channel_delete(my_channel_id);
Returns
cluster& Reference to self for chaining.

◆ create_dm_channel()

void dpp::cluster::create_dm_channel ( snowflake  user_id,
command_completion_event_t  callback = {} 
)

Create a dm channel.

Parameters
user_idUser ID to create DM channel with
callbackFunction to call when the API call completes. On success the callback will contain a dpp::channel object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ create_webhook()

void dpp::cluster::create_webhook ( const class webhook w,
command_completion_event_t  callback = {} 
)

Create a webhook.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
wWebhook to create
callbackFunction to call when the API call completes. On success the callback will contain a dpp::webhook object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ current_application_get()

void dpp::cluster::current_application_get ( command_completion_event_t  callback)

Get current (bot) application.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::application object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ current_user_connections_get()

void dpp::cluster::current_user_connections_get ( command_completion_event_t  callback)

Get current user's connections (linked accounts, e.g. steam, xbox). This call requires the oauth2 connections scope and cannot be executed against a bot token.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::connection_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ current_user_edit()

void dpp::cluster::current_user_edit ( const std::string &  nickname,
const std::string &  image_blob = "",
const image_type  type = i_png,
command_completion_event_t  callback = {} 
)

Edit current (bot) user.

Modifies the current member in a guild. Returns the updated guild_member object on success. Fires a Guild Member Update Gateway event.

Parameters
nicknameNickname to set
image_blobAvatar data to upload (NOTE: Very heavily rate limited!)
typeType of image for avatar
callbackFunction to call when the API call completes. On success the callback will contain a dpp::user object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().
Exceptions
dpp::exceptionImage data is larger than the maximum size of 256 kilobytes

◆ current_user_get()

void dpp::cluster::current_user_get ( command_completion_event_t  callback)

Get current (bot) user.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::user_identified object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().
Note
The user_identified object is a subclass of dpp::user which contains further details if you have the oauth2 identify or email scopes. If you do not have these scopes, these fields are empty. You can safely convert a user_identified to user with dynamic_cast.

◆ current_user_get_dms()

void dpp::cluster::current_user_get_dms ( command_completion_event_t  callback)

Get current user DM channels.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::channel_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ current_user_get_guilds()

void dpp::cluster::current_user_get_guilds ( command_completion_event_t  callback)

Get current (bot) user guilds.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ current_user_join_thread()

void dpp::cluster::current_user_join_thread ( snowflake  thread_id,
command_completion_event_t  callback = {} 
)

Join a thread.

Parameters
thread_idThread ID to join
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ current_user_leave_guild()

void dpp::cluster::current_user_leave_guild ( snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Leave a guild.

Parameters
guild_idGuild ID to leave
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ current_user_leave_thread()

void dpp::cluster::current_user_leave_thread ( snowflake  thread_id,
command_completion_event_t  callback = {} 
)

Leave a thread.

Parameters
thread_idThread ID to leave
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ current_user_set_voice_state()

void dpp::cluster::current_user_set_voice_state ( snowflake  guild_id,
snowflake  channel_id,
bool  suppress = false,
time_t  request_to_speak_timestamp = 0,
command_completion_event_t  callback = {} 
)

Set the bot's voice state on a stage channel.

Caveats

There are currently several caveats for this endpoint:

  • channel_id must currently point to a stage channel.
    • current user must already have joined channel_id.
    • You must have the MUTE_MEMBERS permission to unsuppress yourself. You can always suppress yourself.
    • You must have the REQUEST_TO_SPEAK permission to request to speak. You can always clear your own request to speak.
    • You are able to set request_to_speak_timestamp to any present or future time.
Parameters
guild_idGuild to set voice state on
channel_idStage channel to set voice state on
callbackFunction to call when the API call completes.
suppressTrue if the user's audio should be suppressed, false if it should not
request_to_speak_timestampThe time at which we requested to speak, or 0 to clear the request. The time set here must be the current time or in the future. On success the callback will contain a dpp::scheduled_event object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().
Exceptions
std::logic_exceptionYou attempted to set a request_to_speak_timestamp in the past which is not the value of 0.

◆ delete_webhook()

void dpp::cluster::delete_webhook ( snowflake  webhook_id,
command_completion_event_t  callback = {} 
)

Delete a webhook.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
webhook_idWebhook ID to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ delete_webhook_message()

void dpp::cluster::delete_webhook_message ( const class webhook wh,
snowflake  message_id,
command_completion_event_t  callback = {} 
)

Delete webhook message.

Parameters
whWebhook to delete message for
message_idMessage ID to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ delete_webhook_with_token()

void dpp::cluster::delete_webhook_with_token ( snowflake  webhook_id,
const std::string &  token,
command_completion_event_t  callback = {} 
)

Delete webhook with token.

Parameters
webhook_idWebhook ID to delete
tokenToken of webhook to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ direct_message_create()

void dpp::cluster::direct_message_create ( snowflake  user_id,
const message m,
command_completion_event_t  callback = {} 
)

Create a direct message, also create the channel for the direct message if needed.

Parameters
user_idUser ID of user to send message to
mMessage object
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ edit_webhook()

void dpp::cluster::edit_webhook ( const class webhook wh,
command_completion_event_t  callback = {} 
)

Edit webhook.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
whWebhook to edit
callbackFunction to call when the API call completes. On success the callback will contain a dpp::webhook object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ edit_webhook_message()

void dpp::cluster::edit_webhook_message ( const class webhook wh,
const struct message m,
command_completion_event_t  callback = {} 
)

Edit webhook message.

Parameters
whWebhook to edit message for
mNew message
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ edit_webhook_with_token()

void dpp::cluster::edit_webhook_with_token ( const class webhook wh,
command_completion_event_t  callback = {} 
)

Edit webhook with token (token is encapsulated in the webhook object)

Parameters
whWebhook to edit (should include token)
callbackFunction to call when the API call completes. On success the callback will contain a dpp::webhook object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ execute_webhook()

void dpp::cluster::execute_webhook ( const class webhook wh,
const struct message m,
bool  wait = false,
snowflake  thread_id = 0,
command_completion_event_t  callback = {} 
)

Execute webhook.

Parameters
whWebhook to execute
mMessage to send
waitwaits for server confirmation of message send before response, and returns the created message body
thread_idSend a message to the specified thread within a webhook's channel. The thread will automatically be unarchived
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ gdm_add()

void dpp::cluster::gdm_add ( snowflake  channel_id,
snowflake  user_id,
const std::string &  access_token,
const std::string &  nick,
command_completion_event_t  callback = {} 
)

Adds a recipient to a Group DM using their access token.

Parameters
channel_idChannel id to add group DM recipients to
user_idUser ID to add
access_tokenAccess token from OAuth2
nickNickname of user to apply to the chat
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ gdm_remove()

void dpp::cluster::gdm_remove ( snowflake  channel_id,
snowflake  user_id,
command_completion_event_t  callback = {} 
)

Removes a recipient from a Group DM.

Parameters
channel_idChannel ID of group DM
user_idUser ID to remove from group DM
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ get_audit_reason()

std::string dpp::cluster::get_audit_reason ( )

Get the audit reason set for the next REST call to be made on this thread. This is set per-thread, so you must ensure that if you call this method, your request that is associated with the reason happens on the same thread where you set the reason. Once the next call is made, the audit log reason is cleared for this thread automatically.

Note
This method call clears the audit reason when it returns it.
Returns
std::string The audit reason to be used.

◆ get_channel_webhooks()

void dpp::cluster::get_channel_webhooks ( snowflake  channel_id,
command_completion_event_t  callback 
)

Get channel webhooks.

Parameters
channel_idChannel ID to get webhooks for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::webhook_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ get_dm_channel()

snowflake dpp::cluster::get_dm_channel ( snowflake  user_id)

Get the dm channel for a user id.

Parameters
user_idthe user id to get the dm channel for
Returns
Returns 0 on failure

◆ get_gateway_bot()

void dpp::cluster::get_gateway_bot ( command_completion_event_t  callback)

Get the gateway information for the bot using the token.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::gateway object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ get_guild_webhooks()

void dpp::cluster::get_guild_webhooks ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get guild webhooks.

Parameters
guild_idGuild ID to get webhooks for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::webhook_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ get_shard()

discord_client * dpp::cluster::get_shard ( uint32_t  id)

Get a shard by id, returning the discord_client.

Parameters
idShard ID
Returns
discord_client* shard, or null

◆ get_shards()

const shard_list & dpp::cluster::get_shards ( )

Get the list of shards.

Returns
shard_list& Reference to map of shards for this cluster

◆ get_voice_regions()

void dpp::cluster::get_voice_regions ( command_completion_event_t  callback)

Get all voice regions.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::voiceregion_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ get_webhook()

void dpp::cluster::get_webhook ( snowflake  webhook_id,
command_completion_event_t  callback 
)

Get webhook.

Parameters
webhook_idWebhook ID to get
callbackFunction to call when the API call completes. On success the callback will contain a dpp::webhook object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ get_webhook_message()

void dpp::cluster::get_webhook_message ( const class webhook wh,
command_completion_event_t  callback = {} 
)

Get webhook message.

Parameters
whWebhook to get the original message for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ get_webhook_with_token()

void dpp::cluster::get_webhook_with_token ( snowflake  webhook_id,
const std::string &  token,
command_completion_event_t  callback 
)

Get webhook using token.

Parameters
webhook_idWebhook ID to retrieve
tokenToken of webhook
callbackFunction to call when the API call completes. On success the callback will contain a dpp::webhook object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ global_bulk_command_create()

void dpp::cluster::global_bulk_command_create ( const std::vector< slashcommand > &  commands,
command_completion_event_t  callback = {} 
)

Create/overwrite global slash commands. Any existing global slash commands will be deleted and replaced with these.

Note
Global commands are cached by discord server-side and can take up to an hour to be visible. For testing, you should use cluster::guild_bulk_command_create instead.
Parameters
commandsVector of slash commands to create/update. overwriting existing commands that are registered globally for this application. Updates will be available in all guilds after 1 hour. Commands that do not already exist will count toward daily application command create limits.
callbackFunction to call when the API call completes. On success the callback will contain a list of dpp::slashcommmand object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ global_command_create()

void dpp::cluster::global_command_create ( const slashcommand s,
command_completion_event_t  callback = {} 
)

Create a global slash command (a bot can have a maximum of 100 of these).

Note
Global commands are cached by discord server-side and can take up to an hour to be visible. For testing, you should use cluster::guild_command_create instead.
Parameters
sSlash command to create
callbackFunction to call when the API call completes. On success the callback will contain a dpp::slashcommmand object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ global_command_delete()

void dpp::cluster::global_command_delete ( snowflake  id,
command_completion_event_t  callback = {} 
)

Delete a global slash command (a bot can have a maximum of 100 of these)

Parameters
idSlash command to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ global_command_edit()

void dpp::cluster::global_command_edit ( const slashcommand s,
command_completion_event_t  callback = {} 
)

Edit a global slash command (a bot can have a maximum of 100 of these)

Note
Global commands are cached by discord server-side and can take up to an hour to be visible. For testing, you should use cluster::guild_bulk_command_create instead.
Parameters
sSlash command to change
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ global_command_get()

void dpp::cluster::global_command_get ( snowflake  id,
command_completion_event_t  callback = {} 
)

Get a global slash command.

Parameters
idThe ID of the slash command
callbackFunction to call when the API call completes. On success the callback will contain a dpp::slashcommmand object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ global_commands_get()

void dpp::cluster::global_commands_get ( command_completion_event_t  callback)

Get the application's global slash commands.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::slashcommand_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_add_member()

void dpp::cluster::guild_add_member ( const guild_member gm,
const std::string &  access_token,
command_completion_event_t  callback = {} 
)

Add guild member. Needs a specific oauth2 scope, from which you get the access_token.

Adds a user to the guild, provided you have a valid oauth2 access token for the user with the guilds.join scope. Returns the guild_member, which is defaulted if the user is already a member of the guild. Fires a Guild Member Add Gateway event.

For guilds with Membership Screening enabled, this endpoint will default to adding new members as pending in the guild member object. Members that are pending will have to complete membership screening before they become full members that can talk.

Note
All parameters to this endpoint except for access_token are optional. The bot must be a member of the guild with CREATE_INSTANT_INVITE permission.
Parameters
gmGuild member to add
access_tokenAccess token from Oauth2 scope
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_member object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_auditlog_get()

void dpp::cluster::guild_auditlog_get ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get the audit log for a guild.

Parameters
guild_idGuild to get the audit log of
callbackFunction to call when the API call completes. On success the callback will contain a dpp::auditlog object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_ban_add()

void dpp::cluster::guild_ban_add ( snowflake  guild_id,
snowflake  user_id,
uint32_t  delete_message_days,
const std::string &  reason,
command_completion_event_t  callback = {} 
)

Add guild ban.

Create a guild ban, and optionally delete previous messages sent by the banned user. Requires the BAN_MEMBERS permission. Fires a Guild Ban Add Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to add ban to
user_idUser ID to ban
delete_message_daysHow many days of their user's messages to also delete
reasonReason for ban
callbackFunction to call when the API call completes. On success the callback will contain a dpp::ban object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_ban_delete()

void dpp::cluster::guild_ban_delete ( snowflake  guild_id,
snowflake  user_id,
command_completion_event_t  callback = {} 
)

Delete guild ban.

Remove the ban for a user. Requires the BAN_MEMBERS permissions. Fires a Guild Ban Remove Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild to delete ban from
user_idUser ID to delete ban for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_begin_prune()

void dpp::cluster::guild_begin_prune ( snowflake  guild_id,
const struct prune pruneinfo,
command_completion_event_t  callback = {} 
)

Begin guild prune.

Begin a prune operation. Requires the KICK_MEMBERS permission. Returns a prune object indicating the number of members that were removed in the prune operation. For large guilds it's recommended to set the compute_prune_count option to false, forcing 'pruned' to 0. Fires multiple Guild Member Remove Gateway events. By default, prune will not remove users with roles. You can optionally include specific roles in your prune by providing the include_roles parameter. Any inactive user that has a subset of the provided role(s) will be included in the prune and users with additional roles will not.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to prune
pruneinfoPruning info
callbackFunction to call when the API call completes. On success the callback will contain a dpp::prune object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_bulk_command_create()

void dpp::cluster::guild_bulk_command_create ( const std::vector< slashcommand > &  commands,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Create/overwrite guild slash commands. Any existing guild slash commands on this guild will be deleted and replaced with these.

Parameters
commandsVector of slash commands to create/update. New guild commands will be available in the guild immediately. If the command did not already exist, it will count toward daily application command create limits.
guild_idGuild ID to create/update the slash commands in
callbackFunction to call when the API call completes. On success the callback will contain a list of dpp::slashcommmand object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_bulk_command_edit_permissions()

void dpp::cluster::guild_bulk_command_edit_permissions ( const std::vector< slashcommand > &  commands,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Edit/Overwrite the permissions of all existing slash commands in a guild.

Note
You can only add up to 10 permission overwrites for a command
Warning
The endpoint will overwrite all existing permissions for all commands of the application in a guild, including slash commands, user commands, and message commands. Meaning that if you forgot to pass a slash command, the permissions of it might be removed.
Parameters
commandsA vector of slash commands to edit/overwrite the permissions for
guild_idGuild ID to edit permissions of the slash commands in
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_command_permissions_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_command_create()

void dpp::cluster::guild_command_create ( const slashcommand s,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Create a slash command local to a guild.

Note
Creating a command with the same name as an existing command for your application will overwrite the old command.
Parameters
sSlash command to create
guild_idGuild ID to create the slash command in
callbackFunction to call when the API call completes. On success the callback will contain a dpp::slashcommmand object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_command_delete()

void dpp::cluster::guild_command_delete ( snowflake  id,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Delete a slash command local to a guild.

Parameters
idSlash command to delete
guild_idGuild ID to delete the slash command in
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_command_edit()

void dpp::cluster::guild_command_edit ( const slashcommand s,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Edit a slash command local to a guild.

Parameters
sSlash command to edit
guild_idGuild ID to edit the slash command in
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_command_edit_permissions()

void dpp::cluster::guild_command_edit_permissions ( const slashcommand s,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Edit slash command permissions of a guild.

Note
You can only add up to 10 permission overwrites for a command
Parameters
sSlash command to edit the permissions for
guild_idGuild ID to edit the slash command in
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_command_get()

void dpp::cluster::guild_command_get ( snowflake  id,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Get a slash command of a guild.

Note
The returned slash commands will not have permissions set, you need to use a permissions getter e.g. dpp::guild_commands_get_permissions to get the guild command permissions
Parameters
idThe ID of the slash command
guild_idGuild ID to get the slash command from
callbackFunction to call when the API call completes. On success the callback will contain a dpp::slashcommand object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_command_get_permissions()

void dpp::cluster::guild_command_get_permissions ( snowflake  id,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Get the permissions for a slash command of a guild.

Parameters
idThe ID of the slash command to get the permissions for
guild_idGuild ID to get the permissions of
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_command_permissions object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_commands_get()

void dpp::cluster::guild_commands_get ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get the application's slash commands for a guild.

Note
The returned slash commands will not have permissions set, you need to use a permissions getter e.g. dpp::guild_commands_get_permissions to get the guild command permissions
Parameters
guild_idGuild ID to get the slash commands for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::slashcommand_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_commands_get_permissions()

void dpp::cluster::guild_commands_get_permissions ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get all slash command permissions of a guild.

Parameters
guild_idGuild ID to get the slash commands permissions for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_command_permissions_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_create()

void dpp::cluster::guild_create ( const class guild g,
command_completion_event_t  callback = {} 
)

Create a guild.

Create a new guild. Returns a guild object on success. Fires a Guild Create Gateway event.

When using the roles parameter, the first member of the array is used to change properties of the guild's everyone role. If you are trying to bootstrap a guild with additional roles, keep this in mind. The required id field within each role object is an integer placeholder, and will be replaced by the API upon consumption. Its purpose is to allow you to overwrite a role's permissions in a channel when also passing in channels with the channels array. When using the channels parameter, the position field is ignored, and none of the default channels are created. The id field within each channel object may be set to an integer placeholder, and will be replaced by the API upon consumption. Its purpose is to allow you to create GUILD_CATEGORY channels by setting the parent_id field on any children to the category's id field. Category channels must be listed before any children.

Note
The region field is deprecated and is replaced by channel.rtc_region.
Parameters
gGuild to create
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_create_from_template()

void dpp::cluster::guild_create_from_template ( const std::string &  code,
const std::string &  name,
command_completion_event_t  callback = {} 
)

Create a new guild based on a template.

Parameters
codeTemplate code to create guild from
nameGuild name to create
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_current_member_edit()

void dpp::cluster::guild_current_member_edit ( snowflake  guild_id,
const std::string &  nickname,
command_completion_event_t  callback = {} 
)

Modify current member.

Modifies the current member in a guild. Fires a Guild Member Update Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to change on
nicknameNew nickname, or empty string to clear nickname
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_delete()

void dpp::cluster::guild_delete ( snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Delete a guild.

Delete a guild permanently. User must be owner. Fires a Guild Delete Gateway event.

Parameters
guild_idGuild ID to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_delete_integration()

void dpp::cluster::guild_delete_integration ( snowflake  guild_id,
snowflake  integration_id,
command_completion_event_t  callback = {} 
)

Delete guild integration.

Delete the attached integration object for the guild. Deletes any associated webhooks and kicks the associated bot if there is one. Requires the MANAGE_GUILD permission. Fires a Guild Integrations Update Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to delete integration for
integration_idIntegration ID to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_edit()

void dpp::cluster::guild_edit ( const class guild g,
command_completion_event_t  callback = {} 
)

Edit a guild.

Modify a guild's settings. Requires the MANAGE_GUILD permission. Returns the updated guild object on success. Fires a Guild Update Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
gGuild to edit
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_edit_member()

void dpp::cluster::guild_edit_member ( const guild_member gm,
command_completion_event_t  callback = {} 
)

Edit the properties of an existing guild member.

Modify attributes of a guild member. Returns the guild_member. Fires a Guild Member Update Gateway event. If the channel_id is set to 0, this will force the target user to be disconnected from voice. To remove a timeout, set the communication_disabled_until to a non-zero time in the past, e.g. 1. When moving members to channels, the API user must have permissions to both connect to the channel and have the MOVE_MEMBERS permission.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
gmGuild member to edit
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_member object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_edit_widget()

void dpp::cluster::guild_edit_widget ( snowflake  guild_id,
const class guild_widget gw,
command_completion_event_t  callback = {} 
)

Edit guild widget.

Requires the MANAGE_GUILD permission.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to edit widget for
gwNew guild widget information
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_widget object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_emoji_create()

void dpp::cluster::guild_emoji_create ( snowflake  guild_id,
const class emoji newemoji,
command_completion_event_t  callback = {} 
)

Create single emoji. You must ensure that the emoji passed contained image data using the emoji::load_image() method.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to create emoji om
newemojiEmoji to create
callbackFunction to call when the API call completes. On success the callback will contain a dpp::emoji object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_emoji_delete()

void dpp::cluster::guild_emoji_delete ( snowflake  guild_id,
snowflake  emoji_id,
command_completion_event_t  callback = {} 
)

Delete a guild emoji.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to delete emoji on
emoji_idEmoji ID to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_emoji_edit()

void dpp::cluster::guild_emoji_edit ( snowflake  guild_id,
const class emoji newemoji,
command_completion_event_t  callback = {} 
)

Edit a single emoji.

You must ensure that the emoji passed contained image data using the emoji::load_image() method.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to edit emoji on
newemojiEmoji to edit
callbackFunction to call when the API call completes. On success the callback will contain a dpp::emoji object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_emoji_get()

void dpp::cluster::guild_emoji_get ( snowflake  guild_id,
snowflake  emoji_id,
command_completion_event_t  callback 
)

Get a single emoji.

Parameters
guild_idGuild ID to get emoji for
emoji_idEmoji ID to get
callbackFunction to call when the API call completes. On success the callback will contain a dpp::emoji object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_emojis_get()

void dpp::cluster::guild_emojis_get ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get all emojis for a guild.

Parameters
guild_idGuild ID to get emojis for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::emoji_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_event_create()

void dpp::cluster::guild_event_create ( const scheduled_event event,
command_completion_event_t  callback = {} 
)

Create a scheduled event on a guild.

Parameters
eventEvent to create (guild ID must be populated)
callbackFunction to call when the API call completes. On success the callback will contain a dpp::scheduled_event_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_event_delete()

void dpp::cluster::guild_event_delete ( snowflake  event_id,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Delete a scheduled event from a guild.

Parameters
event_idEvent ID to delete
guild_idGuild ID of event to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_event_edit()

void dpp::cluster::guild_event_edit ( const scheduled_event event,
command_completion_event_t  callback = {} 
)

Edit/modify a scheduled event on a guild.

Parameters
eventEvent to create (event ID and guild ID must be populated)
callbackFunction to call when the API call completes. On success the callback will contain a dpp::scheduled_event_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_event_get()

void dpp::cluster::guild_event_get ( snowflake  guild_id,
snowflake  event_id,
command_completion_event_t  callback 
)

Get a scheduled event for a guild.

Parameters
guild_idGuild to get event for
event_idEvent ID to get
callbackFunction to call when the API call completes. On success the callback will contain a dpp::scheduled_event object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_event_users_get()

void dpp::cluster::guild_event_users_get ( snowflake  guild_id,
snowflake  event_id,
command_completion_event_t  callback,
uint8_t  limit = 100,
snowflake  before = 0,
snowflake  after = 0 
)

Get users RSVP'd to an event.

Parameters
guild_idGuild to get user list for
event_idGuild to get user list for
limitMaximum number of results to return
beforeReturn user IDs that fall before this ID, if provided
afterReturn user IDs that fall after this ID, if provided
callbackFunction to call when the API call completes. On success the callback will contain a dpp::user_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_events_get()

void dpp::cluster::guild_events_get ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get all scheduled events for a guild.

Parameters
guild_idGuild to get events for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::scheduled_event_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get()

void dpp::cluster::guild_get ( snowflake  g,
command_completion_event_t  callback 
)

Get a guild.

Returns the guild object for the given id. This endpoint will also return approximate_member_count and approximate_presence_count for the guild.

Parameters
gGuild ID to retrieve
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_ban()

void dpp::cluster::guild_get_ban ( snowflake  guild_id,
snowflake  user_id,
command_completion_event_t  callback 
)

Get single guild ban.

Requires the BAN_MEMBERS permission.

Parameters
guild_idGuild ID to get ban for
user_idUser ID of ban to retrieve
callbackFunction to call when the API call completes. On success the callback will contain a dpp::ban object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_bans()

void dpp::cluster::guild_get_bans ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get guild ban list.

Requires the BAN_MEMBERS permission.

Parameters
guild_idGuild ID to get bans for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::ban_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_integrations()

void dpp::cluster::guild_get_integrations ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get guild integrations.

Requires the MANAGE_GUILD permission.

Parameters
guild_idGuild ID to get integrations for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::integration_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_invites()

void dpp::cluster::guild_get_invites ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get guild invites.

Returns a list of invite objects (with invite metadata) for the guild. Requires the MANAGE_GUILD permission.

Parameters
guild_idGuild ID to get invites for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::invite_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_member()

void dpp::cluster::guild_get_member ( snowflake  guild_id,
snowflake  user_id,
command_completion_event_t  callback 
)

Get a guild member.

Parameters
guild_idGuild ID to get member for
user_idUser ID of member to get
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_member object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_members()

void dpp::cluster::guild_get_members ( snowflake  guild_id,
uint16_t  limit,
snowflake  after,
command_completion_event_t  callback 
)

Get all guild members.

Note
This endpoint is restricted according to whether the GUILD_MEMBERS Privileged Intent is enabled for your application.
Parameters
guild_idGuild ID to get all members for
limitmax number of members to return (1-1000)
afterthe highest user id in the previous page
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_member_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_preview()

void dpp::cluster::guild_get_preview ( snowflake  g,
command_completion_event_t  callback 
)

Get a guild preview. Returns a guild object but only a subset of the fields will be populated.

Returns the guild preview object for the given id g. If the user is not in the guild, then the guild must be lurkable (it must be Discoverable or have a live public stage).

Parameters
gGuild ID to retrieve
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_prune_counts()

void dpp::cluster::guild_get_prune_counts ( snowflake  guild_id,
const struct prune pruneinfo,
command_completion_event_t  callback 
)

Get prune counts.

Returns a prune object indicating the number of members that would be removed in a prune operation. Requires the KICK_MEMBERS permission. By default, prune will not remove users with roles. You can optionally include specific roles in your prune by providing the include_roles parameter. Any inactive user that has a subset of the provided role(s) will be counted in the prune and users with additional roles will not.

Parameters
guild_idGuild ID to count for pruning
pruneinfoPruning info
callbackFunction to call when the API call completes. On success the callback will contain a dpp::prune object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_vanity()

void dpp::cluster::guild_get_vanity ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get guild vanity url, if enabled.

Returns a partial dpp::invite object for guilds with that feature enabled. Requires the MANAGE_GUILD permission. code will be null if a vanity url for the guild is not set.

Parameters
guild_idGuild to get vanity URL for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::invite object in confirmation_callback_t::value filled to match the vanity url. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_voice_regions()

void dpp::cluster::guild_get_voice_regions ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get guild voice regions.

Voice regions per guild are somewhat deprecated in preference of per-channel voice regions. Returns a list of voice region objects for the guild. Unlike the similar /voice route, this returns VIP servers when the guild is VIP-enabled.

Parameters
guild_idGuild ID to get voice regions for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::voiceregion_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_get_widget()

void dpp::cluster::guild_get_widget ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get guild widget.

Requires the MANAGE_GUILD permission.

Parameters
guild_idGuild ID to get widget for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_widget object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_member_add_role()

void dpp::cluster::guild_member_add_role ( snowflake  guild_id,
snowflake  user_id,
snowflake  role_id,
command_completion_event_t  callback = {} 
)

Add role to guild member.

Adds a role to a guild member. Requires the MANAGE_ROLES permission. Fires a Guild Member Update Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to add a role to
user_idUser ID to add role to
role_idRole ID to add to the user
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_member_delete()

void dpp::cluster::guild_member_delete ( snowflake  guild_id,
snowflake  user_id,
command_completion_event_t  callback = {} 
)

Remove (kick) a guild member.

Remove a member from a guild. Requires KICK_MEMBERS permission. Fires a Guild Member Remove Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to kick member from
user_idUser ID to kick
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_member_delete_role()

void dpp::cluster::guild_member_delete_role ( snowflake  guild_id,
snowflake  user_id,
snowflake  role_id,
command_completion_event_t  callback = {} 
)

Remove role from guild member.

Removes a role from a guild member. Requires the MANAGE_ROLES permission. Fires a Guild Member Update Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to remove role from user on
user_idUser ID to remove role from
role_idRole to remove
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_member_move()

void dpp::cluster::guild_member_move ( const snowflake  channel_id,
const snowflake  guild_id,
const snowflake  user_id,
command_completion_event_t  callback = {} 
)

Moves the guild member to a other voice channel, if member is connected to one.

Parameters
channel_idId of the channel to which the user is used
guild_idGuild id to which the user is connected
user_idUser id, who should be moved
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_member object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_modify_integration()

void dpp::cluster::guild_modify_integration ( snowflake  guild_id,
const class integration i,
command_completion_event_t  callback = {} 
)

Modify guild integration.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to modify integration for
iIntegration to modify
callbackFunction to call when the API call completes. On success the callback will contain a dpp::integration object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_search_members()

void dpp::cluster::guild_search_members ( snowflake  guild_id,
const std::string &  query,
uint16_t  limit,
command_completion_event_t  callback 
)

Search for guild members based on whether their username or nickname starts with the given string.

Note
This endpoint is restricted according to whether the GUILD_MEMBERS Privileged Intent is enabled for your application.
Parameters
guild_idGuild ID to search in
queryQuery string to match username(s) and nickname(s) against
limitmax number of members to return (1-1000)
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_member_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_set_nickname()

void dpp::cluster::guild_set_nickname ( snowflake  guild_id,
const std::string &  nickname,
command_completion_event_t  callback = {} 
)

Change current user nickname.

Modifies the nickname of the current user in a guild. Fires a Guild Member Update Gateway event.

Deprecated:
Deprecated in favor of Modify Current Member. Will be replaced by dpp::cluster::guild_current_member_edit
Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to change nickname on
nicknameNew nickname, or empty string to clear nickname
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_sticker_create()

void dpp::cluster::guild_sticker_create ( sticker s,
command_completion_event_t  callback = {} 
)

Create a sticker in a guild.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
sSticker to create. Must have its guild ID set.
callbackFunction to call when the API call completes. On success the callback will contain a dpp::sticker object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_sticker_delete()

void dpp::cluster::guild_sticker_delete ( snowflake  sticker_id,
snowflake  guild_id,
command_completion_event_t  callback = {} 
)

Delete a sticker from a guild.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
sticker_idsticker ID to delete
guild_idguild ID to delete from
callbackFunction to call when the API call completes. On success the callback will contain a dpp::sticker object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_sticker_get()

void dpp::cluster::guild_sticker_get ( snowflake  id,
snowflake  guild_id,
command_completion_event_t  callback 
)

Get a guild sticker.

Parameters
idId of sticker to get.
guild_idGuild ID of the guild where the sticker is
callbackFunction to call when the API call completes. On success the callback will contain a dpp::sticker object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_sticker_modify()

void dpp::cluster::guild_sticker_modify ( sticker s,
command_completion_event_t  callback = {} 
)

Modify a sticker in a guild.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
sSticker to modify. Must have its guild ID and sticker ID set.
callbackFunction to call when the API call completes. On success the callback will contain a dpp::sticker object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_stickers_get()

void dpp::cluster::guild_stickers_get ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get all guild stickers.

Parameters
guild_idGuild ID of the guild where the sticker is
callbackFunction to call when the API call completes. On success the callback will contain a dpp::sticker object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_sync_integration()

void dpp::cluster::guild_sync_integration ( snowflake  guild_id,
snowflake  integration_id,
command_completion_event_t  callback = {} 
)

Sync guild integration.

Parameters
guild_idGuild ID to sync integration on
integration_idIntegration ID to synchronise
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_template_create()

void dpp::cluster::guild_template_create ( snowflake  guild_id,
const std::string &  name,
const std::string &  description,
command_completion_event_t  callback 
)

Creates a template for the guild.

Parameters
guild_idGuild to create template from
nameTemplate name to create
descriptionDescription of template to create
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_template_delete()

void dpp::cluster::guild_template_delete ( snowflake  guild_id,
const std::string &  code,
command_completion_event_t  callback = {} 
)

Deletes the template.

Parameters
guild_idGuild ID of template to delete
codeTemplate code to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_template_modify()

void dpp::cluster::guild_template_modify ( snowflake  guild_id,
const std::string &  code,
const std::string &  name,
const std::string &  description,
command_completion_event_t  callback = {} 
)

Modifies the template's metadata.

Parameters
guild_idGuild ID of template to modify
codeTemplate code to modify
nameNew name of template
descriptionNew description of template
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_template_sync()

void dpp::cluster::guild_template_sync ( snowflake  guild_id,
const std::string &  code,
command_completion_event_t  callback = {} 
)

Syncs the template to the guild's current state.

Parameters
guild_idGuild to synchronise template for
codeCode of template to synchronise
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ guild_templates_get()

void dpp::cluster::guild_templates_get ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get guild templates.

Parameters
guild_idGuild ID to get templates for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ interaction_response_create()

void dpp::cluster::interaction_response_create ( snowflake  interaction_id,
const std::string &  token,
const interaction_response r,
command_completion_event_t  callback = {} 
)

Respond to a slash command.

Parameters
interaction_idInteraction id to respond to
tokenToken for the interaction webhook
rResponse to send
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ interaction_response_edit()

void dpp::cluster::interaction_response_edit ( const std::string &  token,
const message r,
command_completion_event_t  callback = {} 
)

Respond to a slash command.

Parameters
tokenToken for the interaction webhook
rMessage to send
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ invite_delete()

void dpp::cluster::invite_delete ( const std::string &  invite,
command_completion_event_t  callback = {} 
)

Delete an invite.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
inviteInvite code to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::invite object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ invite_get()

void dpp::cluster::invite_get ( const std::string &  invite,
command_completion_event_t  callback 
)

Get details about an invite.

Parameters
inviteInvite code to get information on
callbackFunction to call when the API call completes. On success the callback will contain a dpp::invite object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ log()

void dpp::cluster::log ( dpp::loglevel  severity,
const std::string &  msg 
) const

Log a message to whatever log the user is using. The logged message is passed up the chain to the on_log event in user code which can then do whatever it wants to do with it.

Parameters
severityThe log level from dpp::loglevel
msgThe log message to output

◆ message_add_reaction() [1/2]

void dpp::cluster::message_add_reaction ( const struct message m,
const std::string &  reaction,
command_completion_event_t  callback = {} 
)

Add a reaction to a message. The reaction string must be either an emojiname:id or a unicode character.

Parameters
mMessage to add a reaction to
reactionReaction to add. Emojis should be in the form emojiname:id
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_add_reaction() [2/2]

void dpp::cluster::message_add_reaction ( snowflake  message_id,
snowflake  channel_id,
const std::string &  reaction,
command_completion_event_t  callback = {} 
)

Add a reaction to a message by id. The reaction string must be either an emojiname:id or a unicode character.

Parameters
message_idMessage to add reactions to
channel_idChannel to add reactions to
reactionReaction to add. Emojis should be in the form emojiname:id
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_create()

void dpp::cluster::message_create ( const struct message m,
command_completion_event_t  callback = {} 
)

Send a message to a channel. The callback function is called when the message has been sent.

Parameters
mMessage to send
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_crosspost()

void dpp::cluster::message_crosspost ( snowflake  message_id,
snowflake  channel_id,
command_completion_event_t  callback = {} 
)

Crosspost a message. The callback function is called when the message has been sent.

Parameters
message_idMessage to crosspost
channel_idChannel ID to crosspost from
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete()

void dpp::cluster::message_delete ( snowflake  message_id,
snowflake  channel_id,
command_completion_event_t  callback = {} 
)

Delete a message from a channel. The callback function is called when the message has been edited.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
message_idMessage ID to delete
channel_idChannel to delete from
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_all_reactions() [1/2]

void dpp::cluster::message_delete_all_reactions ( const struct message m,
command_completion_event_t  callback = {} 
)

Delete all reactions on a message.

Parameters
mMessage to delete reactions from
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_all_reactions() [2/2]

void dpp::cluster::message_delete_all_reactions ( snowflake  message_id,
snowflake  channel_id,
command_completion_event_t  callback = {} 
)

Delete all reactions on a message by id.

Parameters
message_idMessage to delete reactions from
channel_idChannel to delete reactions from
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_bulk()

void dpp::cluster::message_delete_bulk ( const std::vector< snowflake > &  message_ids,
snowflake  channel_id,
command_completion_event_t  callback = {} 
)

Bulk delete messages from a channel. The callback function is called when the message has been edited.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
If any message provided older than 2 weeks or any duplicate message ID, it will fail.
Parameters
message_idsList of message IDs to delete (at least 2 and at most 100 message IDs)
channel_idChannel to delete from
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_own_reaction() [1/2]

void dpp::cluster::message_delete_own_reaction ( const struct message m,
const std::string &  reaction,
command_completion_event_t  callback = {} 
)

Delete own reaction from a message. The reaction string must be either an emojiname:id or a unicode character.

Parameters
mMessage to delete own reaction from
reactionReaction to delete. The reaction should be in the form emojiname:id
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_own_reaction() [2/2]

void dpp::cluster::message_delete_own_reaction ( snowflake  message_id,
snowflake  channel_id,
const std::string &  reaction,
command_completion_event_t  callback = {} 
)

Delete own reaction from a message by id. The reaction string must be either an emojiname:id or a unicode character.

Parameters
message_idMessage to delete reactions from
channel_idChannel to delete reactions from
reactionReaction to delete. The reaction should be in the form emojiname:id
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_reaction() [1/2]

void dpp::cluster::message_delete_reaction ( const struct message m,
snowflake  user_id,
const std::string &  reaction,
command_completion_event_t  callback = {} 
)

Delete a user's reaction from a message. The reaction string must be either an emojiname:id or a unicode character.

Parameters
mMessage to delete a user's reaction from
user_idUser ID who's reaction you want to remove
reactionReaction to remove. Reactions should be in the form emojiname:id
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_reaction() [2/2]

void dpp::cluster::message_delete_reaction ( snowflake  message_id,
snowflake  channel_id,
snowflake  user_id,
const std::string &  reaction,
command_completion_event_t  callback = {} 
)

Delete a user's reaction from a message by id. The reaction string must be either an emojiname:id or a unicode character.

Parameters
message_idMessage to delete reactions from
channel_idChannel to delete reactions from
user_idUser ID who's reaction you want to remove
reactionReaction to remove. Reactions should be in the form emojiname:id
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_reaction_emoji() [1/2]

void dpp::cluster::message_delete_reaction_emoji ( const struct message m,
const std::string &  reaction,
command_completion_event_t  callback = {} 
)

Delete all reactions on a message using a particular emoji. The reaction string must be either an emojiname:id or a unicode character.

Parameters
mMessage to delete reactions from
reactionReaction to delete, in the form emojiname:id or a unicode character
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_delete_reaction_emoji() [2/2]

void dpp::cluster::message_delete_reaction_emoji ( snowflake  message_id,
snowflake  channel_id,
const std::string &  reaction,
command_completion_event_t  callback = {} 
)

Delete all reactions on a message using a particular emoji by id. The reaction string must be either an emojiname:id or a unicode character.

Parameters
message_idMessage to delete reactions from
channel_idChannel to delete reactions from
reactionReaction to delete, in the form emojiname:id or a unicode character
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_edit()

void dpp::cluster::message_edit ( const struct message m,
command_completion_event_t  callback = {} 
)

Edit a message on a channel. The callback function is called when the message has been edited.

Parameters
mMessage to edit
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_get()

void dpp::cluster::message_get ( snowflake  message_id,
snowflake  channel_id,
command_completion_event_t  callback 
)

Get a message.

Parameters
message_idMessage ID
channel_idChannel ID
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_get_reactions() [1/2]

void dpp::cluster::message_get_reactions ( const struct message m,
const std::string &  reaction,
snowflake  before,
snowflake  after,
snowflake  limit,
command_completion_event_t  callback 
)

Get reactions on a message for a particular emoji. The reaction string must be either an emojiname:id or a unicode character.

Parameters
mMessage to get reactions for
reactionReaction should be in the form emojiname:id or a unicode character
beforeReactions before this ID should be retrieved if this is set to non-zero
afterReactions before this ID should be retrieved if this is set to non-zero
limitThis number of reactions maximum should be returned
callbackFunction to call when the API call completes. On success the callback will contain a dpp::user_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_get_reactions() [2/2]

void dpp::cluster::message_get_reactions ( snowflake  message_id,
snowflake  channel_id,
const std::string &  reaction,
snowflake  before,
snowflake  after,
snowflake  limit,
command_completion_event_t  callback 
)

Get reactions on a message for a particular emoji by id. The reaction string must be either an emojiname:id or a unicode character.

Parameters
message_idMessage to get reactions for
channel_idChannel to get reactions for
reactionReaction should be in the form emojiname:id or a unicode character
beforeReactions before this ID should be retrieved if this is set to non-zero
afterReactions before this ID should be retrieved if this is set to non-zero
limitThis number of reactions maximum should be returned
callbackFunction to call when the API call completes. On success the callback will contain a dpp::user_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_pin()

void dpp::cluster::message_pin ( snowflake  channel_id,
snowflake  message_id,
command_completion_event_t  callback = {} 
)

Pin a message.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
channel_idChannel id to pin message on
message_idMessage id to pin message on
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ message_unpin()

void dpp::cluster::message_unpin ( snowflake  channel_id,
snowflake  message_id,
command_completion_event_t  callback = {} 
)

Unpin a message.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
channel_idChannel id to unpin message on
message_idMessage id to unpin message on
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ messages_get()

void dpp::cluster::messages_get ( snowflake  channel_id,
snowflake  around,
snowflake  before,
snowflake  after,
uint32_t  limit,
command_completion_event_t  callback 
)

Get multiple messages.

This function will attempt to fetch as many messages as possible using multiple API calls if needed.

Parameters
channel_idChannel ID to retrieve messages for
aroundMessages should be retrieved around this ID if this is set to non-zero
beforeMessages before this ID should be retrieved if this is set to non-zero
afterMessages after this ID should be retrieved if this is set to non-zero
limitThis number of messages maximum should be returned. If the number passed for limit is less than 100, then this will be executed in one REST call. If you specify a limit greater than 100, then there will be one REST call per 100 messages.
Warning
if you request a large number of messages this can and will take a long time. You should not constantly do this, or you may get banned from the API by Discord as repeated calls to an endpoint are strongly discouraged!
Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::message_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ nitro_sticker_get()

void dpp::cluster::nitro_sticker_get ( snowflake  id,
command_completion_event_t  callback 
)

Get a nitro sticker.

Parameters
idId of sticker to get.
callbackFunction to call when the API call completes. On success the callback will contain a dpp::sticker object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ post_rest()

void dpp::cluster::post_rest ( const std::string &  endpoint,
const std::string &  major_parameters,
const std::string &  parameters,
http_method  method,
const std::string &  postdata,
json_encode_t  callback,
const std::string &  filename = "",
const std::string &  filecontent = "" 
)

Post a REST request. Where possible use a helper method instead like message_create.

Parameters
endpointEndpoint to post to, e.g. /api/guilds
major_parametersMajor parameters for the endpoint e.g. a guild id
parametersMinor parameters for the API request
methodMethod, e.g. GET, POST
postdataPost data (usually JSON encoded)
callbackFunction to call when the HTTP call completes. The callback parameter will contain amongst other things, the decoded json.
filenameFilename to post for POST requests (for uploading files)
filecontentFile content to post for POST requests (for uploading files)

◆ post_rest_multipart()

void dpp::cluster::post_rest_multipart ( const std::string &  endpoint,
const std::string &  major_parameters,
const std::string &  parameters,
http_method  method,
const std::string &  postdata,
json_encode_t  callback,
const std::vector< std::string > &  filename = {},
const std::vector< std::string > &  filecontent = {} 
)

Post a multipart REST request. Where possible use a helper method instead like message_create.

Parameters
endpointEndpoint to post to, e.g. /api/guilds
major_parametersMajor parameters for the endpoint e.g. a guild id
parametersMinor parameters for the API request
methodMethod, e.g. GET, POST
postdataPost data (usually JSON encoded)
callbackFunction to call when the HTTP call completes. The callback parameter will contain amongst other things, the decoded json.
filenameList of filenames to post for POST requests (for uploading files)
filecontentList of file content to post for POST requests (for uploading files)

◆ request()

void dpp::cluster::request ( const std::string &  url,
http_method  method,
http_completion_event  callback,
const std::string &  postdata = "",
const std::string &  mimetype = "text/plain",
const std::multimap< std::string, std::string > &  headers = {} 
)

Make a HTTP(S) request. For use when wanting asynchronous access to HTTP APIs outside of Discord.

Parameters
urlEndpoint to post to, e.g. /api/guilds
methodMethod, e.g. GET, POST
callbackFunction to call when the HTTP call completes. No processing is done on the returned data.
postdataPOST data
mimetypeMIME type of POST data
headersHeaders to send with the request

◆ role_create()

void dpp::cluster::role_create ( const class role r,
command_completion_event_t  callback = {} 
)

Create a role on a guild.

Create a new role for the guild. Requires the MANAGE_ROLES permission. Returns the new role object on success. Fires a Guild Role Create Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
rRole to create (guild ID is encapsulated in the role object)
callbackFunction to call when the API call completes. On success the callback will contain a dpp::role object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ role_delete()

void dpp::cluster::role_delete ( snowflake  guild_id,
snowflake  role_id,
command_completion_event_t  callback = {} 
)

Delete a role.

Requires the MANAGE_ROLES permission. Fires a Guild Role Delete Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to delete the role on
role_idRole ID to delete
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ role_edit()

void dpp::cluster::role_edit ( const class role r,
command_completion_event_t  callback = {} 
)

Edit a role on a guild.

Requires the MANAGE_ROLES permission. Returns the updated role on success. Fires a Guild Role Update Gateway event.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
rRole to edit
callbackFunction to call when the API call completes. On success the callback will contain a dpp::role object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ roles_edit_position()

void dpp::cluster::roles_edit_position ( snowflake  guild_id,
const std::vector< role > &  roles,
command_completion_event_t  callback = {} 
)

Edit multiple role's position in a guild. Returns a list of all roles of the guild on success.

Modify the positions of a set of role objects for the guild. Requires the MANAGE_ROLES permission. Fires multiple Guild Role Update Gateway events.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
guild_idGuild ID to change the roles position on
rolesVector of roles to change the positions of
callbackFunction to call when the API call completes. On success the callback will contain a dpp::role_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ roles_get()

void dpp::cluster::roles_get ( snowflake  guild_id,
command_completion_event_t  callback 
)

Get a role for a guild.

Parameters
guild_idGuild ID to get role for
callbackFunction to call when the API call completes. On success the callback will contain a dpp::role_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ set_audit_reason()

cluster & dpp::cluster::set_audit_reason ( const std::string &  reason)

Set the audit log reason for the next REST call to be made. This is set per-thread, so you must ensure that if you call this method, your request that is associated with the reason happens on the same thread where you set the reason. Once the next call is made, the audit log reason is cleared for this thread automatically.

Example:

bot.set_audit_reason("Too much abusive content")
.channel_delete(my_channel_id);
Parameters
reasonThe reason to set for the next REST call on this thread
Returns
cluster& Reference to self for chaining.

◆ set_dm_channel()

void dpp::cluster::set_dm_channel ( snowflake  user_id,
snowflake  channel_id 
)

Set the dm channel id for a user id.

Parameters
user_iduser id to set the dm channel for
channel_iddm channel to set

◆ set_presence()

void dpp::cluster::set_presence ( const class dpp::presence p)

Set the presence for all shards on the cluster.

Parameters
pThe presence to set. Only the online status and the first activity are sent.

◆ set_websocket_protocol()

cluster & dpp::cluster::set_websocket_protocol ( websocket_protocol_t  mode)

Set the websocket protocol for all shards on this cluster. You should call this method before cluster::start. Generally ws_etf is faster, but provides less facilities for debugging should something go wrong. It is recommended to use ETF in production and JSON in development.

Parameters
modewebsocket protocol to use, either ws_json or ws_etf.
Returns
cluster& Reference to self for chaining.

◆ stage_instance_create()

void dpp::cluster::stage_instance_create ( const stage_instance instance,
command_completion_event_t  callback = {} 
)

Create a stage instance on a stage channel.

Parameters
instanceStage instance to create
callbackUser function to execute when the api call completes On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().
Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.

◆ stage_instance_delete()

void dpp::cluster::stage_instance_delete ( const snowflake  channel_id,
command_completion_event_t  callback = {} 
)

Delete a stage instance.

Parameters
channel_idID of the associated channel
callbackUser function to execute when the api call completes On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().
Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.

◆ stage_instance_edit()

void dpp::cluster::stage_instance_edit ( const stage_instance instance,
command_completion_event_t  callback = {} 
)

Edit a stage instance.

Parameters
instanceStage instance to edit
callbackUser function to execute when the api call completes On success the callback will contain a dpp::stage_instance object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().
Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.

◆ stage_instance_get()

void dpp::cluster::stage_instance_get ( const snowflake  channel_id,
command_completion_event_t  callback 
)

Get the stage instance associated with the channel id, if it exists.

Parameters
channel_idID of the associated channel
callbackUser function to execute when the api call completes On success the callback will contain a dpp::stage_instance object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ start()

void dpp::cluster::start ( bool  return_after = true)

Start the cluster, connecting all its shards.

Returns once all shards are connected if return_after is true, otherwise enters an infinite loop while the shards run.

Parameters
return_afterIf true the bot will return to your program after starting shards, if false this function will never return.

◆ start_timer()

timer dpp::cluster::start_timer ( timer_callback_t  on_tick,
uint64_t  frequency,
timer_callback_t  on_stop = {} 
)

Start a timer. Every frequency seconds, the callback is called.

Parameters
on_tickThe callback lambda to call for this timer when ticked
on_stopThe callback lambda to call for this timer when it is stopped
frequencyHow often to tick the timer in seconds
Returns
timer A handle to the timer, used to remove that timer later

◆ sticker_packs_get()

void dpp::cluster::sticker_packs_get ( command_completion_event_t  callback)

Get sticker packs.

Parameters
callbackFunction to call when the API call completes. On success the callback will contain a dpp::sticker object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ stop_timer()

bool dpp::cluster::stop_timer ( timer  t)

Stop a ticking timer.

Parameters
tTimer handle received from cluster::start_timer
Returns
bool True if the timer was stopped, false if it did not exist
Note
If the timer has an on_stop lambda, the on_stop lambda will be called.

◆ template_get()

void dpp::cluster::template_get ( const std::string &  code,
command_completion_event_t  callback 
)

Get a template.

Parameters
codeTemplate code
callbackFunction to call when the API call completes. On success the callback will contain a dpp::guild object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ thread_create()

void dpp::cluster::thread_create ( const std::string &  thread_name,
snowflake  channel_id,
uint16_t  auto_archive_duration,
channel_type  thread_type,
bool  invitable,
uint16_t  rate_limit_per_user,
command_completion_event_t  callback = {} 
)

Create a thread.

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
thread_nameName of the thread
channel_idChannel in which thread to create
auto_archive_durationDuration after which thread auto-archives. Can be set to - 60, 1440 (for boosted guilds can also be: 4320, 10080)
thread_typeType of thread - GUILD_PUBLIC_THREAD, GUILD_NEWS_THREAD, GUILD_PRIVATE_THREAD
invitablewhether non-moderators can add other non-moderators to a thread; only available when creating a private thread
rate_limit_per_useramount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission manage_messages, manage_thread, or manage_channel, are unaffected
callbackFunction to call when the API call completes. On success the callback will contain a dpp::thread object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ thread_create_with_message()

void dpp::cluster::thread_create_with_message ( const std::string &  thread_name,
snowflake  channel_id,
snowflake  message_id,
uint16_t  auto_archive_duration,
uint16_t  rate_limit_per_user,
command_completion_event_t  callback = {} 
)

Create a thread with a message (Discord: ID of a thread is same as message ID)

Note
This method supports audit log reasons set by the cluster::set_audit_reason() method.
Parameters
thread_nameName of the thread
channel_idChannel in which thread to create
message_idmessage to start thread with
auto_archive_durationDuration after which thread auto-archives. Can be set to - 60, 1440 (for boosted guilds can also be: 4320, 10080)
rate_limit_per_useramount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission manage_messages, manage_thread, or manage_channel, are unaffected
callbackFunction to call when the API call completes. On success the callback will contain a dpp::thread object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ thread_member_add()

void dpp::cluster::thread_member_add ( snowflake  thread_id,
snowflake  user_id,
command_completion_event_t  callback = {} 
)

Add a member to a thread.

Parameters
thread_idThread ID to add to
user_idMember ID to add
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ thread_member_get()

void dpp::cluster::thread_member_get ( const snowflake  thread_id,
const snowflake  user_id,
command_completion_event_t  callback 
)

Get a thread member.

Parameters
thread_idThread to get member for
user_idID of the user to get
callbackFunction to call when the API call completes On success the callback will contain a dpp::thread_member object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ thread_member_remove()

void dpp::cluster::thread_member_remove ( snowflake  thread_id,
snowflake  user_id,
command_completion_event_t  callback = {} 
)

Remove a member from a thread.

Parameters
thread_idThread ID to remove from
user_idMember ID to remove
callbackFunction to call when the API call completes. On success the callback will contain a dpp::confirmation object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ thread_members_get()

void dpp::cluster::thread_members_get ( snowflake  thread_id,
command_completion_event_t  callback 
)

Get members of a thread.

Parameters
thread_idThread to get members for
callbackFunction to call when the API call completes On success the callback will contain a dpp::thread_member_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ threads_get_active()

void dpp::cluster::threads_get_active ( snowflake  channel_id,
command_completion_event_t  callback 
)

Get active threads in a channel (Sorted by ID in descending order)

Parameters
channel_idChannel to get active threads for
callbackFunction to call when the API call completes On success the callback will contain a dpp::thread_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ threads_get_joined_private_archived()

void dpp::cluster::threads_get_joined_private_archived ( snowflake  channel_id,
snowflake  before_id,
uint16_t  limit,
command_completion_event_t  callback 
)

Get private archived threads in a channel which current user has joined (Sorted by ID in descending order)

Parameters
channel_idChannel to get public archived threads for
before_idGet threads before this id
limitNumber of threads to get
callbackFunction to call when the API call completes On success the callback will contain a dpp::thread_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ threads_get_private_archived()

void dpp::cluster::threads_get_private_archived ( snowflake  channel_id,
time_t  before_timestamp,
uint16_t  limit,
command_completion_event_t  callback 
)

Get private archived threads in a channel (Sorted by archive_timestamp in descending order)

Parameters
channel_idChannel to get public archived threads for
before_timestampGet threads before this timestamp
limitNumber of threads to get
callbackFunction to call when the API call completes On success the callback will contain a dpp::thread_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ threads_get_public_archived()

void dpp::cluster::threads_get_public_archived ( snowflake  channel_id,
time_t  before_timestamp,
uint16_t  limit,
command_completion_event_t  callback 
)

Get public archived threads in a channel (Sorted by archive_timestamp in descending order)

Parameters
channel_idChannel to get public archived threads for
before_timestampGet threads before this timestamp
limitNumber of threads to get
callbackFunction to call when the API call completes On success the callback will contain a dpp::thread_map object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

◆ uptime()

dpp::utility::uptime dpp::cluster::uptime ( )

Returns the uptime of the cluster.

Returns
dpp::utility::uptime The uptime of the cluster

◆ user_get()

void dpp::cluster::user_get ( snowflake  user_id,
command_completion_event_t  callback 
)

Get a user by id.

Parameters
user_idUser ID to retrieve
callbackFunction to call when the API call completes. On success the callback will contain a dpp::user_identified object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().
Note
The user_identified object is a subclass of dpp::user which contains further details if you have the oauth2 identify or email scopes. If you do not have these scopes, these fields are empty. You can safely convert a user_identified to user with dynamic_cast.
unless you want something special from dpp::user_identified or you've turned off caching, you have no need to call this. Call dpp::find_user instead that looks up the user in the cache rather than a REST call.

◆ user_set_voice_state()

void dpp::cluster::user_set_voice_state ( snowflake  user_id,
snowflake  guild_id,
snowflake  channel_id,
bool  suppress = false,
command_completion_event_t  callback = {} 
)

Set a user's voice state on a stage channel.

Caveats

There are currently several caveats for this endpoint:

  • channel_id must currently point to a stage channel.
  • User must already have joined channel_id.
  • You must have the MUTE_MEMBERS permission. (Since suppression is the only thing that is available currently)
  • When unsuppressed, non-bot users will have their request_to_speak_timestamp set to the current time. Bot users will not.
  • When suppressed, the user will have their request_to_speak_timestamp removed.
Parameters
user_idThe user to set the voice state of
guild_idGuild to set voice state on
channel_idStage channel to set voice state on
callbackFunction to call when the API call completes.
suppressTrue if the user's audio should be suppressed, false if it should not On success the callback will contain a dpp::scheduled_event object in confirmation_callback_t::value. On failure, the value is undefined and confirmation_callback_t::is_error() method will return true. You can obtain full error details with confirmation_callback_t::get_error().

Friends And Related Function Documentation

◆ discord_client

friend class discord_client
friend

◆ discord_voice_client

friend class discord_voice_client
friend

Member Data Documentation

◆ cache_policy

cache_policy_t dpp::cluster::cache_policy

Current cache policy for the cluster.

◆ cluster_id

uint32_t dpp::cluster::cluster_id

ID of this cluster, between 0 and MAXCLUSTERS-1 inclusive.

◆ intents

uint32_t dpp::cluster::intents

Current bitmask of gateway intents.

◆ last_identify

time_t dpp::cluster::last_identify

Last time the bot sent an IDENTIFY.

◆ maxclusters

uint32_t dpp::cluster::maxclusters

Total number of clusters that are active.

◆ me

dpp::user dpp::cluster::me

The details of the bot user. This is assumed to be identical across all shards in the cluster. Each connecting shard updates this information.

◆ numshards

uint32_t dpp::cluster::numshards

Total number of shards across all clusters.

◆ on_autocomplete

event_router_t<autocomplete_t> dpp::cluster::on_autocomplete

Called when an auto completed field needs suggestions to present to the user This is triggered by discord when option choices have auto completion enabled which you have associated with a dpp::slashcommand.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type autocomplete_t&, and returns void.

◆ on_button_click

event_router_t<button_click_t> dpp::cluster::on_button_click

Called when a button is clicked attached to a message. Button clicks are triggered by discord when buttons are clicked which you have associated with a message using dpp::component.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type button_click_t&, and returns void.

◆ on_channel_create

event_router_t<channel_create_t> dpp::cluster::on_channel_create

Called when a new channel is created on a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type channel_create_t&, and returns void.

◆ on_channel_delete

event_router_t<channel_delete_t> dpp::cluster::on_channel_delete

Called when a channel is deleted from a guild. The channel will still be temporarily available in the cache. Pointers to the channel should not be retained long-term as they will be deleted by the garbage collector.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type channel_delete_t&, and returns void.

◆ on_channel_pins_update

event_router_t<channel_pins_update_t> dpp::cluster::on_channel_pins_update

Called when a message is pinned. Note that the pinned message is not returned to this event, just the timestamp of the last pinned message.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type channel_pins_update_t&, and returns void.

◆ on_channel_update

event_router_t<channel_update_t> dpp::cluster::on_channel_update

Called when a channel is edited on a guild. The new channel details have already been applied to the guild when you receive this event.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type channel_update_t&, and returns void.

◆ on_form_submit

event_router_t<form_submit_t> dpp::cluster::on_form_submit

Called when a modal dialog is submitted. Form submits are triggered by discord when modal dialogs are submitted which you have associated with a slash command using dpp::interaction_modal_response.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type form_submit_t&, and returns void.

◆ on_guild_ban_add

event_router_t<guild_ban_add_t> dpp::cluster::on_guild_ban_add

Called when a ban is added to a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_ban_add_t&, and returns void.

◆ on_guild_ban_remove

event_router_t<guild_ban_remove_t> dpp::cluster::on_guild_ban_remove

Called when a ban is removed from a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_ban_remove_t&, and returns void.

◆ on_guild_create

event_router_t<guild_create_t> dpp::cluster::on_guild_create

Called when a new guild is created. D++ will request members for the guild for its cache using guild_members_chunk.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_create_t&, and returns void.

◆ on_guild_delete

event_router_t<guild_delete_t> dpp::cluster::on_guild_delete

Called when a guild is deleted. A guild can be deleted via the bot being kicked, the bot leaving the guild explicitly with dpp::guild_delete, or via the guild being unavailable due to an outage.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_delete_t&, and returns void.

◆ on_guild_emojis_update

event_router_t<guild_emojis_update_t> dpp::cluster::on_guild_emojis_update

Called when new emojis are added to a guild. The complete set of emojis is sent every time.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_emojis_update_t&, and returns void.

◆ on_guild_integrations_update

event_router_t<guild_integrations_update_t> dpp::cluster::on_guild_integrations_update

Called when an integration is updated for a guild. This returns the complete list. An integration is a connection to a guild of a user's associated accounts, e.g. youtube or twitch, for automatic assignment of roles etc.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_integrations_update_t&, and returns void.

◆ on_guild_join_request_delete

event_router_t<guild_join_request_delete_t> dpp::cluster::on_guild_join_request_delete

on guild join request delete. Triggered when a user declines the membership screening questionnaire for a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_join_request_delete_t&, and returns void.

◆ on_guild_member_add

event_router_t<guild_member_add_t> dpp::cluster::on_guild_member_add

Called when a new member joins a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_member_add_t&, and returns void.

◆ on_guild_member_remove

event_router_t<guild_member_remove_t> dpp::cluster::on_guild_member_remove

Called when a user leaves a guild (either through being kicked, or choosing to leave)

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_member_remove_t&, and returns void.

◆ on_guild_member_update

event_router_t<guild_member_update_t> dpp::cluster::on_guild_member_update

Called when details of a guild member (e.g. their roles or nickname) are updated.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_member_update_t&, and returns void.

◆ on_guild_members_chunk

event_router_t<guild_members_chunk_t> dpp::cluster::on_guild_members_chunk

Called when a set of members is received for a guild. D++ will request these for all new guilds if needed, after the on_guild_create events.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_members_chunk_t&, and returns void.

◆ on_guild_role_create

event_router_t<guild_role_create_t> dpp::cluster::on_guild_role_create

Called when a new role is created on a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_role_create_t&, and returns void.

◆ on_guild_role_delete

event_router_t<guild_role_delete_t> dpp::cluster::on_guild_role_delete

Called when a role is deleted in a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_role_delete_t&, and returns void.

◆ on_guild_role_update

event_router_t<guild_role_update_t> dpp::cluster::on_guild_role_update

Called when an existing role is updated on a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_role_update_t&, and returns void.

◆ on_guild_scheduled_event_create

event_router_t<guild_scheduled_event_create_t> dpp::cluster::on_guild_scheduled_event_create

Called when a new scheduled event is created.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_scheduled_event_create_t&, and returns void.

◆ on_guild_scheduled_event_delete

event_router_t<guild_scheduled_event_delete_t> dpp::cluster::on_guild_scheduled_event_delete

Called when a new scheduled event is deleted.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_scheduled_event_delete_t&, and returns void.

◆ on_guild_scheduled_event_update

event_router_t<guild_scheduled_event_update_t> dpp::cluster::on_guild_scheduled_event_update

Called when a new scheduled event is updated.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_scheduled_event_update_t&, and returns void.

◆ on_guild_scheduled_event_user_add

event_router_t<guild_scheduled_event_user_add_t> dpp::cluster::on_guild_scheduled_event_user_add

Called when a user is added to a scheduled event.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_scheduled_event_user_add_t&, and returns void.

◆ on_guild_scheduled_event_user_remove

event_router_t<guild_scheduled_event_user_remove_t> dpp::cluster::on_guild_scheduled_event_user_remove

Called when a user is removed to a scheduled event.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_scheduled_event_user_remove_t&, and returns void.

◆ on_guild_stickers_update

event_router_t<guild_stickers_update_t> dpp::cluster::on_guild_stickers_update

Called when new stickers are added to a guild. The complete set of stickers is sent every time.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_stickers_update_t&, and returns void.

◆ on_guild_update

event_router_t<guild_update_t> dpp::cluster::on_guild_update

Called when details of a guild are updated.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type guild_update_t&, and returns void.

◆ on_integration_create

event_router_t<integration_create_t> dpp::cluster::on_integration_create

Called when a new integration is attached to a guild by a user. An integration is a connection to a guild of a user's associated accounts, e.g. youtube or twitch, for automatic assignment of roles etc.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type integration_create_t&, and returns void.

◆ on_integration_delete

event_router_t<integration_delete_t> dpp::cluster::on_integration_delete

Called when an integration is removed by a user. An integration is a connection to a guild of a user's associated accounts, e.g. youtube or twitch, for automatic assignment of roles etc.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type integration_delete_t&, and returns void.

◆ on_integration_update

event_router_t<integration_update_t> dpp::cluster::on_integration_update

Called when an integration is updated by a user. This returns details of just the single integration that has changed. An integration is a connection to a guild of a user's associated accounts, e.g. youtube or twitch, for automatic assignment of roles etc.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type integration_update_t&, and returns void.

◆ on_interaction_create

event_router_t<interaction_create_t> dpp::cluster::on_interaction_create

Called when a new interaction is created. Interactions are created by discord when commands you have registered are issued by a user. For an example of this in action please see Using Slash Commands and Interactions.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type interaction_create_t&, and returns void.

◆ on_invite_create

event_router_t<invite_create_t> dpp::cluster::on_invite_create

Called when a new invite is created for a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type invite_create_t&, and returns void.

◆ on_invite_delete

event_router_t<invite_delete_t> dpp::cluster::on_invite_delete

Called when an invite is deleted from a guild.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type invite_delete_t&, and returns void.

◆ on_log

event_router_t<log_t> dpp::cluster::on_log

Called when a log message is to be written to the log. You can attach any logging system here you wish, e.g. spdlog, or even just a simple use of std::cout or printf. If nothing attaches this log event, then the library will be silent.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type log_t&, and returns void.

◆ on_message_create

event_router_t<message_create_t> dpp::cluster::on_message_create

Called when a new message arrives from discord. Note that D++ does not cache messages. If you want to cache these objects you should create something yourself within your bot. Caching of messages is not on the roadmap to be supported as it consumes excessive amounts of RAM.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type message_create_t&, and returns void.

◆ on_message_delete

event_router_t<message_delete_t> dpp::cluster::on_message_delete

Called when a message is deleted. The message has already been deleted from Discord when you receive this event.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type message_delete_t&, and returns void.

◆ on_message_delete_bulk

event_router_t<message_delete_bulk_t> dpp::cluster::on_message_delete_bulk

Called when multiple messages are deleted from a channel or DM.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type message_delete_bulk_t&, and returns void.

◆ on_message_reaction_add

event_router_t<message_reaction_add_t> dpp::cluster::on_message_reaction_add

Called when a new reaction is added to a message.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type message_reaction_add_t&, and returns void.

◆ on_message_reaction_remove

event_router_t<message_reaction_remove_t> dpp::cluster::on_message_reaction_remove

Called when a single reaction is removed from a message.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type message_reaction_remove_t&, and returns void.

◆ on_message_reaction_remove_all

event_router_t<message_reaction_remove_all_t> dpp::cluster::on_message_reaction_remove_all

Called when all reactions are removed from a message.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type message_reaction_remove_all_t&, and returns void.

◆ on_message_reaction_remove_emoji

event_router_t<message_reaction_remove_emoji_t> dpp::cluster::on_message_reaction_remove_emoji

Called when all reactions for a particular emoji are removed from a message.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type message_reaction_remove_emoji_t&, and returns void.

◆ on_message_update

event_router_t<message_update_t> dpp::cluster::on_message_update

Called when a message is updated (edited).

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type message_update_t&, and returns void.

◆ on_presence_update

event_router_t<presence_update_t> dpp::cluster::on_presence_update

Called when a user's presence is updated. To receive these you will need the GUILD_PRESENCES privileged intent. You will receive many of these, very often, and receiving them will significantly increase your bot's CPU usage. If you don't need them it is recommended to not ask for them.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type presence_update_t&, and returns void.

◆ on_ready

event_router_t<ready_t> dpp::cluster::on_ready

Called when a shard is connected and ready. A set of on_guild_create events will follow this event.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type ready_t&, and returns void.

◆ on_resumed

event_router_t<resumed_t> dpp::cluster::on_resumed

Called when a connection to a shard successfully resumes. A resumed session does not need to re-synchronise guilds, members, etc. This is generally non-fatal and informational only.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type resumed_t&, and returns void.

◆ on_select_click

event_router_t<select_click_t> dpp::cluster::on_select_click

Called when a select menu is clicked attached to a message. Select menu clicks are triggered by discord when select menus are clicked which you have associated with a message using dpp::component.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type select_click_t&, and returns void.

◆ on_stage_instance_create

event_router_t<stage_instance_create_t> dpp::cluster::on_stage_instance_create

Called when a new stage instance is created on a stage channel.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID.

◆ on_stage_instance_delete

event_router_t<stage_instance_delete_t> dpp::cluster::on_stage_instance_delete

Called when an existing stage instance is deleted from a stage channel.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type stage_instance_delete_t&, and returns void.

◆ on_stage_instance_update

event_router_t<stage_instance_update_t> dpp::cluster::on_stage_instance_update

Called when a stage instance is updated.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type stage_instance_update_t&, and returns void.

◆ on_thread_create

event_router_t<thread_create_t> dpp::cluster::on_thread_create

Called when a thread is created Note: Threads are not cached by D++, but a list of thread IDs is accessible in a guild object.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type thread_create_t&, and returns void.

◆ on_thread_delete

event_router_t<thread_delete_t> dpp::cluster::on_thread_delete

Called when a thread is deleted.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type thread_delete_t&, and returns void.

◆ on_thread_list_sync

event_router_t<thread_list_sync_t> dpp::cluster::on_thread_list_sync

Called when thread list is synced (upon gaining access to a channel) Note: Threads are not cached by D++, but a list of thread IDs is accessible in a guild object.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type thread_list_sync_t&, and returns void.

◆ on_thread_member_update

event_router_t<thread_member_update_t> dpp::cluster::on_thread_member_update

Called when current user's thread member object is updated.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type thread_member_update_t&, and returns void.

◆ on_thread_members_update

event_router_t<thread_members_update_t> dpp::cluster::on_thread_members_update

Called when a thread's member list is updated (without GUILD_MEMBERS intent, is only called for current user)

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type thread_members_update_t&, and returns void.

◆ on_thread_update

event_router_t<thread_update_t> dpp::cluster::on_thread_update

Called when a thread is updated.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type thread_update_t&, and returns void.

◆ on_typing_start

event_router_t<typing_start_t> dpp::cluster::on_typing_start

Called when a user is typing on a channel.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type typing_start_t&, and returns void.

◆ on_user_update

event_router_t<user_update_t> dpp::cluster::on_user_update

Called when a user is updated. This is separate to guild_member_update and includes things such as an avatar change, username change, discriminator change or change in subscription status for nitro.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type user_update_t&, and returns void.

◆ on_voice_buffer_send

event_router_t<voice_buffer_send_t> dpp::cluster::on_voice_buffer_send

Called when packets are sent from the voice buffer. The voice buffer contains packets that are already encoded with Opus and encrypted with Sodium, and merged into packets by the repacketizer, which is done in the dpp::discord_voice_client::send_audio method. You should use the buffer size properties of dpp::voice_buffer_send_t to determine if you should fill the buffer with more content.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_buffer_send_t&, and returns void.

◆ on_voice_client_disconnect

event_router_t<voice_client_disconnect_t> dpp::cluster::on_voice_client_disconnect

on voice client disconnect event

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_client_disconnect_t&, and returns void.

◆ on_voice_client_speaking

event_router_t<voice_client_speaking_t> dpp::cluster::on_voice_client_speaking

on voice client speaking event

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_client_speaking_t&, and returns void.

◆ on_voice_ready

event_router_t<voice_ready_t> dpp::cluster::on_voice_ready

Called when a voice channel is connected and ready to send audio. Note that this is not directly attached to the READY event of the websocket, as there is further connection that needs to be done before audio is ready to send.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_ready_t&, and returns void.

◆ on_voice_receive

event_router_t<voice_receive_t> dpp::cluster::on_voice_receive

Called when new audio data is received. Each separate user's audio from the voice channel will arrive tagged with their user id in the event, if a user can be attributed to the received audio.

Note
Receiving audio for bots is not officially supported by discord.
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_receive_t&, and returns void.

◆ on_voice_server_update

event_router_t<voice_server_update_t> dpp::cluster::on_voice_server_update

Called when we are told which voice server we can use. This will be sent either when we establish a new voice channel connection, or as discord rearrange their infrastructure.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_server_update_t&, and returns void.

◆ on_voice_state_update

event_router_t<voice_state_update_t> dpp::cluster::on_voice_state_update

on voice state update event

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_state_update_t&, and returns void.

◆ on_voice_track_marker

event_router_t<voice_track_marker_t> dpp::cluster::on_voice_track_marker

Called when sending of audio passes over a track marker. Track markers are arbitrarily placed "bookmarks" in the audio buffer, placed by the bot developer. Each track marker can have a string value associated with it which is specified in dpp::discord_voice_client::insert_marker and returned to this event.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_track_marker_t&, and returns void.

◆ on_voice_user_talking

event_router_t<voice_user_talking_t> dpp::cluster::on_voice_user_talking

Called when a user is talking on a voice channel.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type voice_user_talking_t&, and returns void.

◆ on_webhooks_update

event_router_t<webhooks_update_t> dpp::cluster::on_webhooks_update

Called when the webhooks for a guild are updated.

Note
Use operator() to attach a lambda to this event, and the detach method to detach the listener using the returned ID. The function signature for this event takes a single const reference of type webhooks_update_t&, and returns void.

◆ rest_ping

double dpp::cluster::rest_ping

REST latency (HTTPS ping) in seconds.

◆ token

std::string dpp::cluster::token

Current bot token for all shards on this cluster and all commands sent via HTTP.

◆ ws_mode

websocket_protocol_t dpp::cluster::ws_mode

Websocket mode for all shards in the cluster, either ws_json or ws_etf. Production bots should use ETF, while development bots should use JSON.

D++ Library version 10.0.29D++ Library version 10.0.28D++ Library version 10.0.27D++ Library version 10.0.26D++ Library version 10.0.25D++ Library version 10.0.24D++ Library version 10.0.23D++ Library version 10.0.22D++ Library version 10.0.21D++ Library version 10.0.20D++ Library version 10.0.19D++ Library version 10.0.18D++ Library version 10.0.17D++ Library version 10.0.16D++ Library version 10.0.15D++ Library version 10.0.14D++ Library version 10.0.13D++ Library version 10.0.12D++ Library version 10.0.11D++ Library version 10.0.10D++ Library version 10.0.9D++ Library version 10.0.8D++ Library version 10.0.7D++ Library version 10.0.6D++ Library version 10.0.5D++ Library version 10.0.4D++ Library version 10.0.3D++ Library version 10.0.2D++ Library version 10.0.1D++ Library version 10.0.0D++ Library version 9.0.19D++ Library version 9.0.18D++ Library version 9.0.17D++ Library version 9.0.16D++ Library version 9.0.15D++ Library version 9.0.14D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0