Browse Source

Update auto_archive_duration documentation

Fix #9351
pull/9367/head
Rapptz 2 years ago
parent
commit
0adef0ec89
  1. 2
      discord/app_commands/models.py
  2. 4
      discord/channel.py
  3. 2
      discord/message.py
  4. 4
      discord/threads.py

2
discord/app_commands/models.py

@ -673,7 +673,7 @@ class AppCommandThread(Hashable):
archiver_id: Optional[:class:`int`] archiver_id: Optional[:class:`int`]
The user's ID that archived this thread. The user's ID that archived this thread.
auto_archive_duration: :class:`int` auto_archive_duration: :class:`int`
The duration in minutes until the thread is automatically archived due to inactivity. The duration in minutes until the thread is automatically hidden from the channel list.
Usually a value of 60, 1440, 4320 and 10080. Usually a value of 60, 1440, 4320 and 10080.
archive_timestamp: :class:`datetime.datetime` archive_timestamp: :class:`datetime.datetime`
An aware timestamp of when the thread's archived status was last updated in UTC. An aware timestamp of when the thread's archived status was last updated in UTC.

4
discord/channel.py

@ -737,7 +737,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
If ``None`` is passed then a private thread is created. If ``None`` is passed then a private thread is created.
Defaults to ``None``. Defaults to ``None``.
auto_archive_duration: :class:`int` auto_archive_duration: :class:`int`
The duration in minutes before a thread is automatically archived for inactivity. The duration in minutes before a thread is automatically hidden from the channel list.
If not provided, the channel's default auto archive duration is used. If not provided, the channel's default auto archive duration is used.
Must be one of ``60``, ``1440``, ``4320``, or ``10080``, if provided. Must be one of ``60``, ``1440``, ``4320``, or ``10080``, if provided.
@ -2607,7 +2607,7 @@ class ForumChannel(discord.abc.GuildChannel, Hashable):
name: :class:`str` name: :class:`str`
The name of the thread. The name of the thread.
auto_archive_duration: :class:`int` auto_archive_duration: :class:`int`
The duration in minutes before a thread is automatically archived for inactivity. The duration in minutes before a thread is automatically hidden from the channel list.
If not provided, the channel's default auto archive duration is used. If not provided, the channel's default auto archive duration is used.
Must be one of ``60``, ``1440``, ``4320``, or ``10080``, if provided. Must be one of ``60``, ``1440``, ``4320``, or ``10080``, if provided.

2
discord/message.py

@ -1215,7 +1215,7 @@ class PartialMessage(Hashable):
name: :class:`str` name: :class:`str`
The name of the thread. The name of the thread.
auto_archive_duration: :class:`int` auto_archive_duration: :class:`int`
The duration in minutes before a thread is automatically archived for inactivity. The duration in minutes before a thread is automatically hidden from the channel list.
If not provided, the channel's default auto archive duration is used. If not provided, the channel's default auto archive duration is used.
Must be one of ``60``, ``1440``, ``4320``, or ``10080``, if provided. Must be one of ``60``, ``1440``, ``4320``, or ``10080``, if provided.

4
discord/threads.py

@ -122,7 +122,7 @@ class Thread(Messageable, Hashable):
archiver_id: Optional[:class:`int`] archiver_id: Optional[:class:`int`]
The user's ID that archived this thread. The user's ID that archived this thread.
auto_archive_duration: :class:`int` auto_archive_duration: :class:`int`
The duration in minutes until the thread is automatically archived due to inactivity. The duration in minutes until the thread is automatically hidden from the channel list.
Usually a value of 60, 1440, 4320 and 10080. Usually a value of 60, 1440, 4320 and 10080.
archive_timestamp: :class:`datetime.datetime` archive_timestamp: :class:`datetime.datetime`
An aware timestamp of when the thread's archived status was last updated in UTC. An aware timestamp of when the thread's archived status was last updated in UTC.
@ -608,7 +608,7 @@ class Thread(Messageable, Hashable):
Whether non-moderators can add other non-moderators to this thread. Whether non-moderators can add other non-moderators to this thread.
Only available for private threads. Only available for private threads.
auto_archive_duration: :class:`int` auto_archive_duration: :class:`int`
The new duration in minutes before a thread is automatically archived for inactivity. The new duration in minutes before a thread is automatically hidden from the channel list.
Must be one of ``60``, ``1440``, ``4320``, or ``10080``. Must be one of ``60``, ``1440``, ``4320``, or ``10080``.
slowmode_delay: :class:`int` slowmode_delay: :class:`int`
Specifies the slowmode rate limit for user in this thread, in seconds. Specifies the slowmode rate limit for user in this thread, in seconds.

Loading…
Cancel
Save