aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2017-01-23 07:07:42 -0500
committerRapptz <[email protected]>2017-01-23 07:07:42 -0500
commite1aaf74fa7d46897f9eb32e4b52d3db88609a6c4 (patch)
tree7abd6affd4cb84d52a2f0e0c468461f3dec9e07f /docs
parentFix issue with user bots chunking unavailable guilds. (diff)
downloaddiscord.py-e1aaf74fa7d46897f9eb32e4b52d3db88609a6c4.tar.xz
discord.py-e1aaf74fa7d46897f9eb32e4b52d3db88609a6c4.zip
Add option to disable auto member chunking.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index f8e0e8b5..b31fa280 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -102,6 +102,13 @@ to handle it, which defaults to print a traceback and ignore the exception.
.. versionadded:: 0.7.0
Subclassing to listen to events.
+.. function:: on_connect()
+
+ Called when the client has successfully connected to Discord. This is not
+ the same as the client being fully prepared, see :func:`on_ready` for that.
+
+ The warnings on :func:`on_ready` also apply.
+
.. function:: on_ready()
Called when the client is done preparing the data received from Discord. Usually after login is successful
@@ -114,6 +121,13 @@ to handle it, which defaults to print a traceback and ignore the exception.
once. This library implements reconnection logic and thus will
end up calling this event whenever a RESUME request fails.
+.. function:: on_shard_ready(shard_id)
+
+ Similar to :func:`on_ready` except used by :class:`AutoShardedClient`
+ to denote when a particular shard ID has become ready.
+
+ :param shard_id: The shard ID that is ready.
+
.. function:: on_resumed()
Called when the client has resumed a session.