diff --git a/annotated.html b/annotated.html index 07164963a4c..0c8bd2d9784 100644 --- a/annotated.html +++ b/annotated.html @@ -371,96 +371,97 @@  Cmessage_reaction_remove_all_tMessage remove all reactions  Cmessage_reaction_remove_emoji_tMessage remove emoji  Cmessage_reaction_remove_tMessage reaction remove - Cmessage_update_tMessage update - Cmoveable_promiseGeneric promise class, represents the owning potion of an asynchronous value - Cmoving_averager - Cmultipart_contentRepresents 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 - ConboardingRepresents a guild's onboarding flow - Conboarding_promptRepresents an onboarding prompt - Conboarding_prompt_optionRepresents an onboarding prompt option - Coneshot_timerTrigger a timed event once. The provided callback is called only once - Cparam_infoDetails 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 - Cparse_exceptionRepresents inability to parse data, usually caused by malformed JSON or ETF - Cpartial_emojiAn emoji reference for a component (select menus included) or a poll - CpermissionRepresents a permission bitmask (refer to enum dpp::permissions) which are held in an uint64_t - Cpermission_overwriteChannel permission overwrites - CpollRepresents a poll - Cpoll_answerRepresents an answer in a poll - Cpoll_mediaStructure representing a poll media, for example the poll question or a possible poll answer - ►Cpoll_resultsRepresents the results of a poll - Canswer_countRepresents a reference to an answer and its count of votes - CpresenceRepresents user presence, e.g. what game they are playing and if they are online - Cpresence_update_tPresence update - CpruneDefines a request to count prunable users, or start a prune operation - CreactionRepresents a reaction to a dpp::message - Creaction_collectorReaction collector. Collects message reactions during a set timeframe and returns them in a list via the completed() method - Cready_tSession ready - ►Crequest_queueThe request_queue class manages rate limits and marshalls HTTP requests that have been built as http_request objects - Ccompleted_requestA completed request. Contains both the request and the response - Cqueued_deleting_requestA request queued for deletion in the queue - Cresolved_userDpp::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 - Crest_exceptionRepresents an error on a REST API call, e.g. a HTTPS request - Cresumed_tSession resumed - CroleRepresents a role within a dpp::guild. Roles are combined via logical OR of the permission bitmasks, then channel-specific overrides can be applied on top, deny types apply a logic NOT to the bit mask, and allows apply a logical OR - Crole_collectorRole collector. Collects guild roles during a set timeframe and returns them in a list via the completed() method - Cscheduled_eventA scheduled event - Cscheduled_event_collectorScheduled event collector. Collects messages during a set timeframe and returns them in a list via the completed() method - Cselect_click_tClick on select - Cselect_optionAn option for a select component - CskuA definition of a discord SKU - CslashcommandRepresents an application command, created by your bot either globally, or on a guild - Cslashcommand_tUser has issued a slash command - CsnowflakeA container for a 64 bit unsigned value representing many things on discord. This value is known in distributed computing as a snowflake value - Cssl_clientImplements a simple non-blocking SSL stream client - Cstage_instanceA stage instance. Stage instances are like a conference facility, with moderators/speakers and listeners - Cstage_instance_create_tCreate stage instance - Cstage_instance_delete_tDelete stage instance - Cstage_instance_update_tUpdate stage instance - CstickerRepresents stickers received in messages - Csticker_packRepresents a sticker pack (the built in groups of stickers that all nitro users get to use) - CtaskA coroutine task. It starts immediately on construction and can be co_await-ed, making it perfect for parallel coroutines returning a value - Ctask_cancelled_exceptionRepresents the cancellation of a task. Will be thrown to the awaiter of a cancelled task - Ctask_dummy - Cteam_memberRepresents a team member on a team who maintain a bot/application - CthreadA definition of a discord thread. A thread is a superset of a channel. Not to be confused with std::thread! - Cthread_collectorThread collector. Collects threads during a set timeframe and returns them in a list via the completed() method - Cthread_create_tThread Create - Cthread_delete_tThread Delete - Cthread_list_sync_tThread List Sync - Cthread_memberRepresents membership of a user with a thread - Cthread_member_update_tThread Member Update - Cthread_members_update_tThread Members Update - Cthread_metadataMetadata for threads - Cthread_update_tThread Update - Ctimed_listenerA 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 - Ctimer_tUsed internally to store state of active timers - Ctyping_start_tTyping start - CuserRepresents a user on discord. May or may not be a member of a dpp::guild - Cuser_context_menu_tEvent parameter for context menu interactions for users - Cuser_identifiedA user with additional fields only available via the oauth2 identify scope. These are not included in dpp::user as additional scopes are needed to fetch them which bots do not normally have - Cuser_update_tUser update - Cvoice_buffer_send_tVoice buffer send - Cvoice_client_disconnect_tVoice client disconnect event - Cvoice_client_speaking_tVoice client speaking event - Cvoice_exceptionRepresents an error with voice processing - Cvoice_out_packetAn opus-encoded RTP packet to be sent out to a voice channel - Cvoice_ready_tVoice user talking - Cvoice_receive_tVoice receive packet - Cvoice_server_update_tVoice server update - Cvoice_state_update_tVoice state update - Cvoice_track_marker_tVoice state update - Cvoice_user_talking_tVoice user talking - CvoiceconnRepresents 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 - CvoiceregionRepresents a voice region on discord - CvoicestateRepresents 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 - CwebhookRepresents a discord webhook - Cwebhooks_update_tWebhooks update - Cwebsocket_clientImplements a websocket client based on the SSL client - Cwelcome_channelDefines a channel on a server's welcome screen - Cwelcome_screenDefines a server's welcome screen - ►Cwhen_anyExperimental 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 - CawaiterObject returned by operator co_await(). Meant to be used by the standard library, not by a user - CresultObject returned by operator co_await() on resumption. Can be moved but not copied + Cmessage_snapshot + Cmessage_update_tMessage update + Cmoveable_promiseGeneric promise class, represents the owning potion of an asynchronous value + Cmoving_averager + Cmultipart_contentRepresents 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 + ConboardingRepresents a guild's onboarding flow + Conboarding_promptRepresents an onboarding prompt + Conboarding_prompt_optionRepresents an onboarding prompt option + Coneshot_timerTrigger a timed event once. The provided callback is called only once + Cparam_infoDetails 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 + Cparse_exceptionRepresents inability to parse data, usually caused by malformed JSON or ETF + Cpartial_emojiAn emoji reference for a component (select menus included) or a poll + CpermissionRepresents a permission bitmask (refer to enum dpp::permissions) which are held in an uint64_t + Cpermission_overwriteChannel permission overwrites + CpollRepresents a poll + Cpoll_answerRepresents an answer in a poll + Cpoll_mediaStructure representing a poll media, for example the poll question or a possible poll answer + ►Cpoll_resultsRepresents the results of a poll + Canswer_countRepresents a reference to an answer and its count of votes + CpresenceRepresents user presence, e.g. what game they are playing and if they are online + Cpresence_update_tPresence update + CpruneDefines a request to count prunable users, or start a prune operation + CreactionRepresents a reaction to a dpp::message + Creaction_collectorReaction collector. Collects message reactions during a set timeframe and returns them in a list via the completed() method + Cready_tSession ready + ►Crequest_queueThe request_queue class manages rate limits and marshalls HTTP requests that have been built as http_request objects + Ccompleted_requestA completed request. Contains both the request and the response + Cqueued_deleting_requestA request queued for deletion in the queue + Cresolved_userDpp::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 + Crest_exceptionRepresents an error on a REST API call, e.g. a HTTPS request + Cresumed_tSession resumed + CroleRepresents a role within a dpp::guild. Roles are combined via logical OR of the permission bitmasks, then channel-specific overrides can be applied on top, deny types apply a logic NOT to the bit mask, and allows apply a logical OR + Crole_collectorRole collector. Collects guild roles during a set timeframe and returns them in a list via the completed() method + Cscheduled_eventA scheduled event + Cscheduled_event_collectorScheduled event collector. Collects messages during a set timeframe and returns them in a list via the completed() method + Cselect_click_tClick on select + Cselect_optionAn option for a select component + CskuA definition of a discord SKU + CslashcommandRepresents an application command, created by your bot either globally, or on a guild + Cslashcommand_tUser has issued a slash command + CsnowflakeA container for a 64 bit unsigned value representing many things on discord. This value is known in distributed computing as a snowflake value + Cssl_clientImplements a simple non-blocking SSL stream client + Cstage_instanceA stage instance. Stage instances are like a conference facility, with moderators/speakers and listeners + Cstage_instance_create_tCreate stage instance + Cstage_instance_delete_tDelete stage instance + Cstage_instance_update_tUpdate stage instance + CstickerRepresents stickers received in messages + Csticker_packRepresents a sticker pack (the built in groups of stickers that all nitro users get to use) + CtaskA coroutine task. It starts immediately on construction and can be co_await-ed, making it perfect for parallel coroutines returning a value + Ctask_cancelled_exceptionRepresents the cancellation of a task. Will be thrown to the awaiter of a cancelled task + Ctask_dummy + Cteam_memberRepresents a team member on a team who maintain a bot/application + CthreadA definition of a discord thread. A thread is a superset of a channel. Not to be confused with std::thread! + Cthread_collectorThread collector. Collects threads during a set timeframe and returns them in a list via the completed() method + Cthread_create_tThread Create + Cthread_delete_tThread Delete + Cthread_list_sync_tThread List Sync + Cthread_memberRepresents membership of a user with a thread + Cthread_member_update_tThread Member Update + Cthread_members_update_tThread Members Update + Cthread_metadataMetadata for threads + Cthread_update_tThread Update + Ctimed_listenerA 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 + Ctimer_tUsed internally to store state of active timers + Ctyping_start_tTyping start + CuserRepresents a user on discord. May or may not be a member of a dpp::guild + Cuser_context_menu_tEvent parameter for context menu interactions for users + Cuser_identifiedA user with additional fields only available via the oauth2 identify scope. These are not included in dpp::user as additional scopes are needed to fetch them which bots do not normally have + Cuser_update_tUser update + Cvoice_buffer_send_tVoice buffer send + Cvoice_client_disconnect_tVoice client disconnect event + Cvoice_client_speaking_tVoice client speaking event + Cvoice_exceptionRepresents an error with voice processing + Cvoice_out_packetAn opus-encoded RTP packet to be sent out to a voice channel + Cvoice_ready_tVoice user talking + Cvoice_receive_tVoice receive packet + Cvoice_server_update_tVoice server update + Cvoice_state_update_tVoice state update + Cvoice_track_marker_tVoice state update + Cvoice_user_talking_tVoice user talking + CvoiceconnRepresents 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 + CvoiceregionRepresents a voice region on discord + CvoicestateRepresents 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 + CwebhookRepresents a discord webhook + Cwebhooks_update_tWebhooks update + Cwebsocket_clientImplements a websocket client based on the SSL client + Cwelcome_channelDefines a channel on a server's welcome screen + Cwelcome_screenDefines a server's welcome screen + ►Cwhen_anyExperimental 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 + CawaiterObject returned by operator co_await(). Meant to be used by the standard library, not by a user + CresultObject returned by operator co_await() on resumption. Can be moved but not copied  ►NstdSTL namespace  Chash< dpp::snowflake > diff --git a/annotated_dup.js b/annotated_dup.js index d0ebb3f68b0..614f4b94eab 100644 --- a/annotated_dup.js +++ b/annotated_dup.js @@ -274,6 +274,7 @@ var annotated_dup = [ "message_reaction_remove_all_t", "structdpp_1_1message__reaction__remove__all__t.html", "structdpp_1_1message__reaction__remove__all__t" ], [ "message_reaction_remove_emoji_t", "structdpp_1_1message__reaction__remove__emoji__t.html", "structdpp_1_1message__reaction__remove__emoji__t" ], [ "message_reaction_remove_t", "structdpp_1_1message__reaction__remove__t.html", "structdpp_1_1message__reaction__remove__t" ], + [ "message_snapshot", "structdpp_1_1message__snapshot.html", "structdpp_1_1message__snapshot" ], [ "message_update_t", "structdpp_1_1message__update__t.html", "structdpp_1_1message__update__t" ], [ "moveable_promise", "classdpp_1_1moveable__promise.html", "classdpp_1_1moveable__promise" ], [ "moving_averager", "structdpp_1_1moving__averager.html", "structdpp_1_1moving__averager" ], diff --git a/awaiting-events.html b/awaiting-events.html index 4a9fdf202b9..cc53a2e0046 100644 --- a/awaiting-events.html +++ b/awaiting-events.html @@ -173,7 +173,7 @@
dpp::interaction_create_t::edit_original_response
void edit_original_response(const message &m, command_completion_event_t callback=utility::log_error()) const
Edit original response message for this interaction.
dpp::interaction_create_t::command
interaction command
command interaction
Definition: dispatcher.h:678
dpp::interaction_create_t::co_reply
dpp::async< dpp::confirmation_callback_t > co_reply() const
Acknowledge interaction without displaying a message to the user, for use with button and select menu...
-
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2016
+
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2034
dpp::ready_t
Session ready.
Definition: dispatcher.h:961
dpp::slashcommand_t
User has issued a slash command.
Definition: dispatcher.h:695

