Channel Parameters

Note

The following classes come from the scurrypy.params.channel module.

---

EditGuildChannelParams

Bases: TypedDict

Parameters for editing a guild channel.

name: str instance-attribute

Name of the channel.

type: Optional[int] instance-attribute

Type of channel. See ChannelTypes.

Important

Only conversion between text and announcement is supported in guilds with NEWS feature.

position: Optional[int] instance-attribute

Sorting position of the channel (channels with the same position are sorted by id).

topic: Optional[str] instance-attribute

Topic of the channel.

nsfw: Optional[bool] instance-attribute

If the channel is flagged NSFW.

rate_limit_per_user: Optional[int] instance-attribute

Seconds user must wait between sending messages in the channel.

parent_id: Optional[int] instance-attribute

Category ID of the channel.

default_auto_archive_duration: Optional[int] instance-attribute

Default duration in minutes threads will be hidden after period of inactivity.

flags: Optional[int] instance-attribute

Channel flags. See ChannelFlags.

default_reaction_emoji: Optional[DefaultReactionPart] instance-attribute

Emoji to show in the add reaction button in a GUILD_FORUM post.

available_tags: Optional[list[TagPart]] instance-attribute

Set of tags that can be applied to a GUILD_FORUM post.

default_sort_order: Optional[int] instance-attribute

Default forum sort order. See SortOrderTypes.

default_forum_layout: Optional[int] instance-attribute

Default forum layout view. See ForumLayoutTypes.

default_thread_rate_limit_per_user: Optional[int] instance-attribute

Rate limit per user set on newly created threads.

Note

This field does not live update!

---

EditThreadChannelParams

Bases: TypedDict

Parameters for editing a thread channel.

name: Optional[str] instance-attribute

Name of the channel.

archived: Optional[bool] instance-attribute

Whether the thread is archived.

auto_archive_duration: Optional[Literal[60, 1440, 4320, 10080]] instance-attribute

Duration in minutes threads will be hidden after period of inactivity.

locked: bool instance-attribute

Whether the thread is locked.

Note

Only users with MANAGE_THREADS can unarchive the thread.

invitable: Optional[bool] instance-attribute

Whether non-moderators can add other non-moderators to the thread (private threads only).

rate_limit_per_user: Optional[int] instance-attribute

Seconds user must wait between sending messages in the channel.

flags: Optional[int] instance-attribute

Channel flags. See ChannelFlags.

applied_tags: Optional[list[int]] instance-attribute

Set of tags applied to a GUILD_FORUM post.