dpp::cluster
cluster.h
std::function< dpp::task< void >(const slashcommand_t &)> using dpp::cluster::co_slashcommand_handler_t = std::function<dpp::task<void>(const slashcommand_t&)> co_slashcommand_handler_t dpp::cluster::co_slashcommand_handler_t

Typedef for coroutines based slashcommand handler type.

std::function< void(const slashcommand_t &)> using dpp::cluster::slashcommand_handler_t = std::function<void(const slashcommand_t &)> slashcommand_handler_t dpp::cluster::slashcommand_handler_t

Typedef for slashcommand handler type.

std::variant< slashcommand_handler_t, co_slashcommand_handler_t > using dpp::cluster::slashcommand_handler_variant = std::variant<slashcommand_handler_t,co_slashcommand_handler_t> slashcommand_handler_variant dpp::cluster::slashcommand_handler_variant

Typedef for variant of coroutines based slashcommand handler type and regular version of it.

class friend class discord_client discord_client dpp::cluster::discord_client discord_client
class friend class discord_voice_client discord_voice_client dpp::cluster::discord_voice_client discord_voice_client
bool bool dpp::cluster::compressed compressed dpp::cluster::compressed

True if to use compression on shards.

std::string std::string dpp::cluster::default_gateway default_gateway dpp::cluster::default_gateway

default gateway for connecting the websocket.

timers_deleted_t timers_deleted_t dpp::cluster::deleted_timers deleted_timers dpp::cluster::deleted_timers

Ephemeral list of deleted timer ids.

std::unordered_map< snowflake, snowflake > std::unordered_map<snowflake, snowflake> dpp::cluster::dm_channels dm_channels dpp::cluster::dm_channels

Active DM channels for the bot.

std::mutex std::mutex dpp::cluster::dm_list_lock dm_list_lock dpp::cluster::dm_list_lock

Lock to prevent concurrent access to dm_channels.

std::thread std::thread dpp::cluster::engine_thread engine_thread dpp::cluster::engine_thread

Used to spawn the socket engine into its own thread if the cluster is started with dpp::st_return. It is unused otherwise.

std::map< std::string, slashcommand_handler_variant > std::map<std::string,slashcommand_handler_variant> dpp::cluster::named_commands named_commands dpp::cluster::named_commands

Container to store relation between command name and it's handler.

std::shared_mutex std::shared_mutex dpp::cluster::named_commands_mutex named_commands_mutex dpp::cluster::named_commands_mutex

Mutex to work with named_commands and synchronize read write access.

timer_next_t timer_next_t dpp::cluster::next_timer next_timer dpp::cluster::next_timer

Priority queue of of timers by time.

std::unique_ptr< thread_pool > std::unique_ptr<thread_pool> dpp::cluster::pool pool dpp::cluster::pool {nullptr}

Thread pool.

request_queue * request_queue* dpp::cluster::raw_rest raw_rest dpp::cluster::raw_rest

queue system for arbitrary HTTP requests sent by the user to sites other than Discord

reconnect_list reconnect_list dpp::cluster::reconnections reconnections dpp::cluster::reconnections

List of shards waiting for reconnection.

request_queue * request_queue* dpp::cluster::rest rest dpp::cluster::rest

queue system for commands sent to Discord, and any replies

shard_list shard_list dpp::cluster::shards shards dpp::cluster::shards

Active shards on this cluster. Shard IDs may have gaps between if there are multiple clusters.

std::shared_mutex std::shared_mutex dpp::cluster::shards_mutex shards_mutex dpp::cluster::shards_mutex

Mutex for protection of shards list.

time_t time_t dpp::cluster::start_time start_time dpp::cluster::start_time

Start time of cluster.

std::mutex std::mutex dpp::cluster::timer_guard timer_guard dpp::cluster::timer_guard

Protection mutex for timers.

struct discord_webhook_server * struct discord_webhook_server* dpp::cluster::webhook_server webhook_server dpp::cluster::webhook_server {nullptr}

Webhook server if enabled.

cache_policy_t cache_policy_t dpp::cluster::cache_policy cache_policy dpp::cluster::cache_policy

Current cache policy for the cluster.

uint32_t uint32_t dpp::cluster::cluster_id cluster_id dpp::cluster::cluster_id

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

uint32_t uint32_t dpp::cluster::intents intents dpp::cluster::intents

Current bitmask of gateway intents.

time_t time_t dpp::cluster::last_identify last_identify dpp::cluster::last_identify

Last time the bot sent an IDENTIFY.

uint32_t uint32_t dpp::cluster::maxclusters maxclusters dpp::cluster::maxclusters

Total number of clusters that are active.

dpp::user dpp::user dpp::cluster::me me 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.

uint32_t uint32_t dpp::cluster::numshards numshards dpp::cluster::numshards

Total number of shards across all clusters.

event_router_t< autocomplete_t > event_router_t<autocomplete_t> dpp::cluster::on_autocomplete on_autocomplete 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.

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.

event_router_t< automod_rule_create_t > event_router_t<automod_rule_create_t> dpp::cluster::on_automod_rule_create on_automod_rule_create dpp::cluster::on_automod_rule_create

Called when a new automod rule is created.

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create

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 automod_rule_create_t&, and returns void.

event_router_t< automod_rule_delete_t > event_router_t<automod_rule_delete_t> dpp::cluster::on_automod_rule_delete on_automod_rule_delete dpp::cluster::on_automod_rule_delete

Called when an automod rule is deleted.

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete

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 automod_rule_delete_t&, and returns void.

event_router_t< automod_rule_execute_t > event_router_t<automod_rule_execute_t> dpp::cluster::on_automod_rule_execute on_automod_rule_execute dpp::cluster::on_automod_rule_execute

Called when an automod rule is triggered/executed.

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution

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 automod_rule_execute_t&, and returns void.

event_router_t< automod_rule_update_t > event_router_t<automod_rule_update_t> dpp::cluster::on_automod_rule_update on_automod_rule_update dpp::cluster::on_automod_rule_update

Called when an automod rule is updated.

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update

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 automod_rule_update_t&, and returns void.

event_router_t< button_click_t > event_router_t<button_click_t> dpp::cluster::on_button_click on_button_click 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.

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.

event_router_t< channel_create_t > event_router_t<channel_create_t> dpp::cluster::on_channel_create on_channel_create dpp::cluster::on_channel_create

Called when a new channel is created on a guild.

If the cache policy has disabled channel caching, the pointer in this event will become invalid after the event ends. You should make a copy of any data you wish to preserve beyond this.

https://discord.com/developers/docs/topics/gateway-events#channel-create

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.

event_router_t< channel_delete_t > event_router_t<channel_delete_t> dpp::cluster::on_channel_delete on_channel_delete 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.

https://discord.com/developers/docs/topics/gateway-events#channel-delete

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.

event_router_t< channel_pins_update_t > event_router_t<channel_pins_update_t> dpp::cluster::on_channel_pins_update on_channel_pins_update 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.

https://discord.com/developers/docs/topics/gateway-events#channel-pins-update

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.

event_router_t< channel_update_t > event_router_t<channel_update_t> dpp::cluster::on_channel_update on_channel_update 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.

https://discord.com/developers/docs/topics/gateway-events#channel-update

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.

event_router_t< entitlement_create_t > event_router_t<entitlement_create_t> dpp::cluster::on_entitlement_create on_entitlement_create dpp::cluster::on_entitlement_create

Called when a user subscribes to an SKU.

https://discord.com/developers/docs/monetization/entitlements#new-entitlement

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.

event_router_t< entitlement_delete_t > event_router_t<entitlement_delete_t> dpp::cluster::on_entitlement_delete on_entitlement_delete dpp::cluster::on_entitlement_delete

Called when a user's entitlement is deleted. These events are infrequent and only occur if Discord issues a refund, or Discord removes an entitlement via "internal tooling". Entitlements are not deleted when they expire.

https://discord.com/developers/docs/monetization/entitlements#deleted-entitlement

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.

event_router_t< entitlement_update_t > event_router_t<entitlement_update_t> dpp::cluster::on_entitlement_update on_entitlement_update dpp::cluster::on_entitlement_update

Called when a user's subscription renews for the next billing period. The `ends_at` field will have an updated value with the new expiration date.

https://discord.com/developers/docs/monetization/entitlements#updated-entitlement

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.

event_router_t< form_submit_t > event_router_t<form_submit_t> dpp::cluster::on_form_submit on_form_submit 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.

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.

event_router_t< guild_audit_log_entry_create_t > event_router_t<guild_audit_log_entry_create_t> dpp::cluster::on_guild_audit_log_entry_create on_guild_audit_log_entry_create dpp::cluster::on_guild_audit_log_entry_create

Called when a guild audit log entry is created.

https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create

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_audit_log_entry_create_t&, and returns void.

event_router_t< guild_ban_add_t > event_router_t<guild_ban_add_t> dpp::cluster::on_guild_ban_add on_guild_ban_add dpp::cluster::on_guild_ban_add

Called when a ban is added to a guild.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-ban-add

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.

event_router_t< guild_ban_remove_t > event_router_t<guild_ban_remove_t> dpp::cluster::on_guild_ban_remove on_guild_ban_remove dpp::cluster::on_guild_ban_remove

Called when a ban is removed from a guild.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove

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.

event_router_t< guild_create_t > event_router_t<guild_create_t> dpp::cluster::on_guild_create on_guild_create 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.

If the cache policy has disabled guild caching, the pointer in this event will become invalid after the event ends. You should make a copy of any data you wish to preserve beyond this.

https://discord.com/developers/docs/topics/gateway-events#guild-create

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.

event_router_t< guild_delete_t > event_router_t<guild_delete_t> dpp::cluster::on_guild_delete on_guild_delete 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::cluster::guild_delete, or via the guild being unavailable due to an outage.

https://discord.com/developers/docs/topics/gateway-events#guild-delete

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.

event_router_t< guild_emojis_update_t > event_router_t<guild_emojis_update_t> dpp::cluster::on_guild_emojis_update on_guild_emojis_update dpp::cluster::on_guild_emojis_update

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

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update

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.

event_router_t< guild_integrations_update_t > event_router_t<guild_integrations_update_t> dpp::cluster::on_guild_integrations_update on_guild_integrations_update 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.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update

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.

event_router_t< guild_join_request_delete_t > event_router_t<guild_join_request_delete_t> dpp::cluster::on_guild_join_request_delete on_guild_join_request_delete dpp::cluster::on_guild_join_request_delete

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

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.

event_router_t< guild_member_add_t > event_router_t<guild_member_add_t> dpp::cluster::on_guild_member_add on_guild_member_add dpp::cluster::on_guild_member_add

Called when a new member joins a guild.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-member-add

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.

event_router_t< guild_member_remove_t > event_router_t<guild_member_remove_t> dpp::cluster::on_guild_member_remove on_guild_member_remove dpp::cluster::on_guild_member_remove

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

https://discord.com/developers/docs/topics/gateway-events#guild-member-remove

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.

event_router_t< guild_member_update_t > event_router_t<guild_member_update_t> dpp::cluster::on_guild_member_update on_guild_member_update dpp::cluster::on_guild_member_update

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

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-member-update

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.

event_router_t< guild_members_chunk_t > event_router_t<guild_members_chunk_t> dpp::cluster::on_guild_members_chunk on_guild_members_chunk 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 cluster::on_guild_create events.

https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk

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.

event_router_t< guild_role_create_t > event_router_t<guild_role_create_t> dpp::cluster::on_guild_role_create on_guild_role_create dpp::cluster::on_guild_role_create

Called when a new role is created on a guild.

https://discord.com/developers/docs/topics/gateway-events#guild-role-create

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.

event_router_t< guild_role_delete_t > event_router_t<guild_role_delete_t> dpp::cluster::on_guild_role_delete on_guild_role_delete dpp::cluster::on_guild_role_delete

Called when a role is deleted in a guild.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-role-delete

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.

event_router_t< guild_role_update_t > event_router_t<guild_role_update_t> dpp::cluster::on_guild_role_update on_guild_role_update dpp::cluster::on_guild_role_update

Called when an existing role is updated on a guild.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-role-update

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.

event_router_t< guild_scheduled_event_create_t > event_router_t<guild_scheduled_event_create_t> dpp::cluster::on_guild_scheduled_event_create on_guild_scheduled_event_create dpp::cluster::on_guild_scheduled_event_create

Called when a new scheduled event is created.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create

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.

event_router_t< guild_scheduled_event_delete_t > event_router_t<guild_scheduled_event_delete_t> dpp::cluster::on_guild_scheduled_event_delete on_guild_scheduled_event_delete dpp::cluster::on_guild_scheduled_event_delete

Called when a new scheduled event is deleted.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete

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.

event_router_t< guild_scheduled_event_update_t > event_router_t<guild_scheduled_event_update_t> dpp::cluster::on_guild_scheduled_event_update on_guild_scheduled_event_update dpp::cluster::on_guild_scheduled_event_update

Called when a new scheduled event is updated.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update

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.

event_router_t< guild_scheduled_event_user_add_t > event_router_t<guild_scheduled_event_user_add_t> dpp::cluster::on_guild_scheduled_event_user_add on_guild_scheduled_event_user_add dpp::cluster::on_guild_scheduled_event_user_add

Called when a user is added to a scheduled event.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add

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.

event_router_t< guild_scheduled_event_user_remove_t > event_router_t<guild_scheduled_event_user_remove_t> dpp::cluster::on_guild_scheduled_event_user_remove on_guild_scheduled_event_user_remove dpp::cluster::on_guild_scheduled_event_user_remove

Called when a user is removed from a scheduled event.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove

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.

event_router_t< guild_stickers_update_t > event_router_t<guild_stickers_update_t> dpp::cluster::on_guild_stickers_update on_guild_stickers_update dpp::cluster::on_guild_stickers_update

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

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update

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.

event_router_t< guild_update_t > event_router_t<guild_update_t> dpp::cluster::on_guild_update on_guild_update dpp::cluster::on_guild_update

Called when details of a guild are updated.

If the cache policy has disabled guild caching, the pointer in this event will become invalid after the event ends. You should make a copy of any data you wish to preserve beyond this. If the guild cache is disabled, only changed elements in the updated guild object will be set. all other values will be empty or defaults.

https://discord.com/developers/docs/topics/gateway-events#guild-update

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.

event_router_t< integration_create_t > event_router_t<integration_create_t> dpp::cluster::on_integration_create on_integration_create 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.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#integration-create

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.

event_router_t< integration_delete_t > event_router_t<integration_delete_t> dpp::cluster::on_integration_delete on_integration_delete 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.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#integration-delete

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.

event_router_t< integration_update_t > event_router_t<integration_update_t> dpp::cluster::on_integration_update on_integration_update 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.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#integration-update

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.

event_router_t< interaction_create_t > event_router_t<interaction_create_t> dpp::cluster::on_interaction_create on_interaction_create 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.

https://discord.com/developers/docs/topics/gateway-events#interaction-create

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.

There are dedicated events to handle slashcommands (See dpp::cluster::on_slashcommand), user context menus (See dpp::cluster::on_user_context_menu) and message context menus (See dpp::cluster::on_message_context_menu)

event_router_t< invite_create_t > event_router_t<invite_create_t> dpp::cluster::on_invite_create on_invite_create dpp::cluster::on_invite_create

Called when a new invite is created for a guild.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#invite-create

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.

event_router_t< invite_delete_t > event_router_t<invite_delete_t> dpp::cluster::on_invite_delete on_invite_delete dpp::cluster::on_invite_delete

Called when an invite is deleted from a guild.

https://discord.com/developers/docs/topics/gateway-events#invite-delete

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.

event_router_t< log_t > event_router_t<log_t> dpp::cluster::on_log on_log 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.

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.

event_router_t< message_context_menu_t > event_router_t<message_context_menu_t> dpp::cluster::on_message_context_menu on_message_context_menu dpp::cluster::on_message_context_menu

Called when a user right-clicks or long-presses on a message, where a slash command is bound to the dpp::ctxm_message command type.

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_context_menu_t&, and returns void.

event_router_t< message_create_t > event_router_t<message_create_t> dpp::cluster::on_message_create on_message_create 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. For an example for caching of messages, please see Caching Messages.

https://discord.com/developers/docs/topics/gateway-events#message-create

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.

event_router_t< message_delete_t > event_router_t<message_delete_t> dpp::cluster::on_message_delete on_message_delete dpp::cluster::on_message_delete

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

https://discord.com/developers/docs/topics/gateway-events#message-delete

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.

event_router_t< message_delete_bulk_t > event_router_t<message_delete_bulk_t> dpp::cluster::on_message_delete_bulk on_message_delete_bulk dpp::cluster::on_message_delete_bulk

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

https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk

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.

event_router_t< message_poll_vote_add_t > event_router_t<message_poll_vote_add_t> dpp::cluster::on_message_poll_vote_add on_message_poll_vote_add dpp::cluster::on_message_poll_vote_add

Called when a vote is added to a message poll.

https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add

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_poll_vote_add_t&, and returns void.

event_router_t< message_poll_vote_remove_t > event_router_t<message_poll_vote_remove_t> dpp::cluster::on_message_poll_vote_remove on_message_poll_vote_remove dpp::cluster::on_message_poll_vote_remove

Called when a vote is removed from a message poll.

https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove

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_poll_vote_remove_t&, and returns void.

event_router_t< message_reaction_add_t > event_router_t<message_reaction_add_t> dpp::cluster::on_message_reaction_add on_message_reaction_add dpp::cluster::on_message_reaction_add

Called when a new reaction is added to a message.

https://discord.com/developers/docs/topics/gateway-events#message-reaction-add

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.

event_router_t< message_reaction_remove_t > event_router_t<message_reaction_remove_t> dpp::cluster::on_message_reaction_remove on_message_reaction_remove dpp::cluster::on_message_reaction_remove

Called when a single reaction is removed from a message.

https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove

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.

event_router_t< message_reaction_remove_all_t > event_router_t<message_reaction_remove_all_t> dpp::cluster::on_message_reaction_remove_all on_message_reaction_remove_all dpp::cluster::on_message_reaction_remove_all

Called when all reactions are removed from a message.

https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all

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.

event_router_t< message_reaction_remove_emoji_t > event_router_t<message_reaction_remove_emoji_t> dpp::cluster::on_message_reaction_remove_emoji on_message_reaction_remove_emoji dpp::cluster::on_message_reaction_remove_emoji

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

https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji

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.

event_router_t< message_update_t > event_router_t<message_update_t> dpp::cluster::on_message_update on_message_update dpp::cluster::on_message_update

Called when a message is updated (edited).

https://discord.com/developers/docs/topics/gateway-events#message-update

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.

event_router_t< presence_update_t > event_router_t<presence_update_t> dpp::cluster::on_presence_update on_presence_update 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.

https://discord.com/developers/docs/topics/gateway-events#presence-update

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.

event_router_t< ready_t > event_router_t<ready_t> dpp::cluster::on_ready on_ready dpp::cluster::on_ready

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

https://discord.com/developers/docs/topics/gateway-events#ready

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.

event_router_t< resumed_t > event_router_t<resumed_t> dpp::cluster::on_resumed on_resumed 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.

https://discord.com/developers/docs/topics/gateway-events#resumed

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.

event_router_t< select_click_t > event_router_t<select_click_t> dpp::cluster::on_select_click on_select_click 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.

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.

event_router_t< slashcommand_t > event_router_t<slashcommand_t> dpp::cluster::on_slashcommand on_slashcommand dpp::cluster::on_slashcommand

Called when a slash command is issued. Only dpp::ctxm_chat_input types of interaction are routed to this event. For an example of this in action please see Using Slash Commands and Interactions.

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 slashcommand_t&, and returns void.

event_router_t< socket_close_t > event_router_t<socket_close_t> dpp::cluster::on_socket_close on_socket_close dpp::cluster::on_socket_close

Called when a file descriptor is removed from the socket engine.

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 socket_close_t&, and returns void.

event_router_t< stage_instance_create_t > event_router_t<stage_instance_create_t> dpp::cluster::on_stage_instance_create on_stage_instance_create dpp::cluster::on_stage_instance_create

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

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#stage-instance-create

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_create_t&, and returns void.

event_router_t< stage_instance_delete_t > event_router_t<stage_instance_delete_t> dpp::cluster::on_stage_instance_delete on_stage_instance_delete dpp::cluster::on_stage_instance_delete

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

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete

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.

event_router_t< stage_instance_update_t > event_router_t<stage_instance_update_t> dpp::cluster::on_stage_instance_update on_stage_instance_update dpp::cluster::on_stage_instance_update

Called when a stage instance is updated.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#stage-instance-update

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.

event_router_t< thread_create_t > event_router_t<thread_create_t> dpp::cluster::on_thread_create on_thread_create dpp::cluster::on_thread_create

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

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#thread-create

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.

event_router_t< thread_delete_t > event_router_t<thread_delete_t> dpp::cluster::on_thread_delete on_thread_delete dpp::cluster::on_thread_delete

Called when a thread is deleted.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#thread-delete

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.

event_router_t< thread_list_sync_t > event_router_t<thread_list_sync_t> dpp::cluster::on_thread_list_sync on_thread_list_sync dpp::cluster::on_thread_list_sync

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

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#thread-list-sync

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.

event_router_t< thread_member_update_t > event_router_t<thread_member_update_t> dpp::cluster::on_thread_member_update on_thread_member_update dpp::cluster::on_thread_member_update

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

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#thread-member-update

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.

event_router_t< thread_members_update_t > event_router_t<thread_members_update_t> dpp::cluster::on_thread_members_update on_thread_members_update 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).

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#thread-members-update

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.

event_router_t< thread_update_t > event_router_t<thread_update_t> dpp::cluster::on_thread_update on_thread_update dpp::cluster::on_thread_update

Called when a thread is updated.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

https://discord.com/developers/docs/topics/gateway-events#thread-update

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.

event_router_t< typing_start_t > event_router_t<typing_start_t> dpp::cluster::on_typing_start on_typing_start dpp::cluster::on_typing_start

Called when a user is typing on a channel.

https://discord.com/developers/docs/topics/gateway-events#typing-start

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.

event_router_t< user_context_menu_t > event_router_t<user_context_menu_t> dpp::cluster::on_user_context_menu on_user_context_menu dpp::cluster::on_user_context_menu

Called when a user right-clicks or long-presses on a user, where a slash command is bound to the dpp::ctxm_user command type.

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_context_menu_t&, and returns void.

event_router_t< user_update_t > event_router_t<user_update_t> dpp::cluster::on_user_update on_user_update dpp::cluster::on_user_update

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

https://discord.com/developers/docs/topics/gateway-events#user-update

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.

event_router_t< voice_buffer_send_t > event_router_t<voice_buffer_send_t> dpp::cluster::on_voice_buffer_send on_voice_buffer_send 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 XChaCha20-Poly1305, 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.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

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.

event_router_t< voice_channel_effect_send_t > event_router_t<voice_channel_effect_send_t> dpp::cluster::on_voice_channel_effect_send on_voice_channel_effect_send dpp::cluster::on_voice_channel_effect_send

on voice channel effect send event

https://discord.com/developers/docs/events/gateway-events#voice-channel-effect-send

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_channel_effect_send_t&, and returns void.

event_router_t< voice_client_disconnect_t > event_router_t<voice_client_disconnect_t> dpp::cluster::on_voice_client_disconnect on_voice_client_disconnect dpp::cluster::on_voice_client_disconnect

on voice client disconnect event

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.

event_router_t< voice_client_platform_t > event_router_t<voice_client_platform_t> dpp::cluster::on_voice_client_platform on_voice_client_platform dpp::cluster::on_voice_client_platform

on voice client platform event After a client connects, or on joining a vc, you will receive the platform type of each client. This is either desktop or mobile.

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.

event_router_t< voice_client_speaking_t > event_router_t<voice_client_speaking_t> dpp::cluster::on_voice_client_speaking on_voice_client_speaking dpp::cluster::on_voice_client_speaking

on voice client speaking event

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.

event_router_t< voice_ready_t > event_router_t<voice_ready_t> dpp::cluster::on_voice_ready on_voice_ready 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.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

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.

event_router_t< voice_receive_t > event_router_t<voice_receive_t> dpp::cluster::on_voice_receive on_voice_receive 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.

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.

event_router_t< voice_receive_t > event_router_t<voice_receive_t> dpp::cluster::on_voice_receive_combined on_voice_receive_combined dpp::cluster::on_voice_receive_combined

Called when new audio data is received, combined and mixed for all speaking users.

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.

event_router_t< voice_server_update_t > event_router_t<voice_server_update_t> dpp::cluster::on_voice_server_update on_voice_server_update 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.

If the cache policy has disabled guild caching, the pointer to the guild in this event may be nullptr.

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.

event_router_t< voice_state_update_t > event_router_t<voice_state_update_t> dpp::cluster::on_voice_state_update on_voice_state_update dpp::cluster::on_voice_state_update

on voice state update event

https://discord.com/developers/docs/topics/gateway-events#voice-state-update

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.

event_router_t< voice_track_marker_t > event_router_t<voice_track_marker_t> dpp::cluster::on_voice_track_marker on_voice_track_marker 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.

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.

event_router_t< webhooks_update_t > event_router_t<webhooks_update_t> dpp::cluster::on_webhooks_update on_webhooks_update dpp::cluster::on_webhooks_update

Called when the webhooks for a guild are updated.

https://discord.com/developers/docs/topics/gateway-events#webhooks-update

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.

uint16_t uint16_t dpp::cluster::request_timeout request_timeout dpp::cluster::request_timeout = 60

The time (in seconds) that a request is allowed to take.

double double dpp::cluster::rest_ping rest_ping dpp::cluster::rest_ping

REST latency (HTTPS ping) in seconds.

std::unique_ptr< socket_engine_base > std::unique_ptr<socket_engine_base> dpp::cluster::socketengine socketengine dpp::cluster::socketengine

Socket engine instance.

std::atomic_bool std::atomic_bool dpp::cluster::terminating terminating dpp::cluster::terminating {false}

Atomic bool to set to true when the cluster is terminating.

D++ itself does not set this value, it is for library users to set if they want the cluster to terminate outside of a flow where they may have simple access to destruct the cluster object.

std::string std::string dpp::cluster::token token dpp::cluster::token

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

websocket_protocol_t websocket_protocol_t dpp::cluster::ws_mode ws_mode 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.

void void dpp::cluster::add_reconnect (uint32_t shard_id) add_reconnect dpp::cluster::add_reconnect uint32_t shard_id

Mark a shard as requiring reconnection. Destructs the old shard in 5 seconds and creates a new one attempting to resume.

shard_id

Shard ID

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

dpp::cluster is non-moveable

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

dpp::cluster is non-copyable

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=cache_policy::cpol_default, uint32_t pool_threads=std::thread::hardware_concurrency()/2)
cluster
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 cache_policy::cpol_default
uint32_t pool_threads std::thread::hardware_concurrency()/2

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

token

The bot token to use for all HTTP commands and websocket connections

intents

A bitmask of dpd::intents values for all shards on this cluster. This is required to be sent for all bots with over 100 servers.

shards

The 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_id

The ID of this cluster, should be between 0 and MAXCLUSTERS-1

maxclusters

The total number of clusters that are active, which may be on separate processes or even separate machines.

compressed

Whether or not to use compression for shards on this cluster. Saves a ton of bandwidth at the cost of some CPU

policy

Set the 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)

pool_threads

The number of threads to allocate for the thread pool. This defaults to half your system concurrency and if set to a number less than 4, will default to 4. All callbacks and events are placed into the thread pool. The bigger you make this pool (but generally no bigger than your number of cores), the more your bot will scale.

dpp::exception

Thrown on windows, if WinSock fails to initialise, or on any other system if a dpp::request_queue fails to construct

dpp::cluster::cluster
(uint32_t pool_threads=std::thread::hardware_concurrency()/2)
cluster
dpp::cluster::cluster
uint32_t pool_threads std::thread::hardware_concurrency()/2

Constructor for creating a cluster without a token. A cluster created without a token has no shards, and just runs the event loop. You can use this to make asynchronous HTTP requests via e.g. dpp::cluster::request without having to connect to a websocket to receive shard events.

pool_threads

The number of threads to allocate for the thread pool. This defaults to half your system concurrency and if set to a number less than 4, will default to 4. All callbacks and events are placed into the thread pool. The bigger you make this pool (but generally no bigger than your number of cores), the more your bot will scale.

dpp::exception

Thrown on windows, if WinSock fails to initialise, or on any other system if a dpp::request_queue fails to construct

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

Destroy the cluster object.

size_t size_t dpp::cluster::active_requests () active_requests dpp::cluster::active_requests

Get the number of currently active HTTP(S) requests active in the cluster. This total includes all in-flight API requests and calls to dpp::cluster::request(). Note that once a request is passed to the thread pool it is no longer counted here.

Total active request count

void void dpp::cluster::application_emoji_create (const class emoji &newemoji, command_completion_event_t callback=utility::log_error()) application_emoji_create dpp::cluster::application_emoji_create const class emoji & newemoji command_completion_event_t callback utility::log_error()

Create an Application Emoji.

https://discord.com/developers/docs/resources/emoji#create-application-emoji

newemoji

The emoji to create

callback

Function 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().

void void dpp::cluster::application_emoji_delete (snowflake emoji_id, command_completion_event_t callback=utility::log_error()) application_emoji_delete dpp::cluster::application_emoji_delete snowflake emoji_id command_completion_event_t callback utility::log_error()

Delete an Application Emoji.

https://discord.com/developers/docs/resources/emoji#delete-application-emoji

emoji_id

The emoji's ID to delete.

callback

Function 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().

void void dpp::cluster::application_emoji_edit (const class emoji &newemoji, command_completion_event_t callback=utility::log_error()) application_emoji_edit dpp::cluster::application_emoji_edit const class emoji & newemoji command_completion_event_t callback utility::log_error()

Edit an Application Emoji.

https://discord.com/developers/docs/resources/emoji#modify-application-emoji

newemoji

The emoji to edit

callback

Function 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().

void void dpp::cluster::application_emoji_get (snowflake emoji_id, command_completion_event_t callback=utility::log_error()) application_emoji_get dpp::cluster::application_emoji_get snowflake emoji_id command_completion_event_t callback utility::log_error()

Get an Application Emoji.

https://discord.com/developers/docs/resources/emoji#get-application-emoji

emoji_id

The ID of the Emoji to get.

callback

Function 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().

void void dpp::cluster::application_emojis_get (command_completion_event_t callback=utility::log_error()) application_emojis_get dpp::cluster::application_emojis_get command_completion_event_t callback utility::log_error()

List all Application Emojis.

https://discord.com/developers/docs/resources/emoji#list-application-emojis

callback

Function 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().

void void dpp::cluster::application_role_connection_get (snowflake application_id, command_completion_event_t callback) application_role_connection_get dpp::cluster::application_role_connection_get snowflake application_id command_completion_event_t callback

Get the application's role connection metadata records.

https://discord.com/developers/docs/resources/application-role-connection-metadata#get-application-role-connection-metadata-records

application_id

The application ID

callback

Function to call when the API call completes. On success the callback will contain a dpp::application_role_connection_metadata_list 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().

void void dpp::cluster::application_role_connection_update (snowflake application_id, const std::vector< application_role_connection_metadata > &connection_metadata, command_completion_event_t callback=utility::log_error()) application_role_connection_update dpp::cluster::application_role_connection_update snowflake application_id const std::vector< application_role_connection_metadata > & connection_metadata command_completion_event_t callback utility::log_error()

Update the application's role connection metadata records.

https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records

application_id

The application ID

connection_metadata

The application role connection metadata to update

callback

Function to call when the API call completes. On success the callback will contain a dpp::application_role_connection_metadata_list 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().

An application can have a maximum of 5 metadata records.

void void dpp::cluster::automod_rule_create (snowflake guild_id, const automod_rule &r, command_completion_event_t callback=utility::log_error()) automod_rule_create dpp::cluster::automod_rule_create snowflake guild_id const automod_rule & r command_completion_event_t callback utility::log_error()

Create an auto moderation rule.

guild_id

Guild id of the auto moderation rule

r

Auto moderation rule to create

callback

Function to call when the API call completes. On success the callback will contain a dpp::automod_rule 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().

void void dpp::cluster::automod_rule_delete (snowflake guild_id, snowflake rule_id, command_completion_event_t callback=utility::log_error()) automod_rule_delete dpp::cluster::automod_rule_delete snowflake guild_id snowflake rule_id command_completion_event_t callback utility::log_error()

Delete an auto moderation rule.

guild_id

Guild id of the auto moderation rule

rule_id

Auto moderation rule id to delete

callback

Function 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().

void void dpp::cluster::automod_rule_edit (snowflake guild_id, const automod_rule &r, command_completion_event_t callback=utility::log_error()) automod_rule_edit dpp::cluster::automod_rule_edit snowflake guild_id const automod_rule & r command_completion_event_t callback utility::log_error()

Edit an auto moderation rule.

guild_id

Guild id of the auto moderation rule

r

Auto moderation rule to edit. The rule's id must be set.

callback

Function to call when the API call completes. On success the callback will contain a dpp::automod_rule 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().

void void dpp::cluster::automod_rule_get (snowflake guild_id, snowflake rule_id, command_completion_event_t callback) automod_rule_get dpp::cluster::automod_rule_get snowflake guild_id snowflake rule_id command_completion_event_t callback

Get a single auto moderation rule.

guild_id

Guild id of the auto moderation rule

rule_id

Rule id to retrieve

callback

Function to call when the API call completes. On success the callback will contain a dpp::automod_rule 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().

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

Get all auto moderation rules for a guild.

guild_id

Guild id of the auto moderation rule

callback

Function to call when the API call completes. On success the callback will contain a dpp::automod_rule_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().

