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 Aug 17, 2023
1 parent 21b2002 commit 538d658
Show file tree
Hide file tree
Showing 70 changed files with 3,507 additions and 3,287 deletions.
2 changes: 2 additions & 0 deletions classdpp_1_1permission-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@
<p>This is the complete list of members for <a class="el" href="classdpp_1_1permission.html">dpp::permission</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classdpp_1_1permission.html#abc2e0b7597ec5b049c0e6a78e1fdab42">add</a>(T... values) noexcept</td><td class="entry"><a class="el" href="classdpp_1_1permission.html">dpp::permission</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classdpp_1_1permission.html#adc6228f57c04d9ad60df458c4a7e76bb">can</a>(T... values) const noexcept</td><td class="entry"><a class="el" href="classdpp_1_1permission.html">dpp::permission</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classdpp_1_1permission.html#a8be0645f95287dc48d68591274722931">can_any</a>(T... values) const noexcept</td><td class="entry"><a class="el" href="classdpp_1_1permission.html">dpp::permission</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classdpp_1_1permission.html#a02df5786b6ca1d11bbd24a175e3e28c4">has</a>(T... values) const noexcept</td><td class="entry"><a class="el" href="classdpp_1_1permission.html">dpp::permission</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classdpp_1_1permission.html#ab1485fc23cfccaabefa7117f10487a40">has_any</a>(T... values) const noexcept</td><td class="entry"><a class="el" href="classdpp_1_1permission.html">dpp::permission</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classdpp_1_1permission.html#a441f6fda65df915de06aee70859e427c">operator uint64_t</a>() const noexcept</td><td class="entry"><a class="el" href="classdpp_1_1permission.html">dpp::permission</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
Expand Down
112 changes: 106 additions & 6 deletions classdpp_1_1permission.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,14 @@
<tr class="memitem:a295aacfb3002689570ee95f608229fa3"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdpp_1_1permission.html#a295aacfb3002689570ee95f608229fa3">operator uint64_t &amp;</a> () noexcept</td></tr>
<tr class="memdesc:a295aacfb3002689570ee95f608229fa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">For acting like an integer. <a href="classdpp_1_1permission.html#a295aacfb3002689570ee95f608229fa3">More...</a><br /></td></tr>
<tr class="separator:a295aacfb3002689570ee95f608229fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc6228f57c04d9ad60df458c4a7e76bb"><td class="memTemplParams" colspan="2">template&lt;typename... T&gt; </td></tr>
<tr class="memitem:adc6228f57c04d9ad60df458c4a7e76bb"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdpp_1_1permission.html#adc6228f57c04d9ad60df458c4a7e76bb">can</a> (T... values) const noexcept</td></tr>
<tr class="memdesc:adc6228f57c04d9ad60df458c4a7e76bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check for certain permissions, taking into account administrator privileges. It uses the Bitwise AND operator. <a href="classdpp_1_1permission.html#adc6228f57c04d9ad60df458c4a7e76bb">More...</a><br /></td></tr>
<tr class="separator:adc6228f57c04d9ad60df458c4a7e76bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8be0645f95287dc48d68591274722931"><td class="memTemplParams" colspan="2">template&lt;typename... T&gt; </td></tr>
<tr class="memitem:a8be0645f95287dc48d68591274722931"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdpp_1_1permission.html#a8be0645f95287dc48d68591274722931">can_any</a> (T... values) const noexcept</td></tr>
<tr class="memdesc:a8be0645f95287dc48d68591274722931"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check for certain permissions, taking into account administrator privileges. It uses the Bitwise AND operator. <a href="classdpp_1_1permission.html#a8be0645f95287dc48d68591274722931">More...</a><br /></td></tr>
<tr class="separator:a8be0645f95287dc48d68591274722931"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02df5786b6ca1d11bbd24a175e3e28c4"><td class="memTemplParams" colspan="2">template&lt;typename... T&gt; </td></tr>
<tr class="memitem:a02df5786b6ca1d11bbd24a175e3e28c4"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdpp_1_1permission.html#a02df5786b6ca1d11bbd24a175e3e28c4">has</a> (T... values) const noexcept</td></tr>
<tr class="memdesc:a02df5786b6ca1d11bbd24a175e3e28c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check for permission flags set. It uses the Bitwise AND operator. <a href="classdpp_1_1permission.html#a02df5786b6ca1d11bbd24a175e3e28c4">More...</a><br /></td></tr>
Expand All @@ -147,7 +155,7 @@
<tr class="separator:abc2e0b7597ec5b049c0e6a78e1fdab42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d55819ed11502a41b4d686eab54f4af"><td class="memTemplParams" colspan="2">template&lt;typename... T&gt; </td></tr>
<tr class="memitem:a9d55819ed11502a41b4d686eab54f4af"><td class="memTemplItemLeft" align="right" valign="top">constexpr std::enable_if_t&lt;(std::is_convertible_v&lt; T, uint64_t &gt; &amp;&amp;...), <a class="el" href="classdpp_1_1permission.html">permission</a> &amp; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdpp_1_1permission.html#a9d55819ed11502a41b4d686eab54f4af">set</a> (T... values) noexcept</td></tr>
<tr class="memdesc:a9d55819ed11502a41b4d686eab54f4af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assign a permission. This will reset the bitmask to the new value. <a href="classdpp_1_1permission.html#a9d55819ed11502a41b4d686eab54f4af">More...</a><br /></td></tr>
<tr class="memdesc:a9d55819ed11502a41b4d686eab54f4af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assign permissions. This will reset the bitmask to the new value. <a href="classdpp_1_1permission.html#a9d55819ed11502a41b4d686eab54f4af">More...</a><br /></td></tr>
<tr class="separator:a9d55819ed11502a41b4d686eab54f4af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1e419249eb0f34d9fd0f57883493f1d"><td class="memTemplParams" colspan="2">template&lt;typename... T&gt; </td></tr>
<tr class="memitem:af1e419249eb0f34d9fd0f57883493f1d"><td class="memTemplItemLeft" align="right" valign="top">constexpr std::enable_if_t&lt;(std::is_convertible_v&lt; T, uint64_t &gt; &amp;&amp;...), <a class="el" href="classdpp_1_1permission.html">permission</a> &amp; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdpp_1_1permission.html#af1e419249eb0f34d9fd0f57883493f1d">remove</a> (T... values) noexcept</td></tr>
Expand Down Expand Up @@ -272,6 +280,100 @@ <h2 class="memtitle"><span class="permalink"><a href="#abc2e0b7597ec5b049c0e6a78
<div class="ttc" id="anamespacedpp_html_a64f16cd622b3a09ae96803ba07fa75b7ad410586df8dba6f62b7770f1d08d3b79"><div class="ttname"><a href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7ad410586df8dba6f62b7770f1d08d3b79">dpp::p_send_messages</a></div><div class="ttdeci">@ p_send_messages</div><div class="ttdoc">allows for sending messages in a channel</div><div class="ttdef"><b>Definition:</b> permissions.h:44</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>permission&amp; reference to self for chaining </dd></dl>

