aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2016-07-15 22:03:22 -0400
committerRapptz <[email protected]>2016-07-15 22:03:22 -0400
commit91351a3238c8b0ddf9710a870e3933323bcceabc (patch)
tree3c2c880cce48f4f9b41b2e19184b754b31f20672 /docs
parentMake PrivateChannel.__str__ more useful for groups. (diff)
downloaddiscord.py-91351a3238c8b0ddf9710a870e3933323bcceabc.tar.xz
discord.py-91351a3238c8b0ddf9710a870e3933323bcceabc.zip
Handle adding and removal of group members.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index e597e6d7..5ac83bef 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -331,6 +331,15 @@ to handle it, which defaults to print a traceback and ignore the exception.
:param user: The user that started typing.
:param when: A ``datetime.datetime`` object representing when typing started.
+.. function:: on_group_join(channel, user)
+ on_group_remove(channel, user)
+
+ Called when someone joins or leaves a group, i.e. a :class:`PrivateChannel`
+ with a :attr:`PrivateChannel.type` of :attr:`ChannelType.group`.
+
+ :param channel: The group that the user joined or left.
+ :param user: The user that joined or left.
+
.. _discord-api-utils:
Utility Functions