matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Add support for clearing a specific reaction.

Browse Source 
Closes #2440
This commit is contained in:
Rapptz
2020-01-17 19:48:46 -05:00
parent 7b2c01c48a
commit 87f9dcff9c
6 changed files with 152 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/api.rst
View File

@@ -250,7 +250,8 @@ to handle it, which defaults to print a traceback and ignoring the exception.
Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.
If this occurs increase the :attr:`Client.max_messages` attribute.
If this occurs increase the :attr:`Client.max_messages` attribute
or use the :func:`on_raw_message_delete` event instead.
:param message: The deleted message.
:type message: :class:`Message`
@@ -264,7 +265,8 @@ to handle it, which defaults to print a traceback and ignoring the exception.
the messages list. Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.
If this occurs increase the :attr:`Client.max_messages` attribute.
If this occurs increase the :attr:`Client.max_messages` attribute
or use the :func:`on_raw_bulk_message_delete` event instead.
:param messages: The messages that have been deleted.
:type messages: List[:class:`Message`]
@@ -298,7 +300,8 @@ to handle it, which defaults to print a traceback and ignoring the exception.
Messages might not be in cache if the message is too old
or the client is participating in high traffic guilds.
If this occurs increase the :attr:`Client.max_messages` attribute.
If this occurs increase the :attr:`Client.max_messages` attribute
or use the :func:`on_raw_message_edit` event instead.
The following non-exhaustive cases trigger this event:
@@ -339,7 +342,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
Called when a message has a reaction added to it. Similar to :func:`on_message_edit`,
if the message is not found in the internal message cache, then this
event will not be called.
event will not be called. Consider using :func:`on_raw_reaction_add` instead.
.. note::
@@ -385,7 +388,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
Called when a message has all its reactions removed from it. Similar to :func:`on_message_edit`,
if the message is not found in the internal message cache, then this event
will not be called.
will not be called. Consider using :func:`on_raw_reaction_clear` instead.
:param message: The message that had its reactions cleared.
:type message: :class:`Message`
@@ -400,6 +403,27 @@ to handle it, which defaults to print a traceback and ignoring the exception.
:param payload: The raw event payload data.
:type payload: :class:`RawReactionClearEvent`
.. function:: on_reaction_clear_emoji(reaction)
Called when a message has a specific reaction removed from it. Similar to :func:`on_message_edit`,
if the message is not found in the internal message cache, then this event
will not be called. Consider using :func:`on_raw_reaction_clear_emoji` instead.
.. versionadded:: 1.3.0
:param reaction: The reaction that got cleared.
:type reaction: :class:`Reaction`
.. function:: on_raw_reaction_clear_emoji(payload)
Called when a message has a specific reaction removed from it. Unlike :func:`on_reaction_clear_emoji` this is called
regardless of the state of the internal message cache.
.. versionadded:: 1.3.0
:param payload: The raw event payload data.
:type payload: :class:`RawReactionClearEmojiEvent`
.. function:: on_private_channel_delete(channel)
on_private_channel_create(channel)
@@ -2472,6 +2496,12 @@ RawReactionClearEvent
.. autoclass:: RawReactionClearEvent()
:members:
RawReactionClearEmojiEvent
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: RawReactionClearEmojiEvent()
:members:
.. _discord_api_data: