aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2015-08-27 17:44:31 -0400
committerRapptz <[email protected]>2015-08-27 17:45:43 -0400
commit795b8ceffefa64262c8ebecaaaf4e1f051162fae (patch)
tree36d2b5e0abde68831e3ec7e1ba4cdc3659ae0b8c /docs
parentGive members their server as an attribute. (diff)
downloaddiscord.py-795b8ceffefa64262c8ebecaaaf4e1f051162fae.tar.xz
discord.py-795b8ceffefa64262c8ebecaaaf4e1f051162fae.zip
on_status now takes only a member.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst13
1 files changed, 4 insertions, 9 deletions
diff --git a/docs/api.rst b/docs/api.rst
index c9b6de0b..08ec3394 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -45,7 +45,7 @@ All events are 'sandboxed', in that if an exception is thrown while the event is
:param response: The received message response after gone through ``json.loads``.
.. function:: on_message_delete(message)
-.. function:: on_message_edit(before, after)
+ on_message_edit(before, after)
Called when a message is deleted or edited from any given server. If the message is not found in the
:attr:`Client.messages` cache, then these events will not be called. This happens if the message
@@ -56,16 +56,11 @@ All events are 'sandboxed', in that if an exception is thrown while the event is
:param before: A :class:`Message` of the previous version of the message.
:param after: A :class:`Message` of the current version of the message.
-.. function:: on_status(server, user, status, game_id):
+.. function:: on_status(member):
- Called whenever a user changes their status or game playing status.
+ Called whenever a :class:`Member` changes their status or game playing status.
- The status is usually either "idle", "online" or "offline".
-
- :param server: The :class:`Server` the user belongs to.
- :param user: The :class:`User` whose status changed.
- :param status: The new status of the user.
- :param game_id: The game ID that the user is playing. Can be None.
+ :param server: The :class:`Member` who has had their status changed.
.. function:: on_channel_delete(channel)
on_channel_create(channel)