Skip to content

Commit

Permalink
automatic commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Docs Deployment Bot committed Nov 8, 2023
1 parent 64b6dc0 commit 3eea3e9
Show file tree
Hide file tree
Showing 365 changed files with 24,189 additions and 23,893 deletions.
171 changes: 86 additions & 85 deletions annotated.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions annotated_dup.js
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ var annotated_dup =
[ "message_create_t", "structdpp_1_1message__create__t.html", "structdpp_1_1message__create__t" ],
[ "message_delete_bulk_t", "structdpp_1_1message__delete__bulk__t.html", "structdpp_1_1message__delete__bulk__t" ],
[ "message_delete_t", "structdpp_1_1message__delete__t.html", "structdpp_1_1message__delete__t" ],
[ "message_file_data", "structdpp_1_1message__file__data.html", "structdpp_1_1message__file__data" ],
[ "message_reaction_add_t", "structdpp_1_1message__reaction__add__t.html", "structdpp_1_1message__reaction__add__t" ],
[ "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" ],
Expand Down
4 changes: 2 additions & 2 deletions awaiting-events.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@
<div class="ttc" id="aclassdpp_1_1cluster_html"><div class="ttname"><a href="classdpp_1_1cluster.html">dpp::cluster</a></div><div class="ttdoc">The cluster class represents a group of shards and a command queue for sending and receiving commands...</div><div class="ttdef"><b>Definition:</b> cluster.h:80</div></div>
<div class="ttc" id="aclassdpp_1_1cluster_html_ab840686c7cd2e15f4a66ab64f62e106b"><div class="ttname"><a href="classdpp_1_1cluster.html#ab840686c7cd2e15f4a66ab64f62e106b">dpp::cluster::on_log</a></div><div class="ttdeci">event_router_t&lt; log_t &gt; on_log</div><div class="ttdoc">Called when a log message is to be written to the log. You can attach any logging system here you wis...</div><div class="ttdef"><b>Definition:</b> cluster.h:462</div></div>
<div class="ttc" id="aclassdpp_1_1cluster_html_af9409347218d270da0aeb22b0a27c38d"><div class="ttname"><a href="classdpp_1_1cluster.html#af9409347218d270da0aeb22b0a27c38d">dpp::cluster::on_button_click</a></div><div class="ttdeci">event_router_t&lt; button_click_t &gt; on_button_click</div><div class="ttdoc">Called when a button is clicked attached to a message. Button clicks are triggered by discord when bu...</div><div class="ttdef"><b>Definition:</b> cluster.h:506</div></div>
<div class="ttc" id="aclassdpp_1_1component_html"><div class="ttname"><a href="classdpp_1_1component.html">dpp::component</a></div><div class="ttdoc">Represents the component object. A component is a clickable button or drop down list within a discord...</div><div class="ttdef"><b>Definition:</b> message.h:309</div></div>
<div class="ttc" id="aclassdpp_1_1component_html"><div class="ttname"><a href="classdpp_1_1component.html">dpp::component</a></div><div class="ttdoc">Represents the component object. A component is a clickable button or drop down list within a discord...</div><div class="ttdef"><b>Definition:</b> message.h:333</div></div>
<div class="ttc" id="aclassdpp_1_1component_html_a1bf3798669b015711df5d2621ff92d73"><div class="ttname"><a href="classdpp_1_1component.html#a1bf3798669b015711df5d2621ff92d73">dpp::component::set_id</a></div><div class="ttdeci">component &amp; set_id(const std::string &amp;id)</div><div class="ttdoc">Set the id of the component. For action rows, this field is ignored. Setting the id will auto-set the...</div></div>
<div class="ttc" id="aclassdpp_1_1component_html_a23955055e9d77383fca2a5738ae3a30f"><div class="ttname"><a href="classdpp_1_1component.html#a23955055e9d77383fca2a5738ae3a30f">dpp::component::set_label</a></div><div class="ttdeci">component &amp; set_label(const std::string &amp;label)</div><div class="ttdoc">Set the label of the component, e.g. button text. For action rows, this field is ignored....</div></div>
<div class="ttc" id="aclassdpp_1_1component_html_a281e39d6b8c65b1fd301d195a835e703"><div class="ttname"><a href="classdpp_1_1component.html#a281e39d6b8c65b1fd301d195a835e703">dpp::component::set_type</a></div><div class="ttdeci">component &amp; set_type(component_type ct)</div><div class="ttdoc">Set the type of the component. Button components (type dpp::cot_button) should always be contained wi...</div></div>
Expand All @@ -173,7 +173,7 @@
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a10553ebb8d10ba58595f825e0a89eb1b"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a10553ebb8d10ba58595f825e0a89eb1b">dpp::interaction_create_t::edit_original_response</a></div><div class="ttdeci">void edit_original_response(const message &amp;m, command_completion_event_t callback=utility::log_error()) const</div><div class="ttdoc">Edit original response message for this interaction.</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a8b0c69c156a1e532507a918c13414f14"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a8b0c69c156a1e532507a918c13414f14">dpp::interaction_create_t::command</a></div><div class="ttdeci">interaction command</div><div class="ttdoc">command interaction</div><div class="ttdef"><b>Definition:</b> dispatcher.h:677</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_aef38626cd24d2212b00ab866509b4d59"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#aef38626cd24d2212b00ab866509b4d59">dpp::interaction_create_t::co_reply</a></div><div class="ttdeci">dpp::async&lt; dpp::confirmation_callback_t &gt; co_reply() const</div><div class="ttdoc">Acknowledge interaction without displaying a message to the user, for use with button and select menu...</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:1714</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:1738</div></div>
<div class="ttc" id="astructdpp_1_1ready__t_html"><div class="ttname"><a href="structdpp_1_1ready__t.html">dpp::ready_t</a></div><div class="ttdoc">Session ready.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:960</div></div>
<div class="ttc" id="astructdpp_1_1slashcommand__t_html"><div class="ttname"><a href="structdpp_1_1slashcommand__t.html">dpp::slashcommand_t</a></div><div class="ttdoc">User has issued a slash command.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:694</div></div>
</div><!-- fragment --><p >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 <a class="el" href="expiring-buttons.html">next example</a> comes into play as a solution, with a button that expires with time.</p>
Expand Down
4 changes: 2 additions & 2 deletions caching-messages.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a8b0c69c156a1e532507a918c13414f14"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a8b0c69c156a1e532507a918c13414f14">dpp::interaction_create_t::command</a></div><div class="ttdeci">interaction command</div><div class="ttdoc">command interaction</div><div class="ttdef"><b>Definition:</b> dispatcher.h:677</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_ae89b601e82f534d5d87135b82a6f0491"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#ae89b601e82f534d5d87135b82a6f0491">dpp::interaction_create_t::get_parameter</a></div><div class="ttdeci">virtual command_value get_parameter(const std::string &amp;name) const</div><div class="ttdoc">Get a slashcommand parameter.</div></div>
<div class="ttc" id="astructdpp_1_1message__create__t_html"><div class="ttname"><a href="structdpp_1_1message__create__t.html">dpp::message_create_t</a></div><div class="ttdoc">Create message.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:1624</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:1714</div></div>
<div class="ttc" id="astructdpp_1_1message_html_acb17877db423d2ac4b103a67e1ae2ff6"><div class="ttname"><a href="structdpp_1_1message.html#acb17877db423d2ac4b103a67e1ae2ff6">dpp::message::content</a></div><div class="ttdeci">std::string content</div><div class="ttdoc">Contents of the message.</div><div class="ttdef"><b>Definition:</b> message.h:1759</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:1738</div></div>
<div class="ttc" id="astructdpp_1_1message_html_acb17877db423d2ac4b103a67e1ae2ff6"><div class="ttname"><a href="structdpp_1_1message.html#acb17877db423d2ac4b103a67e1ae2ff6">dpp::message::content</a></div><div class="ttdeci">std::string content</div><div class="ttdoc">Contents of the message.</div><div class="ttdef"><b>Definition:</b> message.h:1783</div></div>
<div class="ttc" id="astructdpp_1_1ready__t_html"><div class="ttname"><a href="structdpp_1_1ready__t.html">dpp::ready_t</a></div><div class="ttdoc">Session ready.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:960</div></div>
<div class="ttc" id="astructdpp_1_1slashcommand__t_html"><div class="ttname"><a href="structdpp_1_1slashcommand__t.html">dpp::slashcommand_t</a></div><div class="ttdoc">User has issued a slash command.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:694</div></div>
</div><!-- fragment --> </div></div><!-- contents --><script src="https://giscus.app/client.js" data-repo="brainboxdotcc/dpp-comments" data-repo-id="R_kgDOHOY4xg" data-category="General" data-category-id="DIC_kwDOHOY4xs4CRYtj" data-mapping="pathname" data-strict="1" data-reactions-enabled="1" data-emit-metadata="1" data-input-position="top" data-theme="preferred_color_scheme" data-lang="en" data-loading="lazy" crossorigin="anonymous" async></script>
Expand Down
2 changes: 1 addition & 1 deletion callback-functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@
<div class="ttc" id="astructdpp_1_1confirmation__callback__t_html_ac32b677abe27aa496063ee34a4ae1fbd"><div class="ttname"><a href="structdpp_1_1confirmation__callback__t.html#ac32b677abe27aa496063ee34a4ae1fbd">dpp::confirmation_callback_t::get</a></div><div class="ttdeci">T get() const</div><div class="ttdoc">Get the stored value via std::get.</div><div class="ttdef"><b>Definition:</b> restresults.h:323</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a34f374b358f8d2d49fa93bfe5a2c0493"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a34f374b358f8d2d49fa93bfe5a2c0493">dpp::interaction_create_t::reply</a></div><div class="ttdeci">void reply(command_completion_event_t callback=utility::log_error()) const</div><div class="ttdoc">Acknowledge interaction without displaying a message to the user, for use with button and select menu...</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a8b0c69c156a1e532507a918c13414f14"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a8b0c69c156a1e532507a918c13414f14">dpp::interaction_create_t::command</a></div><div class="ttdeci">interaction command</div><div class="ttdoc">command interaction</div><div class="ttdef"><b>Definition:</b> dispatcher.h:677</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:1714</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:1738</div></div>
<div class="ttc" id="astructdpp_1_1ready__t_html"><div class="ttname"><a href="structdpp_1_1ready__t.html">dpp::ready_t</a></div><div class="ttdoc">Session ready.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:960</div></div>
<div class="ttc" id="astructdpp_1_1slashcommand__t_html"><div class="ttname"><a href="structdpp_1_1slashcommand__t.html">dpp::slashcommand_t</a></div><div class="ttdoc">User has issued a slash command.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:694</div></div>
</div><!-- fragment --><p >This is the result:</p>
Expand Down
2 changes: 1 addition & 1 deletion classdpp_1_1channel__collector.html
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#abe7a5ff238f82ee080030514
<div class="ttc" id="aclassdpp_1_1channel__collector_html_ac048b6f35cb511cc9b8d46b1591b243e"><div class="ttname"><a href="classdpp_1_1channel__collector.html#ac048b6f35cb511cc9b8d46b1591b243e">dpp::channel_collector::filter</a></div><div class="ttdeci">virtual const dpp::channel * filter(const dpp::channel_create_t &amp;element)</div><div class="ttdoc">Select and filter the items which are to appear in the list This is called every time a new event is ...</div><div class="ttdef"><b>Definition:</b> collector.h:354</div></div>
<div class="ttc" id="anamespacedpp_1_1unicode__emoji_html_a24ac871c89f4e1779cfeda23077faeac"><div class="ttname"><a href="namespacedpp_1_1unicode__emoji.html#a24ac871c89f4e1779cfeda23077faeac">dpp::unicode_emoji::m</a></div><div class="ttdeci">constexpr const char m[]</div><div class="ttdef"><b>Definition:</b> unicode_emoji.h:5119</div></div>
<div class="ttc" id="astructdpp_1_1message__create__t_html"><div class="ttname"><a href="structdpp_1_1message__create__t.html">dpp::message_create_t</a></div><div class="ttdoc">Create message.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:1624</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:1714</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:1738</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">element</td><td>The event data to filter </td></tr>
Expand Down
2 changes: 1 addition & 1 deletion classdpp_1_1cluster-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -724,7 +724,7 @@
<tr class="odd"><td class="entry"><a class="el" href="classdpp_1_1cluster.html#adfece237b42b8a0ab4d81c000e159fd6">operator=</a>(const cluster &amp;)=delete</td><td class="entry"><a class="el" href="classdpp_1_1cluster.html">dpp::cluster</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classdpp_1_1cluster.html#a17780ca53ef05b8d66df90185eb51a04">operator=</a>(const cluster &amp;&amp;)=delete</td><td class="entry"><a class="el" href="classdpp_1_1cluster.html">dpp::cluster</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classdpp_1_1cluster.html#a4d102b15a0a4d74fd1f9ee4fc3aa8bbf">post_rest</a>(const std::string &amp;endpoint, const std::string &amp;major_parameters, const std::string &amp;parameters, http_method method, const std::string &amp;postdata, json_encode_t callback, const std::string &amp;filename=&quot;&quot;, const std::string &amp;filecontent=&quot;&quot;, const std::string &amp;filemimetype=&quot;&quot;, const std::string &amp;protocol=&quot;1.1&quot;)</td><td class="entry"><a class="el" href="classdpp_1_1cluster.html">dpp::cluster</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classdpp_1_1cluster.html#a3c540c26342e8238a76b8ac252f7f262">post_rest_multipart</a>(const std::string &amp;endpoint, const std::string &amp;major_parameters, const std::string &amp;parameters, http_method method, const std::string &amp;postdata, json_encode_t callback, const std::vector&lt; std::string &gt; &amp;filename={}, const std::vector&lt; std::string &gt; &amp;filecontent={}, const std::vector&lt; std::string &gt; &amp;filemimetypes={})</td><td class="entry"><a class="el" href="classdpp_1_1cluster.html">dpp::cluster</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classdpp_1_1cluster.html#a548e19022b7d3ee825920888da07493b">post_rest_multipart</a>(const std::string &amp;endpoint, const std::string &amp;major_parameters, const std::string &amp;parameters, http_method method, const std::string &amp;postdata, json_encode_t callback, const std::vector&lt; message_file_data &gt; &amp;file_data={})</td><td class="entry"><a class="el" href="classdpp_1_1cluster.html">dpp::cluster</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classdpp_1_1cluster.html#aa4ead3406c471a64fa1fa578cc51cf2e">request</a>(const std::string &amp;url, http_method method, http_completion_event callback, const std::string &amp;postdata=&quot;&quot;, const std::string &amp;mimetype=&quot;text/plain&quot;, const std::multimap&lt; std::string, std::string &gt; &amp;headers={}, const std::string &amp;protocol=&quot;1.1&quot;)</td><td class="entry"><a class="el" href="classdpp_1_1cluster.html">dpp::cluster</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classdpp_1_1cluster.html#a6161f8d412b2e81a06594f727684a260">rest_ping</a></td><td class="entry"><a class="el" href="classdpp_1_1cluster.html">dpp::cluster</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classdpp_1_1cluster.html#a849017410297379997601daac5e99ce1">role_create</a>(const class role &amp;r, command_completion_event_t callback=utility::log_error())</td><td class="entry"><a class="el" href="classdpp_1_1cluster.html">dpp::cluster</a></td><td class="entry"></td></tr>
Expand Down
Loading

0 comments on commit 3eea3e9

Please sign in to comment.