</div>
</div>
<a id="adc6228f57c04d9ad60df458c4a7e76bb" name="adc6228f57c04d9ad60df458c4a7e76bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc6228f57c04d9ad60df458c4a7e76bb">&#9670;&nbsp;</a></span>can()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool dpp::permission::can </td>
<td>(</td>
<td class="paramtype">T...&#160;</td>
<td class="paramname"><em>values</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Check for certain permissions, taking into account administrator privileges. It uses the Bitwise AND operator. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>one or more uint64_t permission bits </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">values</td><td>The permissions (from <a class="el" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7" title="Represents the various discord permissions.">dpp::permissions</a>) to check for</td></tr>
</table>
</dd>
</dl>
<p><b>Example:</b></p>
<div class="fragment"><div class="line"><span class="keywordtype">bool</span> is_mod = <a class="code hl_function" href="classdpp_1_1permission.html#acaf85c0093795893cb9269aad04c2c22">permission</a>.can(<a class="code hl_enumvalue" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7ae57cb8bf1870f74f2820f84255ca8104">dpp::p_kick_members</a>, <a class="code hl_enumvalue" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a6c9849fc7380edaf4ab8f169c2f4cc82">dpp::p_ban_members</a>);</div>
<div class="line"><span class="comment">// Returns true if it has permission to p_kick_members and p_ban_members</span></div>
<div class="ttc" id="anamespacedpp_html_a64f16cd622b3a09ae96803ba07fa75b7a6c9849fc7380edaf4ab8f169c2f4cc82"><div class="ttname"><a href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a6c9849fc7380edaf4ab8f169c2f4cc82">dpp::p_ban_members</a></div><div class="ttdeci">@ p_ban_members</div><div class="ttdoc">allows banning members</div><div class="ttdef"><b>Definition:</b> permissions.h:35</div></div>
<div class="ttc" id="anamespacedpp_html_a64f16cd622b3a09ae96803ba07fa75b7ae57cb8bf1870f74f2820f84255ca8104"><div class="ttname"><a href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7ae57cb8bf1870f74f2820f84255ca8104">dpp::p_kick_members</a></div><div class="ttdeci">@ p_kick_members</div><div class="ttdoc">allows kicking members</div><div class="ttdef"><b>Definition:</b> permissions.h:34</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>bool True if it has <b>all</b> the given permissions or <a class="el" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a43f62c967b9b16b49c315a0b23f86039" title="allows all permissions and bypasses channel permission overwrites">dpp::p_administrator</a> </dd></dl>

