Objects

---

Announcement Channel

---

announcement

GuildAnnouncementChannelPart dataclass

Bases: Part, GuildChannelCreate

              flowchart TD
              scurrypy.api.channels.announcement.GuildAnnouncementChannelPart[GuildAnnouncementChannelPart]
              scurrypy.core.part.Part[Part]
              scurrypy.bases.channel.GuildChannelCreate[GuildChannelCreate]

                              scurrypy.core.part.Part --> scurrypy.api.channels.announcement.GuildAnnouncementChannelPart
                
                scurrypy.bases.channel.GuildChannelCreate --> scurrypy.api.channels.announcement.GuildAnnouncementChannelPart
                


              click scurrypy.api.channels.announcement.GuildAnnouncementChannelPart href "" "scurrypy.api.channels.announcement.GuildAnnouncementChannelPart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
              click scurrypy.bases.channel.GuildChannelCreate href "" "scurrypy.bases.channel.GuildChannelCreate"
            

Represents fields for creating a guild announcement channel.

name: RequiredPartField[str] = None class-attribute instance-attribute

Name of the channel.

topic: OptionalNullablePartField[str] = None class-attribute instance-attribute

Topic of the channel.

position: OptionalNullablePartField[int] = None class-attribute instance-attribute

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

permission_overwrites: OptionalNullablePartField[list[PermissionOverwritePart]] = None class-attribute instance-attribute

Explicit permission overwrites for members and roles.

parent_id: OptionalNullablePartField[Snowflake] = None class-attribute instance-attribute

Category ID of the channel.

nsfw: OptionalNullablePartField[bool] = None class-attribute instance-attribute

If the channel is flagged NSFW.

default_auto_archive_duration: OptionalNullablePartField[int] = None class-attribute instance-attribute

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

default_thread_rate_limit_per_user: OptionalNullablePartField[int] = None class-attribute instance-attribute

Rate limit per user set on newly created threads.

Note

This field does not live update!

type: ChannelType = field(init=False, default=(ChannelType.GUILD_ANNOUNCEMENT)) class-attribute instance-attribute

Type of channel. Always ChannelType.GUILD_ANNOUNCEMENT for this class.

Default Reaction

---

default_reaction

DefaultReactionPart dataclass

Bases: Part

              flowchart TD
              scurrypy.api.channels.default_reaction.DefaultReactionPart[DefaultReactionPart]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.api.channels.default_reaction.DefaultReactionPart
                


              click scurrypy.api.channels.default_reaction.DefaultReactionPart href "" "scurrypy.api.channels.default_reaction.DefaultReactionPart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
            

Represents fields for creating a default reaction for a GUILD_FORUM post.

emoji_id: RequiredNullablePartField[int] = None class-attribute instance-attribute

ID of the guild's custom emoji.

emoji_name: RequiredNullablePartField[str] = None class-attribute instance-attribute

Unicode character of the emoji.

Guild Forum Channel

---

forum

GuildForumChannelPart dataclass

Bases: Part, GuildChannelCreate

              flowchart TD
              scurrypy.api.channels.forum.GuildForumChannelPart[GuildForumChannelPart]
              scurrypy.core.part.Part[Part]
              scurrypy.bases.channel.GuildChannelCreate[GuildChannelCreate]

                              scurrypy.core.part.Part --> scurrypy.api.channels.forum.GuildForumChannelPart
                
                scurrypy.bases.channel.GuildChannelCreate --> scurrypy.api.channels.forum.GuildForumChannelPart
                


              click scurrypy.api.channels.forum.GuildForumChannelPart href "" "scurrypy.api.channels.forum.GuildForumChannelPart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
              click scurrypy.bases.channel.GuildChannelCreate href "" "scurrypy.bases.channel.GuildChannelCreate"
            

Represents fields for creating a guild forum channel.

name: RequiredPartField[str] = None class-attribute instance-attribute

Name of the channel.

topic: OptionalNullablePartField[str] = None class-attribute instance-attribute

Topic of the channel.

position: OptionalNullablePartField[int] = None class-attribute instance-attribute

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

permission_overwrites: OptionalNullablePartField[list[PermissionOverwritePart]] = None class-attribute instance-attribute

Explicit permission overwrites for members and roles.

rate_limit_per_user: OptionalNullablePartField[int] = None class-attribute instance-attribute

Seconds user must wait between sending messages in the channel.

parent_id: OptionalNullablePartField[Snowflake] = None class-attribute instance-attribute

Category ID of the channel.

nsfw: OptionalNullablePartField[bool] = None class-attribute instance-attribute

If the channel is flagged NSFW.

default_auto_archive_duration: OptionalNullablePartField[int] = None class-attribute instance-attribute

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

default_reaction_emoji: OptionalNullablePartField[DefaultReactionPart] = None class-attribute instance-attribute

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

available_tags: OptionalNullablePartField[list[TagPart]] = None class-attribute instance-attribute

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

default_sort_order: OptionalNullablePartField[SortOrderType] = None class-attribute instance-attribute

Default forum sort order.

default_forum_layout: OptionalNullablePartField[ForumLayoutType] = None class-attribute instance-attribute

Default forum layout view.

default_thread_rate_limit_per_user: OptionalNullablePartField[int] = None class-attribute instance-attribute

Rate limit per user set on newly created threads.

Note

This field does not live update!