Note that there is a problem with that! If the user never clicks your button, or if the message gets deleted, your coroutine will be stuck waiting... And waiting... Forever until your bot shuts down, occupying a space in memory. This is where the next example comes into play as a solution, with a button that expires with time.

diff --git a/caching-messages.html b/caching-messages.html index 64ca76dea80..e47ead921b0 100644 --- a/caching-messages.html +++ b/caching-messages.html @@ -180,8 +180,8 @@
dpp::interaction_create_t::command
interaction command
command interaction
Definition: dispatcher.h:678
dpp::interaction_create_t::get_parameter
virtual command_value get_parameter(const std::string &name) const
Get a slashcommand parameter.
dpp::message_create_t
Create message.
Definition: dispatcher.h:1635
-
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2016
-
dpp::message::content
std::string content
Contents of the message.
Definition: message.h:2061
+
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2034
+
dpp::message::content
std::string content
Contents of the message.
Definition: message.h:2079
dpp::ready_t
Session ready.
Definition: dispatcher.h:961
dpp::slashcommand_t
User has issued a slash command.
Definition: dispatcher.h:695
diff --git a/callback-functions.html b/callback-functions.html index 152b042608c..8a9bf54c2c6 100644 --- a/callback-functions.html +++ b/callback-functions.html @@ -212,7 +212,7 @@
dpp::confirmation_callback_t::get
T get() const
Get the stored value via std::get.
Definition: restresults.h:323
dpp::interaction_create_t::reply
void reply(command_completion_event_t callback=utility::log_error()) const
Acknowledge interaction without displaying a message to the user, for use with button and select menu...
dpp::interaction_create_t::command
interaction command
command interaction
Definition: dispatcher.h:678
-
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2016
+
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2034
dpp::ready_t
Session ready.
Definition: dispatcher.h:961
dpp::slashcommand_t
User has issued a slash command.
Definition: dispatcher.h:695