void void dpp::cluster::channel_create (const class channel &c, command_completion_event_t callback=utility::log_error()) channel_create dpp::cluster::channel_create const class channel & c command_completion_event_t callback utility::log_error()

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`

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#create-channel

c

Channel to create

callback

Function 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().

void void dpp::cluster::channel_delete (snowflake channel_id, command_completion_event_t callback=utility::log_error()) channel_delete dpp::cluster::channel_delete snowflake channel_id command_completion_event_t callback utility::log_error()

Delete a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#deleteclose-channel

channel_id

Channel id to delete

callback

Function 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().

void void dpp::cluster::channel_delete_permission (const class channel &c, snowflake overwrite_id, command_completion_event_t callback=utility::log_error()) channel_delete_permission dpp::cluster::channel_delete_permission const class channel & c snowflake overwrite_id command_completion_event_t callback utility::log_error()

Remove a permission from a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#delete-channel-permission

c

Channel to remove permission from

overwrite_id

Overwrite to remove, user or channel ID

callback

Function 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().

void void dpp::cluster::channel_edit (const class channel &c, command_completion_event_t callback=utility::log_error()) channel_edit dpp::cluster::channel_edit const class channel & c command_completion_event_t callback utility::log_error()

Edit a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#modify-channel

c

Channel to edit/update

callback

Function 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().

void void dpp::cluster::channel_edit_permissions (const class channel &c, const snowflake overwrite_id, const uint64_t allow, const uint64_t deny, const bool member, command_completion_event_t callback=utility::log_error()) channel_edit_permissions dpp::cluster::channel_edit_permissions const class channel & c const snowflake overwrite_id const uint64_t allow const uint64_t deny const bool member command_completion_event_t callback utility::log_error()

Edit a channel's permissions.

https://discord.com/developers/docs/resources/channel#edit-channel-permissions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

c

Channel to set permissions for

overwrite_id

Overwrite to change (a user or role ID)

allow

Bitmask of allowed permissions (refer to enum dpp::permissions)

deny

Bitmask of denied permissions (refer to enum dpp::permissions)

member

true if the overwrite_id is a user id, false if it is a channel id

callback

Function 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().

void void dpp::cluster::channel_edit_permissions (const snowflake channel_id, const snowflake overwrite_id, const uint64_t allow, const uint64_t deny, const bool member, command_completion_event_t callback=utility::log_error()) channel_edit_permissions dpp::cluster::channel_edit_permissions const snowflake channel_id const snowflake overwrite_id const uint64_t allow const uint64_t deny const bool member command_completion_event_t callback utility::log_error()

Edit a channel's permissions.

https://discord.com/developers/docs/resources/channel#edit-channel-permissions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

channel_id

ID of the channel to set permissions for

overwrite_id

Overwrite to change (a user or role ID)

allow

Bitmask of allowed permissions (refer to enum dpp::permissions)

deny

Bitmask of denied permissions (refer to enum dpp::permissions)

member

true if the overwrite_id is a user id, false if it is a channel id

callback

Function 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().

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

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.

https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

c

Channel to change the position for

callback

Function 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().

void void dpp::cluster::channel_follow_news (const class channel &c, snowflake target_channel_id, command_completion_event_t callback=utility::log_error()) channel_follow_news dpp::cluster::channel_follow_news const class channel & c snowflake target_channel_id command_completion_event_t callback utility::log_error()

Follow an announcement (news) channel.

https://discord.com/developers/docs/resources/channel#follow-news-channel

c

Channel id to follow

target_channel_id

Channel to subscribe the channel to

callback

Function 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().

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

Get a channel.

https://discord.com/developers/docs/resources/channel#get-channel

c

Channel ID to retrieve

callback

Function 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().

void void dpp::cluster::channel_invite_create (const class channel &c, const class invite &i, command_completion_event_t callback=utility::log_error()) channel_invite_create dpp::cluster::channel_invite_create const class channel & c const class invite & i command_completion_event_t callback utility::log_error()

Create invite for a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#create-channel-invite

c

Channel to create an invite on

i

Invite to create

callback

Function 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().

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

Get invites for a channel.

https://discord.com/developers/docs/resources/invite#get-invites

c

Channel to get invites for

callback

Function 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().

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

Get a channel's pins.

https://discord.com/developers/docs/resources/channel#get-pinned-messages

channel_id

Channel ID to get pins for

callback

Function to call when the API call completes. On success the callback will contain a dpp::message_pin_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().

void void dpp::cluster::channel_pins_get (snowflake channel_id, std::optional< time_t > before, std::optional< uint64_t > limit, command_completion_event_t callback) channel_pins_get dpp::cluster::channel_pins_get snowflake channel_id std::optional< time_t > before std::optional< uint64_t > limit command_completion_event_t callback

Get a channel's pins.

https://discord.com/developers/docs/resources/channel#get-pinned-messages

channel_id

Channel ID to get pins for

before

Get messages pinned before this timestamp.

limit

Max number of pins to return (1-50). Defaults to 50 if not set.

callback

Function to call when the API call completes. On success the callback will contain a dpp::message_pin_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().

void void dpp::cluster::channel_set_voice_status (snowflake channel_id, const std::string &status, command_completion_event_t callback=utility::log_error()) channel_set_voice_status dpp::cluster::channel_set_voice_status snowflake channel_id const std::string & status command_completion_event_t callback utility::log_error()

Set the status of a voice channel.

https://github.com/discord/discord-api-docs/pull/6400 (please replace soon).

channel_id

The channel to update.

status

The new status for the channel.

callback

Function 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().

void void dpp::cluster::channel_typing (const class channel &c, command_completion_event_t callback=utility::log_error()) channel_typing dpp::cluster::channel_typing const class channel & c command_completion_event_t callback utility::log_error()

Trigger channel typing indicator.

https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

c

Channel to set as typing on

callback

Function 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().

void void dpp::cluster::channel_typing (snowflake cid, command_completion_event_t callback=utility::log_error()) channel_typing dpp::cluster::channel_typing snowflake cid command_completion_event_t callback utility::log_error()

Trigger channel typing indicator.

https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

cid

Channel ID to set as typing on

callback

Function 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().

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

Get all channels for a guild.

https://discord.com/developers/docs/resources/channel#get-channels

guild_id

Guild ID to retrieve channels for

callback

Function 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().

cluster & cluster & dpp::cluster::clear_audit_reason () clear_audit_reason 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'tbesent")
    .clear_audit_reason()
    .channel_delete(my_channel_id);

cluster& Reference to self for chaining.

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emoji_create (const class emoji &newemoji) co_application_emoji_create dpp::cluster::co_application_emoji_create const class emoji & newemoji

Create an Application Emoji.

dpp::cluster::application_emoji_create

https://discord.com/developers/docs/resources/emoji#create-application-emoji

newemoji

The emoji to create

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emoji_create (const class emoji &newemoji) co_application_emoji_create dpp::cluster::co_application_emoji_create const class emoji & newemoji

Create an Application Emoji.

dpp::cluster::application_emoji_create

https://discord.com/developers/docs/resources/emoji#create-application-emoji

newemoji

The emoji to create

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emoji_delete (snowflake emoji_id) co_application_emoji_delete dpp::cluster::co_application_emoji_delete snowflake emoji_id

Delete an Application Emoji.

dpp::cluster::application_emoji_delete

https://discord.com/developers/docs/resources/emoji#delete-application-emoji

emoji_id

The emoji's ID to delete.

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emoji_delete (snowflake emoji_id) co_application_emoji_delete dpp::cluster::co_application_emoji_delete snowflake emoji_id

Delete an Application Emoji.

dpp::cluster::application_emoji_delete

https://discord.com/developers/docs/resources/emoji#delete-application-emoji

emoji_id

The emoji's ID to delete.

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emoji_edit (const class emoji &newemoji) co_application_emoji_edit dpp::cluster::co_application_emoji_edit const class emoji & newemoji

Edit an Application Emoji.

dpp::cluster::application_emoji_edit

https://discord.com/developers/docs/resources/emoji#modify-application-emoji

newemoji

The emoji to edit

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emoji_edit (const class emoji &newemoji) co_application_emoji_edit dpp::cluster::co_application_emoji_edit const class emoji & newemoji

Edit an Application Emoji.

dpp::cluster::application_emoji_edit

https://discord.com/developers/docs/resources/emoji#modify-application-emoji

newemoji

The emoji to edit

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emoji_get (snowflake emoji_id) co_application_emoji_get dpp::cluster::co_application_emoji_get snowflake emoji_id

Get an Application Emoji.

dpp::cluster::application_emoji_get

https://discord.com/developers/docs/resources/emoji#get-application-emoji

emoji_id

The ID of the Emoji to get.

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emoji_get (snowflake emoji_id) co_application_emoji_get dpp::cluster::co_application_emoji_get snowflake emoji_id

Get an Application Emoji.

dpp::cluster::application_emoji_get

https://discord.com/developers/docs/resources/emoji#get-application-emoji

emoji_id

The ID of the Emoji to get.

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emojis_get () co_application_emojis_get dpp::cluster::co_application_emojis_get

List all Application Emojis.

dpp::cluster::application_emojis_get

https://discord.com/developers/docs/resources/emoji#list-application-emojis

emoji_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_emojis_get () co_application_emojis_get dpp::cluster::co_application_emojis_get

List all Application Emojis.

dpp::cluster::application_emojis_get

https://discord.com/developers/docs/resources/emoji#list-application-emojis

emoji_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_role_connection_get (snowflake application_id) co_application_role_connection_get dpp::cluster::co_application_role_connection_get snowflake application_id

Get the application's role connection metadata records.

dpp::cluster::application_role_connection_get

https://discord.com/developers/docs/resources/application-role-connection-metadata#get-application-role-connection-metadata-records

application_id

The application ID

application_role_connection_metadata_list returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_role_connection_get (snowflake application_id) co_application_role_connection_get dpp::cluster::co_application_role_connection_get snowflake application_id

Get the application's role connection metadata records.

dpp::cluster::application_role_connection_get

https://discord.com/developers/docs/resources/application-role-connection-metadata#get-application-role-connection-metadata-records

application_id

The application ID

application_role_connection_metadata_list returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_application_role_connection_update (snowflake application_id, const std::vector< application_role_connection_metadata > &connection_metadata) co_application_role_connection_update dpp::cluster::co_application_role_connection_update snowflake application_id const std::vector< application_role_connection_metadata > & connection_metadata

Update the application's role connection metadata records.

dpp::cluster::application_role_connection_update

https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records

application_id

The application ID

connection_metadata

The application role connection metadata to update

application_role_connection_metadata_list returned object on completion

An application can have a maximum of 5 metadata records.

async< confirmation_callback_t > async< confirmation_callback_t > co_application_role_connection_update (snowflake application_id, const std::vector< application_role_connection_metadata > &connection_metadata) co_application_role_connection_update dpp::cluster::co_application_role_connection_update snowflake application_id const std::vector< application_role_connection_metadata > & connection_metadata

Update the application's role connection metadata records.

dpp::cluster::application_role_connection_update

https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records

application_id

The application ID

connection_metadata

The application role connection metadata to update

application_role_connection_metadata_list returned object on completion

An application can have a maximum of 5 metadata records.

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rule_create (snowflake guild_id, const automod_rule &r) co_automod_rule_create dpp::cluster::co_automod_rule_create snowflake guild_id const automod_rule & r

Create an auto moderation rule.

guild_id

Guild id of the auto moderation rule

r

Auto moderation rule to create

automod_rule returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rule_create (snowflake guild_id, const automod_rule &r) co_automod_rule_create dpp::cluster::co_automod_rule_create snowflake guild_id const automod_rule & r

Create an auto moderation rule.

guild_id

Guild id of the auto moderation rule

r

Auto moderation rule to create

automod_rule returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rule_delete (snowflake guild_id, snowflake rule_id) co_automod_rule_delete dpp::cluster::co_automod_rule_delete snowflake guild_id snowflake rule_id

Delete an auto moderation rule.

guild_id

Guild id of the auto moderation rule

rule_id

Auto moderation rule id to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rule_delete (snowflake guild_id, snowflake rule_id) co_automod_rule_delete dpp::cluster::co_automod_rule_delete snowflake guild_id snowflake rule_id

Delete an auto moderation rule.

guild_id

Guild id of the auto moderation rule

rule_id

Auto moderation rule id to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rule_edit (snowflake guild_id, const automod_rule &r) co_automod_rule_edit dpp::cluster::co_automod_rule_edit snowflake guild_id const automod_rule & r

Edit an auto moderation rule.

guild_id

Guild id of the auto moderation rule

r

Auto moderation rule to edit. The rule's id must be set.

automod_rule returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rule_edit (snowflake guild_id, const automod_rule &r) co_automod_rule_edit dpp::cluster::co_automod_rule_edit snowflake guild_id const automod_rule & r

Edit an auto moderation rule.

guild_id

Guild id of the auto moderation rule

r

Auto moderation rule to edit. The rule's id must be set.

automod_rule returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rule_get (snowflake guild_id, snowflake rule_id) co_automod_rule_get dpp::cluster::co_automod_rule_get snowflake guild_id snowflake rule_id

Get a single auto moderation rule.

guild_id

Guild id of the auto moderation rule

rule_id

Rule id to retrieve

automod_rule returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rule_get (snowflake guild_id, snowflake rule_id) co_automod_rule_get dpp::cluster::co_automod_rule_get snowflake guild_id snowflake rule_id

Get a single auto moderation rule.

guild_id

Guild id of the auto moderation rule

rule_id

Rule id to retrieve

automod_rule returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rules_get (snowflake guild_id) co_automod_rules_get dpp::cluster::co_automod_rules_get snowflake guild_id

Get all auto moderation rules for a guild.

guild_id

Guild id of the auto moderation rule

automod_rule_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_automod_rules_get (snowflake guild_id) co_automod_rules_get dpp::cluster::co_automod_rules_get snowflake guild_id

Get all auto moderation rules for a guild.

guild_id

Guild id of the auto moderation rule

automod_rule_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_create (const class channel &c) co_channel_create dpp::cluster::co_channel_create const class channel & c

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`

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_create

https://discord.com/developers/docs/resources/channel#create-channel

c

Channel to create

channel returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_create (const class channel &c) co_channel_create dpp::cluster::co_channel_create const class channel & c

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`

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_create

https://discord.com/developers/docs/resources/channel#create-channel

c

Channel to create

channel returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_delete (snowflake channel_id) co_channel_delete dpp::cluster::co_channel_delete snowflake channel_id

Delete a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_delete

https://discord.com/developers/docs/resources/channel#deleteclose-channel

channel_id

Channel id to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_delete (snowflake channel_id) co_channel_delete dpp::cluster::co_channel_delete snowflake channel_id

Delete a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_delete

https://discord.com/developers/docs/resources/channel#deleteclose-channel

channel_id

Channel id to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_delete_permission (const class channel &c, snowflake overwrite_id) co_channel_delete_permission dpp::cluster::co_channel_delete_permission const class channel & c snowflake overwrite_id

Remove a permission from a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_delete_permission

https://discord.com/developers/docs/resources/channel#delete-channel-permission

c

Channel to remove permission from

overwrite_id

Overwrite to remove, user or channel ID

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_delete_permission (const class channel &c, snowflake overwrite_id) co_channel_delete_permission dpp::cluster::co_channel_delete_permission const class channel & c snowflake overwrite_id

Remove a permission from a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_delete_permission

https://discord.com/developers/docs/resources/channel#delete-channel-permission

c

Channel to remove permission from

overwrite_id

Overwrite to remove, user or channel ID

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_edit (const class channel &c) co_channel_edit dpp::cluster::co_channel_edit const class channel & c

Edit a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_edit

https://discord.com/developers/docs/resources/channel#modify-channel

c

Channel to edit/update

channel returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_edit (const class channel &c) co_channel_edit dpp::cluster::co_channel_edit const class channel & c

Edit a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_edit

https://discord.com/developers/docs/resources/channel#modify-channel

c

Channel to edit/update

channel returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_edit_permissions (const class channel &c, const snowflake overwrite_id, const uint64_t allow, const uint64_t deny, const bool member) co_channel_edit_permissions dpp::cluster::co_channel_edit_permissions const class channel & c const snowflake overwrite_id const uint64_t allow const uint64_t deny const bool member

Edit a channel's permissions.

dpp::cluster::channel_edit_permissions

https://discord.com/developers/docs/resources/channel#edit-channel-permissions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

c

Channel to set permissions for

overwrite_id

Overwrite to change (a user or role ID)

allow

Bitmask of allowed permissions (refer to enum dpp::permissions)

deny

Bitmask of denied permissions (refer to enum dpp::permissions)

member

true if the overwrite_id is a user id, false if it is a channel id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_edit_permissions (const class channel &c, const snowflake overwrite_id, const uint64_t allow, const uint64_t deny, const bool member) co_channel_edit_permissions dpp::cluster::co_channel_edit_permissions const class channel & c const snowflake overwrite_id const uint64_t allow const uint64_t deny const bool member

Edit a channel's permissions.

dpp::cluster::channel_edit_permissions

https://discord.com/developers/docs/resources/channel#edit-channel-permissions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

c

Channel to set permissions for

overwrite_id

Overwrite to change (a user or role ID)

allow

Bitmask of allowed permissions (refer to enum dpp::permissions)

deny

Bitmask of denied permissions (refer to enum dpp::permissions)

member

true if the overwrite_id is a user id, false if it is a channel id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_edit_permissions (const snowflake channel_id, const snowflake overwrite_id, const uint64_t allow, const uint64_t deny, const bool member) co_channel_edit_permissions dpp::cluster::co_channel_edit_permissions const snowflake channel_id const snowflake overwrite_id const uint64_t allow const uint64_t deny const bool member

Edit a channel's permissions.

dpp::cluster::channel_edit_permissions

https://discord.com/developers/docs/resources/channel#edit-channel-permissions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

channel_id

ID of the channel to set permissions for

overwrite_id

Overwrite to change (a user or role ID)

allow

Bitmask of allowed permissions (refer to enum dpp::permissions)

deny

Bitmask of denied permissions (refer to enum dpp::permissions)

member

true if the overwrite_id is a user id, false if it is a channel id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_edit_permissions (const snowflake channel_id, const snowflake overwrite_id, const uint64_t allow, const uint64_t deny, const bool member) co_channel_edit_permissions dpp::cluster::co_channel_edit_permissions const snowflake channel_id const snowflake overwrite_id const uint64_t allow const uint64_t deny const bool member

Edit a channel's permissions.

dpp::cluster::channel_edit_permissions

https://discord.com/developers/docs/resources/channel#edit-channel-permissions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

channel_id

ID of the channel to set permissions for

overwrite_id

Overwrite to change (a user or role ID)

allow

Bitmask of allowed permissions (refer to enum dpp::permissions)

deny

Bitmask of denied permissions (refer to enum dpp::permissions)

member

true if the overwrite_id is a user id, false if it is a channel id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_edit_positions (const std::vector< channel > &c) co_channel_edit_positions dpp::cluster::co_channel_edit_positions const std::vector< channel > & c

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.

dpp::cluster::channel_edit_positions

https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

c

Channel to change the position for

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_edit_positions (const std::vector< channel > &c) co_channel_edit_positions dpp::cluster::co_channel_edit_positions const std::vector< channel > & c

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.

dpp::cluster::channel_edit_positions

https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

c

Channel to change the position for

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_follow_news (const class channel &c, snowflake target_channel_id) co_channel_follow_news dpp::cluster::co_channel_follow_news const class channel & c snowflake target_channel_id

Follow an announcement (news) channel.

dpp::cluster::channel_follow_news

https://discord.com/developers/docs/resources/channel#follow-news-channel

c

Channel id to follow

target_channel_id

Channel to subscribe the channel to

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_follow_news (const class channel &c, snowflake target_channel_id) co_channel_follow_news dpp::cluster::co_channel_follow_news const class channel & c snowflake target_channel_id

Follow an announcement (news) channel.

dpp::cluster::channel_follow_news

https://discord.com/developers/docs/resources/channel#follow-news-channel

c

Channel id to follow

target_channel_id

Channel to subscribe the channel to

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_get (snowflake c) co_channel_get dpp::cluster::co_channel_get snowflake c

Get a channel.

dpp::cluster::channel_get

https://discord.com/developers/docs/resources/channel#get-channel

c

Channel ID to retrieve

channel returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_get (snowflake c) co_channel_get dpp::cluster::co_channel_get snowflake c

Get a channel.

dpp::cluster::channel_get

https://discord.com/developers/docs/resources/channel#get-channel

c

Channel ID to retrieve

channel returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_invite_create (const class channel &c, const class invite &i) co_channel_invite_create dpp::cluster::co_channel_invite_create const class channel & c const class invite & i

Create invite for a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_invite_create

https://discord.com/developers/docs/resources/channel#create-channel-invite

c

Channel to create an invite on

i

Invite to create

invite returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_invite_create (const class channel &c, const class invite &i) co_channel_invite_create dpp::cluster::co_channel_invite_create const class channel & c const class invite & i

Create invite for a channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::channel_invite_create

https://discord.com/developers/docs/resources/channel#create-channel-invite

c

Channel to create an invite on

i

Invite to create

invite returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_invites_get (const class channel &c) co_channel_invites_get dpp::cluster::co_channel_invites_get const class channel & c

Get invites for a channel.

dpp::cluster::channel_invites_get

https://discord.com/developers/docs/resources/invite#get-invites

c

Channel to get invites for

invite_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_invites_get (const class channel &c) co_channel_invites_get dpp::cluster::co_channel_invites_get const class channel & c

Get invites for a channel.

dpp::cluster::channel_invites_get

https://discord.com/developers/docs/resources/invite#get-invites

c

Channel to get invites for

invite_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_pins_get (snowflake channel_id) co_channel_pins_get dpp::cluster::co_channel_pins_get snowflake channel_id

Get a channel's pins.

dpp::cluster::channel_pins_get

https://discord.com/developers/docs/resources/channel#get-pinned-messages

channel_id

Channel ID to get pins for

message_pin_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_pins_get (snowflake channel_id) co_channel_pins_get dpp::cluster::co_channel_pins_get snowflake channel_id

Get a channel's pins.

dpp::cluster::channel_pins_get

https://discord.com/developers/docs/resources/channel#get-pinned-messages

channel_id

Channel ID to get pins for

message_pin_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_pins_get (snowflake channel_id, std::optional< time_t > before, std::optional< uint64_t > limit) co_channel_pins_get dpp::cluster::co_channel_pins_get snowflake channel_id std::optional< time_t > before std::optional< uint64_t > limit

Get a channel's pins.

dpp::cluster::channel_pins_get

https://discord.com/developers/docs/resources/channel#get-pinned-messages

channel_id

Channel ID to get pins for

before

Get messages pinned before this timestamp.

limit

Max number of pins to return (1-50). Defaults to 50 if not set.

message_pin_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_pins_get (snowflake channel_id, std::optional< time_t > before, std::optional< uint64_t > limit) co_channel_pins_get dpp::cluster::co_channel_pins_get snowflake channel_id std::optional< time_t > before std::optional< uint64_t > limit

Get a channel's pins.

dpp::cluster::channel_pins_get

https://discord.com/developers/docs/resources/channel#get-pinned-messages

channel_id

Channel ID to get pins for

before

Get messages pinned before this timestamp.

limit

Max number of pins to return (1-50). Defaults to 50 if not set.

message_pin_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_set_voice_status (snowflake channel_id, const std::string &status) co_channel_set_voice_status dpp::cluster::co_channel_set_voice_status snowflake channel_id const std::string & status

Set the status of a voice channel.

dpp::cluster::channel_set_voice_status

https://github.com/discord/discord-api-docs/pull/6400 (please replace soon).

channel_id

The channel to update.

status

The new status for the channel.

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_set_voice_status (snowflake channel_id, const std::string &status) co_channel_set_voice_status dpp::cluster::co_channel_set_voice_status snowflake channel_id const std::string & status

Set the status of a voice channel.

dpp::cluster::channel_set_voice_status

https://github.com/discord/discord-api-docs/pull/6400 (please replace soon).

channel_id

The channel to update.

status

The new status for the channel.

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_typing (const class channel &c) co_channel_typing dpp::cluster::co_channel_typing const class channel & c

Trigger channel typing indicator.

dpp::cluster::channel_typing

https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

c

Channel to set as typing on

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_typing (const class channel &c) co_channel_typing dpp::cluster::co_channel_typing const class channel & c

Trigger channel typing indicator.

dpp::cluster::channel_typing

https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

c

Channel to set as typing on

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_typing (snowflake cid) co_channel_typing dpp::cluster::co_channel_typing snowflake cid

Trigger channel typing indicator.

dpp::cluster::channel_typing

https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

cid

Channel ID to set as typing on

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channel_typing (snowflake cid) co_channel_typing dpp::cluster::co_channel_typing snowflake cid

Trigger channel typing indicator.

dpp::cluster::channel_typing

https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

cid

Channel ID to set as typing on

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channels_get (snowflake guild_id) co_channels_get dpp::cluster::co_channels_get snowflake guild_id

Get all channels for a guild.

dpp::cluster::channels_get

https://discord.com/developers/docs/resources/channel#get-channels

guild_id

Guild ID to retrieve channels for

channel_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_channels_get (snowflake guild_id) co_channels_get dpp::cluster::co_channels_get snowflake guild_id

Get all channels for a guild.

dpp::cluster::channels_get

https://discord.com/developers/docs/resources/channel#get-channels

guild_id

Guild ID to retrieve channels for

channel_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_create_dm_channel (snowflake user_id) co_create_dm_channel dpp::cluster::co_create_dm_channel snowflake user_id

Create a dm channel.

dpp::cluster::create_dm_channel

https://discord.com/developers/docs/resources/user#create-dm

user_id

User ID to create DM channel with

channel returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_create_dm_channel (snowflake user_id) co_create_dm_channel dpp::cluster::co_create_dm_channel snowflake user_id

Create a dm channel.

dpp::cluster::create_dm_channel

https://discord.com/developers/docs/resources/user#create-dm

user_id

User ID to create DM channel with

channel returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > dpp::cluster::co_create_webhook (const class webhook &wh) co_create_webhook dpp::cluster::co_create_webhook const class webhook & wh
async< confirmation_callback_t > async< confirmation_callback_t > co_current_application_get () co_current_application_get dpp::cluster::co_current_application_get

Get current (bot) application.

dpp::cluster::current_application_get

https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information

application returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_application_get () co_current_application_get dpp::cluster::co_current_application_get

Get current (bot) application.

dpp::cluster::current_application_get

https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information

application returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_connections_get () co_current_user_connections_get dpp::cluster::co_current_user_connections_get

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.

dpp::cluster::current_user_connections_get

https://discord.com/developers/docs/resources/user#get-user-connections

connection_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_connections_get () co_current_user_connections_get dpp::cluster::co_current_user_connections_get

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.

dpp::cluster::current_user_connections_get

https://discord.com/developers/docs/resources/user#get-user-connections

connection_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_edit (const std::string &nickname, const std::string &avatar_blob="", const image_type avatar_type=i_png, const std::string &banner_blob="", const image_type banner_type=i_png) co_current_user_edit dpp::cluster::co_current_user_edit const std::string & nickname const std::string & avatar_blob "" const image_type avatar_type i_png const std::string & banner_blob "" const image_type banner_type i_png

Edit current (bot) user.

Modify the requester's user account settings. Returns a dpp::user object on success. Fires a User Update Gateway event.

There appears to be no limit to the image size, however, if your image cannot be processed/uploaded in time, you will receive a malformed http request.

dpp::cluster::current_user_edit

https://discord.com/developers/docs/resources/user#modify-current-user

nickname

Nickname to set

avatar_blob

Avatar data to upload

avatar_type

Type of image for avatar. It can be one of `i_gif`, `i_jpg` or `i_png`.

banner_blob

Banner data to upload

banner_type

Type of image for Banner. It can be one of `i_gif`, `i_jpg` or `i_png`.

user returned object on completion

dpp::length_exception

Image data is larger than the maximum size of 256 kilobytes

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_edit (const std::string &nickname, const std::string &avatar_blob="", const image_type avatar_type=i_png, const std::string &banner_blob="", const image_type banner_type=i_png) co_current_user_edit dpp::cluster::co_current_user_edit const std::string & nickname const std::string & avatar_blob "" const image_type avatar_type i_png const std::string & banner_blob "" const image_type banner_type i_png

Edit current (bot) user.

Modify the requester's user account settings. Returns a dpp::user object on success. Fires a User Update Gateway event.

There appears to be no limit to the image size, however, if your image cannot be processed/uploaded in time, you will receive a malformed http request.

dpp::cluster::current_user_edit

https://discord.com/developers/docs/resources/user#modify-current-user

nickname

Nickname to set

avatar_blob

Avatar data to upload

avatar_type

Type of image for avatar. It can be one of `i_gif`, `i_jpg` or `i_png`.

banner_blob

Banner data to upload

banner_type

Type of image for Banner. It can be one of `i_gif`, `i_jpg` or `i_png`.

user returned object on completion

dpp::length_exception

Image data is larger than the maximum size of 256 kilobytes

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_get () co_current_user_get dpp::cluster::co_current_user_get

Get current (bot) user.

dpp::cluster::current_user_get

https://discord.com/developers/docs/resources/user#get-current-user

user_identified returned object on completion

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`.

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_get () co_current_user_get dpp::cluster::co_current_user_get

Get current (bot) user.

dpp::cluster::current_user_get

https://discord.com/developers/docs/resources/user#get-current-user

user_identified returned object on completion

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`.

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_get_dms () co_current_user_get_dms dpp::cluster::co_current_user_get_dms

Get current user DM channels.

channel_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_get_dms () co_current_user_get_dms dpp::cluster::co_current_user_get_dms

Get current user DM channels.

channel_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_get_guilds () co_current_user_get_guilds dpp::cluster::co_current_user_get_guilds

Get current (bot) user guilds.

dpp::cluster::current_user_get_guilds

https://discord.com/developers/docs/resources/user#get-current-user-guilds

guild_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_get_guilds () co_current_user_get_guilds dpp::cluster::co_current_user_get_guilds

Get current (bot) user guilds.

dpp::cluster::current_user_get_guilds

https://discord.com/developers/docs/resources/user#get-current-user-guilds

guild_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_get_voice_state (snowflake guild_id) co_current_user_get_voice_state dpp::cluster::co_current_user_get_voice_state snowflake guild_id

Get the bot's voice state in a guild without a Gateway connection.

dpp::cluster::current_user_get_voice_state

https://discord.com/developers/docs/resources/voice#get-current-user-voice-state

guild_id

Guild to get the voice state for

voicestate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_get_voice_state (snowflake guild_id) co_current_user_get_voice_state dpp::cluster::co_current_user_get_voice_state snowflake guild_id

Get the bot's voice state in a guild without a Gateway connection.

dpp::cluster::current_user_get_voice_state

https://discord.com/developers/docs/resources/voice#get-current-user-voice-state

guild_id

Guild to get the voice state for

voicestate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_join_thread (snowflake thread_id) co_current_user_join_thread dpp::cluster::co_current_user_join_thread snowflake thread_id

Join a thread.

dpp::cluster::current_user_join_thread

https://discord.com/developers/docs/resources/channel#join-thread

thread_id

Thread ID to join

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_join_thread (snowflake thread_id) co_current_user_join_thread dpp::cluster::co_current_user_join_thread snowflake thread_id

Join a thread.

dpp::cluster::current_user_join_thread

https://discord.com/developers/docs/resources/channel#join-thread

thread_id

Thread ID to join

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_leave_guild (snowflake guild_id) co_current_user_leave_guild dpp::cluster::co_current_user_leave_guild snowflake guild_id

Leave a guild.

dpp::cluster::current_user_leave_guild

https://discord.com/developers/docs/resources/user#leave-guild

guild_id

Guild ID to leave

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_leave_guild (snowflake guild_id) co_current_user_leave_guild dpp::cluster::co_current_user_leave_guild snowflake guild_id

Leave a guild.

dpp::cluster::current_user_leave_guild

https://discord.com/developers/docs/resources/user#leave-guild

guild_id

Guild ID to leave

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_leave_thread (snowflake thread_id) co_current_user_leave_thread dpp::cluster::co_current_user_leave_thread snowflake thread_id

Leave a thread.

dpp::cluster::current_user_leave_thread

https://discord.com/developers/docs/resources/channel#leave-thread

thread_id

Thread ID to leave

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_leave_thread (snowflake thread_id) co_current_user_leave_thread dpp::cluster::co_current_user_leave_thread snowflake thread_id

Leave a thread.

dpp::cluster::current_user_leave_thread

https://discord.com/developers/docs/resources/channel#leave-thread

thread_id

Thread ID to leave

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_set_voice_state (snowflake guild_id, snowflake channel_id, bool suppress=false, time_t request_to_speak_timestamp=0) co_current_user_set_voice_state dpp::cluster::co_current_user_set_voice_state snowflake guild_id snowflake channel_id bool suppress false time_t request_to_speak_timestamp 0

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.

dpp::cluster::current_user_set_voice_state

https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state

guild_id

Guild to set voice state on

channel_id

Stage channel to set voice state on

confirmation returned object on completion

suppress

True if the user's audio should be suppressed, false if it should not

request_to_speak_timestamp

The 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.

std::logic_exception

You attempted to set a request_to_speak_timestamp in the past which is not the value of 0.

async< confirmation_callback_t > async< confirmation_callback_t > co_current_user_set_voice_state (snowflake guild_id, snowflake channel_id, bool suppress=false, time_t request_to_speak_timestamp=0) co_current_user_set_voice_state dpp::cluster::co_current_user_set_voice_state snowflake guild_id snowflake channel_id bool suppress false time_t request_to_speak_timestamp 0

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.

dpp::cluster::current_user_set_voice_state

https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state

guild_id

Guild to set voice state on

channel_id

Stage channel to set voice state on

confirmation returned object on completion

suppress

True if the user's audio should be suppressed, false if it should not

request_to_speak_timestamp

The 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.

std::logic_exception

You attempted to set a request_to_speak_timestamp in the past which is not the value of 0.

async< confirmation_callback_t > async< confirmation_callback_t > co_delete_webhook (snowflake webhook_id) co_delete_webhook dpp::cluster::co_delete_webhook snowflake webhook_id

Delete a webhook.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::delete_webhook

https://discord.com/developers/docs/resources/webhook#delete-webhook

webhook_id

Webhook ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_delete_webhook (snowflake webhook_id) co_delete_webhook dpp::cluster::co_delete_webhook snowflake webhook_id

Delete a webhook.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::delete_webhook

https://discord.com/developers/docs/resources/webhook#delete-webhook

webhook_id

Webhook ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_delete_webhook_message (const class webhook &wh, snowflake message_id, snowflake thread_id=0) co_delete_webhook_message dpp::cluster::co_delete_webhook_message const class webhook & wh snowflake message_id snowflake thread_id 0

Delete webhook message.

dpp::cluster::delete_webhook_message

https://discord.com/developers/docs/resources/webhook#delete-webhook-message

wh

Webhook to delete message for

message_id

Message ID to delete

thread_id

ID of the thread the message is in

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_delete_webhook_message (const class webhook &wh, snowflake message_id, snowflake thread_id=0) co_delete_webhook_message dpp::cluster::co_delete_webhook_message const class webhook & wh snowflake message_id snowflake thread_id 0

Delete webhook message.

dpp::cluster::delete_webhook_message

https://discord.com/developers/docs/resources/webhook#delete-webhook-message

wh

Webhook to delete message for

message_id

Message ID to delete

thread_id

ID of the thread the message is in

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_delete_webhook_with_token (snowflake webhook_id, const std::string &token) co_delete_webhook_with_token dpp::cluster::co_delete_webhook_with_token snowflake webhook_id const std::string & token

Delete webhook with token.

dpp::cluster::delete_webhook_with_token

https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token

webhook_id

Webhook ID to delete

token

Token of webhook to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_delete_webhook_with_token (snowflake webhook_id, const std::string &token) co_delete_webhook_with_token dpp::cluster::co_delete_webhook_with_token snowflake webhook_id const std::string & token

Delete webhook with token.

dpp::cluster::delete_webhook_with_token

https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token

webhook_id

Webhook ID to delete

token

Token of webhook to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_direct_message_create (snowflake user_id, const message &m) co_direct_message_create dpp::cluster::co_direct_message_create snowflake user_id const message & m

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

dpp::cluster::direct_message_create

https://discord.com/developers/docs/resources/user#create-dm

dpp::cluster::direct_message_create

https://discord.com/developers/docs/resources/channel#create-message

user_id

User ID of user to send message to

m

Message object

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_direct_message_create (snowflake user_id, const message &m) co_direct_message_create dpp::cluster::co_direct_message_create snowflake user_id const message & m

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

dpp::cluster::direct_message_create

https://discord.com/developers/docs/resources/user#create-dm

dpp::cluster::direct_message_create

https://discord.com/developers/docs/resources/channel#create-message

user_id

User ID of user to send message to

m

Message object

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_edit_webhook (const class webhook &wh) co_edit_webhook dpp::cluster::co_edit_webhook const class webhook & wh

Edit webhook.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::edit_webhook

https://discord.com/developers/docs/resources/webhook#modify-webhook

wh

Webhook to edit

webhook returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_edit_webhook (const class webhook &wh) co_edit_webhook dpp::cluster::co_edit_webhook const class webhook & wh

Edit webhook.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::edit_webhook

https://discord.com/developers/docs/resources/webhook#modify-webhook

wh

Webhook to edit

webhook returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_edit_webhook_message (const class webhook &wh, const struct message &m, snowflake thread_id=0) co_edit_webhook_message dpp::cluster::co_edit_webhook_message const class webhook & wh const struct message & m snowflake thread_id 0

Edit webhook message.

When the content field is edited, the mentions array in the message object will be reconstructed from scratch based on the new content. The allowed_mentions field of the edit request controls how this happens. If there is no explicit allowed_mentions in the edit request, the content will be parsed with default allowances, that is, without regard to whether or not an allowed_mentions was present in the request that originally created the message.

dpp::cluster::edit_webhook_message

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

the attachments array must contain all attachments that should be present after edit, including retained and new attachments provided in the request body.

wh

Webhook to edit message for

m

New message

thread_id

ID of the thread the message is in

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_edit_webhook_message (const class webhook &wh, const struct message &m, snowflake thread_id=0) co_edit_webhook_message dpp::cluster::co_edit_webhook_message const class webhook & wh const struct message & m snowflake thread_id 0

Edit webhook message.

When the content field is edited, the mentions array in the message object will be reconstructed from scratch based on the new content. The allowed_mentions field of the edit request controls how this happens. If there is no explicit allowed_mentions in the edit request, the content will be parsed with default allowances, that is, without regard to whether or not an allowed_mentions was present in the request that originally created the message.

dpp::cluster::edit_webhook_message

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

the attachments array must contain all attachments that should be present after edit, including retained and new attachments provided in the request body.

wh

Webhook to edit message for

m

New message

thread_id

ID of the thread the message is in

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_edit_webhook_with_token (const class webhook &wh) co_edit_webhook_with_token dpp::cluster::co_edit_webhook_with_token const class webhook & wh

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

dpp::cluster::edit_webhook_with_token

https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token

wh

Webhook to edit (should include token)

webhook returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_edit_webhook_with_token (const class webhook &wh) co_edit_webhook_with_token dpp::cluster::co_edit_webhook_with_token const class webhook & wh

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

dpp::cluster::edit_webhook_with_token

https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token

wh

Webhook to edit (should include token)

webhook returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_entitlement_consume (snowflake entitlement_id) co_entitlement_consume dpp::cluster::co_entitlement_consume snowflake entitlement_id

For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed.

dpp::cluster::entitlement_consume

https://discord.com/developers/docs/monetization/entitlements#consume-an-entitlement

entitlement_id

The entitlement to mark as consumed.

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_entitlement_consume (snowflake entitlement_id) co_entitlement_consume dpp::cluster::co_entitlement_consume snowflake entitlement_id

For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed.

dpp::cluster::entitlement_consume

https://discord.com/developers/docs/monetization/entitlements#consume-an-entitlement

entitlement_id

The entitlement to mark as consumed.

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_entitlement_test_create (const class entitlement &new_entitlement) co_entitlement_test_create dpp::cluster::co_entitlement_test_create const class entitlement & new_entitlement

Creates a test entitlement to a given SKU for a given guild or user. Discord will act as though that user or guild has entitlement to your premium offering.

dpp::cluster::entitlement_test_create

https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement

new_entitlement

The entitlement to create. Make sure your dpp::entitlement_type (inside your dpp::entitlement object) matches the type of the owner_id (if type is guild, owner_id is a guild id), otherwise it won't work!

entitlement returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_entitlement_test_create (const class entitlement &new_entitlement) co_entitlement_test_create dpp::cluster::co_entitlement_test_create const class entitlement & new_entitlement

Creates a test entitlement to a given SKU for a given guild or user. Discord will act as though that user or guild has entitlement to your premium offering.

dpp::cluster::entitlement_test_create

https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement

new_entitlement

The entitlement to create. Make sure your dpp::entitlement_type (inside your dpp::entitlement object) matches the type of the owner_id (if type is guild, owner_id is a guild id), otherwise it won't work!

entitlement returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_entitlement_test_delete (snowflake entitlement_id) co_entitlement_test_delete dpp::cluster::co_entitlement_test_delete snowflake entitlement_id

Deletes a currently-active test entitlement. Discord will act as though that user or guild no longer has entitlement to your premium offering.

dpp::cluster::entitlement_test_delete

https://discord.com/developers/docs/monetization/entitlements#delete-test-entitlement

entitlement_id

The test entitlement to delete.

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_entitlement_test_delete (snowflake entitlement_id) co_entitlement_test_delete dpp::cluster::co_entitlement_test_delete snowflake entitlement_id

Deletes a currently-active test entitlement. Discord will act as though that user or guild no longer has entitlement to your premium offering.

dpp::cluster::entitlement_test_delete

https://discord.com/developers/docs/monetization/entitlements#delete-test-entitlement

entitlement_id

The test entitlement to delete.

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_entitlements_get (snowflake user_id=0, const std::vector< snowflake > &sku_ids={}, snowflake before_id=0, snowflake after_id=0, uint8_t limit=100, snowflake guild_id=0, bool exclude_ended=false) co_entitlements_get dpp::cluster::co_entitlements_get snowflake user_id 0 const std::vector< snowflake > & sku_ids {} snowflake before_id 0 snowflake after_id 0 uint8_t limit 100 snowflake guild_id 0 bool exclude_ended false

Returns all entitlements for a given app, active and expired.

dpp::cluster::entitlements_get

https://discord.com/developers/docs/monetization/entitlements#list-entitlements

user_id

User ID to look up entitlements for.

sku_ids

List of SKU IDs to check entitlements for.

before_id

Retrieve entitlements before this entitlement ID.

after_id

Retrieve entitlements after this entitlement ID.

limit

Number of entitlements to return, 1-100 (default 100).

guild_id

Guild ID to look up entitlements for.

exclude_ended

Whether ended entitlements should be excluded from the search.

entitlement_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_entitlements_get (snowflake user_id=0, const std::vector< snowflake > &sku_ids={}, snowflake before_id=0, snowflake after_id=0, uint8_t limit=100, snowflake guild_id=0, bool exclude_ended=false) co_entitlements_get dpp::cluster::co_entitlements_get snowflake user_id 0 const std::vector< snowflake > & sku_ids {} snowflake before_id 0 snowflake after_id 0 uint8_t limit 100 snowflake guild_id 0 bool exclude_ended false

Returns all entitlements for a given app, active and expired.

dpp::cluster::entitlements_get

https://discord.com/developers/docs/monetization/entitlements#list-entitlements

user_id

User ID to look up entitlements for.

sku_ids

List of SKU IDs to check entitlements for.

before_id

Retrieve entitlements before this entitlement ID.

after_id

Retrieve entitlements after this entitlement ID.

limit

Number of entitlements to return, 1-100 (default 100).

guild_id

Guild ID to look up entitlements for.

exclude_ended

Whether ended entitlements should be excluded from the search.

entitlement_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_execute_webhook (const class webhook &wh, const struct message &m, bool wait=false, snowflake thread_id=0, const std::string &thread_name="") co_execute_webhook dpp::cluster::co_execute_webhook const class webhook & wh const struct message & m bool wait false snowflake thread_id 0 const std::string & thread_name ""

Execute webhook.

dpp::cluster::execute_webhook

https://discord.com/developers/docs/resources/webhook#execute-webhook

wh

Webhook to execute

m

Message to send

wait

waits for server confirmation of message send before response, and returns the created message body

thread_id

Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived

thread_name

Name of thread to create (requires the webhook channel to be a forum channel)

message returned object on completion

If the webhook channel is a forum channel, you must provide either `thread_id` or `thread_name`. If `thread_id` is provided, the message will send in that thread. If `thread_name` is provided, a thread with that name will be created in the forum channel.

async< confirmation_callback_t > async< confirmation_callback_t > co_execute_webhook (const class webhook &wh, const struct message &m, bool wait=false, snowflake thread_id=0, const std::string &thread_name="") co_execute_webhook dpp::cluster::co_execute_webhook const class webhook & wh const struct message & m bool wait false snowflake thread_id 0 const std::string & thread_name ""

Execute webhook.

dpp::cluster::execute_webhook

https://discord.com/developers/docs/resources/webhook#execute-webhook

wh

Webhook to execute

m

Message to send

wait

waits for server confirmation of message send before response, and returns the created message body

thread_id

Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived

thread_name

Name of thread to create (requires the webhook channel to be a forum channel)

message returned object on completion

If the webhook channel is a forum channel, you must provide either `thread_id` or `thread_name`. If `thread_id` is provided, the message will send in that thread. If `thread_name` is provided, a thread with that name will be created in the forum channel.

async< confirmation_callback_t > async< confirmation_callback_t > co_gdm_add (snowflake channel_id, snowflake user_id, const std::string &access_token, const std::string &nick) co_gdm_add dpp::cluster::co_gdm_add snowflake channel_id snowflake user_id const std::string & access_token const std::string & nick

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

dpp::cluster::gdm_add

https://discord.com/developers/docs/resources/channel#group-dm-add-recipient

channel_id

Channel id to add group DM recipients to

user_id

User ID to add

access_token

Access token from OAuth2

nick

Nickname of user to apply to the chat

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_gdm_add (snowflake channel_id, snowflake user_id, const std::string &access_token, const std::string &nick) co_gdm_add dpp::cluster::co_gdm_add snowflake channel_id snowflake user_id const std::string & access_token const std::string & nick

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

dpp::cluster::gdm_add

https://discord.com/developers/docs/resources/channel#group-dm-add-recipient

channel_id

Channel id to add group DM recipients to

user_id

User ID to add

access_token

Access token from OAuth2

nick

Nickname of user to apply to the chat

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_gdm_remove (snowflake channel_id, snowflake user_id) co_gdm_remove dpp::cluster::co_gdm_remove snowflake channel_id snowflake user_id

Removes a recipient from a Group DM.

dpp::cluster::gdm_remove

https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient

channel_id

Channel ID of group DM

user_id

User ID to remove from group DM

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_gdm_remove (snowflake channel_id, snowflake user_id) co_gdm_remove dpp::cluster::co_gdm_remove snowflake channel_id snowflake user_id

Removes a recipient from a Group DM.

dpp::cluster::gdm_remove

https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient

channel_id

Channel ID of group DM

user_id

User ID to remove from group DM

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_channel_webhooks (snowflake channel_id) co_get_channel_webhooks dpp::cluster::co_get_channel_webhooks snowflake channel_id

Get channel webhooks.

dpp::cluster::get_channel_webhooks

https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

channel_id

Channel ID to get webhooks for

webhook_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_channel_webhooks (snowflake channel_id) co_get_channel_webhooks dpp::cluster::co_get_channel_webhooks snowflake channel_id

Get channel webhooks.

dpp::cluster::get_channel_webhooks

https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

channel_id

Channel ID to get webhooks for

webhook_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_gateway_bot () co_get_gateway_bot dpp::cluster::co_get_gateway_bot

Get the gateway information for the bot using the token.

dpp::cluster::get_gateway_bot

https://discord.com/developers/docs/topics/gateway#get-gateway-bot

gateway returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_gateway_bot () co_get_gateway_bot dpp::cluster::co_get_gateway_bot

Get the gateway information for the bot using the token.

dpp::cluster::get_gateway_bot

https://discord.com/developers/docs/topics/gateway#get-gateway-bot

gateway returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_guild_webhooks (snowflake guild_id) co_get_guild_webhooks dpp::cluster::co_get_guild_webhooks snowflake guild_id

Get guild webhooks.

dpp::cluster::get_guild_webhooks

https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

guild_id

Guild ID to get webhooks for

webhook_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_guild_webhooks (snowflake guild_id) co_get_guild_webhooks dpp::cluster::co_get_guild_webhooks snowflake guild_id

Get guild webhooks.

dpp::cluster::get_guild_webhooks

https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

guild_id

Guild ID to get webhooks for

webhook_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_voice_regions () co_get_voice_regions dpp::cluster::co_get_voice_regions

Get all voice regions.

dpp::cluster::get_voice_regions

https://discord.com/developers/docs/resources/voice#list-voice-regions

voiceregion_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_voice_regions () co_get_voice_regions dpp::cluster::co_get_voice_regions

Get all voice regions.

dpp::cluster::get_voice_regions

https://discord.com/developers/docs/resources/voice#list-voice-regions

voiceregion_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_webhook (snowflake webhook_id) co_get_webhook dpp::cluster::co_get_webhook snowflake webhook_id

Get webhook.

dpp::cluster::get_webhook

https://discord.com/developers/docs/resources/webhook#get-webhook

webhook_id

Webhook ID to get

webhook returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_webhook (snowflake webhook_id) co_get_webhook dpp::cluster::co_get_webhook snowflake webhook_id

Get webhook.

dpp::cluster::get_webhook

https://discord.com/developers/docs/resources/webhook#get-webhook

webhook_id

Webhook ID to get

webhook returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_webhook_message (const class webhook &wh, snowflake message_id, snowflake thread_id=0) co_get_webhook_message dpp::cluster::co_get_webhook_message const class webhook & wh snowflake message_id snowflake thread_id 0

Get webhook message.

dpp::cluster::get_webhook_message

https://discord.com/developers/docs/resources/webhook#get-webhook-message

wh

Webhook to get the original message for

message_id

The message ID

thread_id

ID of the thread the message is in

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_webhook_message (const class webhook &wh, snowflake message_id, snowflake thread_id=0) co_get_webhook_message dpp::cluster::co_get_webhook_message const class webhook & wh snowflake message_id snowflake thread_id 0

Get webhook message.

dpp::cluster::get_webhook_message

https://discord.com/developers/docs/resources/webhook#get-webhook-message

wh

Webhook to get the original message for

message_id

The message ID

thread_id

ID of the thread the message is in

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_webhook_with_token (snowflake webhook_id, const std::string &token) co_get_webhook_with_token dpp::cluster::co_get_webhook_with_token snowflake webhook_id const std::string & token

Get webhook using token.

dpp::cluster::get_webhook_with_token

https://discord.com/developers/docs/resources/webhook#get-webhook-with-token

webhook_id

Webhook ID to retrieve

token

Token of webhook

webhook returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_get_webhook_with_token (snowflake webhook_id, const std::string &token) co_get_webhook_with_token dpp::cluster::co_get_webhook_with_token snowflake webhook_id const std::string & token

Get webhook using token.

dpp::cluster::get_webhook_with_token

https://discord.com/developers/docs/resources/webhook#get-webhook-with-token

webhook_id

Webhook ID to retrieve

token

Token of webhook

webhook returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_bulk_command_create (const std::vector< slashcommand > &commands) co_global_bulk_command_create dpp::cluster::co_global_bulk_command_create const std::vector< slashcommand > & commands

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

dpp::cluster::global_bulk_command_create

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

commands

Vector of slash commands to create/update. overwriting existing commands that are registered globally for this application. Commands that do not already exist will count toward daily application command create limits.

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_bulk_command_create (const std::vector< slashcommand > &commands) co_global_bulk_command_create dpp::cluster::co_global_bulk_command_create const std::vector< slashcommand > & commands

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

dpp::cluster::global_bulk_command_create

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

commands

Vector of slash commands to create/update. overwriting existing commands that are registered globally for this application. Commands that do not already exist will count toward daily application command create limits.

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_bulk_command_delete () co_global_bulk_command_delete dpp::cluster::co_global_bulk_command_delete

Delete all existing global slash commands.

dpp::cluster::global_bulk_command_delete

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_bulk_command_delete () co_global_bulk_command_delete dpp::cluster::co_global_bulk_command_delete

Delete all existing global slash commands.

dpp::cluster::global_bulk_command_delete

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_command_create (const slashcommand &s) co_global_command_create dpp::cluster::co_global_command_create const slashcommand & s

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

dpp::cluster::global_command_create

https://discord.com/developers/docs/interactions/application-commands#create-global-application-command

s

Slash command to create

slashcommand returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_command_create (const slashcommand &s) co_global_command_create dpp::cluster::co_global_command_create const slashcommand & s

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

dpp::cluster::global_command_create

https://discord.com/developers/docs/interactions/application-commands#create-global-application-command

s

Slash command to create

slashcommand returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_command_delete (snowflake id) co_global_command_delete dpp::cluster::co_global_command_delete snowflake id

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

dpp::cluster::global_command_delete

https://discord.com/developers/docs/interactions/application-commands#delete-global-application-command

id

Slash command to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_command_delete (snowflake id) co_global_command_delete dpp::cluster::co_global_command_delete snowflake id

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

dpp::cluster::global_command_delete

https://discord.com/developers/docs/interactions/application-commands#delete-global-application-command

id

Slash command to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_command_edit (const slashcommand &s) co_global_command_edit dpp::cluster::co_global_command_edit const slashcommand & s

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

dpp::cluster::global_command_edit

https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command

s

Slash command to change

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_command_edit (const slashcommand &s) co_global_command_edit dpp::cluster::co_global_command_edit const slashcommand & s

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

dpp::cluster::global_command_edit

https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command

s

Slash command to change

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_command_get (snowflake id) co_global_command_get dpp::cluster::co_global_command_get snowflake id

Get a global slash command.

dpp::cluster::global_command_get

https://discord.com/developers/docs/interactions/application-commands#get-global-application-command

id

The ID of the slash command

slashcommand returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_command_get (snowflake id) co_global_command_get dpp::cluster::co_global_command_get snowflake id

Get a global slash command.

dpp::cluster::global_command_get

https://discord.com/developers/docs/interactions/application-commands#get-global-application-command

id

The ID of the slash command

slashcommand returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_commands_get () co_global_commands_get dpp::cluster::co_global_commands_get

Get the application's global slash commands.

dpp::cluster::global_commands_get

https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_global_commands_get () co_global_commands_get dpp::cluster::co_global_commands_get

Get the application's global slash commands.

dpp::cluster::global_commands_get

https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_add_member (const guild_member &gm, const std::string &access_token) co_guild_add_member dpp::cluster::co_guild_add_member const guild_member & gm const std::string & access_token

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.

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.

dpp::cluster::guild_add_member

https://discord.com/developers/docs/resources/guild#add-guild-member

gm

Guild member to add

access_token

Access token from Oauth2 scope

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_add_member (const guild_member &gm, const std::string &access_token) co_guild_add_member dpp::cluster::co_guild_add_member const guild_member & gm const std::string & access_token

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.

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.

dpp::cluster::guild_add_member

https://discord.com/developers/docs/resources/guild#add-guild-member

gm

Guild member to add

access_token

Access token from Oauth2 scope

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_auditlog_get (snowflake guild_id, snowflake user_id, uint32_t action_type, snowflake before, snowflake after, uint32_t limit) co_guild_auditlog_get dpp::cluster::co_guild_auditlog_get snowflake guild_id snowflake user_id uint32_t action_type snowflake before snowflake after uint32_t limit

Get the audit log for a guild.

dpp::cluster::guild_auditlog_get

https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log

guild_id

Guild to get the audit log of

user_id

Entries from a specific user ID. Set this to `0` will fetch any user

action_type

Entries for a specific dpp::audit_type. Set this to `0` will fetch any type

before

Entries with ID less than a specific audit log entry ID. Used for paginating

after

Entries with ID greater than a specific audit log entry ID. Used for paginating

limit

Maximum number of entries (between 1-100) to return

auditlog returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_auditlog_get (snowflake guild_id, snowflake user_id, uint32_t action_type, snowflake before, snowflake after, uint32_t limit) co_guild_auditlog_get dpp::cluster::co_guild_auditlog_get snowflake guild_id snowflake user_id uint32_t action_type snowflake before snowflake after uint32_t limit

Get the audit log for a guild.

dpp::cluster::guild_auditlog_get

https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log

guild_id

Guild to get the audit log of

user_id

Entries from a specific user ID. Set this to `0` will fetch any user

action_type

Entries for a specific dpp::audit_type. Set this to `0` will fetch any type

before

Entries with ID less than a specific audit log entry ID. Used for paginating

after

Entries with ID greater than a specific audit log entry ID. Used for paginating

limit

Maximum number of entries (between 1-100) to return

auditlog returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_ban_add (snowflake guild_id, snowflake user_id, uint32_t delete_message_seconds=0) co_guild_ban_add dpp::cluster::co_guild_ban_add snowflake guild_id snowflake user_id uint32_t delete_message_seconds 0

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.

dpp::cluster::guild_ban_add

https://discord.com/developers/docs/resources/guild#create-guild-ban

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to add ban to

user_id

User ID to ban

delete_message_seconds

How many seconds to delete messages for, between 0 and 604800 (7 days). Defaults to 0

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_ban_add (snowflake guild_id, snowflake user_id, uint32_t delete_message_seconds=0) co_guild_ban_add dpp::cluster::co_guild_ban_add snowflake guild_id snowflake user_id uint32_t delete_message_seconds 0

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.

dpp::cluster::guild_ban_add

https://discord.com/developers/docs/resources/guild#create-guild-ban

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to add ban to

user_id

User ID to ban

delete_message_seconds

How many seconds to delete messages for, between 0 and 604800 (7 days). Defaults to 0

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_ban_delete (snowflake guild_id, snowflake user_id) co_guild_ban_delete dpp::cluster::co_guild_ban_delete snowflake guild_id snowflake user_id

Delete guild ban.

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

dpp::cluster::guild_ban_delete

https://discord.com/developers/docs/resources/guild#remove-guild-ban

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild to delete ban from

user_id

User ID to delete ban for

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_ban_delete (snowflake guild_id, snowflake user_id) co_guild_ban_delete dpp::cluster::co_guild_ban_delete snowflake guild_id snowflake user_id

Delete guild ban.

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

dpp::cluster::guild_ban_delete

https://discord.com/developers/docs/resources/guild#remove-guild-ban

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild to delete ban from

user_id

User ID to delete ban for

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_begin_prune (snowflake guild_id, const struct prune &pruneinfo) co_guild_begin_prune dpp::cluster::co_guild_begin_prune snowflake guild_id const struct prune & pruneinfo

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.

dpp::cluster::guild_begin_prune

https://discord.com/developers/docs/resources/guild#begin-guild-prune

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to prune

pruneinfo

Pruning info

prune returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_begin_prune (snowflake guild_id, const struct prune &pruneinfo) co_guild_begin_prune dpp::cluster::co_guild_begin_prune snowflake guild_id const struct prune & pruneinfo

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.

dpp::cluster::guild_begin_prune

https://discord.com/developers/docs/resources/guild#begin-guild-prune

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to prune

pruneinfo

Pruning info

prune returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_bulk_command_create (const std::vector< slashcommand > &commands, snowflake guild_id) co_guild_bulk_command_create dpp::cluster::co_guild_bulk_command_create const std::vector< slashcommand > & commands snowflake guild_id

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

dpp::cluster::guild_bulk_command_create

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands

commands

Vector 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_id

Guild ID to create/update the slash commands in

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_bulk_command_create (const std::vector< slashcommand > &commands, snowflake guild_id) co_guild_bulk_command_create dpp::cluster::co_guild_bulk_command_create const std::vector< slashcommand > & commands snowflake guild_id

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

dpp::cluster::guild_bulk_command_create

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands

commands

Vector 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_id

Guild ID to create/update the slash commands in

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_bulk_command_delete (snowflake guild_id) co_guild_bulk_command_delete dpp::cluster::co_guild_bulk_command_delete snowflake guild_id

Delete all existing guild slash commands.

dpp::cluster::guild_bulk_command_delete

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

guild_id

Guild ID to delete the slash commands in.

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_bulk_command_delete (snowflake guild_id) co_guild_bulk_command_delete dpp::cluster::co_guild_bulk_command_delete snowflake guild_id

Delete all existing guild slash commands.

dpp::cluster::guild_bulk_command_delete

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

guild_id

Guild ID to delete the slash commands in.

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_bulk_command_edit_permissions (const std::vector< slashcommand > &commands, snowflake guild_id) co_guild_bulk_command_edit_permissions dpp::cluster::co_guild_bulk_command_edit_permissions const std::vector< slashcommand > & commands snowflake guild_id

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

You can only add up to 10 permission overwrites for a command

dpp::cluster::guild_bulk_command_edit_permissions

https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions

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.

commands

A vector of slash commands to edit/overwrite the permissions for

guild_id

Guild ID to edit permissions of the slash commands in

guild_command_permissions_map returned object on completion

Deprecated

This has been disabled with updates to Permissions v2. You can use guild_command_edit_permissions instead

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_bulk_command_edit_permissions (const std::vector< slashcommand > &commands, snowflake guild_id) co_guild_bulk_command_edit_permissions dpp::cluster::co_guild_bulk_command_edit_permissions const std::vector< slashcommand > & commands snowflake guild_id

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

You can only add up to 10 permission overwrites for a command

dpp::cluster::guild_bulk_command_edit_permissions

https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions

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.

commands

A vector of slash commands to edit/overwrite the permissions for

guild_id

Guild ID to edit permissions of the slash commands in

guild_command_permissions_map returned object on completion

Deprecated

This has been disabled with updates to Permissions v2. You can use guild_command_edit_permissions instead

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_create (const slashcommand &s, snowflake guild_id) co_guild_command_create dpp::cluster::co_guild_command_create const slashcommand & s snowflake guild_id

Create a slash command local to a guild.

dpp::cluster::guild_command_create

https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command

Creating a command with the same name as an existing command for your application will overwrite the old command.

s

Slash command to create

guild_id

Guild ID to create the slash command in

slashcommand returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_create (const slashcommand &s, snowflake guild_id) co_guild_command_create dpp::cluster::co_guild_command_create const slashcommand & s snowflake guild_id

Create a slash command local to a guild.

dpp::cluster::guild_command_create

https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command

Creating a command with the same name as an existing command for your application will overwrite the old command.

s

Slash command to create

guild_id

Guild ID to create the slash command in

slashcommand returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_delete (snowflake id, snowflake guild_id) co_guild_command_delete dpp::cluster::co_guild_command_delete snowflake id snowflake guild_id

Delete a slash command local to a guild.

dpp::cluster::guild_command_delete

https://discord.com/developers/docs/interactions/application-commands#delete-guild-application-command

id

Slash command to delete

guild_id

Guild ID to delete the slash command in

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_delete (snowflake id, snowflake guild_id) co_guild_command_delete dpp::cluster::co_guild_command_delete snowflake id snowflake guild_id

Delete a slash command local to a guild.

dpp::cluster::guild_command_delete

https://discord.com/developers/docs/interactions/application-commands#delete-guild-application-command

id

Slash command to delete

guild_id

Guild ID to delete the slash command in

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_edit (const slashcommand &s, snowflake guild_id) co_guild_command_edit dpp::cluster::co_guild_command_edit const slashcommand & s snowflake guild_id

Edit a slash command local to a guild.

dpp::cluster::guild_command_edit

https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command

s

Slash command to edit

guild_id

Guild ID to edit the slash command in

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_edit (const slashcommand &s, snowflake guild_id) co_guild_command_edit dpp::cluster::co_guild_command_edit const slashcommand & s snowflake guild_id

Edit a slash command local to a guild.

dpp::cluster::guild_command_edit

https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command

s

Slash command to edit

guild_id

Guild ID to edit the slash command in

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_edit_permissions (const slashcommand &s, snowflake guild_id) co_guild_command_edit_permissions dpp::cluster::co_guild_command_edit_permissions const slashcommand & s snowflake guild_id

Edit slash command permissions of a guild.

dpp::cluster::guild_command_edit_permissions

https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions

You can only add up to 10 permission overwrites for a command

s

Slash command to edit the permissions for

guild_id

Guild ID to edit the slash command in

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_edit_permissions (const slashcommand &s, snowflake guild_id) co_guild_command_edit_permissions dpp::cluster::co_guild_command_edit_permissions const slashcommand & s snowflake guild_id

Edit slash command permissions of a guild.

dpp::cluster::guild_command_edit_permissions

https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions

You can only add up to 10 permission overwrites for a command

s

Slash command to edit the permissions for

guild_id

Guild ID to edit the slash command in

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_get (snowflake id, snowflake guild_id) co_guild_command_get dpp::cluster::co_guild_command_get snowflake id snowflake guild_id

Get a slash command of a guild.

dpp::cluster::guild_command_get

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command

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

id

The ID of the slash command

guild_id

Guild ID to get the slash command from

slashcommand returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_get (snowflake id, snowflake guild_id) co_guild_command_get dpp::cluster::co_guild_command_get snowflake id snowflake guild_id

Get a slash command of a guild.

dpp::cluster::guild_command_get

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command

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

id

The ID of the slash command

guild_id

Guild ID to get the slash command from

slashcommand returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_get_permissions (snowflake id, snowflake guild_id) co_guild_command_get_permissions dpp::cluster::co_guild_command_get_permissions snowflake id snowflake guild_id

Get the permissions for a slash command of a guild.

dpp::cluster::guild_command_get_permissions

https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions

id

The ID of the slash command to get the permissions for

guild_id

Guild ID to get the permissions of

guild_command_permissions returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_command_get_permissions (snowflake id, snowflake guild_id) co_guild_command_get_permissions dpp::cluster::co_guild_command_get_permissions snowflake id snowflake guild_id

Get the permissions for a slash command of a guild.

dpp::cluster::guild_command_get_permissions

https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions

id

The ID of the slash command to get the permissions for

guild_id

Guild ID to get the permissions of

guild_command_permissions returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_commands_get (snowflake guild_id) co_guild_commands_get dpp::cluster::co_guild_commands_get snowflake guild_id

Get the application's slash commands for a guild.

dpp::cluster::guild_commands_get

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands

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

guild_id

Guild ID to get the slash commands for

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_commands_get (snowflake guild_id) co_guild_commands_get dpp::cluster::co_guild_commands_get snowflake guild_id

Get the application's slash commands for a guild.

dpp::cluster::guild_commands_get

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands

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

guild_id

Guild ID to get the slash commands for

slashcommand_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_commands_get_permissions (snowflake guild_id) co_guild_commands_get_permissions dpp::cluster::co_guild_commands_get_permissions snowflake guild_id

Get all slash command permissions of a guild.

dpp::cluster::guild_commands_get_permissions

https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions

guild_id

Guild ID to get the slash commands permissions for

guild_command_permissions_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_commands_get_permissions (snowflake guild_id) co_guild_commands_get_permissions dpp::cluster::co_guild_commands_get_permissions snowflake guild_id

Get all slash command permissions of a guild.

dpp::cluster::guild_commands_get_permissions

https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions

guild_id

Guild ID to get the slash commands permissions for

guild_command_permissions_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_create (const class guild &g) co_guild_create dpp::cluster::co_guild_create const class guild & g

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.

dpp::cluster::guild_create

https://discord.com/developers/docs/resources/guild#create-guild

The region field is deprecated and is replaced by channel.rtc_region. This endpoint can be used only by bots in less than 10 guilds.

g

Guild to create

guild returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_create (const class guild &g) co_guild_create dpp::cluster::co_guild_create const class guild & g

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.

dpp::cluster::guild_create

https://discord.com/developers/docs/resources/guild#create-guild

The region field is deprecated and is replaced by channel.rtc_region. This endpoint can be used only by bots in less than 10 guilds.

g

Guild to create

guild returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_create_from_template (const std::string &code, const std::string &name) co_guild_create_from_template dpp::cluster::co_guild_create_from_template const std::string & code const std::string & name

Create a new guild based on a template.

This endpoint can be used only by bots in less than 10 guilds.

dpp::cluster::guild_create_from_template

https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template

code

Template code to create guild from

name

Guild name to create

guild returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_create_from_template (const std::string &code, const std::string &name) co_guild_create_from_template dpp::cluster::co_guild_create_from_template const std::string & code const std::string & name

Create a new guild based on a template.

This endpoint can be used only by bots in less than 10 guilds.

dpp::cluster::guild_create_from_template

https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template

code

Template code to create guild from

name

Guild name to create

guild returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_current_member_edit (snowflake guild_id, const std::string &nickname, const std::string &banner_blob, const image_type banner_type, const std::string &avatar_blob, const image_type avatar_type, const std::string &bio) co_guild_current_member_edit dpp::cluster::co_guild_current_member_edit snowflake guild_id const std::string & nickname const std::string & banner_blob const image_type banner_type const std::string & avatar_blob const image_type avatar_type const std::string & bio

Modify current member.

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_current_member_edit

https://discord.com/developers/docs/resources/guild#modify-current-member

guild_id

Guild ID to change on

nickname

New nickname, or empty string to clear nickname.

banner_blob

New banner, or empty string to clear banner.

banner_type

Type of image for new banner.

avatar_blob

New avatar, or empty string to clear avatar.

avatar_type

Type of image for new avatar.

bio

New bio, or empty string to clear bio

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_current_member_edit (snowflake guild_id, const std::string &nickname, const std::string &banner_blob, const image_type banner_type, const std::string &avatar_blob, const image_type avatar_type, const std::string &bio) co_guild_current_member_edit dpp::cluster::co_guild_current_member_edit snowflake guild_id const std::string & nickname const std::string & banner_blob const image_type banner_type const std::string & avatar_blob const image_type avatar_type const std::string & bio

Modify current member.

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_current_member_edit

https://discord.com/developers/docs/resources/guild#modify-current-member

guild_id

Guild ID to change on

nickname

New nickname, or empty string to clear nickname.

banner_blob

New banner, or empty string to clear banner.

banner_type

Type of image for new banner.

avatar_blob

New avatar, or empty string to clear avatar.

avatar_type

Type of image for new avatar.

bio

New bio, or empty string to clear bio

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_delete (snowflake guild_id) co_guild_delete dpp::cluster::co_guild_delete snowflake guild_id

Delete a guild.

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

dpp::cluster::guild_delete

https://discord.com/developers/docs/resources/guild#delete-guild

guild_id

Guild ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_delete (snowflake guild_id) co_guild_delete dpp::cluster::co_guild_delete snowflake guild_id

Delete a guild.

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

dpp::cluster::guild_delete

https://discord.com/developers/docs/resources/guild#delete-guild

guild_id

Guild ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_delete_integration (snowflake guild_id, snowflake integration_id) co_guild_delete_integration dpp::cluster::co_guild_delete_integration snowflake guild_id snowflake integration_id

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.

dpp::cluster::guild_delete_integration

https://discord.com/developers/docs/resources/guild#delete-guild-integration

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to delete integration for

integration_id

Integration ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_delete_integration (snowflake guild_id, snowflake integration_id) co_guild_delete_integration dpp::cluster::co_guild_delete_integration snowflake guild_id snowflake integration_id

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.

dpp::cluster::guild_delete_integration

https://discord.com/developers/docs/resources/guild#delete-guild-integration

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to delete integration for

integration_id

Integration ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit (const class guild &g) co_guild_edit dpp::cluster::co_guild_edit const class guild & g

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.

dpp::cluster::guild_edit

https://discord.com/developers/docs/resources/guild#modify-guild

This method supports audit log reasons set by the cluster::set_audit_reason() method.

g

Guild to edit

guild returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit (const class guild &g) co_guild_edit dpp::cluster::co_guild_edit const class guild & g

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.

dpp::cluster::guild_edit

https://discord.com/developers/docs/resources/guild#modify-guild

This method supports audit log reasons set by the cluster::set_audit_reason() method.

g

Guild to edit

guild returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit_member (const guild_member &gm) co_guild_edit_member dpp::cluster::co_guild_edit_member const guild_member & gm

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. 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. For moving and disconnecting users from voice, use dpp::cluster::guild_member_move.

dpp::cluster::guild_edit_member

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

gm

Guild member to edit

guild_member returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit_member (const guild_member &gm) co_guild_edit_member dpp::cluster::co_guild_edit_member const guild_member & gm

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. 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. For moving and disconnecting users from voice, use dpp::cluster::guild_member_move.

dpp::cluster::guild_edit_member

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

gm

Guild member to edit

guild_member returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit_onboarding (const struct onboarding &o) co_guild_edit_onboarding dpp::cluster::co_guild_edit_onboarding const struct onboarding & o

Edit the guild's onboarding configuration.

Requires the `MANAGE_GUILD` and `MANAGE_ROLES` permissions.

Onboarding enforces constraints when enabled. These constraints are that there must be at least 7 Default Channels and at least 5 of them must allow sending messages to the @everyone role. The `onboarding::mode` field modifies what is considered when enforcing these constraints.

dpp::cluster::guild_edit_onboarding

https://discord.com/developers/docs/resources/guild#modify-guild-onboarding

This method supports audit log reasons set by the cluster::set_audit_reason() method.

o

The onboarding object

onboarding returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit_onboarding (const struct onboarding &o) co_guild_edit_onboarding dpp::cluster::co_guild_edit_onboarding const struct onboarding & o

Edit the guild's onboarding configuration.

Requires the `MANAGE_GUILD` and `MANAGE_ROLES` permissions.

Onboarding enforces constraints when enabled. These constraints are that there must be at least 7 Default Channels and at least 5 of them must allow sending messages to the @everyone role. The `onboarding::mode` field modifies what is considered when enforcing these constraints.

dpp::cluster::guild_edit_onboarding

https://discord.com/developers/docs/resources/guild#modify-guild-onboarding

This method supports audit log reasons set by the cluster::set_audit_reason() method.

o

The onboarding object

onboarding returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit_welcome_screen (snowflake guild_id, const struct welcome_screen &welcome_screen, bool enabled) co_guild_edit_welcome_screen dpp::cluster::co_guild_edit_welcome_screen snowflake guild_id const struct welcome_screen & welcome_screen bool enabled

Edit the guild's welcome screen.

Requires the `MANAGE_GUILD` permission. May fire a `Guild Update` Gateway event.

dpp::cluster::guild_edit_welcome_screen

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen

guild_id

The guild ID to edit the welcome screen for

welcome_screen

The welcome screen

enabled

Whether the welcome screen should be enabled or disabled

dpp::welcome_screen returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit_welcome_screen (snowflake guild_id, const struct welcome_screen &welcome_screen, bool enabled) co_guild_edit_welcome_screen dpp::cluster::co_guild_edit_welcome_screen snowflake guild_id const struct welcome_screen & welcome_screen bool enabled

Edit the guild's welcome screen.

Requires the `MANAGE_GUILD` permission. May fire a `Guild Update` Gateway event.

dpp::cluster::guild_edit_welcome_screen

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen

guild_id

The guild ID to edit the welcome screen for

welcome_screen

The welcome screen

enabled

Whether the welcome screen should be enabled or disabled

dpp::welcome_screen returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit_widget (snowflake guild_id, const class guild_widget &gw) co_guild_edit_widget dpp::cluster::co_guild_edit_widget snowflake guild_id const class guild_widget & gw

Edit guild widget.

Requires the `MANAGE_GUILD` permission.

dpp::cluster::guild_edit_widget

https://discord.com/developers/docs/resources/guild#modify-guild-widget

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to edit widget for

gw

New guild widget information

guild_widget returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_edit_widget (snowflake guild_id, const class guild_widget &gw) co_guild_edit_widget dpp::cluster::co_guild_edit_widget snowflake guild_id const class guild_widget & gw

Edit guild widget.

Requires the `MANAGE_GUILD` permission.

dpp::cluster::guild_edit_widget

https://discord.com/developers/docs/resources/guild#modify-guild-widget

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to edit widget for

gw

New guild widget information

guild_widget returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emoji_create (snowflake guild_id, const class emoji &newemoji) co_guild_emoji_create dpp::cluster::co_guild_emoji_create snowflake guild_id const class emoji & newemoji

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_emoji_create

https://discord.com/developers/docs/resources/emoji#create-guild-emoji

guild_id

Guild ID to create emoji om

newemoji

Emoji to create

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emoji_create (snowflake guild_id, const class emoji &newemoji) co_guild_emoji_create dpp::cluster::co_guild_emoji_create snowflake guild_id const class emoji & newemoji

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_emoji_create

https://discord.com/developers/docs/resources/emoji#create-guild-emoji

guild_id

Guild ID to create emoji om

newemoji

Emoji to create

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emoji_delete (snowflake guild_id, snowflake emoji_id) co_guild_emoji_delete dpp::cluster::co_guild_emoji_delete snowflake guild_id snowflake emoji_id

Delete a guild emoji.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_emoji_delete

https://discord.com/developers/docs/resources/emoji#delete-guild-emoji

guild_id

Guild ID to delete emoji on

emoji_id

Emoji ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emoji_delete (snowflake guild_id, snowflake emoji_id) co_guild_emoji_delete dpp::cluster::co_guild_emoji_delete snowflake guild_id snowflake emoji_id

Delete a guild emoji.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_emoji_delete

https://discord.com/developers/docs/resources/emoji#delete-guild-emoji

guild_id

Guild ID to delete emoji on

emoji_id

Emoji ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emoji_edit (snowflake guild_id, const class emoji &newemoji) co_guild_emoji_edit dpp::cluster::co_guild_emoji_edit snowflake guild_id const class emoji & newemoji

Edit a single emoji.

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

dpp::cluster::guild_emoji_edit

https://discord.com/developers/docs/resources/emoji#modify-guild-emoji

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to edit emoji on

newemoji

Emoji to edit

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emoji_edit (snowflake guild_id, const class emoji &newemoji) co_guild_emoji_edit dpp::cluster::co_guild_emoji_edit snowflake guild_id const class emoji & newemoji

Edit a single emoji.

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

dpp::cluster::guild_emoji_edit

https://discord.com/developers/docs/resources/emoji#modify-guild-emoji

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to edit emoji on

newemoji

Emoji to edit

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emoji_get (snowflake guild_id, snowflake emoji_id) co_guild_emoji_get dpp::cluster::co_guild_emoji_get snowflake guild_id snowflake emoji_id

Get a single emoji.

dpp::cluster::guild_emoji_get

https://discord.com/developers/docs/resources/emoji#get-guild-emoji

guild_id

Guild ID to get emoji for

emoji_id

Emoji ID to get

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emoji_get (snowflake guild_id, snowflake emoji_id) co_guild_emoji_get dpp::cluster::co_guild_emoji_get snowflake guild_id snowflake emoji_id

Get a single emoji.

dpp::cluster::guild_emoji_get

https://discord.com/developers/docs/resources/emoji#get-guild-emoji

guild_id

Guild ID to get emoji for

emoji_id

Emoji ID to get

emoji returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emojis_get (snowflake guild_id) co_guild_emojis_get dpp::cluster::co_guild_emojis_get snowflake guild_id

Get all emojis for a guild.

dpp::cluster::guild_emojis_get

https://discord.com/developers/docs/resources/emoji#list-guild-emojis

guild_id

Guild ID to get emojis for

emoji_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_emojis_get (snowflake guild_id) co_guild_emojis_get dpp::cluster::co_guild_emojis_get snowflake guild_id

Get all emojis for a guild.

dpp::cluster::guild_emojis_get

https://discord.com/developers/docs/resources/emoji#list-guild-emojis

guild_id

Guild ID to get emojis for

emoji_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_event_create (const scheduled_event &event) co_guild_event_create dpp::cluster::co_guild_event_create const scheduled_event & event

Create a scheduled event on a guild.

dpp::cluster::guild_event_create

https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event

event

Event to create (guild ID must be populated)

scheduled_event returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_event_create (const scheduled_event &event) co_guild_event_create dpp::cluster::co_guild_event_create const scheduled_event & event

Create a scheduled event on a guild.

dpp::cluster::guild_event_create

https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event

event

Event to create (guild ID must be populated)

scheduled_event returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_event_delete (snowflake event_id, snowflake guild_id) co_guild_event_delete dpp::cluster::co_guild_event_delete snowflake event_id snowflake guild_id

Delete a scheduled event from a guild.

dpp::cluster::guild_event_delete

https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event

event_id

Event ID to delete

guild_id

Guild ID of event to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_event_delete (snowflake event_id, snowflake guild_id) co_guild_event_delete dpp::cluster::co_guild_event_delete snowflake event_id snowflake guild_id

Delete a scheduled event from a guild.

dpp::cluster::guild_event_delete

https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event

event_id

Event ID to delete

guild_id

Guild ID of event to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_event_edit (const scheduled_event &event) co_guild_event_edit dpp::cluster::co_guild_event_edit const scheduled_event & event

Edit/modify a scheduled event on a guild.

dpp::cluster::guild_event_edit

https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event

event

Event to create (event ID and guild ID must be populated)

scheduled_event returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_event_edit (const scheduled_event &event) co_guild_event_edit dpp::cluster::co_guild_event_edit const scheduled_event & event

Edit/modify a scheduled event on a guild.

dpp::cluster::guild_event_edit

https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event

event

Event to create (event ID and guild ID must be populated)

scheduled_event returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_event_get (snowflake guild_id, snowflake event_id) co_guild_event_get dpp::cluster::co_guild_event_get snowflake guild_id snowflake event_id

Get a scheduled event for a guild.

dpp::cluster::guild_event_get

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event

guild_id

Guild to get event for

event_id

Event ID to get

scheduled_event returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_event_get (snowflake guild_id, snowflake event_id) co_guild_event_get dpp::cluster::co_guild_event_get snowflake guild_id snowflake event_id

Get a scheduled event for a guild.

dpp::cluster::guild_event_get

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event

guild_id

Guild to get event for

event_id

Event ID to get

scheduled_event returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_events_get (snowflake guild_id) co_guild_events_get dpp::cluster::co_guild_events_get snowflake guild_id

Get all scheduled events for a guild.

dpp::cluster::guild_events_get

https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild

guild_id

Guild to get events for

scheduled_event_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_events_get (snowflake guild_id) co_guild_events_get dpp::cluster::co_guild_events_get snowflake guild_id

Get all scheduled events for a guild.

dpp::cluster::guild_events_get

https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild

guild_id

Guild to get events for

scheduled_event_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > dpp::cluster::co_guild_get (snowflake guild_id) co_guild_get dpp::cluster::co_guild_get snowflake guild_id
async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_ban (snowflake guild_id, snowflake user_id) co_guild_get_ban dpp::cluster::co_guild_get_ban snowflake guild_id snowflake user_id

Get single guild ban.

Requires the `BAN_MEMBERS` permission.

dpp::cluster::guild_get_ban

https://discord.com/developers/docs/resources/guild#get-guild-ban

guild_id

Guild ID to get ban for

user_id

User ID of ban to retrieve

ban returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_ban (snowflake guild_id, snowflake user_id) co_guild_get_ban dpp::cluster::co_guild_get_ban snowflake guild_id snowflake user_id

Get single guild ban.

Requires the `BAN_MEMBERS` permission.

dpp::cluster::guild_get_ban

https://discord.com/developers/docs/resources/guild#get-guild-ban

guild_id

Guild ID to get ban for

user_id

User ID of ban to retrieve

ban returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_bans (snowflake guild_id, snowflake before, snowflake after, snowflake limit) co_guild_get_bans dpp::cluster::co_guild_get_bans snowflake guild_id snowflake before snowflake after snowflake limit

Get guild ban list.

Requires the `BAN_MEMBERS` permission.

dpp::cluster::guild_get_bans

https://discord.com/developers/docs/resources/guild#get-guild-bans

Provide a user ID to `before` and `after` for pagination. Users will always be returned in ascending order by the user ID. If both before and after are provided, only before is respected.

guild_id

Guild ID to get bans for

before

If non-zero, all bans for user ids before this user id will be returned up to the limit

after

if non-zero, all bans for user ids after this user id will be returned up to the limit

limit

the maximum number of bans to retrieve in this call up to a maximum of 1000

ban_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_bans (snowflake guild_id, snowflake before, snowflake after, snowflake limit) co_guild_get_bans dpp::cluster::co_guild_get_bans snowflake guild_id snowflake before snowflake after snowflake limit

Get guild ban list.

Requires the `BAN_MEMBERS` permission.

dpp::cluster::guild_get_bans

https://discord.com/developers/docs/resources/guild#get-guild-bans

Provide a user ID to `before` and `after` for pagination. Users will always be returned in ascending order by the user ID. If both before and after are provided, only before is respected.

guild_id

Guild ID to get bans for

before

If non-zero, all bans for user ids before this user id will be returned up to the limit

after

if non-zero, all bans for user ids after this user id will be returned up to the limit

limit

the maximum number of bans to retrieve in this call up to a maximum of 1000

ban_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_integrations (snowflake guild_id) co_guild_get_integrations dpp::cluster::co_guild_get_integrations snowflake guild_id

Get guild integrations.

Requires the `MANAGE_GUILD` permission.

dpp::cluster::guild_get_integrations

https://discord.com/developers/docs/resources/guild#get-guild-integrations

guild_id

Guild ID to get integrations for

integration_map returned object on completion

This endpoint returns a maximum of 50 integrations. If a guild has more integrations, they cannot be accessed.

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_integrations (snowflake guild_id) co_guild_get_integrations dpp::cluster::co_guild_get_integrations snowflake guild_id

Get guild integrations.

Requires the `MANAGE_GUILD` permission.

dpp::cluster::guild_get_integrations

https://discord.com/developers/docs/resources/guild#get-guild-integrations

guild_id

Guild ID to get integrations for

integration_map returned object on completion

This endpoint returns a maximum of 50 integrations. If a guild has more integrations, they cannot be accessed.

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_invites (snowflake guild_id) co_guild_get_invites dpp::cluster::co_guild_get_invites snowflake guild_id

Get guild invites.

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

dpp::cluster::guild_get_invites

https://discord.com/developers/docs/resources/guild#get-guild-invites

guild_id

Guild ID to get invites for

invite_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_invites (snowflake guild_id) co_guild_get_invites dpp::cluster::co_guild_get_invites snowflake guild_id

Get guild invites.

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

dpp::cluster::guild_get_invites

https://discord.com/developers/docs/resources/guild#get-guild-invites

guild_id

Guild ID to get invites for

invite_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_member (snowflake guild_id, snowflake user_id) co_guild_get_member dpp::cluster::co_guild_get_member snowflake guild_id snowflake user_id

Get a guild member.

dpp::cluster::guild_get_member

https://discord.com/developers/docs/resources/guild#get-guild-member

guild_id

Guild ID to get member for

user_id

User ID of member to get

guild_member returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_member (snowflake guild_id, snowflake user_id) co_guild_get_member dpp::cluster::co_guild_get_member snowflake guild_id snowflake user_id

Get a guild member.

dpp::cluster::guild_get_member

https://discord.com/developers/docs/resources/guild#get-guild-member

guild_id

Guild ID to get member for

user_id

User ID of member to get

guild_member returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_members (snowflake guild_id, uint16_t limit, snowflake after) co_guild_get_members dpp::cluster::co_guild_get_members snowflake guild_id uint16_t limit snowflake after

Get all guild members.

This endpoint is restricted according to whether the `GUILD_MEMBERS` Privileged Intent is enabled for your application.

dpp::cluster::guild_get_members

https://discord.com/developers/docs/resources/guild#get-guild-members

guild_id

Guild ID to get all members for

limit

max number of members to return (1-1000)

after

the highest user id in the previous page

guild_member_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_members (snowflake guild_id, uint16_t limit, snowflake after) co_guild_get_members dpp::cluster::co_guild_get_members snowflake guild_id uint16_t limit snowflake after

Get all guild members.

This endpoint is restricted according to whether the `GUILD_MEMBERS` Privileged Intent is enabled for your application.

dpp::cluster::guild_get_members

https://discord.com/developers/docs/resources/guild#get-guild-members

guild_id

Guild ID to get all members for

limit

max number of members to return (1-1000)

after

the highest user id in the previous page

guild_member_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_onboarding (snowflake guild_id) co_guild_get_onboarding dpp::cluster::co_guild_get_onboarding snowflake guild_id

Get the guild's onboarding configuration.

dpp::cluster::guild_get_onboarding

https://discord.com/developers/docs/resources/guild#get-guild-onboarding

guild_id

The guild to pull the onboarding configuration from.

onboarding returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_onboarding (snowflake guild_id) co_guild_get_onboarding dpp::cluster::co_guild_get_onboarding snowflake guild_id

Get the guild's onboarding configuration.

dpp::cluster::guild_get_onboarding

https://discord.com/developers/docs/resources/guild#get-guild-onboarding

guild_id

The guild to pull the onboarding configuration from.

onboarding returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > dpp::cluster::co_guild_get_preview (snowflake guild_id) co_guild_get_preview dpp::cluster::co_guild_get_preview snowflake guild_id
async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_prune_counts (snowflake guild_id, const struct prune &pruneinfo) co_guild_get_prune_counts dpp::cluster::co_guild_get_prune_counts snowflake guild_id const struct prune & pruneinfo

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.

dpp::cluster::guild_get_prune_counts

https://discord.com/developers/docs/resources/guild#get-guild-prune-count

guild_id

Guild ID to count for pruning

pruneinfo

Pruning info

prune returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_prune_counts (snowflake guild_id, const struct prune &pruneinfo) co_guild_get_prune_counts dpp::cluster::co_guild_get_prune_counts snowflake guild_id const struct prune & pruneinfo

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.

dpp::cluster::guild_get_prune_counts

https://discord.com/developers/docs/resources/guild#get-guild-prune-count

guild_id

Guild ID to count for pruning

pruneinfo

Pruning info

prune returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_vanity (snowflake guild_id) co_guild_get_vanity dpp::cluster::co_guild_get_vanity snowflake guild_id

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.

dpp::cluster::guild_get_vanity

https://discord.com/developers/docs/resources/guild#get-guild-vanity-url

guild_id

Guild to get vanity URL for

invite returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_vanity (snowflake guild_id) co_guild_get_vanity dpp::cluster::co_guild_get_vanity snowflake guild_id

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.

dpp::cluster::guild_get_vanity

https://discord.com/developers/docs/resources/guild#get-guild-vanity-url

guild_id

Guild to get vanity URL for

invite returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_voice_regions (snowflake guild_id) co_guild_get_voice_regions dpp::cluster::co_guild_get_voice_regions snowflake guild_id

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.

dpp::cluster::guild_get_voice_regions

https://discord.com/developers/docs/resources/guild#get-guild-voice-regions

guild_id

Guild ID to get voice regions for

voiceregion_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_voice_regions (snowflake guild_id) co_guild_get_voice_regions dpp::cluster::co_guild_get_voice_regions snowflake guild_id

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.

dpp::cluster::guild_get_voice_regions

https://discord.com/developers/docs/resources/guild#get-guild-voice-regions

guild_id

Guild ID to get voice regions for

voiceregion_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_welcome_screen (snowflake guild_id) co_guild_get_welcome_screen dpp::cluster::co_guild_get_welcome_screen snowflake guild_id

Get the guild's welcome screen.

If the welcome screen is not enabled, the `MANAGE_GUILD` permission is required.

dpp::cluster::guild_get_welcome_screen

https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen

guild_id

The guild ID to get the welcome screen from

dpp::welcome_screen returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_welcome_screen (snowflake guild_id) co_guild_get_welcome_screen dpp::cluster::co_guild_get_welcome_screen snowflake guild_id

Get the guild's welcome screen.

If the welcome screen is not enabled, the `MANAGE_GUILD` permission is required.

dpp::cluster::guild_get_welcome_screen

https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen

guild_id

The guild ID to get the welcome screen from

dpp::welcome_screen returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_widget (snowflake guild_id) co_guild_get_widget dpp::cluster::co_guild_get_widget snowflake guild_id

Get guild widget.

Requires the `MANAGE_GUILD` permission.

dpp::cluster::guild_get_widget

https://discord.com/developers/docs/resources/guild#get-guild-widget

guild_id

Guild ID to get widget for

guild_widget returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_get_widget (snowflake guild_id) co_guild_get_widget dpp::cluster::co_guild_get_widget snowflake guild_id

Get guild widget.

Requires the `MANAGE_GUILD` permission.

dpp::cluster::guild_get_widget

https://discord.com/developers/docs/resources/guild#get-guild-widget

guild_id

Guild ID to get widget for

guild_widget returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_add_role (snowflake guild_id, snowflake user_id, snowflake role_id) co_guild_member_add_role dpp::cluster::co_guild_member_add_role snowflake guild_id snowflake user_id snowflake role_id

Add role to guild member.

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

dpp::cluster::guild_member_add_role

https://discord.com/developers/docs/resources/guild#add-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to add a role to

user_id

User ID to add role to

role_id

Role ID to add to the user

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_add_role (snowflake guild_id, snowflake user_id, snowflake role_id) co_guild_member_add_role dpp::cluster::co_guild_member_add_role snowflake guild_id snowflake user_id snowflake role_id

Add role to guild member.

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

dpp::cluster::guild_member_add_role

https://discord.com/developers/docs/resources/guild#add-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to add a role to

user_id

User ID to add role to

role_id

Role ID to add to the user

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_delete (snowflake guild_id, snowflake user_id) co_guild_member_delete dpp::cluster::co_guild_member_delete snowflake guild_id snowflake user_id

Remove (kick) a guild member.

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

dpp::cluster::guild_member_delete

https://discord.com/developers/docs/resources/guild#remove-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

Deprecated

Replaced by dpp::cluster::guild_member_kick

guild_id

Guild ID to kick member from

user_id

User ID to kick

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_delete (snowflake guild_id, snowflake user_id) co_guild_member_delete dpp::cluster::co_guild_member_delete snowflake guild_id snowflake user_id

Remove (kick) a guild member.

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

dpp::cluster::guild_member_delete

https://discord.com/developers/docs/resources/guild#remove-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

Deprecated

Replaced by dpp::cluster::guild_member_kick

guild_id

Guild ID to kick member from

user_id

User ID to kick

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_delete_role (snowflake guild_id, snowflake user_id, snowflake role_id) co_guild_member_delete_role dpp::cluster::co_guild_member_delete_role snowflake guild_id snowflake user_id snowflake role_id

Remove role from guild member.

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

dpp::cluster::guild_member_delete_role

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove role from user on

user_id

User ID to remove role from

role_id

Role to remove

confirmation returned object on completion

Deprecated

Use dpp::cluster::guild_member_remove_role instead

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_delete_role (snowflake guild_id, snowflake user_id, snowflake role_id) co_guild_member_delete_role dpp::cluster::co_guild_member_delete_role snowflake guild_id snowflake user_id snowflake role_id

Remove role from guild member.

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

dpp::cluster::guild_member_delete_role

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove role from user on

user_id

User ID to remove role from

role_id

Role to remove

confirmation returned object on completion

Deprecated

Use dpp::cluster::guild_member_remove_role instead

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_kick (snowflake guild_id, snowflake user_id) co_guild_member_kick dpp::cluster::co_guild_member_kick snowflake guild_id snowflake user_id

Remove (kick) a guild member.

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

dpp::cluster::guild_member_kick

https://discord.com/developers/docs/resources/guild#remove-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to kick member from

user_id

User ID to kick

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_kick (snowflake guild_id, snowflake user_id) co_guild_member_kick dpp::cluster::co_guild_member_kick snowflake guild_id snowflake user_id

Remove (kick) a guild member.

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

dpp::cluster::guild_member_kick

https://discord.com/developers/docs/resources/guild#remove-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to kick member from

user_id

User ID to kick

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_move (const snowflake channel_id, const snowflake guild_id, const snowflake user_id) co_guild_member_move dpp::cluster::co_guild_member_move const snowflake channel_id const snowflake guild_id const snowflake user_id

Moves the guild member to a other voice channel, if member is connected to one. Set the `channel_id` to `0` to disconnect the user.

Fires a `Guild Member Update` Gateway event.

When moving members to channels, the API user must have permissions to both connect to the channel and have the `MOVE_MEMBERS` permission.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_member_move

https://discord.com/developers/docs/resources/guild#modify-guild-member

channel_id

Id of the channel to which the user is used. Set to `0` to disconnect the user

guild_id

Guild id to which the user is connected

user_id

User id, who should be moved

guild_member returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_move (const snowflake channel_id, const snowflake guild_id, const snowflake user_id) co_guild_member_move dpp::cluster::co_guild_member_move const snowflake channel_id const snowflake guild_id const snowflake user_id

Moves the guild member to a other voice channel, if member is connected to one. Set the `channel_id` to `0` to disconnect the user.

Fires a `Guild Member Update` Gateway event.

When moving members to channels, the API user must have permissions to both connect to the channel and have the `MOVE_MEMBERS` permission.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_member_move

https://discord.com/developers/docs/resources/guild#modify-guild-member

channel_id

Id of the channel to which the user is used. Set to `0` to disconnect the user

guild_id

Guild id to which the user is connected

user_id

User id, who should be moved

guild_member returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_remove_role (snowflake guild_id, snowflake user_id, snowflake role_id) co_guild_member_remove_role dpp::cluster::co_guild_member_remove_role snowflake guild_id snowflake user_id snowflake role_id

Remove role from guild member.

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

dpp::cluster::guild_member_remove_role

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove role from user on

user_id

User ID to remove role from

role_id

Role to remove

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_remove_role (snowflake guild_id, snowflake user_id, snowflake role_id) co_guild_member_remove_role dpp::cluster::co_guild_member_remove_role snowflake guild_id snowflake user_id snowflake role_id

Remove role from guild member.

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

dpp::cluster::guild_member_remove_role

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove role from user on

user_id

User ID to remove role from

role_id

Role to remove

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_timeout (snowflake guild_id, snowflake user_id, time_t communication_disabled_until) co_guild_member_timeout dpp::cluster::co_guild_member_timeout snowflake guild_id snowflake user_id time_t communication_disabled_until

Set the timeout of a guild member.

Fires a `Guild Member Update` Gateway event.

dpp::cluster::guild_member_timeout

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to timeout the member in

user_id

User ID to set the timeout for

communication_disabled_until

The timestamp when the user's timeout will expire (up to 28 days in the future). Set to 0 to remove the timeout

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_timeout (snowflake guild_id, snowflake user_id, time_t communication_disabled_until) co_guild_member_timeout dpp::cluster::co_guild_member_timeout snowflake guild_id snowflake user_id time_t communication_disabled_until

Set the timeout of a guild member.

Fires a `Guild Member Update` Gateway event.

dpp::cluster::guild_member_timeout

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to timeout the member in

user_id

User ID to set the timeout for

communication_disabled_until

The timestamp when the user's timeout will expire (up to 28 days in the future). Set to 0 to remove the timeout

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_timeout_remove (snowflake guild_id, snowflake user_id) co_guild_member_timeout_remove dpp::cluster::co_guild_member_timeout_remove snowflake guild_id snowflake user_id

Remove the timeout of a guild member. A shortcut for guild_member_timeout(guild_id, user_id, 0, callback) Fires a `Guild Member Update` Gateway event.

dpp::cluster::guild_member_timeout_remove

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove the member timeout from

user_id

User ID to remove the timeout for

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_member_timeout_remove (snowflake guild_id, snowflake user_id) co_guild_member_timeout_remove dpp::cluster::co_guild_member_timeout_remove snowflake guild_id snowflake user_id

Remove the timeout of a guild member. A shortcut for guild_member_timeout(guild_id, user_id, 0, callback) Fires a `Guild Member Update` Gateway event.

dpp::cluster::guild_member_timeout_remove

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove the member timeout from

user_id

User ID to remove the timeout for

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_messages_search (snowflake guild_id, const message_search_params &params) co_guild_messages_search dpp::cluster::co_guild_messages_search snowflake guild_id const message_search_params & params

Search for messages in a guild.

dpp::cluster::guild_messages_search

https://discord.com/developers/docs/resources/message#search-guild-messages

guild_id

Guild ID to search in

params

Search parameters

message_search_result returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_messages_search (snowflake guild_id, const message_search_params &params) co_guild_messages_search dpp::cluster::co_guild_messages_search snowflake guild_id const message_search_params & params

Search for messages in a guild.

dpp::cluster::guild_messages_search

https://discord.com/developers/docs/resources/message#search-guild-messages

guild_id

Guild ID to search in

params

Search parameters

message_search_result returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_modify_integration (snowflake guild_id, const class integration &i) co_guild_modify_integration dpp::cluster::co_guild_modify_integration snowflake guild_id const class integration & i

Modify guild integration.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_modify_integration

https://discord.com/developers/docs/resources/guild#modify-guild-integration

guild_id

Guild ID to modify integration for

i

Integration to modify

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_modify_integration (snowflake guild_id, const class integration &i) co_guild_modify_integration dpp::cluster::co_guild_modify_integration snowflake guild_id const class integration & i

Modify guild integration.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_modify_integration

https://discord.com/developers/docs/resources/guild#modify-guild-integration

guild_id

Guild ID to modify integration for

i

Integration to modify

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_search_members (snowflake guild_id, const std::string &query, uint16_t limit) co_guild_search_members dpp::cluster::co_guild_search_members snowflake guild_id const std::string & query uint16_t limit

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

This endpoint is restricted according to whether the `GUILD_MEMBERS` Privileged Intent is enabled for your application.

dpp::cluster::guild_search_members

https://discord.com/developers/docs/resources/guild#search-guild-members

guild_id

Guild ID to search in

query

Query string to match username(s) and nickname(s) against

limit

max number of members to return (1-1000)

guild_member_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_search_members (snowflake guild_id, const std::string &query, uint16_t limit) co_guild_search_members dpp::cluster::co_guild_search_members snowflake guild_id const std::string & query uint16_t limit

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

This endpoint is restricted according to whether the `GUILD_MEMBERS` Privileged Intent is enabled for your application.

dpp::cluster::guild_search_members

https://discord.com/developers/docs/resources/guild#search-guild-members

guild_id

Guild ID to search in

query

Query string to match username(s) and nickname(s) against

limit

max number of members to return (1-1000)

guild_member_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_set_nickname (snowflake guild_id, const std::string &nickname) co_guild_set_nickname dpp::cluster::co_guild_set_nickname snowflake guild_id const std::string & nickname

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_set_nickname

https://discord.com/developers/docs/resources/guild#modify-current-user-nick

guild_id

Guild ID to change nickname on

nickname

New nickname, or empty string to clear nickname

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_set_nickname (snowflake guild_id, const std::string &nickname) co_guild_set_nickname dpp::cluster::co_guild_set_nickname snowflake guild_id const std::string & nickname

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_set_nickname

https://discord.com/developers/docs/resources/guild#modify-current-user-nick

guild_id

Guild ID to change nickname on

nickname

New nickname, or empty string to clear nickname

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sticker_create (const sticker &s) co_guild_sticker_create dpp::cluster::co_guild_sticker_create const sticker & s

Create a sticker in a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_sticker_create

https://discord.com/developers/docs/resources/sticker#create-guild-sticker

s

Sticker to create. Must have its guild ID set.

sticker returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sticker_create (const sticker &s) co_guild_sticker_create dpp::cluster::co_guild_sticker_create const sticker & s

Create a sticker in a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_sticker_create

https://discord.com/developers/docs/resources/sticker#create-guild-sticker

s

Sticker to create. Must have its guild ID set.

sticker returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sticker_delete (snowflake sticker_id, snowflake guild_id) co_guild_sticker_delete dpp::cluster::co_guild_sticker_delete snowflake sticker_id snowflake guild_id

Delete a sticker from a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_sticker_delete

https://discord.com/developers/docs/resources/sticker#delete-guild-sticker

sticker_id

sticker ID to delete

guild_id

guild ID to delete from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sticker_delete (snowflake sticker_id, snowflake guild_id) co_guild_sticker_delete dpp::cluster::co_guild_sticker_delete snowflake sticker_id snowflake guild_id

Delete a sticker from a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_sticker_delete

https://discord.com/developers/docs/resources/sticker#delete-guild-sticker

sticker_id

sticker ID to delete

guild_id

guild ID to delete from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sticker_get (snowflake id, snowflake guild_id) co_guild_sticker_get dpp::cluster::co_guild_sticker_get snowflake id snowflake guild_id

Get a guild sticker.

dpp::cluster::guild_sticker_get

https://discord.com/developers/docs/resources/sticker#get-guild-sticker

id

Id of sticker to get.

guild_id

Guild ID of the guild where the sticker is

sticker returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sticker_get (snowflake id, snowflake guild_id) co_guild_sticker_get dpp::cluster::co_guild_sticker_get snowflake id snowflake guild_id

Get a guild sticker.

dpp::cluster::guild_sticker_get

https://discord.com/developers/docs/resources/sticker#get-guild-sticker

id

Id of sticker to get.

guild_id

Guild ID of the guild where the sticker is

sticker returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sticker_modify (const sticker &s) co_guild_sticker_modify dpp::cluster::co_guild_sticker_modify const sticker & s

Modify a sticker in a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_sticker_modify

https://discord.com/developers/docs/resources/sticker#modify-guild-sticker

s

Sticker to modify. Must have its guild ID and sticker ID set.

sticker returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sticker_modify (const sticker &s) co_guild_sticker_modify dpp::cluster::co_guild_sticker_modify const sticker & s

Modify a sticker in a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::guild_sticker_modify

https://discord.com/developers/docs/resources/sticker#modify-guild-sticker

s

Sticker to modify. Must have its guild ID and sticker ID set.

sticker returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_stickers_get (snowflake guild_id) co_guild_stickers_get dpp::cluster::co_guild_stickers_get snowflake guild_id

Get all guild stickers.

dpp::cluster::guild_stickers_get

https://discord.com/developers/docs/resources/sticker#list-guild-stickers

guild_id

Guild ID of the guild where the sticker is

sticker_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_stickers_get (snowflake guild_id) co_guild_stickers_get dpp::cluster::co_guild_stickers_get snowflake guild_id

Get all guild stickers.

dpp::cluster::guild_stickers_get

https://discord.com/developers/docs/resources/sticker#list-guild-stickers

guild_id

Guild ID of the guild where the sticker is

sticker_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sync_integration (snowflake guild_id, snowflake integration_id) co_guild_sync_integration dpp::cluster::co_guild_sync_integration snowflake guild_id snowflake integration_id

Sync guild integration.

dpp::cluster::guild_sync_integration

https://discord.com/developers/docs/resources/guild#sync-guild-integration

guild_id

Guild ID to sync integration on

integration_id

Integration ID to synchronise

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_sync_integration (snowflake guild_id, snowflake integration_id) co_guild_sync_integration dpp::cluster::co_guild_sync_integration snowflake guild_id snowflake integration_id

Sync guild integration.

dpp::cluster::guild_sync_integration

https://discord.com/developers/docs/resources/guild#sync-guild-integration

guild_id

Guild ID to sync integration on

integration_id

Integration ID to synchronise

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_template_create (snowflake guild_id, const std::string &name, const std::string &description) co_guild_template_create dpp::cluster::co_guild_template_create snowflake guild_id const std::string & name const std::string & description

Creates a template for the guild.

dpp::cluster::guild_template_create

https://discord.com/developers/docs/resources/guild-template#create-guild-template

guild_id

Guild to create template from

name

Template name to create

description

Description of template to create

dtemplate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_template_create (snowflake guild_id, const std::string &name, const std::string &description) co_guild_template_create dpp::cluster::co_guild_template_create snowflake guild_id const std::string & name const std::string & description

Creates a template for the guild.

dpp::cluster::guild_template_create

https://discord.com/developers/docs/resources/guild-template#create-guild-template

guild_id

Guild to create template from

name

Template name to create

description

Description of template to create

dtemplate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_template_delete (snowflake guild_id, const std::string &code) co_guild_template_delete dpp::cluster::co_guild_template_delete snowflake guild_id const std::string & code

Deletes the template.

dpp::cluster::guild_template_delete

https://discord.com/developers/docs/resources/guild-template#delete-guild-template

guild_id

Guild ID of template to delete

code

Template code to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_template_delete (snowflake guild_id, const std::string &code) co_guild_template_delete dpp::cluster::co_guild_template_delete snowflake guild_id const std::string & code

Deletes the template.

dpp::cluster::guild_template_delete

https://discord.com/developers/docs/resources/guild-template#delete-guild-template

guild_id

Guild ID of template to delete

code

Template code to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_template_modify (snowflake guild_id, const std::string &code, const std::string &name, const std::string &description) co_guild_template_modify dpp::cluster::co_guild_template_modify snowflake guild_id const std::string & code const std::string & name const std::string & description

Modifies the template's metadata.

dpp::cluster::guild_template_modify

https://discord.com/developers/docs/resources/guild-template#modify-guild-template

guild_id

Guild ID of template to modify

code

Template code to modify

name

New name of template

description

New description of template

dtemplate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_template_modify (snowflake guild_id, const std::string &code, const std::string &name, const std::string &description) co_guild_template_modify dpp::cluster::co_guild_template_modify snowflake guild_id const std::string & code const std::string & name const std::string & description

Modifies the template's metadata.

dpp::cluster::guild_template_modify

https://discord.com/developers/docs/resources/guild-template#modify-guild-template

guild_id

Guild ID of template to modify

code

Template code to modify

name

New name of template

description

New description of template

dtemplate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_template_sync (snowflake guild_id, const std::string &code) co_guild_template_sync dpp::cluster::co_guild_template_sync snowflake guild_id const std::string & code

Syncs the template to the guild's current state.

dpp::cluster::guild_template_sync

https://discord.com/developers/docs/resources/guild-template#sync-guild-template

guild_id

Guild to synchronise template for

code

Code of template to synchronise

dtemplate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_template_sync (snowflake guild_id, const std::string &code) co_guild_template_sync dpp::cluster::co_guild_template_sync snowflake guild_id const std::string & code

Syncs the template to the guild's current state.

dpp::cluster::guild_template_sync

https://discord.com/developers/docs/resources/guild-template#sync-guild-template

guild_id

Guild to synchronise template for

code

Code of template to synchronise

dtemplate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_templates_get (snowflake guild_id) co_guild_templates_get dpp::cluster::co_guild_templates_get snowflake guild_id

Get guild templates.

dpp::cluster::guild_templates_get

https://discord.com/developers/docs/resources/guild-template#get-guild-templates

guild_id

Guild ID to get templates for

dtemplate_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_guild_templates_get (snowflake guild_id) co_guild_templates_get dpp::cluster::co_guild_templates_get snowflake guild_id

Get guild templates.

dpp::cluster::guild_templates_get

https://discord.com/developers/docs/resources/guild-template#get-guild-templates

guild_id

Guild ID to get templates for

dtemplate_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_create (const std::string &token, const message &m) co_interaction_followup_create dpp::cluster::co_interaction_followup_create const std::string & token const message & m

Create a followup message for an interaction.

dpp::cluster::interaction_followup_create

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

token

Token for the interaction webhook

m

followup message to create

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_create (const std::string &token, const message &m) co_interaction_followup_create dpp::cluster::co_interaction_followup_create const std::string & token const message & m

Create a followup message for an interaction.

dpp::cluster::interaction_followup_create

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

token

Token for the interaction webhook

m

followup message to create

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_delete (const std::string &token) co_interaction_followup_delete dpp::cluster::co_interaction_followup_delete const std::string & token

Delete the initial interaction response.

dpp::cluster::interaction_followup_delete

https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response

token

Token for the interaction webhook

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_delete (const std::string &token) co_interaction_followup_delete dpp::cluster::co_interaction_followup_delete const std::string & token

Delete the initial interaction response.

dpp::cluster::interaction_followup_delete

https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response

token

Token for the interaction webhook

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_edit (const std::string &token, const message &m) co_interaction_followup_edit dpp::cluster::co_interaction_followup_edit const std::string & token const message & m

Edit followup message for an interaction The message ID in the message you pass should be correctly set to that of a followup message you previously sent.

dpp::cluster::interaction_followup_edit

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message

token

Token for the interaction webhook

m

message to edit, the ID should be set

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_edit (const std::string &token, const message &m) co_interaction_followup_edit dpp::cluster::co_interaction_followup_edit const std::string & token const message & m

Edit followup message for an interaction The message ID in the message you pass should be correctly set to that of a followup message you previously sent.

dpp::cluster::interaction_followup_edit

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message

token

Token for the interaction webhook

m

message to edit, the ID should be set

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_edit_original (const std::string &token, const message &m) co_interaction_followup_edit_original dpp::cluster::co_interaction_followup_edit_original const std::string & token const message & m

Edit original followup message for an interaction This is an alias for cluster::interaction_response_edit.

dpp::cluster::interaction_followup_edit_original

cluster::interaction_response_edit

token

Token for the interaction webhook

m

message to edit, the ID should be set

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_edit_original (const std::string &token, const message &m) co_interaction_followup_edit_original dpp::cluster::co_interaction_followup_edit_original const std::string & token const message & m

Edit original followup message for an interaction This is an alias for cluster::interaction_response_edit.

dpp::cluster::interaction_followup_edit_original

cluster::interaction_response_edit

token

Token for the interaction webhook

m

message to edit, the ID should be set

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_get (const std::string &token, snowflake message_id) co_interaction_followup_get dpp::cluster::co_interaction_followup_get const std::string & token snowflake message_id

Get the followup message for an interaction.

dpp::cluster::interaction_followup_get

https://discord.com/developers/docs/interactions/receiving-and-responding#get-followup-message

token

Token for the interaction webhook

message_id

message to retrieve

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_get (const std::string &token, snowflake message_id) co_interaction_followup_get dpp::cluster::co_interaction_followup_get const std::string & token snowflake message_id

Get the followup message for an interaction.

dpp::cluster::interaction_followup_get

https://discord.com/developers/docs/interactions/receiving-and-responding#get-followup-message

token

Token for the interaction webhook

message_id

message to retrieve

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_get_original (const std::string &token) co_interaction_followup_get_original dpp::cluster::co_interaction_followup_get_original const std::string & token

Get the original followup message for an interaction This is an alias for cluster::interaction_response_get_original.

dpp::cluster::interaction_followup_get_original

cluster::interaction_response_get_original

token

Token for the interaction webhook

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_followup_get_original (const std::string &token) co_interaction_followup_get_original dpp::cluster::co_interaction_followup_get_original const std::string & token

Get the original followup message for an interaction This is an alias for cluster::interaction_response_get_original.

dpp::cluster::interaction_followup_get_original

cluster::interaction_response_get_original

token

Token for the interaction webhook

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_response_create (snowflake interaction_id, const std::string &token, const interaction_response &r) co_interaction_response_create dpp::cluster::co_interaction_response_create snowflake interaction_id const std::string & token const interaction_response & r

Respond to a slash command.

dpp::cluster::interaction_response_create

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

interaction_id

Interaction id to respond to

token

Token for the interaction webhook

r

Response to send

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_response_create (snowflake interaction_id, const std::string &token, const interaction_response &r) co_interaction_response_create dpp::cluster::co_interaction_response_create snowflake interaction_id const std::string & token const interaction_response & r

Respond to a slash command.

dpp::cluster::interaction_response_create

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

interaction_id

Interaction id to respond to

token

Token for the interaction webhook

r

Response to send

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_response_edit (const std::string &token, const message &m) co_interaction_response_edit dpp::cluster::co_interaction_response_edit const std::string & token const message & m

Edit response to a slash command.

dpp::cluster::interaction_response_edit

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response

token

Token for the interaction webhook

m

Message to send

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_response_edit (const std::string &token, const message &m) co_interaction_response_edit dpp::cluster::co_interaction_response_edit const std::string & token const message & m

Edit response to a slash command.

dpp::cluster::interaction_response_edit

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response

token

Token for the interaction webhook

m

Message to send

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_response_get_original (const std::string &token) co_interaction_response_get_original dpp::cluster::co_interaction_response_get_original const std::string & token

Get the original response to a slash command.

dpp::cluster::interaction_response_get_original

https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response

token

Token for the interaction webhook

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_interaction_response_get_original (const std::string &token) co_interaction_response_get_original dpp::cluster::co_interaction_response_get_original const std::string & token

Get the original response to a slash command.

dpp::cluster::interaction_response_get_original

https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response

token

Token for the interaction webhook

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > dpp::cluster::co_invite_delete (const std::string &invitecode) co_invite_delete dpp::cluster::co_invite_delete const std::string & invitecode
async< confirmation_callback_t > async< confirmation_callback_t > co_invite_get (const std::string &invite_code) co_invite_get dpp::cluster::co_invite_get const std::string & invite_code

Get details about an invite.

dpp::cluster::invite_get

https://discord.com/developers/docs/resources/invite#get-invite

invite_code

Invite code to get information on

invite returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_invite_get (const std::string &invite_code) co_invite_get dpp::cluster::co_invite_get const std::string & invite_code

Get details about an invite.

dpp::cluster::invite_get

https://discord.com/developers/docs/resources/invite#get-invite

invite_code

Invite code to get information on

invite returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_add_reaction (const struct message &m, const std::string &reaction) co_message_add_reaction dpp::cluster::co_message_add_reaction const struct message & m const std::string & reaction

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

dpp::cluster::message_add_reaction

https://discord.com/developers/docs/resources/channel#create-reaction

m

Message to add a reaction to

reaction

Reaction to add. Emojis should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_add_reaction (const struct message &m, const std::string &reaction) co_message_add_reaction dpp::cluster::co_message_add_reaction const struct message & m const std::string & reaction

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

dpp::cluster::message_add_reaction

https://discord.com/developers/docs/resources/channel#create-reaction

m

Message to add a reaction to

reaction

Reaction to add. Emojis should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_add_reaction (snowflake message_id, snowflake channel_id, const std::string &reaction) co_message_add_reaction dpp::cluster::co_message_add_reaction snowflake message_id snowflake channel_id const std::string & reaction

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

dpp::cluster::message_add_reaction

https://discord.com/developers/docs/topics/gateway#message-reaction-add

message_id

Message to add reactions to

channel_id

Channel to add reactions to

reaction

Reaction to add. Emojis should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_add_reaction (snowflake message_id, snowflake channel_id, const std::string &reaction) co_message_add_reaction dpp::cluster::co_message_add_reaction snowflake message_id snowflake channel_id const std::string & reaction

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

dpp::cluster::message_add_reaction

https://discord.com/developers/docs/topics/gateway#message-reaction-add

message_id

Message to add reactions to

channel_id

Channel to add reactions to

reaction

Reaction to add. Emojis should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_create (const struct message &m) co_message_create dpp::cluster::co_message_create const struct message & m

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

dpp::cluster::message_create

https://discord.com/developers/docs/resources/channel#create-message

m

Message to send

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_create (const struct message &m) co_message_create dpp::cluster::co_message_create const struct message & m

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

dpp::cluster::message_create

https://discord.com/developers/docs/resources/channel#create-message

m

Message to send

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_crosspost (snowflake message_id, snowflake channel_id) co_message_crosspost dpp::cluster::co_message_crosspost snowflake message_id snowflake channel_id

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

dpp::cluster::message_crosspost

https://discord.com/developers/docs/resources/channel#crosspost-message

message_id

Message to crosspost

channel_id

Channel ID to crosspost from

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_crosspost (snowflake message_id, snowflake channel_id) co_message_crosspost dpp::cluster::co_message_crosspost snowflake message_id snowflake channel_id

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

dpp::cluster::message_crosspost

https://discord.com/developers/docs/resources/channel#crosspost-message

message_id

Message to crosspost

channel_id

Channel ID to crosspost from

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete (snowflake message_id, snowflake channel_id) co_message_delete dpp::cluster::co_message_delete snowflake message_id snowflake channel_id

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::message_delete

https://discord.com/developers/docs/resources/channel#delete-message

message_id

Message ID to delete

channel_id

Channel to delete from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete (snowflake message_id, snowflake channel_id) co_message_delete dpp::cluster::co_message_delete snowflake message_id snowflake channel_id

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::message_delete

https://discord.com/developers/docs/resources/channel#delete-message

message_id

Message ID to delete

channel_id

Channel to delete from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_all_reactions (const struct message &m) co_message_delete_all_reactions dpp::cluster::co_message_delete_all_reactions const struct message & m

Delete all reactions on a message.

dpp::cluster::message_delete_all_reactions

https://discord.com/developers/docs/resources/channel#delete-all-reactions

m

Message to delete reactions from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_all_reactions (const struct message &m) co_message_delete_all_reactions dpp::cluster::co_message_delete_all_reactions const struct message & m

Delete all reactions on a message.

dpp::cluster::message_delete_all_reactions

https://discord.com/developers/docs/resources/channel#delete-all-reactions

m

Message to delete reactions from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_all_reactions (snowflake message_id, snowflake channel_id) co_message_delete_all_reactions dpp::cluster::co_message_delete_all_reactions snowflake message_id snowflake channel_id

Delete all reactions on a message by id.

dpp::cluster::message_delete_all_reactions

https://discord.com/developers/docs/resources/channel#delete-all-reactions

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_all_reactions (snowflake message_id, snowflake channel_id) co_message_delete_all_reactions dpp::cluster::co_message_delete_all_reactions snowflake message_id snowflake channel_id

Delete all reactions on a message by id.

dpp::cluster::message_delete_all_reactions

https://discord.com/developers/docs/resources/channel#delete-all-reactions

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_bulk (const std::vector< snowflake > &message_ids, snowflake channel_id) co_message_delete_bulk dpp::cluster::co_message_delete_bulk const std::vector< snowflake > & message_ids snowflake channel_id

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

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.

dpp::cluster::message_delete_bulk

https://discord.com/developers/docs/resources/channel#bulk-delete-messages

message_ids

List of message IDs to delete (at least 2 and at most 100 message IDs)

channel_id

Channel to delete from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_bulk (const std::vector< snowflake > &message_ids, snowflake channel_id) co_message_delete_bulk dpp::cluster::co_message_delete_bulk const std::vector< snowflake > & message_ids snowflake channel_id

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

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.

dpp::cluster::message_delete_bulk

https://discord.com/developers/docs/resources/channel#bulk-delete-messages

message_ids

List of message IDs to delete (at least 2 and at most 100 message IDs)

channel_id

Channel to delete from

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_own_reaction (const struct message &m, const std::string &reaction) co_message_delete_own_reaction dpp::cluster::co_message_delete_own_reaction const struct message & m const std::string & reaction

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

dpp::cluster::message_delete_own_reaction

https://discord.com/developers/docs/resources/channel#delete-own-reaction

m

Message to delete own reaction from

reaction

Reaction to delete. The reaction should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_own_reaction (const struct message &m, const std::string &reaction) co_message_delete_own_reaction dpp::cluster::co_message_delete_own_reaction const struct message & m const std::string & reaction

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

dpp::cluster::message_delete_own_reaction

https://discord.com/developers/docs/resources/channel#delete-own-reaction

m

Message to delete own reaction from

reaction

Reaction to delete. The reaction should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_own_reaction (snowflake message_id, snowflake channel_id, const std::string &reaction) co_message_delete_own_reaction dpp::cluster::co_message_delete_own_reaction snowflake message_id snowflake channel_id const std::string & reaction

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

dpp::cluster::message_delete_own_reaction

https://discord.com/developers/docs/resources/channel#delete-own-reaction

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

reaction

Reaction to delete. The reaction should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_own_reaction (snowflake message_id, snowflake channel_id, const std::string &reaction) co_message_delete_own_reaction dpp::cluster::co_message_delete_own_reaction snowflake message_id snowflake channel_id const std::string & reaction

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

dpp::cluster::message_delete_own_reaction

https://discord.com/developers/docs/resources/channel#delete-own-reaction

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

reaction

Reaction to delete. The reaction should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_reaction (const struct message &m, snowflake user_id, const std::string &reaction) co_message_delete_reaction dpp::cluster::co_message_delete_reaction const struct message & m snowflake user_id const std::string & reaction

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

dpp::cluster::message_delete_reaction

https://discord.com/developers/docs/resources/channel#delete-user-reaction

m

Message to delete a user's reaction from

user_id

User ID who's reaction you want to remove

reaction

Reaction to remove. Reactions should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_reaction (const struct message &m, snowflake user_id, const std::string &reaction) co_message_delete_reaction dpp::cluster::co_message_delete_reaction const struct message & m snowflake user_id const std::string & reaction

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

dpp::cluster::message_delete_reaction

https://discord.com/developers/docs/resources/channel#delete-user-reaction

m

Message to delete a user's reaction from

user_id

User ID who's reaction you want to remove

reaction

Reaction to remove. Reactions should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_reaction (snowflake message_id, snowflake channel_id, snowflake user_id, const std::string &reaction) co_message_delete_reaction dpp::cluster::co_message_delete_reaction snowflake message_id snowflake channel_id snowflake user_id const std::string & reaction

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

dpp::cluster::message_delete_reaction

https://discord.com/developers/docs/resources/channel#delete-user-reaction

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

user_id

User ID who's reaction you want to remove

reaction

Reaction to remove. Reactions should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_reaction (snowflake message_id, snowflake channel_id, snowflake user_id, const std::string &reaction) co_message_delete_reaction dpp::cluster::co_message_delete_reaction snowflake message_id snowflake channel_id snowflake user_id const std::string & reaction

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

dpp::cluster::message_delete_reaction

https://discord.com/developers/docs/resources/channel#delete-user-reaction

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

user_id

User ID who's reaction you want to remove

reaction

Reaction to remove. Reactions should be in the form emojiname:id

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_reaction_emoji (const struct message &m, const std::string &reaction) co_message_delete_reaction_emoji dpp::cluster::co_message_delete_reaction_emoji const struct message & m const std::string & reaction

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

dpp::cluster::message_delete_reaction_emoji

https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji

m

Message to delete reactions from

reaction

Reaction to delete, in the form emojiname:id or a unicode character

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_reaction_emoji (const struct message &m, const std::string &reaction) co_message_delete_reaction_emoji dpp::cluster::co_message_delete_reaction_emoji const struct message & m const std::string & reaction

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

dpp::cluster::message_delete_reaction_emoji

https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji

m

Message to delete reactions from

reaction

Reaction to delete, in the form emojiname:id or a unicode character

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_reaction_emoji (snowflake message_id, snowflake channel_id, const std::string &reaction) co_message_delete_reaction_emoji dpp::cluster::co_message_delete_reaction_emoji snowflake message_id snowflake channel_id const std::string & reaction

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.

dpp::cluster::message_delete_reaction_emoji

https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

reaction

Reaction to delete, in the form emojiname:id or a unicode character

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_delete_reaction_emoji (snowflake message_id, snowflake channel_id, const std::string &reaction) co_message_delete_reaction_emoji dpp::cluster::co_message_delete_reaction_emoji snowflake message_id snowflake channel_id const std::string & reaction

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.

dpp::cluster::message_delete_reaction_emoji

https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

reaction

Reaction to delete, in the form emojiname:id or a unicode character

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_edit (const struct message &m) co_message_edit dpp::cluster::co_message_edit const struct message & m

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

dpp::cluster::message_edit

https://discord.com/developers/docs/resources/channel#edit-message

m

Message to edit

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_edit (const struct message &m) co_message_edit dpp::cluster::co_message_edit const struct message & m

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

dpp::cluster::message_edit

https://discord.com/developers/docs/resources/channel#edit-message

m

Message to edit

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_edit_flags (const struct message &m) co_message_edit_flags dpp::cluster::co_message_edit_flags const struct message & m

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

m

Message to edit the flags of

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_edit_flags (const struct message &m) co_message_edit_flags dpp::cluster::co_message_edit_flags const struct message & m

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

m

Message to edit the flags of

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_get (snowflake message_id, snowflake channel_id) co_message_get dpp::cluster::co_message_get snowflake message_id snowflake channel_id

Get a message.

dpp::cluster::message_get

https://discord.com/developers/docs/resources/channel#get-channel-message

message_id

Message ID

channel_id

Channel ID

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_get (snowflake message_id, snowflake channel_id) co_message_get dpp::cluster::co_message_get snowflake message_id snowflake channel_id

Get a message.

dpp::cluster::message_get

https://discord.com/developers/docs/resources/channel#get-channel-message

message_id

Message ID

channel_id

Channel ID

message returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_get_reactions (const struct message &m, const std::string &reaction, snowflake before, snowflake after, snowflake limit) co_message_get_reactions dpp::cluster::co_message_get_reactions const struct message & m const std::string & reaction snowflake before snowflake after snowflake limit

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

dpp::cluster::message_get_reactions

https://discord.com/developers/docs/resources/channel#get-reactions

m

Message to get reactions for

reaction

Reaction should be in the form emojiname:id or a unicode character

before

Reactions before this ID should be retrieved if this is set to non-zero

after

Reactions before this ID should be retrieved if this is set to non-zero

limit

This number of reactions maximum should be returned

user_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_get_reactions (const struct message &m, const std::string &reaction, snowflake before, snowflake after, snowflake limit) co_message_get_reactions dpp::cluster::co_message_get_reactions const struct message & m const std::string & reaction snowflake before snowflake after snowflake limit

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

dpp::cluster::message_get_reactions

https://discord.com/developers/docs/resources/channel#get-reactions

m

Message to get reactions for

reaction

Reaction should be in the form emojiname:id or a unicode character

before

Reactions before this ID should be retrieved if this is set to non-zero

after

Reactions before this ID should be retrieved if this is set to non-zero

limit

This number of reactions maximum should be returned

user_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_get_reactions (snowflake message_id, snowflake channel_id, const std::string &reaction, snowflake before, snowflake after, snowflake limit) co_message_get_reactions dpp::cluster::co_message_get_reactions snowflake message_id snowflake channel_id const std::string & reaction snowflake before snowflake after snowflake limit

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

dpp::cluster::message_get_reactions

https://discord.com/developers/docs/resources/channel#get-reactions

message_id

Message to get reactions for

channel_id

Channel to get reactions for

reaction

Reaction should be in the form emojiname:id or a unicode character

before

Reactions before this ID should be retrieved if this is set to non-zero

after

Reactions before this ID should be retrieved if this is set to non-zero

limit

This number of reactions maximum should be returned

emoji_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_get_reactions (snowflake message_id, snowflake channel_id, const std::string &reaction, snowflake before, snowflake after, snowflake limit) co_message_get_reactions dpp::cluster::co_message_get_reactions snowflake message_id snowflake channel_id const std::string & reaction snowflake before snowflake after snowflake limit

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

dpp::cluster::message_get_reactions

https://discord.com/developers/docs/resources/channel#get-reactions

message_id

Message to get reactions for

channel_id

Channel to get reactions for

reaction

Reaction should be in the form emojiname:id or a unicode character

before

Reactions before this ID should be retrieved if this is set to non-zero

after

Reactions before this ID should be retrieved if this is set to non-zero

limit

This number of reactions maximum should be returned

emoji_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_pin (snowflake channel_id, snowflake message_id) co_message_pin dpp::cluster::co_message_pin snowflake channel_id snowflake message_id

Pin a message.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::message_pin

https://discord.com/developers/docs/resources/channel#pin-message

channel_id

Channel id to pin message on

message_id

Message id to pin message on

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_pin (snowflake channel_id, snowflake message_id) co_message_pin dpp::cluster::co_message_pin snowflake channel_id snowflake message_id

Pin a message.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::message_pin

https://discord.com/developers/docs/resources/channel#pin-message

channel_id

Channel id to pin message on

message_id

Message id to pin message on

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_unpin (snowflake channel_id, snowflake message_id) co_message_unpin dpp::cluster::co_message_unpin snowflake channel_id snowflake message_id

Unpin a message.

dpp::cluster::message_unpin

https://discord.com/developers/docs/resources/channel#unpin-message

This method supports audit log reasons set by the cluster::set_audit_reason() method.

channel_id

Channel id to unpin message on

message_id

Message id to unpin message on

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_message_unpin (snowflake channel_id, snowflake message_id) co_message_unpin dpp::cluster::co_message_unpin snowflake channel_id snowflake message_id

Unpin a message.

dpp::cluster::message_unpin

https://discord.com/developers/docs/resources/channel#unpin-message

This method supports audit log reasons set by the cluster::set_audit_reason() method.

channel_id

Channel id to unpin message on

message_id

Message id to unpin message on

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_messages_get (snowflake channel_id, snowflake around, snowflake before, snowflake after, uint64_t limit) co_messages_get dpp::cluster::co_messages_get snowflake channel_id snowflake around snowflake before snowflake after uint64_t limit

Get multiple messages.

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

dpp::cluster::messages_get

https://discord.com/developers/docs/resources/channel#get-channel-messages

channel_id

Channel ID to retrieve messages for

around

Messages should be retrieved around this ID if this is set to non-zero

before

Messages before this ID should be retrieved if this is set to non-zero

after

Messages after this ID should be retrieved if this is set to non-zero

limit

This number of messages maximum should be returned, up to a maximum of 100.

message_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_messages_get (snowflake channel_id, snowflake around, snowflake before, snowflake after, uint64_t limit) co_messages_get dpp::cluster::co_messages_get snowflake channel_id snowflake around snowflake before snowflake after uint64_t limit

Get multiple messages.

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

dpp::cluster::messages_get

https://discord.com/developers/docs/resources/channel#get-channel-messages

channel_id

Channel ID to retrieve messages for

around

Messages should be retrieved around this ID if this is set to non-zero

before

Messages before this ID should be retrieved if this is set to non-zero

after

Messages after this ID should be retrieved if this is set to non-zero

limit

This number of messages maximum should be returned, up to a maximum of 100.

message_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_nitro_sticker_get (snowflake id) co_nitro_sticker_get dpp::cluster::co_nitro_sticker_get snowflake id

Get a nitro sticker.

dpp::cluster::nitro_sticker_get

https://discord.com/developers/docs/resources/sticker#get-sticker

id

Id of sticker to get.

sticker returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_nitro_sticker_get (snowflake id) co_nitro_sticker_get dpp::cluster::co_nitro_sticker_get snowflake id

Get a nitro sticker.

dpp::cluster::nitro_sticker_get

https://discord.com/developers/docs/resources/sticker#get-sticker

id

Id of sticker to get.

sticker returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_poll_end (const message &m) co_poll_end dpp::cluster::co_poll_end const message & m

Immediately end a poll.

m

Message that contains the poll

message returned object on completion

dpp::cluster::poll_end

https://discord.com/developers/docs/resources/poll#end-poll

async< confirmation_callback_t > async< confirmation_callback_t > co_poll_end (const message &m) co_poll_end dpp::cluster::co_poll_end const message & m

Immediately end a poll.

m

Message that contains the poll

message returned object on completion

dpp::cluster::poll_end

https://discord.com/developers/docs/resources/poll#end-poll

async< confirmation_callback_t > async< confirmation_callback_t > co_poll_end (snowflake message_id, snowflake channel_id) co_poll_end dpp::cluster::co_poll_end snowflake message_id snowflake channel_id

Immediately end a poll.

message_id

ID of the message with the poll to end

channel_id

ID of the channel with the poll to end

message returned object on completion

dpp::cluster::poll_end

https://discord.com/developers/docs/resources/poll#end-poll

async< confirmation_callback_t > async< confirmation_callback_t > co_poll_end (snowflake message_id, snowflake channel_id) co_poll_end dpp::cluster::co_poll_end snowflake message_id snowflake channel_id

Immediately end a poll.

message_id

ID of the message with the poll to end

channel_id

ID of the channel with the poll to end

message returned object on completion

dpp::cluster::poll_end

https://discord.com/developers/docs/resources/poll#end-poll

async< confirmation_callback_t > async< confirmation_callback_t > co_poll_get_answer_voters (const message &m, uint32_t answer_id, snowflake after, uint64_t limit) co_poll_get_answer_voters dpp::cluster::co_poll_get_answer_voters const message & m uint32_t answer_id snowflake after uint64_t limit

Get a list of users that voted for this specific answer.

m

Message that contains the poll to retrieve the answers from

answer_id

ID of the answer to retrieve votes from (see poll_answer::answer_id)

after

Users after this ID should be retrieved if this is set to non-zero

limit

This number of users maximum should be returned, up to 100

user_map returned object on completion

dpp::cluster::poll_get_answer_voters

https://discord.com/developers/docs/resources/poll#get-answer-voters

async< confirmation_callback_t > async< confirmation_callback_t > co_poll_get_answer_voters (const message &m, uint32_t answer_id, snowflake after, uint64_t limit) co_poll_get_answer_voters dpp::cluster::co_poll_get_answer_voters const message & m uint32_t answer_id snowflake after uint64_t limit

Get a list of users that voted for this specific answer.

m

Message that contains the poll to retrieve the answers from

answer_id

ID of the answer to retrieve votes from (see poll_answer::answer_id)

after

Users after this ID should be retrieved if this is set to non-zero

limit

This number of users maximum should be returned, up to 100

user_map returned object on completion

dpp::cluster::poll_get_answer_voters

https://discord.com/developers/docs/resources/poll#get-answer-voters

async< confirmation_callback_t > async< confirmation_callback_t > co_poll_get_answer_voters (snowflake message_id, snowflake channel_id, uint32_t answer_id, snowflake after, uint64_t limit) co_poll_get_answer_voters dpp::cluster::co_poll_get_answer_voters snowflake message_id snowflake channel_id uint32_t answer_id snowflake after uint64_t limit

Get a list of users that voted for this specific answer.

message_id

ID of the message with the poll to retrieve the answers from

channel_id

ID of the channel with the poll to retrieve the answers from

answer_id

ID of the answer to retrieve votes from (see poll_answer::answer_id)

after

Users after this ID should be retrieved if this is set to non-zero

limit

This number of users maximum should be returned, up to 100

user_map returned object on completion

dpp::cluster::poll_get_answer_voters

https://discord.com/developers/docs/resources/poll#get-answer-voters

async< confirmation_callback_t > async< confirmation_callback_t > co_poll_get_answer_voters (snowflake message_id, snowflake channel_id, uint32_t answer_id, snowflake after, uint64_t limit) co_poll_get_answer_voters dpp::cluster::co_poll_get_answer_voters snowflake message_id snowflake channel_id uint32_t answer_id snowflake after uint64_t limit

Get a list of users that voted for this specific answer.

message_id

ID of the message with the poll to retrieve the answers from

channel_id

ID of the channel with the poll to retrieve the answers from

answer_id

ID of the answer to retrieve votes from (see poll_answer::answer_id)

after

Users after this ID should be retrieved if this is set to non-zero

limit

This number of users maximum should be returned, up to 100

user_map returned object on completion

dpp::cluster::poll_get_answer_voters

https://discord.com/developers/docs/resources/poll#get-answer-voters

async< http_request_completion_t > async< http_request_completion_t > dpp::cluster::co_request (const std::string &url, http_method method, const std::string &postdata="", const std::string &mimetype="text/plain", const std::multimap< std::string, std::string > &headers={}, const std::string &protocol="1.1") co_request dpp::cluster::co_request const std::string & url http_method method const std::string & postdata "" const std::string & mimetype "text/plain" const std::multimap< std::string, std::string > & headers {} const std::string & protocol "1.1"
async< confirmation_callback_t > async< confirmation_callback_t > co_role_create (const class role &r) co_role_create dpp::cluster::co_role_create const class role & r

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.

dpp::cluster::role_create

https://discord.com/developers/docs/resources/guild#create-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

r

Role to create (guild ID is encapsulated in the role object)

role returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_role_create (const class role &r) co_role_create dpp::cluster::co_role_create const class role & r

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.

dpp::cluster::role_create

https://discord.com/developers/docs/resources/guild#create-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

r

Role to create (guild ID is encapsulated in the role object)

role returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_role_delete (snowflake guild_id, snowflake role_id) co_role_delete dpp::cluster::co_role_delete snowflake guild_id snowflake role_id

Delete a role.

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

dpp::cluster::role_delete

https://discord.com/developers/docs/resources/guild#delete-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to delete the role on

role_id

Role ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_role_delete (snowflake guild_id, snowflake role_id) co_role_delete dpp::cluster::co_role_delete snowflake guild_id snowflake role_id

Delete a role.

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

dpp::cluster::role_delete

https://discord.com/developers/docs/resources/guild#delete-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to delete the role on

role_id

Role ID to delete

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_role_edit (const class role &r) co_role_edit dpp::cluster::co_role_edit const class role & r

Edit a role on a guild.

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

dpp::cluster::role_edit

https://discord.com/developers/docs/resources/guild#modify-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

r

Role to edit

role returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_role_edit (const class role &r) co_role_edit dpp::cluster::co_role_edit const class role & r

Edit a role on a guild.

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

dpp::cluster::role_edit

https://discord.com/developers/docs/resources/guild#modify-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

r

Role to edit

role returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_roles_edit_position (snowflake guild_id, const std::vector< role > &roles) co_roles_edit_position dpp::cluster::co_roles_edit_position snowflake guild_id const std::vector< role > & roles

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.

dpp::cluster::roles_edit_position

https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to change the roles position on

roles

Vector of roles to change the positions of

role_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_roles_edit_position (snowflake guild_id, const std::vector< role > &roles) co_roles_edit_position dpp::cluster::co_roles_edit_position snowflake guild_id const std::vector< role > & roles

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.

dpp::cluster::roles_edit_position

https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to change the roles position on

roles

Vector of roles to change the positions of

role_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_roles_get (snowflake guild_id) co_roles_get dpp::cluster::co_roles_get snowflake guild_id

Get a role for a guild.

dpp::cluster::roles_get

https://discord.com/developers/docs/resources/guild#get-guild-roles

guild_id

Guild ID to get role for

role_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_roles_get (snowflake guild_id) co_roles_get dpp::cluster::co_roles_get snowflake guild_id

Get a role for a guild.

dpp::cluster::roles_get

https://discord.com/developers/docs/resources/guild#get-guild-roles

guild_id

Guild ID to get role for

role_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_skus_get () co_skus_get dpp::cluster::co_skus_get

Returns all SKUs for a given application.

Because of how Discord's SKU and subscription systems work, you will see two SKUs for your premium offering. For integration and testing entitlements, you should use the SKU with type: 5.

dpp::cluster::skus_get

https://discord.com/developers/docs/monetization/skus#list-skus

sku_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_skus_get () co_skus_get dpp::cluster::co_skus_get

Returns all SKUs for a given application.

Because of how Discord's SKU and subscription systems work, you will see two SKUs for your premium offering. For integration and testing entitlements, you should use the SKU with type: 5.

dpp::cluster::skus_get

https://discord.com/developers/docs/monetization/skus#list-skus

sku_map returned object on completion

async< timer > async< timer > dpp::cluster::co_sleep (uint64_t seconds) co_sleep dpp::cluster::co_sleep uint64_t seconds

Get an awaitable to wait a certain amount of seconds. Use the co_await keyword on its return value to suspend the coroutine until the timer ends.

seconds

How long to wait for

async<timer> Object that can be co_await-ed to suspend the function for a certain time

async< confirmation_callback_t > async< confirmation_callback_t > dpp::cluster::co_stage_instance_create (const stage_instance &si) co_stage_instance_create dpp::cluster::co_stage_instance_create const stage_instance & si
async< confirmation_callback_t > async< confirmation_callback_t > co_stage_instance_delete (const snowflake channel_id) co_stage_instance_delete dpp::cluster::co_stage_instance_delete const snowflake channel_id

Delete a stage instance.

dpp::cluster::stage_instance_delete

https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance

channel_id

ID of the associated channel

confirmation returned object on completion

This method supports audit log reasons set by the cluster::set_audit_reason() method.

async< confirmation_callback_t > async< confirmation_callback_t > co_stage_instance_delete (const snowflake channel_id) co_stage_instance_delete dpp::cluster::co_stage_instance_delete const snowflake channel_id

Delete a stage instance.

dpp::cluster::stage_instance_delete

https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance

channel_id

ID of the associated channel

confirmation returned object on completion

This method supports audit log reasons set by the cluster::set_audit_reason() method.

async< confirmation_callback_t > async< confirmation_callback_t > dpp::cluster::co_stage_instance_edit (const stage_instance &si) co_stage_instance_edit dpp::cluster::co_stage_instance_edit const stage_instance & si
async< confirmation_callback_t > async< confirmation_callback_t > co_stage_instance_get (const snowflake channel_id) co_stage_instance_get dpp::cluster::co_stage_instance_get const snowflake channel_id

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

dpp::cluster::stage_instance_get

https://discord.com/developers/docs/resources/stage-instance#get-stage-instance

channel_id

ID of the associated channel

stage_instance returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_stage_instance_get (const snowflake channel_id) co_stage_instance_get dpp::cluster::co_stage_instance_get const snowflake channel_id

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

dpp::cluster::stage_instance_get

https://discord.com/developers/docs/resources/stage-instance#get-stage-instance

channel_id

ID of the associated channel

stage_instance returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_sticker_packs_get () co_sticker_packs_get dpp::cluster::co_sticker_packs_get

Get a list of available sticker packs.

dpp::cluster::sticker_packs_get

https://discord.com/developers/docs/resources/sticker#list-sticker-packs

sticker_pack_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_sticker_packs_get () co_sticker_packs_get dpp::cluster::co_sticker_packs_get

Get a list of available sticker packs.

dpp::cluster::sticker_packs_get

https://discord.com/developers/docs/resources/sticker#list-sticker-packs

sticker_pack_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_template_get (const std::string &code) co_template_get dpp::cluster::co_template_get const std::string & code

Get a template.

dpp::cluster::template_get

https://discord.com/developers/docs/resources/guild-template#get-guild-template

code

Template code

dtemplate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_template_get (const std::string &code) co_template_get dpp::cluster::co_template_get const std::string & code

Get a template.

dpp::cluster::template_get

https://discord.com/developers/docs/resources/guild-template#get-guild-template

code

Template code

dtemplate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_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) co_thread_create dpp::cluster::co_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

Create a thread.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::thread_create

https://discord.com/developers/docs/resources/channel#start-thread-without-message

thread_name

Name of the thread

channel_id

Channel in which thread to create

auto_archive_duration

Duration after which thread auto-archives. Can be set to - 60, 1440 (for boosted guilds can also be: 4320, 10080)

thread_type

Type of thread - CHANNEL_PUBLIC_THREAD, CHANNEL_ANNOUNCEMENT_THREAD, CHANNEL_PRIVATE_THREAD

invitable

whether non-moderators can add other non-moderators to a thread; only available when creating a private thread

rate_limit_per_user

amount 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

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_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) co_thread_create dpp::cluster::co_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

Create a thread.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::thread_create

https://discord.com/developers/docs/resources/channel#start-thread-without-message

thread_name

Name of the thread

channel_id

Channel in which thread to create

auto_archive_duration

Duration after which thread auto-archives. Can be set to - 60, 1440 (for boosted guilds can also be: 4320, 10080)

thread_type

Type of thread - CHANNEL_PUBLIC_THREAD, CHANNEL_ANNOUNCEMENT_THREAD, CHANNEL_PRIVATE_THREAD

invitable

whether non-moderators can add other non-moderators to a thread; only available when creating a private thread

rate_limit_per_user

amount 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

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_create_in_forum (const std::string &thread_name, snowflake channel_id, const message &msg, auto_archive_duration_t auto_archive_duration, uint16_t rate_limit_per_user, std::vector< snowflake > applied_tags={}) co_thread_create_in_forum dpp::cluster::co_thread_create_in_forum const std::string & thread_name snowflake channel_id const message & msg auto_archive_duration_t auto_archive_duration uint16_t rate_limit_per_user std::vector< snowflake > applied_tags {}

Create a thread in a forum or media channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::thread_create_in_forum

https://discord.com/developers/docs/resources/channel#start-thread-in-forum-channel

thread_name

Name of the forum thread

channel_id

Forum channel in which thread to create

msg

The message to start the thread with

auto_archive_duration

Duration to automatically archive the thread after recent activity

rate_limit_per_user

amount 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

applied_tags

List of IDs of forum tags (dpp::forum_tag) to apply to this thread

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_create_in_forum (const std::string &thread_name, snowflake channel_id, const message &msg, auto_archive_duration_t auto_archive_duration, uint16_t rate_limit_per_user, std::vector< snowflake > applied_tags={}) co_thread_create_in_forum dpp::cluster::co_thread_create_in_forum const std::string & thread_name snowflake channel_id const message & msg auto_archive_duration_t auto_archive_duration uint16_t rate_limit_per_user std::vector< snowflake > applied_tags {}

Create a thread in a forum or media channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::thread_create_in_forum

https://discord.com/developers/docs/resources/channel#start-thread-in-forum-channel

thread_name

Name of the forum thread

channel_id

Forum channel in which thread to create

msg

The message to start the thread with

auto_archive_duration

Duration to automatically archive the thread after recent activity

rate_limit_per_user

amount 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

applied_tags

List of IDs of forum tags (dpp::forum_tag) to apply to this thread

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_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) co_thread_create_with_message dpp::cluster::co_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

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::thread_create_with_message

https://discord.com/developers/docs/resources/channel#start-thread-from-message

thread_name

Name of the thread

channel_id

Channel in which thread to create

message_id

message to start thread with

auto_archive_duration

Duration after which thread auto-archives. Can be set to - 60, 1440 (for boosted guilds can also be: 4320, 10080)

rate_limit_per_user

amount 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

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_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) co_thread_create_with_message dpp::cluster::co_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

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::thread_create_with_message

https://discord.com/developers/docs/resources/channel#start-thread-from-message

thread_name

Name of the thread

channel_id

Channel in which thread to create

message_id

message to start thread with

auto_archive_duration

Duration after which thread auto-archives. Can be set to - 60, 1440 (for boosted guilds can also be: 4320, 10080)

rate_limit_per_user

amount 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

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_edit (const thread &t) co_thread_edit dpp::cluster::co_thread_edit const thread & t

Edit a thread.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::thread_edit

https://discord.com/developers/docs/topics/threads#editing-deleting-threads

t

Thread to edit

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_edit (const thread &t) co_thread_edit dpp::cluster::co_thread_edit const thread & t

Edit a thread.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

dpp::cluster::thread_edit

https://discord.com/developers/docs/topics/threads#editing-deleting-threads

t

Thread to edit

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_get (snowflake thread_id) co_thread_get dpp::cluster::co_thread_get snowflake thread_id

Get the thread specified by thread_id. This uses the same call as dpp::cluster::channel_get but returns a thread object.

dpp::cluster::thread_get

https://discord.com/developers/docs/resources/channel#get-channel

thread_id

The id of the thread to obtain.

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_get (snowflake thread_id) co_thread_get dpp::cluster::co_thread_get snowflake thread_id

Get the thread specified by thread_id. This uses the same call as dpp::cluster::channel_get but returns a thread object.

dpp::cluster::thread_get

https://discord.com/developers/docs/resources/channel#get-channel

thread_id

The id of the thread to obtain.

thread returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_member_add (snowflake thread_id, snowflake user_id) co_thread_member_add dpp::cluster::co_thread_member_add snowflake thread_id snowflake user_id

Add a member to a thread.

dpp::cluster::thread_member_add

https://discord.com/developers/docs/resources/channel#add-thread-member

thread_id

Thread ID to add to

user_id

Member ID to add

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_member_add (snowflake thread_id, snowflake user_id) co_thread_member_add dpp::cluster::co_thread_member_add snowflake thread_id snowflake user_id

Add a member to a thread.

dpp::cluster::thread_member_add

https://discord.com/developers/docs/resources/channel#add-thread-member

thread_id

Thread ID to add to

user_id

Member ID to add

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_member_get (const snowflake thread_id, const snowflake user_id) co_thread_member_get dpp::cluster::co_thread_member_get const snowflake thread_id const snowflake user_id

Get a thread member.

dpp::cluster::thread_member_get

https://discord.com/developers/docs/resources/channel#get-thread-member

thread_id

Thread to get member for

user_id

ID of the user to get

thread_member returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_member_get (const snowflake thread_id, const snowflake user_id) co_thread_member_get dpp::cluster::co_thread_member_get const snowflake thread_id const snowflake user_id

Get a thread member.

dpp::cluster::thread_member_get

https://discord.com/developers/docs/resources/channel#get-thread-member

thread_id

Thread to get member for

user_id

ID of the user to get

thread_member returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_member_remove (snowflake thread_id, snowflake user_id) co_thread_member_remove dpp::cluster::co_thread_member_remove snowflake thread_id snowflake user_id

Remove a member from a thread.

dpp::cluster::thread_member_remove

https://discord.com/developers/docs/resources/channel#remove-thread-member

thread_id

Thread ID to remove from

user_id

Member ID to remove

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_member_remove (snowflake thread_id, snowflake user_id) co_thread_member_remove dpp::cluster::co_thread_member_remove snowflake thread_id snowflake user_id

Remove a member from a thread.

dpp::cluster::thread_member_remove

https://discord.com/developers/docs/resources/channel#remove-thread-member

thread_id

Thread ID to remove from

user_id

Member ID to remove

confirmation returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_members_get (snowflake thread_id) co_thread_members_get dpp::cluster::co_thread_members_get snowflake thread_id

Get members of a thread.

dpp::cluster::thread_members_get

https://discord.com/developers/docs/resources/channel#list-thread-members

thread_id

Thread to get members for

thread_member_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_thread_members_get (snowflake thread_id) co_thread_members_get dpp::cluster::co_thread_members_get snowflake thread_id

Get members of a thread.

dpp::cluster::thread_members_get

https://discord.com/developers/docs/resources/channel#list-thread-members

thread_id

Thread to get members for

thread_member_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_threads_get_active (snowflake guild_id) co_threads_get_active dpp::cluster::co_threads_get_active snowflake guild_id

Get all active threads in the guild, including public and private threads. Threads are ordered by their id, in descending order.

dpp::cluster::threads_get_active

https://discord.com/developers/docs/resources/guild#list-active-guild-threads

guild_id

Guild to get active threads for

active_threads returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_threads_get_active (snowflake guild_id) co_threads_get_active dpp::cluster::co_threads_get_active snowflake guild_id

Get all active threads in the guild, including public and private threads. Threads are ordered by their id, in descending order.

dpp::cluster::threads_get_active

https://discord.com/developers/docs/resources/guild#list-active-guild-threads

guild_id

Guild to get active threads for

active_threads returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_threads_get_joined_private_archived (snowflake channel_id, snowflake before_id, uint16_t limit) co_threads_get_joined_private_archived dpp::cluster::co_threads_get_joined_private_archived snowflake channel_id snowflake before_id uint16_t limit

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

dpp::cluster::threads_get_joined_private_archived

https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads

channel_id

Channel to get public archived threads for

before_id

Get threads before this id

limit

Number of threads to get

thread_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_threads_get_joined_private_archived (snowflake channel_id, snowflake before_id, uint16_t limit) co_threads_get_joined_private_archived dpp::cluster::co_threads_get_joined_private_archived snowflake channel_id snowflake before_id uint16_t limit

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

dpp::cluster::threads_get_joined_private_archived

https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads

channel_id

Channel to get public archived threads for

before_id

Get threads before this id

limit

Number of threads to get

thread_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_threads_get_private_archived (snowflake channel_id, time_t before_timestamp, uint16_t limit) co_threads_get_private_archived dpp::cluster::co_threads_get_private_archived snowflake channel_id time_t before_timestamp uint16_t limit

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

dpp::cluster::threads_get_private_archived

https://discord.com/developers/docs/resources/channel#list-private-archived-threads

channel_id

Channel to get public archived threads for

before_timestamp

Get threads archived before this timestamp

limit

Number of threads to get

thread_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_threads_get_private_archived (snowflake channel_id, time_t before_timestamp, uint16_t limit) co_threads_get_private_archived dpp::cluster::co_threads_get_private_archived snowflake channel_id time_t before_timestamp uint16_t limit

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

dpp::cluster::threads_get_private_archived

https://discord.com/developers/docs/resources/channel#list-private-archived-threads

channel_id

Channel to get public archived threads for

before_timestamp

Get threads archived before this timestamp

limit

Number of threads to get

thread_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_threads_get_public_archived (snowflake channel_id, time_t before_timestamp, uint16_t limit) co_threads_get_public_archived dpp::cluster::co_threads_get_public_archived snowflake channel_id time_t before_timestamp uint16_t limit

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

dpp::cluster::threads_get_public_archived

https://discord.com/developers/docs/resources/channel#list-public-archived-threads

channel_id

Channel to get public archived threads for

before_timestamp

Get threads archived before this timestamp

limit

Number of threads to get

thread_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_threads_get_public_archived (snowflake channel_id, time_t before_timestamp, uint16_t limit) co_threads_get_public_archived dpp::cluster::co_threads_get_public_archived snowflake channel_id time_t before_timestamp uint16_t limit

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

dpp::cluster::threads_get_public_archived

https://discord.com/developers/docs/resources/channel#list-public-archived-threads

channel_id

Channel to get public archived threads for

before_timestamp

Get threads archived before this timestamp

limit

Number of threads to get

thread_map returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_user_application_role_connection_get (snowflake application_id) co_user_application_role_connection_get dpp::cluster::co_user_application_role_connection_get snowflake application_id

Get user application role connection.

dpp::cluster::user_application_role_connection_get

https://discord.com/developers/docs/resources/user#get-user-application-role-connection

application_id

The application ID

application_role_connection returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_user_application_role_connection_get (snowflake application_id) co_user_application_role_connection_get dpp::cluster::co_user_application_role_connection_get snowflake application_id

Get user application role connection.

dpp::cluster::user_application_role_connection_get

https://discord.com/developers/docs/resources/user#get-user-application-role-connection

application_id

The application ID

application_role_connection returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_user_application_role_connection_update (snowflake application_id, const application_role_connection &connection) co_user_application_role_connection_update dpp::cluster::co_user_application_role_connection_update snowflake application_id const application_role_connection & connection

Update user application role connection.

dpp::cluster::user_application_role_connection_update

https://discord.com/developers/docs/resources/user#update-user-application-role-connection

application_id

The application ID

connection

The application role connection to update

application_role_connection returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_user_application_role_connection_update (snowflake application_id, const application_role_connection &connection) co_user_application_role_connection_update dpp::cluster::co_user_application_role_connection_update snowflake application_id const application_role_connection & connection

Update user application role connection.

dpp::cluster::user_application_role_connection_update

https://discord.com/developers/docs/resources/user#update-user-application-role-connection

application_id

The application ID

connection

The application role connection to update

application_role_connection returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_user_get (snowflake user_id) co_user_get dpp::cluster::co_user_get snowflake user_id

Get a user by id, without using the cache.

dpp::cluster::user_get

https://discord.com/developers/docs/resources/user#get-user

user_id

User ID to retrieve

user_identified returned object on completion

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.

async< confirmation_callback_t > async< confirmation_callback_t > co_user_get (snowflake user_id) co_user_get dpp::cluster::co_user_get snowflake user_id

Get a user by id, without using the cache.

dpp::cluster::user_get

https://discord.com/developers/docs/resources/user#get-user

user_id

User ID to retrieve

user_identified returned object on completion

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.

async< confirmation_callback_t > async< confirmation_callback_t > co_user_get_cached (snowflake user_id) co_user_get_cached dpp::cluster::co_user_get_cached snowflake user_id

Get a user by id, checking in the cache first.

dpp::cluster::user_get_cached

https://discord.com/developers/docs/resources/user#get-user

user_id

User ID to retrieve

user_identified returned object on completion

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`.

