aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIan Salmons <[email protected]>2017-01-09 01:07:28 +0000
committerRapptz <[email protected]>2017-01-09 03:52:44 -0500
commitc635ce25269e86fe8fd05d1d1785a148293896b4 (patch)
tree0640575de14a714fced9ac4ae8a42e41d1ee93aa /docs
parentUse CDN URL for Guild.icon_url. (diff)
downloaddiscord.py-c635ce25269e86fe8fd05d1d1785a148293896b4.tar.xz
discord.py-c635ce25269e86fe8fd05d1d1785a148293896b4.zip
Simple parser for CHANNEL_PINS_UPDATE
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index e001d8bb..c3f6aabc 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -263,6 +263,14 @@ to handle it, which defaults to print a traceback and ignore the exception.
:param before: The :class:`Channel` that got updated with the old info.
:param after: The :class:`Channel` that got updated with the updated info.
+.. function:: on_channel_pins_update(channel, last_pin)
+
+ Called whenever a message is pinned or unpinned from a channel.
+
+ :param channel: The :class:`Channel` that had it's pins updated.
+ :param last_pin: A ``datetime.datetime`` object representing when the latest message
+ was pinned or ``None`` if there are no pins.
+
.. function:: on_member_join(member)
on_member_remove(member)