216 lines
		
	
	
		
			19 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			216 lines
		
	
	
		
			19 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| <!DOCTYPE html>
 | |
| <html class="writer-html5" lang="en" >
 | |
| <head>
 | |
|   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 | |
| 
 | |
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 | |
|   <title>Discord reference — Common Python Library  documentation</title>
 | |
|       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 | |
|       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
 | |
|   <!--[if lt IE 9]>
 | |
|     <script src="_static/js/html5shiv.min.js"></script>
 | |
|   <![endif]-->
 | |
|   
 | |
|         <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
 | |
|         <script src="_static/jquery.js"></script>
 | |
|         <script src="_static/underscore.js"></script>
 | |
|         <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
 | |
|         <script src="_static/doctools.js"></script>
 | |
|     <script src="_static/js/theme.js"></script>
 | |
|     <link rel="index" title="Index" href="genindex.html" />
 | |
|     <link rel="search" title="Search" href="search.html" />
 | |
|     <link rel="next" title="cpl_discord.application" href="cpl_discord.application.html" />
 | |
|     <link rel="prev" title="cpl_core.utils" href="cpl_core.utils.html" /> 
 | |
| </head>
 | |
| 
 | |
| <body class="wy-body-for-nav"> 
 | |
|   <div class="wy-grid-for-nav">
 | |
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
 | |
|       <div class="wy-side-scroll">
 | |
|         <div class="wy-side-nav-search" >
 | |
|             <a href="index.html" class="icon icon-home"> Common Python Library
 | |
|           </a>
 | |
| <div role="search">
 | |
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
 | |
|     <input type="text" name="q" placeholder="Search docs" />
 | |
|     <input type="hidden" name="check_keywords" value="yes" />
 | |
|     <input type="hidden" name="area" value="default" />
 | |
|   </form>
 | |
| </div>
 | |
|         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
 | |
|               <ul class="current">
 | |
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
 | |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Discord reference</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
 | |
| </ul>
 | |
| 
 | |
|         </div>
 | |
|       </div>
 | |
|     </nav>
 | |
| 
 | |
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
 | |
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 | |
|           <a href="index.html">Common Python Library</a>
 | |
|       </nav>
 | |
| 
 | |
|       <div class="wy-nav-content">
 | |
|         <div class="rst-content">
 | |
|           <div role="navigation" aria-label="Page navigation">
 | |
|   <ul class="wy-breadcrumbs">
 | |
|       <li><a href="index.html" class="icon icon-home"></a> »</li>
 | |
|       <li>Discord reference</li>
 | |
|       <li class="wy-breadcrumbs-aside">
 | |
|             <a href="_sources/cpl_discord.rst.txt" rel="nofollow"> View page source</a>
 | |
|       </li>
 | |
|   </ul>
 | |
|   <hr/>
 | |
| </div>
 | |
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 | |
|            <div itemprop="articleBody">
 | |
|              
 | |
|   <section id="discord-reference">
 | |
| <h1>Discord reference<a class="headerlink" href="#discord-reference" title="Permalink to this heading"></a></h1>
 | |
| <div class="toctree-wrapper compound">
 | |