If the user is found in the cache, special values set in `dpp::user_identified` will be undefined. This call should be used where you want to for example resolve a user who may no longer be in the bot's guilds, for something like a ban log message.

async< confirmation_callback_t > async< confirmation_callback_t > co_user_get_cached (snowflake user_id) co_user_get_cached dpp::cluster::co_user_get_cached snowflake user_id

Get a user by id, checking in the cache first.

dpp::cluster::user_get_cached

https://discord.com/developers/docs/resources/user#get-user

user_id

User ID to retrieve

user_identified returned object on completion

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`.

If the user is found in the cache, special values set in `dpp::user_identified` will be undefined. This call should be used where you want to for example resolve a user who may no longer be in the bot's guilds, for something like a ban log message.

async< confirmation_callback_t > async< confirmation_callback_t > co_user_get_voice_state (snowflake guild_id, snowflake user_id) co_user_get_voice_state dpp::cluster::co_user_get_voice_state snowflake guild_id snowflake user_id

Get a user's voice state in a guild without a Gateway connection.

dpp::cluster::user_get_voice_state

https://discord.com/developers/docs/resources/voice#get-user-voice-state

guild_id

Guild to get the voice state for

user_id

The user to get the voice state of

voicestate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_user_get_voice_state (snowflake guild_id, snowflake user_id) co_user_get_voice_state dpp::cluster::co_user_get_voice_state snowflake guild_id snowflake user_id

Get a user's voice state in a guild without a Gateway connection.

dpp::cluster::user_get_voice_state

https://discord.com/developers/docs/resources/voice#get-user-voice-state

guild_id

Guild to get the voice state for

user_id

The user to get the voice state of

voicestate returned object on completion

async< confirmation_callback_t > async< confirmation_callback_t > co_user_set_voice_state (snowflake user_id, snowflake guild_id, snowflake channel_id, bool suppress=false) co_user_set_voice_state dpp::cluster::co_user_set_voice_state snowflake user_id snowflake guild_id snowflake channel_id bool suppress false

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.

dpp::cluster::user_set_voice_state

https://discord.com/developers/docs/resources/guild#modify-user-voice-state

user_id

The user to set the voice state of

guild_id

Guild to set voice state on

channel_id

Stage channel to set voice state on

confirmation returned object on completion

suppress

True if the user's audio should be suppressed, false if it should not

async< confirmation_callback_t > async< confirmation_callback_t > co_user_set_voice_state (snowflake user_id, snowflake guild_id, snowflake channel_id, bool suppress=false) co_user_set_voice_state dpp::cluster::co_user_set_voice_state snowflake user_id snowflake guild_id snowflake channel_id bool suppress false

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.

dpp::cluster::user_set_voice_state

https://discord.com/developers/docs/resources/guild#modify-user-voice-state

user_id

The user to set the voice state of

guild_id

Guild to set voice state on

channel_id

Stage channel to set voice state on

confirmation returned object on completion

suppress

True if the user's audio should be suppressed, false if it should not

void void dpp::cluster::create_dm_channel (snowflake user_id, command_completion_event_t callback=utility::log_error()) create_dm_channel dpp::cluster::create_dm_channel snowflake user_id command_completion_event_t callback utility::log_error()

Create a dm channel.

https://discord.com/developers/docs/resources/user#create-dm

user_id

User ID to create DM channel with

callback

Function 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().

void void dpp::cluster::create_webhook (const class webhook &w, command_completion_event_t callback=utility::log_error()) create_webhook dpp::cluster::create_webhook const class webhook & w command_completion_event_t callback utility::log_error()

Create a webhook.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/webhook#create-webhook

w

Webhook to create

callback

Function 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().

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

Get current (bot) application.

https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information

callback

Function 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().

void void dpp::cluster::current_user_connections_get (command_completion_event_t callback) current_user_connections_get 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.

https://discord.com/developers/docs/resources/user#get-user-connections

callback

Function 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().

void void dpp::cluster::current_user_edit (const std::string &nickname, const std::string &avatar_blob="", const image_type avatar_type=i_png, const std::string &banner_blob="", const image_type banner_type=i_png, command_completion_event_t callback=utility::log_error()) current_user_edit dpp::cluster::current_user_edit const std::string & nickname const std::string & avatar_blob "" const image_type avatar_type i_png const std::string & banner_blob "" const image_type banner_type i_png command_completion_event_t callback utility::log_error()

Edit current (bot) user.

Modify the requester's user account settings. Returns a dpp::user object on success. Fires a User Update Gateway event.

There appears to be no limit to the image size, however, if your image cannot be processed/uploaded in time, you will receive a malformed http request.

https://discord.com/developers/docs/resources/user#modify-current-user

nickname

Nickname to set

avatar_blob

Avatar data to upload

avatar_type

Type of image for avatar. It can be one of `i_gif`, `i_jpg` or `i_png`.

banner_blob

Banner data to upload

banner_type

Type of image for Banner. It can be one of `i_gif`, `i_jpg` or `i_png`.

callback

Function 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().

dpp::length_exception

Image data is larger than the maximum size of 256 kilobytes

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

Get current (bot) user.

https://discord.com/developers/docs/resources/user#get-current-user

callback

Function 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().

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`.

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