This is the result:

diff --git a/classdpp_1_1channel__collector.html b/classdpp_1_1channel__collector.html index 4635d207d57..05be4d08a1e 100644 --- a/classdpp_1_1channel__collector.html +++ b/classdpp_1_1channel__collector.html @@ -408,7 +408,7 @@

dpp::channel_collector::filter
virtual const dpp::channel * filter(const dpp::channel_create_t &element)
Select and filter the items which are to appear in the list This is called every time a new event is ...
Definition: collector.h:354
dpp::unicode_emoji::m
constexpr const char m[]
Definition: unicode_emoji.h:5304
dpp::message_create_t
Create message.
Definition: dispatcher.h:1635
-
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2016
+
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2034
Parameters
diff --git a/classdpp_1_1collector.html b/classdpp_1_1collector.html index 64d3203e3f5..8e0d27644dc 100644 --- a/classdpp_1_1collector.html +++ b/classdpp_1_1collector.html @@ -357,7 +357,7 @@

dpp::collector::filter
virtual const C * filter(const T &element)=0
Filter the list of elements.
dpp::unicode_emoji::m
constexpr const char m[]
Definition: unicode_emoji.h:5304
dpp::message_create_t
Create message.
Definition: dispatcher.h:1635
-
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2016
+
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2034
Parameters

