aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNadir Chowdhury <[email protected]>2021-06-09 13:09:05 +0100
committerGitHub <[email protected]>2021-06-09 08:09:05 -0400
commitc2df574b2ac036a3a9fb76d32b2497d019cd798f (patch)
treea46d6bceb78d2b473f8101780bd8e64ede2f23b5 /docs
parentRefactor Guild to support type hints (diff)
downloaddiscord.py-c2df574b2ac036a3a9fb76d32b2497d019cd798f.tar.xz
discord.py-c2df574b2ac036a3a9fb76d32b2497d019cd798f.zip
Add audit log entries for stage instances
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst48
1 files changed, 45 insertions, 3 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 0aeea2f7..3231871d 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -2134,6 +2134,42 @@ of :class:`enum.Enum`.
.. versionadded:: 1.3
+ .. attribute:: stage_instance_create
+
+ 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.
+
+ Possible attributes for :class:`AuditLogDiff`:
+
+ - :attr:`~AuditLogDiff.topic`
+ - :attr:`~AuditLogDiff.privacy_level`
+
+ .. versionadded:: 2.0
+
+ .. attribute:: stage_instance_update
+
+ 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.
+
+ Possible attributes for :class:`AuditLogDiff`:
+
+ - :attr:`~AuditLogDiff.topic`
+ - :attr:`~AuditLogDiff.privacy_level`
+
+ .. versionadded:: 2.0
+
+ .. attribute:: stage_instance_delete
+
+ A stage instance was ended.
+
+ .. versionadded:: 2.0
+
.. class:: AuditLogActionCategory
Represents the category that the :class:`AuditLogAction` belongs to.
@@ -2282,7 +2318,7 @@ of :class:`enum.Enum`.
Represents full camera video quality.
-.. class:: PrivacyLevel
+.. class:: StagePrivacyLevel
Represents a stage instance's privacy level.
@@ -2715,9 +2751,9 @@ AuditLogDiff
.. attribute:: topic
- The topic of a :class:`TextChannel`.
+ The topic of a :class:`TextChannel` or :class:`StageChannel`.
- See also :attr:`TextChannel.topic`.
+ See also :attr:`TextChannel.topic` or :attr:`StageChannel.topic`.
:type: :class:`str`
@@ -2742,6 +2778,12 @@ AuditLogDiff
:type: List[Tuple[target, :class:`PermissionOverwrite`]]
+ .. attribute:: privacy_level
+
+ The privacy level of the stage instance.
+
+ :type: :class:`StagePrivacyLevel`
+
.. attribute:: roles
A list of roles being added or removed from a member.