 |
D++ (DPP)
C++ Discord API Bot Library
|
|
D++ (DPP)
C++ Discord API Bot Library
|
| Cdpp::activity | An activity is a representation of what a user is doing. It might be a game, or a website, or a movie. Whatever |
| Cdpp::message::allowed_ref | Allowed mentions detils |
| Cdpp::app_team | Represents a team of users who maintain a bot/application |
| Cdpp::attachment | Represents an attachment in a dpp::message |
| Cdpp::audit_change | Defines audit log changes |
| Cdpp::audit_entry | An individual audit log entry |
| Cdpp::audit_extra | Extra information for an audit log entry |
| Cdpp::auditlog | The auditlog class represents the audit log entry of a guild |
| Cdpp::autocomplete_interaction | An auto complete interaction |
| Cdpp::ban | The ban class represents a ban on a guild |
| Cdpp::bucket_t | A rate limit bucket. The library builds one of these for each endpoint |
| Cdpp::cache< T > | A cache object maintains a cache of dpp::managed objects |
| Cdpp::cache_policy_t | Represents the caching policy of the cluster |
| Chttplib::detail::ci | |
| Chttplib::Client | |
| Chttplib::ClientImpl | |
| Cdpp::cluster | 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 |
| ►Cdpp::collector< T, C > | Collects objects from events during a specified time period |
| Cdpp::command_data_option | Values in the command interaction. These are the values specified by the user when actually issuing the command on a channel or in DM |
| Cdpp::command_info_t | Represents the details of a command added to the command handler class |
| Cdpp::command_interaction | Details of a command within an interaction. This subobject represents the application command associated with the interaction |
| Cdpp::command_option | Each command option is a command line parameter. It can have a type (see dpp::command_option_type), a name, a description, can be required or optional, and can have zero or more choices (for multiple choice), plus options. Adding options acts like sub-commands and can contain more options |
| Cdpp::command_option_choice | This struct represents choices in a multiple choice option for a command parameter. It has both a string name, and a value parameter which is a variant, meaning it can hold different potential types (see dpp::command_value) that you can retrieve with std::get() |
| Cdpp::command_permission | Application command permissions allow you to enable or disable commands for specific users or roles within a guild |
| Cdpp::command_resolved | Resolved snowflake ids to users, guild members, roles and channels |
| Cdpp::command_source | Represents the sending source of a command. This is passed to any command handler and should be passed back to commandhandler::reply(), allowing the reply method to route any replies back to the origin, which may be a slash command or a message. Both require different response facilities but we want this to be transparent if you use the command handler class |
| Cdpp::commandhandler | The commandhandler class represents a group of commands, prefixed or slash commands with handling functions |
| Cdpp::component | Represents the component object. A component is a clickable button or drop down list within a discord message, where the buttons emit on_button_click events when the user interacts with them |
| Cdpp::component_interaction | A button click for a button component |
| Cdpp::confirmation | Confirmation object represents any true or false simple REST request |
| Cdpp::confirmation_callback_t | The results of a REST call wrapped in a convenient struct |
| Cdpp::connection | The connection object that the user has attached |
| Chttplib::ContentReader | |
| Chttplib::DataSink | |
| Cdpp::dtemplate | Represents a guild template |
| Cdpp::embed | A rich embed for display within a dpp::message |
| Cdpp::embed_author | Author within a dpp::embed object |
| Cdpp::embed_field | A dpp::embed may contain zero or more fields |
| Cdpp::embed_footer | A footer in a dpp::embed |
| Cdpp::embed_image | An video, image or thumbnail in a dpp::embed |
| Cdpp::embed_provider | Embed provider in a dpp::embed. Received from discord but cannot be sent |
| Cdpp::error_detail | The details of a field in an error response |
| Cdpp::error_info | The full details of an error from a REST response |
| Cdpp::etf_buffer | Represents a buffer of bytes being encoded into ETF |
| Cdpp::etf_parser | The etf_parser class 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 |
| ►Cdpp::events::event | An event object represents an event handled internally, passed from the websocket e.g. MESSAGE_CREATE |
| ►Cdpp::event_dispatch_t | Base event parameter struct. Each event you receive from the library will have its parameter derived from this class. The class contains the raw event data, and a pointer to the current shard's dpp::discord_client object. You can also use this object to cancel the current event, meaning that any listeners after yours do not get notified of the current event if you call it |
| Cdpp::event_entities | Entities for the event |
| Cdpp::event_member | Represents a guild member/user who has registered interest in an event |
| Cdpp::event_router_t< T > | Handles routing of an event to multiple listeners |
| ►Cstd::exception | STL class |
| Cdpp::gateway | Represents the various information from the 'get gateway bot' api call |
| Cdpp::guild_command_permissions | Returned when fetching the permissions for a command in a guild |
| Cdpp::guild_member | Represents dpp::user membership upon a dpp::guild. This contains the user's nickname, guild roles, and any other guild-specific flags |
| Cdpp::guild_widget | Represents a guild widget, simple web widget of member list |
| Cdpp::http_request | A HTTP request |
| Cdpp::http_request_completion_t | The result of any HTTP request. Contains the headers, vital rate limit figures, and returned request body |
| Cdpp::utility::iconhash | Store a 128 bit icon hash (profile picture, server icon etc) as a 128 bit binary value made of two uint64_t. Has a constructor to build one from a string, and a method to fetch the value back in string form |
| Cdpp::component::inner_emoji | |
| Cdpp::select_option::inner_select_emoji | Emoji definition. To set an emoji on your button you must set one of either the name or id fields. The easiest way is to use the component::set_emoji method |
| Cdpp::integration_app | An application that has been integrated |
| ►Cdpp::interaction_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 |
| Cdpp::invite | Represents an invite to a discord guild or channel |
| ►Cdpp::managed | The managed class is the base class for various types that can be stored in a cache that are identified by a dpp::snowflake id |
| Cdpp::message::message_interaction_struct | Reference to an interaction |
| Cdpp::message::message_ref | Reference to another message, e.g. a reply |
| Chttplib::MultipartFormData | |
| Cdpp::oneshot_timer | Trigger a timed event once. The provided callback is called only once |
| Cdpp::param_info | Details of a command parameter used in registration. Note that for non-slash commands optional parameters can only be at the end of the list of parameters |
| Cdpp::permission_overwrite | Channel permission overwrites |
| Cdpp::presence | Represents user presence, e.g. what game they are playing and if they are online |
| Cdpp::prune | Defines a request to count prunable users, or start a prune operation |
| Cdpp::reaction | Represets a reaction to a dpp::message |
| Chttplib::Request | |
| Cdpp::request_queue | The request_queue class manages rate limits and marshalls HTTP requests that have been built as http_request objects |
| Cdpp::resolved_user | Dpp::resolved_user contains both a dpp::guild_member and a dpp::user. The user can be used to obtain in-depth user details such as if they are nitro, and the guild member information to check their roles on a guild etc. The Discord API provides both if a parameter is a user ping, so we offer both in a combined structure |
| Chttplib::Response | |
| Chttplib::Result | |
| Cdpp::select_option | An option for a select component |
| Chttplib::Server | |
| Chttplib::ClientImpl::Socket | |
| ►Cdpp::ssl_client | Implements a simple non-blocking SSL stream client |
| Chttplib::Stream | |
| ►Chttplib::TaskQueue | |
| Cdpp::team_member | Represents a team member on a team who maintain a bot/application |
| Cdpp::thread_member | Represents membership of a user with a thread |
| Cdpp::thread_metadata | Metadata for threads |
| Cdpp::timed_listener< attached_event, listening_function > | A timed_listener is a way to temporarily attach to an event for a specific timeframe, then detach when complete. A lambda may also be optionally called when the timeout is reached. Destructing the timed_listener detaches any attached event listeners, and cancels any created timers, but does not call any timeout lambda |
| Cdpp::timer_t | Used internally to store state of active timers |
| Cdpp::type_punner | A horrible structure used within the ETF parser to convert uint64_t to double and back. This is horrible, but it is the official way erlang term format does this, so we can't really mess with it much |
| Cdpp::utility::uptime | 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 |
| Cdpp::voice_out_packet | An opus-encoded RTP packet to be sent out to a voice channel |
| Cdpp::voiceconn | Represents a connection to a voice channel. A client can only connect to one voice channel per guild at a time, so these are stored in a map in the dpp::discord_client keyed by guild_id |
| Cdpp::voiceregion | Represents a voice region on discord |
| Cdpp::voicestate | 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 |
| Cdpp::welcome_channel_t | Defines a channel on a server's welcome screen |
| Cdpp::welcome_screen_t | Defines a server's welcome screen |