Get current user DM channels.

callback

Function 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().

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

Get current (bot) user guilds.

https://discord.com/developers/docs/resources/user#get-current-user-guilds

callback

Function 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().

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

Get the bot's voice state in a guild without a Gateway connection.

https://discord.com/developers/docs/resources/voice#get-current-user-voice-state

guild_id

Guild to get the voice state for

callback

Function to call when the API call completes. On success the callback will contain a dpp::voicestate 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().

void void dpp::cluster::current_user_join_thread (snowflake thread_id, command_completion_event_t callback=utility::log_error()) current_user_join_thread dpp::cluster::current_user_join_thread snowflake thread_id command_completion_event_t callback utility::log_error()

Join a thread.

https://discord.com/developers/docs/resources/channel#join-thread

thread_id

Thread ID to join

callback

Function 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().

void void dpp::cluster::current_user_leave_guild (snowflake guild_id, command_completion_event_t callback=utility::log_error()) current_user_leave_guild dpp::cluster::current_user_leave_guild snowflake guild_id command_completion_event_t callback utility::log_error()

Leave a guild.

https://discord.com/developers/docs/resources/user#leave-guild

guild_id

Guild ID to leave

callback

Function 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().

void void dpp::cluster::current_user_leave_thread (snowflake thread_id, command_completion_event_t callback=utility::log_error()) current_user_leave_thread dpp::cluster::current_user_leave_thread snowflake thread_id command_completion_event_t callback utility::log_error()

Leave a thread.

https://discord.com/developers/docs/resources/channel#leave-thread

thread_id

Thread ID to leave

callback

Function 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().

void 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=utility::log_error()) current_user_set_voice_state 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 utility::log_error()

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.

https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state

guild_id

Guild to set voice state on

channel_id

Stage channel to set voice state on

callback

Function to call when the API call completes.

suppress

True if the user's audio should be suppressed, false if it should not

request_to_speak_timestamp

The 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().

std::logic_exception

You attempted to set a request_to_speak_timestamp in the past which is not the value of 0.

void void dpp::cluster::delete_webhook (snowflake webhook_id, command_completion_event_t callback=utility::log_error()) delete_webhook dpp::cluster::delete_webhook snowflake webhook_id command_completion_event_t callback utility::log_error()

Delete a webhook.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/webhook#delete-webhook

webhook_id

Webhook ID to delete

callback

Function 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().

void void dpp::cluster::delete_webhook_message (const class webhook &wh, snowflake message_id, snowflake thread_id=0, command_completion_event_t callback=utility::log_error()) delete_webhook_message dpp::cluster::delete_webhook_message const class webhook & wh snowflake message_id snowflake thread_id 0 command_completion_event_t callback utility::log_error()

Delete webhook message.

https://discord.com/developers/docs/resources/webhook#delete-webhook-message

wh

Webhook to delete message for

message_id

Message ID to delete

thread_id

ID of the thread the message is in

callback

Function 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().

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

Delete webhook with token.

https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token

webhook_id

Webhook ID to delete

token

Token of webhook to delete

callback

Function 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().

void void dpp::cluster::direct_message_create (snowflake user_id, const message &m, command_completion_event_t callback=utility::log_error()) direct_message_create dpp::cluster::direct_message_create snowflake user_id const message & m command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/resources/user#create-dm

https://discord.com/developers/docs/resources/channel#create-message

user_id

User ID of user to send message to

m

Message object

callback

Function 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().

void void dpp::cluster::edit_webhook (const class webhook &wh, command_completion_event_t callback=utility::log_error()) edit_webhook dpp::cluster::edit_webhook const class webhook & wh command_completion_event_t callback utility::log_error()

Edit webhook.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/webhook#modify-webhook

wh

Webhook to edit

callback

Function 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().

void void dpp::cluster::edit_webhook_message (const class webhook &wh, const struct message &m, snowflake thread_id=0, command_completion_event_t callback=utility::log_error()) edit_webhook_message dpp::cluster::edit_webhook_message const class webhook & wh const struct message & m snowflake thread_id 0 command_completion_event_t callback utility::log_error()

Edit webhook message.

When the content field is edited, the mentions array in the message object will be reconstructed from scratch based on the new content. The allowed_mentions field of the edit request controls how this happens. If there is no explicit allowed_mentions in the edit request, the content will be parsed with default allowances, that is, without regard to whether or not an allowed_mentions was present in the request that originally created the message.

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

the attachments array must contain all attachments that should be present after edit, including retained and new attachments provided in the request body.

wh

Webhook to edit message for

m

New message

thread_id

ID of the thread the message is in

callback

Function 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().

void void dpp::cluster::edit_webhook_with_token (const class webhook &wh, command_completion_event_t callback=utility::log_error()) edit_webhook_with_token dpp::cluster::edit_webhook_with_token const class webhook & wh command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token

wh

Webhook to edit (should include token)

callback

Function 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().

cluster & cluster & dpp::cluster::enable_webhook_server (const std::string &discord_public_key, const std::string_view address, uint16_t port, const std::string &ssl_private_key="", const std::string &ssl_public_key="") enable_webhook_server dpp::cluster::enable_webhook_server const std::string & discord_public_key const std::string_view address uint16_t port const std::string & ssl_private_key "" const std::string & ssl_public_key ""

Create a webhook server for receiving interactions.

This should be considered mutually exclusive with delivery of interaction events via shards.

discord_public_key

Public key for the application from the application dashboard page

address

address to bind to, use "0.0.0.0" to bind to all local addresses

port

port to bind to. You should generally use a port > 1024.

ssl_private_key

Private key PEM file for HTTPS/SSL. If empty, a plaintext server is created

ssl_public_key

Public key PEM file for HTTPS/SSL. If empty, a plaintext server is created

void void dpp::cluster::entitlement_consume (snowflake entitlement_id, command_completion_event_t callback=utility::log_error()) entitlement_consume dpp::cluster::entitlement_consume snowflake entitlement_id command_completion_event_t callback utility::log_error()

For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed.

https://discord.com/developers/docs/monetization/entitlements#consume-an-entitlement

entitlement_id

The entitlement to mark as consumed.

callback

Function 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().

void void dpp::cluster::entitlement_test_create (const class entitlement &new_entitlement, command_completion_event_t callback=utility::log_error()) entitlement_test_create dpp::cluster::entitlement_test_create const class entitlement & new_entitlement command_completion_event_t callback utility::log_error()

Creates a test entitlement to a given SKU for a given guild or user. Discord will act as though that user or guild has entitlement to your premium offering.

https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement

new_entitlement

The entitlement to create. Make sure your dpp::entitlement_type (inside your dpp::entitlement object) matches the type of the owner_id (if type is guild, owner_id is a guild id), otherwise it won't work!

callback

Function to call when the API call completes. On success the callback will contain a dpp::entitlement 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().

void void dpp::cluster::entitlement_test_delete (snowflake entitlement_id, command_completion_event_t callback=utility::log_error()) entitlement_test_delete dpp::cluster::entitlement_test_delete snowflake entitlement_id command_completion_event_t callback utility::log_error()

Deletes a currently-active test entitlement. Discord will act as though that user or guild no longer has entitlement to your premium offering.

https://discord.com/developers/docs/monetization/entitlements#delete-test-entitlement

entitlement_id

The test entitlement to delete.

callback

Function 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().

void void dpp::cluster::entitlements_get (snowflake user_id=0, const std::vector< snowflake > &sku_ids={}, snowflake before_id=0, snowflake after_id=0, uint8_t limit=100, snowflake guild_id=0, bool exclude_ended=false, command_completion_event_t callback=utility::log_error()) entitlements_get dpp::cluster::entitlements_get snowflake user_id 0 const std::vector< snowflake > & sku_ids {} snowflake before_id 0 snowflake after_id 0 uint8_t limit 100 snowflake guild_id 0 bool exclude_ended false command_completion_event_t callback utility::log_error()

Returns all entitlements for a given app, active and expired.

https://discord.com/developers/docs/monetization/entitlements#list-entitlements

user_id

User ID to look up entitlements for.

sku_ids

List of SKU IDs to check entitlements for.

before_id

Retrieve entitlements before this entitlement ID.

after_id

Retrieve entitlements after this entitlement ID.

limit

Number of entitlements to return, 1-100 (default 100).

guild_id

Guild ID to look up entitlements for.

exclude_ended

Whether ended entitlements should be excluded from the search.

callback

Function 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().

void void dpp::cluster::execute_webhook (const class webhook &wh, const struct message &m, bool wait=false, snowflake thread_id=0, const std::string &thread_name="", command_completion_event_t callback=utility::log_error()) execute_webhook dpp::cluster::execute_webhook const class webhook & wh const struct message & m bool wait false snowflake thread_id 0 const std::string & thread_name "" command_completion_event_t callback utility::log_error()

Execute webhook.

https://discord.com/developers/docs/resources/webhook#execute-webhook

wh

Webhook to execute

m

Message to send

wait

waits for server confirmation of message send before response, and returns the created message body

thread_id

Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived

thread_name

Name of thread to create (requires the webhook channel to be a forum channel)

callback

Function to call when the API call completes.

If the webhook channel is a forum channel, you must provide either `thread_id` or `thread_name`. If `thread_id` is provided, the message will send in that thread. If `thread_name` is provided, a thread with that name will be created in the forum channel. 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().

void 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=utility::log_error()) gdm_add dpp::cluster::gdm_add snowflake channel_id snowflake user_id const std::string & access_token const std::string & nick command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/resources/channel#group-dm-add-recipient

channel_id

Channel id to add group DM recipients to

user_id

User ID to add

access_token

Access token from OAuth2

nick

Nickname of user to apply to the chat

callback

Function 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().

void void dpp::cluster::gdm_remove (snowflake channel_id, snowflake user_id, command_completion_event_t callback=utility::log_error()) gdm_remove dpp::cluster::gdm_remove snowflake channel_id snowflake user_id command_completion_event_t callback utility::log_error()

Removes a recipient from a Group DM.

https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient

channel_id

Channel ID of group DM

user_id

User ID to remove from group DM

callback

Function 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().

std::string std::string dpp::cluster::get_audit_reason () get_audit_reason 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.

This method call clears the audit reason when it returns it.

std::string The audit reason to be used.

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

Get channel webhooks.

https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

channel_id

Channel ID to get webhooks for

callback

Function 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().

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

Get the dm channel for a user id.

user_id

the user id to get the dm channel for

Returns 0 on failure

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

Get the gateway information for the bot using the token.

https://discord.com/developers/docs/topics/gateway#get-gateway-bot

callback

Function 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().

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

Get guild webhooks.

https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

guild_id

Guild ID to get webhooks for

callback

Function 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().

request_queue * request_queue * dpp::cluster::get_raw_rest () get_raw_rest dpp::cluster::get_raw_rest

Get the raw rest_queue object which handles all HTTP(S) requests that are not directed at Discord.

request_queue* pointer to request_queue object

request_queue * request_queue * dpp::cluster::get_rest () get_rest dpp::cluster::get_rest

Get the rest_queue object which handles HTTPS requests to Discord.

request_queue* pointer to request_queue object

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

Get a shard by id, returning the discord_client.

id

Shard ID

discord_client* shard, or null

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

Get the list of shards.

shard_list map of shards for this cluster

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

Get all voice regions.

https://discord.com/developers/docs/resources/voice#list-voice-regions

callback

Function 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().

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

Get webhook.

https://discord.com/developers/docs/resources/webhook#get-webhook

webhook_id

Webhook ID to get

callback

Function 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().

void void dpp::cluster::get_webhook_message (const class webhook &wh, snowflake message_id, snowflake thread_id=0, command_completion_event_t callback=utility::log_error()) get_webhook_message dpp::cluster::get_webhook_message const class webhook & wh snowflake message_id snowflake thread_id 0 command_completion_event_t callback utility::log_error()

Get webhook message.

https://discord.com/developers/docs/resources/webhook#get-webhook-message

wh

Webhook to get the original message for

message_id

The message ID

thread_id

ID of the thread the message is in

callback

Function 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().

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

Get webhook using token.

https://discord.com/developers/docs/resources/webhook#get-webhook-with-token

webhook_id

Webhook ID to retrieve

token

Token of webhook

callback

Function 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().

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

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

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

commands

Vector of slash commands to create/update. overwriting existing commands that are registered globally for this application. Commands that do not already exist will count toward daily application command create limits.

callback

Function 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().

void void dpp::cluster::global_bulk_command_delete (command_completion_event_t callback=utility::log_error()) global_bulk_command_delete dpp::cluster::global_bulk_command_delete command_completion_event_t callback utility::log_error()

Delete all existing global slash commands.

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

callback

Function to call when the API call completes. On success the callback will contain a dpp::slashcommand_map object in confirmation_callback_t::value which will be empty, meaning there are no commands. 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().

void void dpp::cluster::global_command_create (const slashcommand &s, command_completion_event_t callback=utility::log_error()) global_command_create dpp::cluster::global_command_create const slashcommand & s command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/interactions/application-commands#create-global-application-command

s

Slash command to create

callback

Function 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().

void void dpp::cluster::global_command_delete (snowflake id, command_completion_event_t callback=utility::log_error()) global_command_delete dpp::cluster::global_command_delete snowflake id command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/interactions/application-commands#delete-global-application-command

id

Slash command to delete

callback

Function 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().

void void dpp::cluster::global_command_edit (const slashcommand &s, command_completion_event_t callback=utility::log_error()) global_command_edit dpp::cluster::global_command_edit const slashcommand & s command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command

s

Slash command to change

callback

Function 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().

void void dpp::cluster::global_command_get (snowflake id, command_completion_event_t callback=utility::log_error()) global_command_get dpp::cluster::global_command_get snowflake id command_completion_event_t callback utility::log_error()

Get a global slash command.

https://discord.com/developers/docs/interactions/application-commands#get-global-application-command

id

The ID of the slash command

callback

Function 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().

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

Get the application's global slash commands.

https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands

callback

Function 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().

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

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.

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.

https://discord.com/developers/docs/resources/guild#add-guild-member

gm

Guild member to add

access_token

Access token from Oauth2 scope

callback

Function 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().

void void dpp::cluster::guild_auditlog_get (snowflake guild_id, snowflake user_id, uint32_t action_type, snowflake before, snowflake after, uint32_t limit, command_completion_event_t callback) guild_auditlog_get dpp::cluster::guild_auditlog_get snowflake guild_id snowflake user_id uint32_t action_type snowflake before snowflake after uint32_t limit command_completion_event_t callback

Get the audit log for a guild.

https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log

guild_id

Guild to get the audit log of

user_id

Entries from a specific user ID. Set this to `0` will fetch any user

action_type

Entries for a specific dpp::audit_type. Set this to `0` will fetch any type

before

Entries with ID less than a specific audit log entry ID. Used for paginating

after

Entries with ID greater than a specific audit log entry ID. Used for paginating

limit

Maximum number of entries (between 1-100) to return

callback

Function 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().

void void dpp::cluster::guild_ban_add (snowflake guild_id, snowflake user_id, uint32_t delete_message_seconds=0, command_completion_event_t callback=utility::log_error()) guild_ban_add dpp::cluster::guild_ban_add snowflake guild_id snowflake user_id uint32_t delete_message_seconds 0 command_completion_event_t callback utility::log_error()

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.

https://discord.com/developers/docs/resources/guild#create-guild-ban

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to add ban to

user_id

User ID to ban

delete_message_seconds

How many seconds to delete messages for, between 0 and 604800 (7 days). Defaults to 0

callback

Function 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().

void void dpp::cluster::guild_ban_delete (snowflake guild_id, snowflake user_id, command_completion_event_t callback=utility::log_error()) guild_ban_delete dpp::cluster::guild_ban_delete snowflake guild_id snowflake user_id command_completion_event_t callback utility::log_error()

Delete guild ban.

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

https://discord.com/developers/docs/resources/guild#remove-guild-ban

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild to delete ban from

user_id

User ID to delete ban for

callback

Function 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().

void void dpp::cluster::guild_begin_prune (snowflake guild_id, const struct prune &pruneinfo, command_completion_event_t callback=utility::log_error()) guild_begin_prune dpp::cluster::guild_begin_prune snowflake guild_id const struct prune & pruneinfo command_completion_event_t callback utility::log_error()

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.

https://discord.com/developers/docs/resources/guild#begin-guild-prune

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to prune

pruneinfo

Pruning info

callback

Function 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().

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

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

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands

commands

Vector 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_id

Guild ID to create/update the slash commands in

callback

Function 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().

