Parameters

---

channel

EditGuildChannelParams dataclass

Bases: Part

              flowchart TD
              scurrypy.params.channel.EditGuildChannelParams[EditGuildChannelParams]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.params.channel.EditGuildChannelParams
                


              click scurrypy.params.channel.EditGuildChannelParams href "" "scurrypy.params.channel.EditGuildChannelParams"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
            

Parameters for editing a guild channel.

name: OptionalParam[str] = Unset class-attribute instance-attribute

Name of the channel.

type: OptionalParam[ChannelType] = Unset class-attribute instance-attribute

Type of channel.

Important

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

position: OptionalNullableParam[int] = Unset class-attribute instance-attribute

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

topic: OptionalNullableParam[str] = Unset class-attribute instance-attribute

Topic of the channel.

nsfw: OptionalNullableParam[bool] = Unset class-attribute instance-attribute

If the channel is flagged NSFW.

rate_limit_per_user: OptionalNullableParam[int] = Unset class-attribute instance-attribute

Seconds user must wait between sending messages in the channel.

permission_overwrites: OptionalNullableParam[PermissionOverwritePart] = Unset class-attribute instance-attribute

Explicit permission overwrites for members and roles.

parent_id: OptionalNullableParam[int] = Unset class-attribute instance-attribute

Category ID of the channel.

default_auto_archive_duration: OptionalNullableParam[int] = Unset class-attribute instance-attribute

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

flags: OptionalParam[ChannelFlags] = Unset class-attribute instance-attribute

Channel flags.

default_reaction_emoji: OptionalNullableParam[DefaultReactionPart] = Unset class-attribute instance-attribute

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

available_tags: OptionalParam[list[TagPart]] = Unset class-attribute instance-attribute

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

default_sort_order: OptionalNullableParam[SortOrderType] = Unset class-attribute instance-attribute

Default forum sort order.

default_forum_layout: OptionalParam[ForumLayoutType] = Unset class-attribute instance-attribute

Default forum layout view.

default_thread_rate_limit_per_user: OptionalParam[int] = Unset class-attribute instance-attribute

Rate limit per user set on newly created threads.

Note

This field does not live update!

EditThreadChannelParams dataclass

Bases: Part

              flowchart TD
              scurrypy.params.channel.EditThreadChannelParams[EditThreadChannelParams]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.params.channel.EditThreadChannelParams
                


              click scurrypy.params.channel.EditThreadChannelParams href "" "scurrypy.params.channel.EditThreadChannelParams"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
            

Parameters for editing a thread channel.

name: OptionalParam[str] = Unset class-attribute instance-attribute

Name of the channel.

archived: OptionalParam[bool] = Unset class-attribute instance-attribute

Whether the thread is archived.

Permissions

Only requires SEND_MESSAGES.

auto_archive_duration: OptionalParam[AutoArchiveDurationType] = Unset class-attribute instance-attribute

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

locked: OptionalParam[bool] = Unset class-attribute instance-attribute

Whether the thread is locked.

Permissions

Only users with MANAGE_THREADS can unarchive the thread.

invitable: OptionalParam[bool] = Unset class-attribute instance-attribute

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

rate_limit_per_user: OptionalNullableParam[int] = Unset class-attribute instance-attribute

Seconds user must wait between sending messages in the channel.

flags: OptionalParam[ChannelFlags] = Unset class-attribute instance-attribute

Channel flags.

applied_tags: OptionalParam[list[int]] = Unset class-attribute instance-attribute

Set of tags applied to a GUILD_FORUM post.