Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12345]

►Nanonymous_namespace{coro.cpp}
Cjob_awaitable
Csimple_awaitable
Ctest_exception
►Ndpp	The main namespace for D++ functions
►Nanonymous_namespace{queues.cpp}
Ccompare_request	Comparator for sorting a request container
►Ndetail	Implementation details for internal use only
►Nasync
Casync_base	Base class of dpp::async
Casync_callback_data	State of the async and its callback
►Ncoroutine
Ccoroutine_base	Base class of dpp::coroutine<R>
Cfinal_awaiter	Struct returned by a coroutine's final_suspend, resumes the continuation
Cpromise_t	Promise type for coroutine
Cpromise_t< void >	Struct returned by a coroutine's final_suspend, resumes the continuation
►Nevent_router	Internal cogwheels for dpp::event_router_t
Cawaitable	Awaitable object representing an event
►Njob
Cpromise	Coroutine promise type for a job
►Nstd_coroutine	Alias for either std or std::experimental depending on compiler and library
Ccoroutine_traits< dpp::coroutine< R >, Args... >	Specialization of std::coroutine_traits, helps the standard library figure out a promise type from a coroutine function
Ccoroutine_traits< dpp::job, Args... >	Specialization of std::coroutine_traits, helps the standard library figure out a promise type from a coroutine function
Ccoroutine_traits< dpp::task< T >, Args... >	Specialization of std::coroutine_traits, helps the standard library figure out a promise_t type from a coroutine function
►Ntask
Cfinal_awaiter	The object automatically co_await-ed at the end of a task
►Cpromise_base	Base implementation of task::promise_t, without the logic that would depend on the return type
Cproxy_awaiter	Proxy awaitable that wraps any co_await inside the task and checks for cancellation on resumption
Cpromise_t	A task's promise_t type, with special logic for handling nested tasks
Cpromise_t< void >	Implementation of task::promise_t for void return type
Ctask_base	Base class of dpp::task
►Nwhen_any	Internal cogwheels for dpp::when_any
Carg_helper_s	Type trait helper to obtain the actual type that will be used by a when_any when a type is passed as a parameter
Carg_helper_s< dpp::event_router_t< T > >
Cempty	Empty result from void-returning awaitable
Cempty_tag_t	Empty struct used for overload resolution
►Nevents	The events namespace holds the internal event handlers for each websocket event
Cautomod_rule_create	Internal event handler for AUTO_MODERATION_RULE_CREATE websocket events
Cautomod_rule_delete	Internal event handler for AUTO_MODERATION_RULE_DELETE websocket events
Cautomod_rule_execute	Internal event handler for AUTO_MODERATION_ACTION_EXECUTION websocket events
Cautomod_rule_update	Internal event handler for AUTO_MODERATION_RULE_UPDATE websocket events
Cchannel_create	Internal event handler for CHANNEL_CREATE websocket events
Cchannel_delete	Internal event handler for CHANNEL_DELETE websocket events
Cchannel_pins_update	Internal event handler for CHANNEL_PINS_UPDATE websocket events
Cchannel_update	Internal event handler for CHANNEL_UPDATE websocket events
Centitlement_create	Internal event handler for ENTITLEMENT_CREATE websocket events
Centitlement_delete	Internal event handler for ENTITLEMENT_DELETE websocket events
Centitlement_update	Internal event handler for ENTITLEMENT_UPDATE websocket events
Cevent	An event object represents an event handled internally, passed from the websocket e.g
Cguild_audit_log_entry_create	Internal event handler for GUILD_AUDIT_LOG_ENTRY_CREATE websocket events
Cguild_ban_add	Internal event handler for GUILD_BAN_ADD websocket events
Cguild_ban_remove	Internal event handler for GUILD_BAN_REMOVE websocket events
Cguild_create	Internal event handler for GUILD_CREATE websocket events
Cguild_delete	Internal event handler for GUILD_DELETE websocket events
Cguild_emojis_update	Internal event handler for GUILD_EMOJIS_UPDATE websocket events
Cguild_integrations_update	Internal event handler for GUILD_INTEGRATIONS_UPDATE websocket events
Cguild_join_request_delete	Internal event handler for GUILD_JOIN_REQUEST_DELETE websocket events
Cguild_member_add	Internal event handler for GUILD_MEMBER_ADD websocket events
Cguild_member_remove	Internal event handler for GUILD_MEMBER_REMOVE websocket events
Cguild_member_update	Internal event handler for GUILD_MEMBERS_UPDATE websocket events
Cguild_members_chunk	Internal event handler for GUILD_MEMBERS_CHUNK websocket events
Cguild_role_create	Internal event handler for GUILD_ROLE_CREATE websocket events
Cguild_role_delete	Internal event handler for GUILD_ROLE_DELETE websocket events
Cguild_role_update	Internal event handler for GUILD_ROLE_UPDATE websocket events
Cguild_scheduled_event_create	Internal event handler for GUILD_SCHEDULED_EVENT_CREATE websocket events
Cguild_scheduled_event_delete	Internal event handler for GUILD_SCHEDULED_EVENT_DELETE websocket events
Cguild_scheduled_event_update	Internal event handler for GUILD_SCHEDULED_EVENT_UPDATE websocket events
Cguild_scheduled_event_user_add	Internal event handler for GUILD_SCHEDULED_EVENT_USER_ADD websocket events
Cguild_scheduled_event_user_remove	Internal event handler for GUILD_SCHEDULED_EVENT_USER_REMOVE websocket events
Cguild_stickers_update	Internal event handler for GUILD_STICKERS_UPDATE websocket events
Cguild_update	Internal event handler for GUILD_UPDATE websocket events
Cintegration_create	Internal event handler for INTEGRATION_CREATE websocket events
Cintegration_delete	Internal event handler for INTEGRATION_DELETE websocket events
Cintegration_update	Internal event handler for INTEGRATION_UPDATE websocket events
Cinteraction_create	Internal event handler for INTERACTION_CREATE websocket events
Cinvite_create	Internal event handler for INVITE_CREATE websocket events
Cinvite_delete	Internal event handler for INVITE_DELETE websocket events
Clogger	Internal event handler for LOG websocket events
Cmessage_create	Internal event handler for MESSAGE_CREATE websocket events
Cmessage_delete	Internal event handler for MESSAGE_DELETE websocket events
Cmessage_delete_bulk	Internal event handler for MESSAGE_DELETE_BULK websocket events
Cmessage_poll_vote_add	Internal event handler for MESSAGE_POLL_VOTE_ADD websocket events
Cmessage_poll_vote_remove	Internal event handler for MESSAGE_POLL_VOTE_REMOVE websocket events
Cmessage_reaction_add	Internal event handler for MESSAGE_REACTION_ADD websocket events
Cmessage_reaction_remove	Internal event handler for MESSAGE_REACTION_REMOVE websocket events
Cmessage_reaction_remove_all	Internal event handler for MESSAGE_REACTION_REMOVE_ALL websocket events
Cmessage_reaction_remove_emoji	Internal event handler for MESSAGE_REACTION_REMOVE_EMOJI websocket events
Cmessage_update	Internal event handler for MESSAGE_UPDATE websocket events
Cpresence_update	Internal event handler for PRESENCE_UPDATE websocket events
Cready	Internal event handler for READY websocket events
Cresumed	Internal event handler for RESUMED websocket events
Cstage_instance_create	Internal event handler for STAGE_INSTANCE_CREATE websocket events
Cstage_instance_delete	Internal event handler for STAGE_INSTANCE_DELETE websocket events
Cstage_instance_update	Internal event handler for STAGE_INSTANCE_UPDATE websocket events
Cthread_create	Internal event handler for THREAD_CREATE websocket events
Cthread_delete	Internal event handler for THREAD_DELETE websocket events
Cthread_list_sync	Internal event handler for THREAD_LIST_SYNC websocket events
Cthread_member_update	Internal event handler for THREAD_MEMBER_UPDATE websocket events
Cthread_members_update	Internal event handler for THREAD_MEMBERS_UPDATE websocket events
Cthread_update	Internal event handler for THREAD_UPDATE websocket events
Ctyping_start	Internal event handler for TYPING_START websocket events
Cuser_update	Internal event handler for USER_UPDATE websocket events
Cvoice_server_update	Internal event handler for VOICE_SERVER_UPDATE websocket events
Cvoice_state_update	Internal event handler for VOICE_STATE_UPDATE websocket events
Cwebhooks_update	Internal event handler for WEBHOOKS_UPDATE websocket events
►Nutility	Utility helper functions, generally for logging, running programs, time/date manipulation, etc
Cdummy	Utility struct that has the same size and alignment as another but does nothing
Cicon	Wrapper class around a variant for either iconhash or image, for API objects that have one or the other (generally iconhash when receiving, image when uploading an image)
Ciconhash	Store a 128 bit icon hash (profile picture, server icon etc) as a 128 bit binary value made of two uint64_t
Cimage_data	Image to be received or sent to API calls
Cuptime	A class used to represent an uptime in hours, minutes, seconds and days, with helper functions to convert from time_t and display as a string
Cactive_thread_info	A thread alongside the bot's optional thread_member object tied to it
Cactivity	An activity is a representation of what a user is doing
Cactivity_assets	An activity asset are the images and the hover text displayed in the rich presence
Cactivity_button	An activity button is a custom button shown in the rich presence
Cactivity_party	Information for the current party of the player
Cactivity_secrets	Secrets for Rich Presence joining and spectating
Capp_team	Represents a team of users who maintain a bot/application
Capplication	Details of a bot application
Capplication_install_params	Represents the settings for the bot/application's in-app authorization link
Capplication_role_connection	The application role connection that an application has attached to a user
Capplication_role_connection_metadata	Application Role Connection Metadata
Casync	A co_await-able object handling an API call in parallel with the caller
Casync_dummy
Cattachment	Represents an attachment in a dpp::message
Caudio_mixer	A class for audio mixing operations using x64 instructions
Caudit_change	Defines audit log changes
Caudit_entry	An individual audit log entry
Caudit_extra	Extra information for an audit log entry
Cauditlog	Audit log entries of a guild
Cautocomplete_interaction	An auto complete interaction
Cautocomplete_t	Discord requests that we fill a list of auto completion choices for a command option
Cautomod_action	Represents an automod action
Cautomod_metadata	Metadata associated with an automod action
Cautomod_rule	Represents an automod rule
Cautomod_rule_create_t	Create automod rule
Cautomod_rule_delete_t	Delete automod rule
Cautomod_rule_execute_t	Execute/trigger automod rule
Cautomod_rule_update_t	Update automod rule
Cban	Ban on a guild
Cbucket_t	A rate limit bucket
Cbutton_click_t	Click on button
Ccache	A cache object maintains a cache of dpp::managed objects
Ccache_exception	Represents invalid access to dpp's cache or its members, which may or may not exist
Ccache_policy_t	Represents the caching policy of the cluster
Cchannel	A definition of a discord channel
Cchannel_collector	Channel collector
Cchannel_create_t	Create channel
Cchannel_delete_t	Delete channel
Cchannel_pins_update_t	Channel pins update
Cchannel_update_t	Update channel
Ccluster	Group of shards and a command queue for sending and receiving commands from discord via HTTP
Ccollected_reaction	Represents a reaction
Ccollector	Collects objects from events during a specified time period
Ccommand_data_option	Values in the command interaction
Ccommand_info_t	Represents the details of a command added to the command handler class
Ccommand_interaction	Details of a command within an interaction
Ccommand_option	Each command option is a command line parameter
Ccommand_option_choice	This struct represents choices in a multiple choice option for a command parameter
Ccommand_permission	Application command permissions allow you to enable or disable commands for specific users or roles within a guild
Ccommand_resolved	Resolved snowflake ids to users, guild members, roles and channels
Ccommand_source	Represents the sending source of a command
Ccommandhandler	Group of commands, prefixed or slash commands with handling functions
Ccomponent	Represents the component object
Ccomponent_default_value	A Default value structure for components
Ccomponent_interaction	A button click for a button component
Cconfirmation	Confirmation object represents any true or false simple REST request
Cconfirmation_callback_t	The results of a REST call wrapped in a convenient struct
Cconnection	The connection object that the user has attached
Cconnection_exception	Represents an error establishing or maintaining a connection
Ccontext_menu_t	Base class for context menu interactions, e.g
Ccoroutine	Base type for a coroutine, starts on co_await
Ccoroutine_dummy
Cdiscord_client	Implements a discord client
Cdiscord_voice_client	Implements a discord voice connection
Cdns_cache_entry	Represents a cached DNS result
Cdtemplate	Represents a guild template
Cembed	A rich embed for display within a dpp::message
Cembed_author	Author within a dpp::embed object
Cembed_field	A dpp::embed may contain zero or more fields
Cembed_footer	A footer in a dpp::embed
Cembed_image	An video, image or thumbnail in a dpp::embed
Cembed_provider	Embed provider in a dpp::embed
Cemoji	Represents an emoji for a dpp::guild
Centitlement	A definition of a discord entitlement
Centitlement_create_t	Delete stage instance
Centitlement_delete_t	Delete stage instance
Centitlement_update_t	Delete stage instance
Cerror_detail	The details of a field in an error response
Cerror_info	The full details of an error from a REST response
Cetf_buffer	Represents a buffer of bytes being encoded into ETF
Cetf_parser	Can serialise and deserialise ETF (Erlang Term Format) into and out of an nlohmann::json object, so that layers above the websocket don't have to be any different for handling ETF
Cevent_dispatch_t	Base event parameter struct
Cevent_entities	Entities for the event
Cevent_member	Represents a guild member/user who has registered interest in an event
Cevent_router_t	Handles routing of an event to multiple listeners
Cexception	The dpp::exception class derives from std::exception and supports some other ways of passing in error details such as via std::string
Cfile_exception	Represents an error reading or writing to a file
Cform_submit_t	On form submitted
Cforum_tag	Represents a tag that is able to be applied to a thread in a forum or media channel
Cgateway	Represents the various information from the 'get gateway bot' api call
Cguild	Represents a guild on Discord (AKA a server)
Cguild_audit_log_entry_create_t	Guild audit log entry create
Cguild_ban_add_t	Guild ban add
Cguild_ban_remove_t	Guild ban remove
Cguild_command_permissions	Returned when fetching the permissions for a command in a guild
Cguild_create_t	Create guild
Cguild_delete_t	Delete guild
Cguild_emojis_update_t	Guild emojis update
Cguild_integrations_update_t	Guild integrations update
Cguild_join_request_delete_t	Guild join request delete (user declined membership screening)
Cguild_member	Represents dpp::user membership upon a dpp::guild
Cguild_member_add_t	Guild member add
Cguild_member_remove_t	Guild member remove
Cguild_member_update_t	Guild member update
Cguild_members_chunk_t	Guild members chunk
Cguild_role_create_t	Guild role create
Cguild_role_delete_t	Guild role delete
Cguild_role_update_t	Guild role update
Cguild_scheduled_event_create_t	Create scheduled event
Cguild_scheduled_event_delete_t	Delete scheduled event
Cguild_scheduled_event_update_t	Create scheduled event
Cguild_scheduled_event_user_add_t	Add user to scheduled event
Cguild_scheduled_event_user_remove_t	Delete user from scheduled event
Cguild_stickers_update_t	Update guild stickers
Cguild_update_t	Guild update
Cguild_widget	Represents a guild widget, simple web widget of member list
Chttp_connect_info	Represents a HTTP scheme, hostname and port split into parts for easy use in https_client
Chttp_request	A HTTP request
Chttp_request_completion_t	The result of any HTTP request
Chttps_client	Implements a HTTPS socket client based on the SSL client
Cin_thread	Represents a thread in the thread pool handling requests to HTTP(S) servers
Cintegration	Represents an integration on a guild, e.g
Cintegration_account	The account information for an integration
Cintegration_app	An application that has been integrated
Cintegration_create_t	Integration create
Cintegration_delete_t	Integration delete
Cintegration_update_t	Integration update
Cinteraction	An interaction represents a user running a command and arrives via the dpp::cluster::on_interaction_create event
Cinteraction_create_t	Create interaction
Cinteraction_modal_response	Represents a modal dialog box response to an interaction
Cinteraction_response	A response to an interaction, used to reply to a command and initiate a message, which can be hidden from others (ephemeral) or visible to all
Cinvalid_token_exception	Represents an attempt to construct a cluster with an invalid bot token
Cinvite	Represents an invite to a discord guild or channel
Cinvite_create_t	Invite create
Cinvite_delete_t	Invite delete
Cjob	Extremely light coroutine object designed to send off a coroutine to execute on its own. Can be used in conjunction with coroutine events via event routers, or on its own
Cjob_dummy
Cjson_interface	Represents an interface for an object that can optionally implement functions for converting to and from nlohmann::json
Ckeepalive_cache_t	Keepalive cache record
Clength_exception	Represents invalid length of argument being passed to a function
Clog_t	Log messages
Clogic_exception	Represents an error in logic, e.g
Cmanaged	Base class for various types that can be stored in a cache that are identified by a dpp::snowflake id
►Cmessage	Represents messages sent and received on Discord
Callowed_ref	Allowed mentions details
Cmessage_interaction_struct	Reference to an interaction
Cmessage_ref	Reference to another message, e.g
Cmessage_collector	Message collector
Cmessage_context_menu_t	Event parameter for context menu interactions for messages
Cmessage_create_t	Create message
Cmessage_delete_bulk_t	Message delete bulk
Cmessage_delete_t	Message Deleted
Cmessage_file_data	The data for a file attached to a message
Cmessage_poll_vote_add_t	Message poll vote add
Cmessage_poll_vote_remove_t	Message poll vote remove
Cmessage_reaction_add_t	Message reaction add
Cmessage_reaction_remove_all_t	Message remove all reactions
Cmessage_reaction_remove_emoji_t	Message remove emoji
Cmessage_reaction_remove_t	Message reaction remove
Cmessage_update_t	Message update
Cmoving_averager
Cmultipart_content	Represents a multipart mime body and the correct top-level mime type If a non-multipart request is passed in, this is represented as a plain body and the application/json mime type
Conboarding	Represents a guild's onboarding flow
Conboarding_prompt	Represents an onboarding prompt
Conboarding_prompt_option	Represents an onboarding prompt option
Coneshot_timer	Trigger a timed event once
Copenssl_connection	This is an opaque class containing openssl library specific structures
Copenssl_context_deleter	Custom deleter for SSL_CTX
Cparam_info	Details of a command parameter used in registration
Cparse_exception	Represents inability to parse data, usually caused by malformed JSON or ETF
Cpartial_emoji	An emoji reference for a component (select menus included) or a poll
Cpermission	Represents a permission bitmask (refer to enum dpp::permissions) which are held in an uint64_t
Cpermission_overwrite	Channel permission overwrites
Cpoll	Represents a poll
Cpoll_answer	Represents an answer in a poll
Cpoll_media	Structure representing a poll media, for example the poll question or a possible poll answer
►Cpoll_results	Represents the results of a poll
Canswer_count	Represents a reference to an answer and its count of votes
Cpresence	Represents user presence, e.g
Cpresence_update_t	Presence update
Cprune	Defines a request to count prunable users, or start a prune operation
Creaction	Represents a reaction to a dpp::message
Creaction_collector	Reaction collector
Cready_t	Session ready
►Crequest_queue	Manages rate limits and marshalls HTTP requests that have been built as http_request objects
Ccompleted_request	A completed request
Cqueued_deleting_request	A request queued for deletion in the queue
Cresolved_user	Dpp::resolved_user contains both a dpp::guild_member and a dpp::user
Crest_exception	Represents an error on a REST API call, e.g
Cresumed_t	Session resumed
Crole	Represents a role within a dpp::guild
Crole_collector	Role collector
Crtp_header	Represents an RTP packet
Cscheduled_event	A scheduled event
Cscheduled_event_collector	Scheduled event collector
Cselect_click_t	Click on select
Cselect_option	An option for a select component
Csku	A definition of a discord SKU
Cslashcommand	Represents an application command, created by your bot either globally, or on a guild
Cslashcommand_t	User has issued a slash command
Csnowflake	A container for a 64 bit unsigned value representing many things on discord
Cssl_client	Implements a simple non-blocking SSL stream client
Cstage_instance	A stage instance
Cstage_instance_create_t	Create stage instance
Cstage_instance_delete_t	Delete stage instance
Cstage_instance_update_t	Update stage instance
Csticker	Represents stickers received in messages
Csticker_pack	Represents a sticker pack (the built in groups of stickers that all nitro users get to use)
Ctask	A coroutine task. It starts immediately on construction and can be co_await-ed, making it perfect for parallel coroutines returning a value
Ctask_cancelled_exception	Represents the cancellation of a task
Ctask_dummy
Cteam_member	Represents a team member on a team who maintain a bot/application
Cthread	A definition of a discord thread
Cthread_collector	Thread collector
Cthread_create_t	Thread Create
Cthread_delete_t	Thread Delete
Cthread_list_sync_t	Thread List Sync
Cthread_member	Membership of a user with a thread
Cthread_member_update_t	Thread Member Update
Cthread_members_update_t	Thread Members Update
Cthread_metadata	Metadata for threads
Cthread_update_t	Thread Update
Ctimed_listener	A timed_listener is a way to temporarily attach to an event for a specific timeframe, then detach when complete
Ctimer_t	Used internally to store state of active timers
Ctyping_start_t	Typing start
Cuser	Represents a user on discord
Cuser_context_menu_t	Event parameter for context menu interactions for users
Cuser_identified	A user with additional fields only available via the oauth2 identify scope
Cuser_update_t	User update
Cvoice_buffer_send_t	Voice buffer send
Cvoice_client_disconnect_t	Voice client disconnect event
Cvoice_client_speaking_t	Voice client speaking event
Cvoice_exception	Represents an error with voice processing
Cvoice_out_packet	An opus-encoded RTP packet to be sent out to a voice channel
Cvoice_ready_t	Voice user talking
Cvoice_receive_t	Voice receive packet
Cvoice_server_update_t	Voice server update
Cvoice_state_update_t	Voice state update
Cvoice_track_marker_t	Voice state update
Cvoice_user_talking_t	Voice user talking
Cvoiceconn	Represents a connection to a voice channel
Cvoiceregion	Represents a voice region on discord
Cvoicestate	Represents the voice state of a user on a guild These are stored in the dpp::guild object, and accessible there, or via dpp::channel::get_voice_members
Cwebhook	Represents a discord webhook
Cwebhooks_update_t	Webhooks update
Cwebsocket_client	Implements a websocket client based on the SSL client
Cwelcome_channel	Defines a channel on a server's welcome screen
Cwelcome_screen	Defines a server's welcome screen
►Cwhen_any	Experimental class to co_await on a bunch of awaitable objects, resuming when the first one completes. On completion, returns a result object that contains the index of the awaitable that finished first. A user can call result::index() and result::get<N>() on the result object to get the result, similar to std::variant
Cawaiter	Object returned by operator co_await()
Cresult	Object returned by operator co_await() on resumption
Czlibcontext	This is an opaque class containing zlib library specific structures
►Nstd	STL namespace
Chash< dpp::snowflake >
Chas_build_json	Type trait to check if a certain type has a build_json method
Chas_build_json< T, std::void_t< decltype(std::declval< T & >().build_json())> >
Chas_fill_from_json	Type trait to check if a certain type has a fill_from_json method
Chas_fill_from_json< T, std::void_t< decltype(std::declval< T & >().fill_from_json(std::declval< dpp::json * >()))> >
Cmessage_collector	A test version of the message collector for use in unit tests
COpusDecoder
COpusEncoder
COpusRepacketizer
Ctest_cached_object_t
Ctest_t
Cuser_project_id_t	Convenience functor to get the snowflake of a certain type