Channel¶

discord_http.channel module¶

class discord_http.channel.BaseChannel(*, state: DiscordAPI, data: dict, guild_id: int | None = None)[source]¶

Bases: PartialChannel

classmethod from_dict(*, state: DiscordAPI, data: dict, guild_id: int | None = None) → BaseChannel[source]¶

Create a channel object from a dictionary Requires the state to be set

Parameters:

state (DiscordAPI) – The state to use
data (dict) – Data provided by Discord API

Returns:

The channel object

Return type:

BaseChannel

property mention: str¶

The channel’s mention

Type:: str

permissions_for(member: Member) → Permissions[source]¶

Returns the permissions for a member in the channel. Note that this only works if you are using Gateway with guild, role and channel cache.

Parameters:: member (Member) – The member to get the permissions for.
Returns:: The permissions for the member in the channel.
Return type:: Permissions

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.CategoryChannel(*, state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

property channels: list[BaseChannel | PartialChannel]¶

Returns a list of channels in this category. This will only return channels that are in the same guild as the category.

Type:: list[BaseChannel | PartialChannel]

async create_stage_channel(name: str, **kwargs) → StageChannel[source]¶

Create a stage channel

Parameters:

name (str) – The name of the channel
bitrate (Optional[int]) – The bitrate of the channel
user_limit (Optional[int]) – The user limit of the channel
overwrites (Optional[list[PermissionOverwrite]]) – The permission overwrites of the category
position (Optional[int]) – The position of the channel
video_quality_mode (Optional[Union[VideoQualityType, int]]) – The video quality mode of the channel
parent_id (Optional[Union[Snowflake, int]]) – The Category ID where the channel will be placed
reason (Optional[str]) – The reason for creating the stage channel

Returns:

The created channel

Return type:

StageChannel

async create_text_channel(name: str, **kwargs) → TextChannel[source]¶

Create a text channel in the category

Parameters:

name (str) – The name of the channel
topic (Optional[str]) – The topic of the channel
rate_limit_per_user (Optional[int]) – The rate limit per user of the channel
overwrites (Optional[list[PermissionOverwrite]]) – The permission overwrites of the category
parent_id (Optional[Snowflake]) – The Category ID where the channel will be placed
nsfw (Optional[bool]) – Whether the channel is NSFW or not
reason (Optional[str]) – The reason for creating the text channel

Returns:

The channel object

Return type:

TextChannel

async create_voice_channel(name: str, **kwargs) → VoiceChannel[source]¶

Create a voice channel to category

Parameters:

name (str) – The name of the channel
bitrate (Optional[int]) – The bitrate of the channel
user_limit (Optional[int]) – The user limit of the channel
rate_limit_per_user (Optional) – The rate limit per user of the channel
overwrites (Optional[list[PermissionOverwrite]]) – The permission overwrites of the category
position (Optional[int]) – The position of the channel
parent_id (Optional[Snowflake]) – The Category ID where the channel will be placed
nsfw (Optional[bool]) – Whether the channel is NSFW or not
reason (Optional[str]) – The reason for creating the voice channel

Returns:

The channel object

Return type:

VoiceChannel

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.DMChannel(*, state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

async edit(*args, **kwargs) → None[source]¶

Only here to prevent errors

Raises:: TypeError – If you try to edit a DM channel

property mention: str¶

The channel’s mention

Type:: str

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.DirectoryChannel(*, state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.ForumChannel(state: DiscordAPI, data: dict)[source]¶

Bases: PublicThread

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.ForumTag(*, data: dict)[source]¶

Bases: object

classmethod create(name: str | None = None, *, emoji_id: int | None = None, emoji_name: str | None = None, moderated: bool = False) → ForumTag[source]¶

Create a forum tag, used for editing available_tags

Parameters:

name (Optional[str]) – The name of the tag
emoji_id (Optional[int]) – The emoji ID of the tag
emoji_name (Optional[str]) – The emoji name of the tag
moderated (bool) – If the tag is moderated

Returns:

The tag object

Return type:

ForumTag

classmethod from_data(*, data: dict) → Self[source]¶

to_dict() → dict[source]¶

class discord_http.channel.ForumThread(state: DiscordAPI, data: dict)[source]¶

Bases: PublicThread

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.GroupDMChannel(*, state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.NewsChannel(state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.NewsThread(state: DiscordAPI, data: dict)[source]¶

Bases: PublicThread

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.PartialChannel(*, state: DiscordAPI, id: int, guild_id: int | None = None)[source]¶

Bases: PartialBase

async add_thread_member(user_id: int) → None[source]¶

Add a thread member

Parameters:: user_id (int) – The user ID to add

Deletes messages in bulk

Parameters:

check (Callable[[Message], bool] | None) – A function to check if the message should be deleted
before (datetime | Message | Snowflake | int | None) – The message before which to delete
after (datetime | Message | Snowflake | int | None) – The message after which to delete
around (datetime | Message | Snowflake | int | None) – The message around which to delete
message_ids (list[Message | Snowflake | int] | None) – The message IDs to delete
limit (int | None) – The maximum amount of messages to delete
reason (str | None) – The reason for deleting the messages

Returns:

Returns a list of messages deleted If you provide message_ids upfront, it will skip history search and delete

Return type:

list[Message] | None

property channel: BaseChannel | CategoryChannel | PartialChannel | None¶: BaseChannel | CategoryChannel | PartialChannel | None: Returns the channel the thread is in. Only returns a full object if cache is enabled for guild and channel.

Create a forum or media thread in the channel

Parameters:

name (str) – The name of the thread
content (Optional[str]) – The content of the message
embed (Optional[Embed]) – Embed to be sent
embeds (Optional[list[Embed]]) – List of embeds to be sent
file (Optional[File]) – File to be sent
files (Optional[list[File]]) – List of files to be sent
allowed_mentions (Optional[AllowedMentions]) – The allowed mentions for the message
view (Optional[View]) – The view to be sent
auto_archive_duration (Optional[int]) – The duration in minutes to automatically archive the thread after recent activity
rate_limit_per_user (Optional[int]) – How long the slowdown should be
applied_tags (Optional[list[Union["ForumTag", int]]]) – The tags to be applied to the thread

Returns:

_description_

Return type:

ForumThread

async create_invite(*, max_age: timedelta | int = 86400, max_uses: int | None = 0, temporary: bool = False, unique: bool = False) → Invite[source]¶

Create an invite for the channel

Parameters:

max_age (Union[timedelta, int]) – How long the invite should last
temporary (bool) – If the invite should be temporary
unique (bool) – If the invite should be unique

Returns:

The invite object

Return type:

Invite

Creates a thread in the channel

Parameters:

name (str) – The name of the thread
type (Optional[Union[ChannelType, int]]) – The type of thread to create
auto_archive_duration (Optional[int]) – The duration in minutes to automatically archive the thread after recent activity
invitable (bool) – If the thread is invitable
rate_limit_per_user (Optional[Union[timedelta, int]]) – How long the slowdown should be
reason (Optional[str]) – The reason for creating the thread

Returns:

The thread object

Return type:

Union[PublicThread, PrivateThread, NewsThread]

Raises:

ValueError –

If the auto_archive_duration is not 60, 1440, 4320 or 10080 - If the rate_limit_per_user is not between 0 and 21600 seconds

async create_webhook(name: str, *, avatar: File | bytes | None = None, reason: str | None = None) → Webhook[source]¶

Create a webhook for the channel

Parameters:

name (str) – The name of the webhook
avatar (Optional[File]) – The avatar of the webhook
reason (Optional[str]) – The reason for creating the webhook that appears in audit logs

Returns:

The webhook object

Return type:

Webhook

async delete(*, reason: str | None = None) → None[source]¶

Delete the channel

Parameters:: reason (Optional[str]) – The reason for deleting the channel

async delete_permission(id: Snowflake | int, *, reason: str | None = None) → None[source]¶

Delete a permission overwrite for the channel

Parameters:

id (Union[Snowflake, int]) – The ID of the overwrite
reason (Optional[str]) – The reason for deleting the overwrite

Edit the channel

Note that this method globaly edits any channel type. So be sure to use the correct parameters for the channel.

Parameters:

name (Optional[str]) – New name of the channel (All)
type (Optional[Union[ChannelType, int]]) – The new type of the channel (Text, Announcement)
position (Optional[int]) – The new position of the channel (All)
topic (Optional[str]) – The new topic of the channel (Text, Announcement, Forum, Media)
nsfw (Optional[bool]) – If the channel should be NSFW (Text, Voice, Announcement, Stage, Forum, Media)
rate_limit_per_user (Optional[int]) – How long the slowdown should be (Text, Voice, Stage, Forum, Media)
bitrate (Optional[int]) – The new bitrate of the channel (Voice, Stage)
user_limit (Optional[int]) – The new user limit of the channel (Voice, Stage)
overwrites (Optional[list[PermissionOverwrite]]) – The new permission overwrites of the channel (All)
parent_id (Optional[Union[Snowflake, int]]) – The new parent ID of the channel (Text, Voice, Announcement, Stage, Forum, Media)
rtc_region (Optional[str]) – The new RTC region of the channel (Voice, Stage)
video_quality_mode (Optional[Union[VideoQualityType, int]]) – The new video quality mode of the channel (Voice, Stage)
default_auto_archive_duration (Optional[int]) – The new default auto archive duration of the channel (Text, Announcement, Forum, Media)
flags (Optional[ChannelFlags]) – The new flags of the channel (Forum, Media)
available_tags (Optional[list[ForumTag]]) – The new available tags of the channel (Forum, Media)
default_reaction_emoji (Optional[str]) – The new default reaction emoji of the channel (Forum, Media)
default_thread_rate_limit_per_user (Optional[int]) – The new default thread rate limit per user of the channel (Text, Forum, Media)
default_sort_order (Optional[Union[SortOrderType, int]]) – The new default sort order of the channel (Forum, Media)
default_forum_layout (Optional[Union[ForumLayoutType, int]]) – The new default forum layout of the channel (Forum)
archived (Optional[bool]) – If the thread should be archived (Thread, Forum)
auto_archive_duration (Optional[int]) – The new auto archive duration of the thread (Thread, Forum)
locked (Optional[bool]) – If the thread should be locked (Thread, Forum)
invitable (Optional[bool]) – If the thread should be invitable by everyone (Thread)
applied_tags (Optional[list[Union[ForumTag, int]]) – The new applied tags of the forum thread (Forum, Media)
reason (Optional[str]) – The reason for editing the channel (All)

Returns:

The channel object

Return type:

BaseChannel

async fetch() → BaseChannel[source]¶: BaseChannel: Fetches the channel and returns the channel object

async fetch_archived_private_threads(*, client: bool = False) → list[PrivateThread][source]¶

Fetch all archived private threads

Parameters:: client (bool) – If it should fetch only where the client is a member of the thread
Returns:: The list of private threads
Return type:: list[PrivateThread]

async fetch_archived_public_threads() → list[PublicThread][source]¶

Fetch all archived public threads

Returns:: The list of public threads
Return type:: list[PublicThread]

Fetch the channel’s message history

Parameters:

before (Optional[Union[datetime, Message, Snowflake, int]]) – Get messages before this message
after (Optional[Union[datetime, Message, Snowflake, int]]) – Get messages after this message
around (Optional[Union[datetime, Message, Snowflake, int]]) – Get messages around this message
limit (Optional[int]) – The maximum amount of messages to fetch. None will fetch all users.

Yields:

Message – The message object

async fetch_message(message_id: int) → Message[source]¶

Fetch a message from the channel

Parameters:: message_id (int) – The message ID to fetch
Returns:: The message object
Return type:: Message

async fetch_pins() → list[Message][source]¶

Fetch all pinned messages for the channel in question

Returns:: The list of pinned messages
Return type:: list[Message]

async fetch_thread_member(user_id: int) → ThreadMember[source]¶

Fetch a thread member

Parameters:: user_id (int) – The user ID to fetch
Returns:: The thread member object
Return type:: ThreadMember

async fetch_thread_members() → list[ThreadMember][source]¶

Fetch all thread members

Returns:: The list of thread members
Return type:: list[ThreadMember]

async follow_announcement_channel(source_channel_id: Snowflake | int) → None[source]¶

Follow an announcement channel to send messages to the webhook

Parameters:: source_channel_id (int) – The channel ID to follow

classmethod from_dict(*, state: DiscordAPI, data: dict) → Self[source]¶

Create a channel object from a dictionary Requires the state to be set

Parameters:

state (DiscordAPI) – The state to use
data (dict) – Data provided by Discord API

Returns:

The channel object

Return type:

BaseChannel

get_partial_message(message_id: int) → PartialMessage[source]¶

Get a partial message object from the channel

Parameters:: message_id (int) – The message ID to get the partial message from
Returns:: The partial message object
Return type:: PartialMessage

property guild: Guild | PartialGuild | None¶: Optional[Guild | PartialGuild]: The guild the channel belongs to (if available). If you are using gateway cache, it can return full object too

async join_thread() → None[source]¶: Make the bot join a thread

async leave_thread() → None[source]¶: Make the bot leave a thread

property mention: str¶

The channel’s mention

Type:: str

property parent: BaseChannel | CategoryChannel | PartialChannel | None¶: BaseChannel | CategoryChannel | PartialChannel | None: Returns the parent channel of the thread or the parent category of the channel. Only returns a full object if cache is enabled for guild and channel.

permissions_for(member: Member) → Permissions[source]¶

Returns the permissions for a member in the channel. However since this is Partial, it will always return Permissions.none()

Parameters:: member (Member) – The member to get the permissions for.
Returns:: The permissions for the member in the channel.
Return type:: Permissions

async remove_thread_member(user_id: int) → None[source]¶

Remove a thread member

Parameters:: user_id (int) – The user ID to remove

async send(content: str | None = <MISSING>, *, embed: ~discord_http.embeds.Embed | None = <MISSING>, embeds: list[~discord_http.embeds.Embed] | None = <MISSING>, file: ~discord_http.file.File | None = <MISSING>, files: list[~discord_http.file.File] | None = <MISSING>, view: ~discord_http.view.View | None = <MISSING>, tts: bool | None = False, type: ~discord_http.enums.ResponseType | int = 4, poll: Poll | None = <MISSING>, flags: ~discord_http.flags.MessageFlags | None = <MISSING>, allowed_mentions: ~discord_http.mentions.AllowedMentions | None = <MISSING>, delete_after: float | None = None) → Message[source]¶

Send a message to the channel

Parameters:

content (Optional[str]) – Cotnent of the message
embed (Optional[Embed]) – Includes an embed object
embeds (Optional[list[Embed]]) – List of embed objects
file (Optional[File]) – A file object
files (Union[list[File], File]) – A list of file objects
view (View) – Send components to the message
tts (bool) – If the message should be sent as a TTS message
type (Optional[ResponseType]) – The type of response to the message
allowed_mentions (Optional[AllowedMentions]) – The allowed mentions for the message
poll (Optional[Poll]) – The poll to be sent
flags (Optional[MessageFlags]) – Flags of the message
delete_after (Optional[float]) – How long to wait before deleting the message

Returns:

The message object

Return type:

Message

async set_permission(overwrite: PermissionOverwrite, *, reason: str | None = None) → None[source]¶

Set a permission overwrite for the channel

Parameters:

overwrite (PermissionOverwrite) – The new overwrite permissions for the spesific role/user
reason (Optional[str]) – The reason for editing the overwrite

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

typing() → Typing[source]¶

Makes the bot trigger the typing indicator. There are two ways you can use this:

Usual await call
Using async with to type as long as you need

# Method 1
await channel.typing()  # Stops after 10 seconds or message sent

# Method 2
async with channel.typing():
    asyncio.sleep(4)

class discord_http.channel.PartialThread(*, state: DiscordAPI, id: int, guild_id: int, parent_id: int, type: ChannelType | int)[source]¶

Bases: PartialChannel

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.PrivateThread(*, state: DiscordAPI, data: dict)[source]¶

Bases: PublicThread

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.PublicThread(*, state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

property guild: Guild | PartialGuild | None¶

Returns a partial guild object

Type:: PartialGuild

property last_message: PartialMessage | None¶

Returns a partial message object if the last message ID is available

Type:: Optional[PartialMessage]

property owner: PartialUser | None¶

Returns a partial user object

Type:: PartialUser

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.StageChannel(*, state: DiscordAPI, data: dict)[source]¶

Bases: VoiceChannel

async create_stage_instance(*, topic: str, privacy_level: ~discord_http.enums.PrivacyLevelType = <MISSING>, send_start_notification: bool = <MISSING>, guild_scheduled_event: ~discord_http.object.Snowflake | int = <MISSING>, reason: str | None = None) → StageInstance[source]¶

Create a stage instance

Parameters:

topic (str) – The topic of the stage instance
privacy_level (PrivacyLevelType) – The privacy level of the stage instance. Defaults to PrivacyLevelType.guild_only
send_start_notification (bool) – Whether to notify @everyone that the stage instance has started.
guild_scheduled_event (Optional[Snowflake | int]) – The guild scheduled event to associate with this stage instance.
reason (Optional[str]) – The reason for creating the stage instance

Returns:

The created stage instance

Return type:

StageInstance

async fetch_stage_instance() → StageInstance[source]¶

Fetch the stage instance associated with this stage channel

Returns:: The stage instance of the channel
Return type:: StageInstance

property stage_instance: StageInstance | None¶

Returns the stage instance for this channel, if available and cached.

Type:: Optional[StageInstance]

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.StoreChannel(*, state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.TextChannel(*, state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.Thread(*, state: DiscordAPI, data: dict)[source]¶

Bases: PublicThread

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.VoiceChannel(*, state: DiscordAPI, data: dict)[source]¶

Bases: BaseChannel

property type: ChannelType¶

Returns the channel’s type

Type:: ChannelType

class discord_http.channel.VoiceRegion(*, data: dict)[source]¶: Bases: object