diff options
| author | 2022-12-12 18:11:20 +0000 | |
|---|---|---|
| committer | 2022-12-12 18:11:20 +0000 | |
| commit | 0a068679f4c82a66c514c69ab1a7a569a736ed0f (patch) | |
| tree | a9abd963940903728237ebf90bf3ea8aa8c23689 /v9.0.0/output/pydis_core.utils.interactions.html | |
| parent | Deploying to docs from @ python-discord/bot-core@3d53d05329b4c3b75909888986c9... (diff) | |
Deploying to docs from @ python-discord/bot-core@9c728dff2351a0170b372fec76e2b5e15f8846f3 🚀
Diffstat (limited to 'v9.0.0/output/pydis_core.utils.interactions.html')
| -rw-r--r-- | v9.0.0/output/pydis_core.utils.interactions.html | 24 | 
1 files changed, 13 insertions, 11 deletions
| diff --git a/v9.0.0/output/pydis_core.utils.interactions.html b/v9.0.0/output/pydis_core.utils.interactions.html index 1ebbcc81..7cd53e4c 100644 --- a/v9.0.0/output/pydis_core.utils.interactions.html +++ b/v9.0.0/output/pydis_core.utils.interactions.html @@ -5,14 +5,14 @@      <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />  <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="logging" href="pydis_core.utils.logging.html" /><link rel="prev" title="function" href="pydis_core.utils.function.html" /> -    <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/> +    <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 5.3.0 and Furo 2022.12.07 -->          <title>interactions - Pydis Core v9.0.0</title>        <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> -    <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" /> +    <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />      <link rel="stylesheet" type="text/css" href="../_static/logo.css" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css" />      <link rel="stylesheet" type="text/css" href="../_static/index.css" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css" /> @@ -156,7 +156,7 @@    <span class="sidebar-brand-text">Pydis Core v9.0.0</span>  </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> -  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> +  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">    <input type="hidden" name="check_keywords" value="yes">    <input type="hidden" name="area" value="default">  </form> @@ -209,6 +209,10 @@                          <a class="version_link reference internal" href="../../main/output/pydis_core.utils.interactions.html">main</a>                      </li> +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v9.1.1/output/pydis_core.utils.interactions.html">v9.1.1</a> +                    </li> +                                      <li class="toctree-l2 current-page">                          <a class="version_link reference internal" href="pydis_core.utils.interactions.html">v9.0.0</a>                      </li> @@ -353,7 +357,7 @@  <dl class="py class">  <dt class="sig sig-object py" id="pydis_core.utils.interactions.DeleteMessageButton">  <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DeleteMessageButton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/3f55e7149a3197b7fa41fcf7dc7df47a3a209cfd/pydis_core/utils/interactions.py#L73-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton" title="Permalink to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.Button" title="(in discord.py v2.2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Button</span></code></a></p> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.Button" title="(in discord.py v2.2.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Button</span></code></a></p>  <p>A button that can be added to a view to delete the message containing the view on click.</p>  <p>This button itself carries out no interaction checks, these should be done by the parent view.</p>  <p>See <a class="reference internal" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="pydis_core.utils.interactions.ViewWithUserAndRoleCheck"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.interactions.ViewWithUserAndRoleCheck</span></code></a> for a view that implements basic checks.</p> @@ -386,7 +390,7 @@  <dl class="py class">  <dt class="sig sig-object py" id="pydis_core.utils.interactions.ViewWithUserAndRoleCheck">  <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ViewWithUserAndRoleCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</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></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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/3f55e7149a3197b7fa41fcf7dc7df47a3a209cfd/pydis_core/utils/interactions.py#L11-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="Permalink to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.View" title="(in discord.py v2.2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">View</span></code></a></p> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.View" title="(in discord.py v2.2.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">View</span></code></a></p>  <p>A view that allows the original invoker and moderators to interact with it.</p>  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -395,7 +399,7 @@  <li><p><strong>allowed_roles</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]) – A sequence of role ids that are allowed to interact with the view.</p></li>  <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>]) – Timeout in seconds from last interaction with the UI before no longer accepting input.  If <code class="docutils literal notranslate"><span class="pre">None</span></code> then there is no timeout.</p></li> -<li><p><strong>message</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a>]) – The message to remove the view from on timeout. This can also be set with +<li><p><strong>message</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.2.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a>]) – The message to remove the view from on timeout. This can also be set with  <code class="docutils literal notranslate"><span class="pre">view.message</span> <span class="pre">=</span> <span class="pre">await</span> <span class="pre">ctx.send(</span> <span class="pre">...</span> <span class="pre">)`</span></code> , or similar, after the view is instantiated.</p></li>  </ul>  </dd> @@ -411,7 +415,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod  <dd><p>Ensure the user clicking the button is the view invoker, or a moderator.</p>  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>interaction</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.Interaction" title="(in discord.py v2.2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interaction</span></code></a>) – The interaction that occurred.</p> +<dd class="field-odd"><p><strong>interaction</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.Interaction" title="(in discord.py v2.2.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interaction</span></code></a>) – The interaction that occurred.</p>  </dd>  <dt class="field-even">Return type<span class="colon">:</span></dt>  <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></p> @@ -471,9 +475,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod            </div>            <div class="right-details"> -            <div class="icons"> -               -            </div> +                        </div>          </div> | 
