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.
1151 lines
35 KiB
1151 lines
35 KiB
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>disco.api.client · 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_api_http.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 " 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 active" 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.api.client</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="discoapiclient">disco.api.client</h1>
|
|
<h2 id="classes">Classes</h2>
|
|
<h3 id="responses">Responses</h3>
|
|
<p><em>Inherits From <code>list</code></em></p>
|
|
<h4 id="functions">Functions</h4>
|
|
<h4 id="ratelimiteddurationself">rate_limited_duration(<code>self</code>)</h4>
|
|
<h4 id="ratelimitedself">rate_limited(<code>self</code>)</h4>
|
|
<h3 id="apiclient">APIClient</h3>
|
|
<p><em>Inherits From <code>LoggingClass</code></em></p>
|
|
<p>An abstraction over a :class:<code>disco.api.http.HTTPClient</code>, which composes
|
|
requests from provided data, and fits models with the returned data. The APIClient
|
|
is the only path to the API used within models/other interfaces, and it's
|
|
the recommended path for all third-party users/implementations.</p>
|
|
<h5 id="args">Args</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>token</td>
|
|
<td><code>str</code></td>
|
|
<td>The Discord authentication token (without prefixes) to be used for all HTTP requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>client</td>
|
|
<td><code>Optional[:class:`disco.client.Client`]</code></td>
|
|
<td>The Disco client this APIClient is a member of. This is used when constructing and fitting models from response data.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="attributes">Attributes</h5>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>client</td>
|
|
<td><code>Optional[:class:`disco.client.Client`]</code></td>
|
|
<td>The Disco client this APIClient is a member of.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>http</td>
|
|
<td><code>:class:`disco.http.HTTPClient`</code></td>
|
|
<td>The HTTPClient this APIClient uses for all requests.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="functions">Functions</h4>
|
|
<h4 id="initself-token-client"><strong>init</strong>(<code>self, token, client)</code></h4>
|
|
<h4 id="afterrequestsself-response">_after_requests(<code>self, response)</code></h4>
|
|
<h4 id="captureself">capture(<code>self</code>)</h4>
|
|
<p>Context manager which captures all requests made, returning a special
|
|
<code>Responses</code> list, which can be used to introspect raw API responses. This
|
|
method is a low-level utility which should only be used by experienced users.</p>
|
|
<h4 id="gatewaygetself">gateway_get(<code>self</code>)</h4>
|
|
<h4 id="gatewaybotgetself">gateway_bot_get(<code>self</code>)</h4>
|
|
<h4 id="channelsgetself-channel">channels_get(<code>self, channel)</code></h4>
|
|
<h4 id="channelsmodifyself-channel-reasonkwargs">channels_modify(<code>self, channel, reason,**kwargs)</code></h4>
|
|
<h4 id="channelsdeleteself-channel-reason">channels_delete(<code>self, channel, reason)</code></h4>
|
|
<h4 id="channelstypingself-channel">channels_typing(<code>self, channel)</code></h4>
|
|
<h4 id="channelsmessageslistself-channel-around-beforenone-afternone-limit50">channels_messages_list(<code>self, channel, around, before=None, after=None, limit=50)</code></h4>
|
|
<h4 id="channelsmessagesgetself-channel-message">channels_messages_get(<code>self, channel, message)</code></h4>
|
|
<h4 id="channelsmessagescreateself-channel-content-noncenone-ttsfalse-attachmentnone-attachments-embednone-sanitizefalse">channels_messages_create(<code>self, channel, content, nonce=None, tts=False, attachment=None, attachments=[], embed=None, sanitize=False)</code></h4>
|
|
<h4 id="channelsmessagesmodifyself-channel-message-content-embednone-sanitizefalse">channels_messages_modify(<code>self, channel, message, content, embed=None, sanitize=False)</code></h4>
|
|
<h4 id="channelsmessagesdeleteself-channel-message">channels_messages_delete(<code>self, channel, message)</code></h4>
|
|
<h4 id="channelsmessagesdeletebulkself-channel-messages">channels_messages_delete_bulk(<code>self, channel, messages)</code></h4>
|
|
<h4 id="channelsmessagesreactionsgetself-channel-message-emoji-after-limit100">channels_messages_reactions_get(<code>self, channel, message, emoji, after, limit=100)</code></h4>
|
|
<h4 id="channelsmessagesreactionscreateself-channel-message-emoji">channels_messages_reactions_create(<code>self, channel, message, emoji)</code></h4>
|
|
<h4 id="channelsmessagesreactionsdeleteself-channel-message-emoji-user">channels_messages_reactions_delete(<code>self, channel, message, emoji, user)</code></h4>
|
|
<h4 id="channelspermissionsmodifyself-channel-permission-allow-deny-typ-reason">channels_permissions_modify(<code>self, channel, permission, allow, deny, typ, reason)</code></h4>
|
|
<h4 id="channelspermissionsdeleteself-channel-permission-reason">channels_permissions_delete(<code>self, channel, permission, reason)</code></h4>
|
|
<h4 id="channelsinviteslistself-channel">channels_invites_list(<code>self, channel)</code></h4>
|
|
<h4 id="channelsinvitescreateself-channel-maxage-maxuses0-temporaryfalse-uniquefalse-reasonnone">channels_invites_create(<code>self, channel, max_age, max_uses=0, temporary=False, unique=False, reason=None)</code></h4>
|
|
<h4 id="channelspinslistself-channel">channels_pins_list(<code>self, channel)</code></h4>
|
|
<h4 id="channelspinscreateself-channel-message">channels_pins_create(<code>self, channel, message)</code></h4>
|
|
<h4 id="channelspinsdeleteself-channel-message">channels_pins_delete(<code>self, channel, message)</code></h4>
|
|
<h4 id="channelswebhookscreateself-channel-name-avatarnone">channels_webhooks_create(<code>self, channel, name, avatar=None)</code></h4>
|
|
<h4 id="channelswebhookslistself-channel">channels_webhooks_list(<code>self, channel)</code></h4>
|
|
<h4 id="guildsgetself-guild">guilds_get(<code>self, guild)</code></h4>
|
|
<h4 id="guildsmodifyself-guild-reasonkwargs">guilds_modify(<code>self, guild, reason,**kwargs)</code></h4>
|
|
<h4 id="guildsdeleteself-guild">guilds_delete(<code>self, guild)</code></h4>
|
|
<h4 id="guildschannelslistself-guild">guilds_channels_list(<code>self, guild)</code></h4>
|
|
<h4 id="guildschannelscreateself-guild-channeltype-name-bitrate-userlimitnone-permissionoverwrites-nsfwnone-parentidnone-positionnone-reasonnone">guilds_channels_create(<code>self, guild, channel_type, name, bitrate, user_limit=None, permission_overwrites=[], nsfw=None, parent_id=None, position=None, reason=None)</code></h4>
|
|
<h4 id="guildschannelsmodifyself-guild-channel-position-reason">guilds_channels_modify(<code>self, guild, channel, position, reason)</code></h4>
|
|
<h4 id="guildsmemberslistself-guild-limit-afternone">guilds_members_list(<code>self, guild, limit, after=None)</code></h4>
|
|
<h4 id="guildsmembersgetself-guild-member">guilds_members_get(<code>self, guild, member)</code></h4>
|
|
<h4 id="guildsmembersmodifyself-guild-member-reasonkwargs">guilds_members_modify(<code>self, guild, member, reason,**kwargs)</code></h4>
|
|
<h4 id="guildsmembersrolesaddself-guild-member-role-reason">guilds_members_roles_add(<code>self, guild, member, role, reason)</code></h4>
|
|
<h4 id="guildsmembersrolesremoveself-guild-member-role-reason">guilds_members_roles_remove(<code>self, guild, member, role, reason)</code></h4>
|
|
<h4 id="guildsmembersmenickself-guild-nick">guilds_members_me_nick(<code>self, guild, nick)</code></h4>
|
|
<h4 id="guildsmemberskickself-guild-member-reason">guilds_members_kick(<code>self, guild, member, reason)</code></h4>
|
|
<h4 id="guildsbanslistself-guild">guilds_bans_list(<code>self, guild)</code></h4>
|
|
<h4 id="guildsbanscreateself-guild-user-deletemessagedays-reasonnone">guilds_bans_create(<code>self, guild, user, delete_message_days, reason=None)</code></h4>
|
|
<h4 id="guildsbansdeleteself-guild-user-reason">guilds_bans_delete(<code>self, guild, user, reason)</code></h4>
|
|
<h4 id="guildsroleslistself-guild">guilds_roles_list(<code>self, guild)</code></h4>
|
|
<h4 id="guildsrolescreateself-guild-name-permissionsnone-colornone-hoistnone-mentionablenone-reasonnone">guilds_roles_create(<code>self, guild, name, permissions=None, color=None, hoist=None, mentionable=None, reason=None)</code></h4>
|
|
<h4 id="guildsrolesmodifybatchself-guild-roles-reason">guilds_roles_modify_batch(<code>self, guild, roles, reason)</code></h4>
|
|
<h4 id="guildsrolesmodifyself-guild-role-name-hoistnone-colornone-permissionsnone-positionnone-mentionablenone-reasonnone">guilds_roles_modify(<code>self, guild, role, name, hoist=None, color=None, permissions=None, position=None, mentionable=None, reason=None)</code></h4>
|
|
<h4 id="guildsrolesdeleteself-guild-role-reason">guilds_roles_delete(<code>self, guild, role, reason)</code></h4>
|
|
<h4 id="guildsinviteslistself-guild">guilds_invites_list(<code>self, guild)</code></h4>
|
|
<h4 id="guildswebhookslistself-guild">guilds_webhooks_list(<code>self, guild)</code></h4>
|
|
<h4 id="guildsemojislistself-guild">guilds_emojis_list(<code>self, guild)</code></h4>
|
|
<h4 id="guildsemojiscreateself-guild-reasonkwargs">guilds_emojis_create(<code>self, guild, reason,**kwargs)</code></h4>
|
|
<h4 id="guildsemojismodifyself-guild-emoji-reasonkwargs">guilds_emojis_modify(<code>self, guild, emoji, reason,**kwargs)</code></h4>
|
|
<h4 id="guildsemojisdeleteself-guild-emoji-reason">guilds_emojis_delete(<code>self, guild, emoji, reason)</code></h4>
|
|
<h4 id="guildsauditlogslistself-guild-before-useridnone-actiontypenone-limit50">guilds_auditlogs_list(<code>self, guild, before, user_id=None, action_type=None, limit=50)</code></h4>
|
|
<h4 id="usersmegetself">users_me_get(<code>self</code>)</h4>
|
|
<h4 id="usersmepatchself-payload">users_me_patch(<code>self, payload)</code></h4>
|
|
<h4 id="usersmeguildsdeleteself-guild">users_me_guilds_delete(<code>self, guild)</code></h4>
|
|
<h4 id="usersmedmscreateself-recipientid">users_me_dms_create(<code>self, recipient_id)</code></h4>
|
|
<h4 id="invitesgetself-invite">invites_get(<code>self, invite)</code></h4>
|
|
<h4 id="invitesdeleteself-invite-reason">invites_delete(<code>self, invite, reason)</code></h4>
|
|
<h4 id="webhooksgetself-webhook">webhooks_get(<code>self, webhook)</code></h4>
|
|
<h4 id="webhooksmodifyself-webhook-name-avatarnone-reasonnone">webhooks_modify(<code>self, webhook, name, avatar=None, reason=None)</code></h4>
|
|
<h4 id="webhooksdeleteself-webhook-reason">webhooks_delete(<code>self, webhook, reason)</code></h4>
|
|
<h4 id="webhookstokengetself-webhook-token">webhooks_token_get(<code>self, webhook, token)</code></h4>
|
|
<h4 id="webhookstokenmodifyself-webhook-token-name-avatarnone">webhooks_token_modify(<code>self, webhook, token, name, avatar=None)</code></h4>
|
|
<h4 id="webhookstokendeleteself-webhook-token">webhooks_token_delete(<code>self, webhook, token)</code></h4>
|
|
<h4 id="webhookstokenexecuteself-webhook-token-data-wait">webhooks_token_execute(<code>self, webhook, token, data, wait)</code></h4>
|
|
<h2 id="functions">Functions</h2>
|
|
<h4 id="optionalkwargscode">optional(**kwargs</code>)</h4>
|
|
<p>Takes a set of keyword arguments, creating a dictionary with only the non-
|
|
null values.</p>
|
|
<p>:returns: dict</p>
|
|
<h4 id="reasonheadervalue">_reason_header(<code>value</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_api_http.html" class="navigation navigation-next navigation-unique" aria-label="Next page: disco.api.http">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"disco.api.client","level":"1.4.5.1","depth":3,"next":{"title":"disco.api.http","level":"1.4.5.2","depth":3,"path":"api/disco_api_http.md","ref":"api/disco_api_http.md","articles":[]},"previous":{"title":"API","level":"1.4.5","depth":2,"ref":"","articles":[{"title":"disco.api.client","level":"1.4.5.1","depth":3,"path":"api/disco_api_client.md","ref":"api/disco_api_client.md","articles":[]},{"title":"disco.api.http","level":"1.4.5.2","depth":3,"path":"api/disco_api_http.md","ref":"api/disco_api_http.md","articles":[]},{"title":"disco.api.ratelimit","level":"1.4.5.3","depth":3,"path":"api/disco_api_ratelimit.md","ref":"api/disco_api_ratelimit.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_api_client.md","mtime":"2018-02-15T05:53:10.139Z","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>
|
|
|
|
|