You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1178 lines
30 KiB
1178 lines
30 KiB
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>disco.state · Disco</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="GitBook 3.2.2">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/style.css">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-prism/prism.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-hints/plugin-hints.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="HandheldFriendly" content="true"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
|
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
|
|
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
|
|
|
|
|
|
<link rel="next" href="disco_cli.html" />
|
|
|
|
|
|
<link rel="prev" href="disco_client.html" />
|
|
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div class="book">
|
|
<div class="book-summary">
|
|
|
|
|
|
<div id="book-search-input" role="search">
|
|
<input type="text" placeholder="Type to search" />
|
|
</div>
|
|
|
|
|
|
<nav role="navigation">
|
|
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2" data-path="../installation.html">
|
|
|
|
<a href="../installation.html">
|
|
|
|
|
|
Installation and Setup
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" data-path="../bot_tutorial/intro.md">
|
|
|
|
<span>
|
|
|
|
|
|
Bot Tutorial
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.3.1" data-path="../bot_tutorial/first_steps.html">
|
|
|
|
<a href="../bot_tutorial/first_steps.html">
|
|
|
|
|
|
Creating and Running a Bot
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.2" data-path="../bot_tutorial/building_block_plugins.html">
|
|
|
|
<a href="../bot_tutorial/building_block_plugins.html">
|
|
|
|
|
|
Plugins
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.3" data-path="../bot_tutorial/building_block_commands.html">
|
|
|
|
<a href="../bot_tutorial/building_block_commands.html">
|
|
|
|
|
|
Commands
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.4" data-path="../bot_tutorial/building_block_listeners.html">
|
|
|
|
<a href="../bot_tutorial/building_block_listeners.html">
|
|
|
|
|
|
Listeners
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.5" data-path="../bot_tutorial/message_embeds.html">
|
|
|
|
<a href="../bot_tutorial/message_embeds.html">
|
|
|
|
|
|
Message Embeds
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.6" data-path="../bot_tutorial/advanced.html">
|
|
|
|
<a href="../bot_tutorial/advanced.html">
|
|
|
|
|
|
Advanced
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4" >
|
|
|
|
<span>
|
|
|
|
|
|
API Docs
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.1" data-path="disco_client.html">
|
|
|
|
<a href="disco_client.html">
|
|
|
|
|
|
disco.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="1.4.2" data-path="disco_state.html">
|
|
|
|
<a href="disco_state.html">
|
|
|
|
|
|
disco.state
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.3" data-path="disco_cli.html">
|
|
|
|
<a href="disco_cli.html">
|
|
|
|
|
|
disco.cli
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4" >
|
|
|
|
<span>
|
|
|
|
|
|
Bot
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.4.1" data-path="disco_bot_bot.html">
|
|
|
|
<a href="disco_bot_bot.html">
|
|
|
|
|
|
disco.bot.bot
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.2" data-path="disco_bot_plugin.html">
|
|
|
|
<a href="disco_bot_plugin.html">
|
|
|
|
|
|
disco.bot.plugin
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.3" data-path="disco_bot_command.html">
|
|
|
|
<a href="disco_bot_command.html">
|
|
|
|
|
|
disco.bot.command
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.4" data-path="disco_bot_storage.html">
|
|
|
|
<a href="disco_bot_storage.html">
|
|
|
|
|
|
disco.bot.storage
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4.5" data-path="disco_bot_parser.html">
|
|
|
|
<a href="disco_bot_parser.html">
|
|
|
|
|
|
disco.bot.parser
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5" >
|
|
|
|
<span>
|
|
|
|
|
|
API
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.5.1" data-path="disco_api_client.html">
|
|
|
|
<a href="disco_api_client.html">
|
|
|
|
|
|
disco.api.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5.2" data-path="disco_api_http.html">
|
|
|
|
<a href="disco_api_http.html">
|
|
|
|
|
|
disco.api.http
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5.3" data-path="disco_api_ratelimit.html">
|
|
|
|
<a href="disco_api_ratelimit.html">
|
|
|
|
|
|
disco.api.ratelimit
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6" >
|
|
|
|
<span>
|
|
|
|
|
|
Gateway
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.6.1" data-path="disco_gateway_client.html">
|
|
|
|
<a href="disco_gateway_client.html">
|
|
|
|
|
|
disco.gateway.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.2" data-path="disco_gateway_events.html">
|
|
|
|
<a href="disco_gateway_events.html">
|
|
|
|
|
|
disco.gateway.events
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.3" data-path="disco_gateway_packets.html">
|
|
|
|
<a href="disco_gateway_packets.html">
|
|
|
|
|
|
disco.gateway.packets
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.4" data-path="disco_gateway_sharder.html">
|
|
|
|
<a href="disco_gateway_sharder.html">
|
|
|
|
|
|
disco.gateway.sharder
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6.5" data-path="disco_gateway_ipc.html">
|
|
|
|
<a href="disco_gateway_ipc.html">
|
|
|
|
|
|
disco.gateway.ipc
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7" >
|
|
|
|
<span>
|
|
|
|
|
|
Types
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.7.1" data-path="disco_types_base.html">
|
|
|
|
<a href="disco_types_base.html">
|
|
|
|
|
|
disco.types.base
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.2" data-path="disco_types_channel.html">
|
|
|
|
<a href="disco_types_channel.html">
|
|
|
|
|
|
disco.types.channel
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.3" data-path="disco_types_guild.html">
|
|
|
|
<a href="disco_types_guild.html">
|
|
|
|
|
|
disco.types.guild
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.4" data-path="disco_types_invite.html">
|
|
|
|
<a href="disco_types_invite.html">
|
|
|
|
|
|
disco.types.invite
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.5" data-path="disco_types_message.html">
|
|
|
|
<a href="disco_types_message.html">
|
|
|
|
|
|
disco.types.message
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.6" data-path="disco_types_permissions.html">
|
|
|
|
<a href="disco_types_permissions.html">
|
|
|
|
|
|
disco.types.permissions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.7" data-path="disco_types_user.html">
|
|
|
|
<a href="disco_types_user.html">
|
|
|
|
|
|
disco.types.user
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.8" data-path="disco_types_voice.html">
|
|
|
|
<a href="disco_types_voice.html">
|
|
|
|
|
|
disco.types.voice
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.7.9" data-path="disco_types_webhook.html">
|
|
|
|
<a href="disco_types_webhook.html">
|
|
|
|
|
|
disco.types.webhook
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8" >
|
|
|
|
<span>
|
|
|
|
|
|
Util
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.8.1" data-path="disco_util.html">
|
|
|
|
<a href="disco_util.html">
|
|
|
|
|
|
disco.util
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.2" data-path="disco_util_backdoor.html">
|
|
|
|
<a href="disco_util_backdoor.html">
|
|
|
|
|
|
disco.util.backdoor
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.3" data-path="disco_util_chains.html">
|
|
|
|
<a href="disco_util_chains.html">
|
|
|
|
|
|
disco.util.chains
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.4" data-path="disco_util_config.html">
|
|
|
|
<a href="disco_util_config.html">
|
|
|
|
|
|
disco.util.config
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.5" data-path="disco_util_functional.html">
|
|
|
|
<a href="disco_util_functional.html">
|
|
|
|
|
|
disco.util.functional
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.6" data-path="disco_util_hashmap.html">
|
|
|
|
<a href="disco_util_hashmap.html">
|
|
|
|
|
|
disco.util.hashmap
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.7" data-path="disco_util_limiter.html">
|
|
|
|
<a href="disco_util_limiter.html">
|
|
|
|
|
|
disco.util.limiter
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.8" data-path="disco_util_logging.html">
|
|
|
|
<a href="disco_util_logging.html">
|
|
|
|
|
|
disco.util.logging
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.9" data-path="disco_util_sanitize.html">
|
|
|
|
<a href="disco_util_sanitize.html">
|
|
|
|
|
|
disco.util.sanitize
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.10" data-path="disco_util_snowflake.html">
|
|
|
|
<a href="disco_util_snowflake.html">
|
|
|
|
|
|
disco.util.snowflake
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.11" data-path="disco_util_token.html">
|
|
|
|
<a href="disco_util_token.html">
|
|
|
|
|
|
disco.util.token
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.8.12" data-path="disco_util_websocket.html">
|
|
|
|
<a href="disco_util_websocket.html">
|
|
|
|
|
|
disco.util.websocket
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9" >
|
|
|
|
<span>
|
|
|
|
|
|
Voice
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.9.1" data-path="disco_voice_client.html">
|
|
|
|
<a href="disco_voice_client.html">
|
|
|
|
|
|
disco.voice.client
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.2" data-path="disco_voice_opus.html">
|
|
|
|
<a href="disco_voice_opus.html">
|
|
|
|
|
|
disco.voice.opus
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.3" data-path="disco_voice_packets.html">
|
|
|
|
<a href="disco_voice_packets.html">
|
|
|
|
|
|
disco.voice.packets
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.4" data-path="disco_voice_playable.html">
|
|
|
|
<a href="disco_voice_playable.html">
|
|
|
|
|
|
disco.voice.playable
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.9.5" data-path="disco_voice_player.html">
|
|
|
|
<a href="disco_voice_player.html">
|
|
|
|
|
|
disco.voice.player
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
<li>
|
|
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
|
|
Published with GitBook
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href=".." >disco.state</a>
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="page-wrapper" tabindex="-1" role="main">
|
|
<div class="page-inner">
|
|
|
|
<div id="book-search-results">
|
|
<div class="search-noresults">
|
|
|
|
<section class="normal markdown-section">
|
|
|
|
<h1 id="discostate">disco.state</h1>
|
|
<h2 id="classes">Classes</h2>
|
|
<h3 id="stackmessage">StackMessage</h3>
|
|
<p><em>Inherits From <code>namedtuple</code></em></p>
|
|
<p>A message stored on a stack inside of the state object, used for tracking
|
|
previously sent messages in channels.</p>
|
|
<h5 id="attributes">Attributes</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>id</td>
|
|
<td><code>snowflake</code></td>
|
|
<td>the id of the message</td>
|
|
</tr>
|
|
<tr>
|
|
<td>channel_id</td>
|
|
<td><code>snowflake</code></td>
|
|
<td>the id of the channel this message was sent in</td>
|
|
</tr>
|
|
<tr>
|
|
<td>author_id</td>
|
|
<td><code>snowflake</code></td>
|
|
<td>the id of the author of this message</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="stateconfig">StateConfig</h3>
|
|
<p><em>Inherits From <code>Config</code></em></p>
|
|
<p>A configuration object for determining how the State tracking behaves.</p>
|
|
<h5 id="attributes">Attributes</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>track_messages</td>
|
|
<td><code>bool</code></td>
|
|
<td>Whether the state store should keep a buffer of previously sent messages. Message tracking allows for multiple higher-level shortcuts and can be highly useful when developing bots that need to delete their own messages. Message tracking is implemented using a deque and a namedtuple, meaning it should generally not have a high impact on memory, however users who find they do not need and may be experiencing memory pressure can disable this feature entirely using this attribute.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>track_messages_size</td>
|
|
<td><code>int</code></td>
|
|
<td>The size of the messages deque for each channel. This value can be used to calculate the total number of possible `StackMessage` objects kept in memory, simply: `total_messages_size * total_channels`. This value can be tweaked based on usage and to help prevent memory pressure.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>sync_guild_members</td>
|
|
<td><code>bool</code></td>
|
|
<td>If true, guilds will be automatically synced when they are initially loaded or joined. Generally this setting is OK for smaller bots, however bots in over 50 guilds will notice this operation can take a while to complete.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="state">State</h3>
|
|
<p>The State class is used to track global state based on events emitted from
|
|
the <code>GatewayClient</code>. State tracking is a core component of the Disco client,
|
|
providing the mechanism for most of the higher-level utility functions.</p>
|
|
<h5 id="attributes">Attributes</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>EVENTS</td>
|
|
<td><code>list(str)</code></td>
|
|
<td>A list of all events the State object binds to</td>
|
|
</tr>
|
|
<tr>
|
|
<td>client</td>
|
|
<td><code>`disco.client.Client`</code></td>
|
|
<td>The Client instance this state is attached to</td>
|
|
</tr>
|
|
<tr>
|
|
<td>config</td>
|
|
<td><code>`StateConfig`</code></td>
|
|
<td>The configuration for this state instance</td>
|
|
</tr>
|
|
<tr>
|
|
<td>me</td>
|
|
<td><code>`User`</code></td>
|
|
<td>The currently logged in user</td>
|
|
</tr>
|
|
<tr>
|
|
<td>dms</td>
|
|
<td><code>dict(snowflake, `Channel`)</code></td>
|
|
<td>Mapping of all known DM Channels</td>
|
|
</tr>
|
|
<tr>
|
|
<td>guilds</td>
|
|
<td><code>dict(snowflake, `Guild`)</code></td>
|
|
<td>Mapping of all known/loaded Guilds</td>
|
|
</tr>
|
|
<tr>
|
|
<td>channels</td>
|
|
<td><code>dict(snowflake, `Channel`)</code></td>
|
|
<td>Weak mapping of all known/loaded Channels</td>
|
|
</tr>
|
|
<tr>
|
|
<td>users</td>
|
|
<td><code>dict(snowflake, `User`)</code></td>
|
|
<td>Weak mapping of all known/loaded Users</td>
|
|
</tr>
|
|
<tr>
|
|
<td>voice_states</td>
|
|
<td><code>dict(str, `VoiceState`)</code></td>
|
|
<td>Weak mapping of all known/active Voice States</td>
|
|
</tr>
|
|
<tr>
|
|
<td>messages</td>
|
|
<td><code>Optional[dict(snowflake, deque)]</code></td>
|
|
<td>Mapping of channel ids to deques containing `StackMessage` objects</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="functions">Functions</h4>
|
|
<h4 id="initself-client-config"><strong>init</strong>(<code>self, client, config)</code></h4>
|
|
<h4 id="unbindself">unbind(<code>self</code>)</h4>
|
|
<p>Unbinds all bound event listeners for this state object.</p>
|
|
<h4 id="bindself">bind(<code>self</code>)</h4>
|
|
<p>Binds all events for this state object, storing the listeners for later</p>
|
|
<h4 id="fillmessagesself-channel">fill_messages(<code>self, channel)</code></h4>
|
|
<h4 id="onreadyself-event">on_ready(<code>self, event)</code></h4>
|
|
<h4 id="onmessagecreateself-event">on_message_create(<code>self, event)</code></h4>
|
|
<h4 id="onmessagedeleteself-event">on_message_delete(<code>self, event)</code></h4>
|
|
<h4 id="onmessagedeletebulkself-event">on_message_delete_bulk(<code>self, event)</code></h4>
|
|
<h4 id="onguildcreateself-event">on_guild_create(<code>self, event)</code></h4>
|
|
<h4 id="onguildupdateself-event">on_guild_update(<code>self, event)</code></h4>
|
|
<h4 id="onguilddeleteself-event">on_guild_delete(<code>self, event)</code></h4>
|
|
<h4 id="onchannelcreateself-event">on_channel_create(<code>self, event)</code></h4>
|
|
<h4 id="onchannelupdateself-event">on_channel_update(<code>self, event)</code></h4>
|
|
<h4 id="onchanneldeleteself-event">on_channel_delete(<code>self, event)</code></h4>
|
|
<h4 id="onvoicestateupdateself-event">on_voice_state_update(<code>self, event)</code></h4>
|
|
<h4 id="onguildmemberaddself-event">on_guild_member_add(<code>self, event)</code></h4>
|
|
<h4 id="onguildmemberupdateself-event">on_guild_member_update(<code>self, event)</code></h4>
|
|
<h4 id="onguildmemberremoveself-event">on_guild_member_remove(<code>self, event)</code></h4>
|
|
<h4 id="onguildmemberschunkself-event">on_guild_members_chunk(<code>self, event)</code></h4>
|
|
<h4 id="onguildrolecreateself-event">on_guild_role_create(<code>self, event)</code></h4>
|
|
<h4 id="onguildroleupdateself-event">on_guild_role_update(<code>self, event)</code></h4>
|
|
<h4 id="onguildroledeleteself-event">on_guild_role_delete(<code>self, event)</code></h4>
|
|
<h4 id="onguildemojisupdateself-event">on_guild_emojis_update(<code>self, event)</code></h4>
|
|
<h4 id="onpresenceupdateself-event">on_presence_update(<code>self, event)</code></h4>
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
<div class="search-results">
|
|
<div class="has-results">
|
|
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
|
|
</div>
|
|
<div class="no-results">
|
|
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<a href="disco_client.html" class="navigation navigation-prev " aria-label="Previous page: disco.client">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="disco_cli.html" class="navigation navigation-next " aria-label="Next page: disco.cli">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"disco.state","level":"1.4.2","depth":2,"next":{"title":"disco.cli","level":"1.4.3","depth":2,"path":"api/disco_cli.md","ref":"api/disco_cli.md","articles":[]},"previous":{"title":"disco.client","level":"1.4.1","depth":2,"path":"api/disco_client.md","ref":"api/disco_client.md","articles":[]},"dir":"ltr"},"config":{"plugins":["prism","-highlight","hints"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"anchorjs":{"placement":"left","visible":"always"},"prism":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Disco","gitbook":"*"},"file":{"path":"api/disco_state.md","mtime":"2018-02-15T05:53:10.059Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-02-15T05:53:11.657Z"},"basePath":"..","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
<script src="../gitbook/gitbook.js"></script>
|
|
<script src="../gitbook/theme.js"></script>
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|