aboutsummaryrefslogtreecommitdiffstats
path: root/main/output/pydis_core.utils.messages.html
diff options
context:
space:
mode:
authorGravatar ChrisLovering <[email protected]>2024-03-04 14:53:52 +0000
committerGravatar ChrisLovering <[email protected]>2024-03-04 14:53:52 +0000
commit3eb5ff4e3f0a841d28d8c742eba2e562f9fc2231 (patch)
treecc57ad52e9e9efb2ab82c0bd8596522ace108556 /main/output/pydis_core.utils.messages.html
parentDeploying to docs from @ python-discord/bot-core@69eeda8a1914b671af68871dcf55... (diff)
Deploying to docs from @ python-discord/bot-core@c72b515aec03b1d9df49a3d58bfa90a3d864160e 🚀
Diffstat (limited to 'main/output/pydis_core.utils.messages.html')
-rw-r--r--main/output/pydis_core.utils.messages.html82
1 files changed, 1 insertions, 81 deletions
diff --git a/main/output/pydis_core.utils.messages.html b/main/output/pydis_core.utils.messages.html
index 01929335..705d637a 100644
--- a/main/output/pydis_core.utils.messages.html
+++ b/main/output/pydis_core.utils.messages.html
@@ -280,86 +280,6 @@
</li>
<li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.3.0-beta/index.html">v8.3.0-beta</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.2.1/index.html">v8.2.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.2.0/index.html">v8.2.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.1.0/index.html">v8.1.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.3/index.html">v8.0.0-beta.3</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.2/index.html">v8.0.0-beta.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.1/index.html">v8.0.0-beta.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0/index.html">v8.0.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.5.0/index.html">v7.5.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.4.0-beta1/index.html">v7.4.0-beta1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.4.0/index.html">v7.4.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.3.1/index.html">v7.3.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.3.0/index.html">v7.3.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.2/index.html">v7.2.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.1/index.html">v7.2.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.0/index.html">v7.2.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.3/index.html">v7.1.3</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.2/index.html">v7.1.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.1/index.html">v7.1.1</a>
- </li>
-
- <li class="toctree-l2 ">
<a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.messages.html">v10.7.0</a>
</li>
@@ -454,7 +374,7 @@
<span id="messages"></span><h1>messages<a class="headerlink" href="#module-pydis_core.utils.messages" title="Link to this heading">#</a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="pydis_core.utils.messages.reaction_check">
-<span class="sig-name descname"><span class="pre">reaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_emoji</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/messages.py#L11-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.messages.reaction_check" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">reaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_emoji</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/messages.py#L11-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.messages.reaction_check" title="Link to this definition">#</a></dt>
<dd><p>Check if a reaction’s emoji and author are allowed and the message is <cite>message_id</cite>.</p>
<p>If the user is not allowed, remove the reaction. Ignore reactions made by the bot.
If <cite>allow_mods</cite> is True, allow users with moderator roles even if they’re not in <cite>allowed_users</cite>.</p>