Skip to content

Enums

channel

ChannelType

Bases: DiscordTypes


              flowchart TD
              scurrypy.enums.channel.ChannelType[ChannelType]
              scurrypy.enums.enum_types.DiscordTypes[DiscordTypes]

                              scurrypy.enums.enum_types.DiscordTypes --> scurrypy.enums.channel.ChannelType
                


              click scurrypy.enums.channel.ChannelType href "" "scurrypy.enums.channel.ChannelType"
              click scurrypy.enums.enum_types.DiscordTypes href "" "scurrypy.enums.enum_types.DiscordTypes"

Represents the types of channels.

GUILD_TEXT = 0 class-attribute instance-attribute

Text channel within a guild.

GUILD_CATEGORY = 4 class-attribute instance-attribute

Organizational category for channels.

GUILD_ANNOUNCEMENT = 5 class-attribute instance-attribute

Channel users can follow and crosspost into their own server.

ANNOUNCEMENT_THREAD = 10 class-attribute instance-attribute

Temporary sub-channel within a GUILD_ANNOUNCEMENT channel.

PUBLIC_THREAD = 11 class-attribute instance-attribute

Temporary sub-channel within a GUILD_TEXT or GUILD_FORUM channel.

PRIVATE_THREAD = 12 class-attribute instance-attribute

Temporary sub-channel within a GUILD_TEXT channel only viewable by invitees and members with MANAGE_THREADS.

GUILD_DIRECTORY = 14 class-attribute instance-attribute

Channel in a hub containing the listed servers.

GUILD_FORUM = 15 class-attribute instance-attribute

Channel that can only contain threads.

ChannelFlags

Bases: DiscordFlags


              flowchart TD
              scurrypy.enums.channel.ChannelFlags[ChannelFlags]
              scurrypy.enums.enum_types.DiscordFlags[DiscordFlags]

                              scurrypy.enums.enum_types.DiscordFlags --> scurrypy.enums.channel.ChannelFlags
                


              click scurrypy.enums.channel.ChannelFlags href "" "scurrypy.enums.channel.ChannelFlags"
              click scurrypy.enums.enum_types.DiscordFlags href "" "scurrypy.enums.enum_types.DiscordFlags"

Represents constant bit fields for channel flags.

PINNED = 1 << 1 class-attribute instance-attribute

This thread is pinned to the top of its parent GUILD_FORUM channel.

REQUIRE_TAG = 1 << 4 class-attribute instance-attribute

Whether a tag is required when creating a thread in a GUILD_FORUM channel.

HIDE_MEDIA_DOWNLOAD_OPTIONS = 1 << 15 class-attribute instance-attribute

hides the embedded media download options.

Warning

Only for media channels.

CHANNEL_OBFUSCATED = 1 << 17 class-attribute instance-attribute

Channel's metadata has been obfuscated because the current user cannot view it.

Warning

Only ever set for channels received over the gateway, not HTTP.

IS_SPOILER_CHANNEL = 1 << 21 class-attribute instance-attribute

Channel in which users must opt in to view its contents.

Warning

Cannot be set for GUILD_STAGE channels. Can only be set if nsfw is False.

SortOrderType

Bases: DiscordTypes


              flowchart TD
              scurrypy.enums.channel.SortOrderType[SortOrderType]
              scurrypy.enums.enum_types.DiscordTypes[DiscordTypes]

                              scurrypy.enums.enum_types.DiscordTypes --> scurrypy.enums.channel.SortOrderType
                


              click scurrypy.enums.channel.SortOrderType href "" "scurrypy.enums.channel.SortOrderType"
              click scurrypy.enums.enum_types.DiscordTypes href "" "scurrypy.enums.enum_types.DiscordTypes"

Represents sort order types for GUILD_FORUM channels.

LATEST_ACTIVITY = 0 class-attribute instance-attribute

Sort by activity.

CREATION_DATE = 1 class-attribute instance-attribute

Sort by creation time (recent to oldest).

ForumLayoutType

Bases: DiscordTypes


              flowchart TD
              scurrypy.enums.channel.ForumLayoutType[ForumLayoutType]
              scurrypy.enums.enum_types.DiscordTypes[DiscordTypes]

                              scurrypy.enums.enum_types.DiscordTypes --> scurrypy.enums.channel.ForumLayoutType
                


              click scurrypy.enums.channel.ForumLayoutType href "" "scurrypy.enums.channel.ForumLayoutType"
              click scurrypy.enums.enum_types.DiscordTypes href "" "scurrypy.enums.enum_types.DiscordTypes"

Represents GUILD_FORUM layout types.

NOT_SET = 0 class-attribute instance-attribute

No default layout has been set.

LIST_VIEW = 1 class-attribute instance-attribute

Display posts as a list.

GALLERY_VIEW = 2 class-attribute instance-attribute

Display posts as a collection of tiles.

AutoArchiveDurationType

Bases: DiscordTypes


              flowchart TD
              scurrypy.enums.channel.AutoArchiveDurationType[AutoArchiveDurationType]
              scurrypy.enums.enum_types.DiscordTypes[DiscordTypes]

                              scurrypy.enums.enum_types.DiscordTypes --> scurrypy.enums.channel.AutoArchiveDurationType
                


              click scurrypy.enums.channel.AutoArchiveDurationType href "" "scurrypy.enums.channel.AutoArchiveDurationType"
              click scurrypy.enums.enum_types.DiscordTypes href "" "scurrypy.enums.enum_types.DiscordTypes"

Auto archive duration options.

ONE_HR = 60 class-attribute instance-attribute

One hour duration.

ONE_DAY = 1440 class-attribute instance-attribute

One day duration.

THREE_DAYS = 4320 class-attribute instance-attribute

Three weeks duration.

ONE_WEEK = 10080 class-attribute instance-attribute

One week duration.