aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNadir Chowdhury <[email protected]>2021-07-29 00:57:42 +0100
committerGitHub <[email protected]>2021-07-28 19:57:42 -0400
commit154c90ef5918e1d454762cabfd269e20865cdf9a (patch)
treecad1f2ff3c5052849a410d1e211682224488c0ee /docs
parentFixes minor grammatical error in Command.update (diff)
downloaddiscord.py-154c90ef5918e1d454762cabfd269e20865cdf9a.tar.xz
discord.py-154c90ef5918e1d454762cabfd269e20865cdf9a.zip
Add audit log events for threads
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst86
1 files changed, 82 insertions, 4 deletions
diff --git a/docs/api.rst b/docs/api.rst
index a14796b1..2f4d911b 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1745,6 +1745,7 @@ of :class:`enum.Enum`.
- :attr:`~AuditLogDiff.bitrate`
- :attr:`~AuditLogDiff.rtc_region`
- :attr:`~AuditLogDiff.video_quality_mode`
+ - :attr:`~AuditLogDiff.default_auto_archive_duration`
.. attribute:: channel_delete
@@ -2173,8 +2174,8 @@ of :class:`enum.Enum`.
A stage instance was started.
When this is the action, the type of :attr:`~AuditLogEntry.target` is
- either :class:`Object` with the stage instance ID of the stage instance
- which was created.
+ the :class:`StageInstance` or :class:`Object` with the ID of the stage
+ instance which was created.
Possible attributes for :class:`AuditLogDiff`:
@@ -2188,8 +2189,8 @@ of :class:`enum.Enum`.
A stage instance was updated.
When this is the action, the type of :attr:`~AuditLogEntry.target` is
- either :class:`Object` with the stage instance ID of the stage instance
- which was updated.
+ the :class:`StageInstance` or :class:`Object` with the ID of the stage
+ instance which was updated.
Possible attributes for :class:`AuditLogDiff`:
@@ -2204,6 +2205,57 @@ of :class:`enum.Enum`.
.. versionadded:: 2.0
+ .. attribute:: thread_create
+
+ A thread was created.
+
+ When this is the action, the type of :attr:`~AuditLogEntry.target` is
+ the :class:`Thread` or :class:`Object` with the ID of the thread which
+ was created.
+
+ Possible attributes for :class:`AuditLogDiff`:
+
+ - :attr:`~AuditLogDiff.name`
+ - :attr:`~AuditLogDiff.archived`
+ - :attr:`~AuditLogDiff.locked`
+ - :attr:`~AuditLogDiff.auto_archive_duration`
+
+ .. versionadded:: 2.0
+
+ .. attribute:: thread_update
+
+ A thread was updated.
+
+ When this is the action, the type of :attr:`~AuditLogEntry.target` is
+ the :class:`Thread` or :class:`Object` with the ID of the thread which
+ was updated.
+
+ Possible attributes for :class:`AuditLogDiff`:
+
+ - :attr:`~AuditLogDiff.name`
+ - :attr:`~AuditLogDiff.archived`
+ - :attr:`~AuditLogDiff.locked`
+ - :attr:`~AuditLogDiff.auto_archive_duration`
+
+ .. versionadded:: 2.0
+
+ .. attribute:: thread_delete
+
+ A thread was deleted.
+
+ When this is the action, the type of :attr:`~AuditLogEntry.target` is
+ the :class:`Thread` or :class:`Object` with the ID of the thread which
+ was deleted.
+
+ Possible attributes for :class:`AuditLogDiff`:
+
+ - :attr:`~AuditLogDiff.name`
+ - :attr:`~AuditLogDiff.archived`
+ - :attr:`~AuditLogDiff.locked`
+ - :attr:`~AuditLogDiff.auto_archive_duration`
+
+ .. versionadded:: 2.0
+
.. class:: AuditLogActionCategory
Represents the category that the :class:`AuditLogAction` belongs to.
@@ -2988,6 +3040,32 @@ AuditLogDiff
:type: :class:`VideoQualityMode`
+ .. attribute:: archived
+
+ The thread is now archived.
+
+ :type: :class:`bool`
+
+ .. attribute:: locked
+
+ The thread is being locked or unlocked.
+
+ :type: :class:`bool`
+
+ .. attribute:: auto_archive_duration
+
+ The thread's auto archive duration being changed.
+
+ See also :attr:`Thread.auto_archive_duration`
+
+ :type: :class:`int`
+
+ .. attribute:: default_auto_archive_duration
+
+ The default auto archive duration for newly created threads being changed.
+
+ :type: :class:`int`
+
.. this is currently missing the following keys: reason and application_id
I'm not sure how to about porting these