type: ChannelType = field(init=False, default=(ChannelType.GUILD_FORUM)) class-attribute instance-attribute

Type of channel. Always ChannelType.GUILD_FORUM for this class.

Guild Text Channel

---

guild_text

GuildTextChannelPart dataclass

Bases: Part, GuildChannelCreate

              flowchart TD
              scurrypy.api.channels.guild_text.GuildTextChannelPart[GuildTextChannelPart]
              scurrypy.core.part.Part[Part]
              scurrypy.bases.channel.GuildChannelCreate[GuildChannelCreate]

                              scurrypy.core.part.Part --> scurrypy.api.channels.guild_text.GuildTextChannelPart
                
                scurrypy.bases.channel.GuildChannelCreate --> scurrypy.api.channels.guild_text.GuildTextChannelPart
                


              click scurrypy.api.channels.guild_text.GuildTextChannelPart href "" "scurrypy.api.channels.guild_text.GuildTextChannelPart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
              click scurrypy.bases.channel.GuildChannelCreate href "" "scurrypy.bases.channel.GuildChannelCreate"
            

Represents fields for creating a guild text channel.

name: RequiredPartField[str] = None class-attribute instance-attribute

Name of the channel.

topic: OptionalNullablePartField[str] = None class-attribute instance-attribute

Topic of the channel.

position: OptionalNullablePartField[int] = None class-attribute instance-attribute

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

permission_overwrites: OptionalNullablePartField[list[PermissionOverwritePart]] = None class-attribute instance-attribute

Explicit permission overwrites for members and roles.

rate_limit_per_user: OptionalNullablePartField[int] = None class-attribute instance-attribute

Seconds user must wait between sending messages in the channel.

parent_id: OptionalNullablePartField[Snowflake] = None class-attribute instance-attribute

Category ID of the channel.

nsfw: OptionalNullablePartField[bool] = None class-attribute instance-attribute

If the channel is flagged NSFW.

default_auto_archive_duration: OptionalNullablePartField[int] = None class-attribute instance-attribute

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

default_thread_rate_limit_per_user: OptionalNullablePartField[int] = None class-attribute instance-attribute

Rate limit per user set on newly created threads.

Note

This field does not live update!

type: ChannelType = field(init=False, default=(ChannelType.GUILD_TEXT)) class-attribute instance-attribute

Type of channel. Always ChannelType.GUILD_TEXT for this class.

Tag

---

tag

TagPart dataclass

Bases: Part

              flowchart TD
              scurrypy.api.channels.tag.TagPart[TagPart]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.api.channels.tag.TagPart
                


              click scurrypy.api.channels.tag.TagPart href "" "scurrypy.api.channels.tag.TagPart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
            

Represents fields for creating a tag object found in GUILD_FORUM channels.

name: RequiredPartField[str] = None class-attribute instance-attribute

Name of the tag.

moderated: OptionalPartField[bool] = None class-attribute instance-attribute

Whether the tag can only be added/removed by a member with MANAGE_THREADS.

emoji_id: RequiredNullablePartField[Snowflake] = None class-attribute instance-attribute

ID of a guild's custom emoji.

emoji_name: RequiredNullablePartField[str] = None class-attribute instance-attribute

Unicode character of the emoji.

Threads

---

threads

ThreadFromMessagePart dataclass

Bases: Part

              flowchart TD
              scurrypy.api.channels.threads.ThreadFromMessagePart[ThreadFromMessagePart]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.api.channels.threads.ThreadFromMessagePart
                


              click scurrypy.api.channels.threads.ThreadFromMessagePart href "" "scurrypy.api.channels.threads.ThreadFromMessagePart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
            

Represents fields for creating a thread attached to a message.

name: RequiredPartField[str] = None class-attribute instance-attribute

Name of the thread.

auto_archive_duration: OptionalPartField[AutoArchiveDurationType] = None class-attribute instance-attribute

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

rate_limit_per_user: OptionalNullablePartField[int] = None class-attribute instance-attribute

Seconds user must wait between sending messages in the channel.

permission_overwrites: OptionalNullablePartField[list[PermissionOverwritePart]] = None class-attribute instance-attribute

Explicit permission overwrites for members and roles.

ThreadWithoutMessagePart dataclass

Bases: Part

              flowchart TD
              scurrypy.api.channels.threads.ThreadWithoutMessagePart[ThreadWithoutMessagePart]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.api.channels.threads.ThreadWithoutMessagePart
                


              click scurrypy.api.channels.threads.ThreadWithoutMessagePart href "" "scurrypy.api.channels.threads.ThreadWithoutMessagePart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
            

Represents fields for creating a thread without a message.

name: RequiredPartField[str] = None class-attribute instance-attribute

Name of the thread.

auto_archive_duration: OptionalPartField[AutoArchiveDurationType] = None class-attribute instance-attribute

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

type: OptionalPartField[ChannelType] = None class-attribute instance-attribute

Type of thread to create. If omitted, Discord defaults to ChannelType.PRIVATE_THREAD.

invitable: OptionalPartField[bool] = None class-attribute instance-attribute

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

rate_limit_per_user: OptionalNullablePartField[int] = None class-attribute instance-attribute

Seconds user must wait between sending messages in the channel.

permission_overwrites: OptionalNullablePartField[list[PermissionOverwritePart]] = None class-attribute instance-attribute

Explicit permission overwrites for members and roles.