void void dpp::cluster::guild_bulk_command_delete (snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_bulk_command_delete dpp::cluster::guild_bulk_command_delete snowflake guild_id command_completion_event_t callback utility::log_error()

Delete all existing guild slash commands.

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

guild_id

Guild ID to delete the slash commands in.

callback

Function to call when the API call completes. On success the callback will contain a dpp::slashcommand_map object in confirmation_callback_t::value which will be empty, meaning there are no commands. 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().

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

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

You can only add up to 10 permission overwrites for a command

https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions

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.

commands

A vector of slash commands to edit/overwrite the permissions for

guild_id

Guild ID to edit permissions of the slash commands in

callback

Function 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().

Deprecated

This has been disabled with updates to Permissions v2. You can use guild_command_edit_permissions instead

void void dpp::cluster::guild_command_create (const slashcommand &s, snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_command_create dpp::cluster::guild_command_create const slashcommand & s snowflake guild_id command_completion_event_t callback utility::log_error()

Create a slash command local to a guild.

https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command

Creating a command with the same name as an existing command for your application will overwrite the old command.

s

Slash command to create

guild_id

Guild ID to create the slash command in

callback

Function 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().

void void dpp::cluster::guild_command_delete (snowflake id, snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_command_delete dpp::cluster::guild_command_delete snowflake id snowflake guild_id command_completion_event_t callback utility::log_error()

Delete a slash command local to a guild.

https://discord.com/developers/docs/interactions/application-commands#delete-guild-application-command

id

Slash command to delete

guild_id

Guild ID to delete the slash command in

callback

Function 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().

void void dpp::cluster::guild_command_edit (const slashcommand &s, snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_command_edit dpp::cluster::guild_command_edit const slashcommand & s snowflake guild_id command_completion_event_t callback utility::log_error()

Edit a slash command local to a guild.

https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command

s

Slash command to edit

guild_id

Guild ID to edit the slash command in

callback

Function 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().

void void dpp::cluster::guild_command_edit_permissions (const slashcommand &s, snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_command_edit_permissions dpp::cluster::guild_command_edit_permissions const slashcommand & s snowflake guild_id command_completion_event_t callback utility::log_error()

Edit slash command permissions of a guild.

https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions

You can only add up to 10 permission overwrites for a command

s

Slash command to edit the permissions for

guild_id

Guild ID to edit the slash command in

callback

Function 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().

void void dpp::cluster::guild_command_get (snowflake id, snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_command_get dpp::cluster::guild_command_get snowflake id snowflake guild_id command_completion_event_t callback utility::log_error()

Get a slash command of a guild.

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command

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

id

The ID of the slash command

guild_id

Guild ID to get the slash command from

callback

Function 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().

void void dpp::cluster::guild_command_get_permissions (snowflake id, snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_command_get_permissions dpp::cluster::guild_command_get_permissions snowflake id snowflake guild_id command_completion_event_t callback utility::log_error()

Get the permissions for a slash command of a guild.

https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions

id

The ID of the slash command to get the permissions for

guild_id

Guild ID to get the permissions of

callback

Function 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().

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

Get the application's slash commands for a guild.

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands

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

guild_id

Guild ID to get the slash commands for

callback

Function 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().

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

Get all slash command permissions of a guild.

https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions

guild_id

Guild ID to get the slash commands permissions for

callback

Function 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().

void void dpp::cluster::guild_create (const class guild &g, command_completion_event_t callback=utility::log_error()) guild_create dpp::cluster::guild_create const class guild & g command_completion_event_t callback utility::log_error()

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.

https://discord.com/developers/docs/resources/guild#create-guild

The region field is deprecated and is replaced by channel.rtc_region. This endpoint can be used only by bots in less than 10 guilds.

g

Guild to create

callback

Function 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().

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

Create a new guild based on a template.

This endpoint can be used only by bots in less than 10 guilds.

https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template

code

Template code to create guild from

name

Guild name to create

callback

Function 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().

void void dpp::cluster::guild_current_member_edit (snowflake guild_id, const std::string &nickname, const std::string &banner_blob, const image_type banner_type, const std::string &avatar_blob, const image_type avatar_type, const std::string &bio, command_completion_event_t callback=utility::log_error()) guild_current_member_edit dpp::cluster::guild_current_member_edit snowflake guild_id const std::string & nickname const std::string & banner_blob const image_type banner_type const std::string & avatar_blob const image_type avatar_type const std::string & bio command_completion_event_t callback utility::log_error()

Modify current member.

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/guild#modify-current-member

guild_id

Guild ID to change on

nickname

New nickname, or empty string to clear nickname.

banner_blob

New banner, or empty string to clear banner.

banner_type

Type of image for new banner.

avatar_blob

New avatar, or empty string to clear avatar.

avatar_type

Type of image for new avatar.

bio

New bio, or empty string to clear bio

callback

Function 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().

void void dpp::cluster::guild_delete (snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_delete dpp::cluster::guild_delete snowflake guild_id command_completion_event_t callback utility::log_error()

Delete a guild.

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

https://discord.com/developers/docs/resources/guild#delete-guild

guild_id

Guild ID to delete

callback

Function 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().

void void dpp::cluster::guild_delete_integration (snowflake guild_id, snowflake integration_id, command_completion_event_t callback=utility::log_error()) guild_delete_integration dpp::cluster::guild_delete_integration snowflake guild_id snowflake integration_id command_completion_event_t callback utility::log_error()

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.

https://discord.com/developers/docs/resources/guild#delete-guild-integration

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to delete integration for

integration_id

Integration ID to delete

callback

Function 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().

void void dpp::cluster::guild_edit (const class guild &g, command_completion_event_t callback=utility::log_error()) guild_edit dpp::cluster::guild_edit const class guild & g command_completion_event_t callback utility::log_error()

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.

https://discord.com/developers/docs/resources/guild#modify-guild

This method supports audit log reasons set by the cluster::set_audit_reason() method.

g

Guild to edit

callback

Function 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().

void void dpp::cluster::guild_edit_member (const guild_member &gm, command_completion_event_t callback=utility::log_error()) guild_edit_member dpp::cluster::guild_edit_member const guild_member & gm command_completion_event_t callback utility::log_error()

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. 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. For moving and disconnecting users from voice, use dpp::cluster::guild_member_move.

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

gm

Guild member to edit

callback

Function 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().

void void dpp::cluster::guild_edit_onboarding (const struct onboarding &o, command_completion_event_t callback=utility::log_error()) guild_edit_onboarding dpp::cluster::guild_edit_onboarding const struct onboarding & o command_completion_event_t callback utility::log_error()

Edit the guild's onboarding configuration.

Requires the `MANAGE_GUILD` and `MANAGE_ROLES` permissions.

Onboarding enforces constraints when enabled. These constraints are that there must be at least 7 Default Channels and at least 5 of them must allow sending messages to the @everyone role. The `onboarding::mode` field modifies what is considered when enforcing these constraints.

https://discord.com/developers/docs/resources/guild#modify-guild-onboarding

This method supports audit log reasons set by the cluster::set_audit_reason() method.

o

The onboarding object

callback

Function to call when the API call completes. On success the callback will contain a dpp::onboarding 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().

void void dpp::cluster::guild_edit_welcome_screen (snowflake guild_id, const struct welcome_screen &welcome_screen, bool enabled, command_completion_event_t callback=utility::log_error()) guild_edit_welcome_screen dpp::cluster::guild_edit_welcome_screen snowflake guild_id const struct welcome_screen & welcome_screen bool enabled command_completion_event_t callback utility::log_error()

Edit the guild's welcome screen.

Requires the `MANAGE_GUILD` permission. May fire a `Guild Update` Gateway event.

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen

guild_id

The guild ID to edit the welcome screen for

welcome_screen

The welcome screen

enabled

Whether the welcome screen should be enabled or disabled

callback

Function to call when the API call completes. On success the callback will contain a dpp::welcome_screen 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().

void void dpp::cluster::guild_edit_widget (snowflake guild_id, const class guild_widget &gw, command_completion_event_t callback=utility::log_error()) guild_edit_widget dpp::cluster::guild_edit_widget snowflake guild_id const class guild_widget & gw command_completion_event_t callback utility::log_error()

Edit guild widget.

Requires the `MANAGE_GUILD` permission.

https://discord.com/developers/docs/resources/guild#modify-guild-widget

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to edit widget for

gw

New guild widget information

callback

Function 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().

void void dpp::cluster::guild_emoji_create (snowflake guild_id, const class emoji &newemoji, command_completion_event_t callback=utility::log_error()) guild_emoji_create dpp::cluster::guild_emoji_create snowflake guild_id const class emoji & newemoji command_completion_event_t callback utility::log_error()

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/emoji#create-guild-emoji

guild_id

Guild ID to create emoji om

newemoji

Emoji to create

callback

Function 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().

void void dpp::cluster::guild_emoji_delete (snowflake guild_id, snowflake emoji_id, command_completion_event_t callback=utility::log_error()) guild_emoji_delete dpp::cluster::guild_emoji_delete snowflake guild_id snowflake emoji_id command_completion_event_t callback utility::log_error()

Delete a guild emoji.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/emoji#delete-guild-emoji

guild_id

Guild ID to delete emoji on

emoji_id

Emoji ID to delete

callback

Function 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().

void void dpp::cluster::guild_emoji_edit (snowflake guild_id, const class emoji &newemoji, command_completion_event_t callback=utility::log_error()) guild_emoji_edit dpp::cluster::guild_emoji_edit snowflake guild_id const class emoji & newemoji command_completion_event_t callback utility::log_error()

Edit a single emoji.

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

https://discord.com/developers/docs/resources/emoji#modify-guild-emoji

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to edit emoji on

newemoji

Emoji to edit

callback

Function 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().

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

Get a single emoji.

https://discord.com/developers/docs/resources/emoji#get-guild-emoji

guild_id

Guild ID to get emoji for

emoji_id

Emoji ID to get

callback

Function 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().

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

Get all emojis for a guild.

https://discord.com/developers/docs/resources/emoji#list-guild-emojis

guild_id

Guild ID to get emojis for

callback

Function 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().

void void dpp::cluster::guild_event_create (const scheduled_event &event, command_completion_event_t callback=utility::log_error()) guild_event_create dpp::cluster::guild_event_create const scheduled_event & event command_completion_event_t callback utility::log_error()

Create a scheduled event on a guild.

https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event

event

Event to create (guild ID must be populated)

callback

Function 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().

void void dpp::cluster::guild_event_delete (snowflake event_id, snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_event_delete dpp::cluster::guild_event_delete snowflake event_id snowflake guild_id command_completion_event_t callback utility::log_error()

Delete a scheduled event from a guild.

https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event

event_id

Event ID to delete

guild_id

Guild ID of event to delete

callback

Function 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().

void void dpp::cluster::guild_event_edit (const scheduled_event &event, command_completion_event_t callback=utility::log_error()) guild_event_edit dpp::cluster::guild_event_edit const scheduled_event & event command_completion_event_t callback utility::log_error()

Edit/modify a scheduled event on a guild.

https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event

event

Event to create (event ID and guild ID must be populated)

callback

Function 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().

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

Get a scheduled event for a guild.

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event

guild_id

Guild to get event for

event_id

Event ID to get

callback

Function 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().

void 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) guild_event_users_get 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.

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users

guild_id

Guild to get user list for

event_id

Guild to get user list for

limit

Maximum number of results to return

before

Return user IDs that fall before this ID, if provided

after

Return user IDs that fall after this ID, if provided

callback

Function to call when the API call completes. On success the callback will contain a dpp::event_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().

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

Get all scheduled events for a guild.

https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild

guild_id

Guild to get events for

callback

Function 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().

void void dpp::cluster::guild_get (snowflake g, command_completion_event_t callback) guild_get 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.

https://discord.com/developers/docs/resources/guild#get-guild

g

Guild ID to retrieve

callback

Function 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().

void void dpp::cluster::guild_get_ban (snowflake guild_id, snowflake user_id, command_completion_event_t callback) guild_get_ban 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.

https://discord.com/developers/docs/resources/guild#get-guild-ban

guild_id

Guild ID to get ban for

user_id

User ID of ban to retrieve

callback

Function 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().

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

Get guild ban list.

Requires the `BAN_MEMBERS` permission.

https://discord.com/developers/docs/resources/guild#get-guild-bans

Provide a user ID to `before` and `after` for pagination. Users will always be returned in ascending order by the user ID. If both before and after are provided, only before is respected.

guild_id

Guild ID to get bans for

before

If non-zero, all bans for user ids before this user id will be returned up to the limit

after

if non-zero, all bans for user ids after this user id will be returned up to the limit

limit

the maximum number of bans to retrieve in this call up to a maximum of 1000

callback

Function 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().

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

Get guild integrations.

Requires the `MANAGE_GUILD` permission.

https://discord.com/developers/docs/resources/guild#get-guild-integrations

guild_id

Guild ID to get integrations for

callback

Function 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().

This endpoint returns a maximum of 50 integrations. If a guild has more integrations, they cannot be accessed.

void void dpp::cluster::guild_get_invites (snowflake guild_id, command_completion_event_t callback) guild_get_invites 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.

https://discord.com/developers/docs/resources/guild#get-guild-invites

guild_id

Guild ID to get invites for

callback

Function 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().

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

Get a guild member.

https://discord.com/developers/docs/resources/guild#get-guild-member

guild_id

Guild ID to get member for

user_id

User ID of member to get

callback

Function 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().

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

Get all guild members.

This endpoint is restricted according to whether the `GUILD_MEMBERS` Privileged Intent is enabled for your application.

https://discord.com/developers/docs/resources/guild#get-guild-members

guild_id

Guild ID to get all members for

limit

max number of members to return (1-1000)

after

the highest user id in the previous page

callback

Function 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().

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

Get the guild's onboarding configuration.

https://discord.com/developers/docs/resources/guild#get-guild-onboarding

guild_id

The guild to pull the onboarding configuration from.

callback

Function to call when the API call completes. On success the callback will contain a dpp::onboarding 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().

void void dpp::cluster::guild_get_preview (snowflake g, command_completion_event_t callback) guild_get_preview 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).

https://discord.com/developers/docs/resources/guild#get-guild-preview

g

Guild ID to retrieve

callback

Function 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().

void void dpp::cluster::guild_get_prune_counts (snowflake guild_id, const struct prune &pruneinfo, command_completion_event_t callback) guild_get_prune_counts 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.

https://discord.com/developers/docs/resources/guild#get-guild-prune-count

guild_id

Guild ID to count for pruning

pruneinfo

Pruning info

callback

Function 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().

void void dpp::cluster::guild_get_vanity (snowflake guild_id, command_completion_event_t callback) guild_get_vanity 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.

https://discord.com/developers/docs/resources/guild#get-guild-vanity-url

guild_id

Guild to get vanity URL for

callback

Function 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().

void void dpp::cluster::guild_get_voice_regions (snowflake guild_id, command_completion_event_t callback) guild_get_voice_regions 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.

https://discord.com/developers/docs/resources/guild#get-guild-voice-regions

guild_id

Guild ID to get voice regions for

callback

Function 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().

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

Get the guild's welcome screen.

If the welcome screen is not enabled, the `MANAGE_GUILD` permission is required.

https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen

guild_id

The guild ID to get the welcome screen from

callback

Function to call when the API call completes. On success the callback will contain a dpp::welcome_screen 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().

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

Get guild widget.

Requires the `MANAGE_GUILD` permission.

https://discord.com/developers/docs/resources/guild#get-guild-widget

guild_id

Guild ID to get widget for

callback

Function 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().

void void dpp::cluster::guild_member_add_role (snowflake guild_id, snowflake user_id, snowflake role_id, command_completion_event_t callback=utility::log_error()) guild_member_add_role dpp::cluster::guild_member_add_role snowflake guild_id snowflake user_id snowflake role_id command_completion_event_t callback utility::log_error()

Add role to guild member.

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

https://discord.com/developers/docs/resources/guild#add-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to add a role to

user_id

User ID to add role to

role_id

Role ID to add to the user

callback

Function 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().

void void dpp::cluster::guild_member_delete (snowflake guild_id, snowflake user_id, command_completion_event_t callback=utility::log_error()) guild_member_delete dpp::cluster::guild_member_delete snowflake guild_id snowflake user_id command_completion_event_t callback utility::log_error()

Remove (kick) a guild member.

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

https://discord.com/developers/docs/resources/guild#remove-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

Deprecated

Replaced by dpp::cluster::guild_member_kick

guild_id

Guild ID to kick member from

user_id

User ID to kick

callback

Function 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().

void void dpp::cluster::guild_member_delete_role (snowflake guild_id, snowflake user_id, snowflake role_id, command_completion_event_t callback=utility::log_error()) guild_member_delete_role dpp::cluster::guild_member_delete_role snowflake guild_id snowflake user_id snowflake role_id command_completion_event_t callback utility::log_error()

Remove role from guild member.

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

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove role from user on

user_id

User ID to remove role from

role_id

Role to remove

callback

Function 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().

Deprecated

Use dpp::cluster::guild_member_remove_role instead

void void dpp::cluster::guild_member_kick (snowflake guild_id, snowflake user_id, command_completion_event_t callback=utility::log_error()) guild_member_kick dpp::cluster::guild_member_kick snowflake guild_id snowflake user_id command_completion_event_t callback utility::log_error()

Remove (kick) a guild member.

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

https://discord.com/developers/docs/resources/guild#remove-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to kick member from

user_id

User ID to kick

callback

Function 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().

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

Moves the guild member to a other voice channel, if member is connected to one. Set the `channel_id` to `0` to disconnect the user.

Fires a `Guild Member Update` Gateway event.

When moving members to channels, the API user must have permissions to both connect to the channel and have the `MOVE_MEMBERS` permission.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/guild#modify-guild-member

channel_id

Id of the channel to which the user is used. Set to `0` to disconnect the user

guild_id

Guild id to which the user is connected

user_id

User id, who should be moved

callback

Function 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().

void void dpp::cluster::guild_member_remove_role (snowflake guild_id, snowflake user_id, snowflake role_id, command_completion_event_t callback=utility::log_error()) guild_member_remove_role dpp::cluster::guild_member_remove_role snowflake guild_id snowflake user_id snowflake role_id command_completion_event_t callback utility::log_error()

Remove role from guild member.

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

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove role from user on

user_id

User ID to remove role from

role_id

Role to remove

callback

Function 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().

void void dpp::cluster::guild_member_timeout (snowflake guild_id, snowflake user_id, time_t communication_disabled_until, command_completion_event_t callback=utility::log_error()) guild_member_timeout dpp::cluster::guild_member_timeout snowflake guild_id snowflake user_id time_t communication_disabled_until command_completion_event_t callback utility::log_error()

Set the timeout of a guild member.

Fires a `Guild Member Update` Gateway event.

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to timeout the member in

user_id

User ID to set the timeout for

communication_disabled_until

The timestamp when the user's timeout will expire (up to 28 days in the future). Set to 0 to remove the timeout

callback

Function 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().

void void dpp::cluster::guild_member_timeout_remove (snowflake guild_id, snowflake user_id, command_completion_event_t callback=utility::log_error()) guild_member_timeout_remove dpp::cluster::guild_member_timeout_remove snowflake guild_id snowflake user_id command_completion_event_t callback utility::log_error()

Remove the timeout of a guild member. A shortcut for guild_member_timeout(guild_id, user_id, 0, callback) Fires a `Guild Member Update` Gateway event.

https://discord.com/developers/docs/resources/guild#modify-guild-member

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to remove the member timeout from

user_id

User ID to remove the timeout for

callback

Function 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().

void void dpp::cluster::guild_messages_search (snowflake guild_id, const message_search_params &params, command_completion_event_t callback) guild_messages_search dpp::cluster::guild_messages_search snowflake guild_id const message_search_params & params command_completion_event_t callback

Search for messages in a guild.

https://discord.com/developers/docs/resources/message#search-guild-messages

guild_id

Guild ID to search in

params

Search parameters

callback

Function to call when the API call completes. On success the callback will contain a dpp::message_search_result 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().

void void dpp::cluster::guild_modify_integration (snowflake guild_id, const class integration &i, command_completion_event_t callback=utility::log_error()) guild_modify_integration dpp::cluster::guild_modify_integration snowflake guild_id const class integration & i command_completion_event_t callback utility::log_error()

Modify guild integration.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/guild#modify-guild-integration

guild_id

Guild ID to modify integration for

i

Integration to modify

callback

Function 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().

void void dpp::cluster::guild_search_members (snowflake guild_id, const std::string &query, uint16_t limit, command_completion_event_t callback) guild_search_members 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.

This endpoint is restricted according to whether the `GUILD_MEMBERS` Privileged Intent is enabled for your application.

https://discord.com/developers/docs/resources/guild#search-guild-members

guild_id

Guild ID to search in

query

Query string to match username(s) and nickname(s) against

limit

max number of members to return (1-1000)

callback

Function 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().

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

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/guild#modify-current-user-nick

guild_id

Guild ID to change nickname on

nickname

New nickname, or empty string to clear nickname

callback

Function 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().

void void dpp::cluster::guild_sticker_create (const sticker &s, command_completion_event_t callback=utility::log_error()) guild_sticker_create dpp::cluster::guild_sticker_create const sticker & s command_completion_event_t callback utility::log_error()

Create a sticker in a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/sticker#create-guild-sticker

s

Sticker to create. Must have its guild ID set.

callback

Function 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().

void void dpp::cluster::guild_sticker_delete (snowflake sticker_id, snowflake guild_id, command_completion_event_t callback=utility::log_error()) guild_sticker_delete dpp::cluster::guild_sticker_delete snowflake sticker_id snowflake guild_id command_completion_event_t callback utility::log_error()

Delete a sticker from a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/sticker#delete-guild-sticker

sticker_id

sticker ID to delete

guild_id

guild ID to delete from

callback

Function 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().

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

Get a guild sticker.

https://discord.com/developers/docs/resources/sticker#get-guild-sticker

id

Id of sticker to get.

guild_id

Guild ID of the guild where the sticker is

callback

Function 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().

void void dpp::cluster::guild_sticker_modify (const sticker &s, command_completion_event_t callback=utility::log_error()) guild_sticker_modify dpp::cluster::guild_sticker_modify const sticker & s command_completion_event_t callback utility::log_error()

Modify a sticker in a guild.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/sticker#modify-guild-sticker

s

Sticker to modify. Must have its guild ID and sticker ID set.

callback

Function 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().

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

Get all guild stickers.

https://discord.com/developers/docs/resources/sticker#list-guild-stickers

guild_id

Guild ID of the guild where the sticker is

callback

Function to call when the API call completes. On success the callback will contain a dpp::sticker_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().

void void dpp::cluster::guild_sync_integration (snowflake guild_id, snowflake integration_id, command_completion_event_t callback=utility::log_error()) guild_sync_integration dpp::cluster::guild_sync_integration snowflake guild_id snowflake integration_id command_completion_event_t callback utility::log_error()

Sync guild integration.

https://discord.com/developers/docs/resources/guild#sync-guild-integration

guild_id

Guild ID to sync integration on

integration_id

Integration ID to synchronise

callback

Function 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().

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

Creates a template for the guild.

https://discord.com/developers/docs/resources/guild-template#create-guild-template

guild_id

Guild to create template from

name

Template name to create

description

Description of template to create

callback

Function to call when the API call completes. On success the callback will contain a dpp::dtemplate 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().

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

Deletes the template.

https://discord.com/developers/docs/resources/guild-template#delete-guild-template

guild_id

Guild ID of template to delete

code

Template code to delete

callback

Function 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().

void 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=utility::log_error()) guild_template_modify 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 utility::log_error()

Modifies the template's metadata.

https://discord.com/developers/docs/resources/guild-template#modify-guild-template

guild_id

Guild ID of template to modify

code

Template code to modify

name

New name of template

description

New description of template

callback

Function to call when the API call completes. On success the callback will contain a dpp::dtemplate 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().

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

Syncs the template to the guild's current state.

https://discord.com/developers/docs/resources/guild-template#sync-guild-template

guild_id

Guild to synchronise template for

code

Code of template to synchronise

callback

Function to call when the API call completes. On success the callback will contain a dpp::dtemplate 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().

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

Get guild templates.

https://discord.com/developers/docs/resources/guild-template#get-guild-templates

guild_id

Guild ID to get templates for

callback

Function to call when the API call completes. On success the callback will contain a dpp::dtemplate_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().

void void dpp::cluster::interaction_followup_create (const std::string &token, const message &m, command_completion_event_t callback=utility::log_error()) interaction_followup_create dpp::cluster::interaction_followup_create const std::string & token const message & m command_completion_event_t callback utility::log_error()

Create a followup message for an interaction.

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

token

Token for the interaction webhook

m

followup message to create

callback

Function 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().

void void dpp::cluster::interaction_followup_delete (const std::string &token, command_completion_event_t callback=utility::log_error()) interaction_followup_delete dpp::cluster::interaction_followup_delete const std::string & token command_completion_event_t callback utility::log_error()

Delete the initial interaction response.

https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response

token

Token for the interaction webhook

callback

Function 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().

void void dpp::cluster::interaction_followup_edit (const std::string &token, const message &m, command_completion_event_t callback=utility::log_error()) interaction_followup_edit dpp::cluster::interaction_followup_edit const std::string & token const message & m command_completion_event_t callback utility::log_error()

Edit followup message for an interaction The message ID in the message you pass should be correctly set to that of a followup message you previously sent.

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message

token

Token for the interaction webhook

m

message to edit, the ID should be set

callback

Function 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().

void void dpp::cluster::interaction_followup_edit_original (const std::string &token, const message &m, command_completion_event_t callback=utility::log_error()) interaction_followup_edit_original dpp::cluster::interaction_followup_edit_original const std::string & token const message & m command_completion_event_t callback utility::log_error()

Edit original followup message for an interaction This is an alias for cluster::interaction_response_edit.

cluster::interaction_response_edit

token

Token for the interaction webhook

m

message to edit, the ID should be set

callback

Function 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().

void void dpp::cluster::interaction_followup_get (const std::string &token, snowflake message_id, command_completion_event_t callback) interaction_followup_get dpp::cluster::interaction_followup_get const std::string & token snowflake message_id command_completion_event_t callback

Get the followup message for an interaction.

https://discord.com/developers/docs/interactions/receiving-and-responding#get-followup-message

token

Token for the interaction webhook

message_id

message to retrieve

callback

Function 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().

void void dpp::cluster::interaction_followup_get_original (const std::string &token, command_completion_event_t callback=utility::log_error()) interaction_followup_get_original dpp::cluster::interaction_followup_get_original const std::string & token command_completion_event_t callback utility::log_error()

Get the original followup message for an interaction This is an alias for cluster::interaction_response_get_original.

cluster::interaction_response_get_original

token

Token for the interaction webhook

callback

Function 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().

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

Respond to a slash command.

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

interaction_id

Interaction id to respond to

token

Token for the interaction webhook

r

Response to send

callback

Function 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().

void void dpp::cluster::interaction_response_edit (const std::string &token, const message &m, command_completion_event_t callback=utility::log_error()) interaction_response_edit dpp::cluster::interaction_response_edit const std::string & token const message & m command_completion_event_t callback utility::log_error()

Edit response to a slash command.

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response

token

Token for the interaction webhook

m

Message to send

callback

Function 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().

void void dpp::cluster::interaction_response_get_original (const std::string &token, command_completion_event_t callback=utility::log_error()) interaction_response_get_original dpp::cluster::interaction_response_get_original const std::string & token command_completion_event_t callback utility::log_error()

Get the original response to a slash command.

https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response

token

Token for the interaction webhook

callback

Function 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().

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

Delete an invite.

https://discord.com/developers/docs/resources/invite#delete-invite

This method supports audit log reasons set by the cluster::set_audit_reason() method.

invite

Invite code to delete

callback

Function 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().

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

Get details about an invite.

https://discord.com/developers/docs/resources/invite#get-invite

invite_code

Invite code to get information on

callback

Function 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().

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

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.

severity

The log level from dpp::loglevel

msg

The log message to output

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

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

https://discord.com/developers/docs/resources/channel#create-reaction

m

Message to add a reaction to

reaction

Reaction to add. Emojis should be in the form emojiname:id

callback

Function 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().

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

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

https://discord.com/developers/docs/topics/gateway#message-reaction-add

message_id

Message to add reactions to

channel_id

Channel to add reactions to

reaction

Reaction to add. Emojis should be in the form emojiname:id

callback

Function 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().

void void dpp::cluster::message_create (const struct message &m, command_completion_event_t callback=utility::log_error()) message_create dpp::cluster::message_create const struct message & m command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/resources/channel#create-message

m

Message to send

callback

Function 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().

void void dpp::cluster::message_crosspost (snowflake message_id, snowflake channel_id, command_completion_event_t callback=utility::log_error()) message_crosspost dpp::cluster::message_crosspost snowflake message_id snowflake channel_id command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/resources/channel#crosspost-message

message_id

Message to crosspost

channel_id

Channel ID to crosspost from

callback

Function 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().

void void dpp::cluster::message_delete (snowflake message_id, snowflake channel_id, command_completion_event_t callback=utility::log_error()) message_delete dpp::cluster::message_delete snowflake message_id snowflake channel_id command_completion_event_t callback utility::log_error()

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#delete-message

message_id

Message ID to delete

channel_id

Channel to delete from

callback

Function 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().

void void dpp::cluster::message_delete_all_reactions (const struct message &m, command_completion_event_t callback=utility::log_error()) message_delete_all_reactions dpp::cluster::message_delete_all_reactions const struct message & m command_completion_event_t callback utility::log_error()

Delete all reactions on a message.

https://discord.com/developers/docs/resources/channel#delete-all-reactions

m

Message to delete reactions from

callback

Function 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().

void void dpp::cluster::message_delete_all_reactions (snowflake message_id, snowflake channel_id, command_completion_event_t callback=utility::log_error()) message_delete_all_reactions dpp::cluster::message_delete_all_reactions snowflake message_id snowflake channel_id command_completion_event_t callback utility::log_error()

Delete all reactions on a message by id.

https://discord.com/developers/docs/resources/channel#delete-all-reactions

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

callback

Function 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().

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

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

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.

https://discord.com/developers/docs/resources/channel#bulk-delete-messages

message_ids

List of message IDs to delete (at least 2 and at most 100 message IDs)

channel_id

Channel to delete from

callback

Function 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().

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

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

https://discord.com/developers/docs/resources/channel#delete-own-reaction

m

Message to delete own reaction from

reaction

Reaction to delete. The reaction should be in the form emojiname:id

callback

Function 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().

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

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

https://discord.com/developers/docs/resources/channel#delete-own-reaction

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

reaction

Reaction to delete. The reaction should be in the form emojiname:id

callback

Function 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().

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

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

https://discord.com/developers/docs/resources/channel#delete-user-reaction

m

Message to delete a user's reaction from

user_id

User ID who's reaction you want to remove

reaction

Reaction to remove. Reactions should be in the form emojiname:id

callback

Function 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().

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

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

https://discord.com/developers/docs/resources/channel#delete-user-reaction

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

user_id

User ID who's reaction you want to remove

reaction

Reaction to remove. Reactions should be in the form emojiname:id

callback

Function 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().

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

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

https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji

m

Message to delete reactions from

reaction

Reaction to delete, in the form emojiname:id or a unicode character

callback

Function 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().

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

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.

https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji

message_id

Message to delete reactions from

channel_id

Channel to delete reactions from

reaction

Reaction to delete, in the form emojiname:id or a unicode character

callback

Function 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().

void void dpp::cluster::message_edit (const struct message &m, command_completion_event_t callback=utility::log_error()) message_edit dpp::cluster::message_edit const struct message & m command_completion_event_t callback utility::log_error()

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

https://discord.com/developers/docs/resources/channel#edit-message

m

Message to edit

callback

Function 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().

void void dpp::cluster::message_edit_flags (const struct message &m, command_completion_event_t callback=utility::log_error()) message_edit_flags dpp::cluster::message_edit_flags const struct message & m command_completion_event_t callback utility::log_error()

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

m

Message to edit the flags of

callback

Function 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().

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

Get a message.

https://discord.com/developers/docs/resources/channel#get-channel-message

message_id

Message ID

channel_id

Channel ID

callback

Function 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().

void 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) message_get_reactions 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.

https://discord.com/developers/docs/resources/channel#get-reactions

m

Message to get reactions for

reaction

Reaction should be in the form emojiname:id or a unicode character

before

Reactions before this ID should be retrieved if this is set to non-zero

after

Reactions before this ID should be retrieved if this is set to non-zero

limit

This number of reactions maximum should be returned

callback

Function 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().

void 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) message_get_reactions 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.

https://discord.com/developers/docs/resources/channel#get-reactions

message_id

Message to get reactions for

channel_id

Channel to get reactions for

reaction

Reaction should be in the form emojiname:id or a unicode character

before

Reactions before this ID should be retrieved if this is set to non-zero

after

Reactions before this ID should be retrieved if this is set to non-zero

limit

This number of reactions maximum should be returned

callback

Function 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().

void void dpp::cluster::message_pin (snowflake channel_id, snowflake message_id, command_completion_event_t callback=utility::log_error()) message_pin dpp::cluster::message_pin snowflake channel_id snowflake message_id command_completion_event_t callback utility::log_error()

Pin a message.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#pin-message

channel_id

Channel id to pin message on

message_id

Message id to pin message on

callback

Function 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().

void void dpp::cluster::message_unpin (snowflake channel_id, snowflake message_id, command_completion_event_t callback=utility::log_error()) message_unpin dpp::cluster::message_unpin snowflake channel_id snowflake message_id command_completion_event_t callback utility::log_error()

Unpin a message.

https://discord.com/developers/docs/resources/channel#unpin-message

This method supports audit log reasons set by the cluster::set_audit_reason() method.

channel_id

Channel id to unpin message on

message_id

Message id to unpin message on

callback

Function 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().

void void dpp::cluster::messages_get (snowflake channel_id, snowflake around, snowflake before, snowflake after, uint64_t limit, command_completion_event_t callback) messages_get dpp::cluster::messages_get snowflake channel_id snowflake around snowflake before snowflake after uint64_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.

https://discord.com/developers/docs/resources/channel#get-channel-messages

channel_id

Channel ID to retrieve messages for

around

Messages should be retrieved around this ID if this is set to non-zero

before

Messages before this ID should be retrieved if this is set to non-zero

after

Messages after this ID should be retrieved if this is set to non-zero

limit

This number of messages maximum should be returned, up to a maximum of 100.

callback

Function 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().

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

Get a nitro sticker.

https://discord.com/developers/docs/resources/sticker#get-sticker

id

Id of sticker to get.

callback

Function 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().

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

dpp::cluster is non-moveable

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

dpp::cluster is non-copyable

void void dpp::cluster::poll_end (const message &m, command_completion_event_t callback=utility::log_error()) poll_end dpp::cluster::poll_end const message & m command_completion_event_t callback utility::log_error()

Immediately end a poll.

m

Message that contains the poll

callback

Function to call when the API call completes.

https://discord.com/developers/docs/resources/poll#end-poll On success the callback will contain a dpp::message object representing the message containing the poll 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().

void void dpp::cluster::poll_end (snowflake message_id, snowflake channel_id, command_completion_event_t callback=utility::log_error()) poll_end dpp::cluster::poll_end snowflake message_id snowflake channel_id command_completion_event_t callback utility::log_error()

Immediately end a poll.

message_id

ID of the message with the poll to end

channel_id

ID of the channel with the poll to end

callback

Function to call when the API call completes.

https://discord.com/developers/docs/resources/poll#end-poll On success the callback will contain a dpp::message object representing the message containing the poll 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().

void void dpp::cluster::poll_get_answer_voters (const message &m, uint32_t answer_id, snowflake after, uint64_t limit, command_completion_event_t callback=utility::log_error()) poll_get_answer_voters dpp::cluster::poll_get_answer_voters const message & m uint32_t answer_id snowflake after uint64_t limit command_completion_event_t callback utility::log_error()

Get a list of users that voted for this specific answer.

m

Message that contains the poll to retrieve the answers from

answer_id

ID of the answer to retrieve votes from (see poll_answer::answer_id)

after

Users after this ID should be retrieved if this is set to non-zero

limit

This number of users maximum should be returned, up to 100

callback

Function to call when the API call completes.

https://discord.com/developers/docs/resources/poll#get-answer-voters 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().

void void dpp::cluster::poll_get_answer_voters (snowflake message_id, snowflake channel_id, uint32_t answer_id, snowflake after, uint64_t limit, command_completion_event_t callback=utility::log_error()) poll_get_answer_voters dpp::cluster::poll_get_answer_voters snowflake message_id snowflake channel_id uint32_t answer_id snowflake after uint64_t limit command_completion_event_t callback utility::log_error()

Get a list of users that voted for this specific answer.

message_id

ID of the message with the poll to retrieve the answers from

channel_id

ID of the channel with the poll to retrieve the answers from

answer_id

ID of the answer to retrieve votes from (see poll_answer::answer_id)

after

Users after this ID should be retrieved if this is set to non-zero

limit

This number of users maximum should be returned, up to 100

callback

Function to call when the API call completes.

https://discord.com/developers/docs/resources/poll#get-answer-voters 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().

void 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="", const std::string &filemimetype="", const std::string &protocol="1.1") post_rest 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 "" const std::string & filemimetype "" const std::string & protocol "1.1"

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

endpoint

Endpoint to post to, e.g. /api/guilds

major_parameters

Major parameters for the endpoint e.g. a guild id

parameters

Minor parameters for the API request

method

Method, e.g. GET, POST

postdata

Post data (usually JSON encoded)

callback

Function to call when the HTTP call completes. The callback parameter will contain amongst other things, the decoded json.

filename

Filename to post for POST requests (for uploading files)

filecontent

File content to post for POST requests (for uploading files)

filemimetype

File content to post for POST requests (for uploading files)

protocol

HTTP protocol to use (1.0 and 1.1 are supported)

void 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< message_file_data > &file_data={}) post_rest_multipart 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< message_file_data > & file_data {}

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

endpoint

Endpoint to post to, e.g. /api/guilds

major_parameters

Major parameters for the endpoint e.g. a guild id

parameters

Minor parameters for the API request

method

Method, e.g. GET, POST

postdata

Post data (usually JSON encoded)

callback

Function to call when the HTTP call completes. The callback parameter will contain amongst other things, the decoded json.

file_data

List of files to post for POST requests (for uploading files)

void void dpp::cluster::queue_work (int priority, work_unit task) queue_work dpp::cluster::queue_work int priority work_unit task

Place some arbitrary work into the thread pool for execution when time permits.

Work units are fetched into threads on the thread pool from the queue in order of priority, lowest numeric values first. Low numeric values should be reserved for API replies from Discord, guild creation events, etc.

priority

Priority of the work unit

task

Task to queue

typename F
bool bool dpp::cluster::register_command (const std::string &name, F &&handler) register_command dpp::cluster::register_command const std::string & name F && handler (utility::callable_returns<F, dpp::task<void>, const slashcommand_t&>)

Register a coroutine-based slash command handler.

name

The name of the slash command to register.

handler

A coroutine handler function of type `co_slashcommand_handler_t`.

bool Returns `true` if the command was registered successfully, or `false` if the command with the same name already exists.

typename F
std::enable_if_t< utility::callable_returns_v< F, void, const slashcommand_t & >, bool > std::enable_if_t< utility::callable_returns_v< F, void, const slashcommand_t & >, bool > dpp::cluster::register_command (const std::string &name, F &&handler) register_command dpp::cluster::register_command const std::string & name F && handler

Register a slash command handler.

name

The name of the slash command to register

handler

A handler function of type `slashcommand_handler_t`

bool Returns `true` if the command was registered successfully, or `false` if the command with the same name already exists

void 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={}, const std::string &protocol="1.1") request 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 {} const std::string & protocol "1.1"

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

url

Full URL to post to, e.g. https://api.somewhere.com/v1/foo/

method

Method, e.g. GET, POST

callback

Function to call when the HTTP call completes. No processing is done on the returned data.

postdata

POST data

mimetype

MIME type of POST data

headers

Headers to send with the request

protocol

HTTP protocol to use (1.1 and 1.0 are supported)

void void dpp::cluster::role_create (const class role &r, command_completion_event_t callback=utility::log_error()) role_create dpp::cluster::role_create const class role & r command_completion_event_t callback utility::log_error()

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.

https://discord.com/developers/docs/resources/guild#create-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

r

Role to create (guild ID is encapsulated in the role object)

callback

Function 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().

void void dpp::cluster::role_delete (snowflake guild_id, snowflake role_id, command_completion_event_t callback=utility::log_error()) role_delete dpp::cluster::role_delete snowflake guild_id snowflake role_id command_completion_event_t callback utility::log_error()

Delete a role.

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

https://discord.com/developers/docs/resources/guild#delete-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to delete the role on

role_id

Role ID to delete

callback

Function 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().

void void dpp::cluster::role_edit (const class role &r, command_completion_event_t callback=utility::log_error()) role_edit dpp::cluster::role_edit const class role & r command_completion_event_t callback utility::log_error()

Edit a role on a guild.

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

https://discord.com/developers/docs/resources/guild#modify-guild-role

This method supports audit log reasons set by the cluster::set_audit_reason() method.

r

Role to edit

callback

Function 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().

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

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.

https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

This method supports audit log reasons set by the cluster::set_audit_reason() method.

guild_id

Guild ID to change the roles position on

roles

Vector of roles to change the positions of

callback

Function 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().

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

Get a role for a guild.

https://discord.com/developers/docs/resources/guild#get-guild-roles

guild_id

Guild ID to get role for

callback

Function 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().

cluster & cluster & dpp::cluster::set_audit_reason (const std::string &reason) set_audit_reason 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("Toomuchabusivecontent")
    .channel_delete(my_channel_id);

reason

The reason to set for the next REST call on this thread

cluster& Reference to self for chaining.

cluster & cluster & dpp::cluster::set_default_gateway (const std::string &default_gateway) set_default_gateway dpp::cluster::set_default_gateway const std::string & default_gateway

Sets the address of the default gateway, for connecting the websockets.

cluster& Reference to self for chaining.

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

Set the dm channel id for a user id.

user_id

user id to set the dm channel for

channel_id

dm channel to set

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

Set the presence for all shards on the cluster.

p

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

cluster & cluster & dpp::cluster::set_request_timeout (uint16_t timeout) set_request_timeout dpp::cluster::set_request_timeout uint16_t timeout

Sets the request timeout.

timeout

The length of time (in seconds) that requests are allowed to take. Default: 20.

cluster& Reference to self for chaining.

cluster & cluster & dpp::cluster::set_websocket_protocol (websocket_protocol_t mode) set_websocket_protocol 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.

mode

websocket protocol to use, either ws_json or ws_etf.

cluster& Reference to self for chaining.

dpp::logic_exception

If called after the cluster is started (this is not supported)

void void dpp::cluster::shutdown () shutdown dpp::cluster::shutdown

End cluster execution without destructing it. To restart the cluster, call cluster::start() again.

void void dpp::cluster::skus_get (command_completion_event_t callback=utility::log_error()) skus_get dpp::cluster::skus_get command_completion_event_t callback utility::log_error()

Returns all SKUs for a given application.

Because of how Discord's SKU and subscription systems work, you will see two SKUs for your premium offering. For integration and testing entitlements, you should use the SKU with type: 5.

https://discord.com/developers/docs/monetization/skus#list-skus

callback

Function 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().

void void dpp::cluster::stage_instance_create (const stage_instance &instance, command_completion_event_t callback=utility::log_error()) stage_instance_create dpp::cluster::stage_instance_create const stage_instance & instance command_completion_event_t callback utility::log_error()

Create a stage instance on a stage channel.

https://discord.com/developers/docs/resources/stage-instance#create-stage-instance

instance

Stage instance to create

callback

User 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().

This method supports audit log reasons set by the cluster::set_audit_reason() method.

void void dpp::cluster::stage_instance_delete (const snowflake channel_id, command_completion_event_t callback=utility::log_error()) stage_instance_delete dpp::cluster::stage_instance_delete const snowflake channel_id command_completion_event_t callback utility::log_error()

Delete a stage instance.

https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance

channel_id

ID of the associated channel

callback

User 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().

This method supports audit log reasons set by the cluster::set_audit_reason() method.

void void dpp::cluster::stage_instance_edit (const stage_instance &instance, command_completion_event_t callback=utility::log_error()) stage_instance_edit dpp::cluster::stage_instance_edit const stage_instance & instance command_completion_event_t callback utility::log_error()

Edit a stage instance.

https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance

instance

Stage instance to edit

callback

User 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().

This method supports audit log reasons set by the cluster::set_audit_reason() method.

void void dpp::cluster::stage_instance_get (const snowflake channel_id, command_completion_event_t callback) stage_instance_get 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.

https://discord.com/developers/docs/resources/stage-instance#get-stage-instance

channel_id

ID of the associated channel

callback

User 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().

void void dpp::cluster::start (start_type return_after=st_wait) start dpp::cluster::start start_type return_after st_wait

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.

return_after

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

std::invocable< timer > T T
std::invocable< timer > U U std::function<void(timer)>
timer timer dpp::cluster::start_timer (T &&on_tick, uint64_t frequency, U &&on_stop={}) start_timer dpp::cluster::start_timer T && on_tick uint64_t frequency U && on_stop {} ( dpp::awaitable_type<typename std::invoke_result<T, timer>::type> && std::copy_constructible<std::decay_t<T>> && // N4988 [func.wrap.func.con]/10.1 - std::function requires a copy constructible argument std::copy_constructible<std::decay_t<U>> )

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

on_tick

The callback lambda to call for this timer when ticked

on_stop

The callback lambda to call for this timer when it is stopped

frequency

How often to tick the timer in seconds

timer A handle to the timer, used to remove that timer later

timer timer dpp::cluster::start_timer (timer_callback_t on_tick, uint64_t frequency, timer_callback_t on_stop={}) start_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.

on_tick

The callback lambda to call for this timer when ticked

on_stop

The callback lambda to call for this timer when it is stopped

frequency

How often to tick the timer in seconds

timer A handle to the timer, used to remove that timer later

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

Get a list of available sticker packs.

https://discord.com/developers/docs/resources/sticker#list-sticker-packs

callback

Function to call when the API call completes. On success the callback will contain a dpp::sticker_pack_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().

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

Stop a ticking timer.

t

Timer handle received from cluster::start_timer

bool True if the timer was stopped, false if it did not exist

If the timer has an on_stop lambda, the on_stop lambda will be called.

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

Get a template.

https://discord.com/developers/docs/resources/guild-template#get-guild-template

code

Template code

callback

Function to call when the API call completes. On success the callback will contain a dpp::dtemplate 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().

void 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=utility::log_error()) thread_create 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 utility::log_error()

Create a thread.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#start-thread-without-message

thread_name

Name of the thread

channel_id

Channel in which thread to create

auto_archive_duration

Duration after which thread auto-archives. Can be set to - 60, 1440 (for boosted guilds can also be: 4320, 10080)

thread_type

Type of thread - CHANNEL_PUBLIC_THREAD, CHANNEL_ANNOUNCEMENT_THREAD, CHANNEL_PRIVATE_THREAD

invitable

whether non-moderators can add other non-moderators to a thread; only available when creating a private thread

rate_limit_per_user

amount 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

callback

Function 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().

void void dpp::cluster::thread_create_in_forum (const std::string &thread_name, snowflake channel_id, const message &msg, auto_archive_duration_t auto_archive_duration, uint16_t rate_limit_per_user, std::vector< snowflake > applied_tags={}, command_completion_event_t callback=utility::log_error()) thread_create_in_forum dpp::cluster::thread_create_in_forum const std::string & thread_name snowflake channel_id const message & msg auto_archive_duration_t auto_archive_duration uint16_t rate_limit_per_user std::vector< snowflake > applied_tags {} command_completion_event_t callback utility::log_error()

Create a thread in a forum or media channel.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#start-thread-in-forum-channel

thread_name

Name of the forum thread

channel_id

Forum channel in which thread to create

msg

The message to start the thread with

auto_archive_duration

Duration to automatically archive the thread after recent activity

rate_limit_per_user

amount 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

applied_tags

List of IDs of forum tags (dpp::forum_tag) to apply to this thread

callback

Function 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().

void 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=utility::log_error()) thread_create_with_message 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 utility::log_error()

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

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/resources/channel#start-thread-from-message

thread_name

Name of the thread

channel_id

Channel in which thread to create

message_id

message to start thread with

auto_archive_duration

Duration after which thread auto-archives. Can be set to - 60, 1440 (for boosted guilds can also be: 4320, 10080)

rate_limit_per_user

amount 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

callback

Function 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().

void void dpp::cluster::thread_edit (const thread &t, command_completion_event_t callback=utility::log_error()) thread_edit dpp::cluster::thread_edit const thread & t command_completion_event_t callback utility::log_error()

Edit a thread.

This method supports audit log reasons set by the cluster::set_audit_reason() method.

https://discord.com/developers/docs/topics/threads#editing-deleting-threads

t

Thread to edit

callback

Function 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().

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

Get the thread specified by thread_id. This uses the same call as dpp::cluster::channel_get but returns a thread object.

https://discord.com/developers/docs/resources/channel#get-channel

thread_id

The id of the thread to obtain.

callback

Function 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().

void void dpp::cluster::thread_member_add (snowflake thread_id, snowflake user_id, command_completion_event_t callback=utility::log_error()) thread_member_add dpp::cluster::thread_member_add snowflake thread_id snowflake user_id command_completion_event_t callback utility::log_error()

Add a member to a thread.

https://discord.com/developers/docs/resources/channel#add-thread-member

thread_id

Thread ID to add to

user_id

Member ID to add

callback

Function 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().

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

Get a thread member.

https://discord.com/developers/docs/resources/channel#get-thread-member

thread_id

Thread to get member for

user_id

ID of the user to get

callback

Function 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().

void void dpp::cluster::thread_member_remove (snowflake thread_id, snowflake user_id, command_completion_event_t callback=utility::log_error()) thread_member_remove dpp::cluster::thread_member_remove snowflake thread_id snowflake user_id command_completion_event_t callback utility::log_error()

Remove a member from a thread.

https://discord.com/developers/docs/resources/channel#remove-thread-member

thread_id

Thread ID to remove from

user_id

Member ID to remove

callback

Function 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().

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

Get members of a thread.

https://discord.com/developers/docs/resources/channel#list-thread-members

thread_id

Thread to get members for

callback

Function 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().

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

Get all active threads in the guild, including public and private threads. Threads are ordered by their id, in descending order.

https://discord.com/developers/docs/resources/guild#list-active-guild-threads

guild_id

Guild to get active threads for

callback

Function to call when the API call completes On success the callback will contain a dpp::active_threads 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().

void void dpp::cluster::threads_get_joined_private_archived (snowflake channel_id, snowflake before_id, uint16_t limit, command_completion_event_t callback) threads_get_joined_private_archived 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).

https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads

channel_id

Channel to get public archived threads for

before_id

Get threads before this id

limit

Number of threads to get

callback

Function 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().

void void dpp::cluster::threads_get_private_archived (snowflake channel_id, time_t before_timestamp, uint16_t limit, command_completion_event_t callback) threads_get_private_archived 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).

https://discord.com/developers/docs/resources/channel#list-private-archived-threads

channel_id

Channel to get public archived threads for

before_timestamp

Get threads archived before this timestamp

limit

Number of threads to get

callback

Function 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().

void void dpp::cluster::threads_get_public_archived (snowflake channel_id, time_t before_timestamp, uint16_t limit, command_completion_event_t callback) threads_get_public_archived 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).

https://discord.com/developers/docs/resources/channel#list-public-archived-threads

channel_id

Channel to get public archived threads for

before_timestamp

Get threads archived before this timestamp

limit

Number of threads to get

callback

Function 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().

void void dpp::cluster::tick_timers () tick_timers dpp::cluster::tick_timers

Tick active timers.

bool bool dpp::cluster::unregister_command (const std::string &name) unregister_command dpp::cluster::unregister_command const std::string & name

Unregister a slash command.

This function unregisters (removes) a previously registered slash command by name. If the command is successfully removed, it returns `true`.

name

The name of the slash command to unregister.

bool Returns `true` if the command was successfully unregistered, or `false` if the command was not found.

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

Returns the uptime of the cluster.

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

void void dpp::cluster::user_application_role_connection_get (snowflake application_id, command_completion_event_t callback) user_application_role_connection_get dpp::cluster::user_application_role_connection_get snowflake application_id command_completion_event_t callback

Get user application role connection.

https://discord.com/developers/docs/resources/user#get-user-application-role-connection

application_id

The application ID

callback

Function to call when the API call completes. On success the callback will contain a dpp::application_role_connection 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().

void void dpp::cluster::user_application_role_connection_update (snowflake application_id, const application_role_connection &connection, command_completion_event_t callback=utility::log_error()) user_application_role_connection_update dpp::cluster::user_application_role_connection_update snowflake application_id const application_role_connection & connection command_completion_event_t callback utility::log_error()

Update user application role connection.

https://discord.com/developers/docs/resources/user#update-user-application-role-connection

application_id

The application ID

connection

The application role connection to update

callback

Function to call when the API call completes. On success the callback will contain a dpp::application_role_connection 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().

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

Get a user by id, without using the cache.

https://discord.com/developers/docs/resources/user#get-user

user_id

User ID to retrieve

callback

Function 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().

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.

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

Get a user by id, checking in the cache first.

https://discord.com/developers/docs/resources/user#get-user

user_id

User ID to retrieve

callback

