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

Redesign bulk delete events

Browse Source 
Change `parse_message_delete_bulk` to not dispatch individual
`message_delete` events, and instead `bulk_message_delete`. Also make
`raw_bulk_message` delete and `raw_message_delete` have message
objects attached.

Fixes #1807
This commit is contained in:
Vexs
2019-03-23 21:46:05 -05:00
committed by Rapptz
parent be227ebcf0
commit 9591b00dcf
3 changed files with 47 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/api.rst
View File

@@ -227,25 +227,45 @@ to handle it, which defaults to print a traceback and ignoring the exception.
.. function:: on_message_delete(message)
Called when a message is deleted. If the message is not found in the
internal message cache, then these events will not be called. This
happens if the message is too old or the client is participating in high
traffic guilds. To fix this, increase the ``max_messages`` option of
:class:`Client`.
internal message cache, then this event will not be called.
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.
:param message: A :class:`Message` of the deleted message.
.. function:: on_bulk_message_delete(messages)
Called when messages are bulk deleted. If none of the messages deleted
are found in the internal message cache, then this event will not be called.
If individual messages were not found in the internal message cache,
this event will still be called, but the messages not found will not be included in
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.
:param messages: A :class:`list` of :class:`Message` that have been deleted.
.. function:: on_raw_message_delete(payload)
Called when a message is deleted. Unlike :func:`on_message_delete`, this is
called regardless of the message being in the internal message cache or not.
If the message is found in the message cache,
it can be accessed via:attr:`RawMessageDeleteEvent.cached_message`
:param payload: The raw event payload data.
:type payload: :class:`RawMessageDeleteEvent`
.. function:: on_raw_bulk_message_delete(payload)
Called when a bulk delete is triggered. This event is called regardless
of the message IDs being in the internal message cache or not.
Called when a bulk delete is triggered. Unlike :func:`on_bulk_message_delete`, this is
called regardless of the messages being in the internal message cache or not.
If the messages are found in the message cache,
they can be accessed via :attr:`RawBulkMessageDeleteEvent.cached_messages`
:param payload: The raw event payload data.
:type payload: :class:`RawBulkMessageDeleteEvent`
@@ -254,8 +274,10 @@ to handle it, which defaults to print a traceback and ignoring the exception.
Called when a :class:`Message` receives an update event. If the message is not found
in the internal message cache, then these events will not be called.
This happens if the message is too old or the client is participating in high
traffic guilds. To fix this, increase the ``max_messages`` option of :class:`Client`.
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.
The following non-exhaustive cases trigger this event:
@@ -288,7 +310,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
.. function:: on_reaction_add(reaction, user)
Called when a message has a reaction added to it. Similar to on_message_edit,
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.