</div>
</div>
<a id="a8be0645f95287dc48d68591274722931" name="a8be0645f95287dc48d68591274722931"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8be0645f95287dc48d68591274722931">&#9670;&nbsp;</a></span>can_any()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool dpp::permission::can_any </td>
<td>(</td>
<td class="paramtype">T...&#160;</td>
<td class="paramname"><em>values</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Check for certain permissions, taking into account administrator privileges. It uses the Bitwise AND operator. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>one or more uint64_t permission bits </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">values</td><td>The permissions (from <a class="el" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7" title="Represents the various discord permissions.">dpp::permissions</a>) to check for</td></tr>
</table>
</dd>
</dl>
<p><b>Example:</b></p>
<div class="fragment"><div class="line"><span class="keywordtype">bool</span> is_mod = <a class="code hl_function" href="classdpp_1_1permission.html#acaf85c0093795893cb9269aad04c2c22">permission</a>.can_any(<a class="code hl_enumvalue" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7ae57cb8bf1870f74f2820f84255ca8104">dpp::p_kick_members</a>, <a class="code hl_enumvalue" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a6c9849fc7380edaf4ab8f169c2f4cc82">dpp::p_ban_members</a>);</div>
<div class="line"><span class="comment">// Returns true if it has permission to p_kick_members or p_ban_members</span></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>bool True if it has <b>any</b> of the given permissions or <a class="el" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a43f62c967b9b16b49c315a0b23f86039" title="allows all permissions and bypasses channel permission overwrites">dpp::p_administrator</a> </dd></dl>

</div>
</div>
<a id="a02df5786b6ca1d11bbd24a175e3e28c4" name="a02df5786b6ca1d11bbd24a175e3e28c4"></a>
Expand Down Expand Up @@ -316,9 +418,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a02df5786b6ca1d11bbd24a17
<p><b>Example:</b></p>
<div class="fragment"><div class="line"><span class="keywordtype">bool</span> is_mod = <a class="code hl_function" href="classdpp_1_1permission.html#acaf85c0093795893cb9269aad04c2c22">permission</a>.has(<a class="code hl_enumvalue" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7ae57cb8bf1870f74f2820f84255ca8104">dpp::p_kick_members</a>, <a class="code hl_enumvalue" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a6c9849fc7380edaf4ab8f169c2f4cc82">dpp::p_ban_members</a>);</div>
<div class="line"><span class="comment">// Returns true if the permission bitmask contains p_kick_members and p_ban_members</span></div>
<div class="ttc" id="anamespacedpp_html_a64f16cd622b3a09ae96803ba07fa75b7a6c9849fc7380edaf4ab8f169c2f4cc82"><div class="ttname"><a href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a6c9849fc7380edaf4ab8f169c2f4cc82">dpp::p_ban_members</a></div><div class="ttdeci">@ p_ban_members</div><div class="ttdoc">allows banning members</div><div class="ttdef"><b>Definition:</b> permissions.h:35</div></div>
<div class="ttc" id="anamespacedpp_html_a64f16cd622b3a09ae96803ba07fa75b7ae57cb8bf1870f74f2820f84255ca8104"><div class="ttname"><a href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7ae57cb8bf1870f74f2820f84255ca8104">dpp::p_kick_members</a></div><div class="ttdeci">@ p_kick_members</div><div class="ttdoc">allows kicking members</div><div class="ttdef"><b>Definition:</b> permissions.h:34</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>bool True if it has all the given permissions </dd></dl>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>bool True if it has <b>all</b> the given permissions </dd></dl>

</div>
</div>
Expand Down Expand Up @@ -365,7 +465,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab1485fc23cfccaabefa7117f
<div class="fragment"><div class="line"><span class="keywordtype">bool</span> is_mod = <a class="code hl_function" href="classdpp_1_1permission.html#acaf85c0093795893cb9269aad04c2c22">permission</a>.has_any(<a class="code hl_enumvalue" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a43f62c967b9b16b49c315a0b23f86039">dpp::p_administrator</a>, <a class="code hl_enumvalue" href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a6c9849fc7380edaf4ab8f169c2f4cc82">dpp::p_ban_members</a>);</div>
<div class="line"><span class="comment">// Returns true if the permission bitmask contains p_administrator or p_ban_members</span></div>
<div class="ttc" id="anamespacedpp_html_a64f16cd622b3a09ae96803ba07fa75b7a43f62c967b9b16b49c315a0b23f86039"><div class="ttname"><a href="namespacedpp.html#a64f16cd622b3a09ae96803ba07fa75b7a43f62c967b9b16b49c315a0b23f86039">dpp::p_administrator</a></div><div class="ttdeci">@ p_administrator</div><div class="ttdoc">allows all permissions and bypasses channel permission overwrites</div><div class="ttdef"><b>Definition:</b> permissions.h:36</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>bool True if it has any the given permissions </dd></dl>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>bool True if it has <b>any</b> of the given permissions </dd></dl>

</div>
</div>
Expand Down Expand Up @@ -497,7 +597,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9d55819ed11502a41b4d686e
</table>
</div><div class="memdoc">

<p>Assign a permission. This will reset the bitmask to the new value. </p>
<p>Assign permissions. This will reset the bitmask to the new value. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>one or more uint64_t permission bits </td></tr>
Expand Down
2 changes: 2 additions & 0 deletions classdpp_1_1permission.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ var classdpp_1_1permission =
[ "permission", "classdpp_1_1permission.html#acaf85c0093795893cb9269aad04c2c22", null ],
[ "permission", "classdpp_1_1permission.html#a75b4a65df5c6f817bd64d81d6856a39e", null ],
[ "add", "classdpp_1_1permission.html#abc2e0b7597ec5b049c0e6a78e1fdab42", null ],
[ "can", "classdpp_1_1permission.html#adc6228f57c04d9ad60df458c4a7e76bb", null ],
[ "can_any", "classdpp_1_1permission.html#a8be0645f95287dc48d68591274722931", null ],
[ "has", "classdpp_1_1permission.html#a02df5786b6ca1d11bbd24a175e3e28c4", null ],
[ "has_any", "classdpp_1_1permission.html#ab1485fc23cfccaabefa7117f10487a40", null ],
[ "operator uint64_t", "classdpp_1_1permission.html#a441f6fda65df915de06aee70859e427c", null ],
Expand Down
Loading

0 comments on commit 538d658

Please sign in to comment.