elementThe event data to filter
diff --git a/classdpp_1_1event__router__t.html b/classdpp_1_1event__router__t.html index 2adeb8fa77b..fbc5c1e9966 100644 --- a/classdpp_1_1event__router__t.html +++ b/classdpp_1_1event__router__t.html @@ -665,7 +665,7 @@

dpp::task
A coroutine task. It starts immediately on construction and can be co_await-ed, making it perfect for...
Definition: task.h:95
dpp::unicode_emoji::b
constexpr const char b[]
Definition: unicode_emoji.h:5255
dpp::button_click_t
Click on button.
Definition: dispatcher.h:703
-
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2016
+
dpp::message
Represents messages sent and received on Discord.
Definition: message.h:2034
dpp::slashcommand_t
User has issued a slash command.
Definition: dispatcher.h:695

This can be combined with dpp::when_any and other awaitables, for example dpp::cluster::co_sleep to create expiring buttons.

Warning
On resumption the awaiter will be given a reference to the event. This means that variable may become dangling at the next co_await, be careful and save it in a variable if you need to.
diff --git a/classdpp_1_1interaction__coll__graph.map b/classdpp_1_1interaction__coll__graph.map index 6dbd22b83ca..cb86257968a 100644 --- a/classdpp_1_1interaction__coll__graph.map +++ b/classdpp_1_1interaction__coll__graph.map @@ -1,44 +1,46 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/classdpp_1_1interaction__coll__graph.md5 b/classdpp_1_1interaction__coll__graph.md5 index 4513a085355..2e5961dc6b1 100644 --- a/classdpp_1_1interaction__coll__graph.md5 +++ b/classdpp_1_1interaction__coll__graph.md5 @@ -1 +1 @@ -996c4d20ebdfddfe1f3e5a219d3edf92 \ No newline at end of file +dc7bbf408d7dbb3e644da5ec77683c14 \ No newline at end of file diff --git a/classdpp_1_1interaction__coll__graph.svg b/classdpp_1_1interaction__coll__graph.svg index 93ea06b8228..72f533295d8 100644 --- a/classdpp_1_1interaction__coll__graph.svg +++ b/classdpp_1_1interaction__coll__graph.svg @@ -4,7 +4,7 @@ - +

elementThe event data to filter