| <ul>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html#module-cpl_discord.application.discord_bot_application_abc">cpl_discord.application.discord_bot_application_abc</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html#module-cpl_discord.command.discord_command_abc">cpl_discord.command.discord_command_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html#module-cpl_discord.command.discord_commands_meta">cpl_discord.command.discord_commands_meta</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html#module-cpl_discord.configuration.discord_bot_settings">cpl_discord.configuration.discord_bot_settings</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.category_channel">cpl_discord.container.category_channel</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.container">cpl_discord.container.container</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.guild">cpl_discord.container.guild</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.member">cpl_discord.container.member</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.role">cpl_discord.container.role</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.text_channel">cpl_discord.container.text_channel</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.thread">cpl_discord.container.thread</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.voice_channel">cpl_discord.container.voice_channel</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_bulk_message_delete_abc">cpl_discord.events.on_bulk_message_delete_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_command_abc">cpl_discord.events.on_command_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_command_completion_abc">cpl_discord.events.on_command_completion_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_command_error_abc">cpl_discord.events.on_command_error_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_connect_abc">cpl_discord.events.on_connect_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_disconnect_abc">cpl_discord.events.on_disconnect_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_error_abc">cpl_discord.events.on_error_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_group_join_abc">cpl_discord.events.on_group_join_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_group_remove_abc">cpl_discord.events.on_group_remove_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_available_abc">cpl_discord.events.on_guild_available_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_channel_create_abc">cpl_discord.events.on_guild_channel_create_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_channel_delete_abc">cpl_discord.events.on_guild_channel_delete_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_channel_pins_update_abc">cpl_discord.events.on_guild_channel_pins_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_channel_update_abc">cpl_discord.events.on_guild_channel_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_emojis_update_abc">cpl_discord.events.on_guild_emojis_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_integrations_update_abc">cpl_discord.events.on_guild_integrations_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_join_abc">cpl_discord.events.on_guild_join_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_remove_abc">cpl_discord.events.on_guild_remove_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_role_create_abc">cpl_discord.events.on_guild_role_create_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_role_delete_abc">cpl_discord.events.on_guild_role_delete_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_role_update_abc">cpl_discord.events.on_guild_role_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_unavailable_abc">cpl_discord.events.on_guild_unavailable_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_update_abc">cpl_discord.events.on_guild_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_invite_create_abc">cpl_discord.events.on_invite_create_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_invite_delete_abc">cpl_discord.events.on_invite_delete_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_ban_abc">cpl_discord.events.on_member_ban_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_join_abc">cpl_discord.events.on_member_join_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_remove_abc">cpl_discord.events.on_member_remove_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_unban_abc">cpl_discord.events.on_member_unban_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_update_abc">cpl_discord.events.on_member_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_message_abc">cpl_discord.events.on_message_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_message_delete_abc">cpl_discord.events.on_message_delete_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_message_edit_abc">cpl_discord.events.on_message_edit_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_private_channel_create_abc">cpl_discord.events.on_private_channel_create_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_private_channel_delete_abc">cpl_discord.events.on_private_channel_delete_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_private_channel_pins_update_abc">cpl_discord.events.on_private_channel_pins_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_private_channel_update_abc">cpl_discord.events.on_private_channel_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_raw_reaction_add_abc">cpl_discord.events.on_raw_reaction_add_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_raw_reaction_clear_abc">cpl_discord.events.on_raw_reaction_clear_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_raw_reaction_clear_emoji_abc">cpl_discord.events.on_raw_reaction_clear_emoji_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_raw_reaction_remove_abc">cpl_discord.events.on_raw_reaction_remove_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_reaction_add_abc">cpl_discord.events.on_reaction_add_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_reaction_clear_abc">cpl_discord.events.on_reaction_clear_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_reaction_clear_emoji_abc">cpl_discord.events.on_reaction_clear_emoji_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_reaction_remove_abc">cpl_discord.events.on_reaction_remove_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_ready_abc">cpl_discord.events.on_ready_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_resume_abc">cpl_discord.events.on_resume_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_typing_abc">cpl_discord.events.on_typing_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_user_update_abc">cpl_discord.events.on_user_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_voice_state_update_abc">cpl_discord.events.on_voice_state_update_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_webhooks_update_abc">cpl_discord.events.on_webhooks_update_abc</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html#module-cpl_discord.helper.to_containers_converter">cpl_discord.helper.to_containers_converter</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.command_error_handler_service">cpl_discord.service.command_error_handler_service</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_bot_service">cpl_discord.service.discord_bot_service</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_bot_service_abc">cpl_discord.service.discord_bot_service_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_collection">cpl_discord.service.discord_collection</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_collection_abc">cpl_discord.service.discord_collection_abc</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_service">cpl_discord.service.discord_service</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_service_abc">cpl_discord.service.discord_service_abc</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| </ul>
 | |
| </div>
 | |
| </section>
 | |
| 
 | |
| 
 | |
|            </div>
 | |
|           </div>
 | |
|           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
 | |
|         <a href="cpl_core.utils.html" class="btn btn-neutral float-left" title="cpl_core.utils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
 | |
|         <a href="cpl_discord.application.html" class="btn btn-neutral float-right" title="cpl_discord.application" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
 | |
|     </div>
 | |
| 
 | |
|   <hr/>
 | |
| 
 | |
|   <div role="contentinfo">
 | |
|     <p>© Copyright 2021 - 2023, Sven Heidemann.</p>
 | |
|   </div>
 | |
| 
 | |
|   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
 | |
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
 | |
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 | |
|    
 | |
| 
 | |
| </footer>
 | |
|         </div>
 | |
|       </div>
 | |
|     </section>
 | |
|   </div>
 | |
|   <script>
 | |
|       jQuery(function () {
 | |
|           SphinxRtdTheme.Navigation.enable(true);
 | |
|       });
 | |
|   </script> 
 | |
| 
 | |
| </body>
 | |
| </html> |