diff options
| author | 2022-12-12 18:11:20 +0000 | |
|---|---|---|
| committer | 2022-12-12 18:11:20 +0000 | |
| commit | 0a068679f4c82a66c514c69ab1a7a569a736ed0f (patch) | |
| tree | a9abd963940903728237ebf90bf3ea8aa8c23689 /main/output/pydis_core.utils.channel.html | |
| parent | Deploying to docs from @ python-discord/bot-core@3d53d05329b4c3b75909888986c9... (diff) | |
Deploying to docs from @ python-discord/bot-core@9c728dff2351a0170b372fec76e2b5e15f8846f3 🚀
Diffstat (limited to 'main/output/pydis_core.utils.channel.html')
| -rw-r--r-- | main/output/pydis_core.utils.channel.html | 40 | 
1 files changed, 21 insertions, 19 deletions
diff --git a/main/output/pydis_core.utils.channel.html b/main/output/pydis_core.utils.channel.html index b9738eaf..f7824751 100644 --- a/main/output/pydis_core.utils.channel.html +++ b/main/output/pydis_core.utils.channel.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="commands" href="pydis_core.utils.commands.html" /><link rel="prev" title="caching" href="pydis_core.utils.caching.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"/> -        <title>channel - Pydis Core Latest (9.1.1)</title> +    <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>channel - Pydis Core Latest (9.2.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" /> @@ -127,7 +127,7 @@        </label>      </div>      <div class="header-center"> -      <a href="../index.html"><div class="brand">Pydis Core Latest (9.1.1)</div></a> +      <a href="../index.html"><div class="brand">Pydis Core Latest (9.2.0)</div></a>      </div>      <div class="header-right">        <div class="theme-toggle-container theme-toggle-header"> @@ -153,10 +153,10 @@      <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/>    </div> -  <span class="sidebar-brand-text">Pydis Core Latest (9.1.1)</span> +  <span class="sidebar-brand-text">Pydis Core Latest (9.2.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> @@ -210,6 +210,10 @@                      </li>                      <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v9.1.1/output/pydis_core.utils.channel.html">v9.1.1</a> +                    </li> +                 +                    <li class="toctree-l2 ">                          <a class="version_link reference internal" href="../../v9.0.0/output/pydis_core.utils.channel.html">v9.0.0</a>                      </li> @@ -353,25 +357,25 @@  <p>Useful helper functions for interacting with various discord channel objects.</p>  <dl class="py function">  <dt class="sig sig-object py" id="pydis_core.utils.channel.get_or_fetch_channel"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/3d53d05329b4c3b75909888986c98b3d6fc49b20/pydis_core/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.get_or_fetch_channel" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9c728dff2351a0170b372fec76e2b5e15f8846f3/pydis_core/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.get_or_fetch_channel" title="Permalink to this definition">#</a></dt>  <dd><p>Attempt to get or fetch the given <code class="docutils literal notranslate"><span class="pre">channel_id</span></code> from the bots cache, and return it.</p>  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt>  <dd class="field-odd"><ul class="simple"> -<li><p><strong>bot</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.2.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code></a> instance to use for getting/fetching.</p></li> +<li><p><strong>bot</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.2.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.2.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code></a> instance to use for getting/fetching.</p></li>  <li><p><strong>channel_id</strong> (<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>) – The channel to get/fetch.</p></li>  </ul>  </dd>  <dt class="field-even">Raises<span class="colon">:</span></dt>  <dd class="field-even"><ul class="simple"> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.2.0)"><strong>discord.InvalidData</strong></a> – An unknown channel type was received from Discord.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.HTTPException" title="(in discord.py v2.2.0)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.2.0)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.2.0)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.2.0a)"><strong>discord.InvalidData</strong></a> – An unknown channel type was received from Discord.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.HTTPException" title="(in discord.py v2.2.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.2.0a)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.2.0a)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li>  </ul>  </dd>  <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a></p> +<dd class="field-odd"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.2.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a></p>  </dd>  <dt class="field-even">Returns<span class="colon">:</span></dt>  <dd class="field-even"><p>The channel from the ID.</p> @@ -381,12 +385,12 @@  <dl class="py function">  <dt class="sig sig-object py" id="pydis_core.utils.channel.is_in_category"> -<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/3d53d05329b4c3b75909888986c98b3d6fc49b20/pydis_core/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.is_in_category" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9c728dff2351a0170b372fec76e2b5e15f8846f3/pydis_core/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.is_in_category" title="Permalink to this definition">#</a></dt>  <dd><p>Return whether the given <code class="docutils literal notranslate"><span class="pre">channel</span></code> in the the category with the id <code class="docutils literal notranslate"><span class="pre">category_id</span></code>.</p>  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt>  <dd class="field-odd"><ul class="simple"> -<li><p><strong>channel</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a>) – The channel to check.</p></li> +<li><p><strong>channel</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.2.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a>) – The channel to check.</p></li>  <li><p><strong>category_id</strong> (<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>) – The category to check for.</p></li>  </ul>  </dd> @@ -438,9 +442,7 @@            </div>            <div class="right-details"> -            <div class="icons"> -               -            </div> +                        </div>          </div>  |