Function 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().

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`.

If the user is found in the cache, special values set in `dpp::user_identified` will be undefined. This call should be used where you want to for example resolve a user who may no longer be in the bot's guilds, for something like a ban log message.

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

Get a user's voice state in a guild without a Gateway connection.

https://discord.com/developers/docs/resources/voice#get-user-voice-state

guild_id

Guild to get the voice state for

user_id

The user to get the voice state of

callback

Function to call when the API call completes. On success the callback will contain a dpp::voicestate 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().

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

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.

https://discord.com/developers/docs/resources/guild#modify-user-voice-state

user_id

The user to set the voice state of

guild_id

Guild to set voice state on

channel_id

Stage channel to set voice state on

callback

Function to call when the API call completes.

suppress

True 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().

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.

K
T
bool
cache_policy_setting_t
double
dpp::cache_policy_t
channel_policy
emoji_policy
guild_policy
role_policy
user_policy
dpp::cluster
token
last_identify
cluster_id
intents
maxclusters
numshards
rest_ping
me
cache_policy
ws_mode
terminating
request_timeout
socketengine
on_voice_channel_effect_send
on_voice_state_update
on_voice_client_platform
on_voice_client_disconnect
on_voice_client_speaking
on_log
on_socket_close
on_guild_join_request_delete
on_interaction_create
on_slashcommand
on_button_click
on_autocomplete
on_select_click
on_message_context_menu
on_user_context_menu
on_form_submit
on_guild_delete
on_channel_delete
on_channel_update
on_ready
on_message_delete
on_guild_member_remove
on_resumed
on_guild_role_create
on_typing_start
on_message_reaction_add
on_guild_members_chunk
on_message_reaction_remove
on_guild_create
on_channel_create
on_message_reaction_remove_emoji
on_message_delete_bulk
on_guild_role_update
on_guild_role_delete
on_channel_pins_update
on_message_reaction_remove_all
on_voice_server_update
on_guild_emojis_update
on_guild_stickers_update
on_presence_update
on_webhooks_update
on_automod_rule_create
on_automod_rule_update
on_automod_rule_delete
on_automod_rule_execute
on_guild_member_add
on_invite_delete
on_guild_update
on_guild_integrations_update
on_guild_member_update
on_invite_create
on_message_update
on_user_update
on_message_create
on_message_poll_vote_add
on_message_poll_vote_remove
on_guild_audit_log_entry_create
on_guild_ban_add
on_guild_ban_remove
on_integration_create
on_integration_update
on_integration_delete
on_thread_create
on_thread_update
on_thread_delete
on_thread_list_sync
on_thread_member_update
on_thread_members_update
on_guild_scheduled_event_create
on_guild_scheduled_event_update
on_guild_scheduled_event_delete
on_guild_scheduled_event_user_add
on_guild_scheduled_event_user_remove
on_voice_buffer_send
on_voice_ready
on_voice_receive
on_voice_receive_combined
on_voice_track_marker
on_stage_instance_create
on_stage_instance_update
on_stage_instance_delete
on_entitlement_create
on_entitlement_update
on_entitlement_delete
dpp::event_router_t< T >
dpp::event_router_t< dpp::autocomplete_t >
< dpp::autocomplete_t >
dpp::event_router_t< dpp::automod_rule_create_t >
< dpp::automod_rule_create_t >
dpp::event_router_t< dpp::automod_rule_delete_t >
< dpp::automod_rule_delete_t >
dpp::event_router_t< dpp::automod_rule_execute_t >
< dpp::automod_rule_execute_t >
dpp::event_router_t< dpp::automod_rule_update_t >
< dpp::automod_rule_update_t >
dpp::event_router_t< dpp::button_click_t >
< dpp::button_click_t >
dpp::event_router_t< dpp::channel_create_t >
< dpp::channel_create_t >
dpp::event_router_t< dpp::channel_delete_t >
< dpp::channel_delete_t >
dpp::event_router_t< dpp::channel_pins_update_t >
< dpp::channel_pins_update_t >
dpp::event_router_t< dpp::channel_update_t >
< dpp::channel_update_t >
dpp::event_router_t< dpp::entitlement_create_t >
< dpp::entitlement_create_t >
dpp::event_router_t< dpp::entitlement_delete_t >
< dpp::entitlement_delete_t >
dpp::event_router_t< dpp::entitlement_update_t >
< dpp::entitlement_update_t >
dpp::event_router_t< dpp::form_submit_t >
< dpp::form_submit_t >
dpp::event_router_t< dpp::guild_audit_log_entry_create_t >
< dpp::guild_audit_log_entry_create_t >
dpp::event_router_t< dpp::guild_ban_add_t >
< dpp::guild_ban_add_t >
dpp::event_router_t< dpp::guild_ban_remove_t >
< dpp::guild_ban_remove_t >
dpp::event_router_t< dpp::guild_create_t >
< dpp::guild_create_t >
dpp::event_router_t< dpp::guild_delete_t >
< dpp::guild_delete_t >
dpp::event_router_t< dpp::guild_emojis_update_t >
< dpp::guild_emojis_update_t >
dpp::event_router_t< dpp::guild_integrations_update_t >
< dpp::guild_integrations_update_t >
dpp::event_router_t< dpp::guild_join_request_delete_t >
< dpp::guild_join_request_delete_t >
dpp::event_router_t< dpp::guild_member_add_t >
< dpp::guild_member_add_t >
dpp::event_router_t< dpp::guild_member_remove_t >
< dpp::guild_member_remove_t >
dpp::event_router_t< dpp::guild_member_update_t >
< dpp::guild_member_update_t >
dpp::event_router_t< dpp::guild_members_chunk_t >
< dpp::guild_members_chunk_t >
dpp::event_router_t< dpp::guild_role_create_t >
< dpp::guild_role_create_t >
dpp::event_router_t< dpp::guild_role_delete_t >
< dpp::guild_role_delete_t >
dpp::event_router_t< dpp::guild_role_update_t >
< dpp::guild_role_update_t >
dpp::event_router_t< dpp::guild_scheduled_event_create_t >
< dpp::guild_scheduled_event_create_t >
dpp::event_router_t< dpp::guild_scheduled_event_delete_t >
< dpp::guild_scheduled_event_delete_t >
dpp::event_router_t< dpp::guild_scheduled_event_update_t >
< dpp::guild_scheduled_event_update_t >
dpp::event_router_t< dpp::guild_scheduled_event_user_add_t >
< dpp::guild_scheduled_event_user_add_t >
dpp::event_router_t< dpp::guild_scheduled_event_user_remove_t >
< dpp::guild_scheduled_event_user_remove_t >
dpp::event_router_t< dpp::guild_stickers_update_t >
< dpp::guild_stickers_update_t >
dpp::event_router_t< dpp::guild_update_t >
< dpp::guild_update_t >
dpp::event_router_t< dpp::integration_create_t >
< dpp::integration_create_t >
dpp::event_router_t< dpp::integration_delete_t >
< dpp::integration_delete_t >
dpp::event_router_t< dpp::integration_update_t >
< dpp::integration_update_t >
dpp::event_router_t< dpp::interaction_create_t >
< dpp::interaction_create_t >
dpp::event_router_t< dpp::invite_create_t >
< dpp::invite_create_t >
dpp::event_router_t< dpp::invite_delete_t >
< dpp::invite_delete_t >
dpp::event_router_t< dpp::log_t >
< dpp::log_t >
dpp::event_router_t< dpp::message_context_menu_t >
< dpp::message_context_menu_t >
dpp::event_router_t< dpp::message_create_t >
< dpp::message_create_t >
dpp::event_router_t< dpp::message_delete_bulk_t >
< dpp::message_delete_bulk_t >
dpp::event_router_t< dpp::message_delete_t >
< dpp::message_delete_t >
dpp::event_router_t< dpp::message_poll_vote_add_t >
< dpp::message_poll_vote_add_t >
dpp::event_router_t< dpp::message_poll_vote_remove_t >
< dpp::message_poll_vote_remove_t >
dpp::event_router_t< dpp::message_reaction_add_t >
< dpp::message_reaction_add_t >
dpp::event_router_t< dpp::message_reaction_remove_all_t >
< dpp::message_reaction_remove_all_t >
dpp::event_router_t< dpp::message_reaction_remove_emoji_t >
< dpp::message_reaction_remove_emoji_t >
dpp::event_router_t< dpp::message_reaction_remove_t >
< dpp::message_reaction_remove_t >
dpp::event_router_t< dpp::message_update_t >
< dpp::message_update_t >
dpp::event_router_t< dpp::presence_update_t >
< dpp::presence_update_t >
dpp::event_router_t< dpp::ready_t >
< dpp::ready_t >
dpp::event_router_t< dpp::resumed_t >
< dpp::resumed_t >
dpp::event_router_t< dpp::select_click_t >
< dpp::select_click_t >
dpp::event_router_t< dpp::slashcommand_t >
< dpp::slashcommand_t >
dpp::event_router_t< dpp::socket_close_t >
< dpp::socket_close_t >
dpp::event_router_t< dpp::stage_instance_create_t >
< dpp::stage_instance_create_t >
dpp::event_router_t< dpp::stage_instance_delete_t >
< dpp::stage_instance_delete_t >
dpp::event_router_t< dpp::stage_instance_update_t >
< dpp::stage_instance_update_t >
dpp::event_router_t< dpp::thread_create_t >
< dpp::thread_create_t >
dpp::event_router_t< dpp::thread_delete_t >
< dpp::thread_delete_t >
dpp::event_router_t< dpp::thread_list_sync_t >
< dpp::thread_list_sync_t >
dpp::event_router_t< dpp::thread_member_update_t >
< dpp::thread_member_update_t >
dpp::event_router_t< dpp::thread_members_update_t >
< dpp::thread_members_update_t >
dpp::event_router_t< dpp::thread_update_t >
< dpp::thread_update_t >
dpp::event_router_t< dpp::typing_start_t >
< dpp::typing_start_t >
dpp::event_router_t< dpp::user_context_menu_t >
< dpp::user_context_menu_t >
dpp::event_router_t< dpp::user_update_t >
< dpp::user_update_t >
dpp::event_router_t< dpp::voice_buffer_send_t >
< dpp::voice_buffer_send_t >
dpp::event_router_t< dpp::voice_channel_effect_send_t >
< dpp::voice_channel_effect_send_t >
dpp::event_router_t< dpp::voice_client_disconnect_t >
< dpp::voice_client_disconnect_t >
dpp::event_router_t< dpp::voice_client_platform_t >
< dpp::voice_client_platform_t >
dpp::event_router_t< dpp::voice_client_speaking_t >
< dpp::voice_client_speaking_t >
dpp::event_router_t< dpp::voice_ready_t >
< dpp::voice_ready_t >
dpp::event_router_t< dpp::voice_receive_t >
< dpp::voice_receive_t >
dpp::event_router_t< dpp::voice_server_update_t >
< dpp::voice_server_update_t >
dpp::event_router_t< dpp::voice_state_update_t >
< dpp::voice_state_update_t >
dpp::event_router_t< dpp::voice_track_marker_t >
< dpp::voice_track_marker_t >
dpp::event_router_t< dpp::webhooks_update_t >
< dpp::webhooks_update_t >
dpp::json_interface< T >
dpp::json_interface< user >
< user >
dpp::managed
id
dpp::snowflake
value
dpp::socket_engine_base
owner
fds_mutex
fds
stats
dpp::socket_stats
active_fds
deletions
errors
iterations
reads
updates
writes
engine_type
dpp::user
global_name
username
avatar
avatar_decoration
primary_guild
flags
discriminator
refcount
dpp::utility::iconhash
first
second
dpp::utility::primaryguild
id
enabled
tag
badge
atomic_bool
std::basic_string< Char >
std::basic_string_view< Char >
std::shared_mutex
std::string
std::string_view
std::unique_ptr< T >
ptr
std::unique_ptr< dpp::socket_engine_base >
ptr
< dpp::socket_engine_base >
std::unordered_map< K, T >
keys
elements
std::unordered_map< dpp::socket, std::unique_ptr< socket_events > >
< dpp::socket, std::unique_ptr< socket_events > >
time_t
uint16_t
uint32_t
uint64_t
uint8_t
websocket_protocol_t
- dpp::cluster
  active_requests
- dpp::cluster
  add_reconnect
- dpp::cluster
  application_emoji_create
- dpp::cluster
  application_emoji_delete
- dpp::cluster
  application_emoji_edit
- dpp::cluster
  application_emoji_get
- dpp::cluster
  application_emojis_get
- dpp::cluster
  application_role_connection_get
- dpp::cluster
  application_role_connection_update
- dpp::cluster
  automod_rule_create
- dpp::cluster
  automod_rule_delete
- dpp::cluster
  automod_rule_edit
- dpp::cluster
  automod_rule_get
- dpp::cluster
  automod_rules_get
- dpp::cluster
  cache_policy
- dpp::cluster
  channel_create
- dpp::cluster
  channel_delete
- dpp::cluster
  channel_delete_permission
- dpp::cluster
  channel_edit
- dpp::cluster
  channel_edit_permissions
- dpp::cluster
  channel_edit_permissions
- dpp::cluster
  channel_edit_positions
- dpp::cluster
  channel_follow_news
- dpp::cluster
  channel_get
- dpp::cluster
  channel_invite_create
- dpp::cluster
  channel_invites_get
- dpp::cluster
  channel_pins_get
- dpp::cluster
  channel_pins_get
- dpp::cluster
  channel_set_voice_status
- dpp::cluster
  channel_typing
- dpp::cluster
  channel_typing
- dpp::cluster
  channels_get
- dpp::cluster
  clear_audit_reason
- dpp::cluster
  cluster
- dpp::cluster
  cluster
- dpp::cluster
  cluster
- dpp::cluster
  cluster
- dpp::cluster
  cluster_id
- dpp::cluster
  co_application_emoji_create
- dpp::cluster
  co_application_emoji_create
- dpp::cluster
  co_application_emoji_delete
- dpp::cluster
  co_application_emoji_delete
- dpp::cluster
  co_application_emoji_edit
- dpp::cluster
  co_application_emoji_edit
- dpp::cluster
  co_application_emoji_get
- dpp::cluster
  co_application_emoji_get
- dpp::cluster
  co_application_emojis_get
- dpp::cluster
  co_application_emojis_get
- dpp::cluster
  co_application_role_connection_get
- dpp::cluster
  co_application_role_connection_get
- dpp::cluster
  co_application_role_connection_update
- dpp::cluster
  co_application_role_connection_update
- dpp::cluster
  co_automod_rule_create
- dpp::cluster
  co_automod_rule_create
- dpp::cluster
  co_automod_rule_delete
- dpp::cluster
  co_automod_rule_delete
- dpp::cluster
  co_automod_rule_edit
- dpp::cluster
  co_automod_rule_edit
- dpp::cluster
  co_automod_rule_get
- dpp::cluster
  co_automod_rule_get
- dpp::cluster
  co_automod_rules_get
- dpp::cluster
  co_automod_rules_get
- dpp::cluster
  co_channel_create
- dpp::cluster
  co_channel_create
- dpp::cluster
  co_channel_delete
- dpp::cluster
  co_channel_delete
- dpp::cluster
  co_channel_delete_permission
- dpp::cluster
  co_channel_delete_permission
- dpp::cluster
  co_channel_edit
- dpp::cluster
  co_channel_edit
- dpp::cluster
  co_channel_edit_permissions
- dpp::cluster
  co_channel_edit_permissions
- dpp::cluster
  co_channel_edit_permissions
- dpp::cluster
  co_channel_edit_permissions
- dpp::cluster
  co_channel_edit_positions
- dpp::cluster
  co_channel_edit_positions
- dpp::cluster
  co_channel_follow_news
- dpp::cluster
  co_channel_follow_news
- dpp::cluster
  co_channel_get
- dpp::cluster
  co_channel_get
- dpp::cluster
  co_channel_invite_create
- dpp::cluster
  co_channel_invite_create
- dpp::cluster
  co_channel_invites_get
- dpp::cluster
  co_channel_invites_get
- dpp::cluster
  co_channel_pins_get
- dpp::cluster
  co_channel_pins_get
- dpp::cluster
  co_channel_pins_get
- dpp::cluster
  co_channel_pins_get
- dpp::cluster
  co_channel_set_voice_status
- dpp::cluster
  co_channel_set_voice_status
- dpp::cluster
  co_channel_typing
- dpp::cluster
  co_channel_typing
- dpp::cluster
  co_channel_typing
- dpp::cluster
  co_channel_typing
- dpp::cluster
  co_channels_get
- dpp::cluster
  co_channels_get
- dpp::cluster
  co_create_dm_channel
- dpp::cluster
  co_create_dm_channel
- dpp::cluster
  co_create_webhook
- dpp::cluster
  co_current_application_get
- dpp::cluster
  co_current_application_get
- dpp::cluster
  co_current_user_connections_get
- dpp::cluster
  co_current_user_connections_get
- dpp::cluster
  co_current_user_edit
- dpp::cluster
  co_current_user_edit
- dpp::cluster
  co_current_user_get
- dpp::cluster
  co_current_user_get
- dpp::cluster
  co_current_user_get_dms
- dpp::cluster
  co_current_user_get_dms
- dpp::cluster
  co_current_user_get_guilds
- dpp::cluster
  co_current_user_get_guilds
- dpp::cluster
  co_current_user_get_voice_state
- dpp::cluster
  co_current_user_get_voice_state
- dpp::cluster
  co_current_user_join_thread
- dpp::cluster
  co_current_user_join_thread
- dpp::cluster
  co_current_user_leave_guild
- dpp::cluster
  co_current_user_leave_guild
- dpp::cluster
  co_current_user_leave_thread
- dpp::cluster
  co_current_user_leave_thread
- dpp::cluster
  co_current_user_set_voice_state
- dpp::cluster
  co_current_user_set_voice_state
- dpp::cluster
  co_delete_webhook
- dpp::cluster
  co_delete_webhook
- dpp::cluster
  co_delete_webhook_message
- dpp::cluster
  co_delete_webhook_message
- dpp::cluster
  co_delete_webhook_with_token
- dpp::cluster
  co_delete_webhook_with_token
- dpp::cluster
  co_direct_message_create
- dpp::cluster
  co_direct_message_create
- dpp::cluster
  co_edit_webhook
- dpp::cluster
  co_edit_webhook
- dpp::cluster
  co_edit_webhook_message
- dpp::cluster
  co_edit_webhook_message
- dpp::cluster
  co_edit_webhook_with_token
- dpp::cluster
  co_edit_webhook_with_token
- dpp::cluster
  co_entitlement_consume
- dpp::cluster
  co_entitlement_consume
- dpp::cluster
  co_entitlement_test_create
- dpp::cluster
  co_entitlement_test_create
- dpp::cluster
  co_entitlement_test_delete
- dpp::cluster
  co_entitlement_test_delete
- dpp::cluster
  co_entitlements_get
- dpp::cluster
  co_entitlements_get
- dpp::cluster
  co_execute_webhook
- dpp::cluster
  co_execute_webhook
- dpp::cluster
  co_gdm_add
- dpp::cluster
  co_gdm_add
- dpp::cluster
  co_gdm_remove
- dpp::cluster
  co_gdm_remove
- dpp::cluster
  co_get_channel_webhooks
- dpp::cluster
  co_get_channel_webhooks
- dpp::cluster
  co_get_gateway_bot
- dpp::cluster
  co_get_gateway_bot
- dpp::cluster
  co_get_guild_webhooks
- dpp::cluster
  co_get_guild_webhooks
- dpp::cluster
  co_get_voice_regions
- dpp::cluster
  co_get_voice_regions
- dpp::cluster
  co_get_webhook
- dpp::cluster
  co_get_webhook
- dpp::cluster
  co_get_webhook_message
- dpp::cluster
  co_get_webhook_message
- dpp::cluster
  co_get_webhook_with_token
- dpp::cluster
  co_get_webhook_with_token
- dpp::cluster
  co_global_bulk_command_create
- dpp::cluster
  co_global_bulk_command_create
- dpp::cluster
  co_global_bulk_command_delete
- dpp::cluster
  co_global_bulk_command_delete
- dpp::cluster
  co_global_command_create
- dpp::cluster
  co_global_command_create
- dpp::cluster
  co_global_command_delete
- dpp::cluster
  co_global_command_delete
- dpp::cluster
  co_global_command_edit
- dpp::cluster
  co_global_command_edit
- dpp::cluster
  co_global_command_get
- dpp::cluster
  co_global_command_get
- dpp::cluster
  co_global_commands_get
- dpp::cluster
  co_global_commands_get
- dpp::cluster
  co_guild_add_member
- dpp::cluster
  co_guild_add_member
- dpp::cluster
  co_guild_auditlog_get
- dpp::cluster
  co_guild_auditlog_get
- dpp::cluster
  co_guild_ban_add
- dpp::cluster
  co_guild_ban_add
- dpp::cluster
  co_guild_ban_delete
- dpp::cluster
  co_guild_ban_delete
- dpp::cluster
  co_guild_begin_prune
- dpp::cluster
  co_guild_begin_prune
- dpp::cluster
  co_guild_bulk_command_create
- dpp::cluster
  co_guild_bulk_command_create
- dpp::cluster
  co_guild_bulk_command_delete
- dpp::cluster
  co_guild_bulk_command_delete
- dpp::cluster
  co_guild_bulk_command_edit_permissions
- dpp::cluster
  co_guild_bulk_command_edit_permissions
- dpp::cluster
  co_guild_command_create
- dpp::cluster
  co_guild_command_create
- dpp::cluster
  co_guild_command_delete
- dpp::cluster
  co_guild_command_delete
- dpp::cluster
  co_guild_command_edit
- dpp::cluster
  co_guild_command_edit
- dpp::cluster
  co_guild_command_edit_permissions
- dpp::cluster
  co_guild_command_edit_permissions
- dpp::cluster
  co_guild_command_get
- dpp::cluster
  co_guild_command_get
- dpp::cluster
  co_guild_command_get_permissions
- dpp::cluster
  co_guild_command_get_permissions
- dpp::cluster
  co_guild_commands_get
- dpp::cluster
  co_guild_commands_get
- dpp::cluster
  co_guild_commands_get_permissions
- dpp::cluster
  co_guild_commands_get_permissions
- dpp::cluster
  co_guild_create
- dpp::cluster
  co_guild_create
- dpp::cluster
  co_guild_create_from_template
- dpp::cluster
  co_guild_create_from_template
- dpp::cluster
  co_guild_current_member_edit
- dpp::cluster
  co_guild_current_member_edit
- dpp::cluster
  co_guild_delete
- dpp::cluster
  co_guild_delete
- dpp::cluster
  co_guild_delete_integration
- dpp::cluster
  co_guild_delete_integration
- dpp::cluster
  co_guild_edit
- dpp::cluster
  co_guild_edit
- dpp::cluster
  co_guild_edit_member
- dpp::cluster
  co_guild_edit_member
- dpp::cluster
  co_guild_edit_onboarding
- dpp::cluster
  co_guild_edit_onboarding
- dpp::cluster
  co_guild_edit_welcome_screen
- dpp::cluster
  co_guild_edit_welcome_screen
- dpp::cluster
  co_guild_edit_widget
- dpp::cluster
  co_guild_edit_widget
- dpp::cluster
  co_guild_emoji_create
- dpp::cluster
  co_guild_emoji_create
- dpp::cluster
  co_guild_emoji_delete
- dpp::cluster
  co_guild_emoji_delete
- dpp::cluster
  co_guild_emoji_edit
- dpp::cluster
  co_guild_emoji_edit
- dpp::cluster
  co_guild_emoji_get
- dpp::cluster
  co_guild_emoji_get
- dpp::cluster
  co_guild_emojis_get
- dpp::cluster
  co_guild_emojis_get
- dpp::cluster
  co_guild_event_create
- dpp::cluster
  co_guild_event_create
- dpp::cluster
  co_guild_event_delete
- dpp::cluster
  co_guild_event_delete
- dpp::cluster
  co_guild_event_edit
- dpp::cluster
  co_guild_event_edit
- dpp::cluster
  co_guild_event_get
- dpp::cluster
  co_guild_event_get
- dpp::cluster
  co_guild_events_get
- dpp::cluster
  co_guild_events_get
- dpp::cluster
  co_guild_get
- dpp::cluster
  co_guild_get_ban
- dpp::cluster
  co_guild_get_ban
- dpp::cluster
  co_guild_get_bans
- dpp::cluster
  co_guild_get_bans
- dpp::cluster
  co_guild_get_integrations
- dpp::cluster
  co_guild_get_integrations
- dpp::cluster
  co_guild_get_invites
- dpp::cluster
  co_guild_get_invites
- dpp::cluster
  co_guild_get_member
- dpp::cluster
  co_guild_get_member
- dpp::cluster
  co_guild_get_members
- dpp::cluster
  co_guild_get_members
- dpp::cluster
  co_guild_get_onboarding
- dpp::cluster
  co_guild_get_onboarding
- dpp::cluster
  co_guild_get_preview
- dpp::cluster
  co_guild_get_prune_counts
- dpp::cluster
  co_guild_get_prune_counts
- dpp::cluster
  co_guild_get_vanity
- dpp::cluster
  co_guild_get_vanity
- dpp::cluster
  co_guild_get_voice_regions
- dpp::cluster
  co_guild_get_voice_regions
- dpp::cluster
  co_guild_get_welcome_screen
- dpp::cluster
  co_guild_get_welcome_screen
- dpp::cluster
  co_guild_get_widget
- dpp::cluster
  co_guild_get_widget
- dpp::cluster
  co_guild_member_add_role
- dpp::cluster
  co_guild_member_add_role
- dpp::cluster
  co_guild_member_delete
- dpp::cluster
  co_guild_member_delete
- dpp::cluster
  co_guild_member_delete_role
- dpp::cluster
  co_guild_member_delete_role
- dpp::cluster
  co_guild_member_kick
- dpp::cluster
  co_guild_member_kick
- dpp::cluster
  co_guild_member_move
- dpp::cluster
  co_guild_member_move
- dpp::cluster
  co_guild_member_remove_role
- dpp::cluster
  co_guild_member_remove_role
- dpp::cluster
  co_guild_member_timeout
- dpp::cluster
  co_guild_member_timeout
- dpp::cluster
  co_guild_member_timeout_remove
- dpp::cluster
  co_guild_member_timeout_remove
- dpp::cluster
  co_guild_messages_search
- dpp::cluster
  co_guild_messages_search
- dpp::cluster
  co_guild_modify_integration
- dpp::cluster
  co_guild_modify_integration
- dpp::cluster
  co_guild_search_members
- dpp::cluster
  co_guild_search_members
- dpp::cluster
  co_guild_set_nickname
- dpp::cluster
  co_guild_set_nickname
- dpp::cluster
  co_guild_sticker_create
- dpp::cluster
  co_guild_sticker_create
- dpp::cluster
  co_guild_sticker_delete
- dpp::cluster
  co_guild_sticker_delete
- dpp::cluster
  co_guild_sticker_get
- dpp::cluster
  co_guild_sticker_get
- dpp::cluster
  co_guild_sticker_modify
- dpp::cluster
  co_guild_sticker_modify
- dpp::cluster
  co_guild_stickers_get
- dpp::cluster
  co_guild_stickers_get
- dpp::cluster
  co_guild_sync_integration
- dpp::cluster
  co_guild_sync_integration
- dpp::cluster
  co_guild_template_create
- dpp::cluster
  co_guild_template_create
- dpp::cluster
  co_guild_template_delete
- dpp::cluster
  co_guild_template_delete
- dpp::cluster
  co_guild_template_modify
- dpp::cluster
  co_guild_template_modify
- dpp::cluster
  co_guild_template_sync
- dpp::cluster
  co_guild_template_sync
- dpp::cluster
  co_guild_templates_get
- dpp::cluster
  co_guild_templates_get
- dpp::cluster
  co_interaction_followup_create
- dpp::cluster
  co_interaction_followup_create
- dpp::cluster
  co_interaction_followup_delete
- dpp::cluster
  co_interaction_followup_delete
- dpp::cluster
  co_interaction_followup_edit
- dpp::cluster
  co_interaction_followup_edit
- dpp::cluster
  co_interaction_followup_edit_original
- dpp::cluster
  co_interaction_followup_edit_original
- dpp::cluster
  co_interaction_followup_get
- dpp::cluster
  co_interaction_followup_get
- dpp::cluster
  co_interaction_followup_get_original
- dpp::cluster
  co_interaction_followup_get_original
- dpp::cluster
  co_interaction_response_create
- dpp::cluster
  co_interaction_response_create
- dpp::cluster
  co_interaction_response_edit
- dpp::cluster
  co_interaction_response_edit
- dpp::cluster
  co_interaction_response_get_original
- dpp::cluster
  co_interaction_response_get_original
- dpp::cluster
  co_invite_delete
- dpp::cluster
  co_invite_get
- dpp::cluster
  co_invite_get
- dpp::cluster
  co_message_add_reaction
- dpp::cluster
  co_message_add_reaction
- dpp::cluster
  co_message_add_reaction
- dpp::cluster
  co_message_add_reaction
- dpp::cluster
  co_message_create
- dpp::cluster
  co_message_create
- dpp::cluster
  co_message_crosspost
- dpp::cluster
  co_message_crosspost
- dpp::cluster
  co_message_delete
- dpp::cluster
  co_message_delete
- dpp::cluster
  co_message_delete_all_reactions
- dpp::cluster
  co_message_delete_all_reactions
- dpp::cluster
  co_message_delete_all_reactions
- dpp::cluster
  co_message_delete_all_reactions
- dpp::cluster
  co_message_delete_bulk
- dpp::cluster
  co_message_delete_bulk
- dpp::cluster
  co_message_delete_own_reaction
- dpp::cluster
  co_message_delete_own_reaction
- dpp::cluster
  co_message_delete_own_reaction
- dpp::cluster
  co_message_delete_own_reaction
- dpp::cluster
  co_message_delete_reaction
- dpp::cluster
  co_message_delete_reaction
- dpp::cluster
  co_message_delete_reaction
- dpp::cluster
  co_message_delete_reaction
- dpp::cluster
  co_message_delete_reaction_emoji
- dpp::cluster
  co_message_delete_reaction_emoji
- dpp::cluster
  co_message_delete_reaction_emoji
- dpp::cluster
  co_message_delete_reaction_emoji
- dpp::cluster
  co_message_edit
- dpp::cluster
  co_message_edit
- dpp::cluster
  co_message_edit_flags
- dpp::cluster
  co_message_edit_flags
- dpp::cluster
  co_message_get
- dpp::cluster
  co_message_get
- dpp::cluster
  co_message_get_reactions
- dpp::cluster
  co_message_get_reactions
- dpp::cluster
  co_message_get_reactions
- dpp::cluster
  co_message_get_reactions
- dpp::cluster
  co_message_pin
- dpp::cluster
  co_message_pin
- dpp::cluster
  co_message_unpin
- dpp::cluster
  co_message_unpin
- dpp::cluster
  co_messages_get
- dpp::cluster
  co_messages_get
- dpp::cluster
  co_nitro_sticker_get
- dpp::cluster
  co_nitro_sticker_get
- dpp::cluster
  co_poll_end
- dpp::cluster
  co_poll_end
- dpp::cluster
  co_poll_end
- dpp::cluster
  co_poll_end
- dpp::cluster
  co_poll_get_answer_voters
- dpp::cluster
  co_poll_get_answer_voters
- dpp::cluster
  co_poll_get_answer_voters
- dpp::cluster
  co_poll_get_answer_voters
- dpp::cluster
  co_request
- dpp::cluster
  co_role_create
- dpp::cluster
  co_role_create
- dpp::cluster
  co_role_delete
- dpp::cluster
  co_role_delete
- dpp::cluster
  co_role_edit
- dpp::cluster
  co_role_edit
- dpp::cluster
  co_roles_edit_position
- dpp::cluster
  co_roles_edit_position
- dpp::cluster
  co_roles_get
- dpp::cluster
  co_roles_get
- dpp::cluster
  co_skus_get
- dpp::cluster
  co_skus_get
- dpp::cluster
  co_slashcommand_handler_t
- dpp::cluster
  co_sleep
- dpp::cluster
  co_stage_instance_create
- dpp::cluster
  co_stage_instance_delete
- dpp::cluster
  co_stage_instance_delete
- dpp::cluster
  co_stage_instance_edit
- dpp::cluster
  co_stage_instance_get
- dpp::cluster
  co_stage_instance_get
- dpp::cluster
  co_sticker_packs_get
- dpp::cluster
  co_sticker_packs_get
- dpp::cluster
  co_template_get
- dpp::cluster
  co_template_get
- dpp::cluster
  co_thread_create
- dpp::cluster
  co_thread_create
- dpp::cluster
  co_thread_create_in_forum
- dpp::cluster
  co_thread_create_in_forum
- dpp::cluster
  co_thread_create_with_message
- dpp::cluster
  co_thread_create_with_message
- dpp::cluster
  co_thread_edit
- dpp::cluster
  co_thread_edit
- dpp::cluster
  co_thread_get
- dpp::cluster
  co_thread_get
- dpp::cluster
  co_thread_member_add
- dpp::cluster
  co_thread_member_add
- dpp::cluster
  co_thread_member_get
- dpp::cluster
  co_thread_member_get
- dpp::cluster
  co_thread_member_remove
- dpp::cluster
  co_thread_member_remove
- dpp::cluster
  co_thread_members_get
- dpp::cluster
  co_thread_members_get
- dpp::cluster
  co_threads_get_active
- dpp::cluster
  co_threads_get_active
- dpp::cluster
  co_threads_get_joined_private_archived
- dpp::cluster
  co_threads_get_joined_private_archived
- dpp::cluster
  co_threads_get_private_archived
- dpp::cluster
  co_threads_get_private_archived
- dpp::cluster
  co_threads_get_public_archived
- dpp::cluster
  co_threads_get_public_archived
- dpp::cluster
  co_user_application_role_connection_get
- dpp::cluster
  co_user_application_role_connection_get
- dpp::cluster
  co_user_application_role_connection_update
- dpp::cluster
  co_user_application_role_connection_update
- dpp::cluster
  co_user_get
- dpp::cluster
  co_user_get
- dpp::cluster
  co_user_get_cached
- dpp::cluster
  co_user_get_cached
- dpp::cluster
  co_user_get_voice_state
- dpp::cluster
  co_user_get_voice_state
- dpp::cluster
  co_user_set_voice_state
- dpp::cluster
  co_user_set_voice_state
- dpp::cluster
  compressed
- dpp::cluster
  create_dm_channel
- dpp::cluster
  create_webhook
- dpp::cluster
  current_application_get
- dpp::cluster
  current_user_connections_get
- dpp::cluster
  current_user_edit
- dpp::cluster
  current_user_get
- dpp::cluster
  current_user_get_dms
- dpp::cluster
  current_user_get_guilds
- dpp::cluster
  current_user_get_voice_state
- dpp::cluster
  current_user_join_thread
- dpp::cluster
  current_user_leave_guild
- dpp::cluster
  current_user_leave_thread
- dpp::cluster
  current_user_set_voice_state
- dpp::cluster
  default_gateway
- dpp::cluster
  delete_webhook
- dpp::cluster
  delete_webhook_message
- dpp::cluster
  delete_webhook_with_token
- dpp::cluster
  deleted_timers
- dpp::cluster
  direct_message_create
- dpp::cluster
  discord_client
- dpp::cluster
  discord_voice_client
- dpp::cluster
  dm_channels
- dpp::cluster
  dm_list_lock
- dpp::cluster
  edit_webhook
- dpp::cluster
  edit_webhook_message
- dpp::cluster
  edit_webhook_with_token
- dpp::cluster
  enable_webhook_server
- dpp::cluster
  engine_thread
- dpp::cluster
  entitlement_consume
- dpp::cluster
  entitlement_test_create
- dpp::cluster
  entitlement_test_delete
- dpp::cluster
  entitlements_get
- dpp::cluster
  execute_webhook
- dpp::cluster
  gdm_add
- dpp::cluster
  gdm_remove
- dpp::cluster
  get_audit_reason
- dpp::cluster
  get_channel_webhooks
- dpp::cluster
  get_dm_channel
- dpp::cluster
  get_gateway_bot
- dpp::cluster
  get_guild_webhooks
- dpp::cluster
  get_raw_rest
- dpp::cluster
  get_rest
- dpp::cluster
  get_shard
- dpp::cluster
  get_shards
- dpp::cluster
  get_voice_regions
- dpp::cluster
  get_webhook
- dpp::cluster
  get_webhook_message
- dpp::cluster
  get_webhook_with_token
- dpp::cluster
  global_bulk_command_create
- dpp::cluster
  global_bulk_command_delete
- dpp::cluster
  global_command_create
- dpp::cluster
  global_command_delete
- dpp::cluster
  global_command_edit
- dpp::cluster
  global_command_get
- dpp::cluster
  global_commands_get
- dpp::cluster
  guild_add_member
- dpp::cluster
  guild_auditlog_get
- dpp::cluster
  guild_ban_add
- dpp::cluster
  guild_ban_delete
- dpp::cluster
  guild_begin_prune
- dpp::cluster
  guild_bulk_command_create
- dpp::cluster
  guild_bulk_command_delete
- dpp::cluster
  guild_bulk_command_edit_permissions
- dpp::cluster
  guild_command_create
- dpp::cluster
  guild_command_delete
- dpp::cluster
  guild_command_edit
- dpp::cluster
  guild_command_edit_permissions
- dpp::cluster
  guild_command_get
- dpp::cluster
  guild_command_get_permissions
- dpp::cluster
  guild_commands_get
- dpp::cluster
  guild_commands_get_permissions
- dpp::cluster
  guild_create
- dpp::cluster
  guild_create_from_template
- dpp::cluster
  guild_current_member_edit
- dpp::cluster
  guild_delete
- dpp::cluster
  guild_delete_integration
- dpp::cluster
  guild_edit
- dpp::cluster
  guild_edit_member
- dpp::cluster
  guild_edit_onboarding
- dpp::cluster
  guild_edit_welcome_screen
- dpp::cluster
  guild_edit_widget
- dpp::cluster
  guild_emoji_create
- dpp::cluster
  guild_emoji_delete
- dpp::cluster
  guild_emoji_edit
- dpp::cluster
  guild_emoji_get
- dpp::cluster
  guild_emojis_get
- dpp::cluster
  guild_event_create
- dpp::cluster
  guild_event_delete
- dpp::cluster
  guild_event_edit
- dpp::cluster
  guild_event_get
- dpp::cluster
  guild_event_users_get
- dpp::cluster
  guild_events_get
- dpp::cluster
  guild_get
- dpp::cluster
  guild_get_ban
- dpp::cluster
  guild_get_bans
- dpp::cluster
  guild_get_integrations
- dpp::cluster
  guild_get_invites
- dpp::cluster
  guild_get_member
- dpp::cluster
  guild_get_members
- dpp::cluster
  guild_get_onboarding
- dpp::cluster
  guild_get_preview
- dpp::cluster
  guild_get_prune_counts
- dpp::cluster
  guild_get_vanity
- dpp::cluster
  guild_get_voice_regions
- dpp::cluster
  guild_get_welcome_screen
- dpp::cluster
  guild_get_widget
- dpp::cluster
  guild_member_add_role
- dpp::cluster
  guild_member_delete
- dpp::cluster
  guild_member_delete_role
- dpp::cluster
  guild_member_kick
- dpp::cluster
  guild_member_move
- dpp::cluster
  guild_member_remove_role
- dpp::cluster
  guild_member_timeout
- dpp::cluster
  guild_member_timeout_remove
- dpp::cluster
  guild_messages_search
- dpp::cluster
  guild_modify_integration
- dpp::cluster
  guild_search_members
- dpp::cluster
  guild_set_nickname
- dpp::cluster
  guild_sticker_create
- dpp::cluster
  guild_sticker_delete
- dpp::cluster
  guild_sticker_get
- dpp::cluster
  guild_sticker_modify
- dpp::cluster
  guild_stickers_get
- dpp::cluster
  guild_sync_integration
- dpp::cluster
  guild_template_create
- dpp::cluster
  guild_template_delete
- dpp::cluster
  guild_template_modify
- dpp::cluster
  guild_template_sync
- dpp::cluster
  guild_templates_get
- dpp::cluster
  intents
- dpp::cluster
  interaction_followup_create
- dpp::cluster
  interaction_followup_delete
- dpp::cluster
  interaction_followup_edit
- dpp::cluster
  interaction_followup_edit_original
- dpp::cluster
  interaction_followup_get
- dpp::cluster
  interaction_followup_get_original
- dpp::cluster
  interaction_response_create
- dpp::cluster
  interaction_response_edit
- dpp::cluster
  interaction_response_get_original
- dpp::cluster
  invite_delete
- dpp::cluster
  invite_get
- dpp::cluster
  last_identify
- dpp::cluster
  log
- dpp::cluster
  maxclusters
- dpp::cluster
  me
- dpp::cluster
  message_add_reaction
- dpp::cluster
  message_add_reaction
- dpp::cluster
  message_create
- dpp::cluster
  message_crosspost
- dpp::cluster
  message_delete
- dpp::cluster
  message_delete_all_reactions
- dpp::cluster
  message_delete_all_reactions
- dpp::cluster
  message_delete_bulk
- dpp::cluster
  message_delete_own_reaction
- dpp::cluster
  message_delete_own_reaction
- dpp::cluster
  message_delete_reaction
- dpp::cluster
  message_delete_reaction
- dpp::cluster
  message_delete_reaction_emoji
- dpp::cluster
  message_delete_reaction_emoji
- dpp::cluster
  message_edit
- dpp::cluster
  message_edit_flags
- dpp::cluster
  message_get
- dpp::cluster
  message_get_reactions
- dpp::cluster
  message_get_reactions
- dpp::cluster
  message_pin
- dpp::cluster
  message_unpin
- dpp::cluster
  messages_get
- dpp::cluster
  named_commands
- dpp::cluster
  named_commands_mutex
- dpp::cluster
  next_timer
- dpp::cluster
  nitro_sticker_get
- dpp::cluster
  numshards
- dpp::cluster
  on_autocomplete
- dpp::cluster
  on_automod_rule_create
- dpp::cluster
  on_automod_rule_delete
- dpp::cluster
  on_automod_rule_execute
- dpp::cluster
  on_automod_rule_update
- dpp::cluster
  on_button_click
- dpp::cluster
  on_channel_create
- dpp::cluster
  on_channel_delete
- dpp::cluster
  on_channel_pins_update
- dpp::cluster
  on_channel_update
- dpp::cluster
  on_entitlement_create
- dpp::cluster
  on_entitlement_delete
- dpp::cluster
  on_entitlement_update
- dpp::cluster
  on_form_submit
- dpp::cluster
  on_guild_audit_log_entry_create
- dpp::cluster
  on_guild_ban_add
- dpp::cluster
  on_guild_ban_remove
- dpp::cluster
  on_guild_create
- dpp::cluster
  on_guild_delete
- dpp::cluster
  on_guild_emojis_update
- dpp::cluster
  on_guild_integrations_update
- dpp::cluster
  on_guild_join_request_delete
- dpp::cluster
  on_guild_member_add
- dpp::cluster
  on_guild_member_remove
- dpp::cluster
  on_guild_member_update
- dpp::cluster
  on_guild_members_chunk
- dpp::cluster
  on_guild_role_create
- dpp::cluster
  on_guild_role_delete
- dpp::cluster
  on_guild_role_update
- dpp::cluster
  on_guild_scheduled_event_create
- dpp::cluster
  on_guild_scheduled_event_delete
- dpp::cluster
  on_guild_scheduled_event_update
- dpp::cluster
  on_guild_scheduled_event_user_add
- dpp::cluster
  on_guild_scheduled_event_user_remove
- dpp::cluster
  on_guild_stickers_update
- dpp::cluster
  on_guild_update
- dpp::cluster
  on_integration_create
- dpp::cluster
  on_integration_delete
- dpp::cluster
  on_integration_update
- dpp::cluster
  on_interaction_create
- dpp::cluster
  on_invite_create
- dpp::cluster
  on_invite_delete
- dpp::cluster
  on_log
- dpp::cluster
  on_message_context_menu
- dpp::cluster
  on_message_create
- dpp::cluster
  on_message_delete
- dpp::cluster
  on_message_delete_bulk
- dpp::cluster
  on_message_poll_vote_add
- dpp::cluster
  on_message_poll_vote_remove
- dpp::cluster
  on_message_reaction_add
- dpp::cluster
  on_message_reaction_remove
- dpp::cluster
  on_message_reaction_remove_all
- dpp::cluster
  on_message_reaction_remove_emoji
- dpp::cluster
  on_message_update
- dpp::cluster
  on_presence_update
- dpp::cluster
  on_ready
- dpp::cluster
  on_resumed
- dpp::cluster
  on_select_click
- dpp::cluster
  on_slashcommand
- dpp::cluster
  on_socket_close
- dpp::cluster
  on_stage_instance_create
- dpp::cluster
  on_stage_instance_delete
- dpp::cluster
  on_stage_instance_update
- dpp::cluster
  on_thread_create
- dpp::cluster
  on_thread_delete
- dpp::cluster
  on_thread_list_sync
- dpp::cluster
  on_thread_member_update
- dpp::cluster
  on_thread_members_update
- dpp::cluster
  on_thread_update
- dpp::cluster
  on_typing_start
- dpp::cluster
  on_user_context_menu
- dpp::cluster
  on_user_update
- dpp::cluster
  on_voice_buffer_send
- dpp::cluster
  on_voice_channel_effect_send
- dpp::cluster
  on_voice_client_disconnect
- dpp::cluster
  on_voice_client_platform
- dpp::cluster
  on_voice_client_speaking
- dpp::cluster
  on_voice_ready
- dpp::cluster
  on_voice_receive
- dpp::cluster
  on_voice_receive_combined
- dpp::cluster
  on_voice_server_update
- dpp::cluster
  on_voice_state_update
- dpp::cluster
  on_voice_track_marker
- dpp::cluster
  on_webhooks_update
- dpp::cluster
  operator=
- dpp::cluster
  operator=
- dpp::cluster
  poll_end
- dpp::cluster
  poll_end
- dpp::cluster
  poll_get_answer_voters
- dpp::cluster
  poll_get_answer_voters
- dpp::cluster
  pool
- dpp::cluster
  post_rest
- dpp::cluster
  post_rest_multipart
- dpp::cluster
  queue_work
- dpp::cluster
  raw_rest
- dpp::cluster
  reconnections
- dpp::cluster
  register_command
- dpp::cluster
  register_command
- dpp::cluster
  request
- dpp::cluster
  request_timeout
- dpp::cluster
  rest
- dpp::cluster
  rest_ping
- dpp::cluster
  role_create
- dpp::cluster
  role_delete
- dpp::cluster
  role_edit
- dpp::cluster
  roles_edit_position
- dpp::cluster
  roles_get
- dpp::cluster
  set_audit_reason
- dpp::cluster
  set_default_gateway
- dpp::cluster
  set_dm_channel
- dpp::cluster
  set_presence
- dpp::cluster
  set_request_timeout
- dpp::cluster
  set_websocket_protocol
- dpp::cluster
  shards
- dpp::cluster
  shards_mutex
- dpp::cluster
  shutdown
- dpp::cluster
  skus_get
- dpp::cluster
  slashcommand_handler_t
- dpp::cluster
  slashcommand_handler_variant
- dpp::cluster
  socketengine
- dpp::cluster
  stage_instance_create
- dpp::cluster
  stage_instance_delete
- dpp::cluster
  stage_instance_edit
- dpp::cluster
  stage_instance_get
- dpp::cluster
  start
- dpp::cluster
  start_time
- dpp::cluster
  start_timer
- dpp::cluster
  start_timer
- dpp::cluster
  sticker_packs_get
- dpp::cluster
  stop_timer
- dpp::cluster
  template_get
- dpp::cluster
  terminating
- dpp::cluster
  thread_create
- dpp::cluster
  thread_create_in_forum
- dpp::cluster
  thread_create_with_message
- dpp::cluster
  thread_edit
- dpp::cluster
  thread_get
- dpp::cluster
  thread_member_add
- dpp::cluster
  thread_member_get
- dpp::cluster
  thread_member_remove
- dpp::cluster
  thread_members_get
- dpp::cluster
  threads_get_active
- dpp::cluster
  threads_get_joined_private_archived
- dpp::cluster
  threads_get_private_archived
- dpp::cluster
  threads_get_public_archived
- dpp::cluster
  tick_timers
- dpp::cluster
  timer_guard
- dpp::cluster
  token
- dpp::cluster
  unregister_command
- dpp::cluster
  uptime
- dpp::cluster
  user_application_role_connection_get
- dpp::cluster
  user_application_role_connection_update
- dpp::cluster
  user_get
- dpp::cluster
  user_get_cached
- dpp::cluster
  user_get_voice_state
- dpp::cluster
  user_set_voice_state
- dpp::cluster
  webhook_server
- dpp::cluster
  ws_mode
- dpp::cluster
  ~cluster