diff options
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst index 5ffc9966..f7fcbc8f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -246,6 +246,18 @@ to handle it, which defaults to print a traceback and ignore the exception. :param member: The :class:`Member` whose voice state changed. +.. function:: on_typing(channel, user, when) + + Called when someone begins typing a message. + + The ``channel`` parameter could either be a :class:`PrivateChannel` or a + :class:`Channel`. + + :param channel: The location where the typing originated from. + :param user: The :class:`Member` that started typing. + :param when: A ``datetime.datetime`` object representing when typing started. + + Utility Functions ----------------- |