API Reference

The following section outlines the API of disnake.

Note

This module uses the Python logging module to log diagnostic and errors in an output independent way. If the logging module is not configured, these logs will not be output anywhere. See Setting Up Logging for more information on how to set up and use the logging module with disnake.

Version Related Info

There are two main ways to query version information about the library. For guarantees, check Version Guarantees.

disnake.version_info

A named tuple that is similar to sys.version_info.

Just like sys.version_info the valid values for releaselevel are ‘alpha’, ‘beta’, ‘candidate’ and ‘final’.

disnake.__version__

A string representation of the version. e.g. '1.0.0rc1'. This is based off of PEP 440.

Clients

Client

Attributes

• activity
• allowed_mentions
• application_flags
• application_id
• cached_messages
• emojis
• global_application_commands
• global_message_commands
• global_slash_commands
• global_user_commands
• guilds
• i18n
• intents
• latency
• loop
• persistent_views
• private_channels
• session_start_limit
• status
• stickers
• user
• users
• voice_clients
• ws

Methods

• defadd_view
• asyncapplication_info
• asyncbefore_identify_hook
• asyncbulk_fetch_command_permissions
• asyncbulk_overwrite_global_commands
• asyncbulk_overwrite_guild_commands
• asyncchange_presence
• defclear
• asyncclose
• asyncconnect
• asynccreate_dm
• asynccreate_global_command
• asynccreate_guild
• asynccreate_guild_command
• asyncdelete_global_command
• asyncdelete_guild_command
• asyncdelete_invite
• asyncedit_global_command
• asyncedit_guild_command
• asyncedit_role_connection_metadata
• @event
• asyncfetch_channel
• asyncfetch_command_permissions
• asyncfetch_global_command
• asyncfetch_global_commands
• asyncfetch_guild
• asyncfetch_guild_command
• asyncfetch_guild_commands
• asyncfetch_guild_preview
• deffetch_guilds
• asyncfetch_invite
• asyncfetch_premium_sticker_packs
• asyncfetch_role_connection_metadata
• asyncfetch_stage_instance
• asyncfetch_sticker
• asyncfetch_template
• asyncfetch_user
• asyncfetch_voice_regions
• asyncfetch_webhook
• asyncfetch_widget
• defget_all_channels
• defget_all_members
• defget_channel
• defget_emoji
• defget_global_command
• defget_global_command_named
• defget_guild
• defget_guild_application_commands
• defget_guild_command
• defget_guild_command_named
• defget_guild_message_commands
• defget_guild_slash_commands
• defget_guild_user_commands
• defget_message
• asyncget_or_fetch_user
• defget_partial_messageable
• defget_stage_instance
• defget_sticker
• defget_user
• asyncgetch_user
• defguild_builder
• defis_closed
• defis_ready
• defis_ws_ratelimited
• asynclogin
• asyncon_error
• asyncon_gateway_error
• defrun
• asyncstart
• asyncwait_for
• asyncwait_until_first_connect
• asyncwait_until_ready

class disnake.Client(*, asyncio_debug=False, loop=None, shard_id=None, shard_count=None, enable_debug_events=False, enable_gateway_error_handler=True, localization_provider=None, strict_localization=False, gateway_params=None, connector=None, proxy=None, proxy_auth=None, assume_unsync_clock=True, max_messages=1000, application_id=None, heartbeat_timeout=60.0, guild_ready_timeout=2.0, allowed_mentions=None, activity=None, status=None, intents=None, chunk_guilds_at_startup=None, member_cache_flags=None)

Represents a client connection that connects to Discord. This class is used to interact with the Discord WebSocket and API.

A number of options can be passed to the Client.

Parameters:

• max_messages (Optional[int]) –

  The maximum number of messages to store in the internal message cache. This defaults to 1000. Passing in None disables the message cache.

  Changed in version 1.3: Allow disabling the message cache and change the default size to 1000.

• loop (Optional[asyncio.AbstractEventLoop]) – The asyncio.AbstractEventLoop to use for asynchronous operations. Defaults to None, in which case the default event loop is used via asyncio.get_event_loop().

• asyncio_debug (bool) – Whether to enable asyncio debugging when the client starts. Defaults to False.

• connector (Optional[aiohttp.BaseConnector]) – The connector to use for connection pooling.

• proxy (Optional[str]) – Proxy URL.

• proxy_auth (Optional[aiohttp.BasicAuth]) – An object that represents proxy HTTP Basic Authorization.

• shard_id (Optional[int]) – Integer starting at 0 and less than shard_count.

• shard_count (Optional[int]) – The total number of shards.

• application_id (int) – The client’s application ID.

• intents (Optional[Intents]) –

  The intents that you want to enable for the session. This is a way of disabling and enabling certain gateway events from triggering and being sent. If not given, defaults to a regularly constructed Intents class.

  New in version 1.5.

• member_cache_flags (MemberCacheFlags) –

  Allows for finer control over how the library caches members. If not given, defaults to cache as much as possible with the currently selected intents.

  New in version 1.5.

• chunk_guilds_at_startup (bool) –

  Indicates if on_ready() should be delayed to chunk all guilds at start-up if necessary. This operation is incredibly slow for large amounts of guilds. The default is True if Intents.members is True.

  New in version 1.5.

• status (Optional[Union[class:str, Status]]) – A status to start your presence with upon logging on to Discord.

• activity (Optional[BaseActivity]) – An activity to start your presence with upon logging on to Discord.

• allowed_mentions (Optional[AllowedMentions]) –

  Control how the client handles mentions by default on every message sent.

  New in version 1.4.

• heartbeat_timeout (float) – The maximum numbers of seconds before timing out and restarting the WebSocket in the case of not receiving a HEARTBEAT_ACK. Useful if processing the initial packets take too long to the point of disconnecting you. The default timeout is 60 seconds.

• guild_ready_timeout (float) –

  The maximum number of seconds to wait for the GUILD_CREATE stream to end before preparing the member cache and firing READY. The default timeout is 2 seconds.

  New in version 1.4.

• assume_unsync_clock (bool) –

  Whether to assume the system clock is unsynced. This applies to the ratelimit handling code. If this is set to True, the default, then the library uses the time to reset a rate limit bucket given by Discord. If this is False then your system clock is used to calculate how long to sleep for. If this is set to False it is recommended to sync your system clock to Google’s NTP server.

  New in version 1.3.

• enable_debug_events (bool) –

  Whether to enable events that are useful only for debugging gateway related information.

  Right now this involves on_socket_raw_receive() and on_socket_raw_send(). If this is False then those events will not be dispatched (due to performance considerations). To enable these events, this must be set to True. Defaults to False.

  New in version 2.0.

• enable_gateway_error_handler (bool) –

  Whether to enable the disnake.on_gateway_error() event. Defaults to True.

  If this is disabled, exceptions that occur while parsing (known) gateway events won’t be handled and the pre-v2.6 behavior of letting the exception propagate up to the connect()/start()/run() call is used instead.

  New in version 2.6.

• localization_provider (LocalizationProtocol) –

  An implementation of LocalizationProtocol to use for localization of application commands. If not provided, the default LocalizationStore implementation is used.

  New in version 2.5.

  Changed in version 2.6: Can no longer be provided together with strict_localization, as it does not apply to the custom localization provider entered in this parameter.

• strict_localization (bool) –

  Whether to raise an exception when localizations for a specific key couldn’t be found. This is mainly useful for testing/debugging, consider disabling this eventually as missing localized names will automatically fall back to the default/base name without it. Only applicable if the localization_provider parameter is not provided. Defaults to False.

  New in version 2.5.

  Changed in version 2.6: Can no longer be provided together with localization_provider, as this parameter is ignored for custom localization providers.

• gateway_params (GatewayParams) –

  Allows configuring parameters used for establishing gateway connections, notably enabling/disabling compression (enabled by default). Encodings other than JSON are not supported.

  New in version 2.6.

ws

The websocket gateway the client is currently connected to. Could be None.

loop

The event loop that the client uses for asynchronous operations.

Type:

asyncio.AbstractEventLoop

session_start_limit

Information about the current session start limit. Only available after initiating the connection.

New in version 2.5.

Type:

Optional[SessionStartLimit]

i18n

An implementation of LocalizationProtocol used for localization of application commands.

New in version 2.5.

Type:

LocalizationProtocol

@event

A decorator that registers an event to listen to.

You can find more info about the events on the documentation below.

The events must be a coroutine, if not, TypeError is raised.

Example

@client.event
async def on_ready():
    print('Ready!')

Raises:

TypeError – The coroutine passed is not actually a coroutine.

async for ... in fetch_guilds(*, limit=100, before=None, after=None)

Retrieves an AsyncIterator that enables receiving your guilds.

Note

Using this, you will only receive Guild.owner, Guild.icon, Guild.id, and Guild.name per Guild.

Note

This method is an API call. For general usage, consider guilds instead.

Examples

Usage

async for guild in client.fetch_guilds(limit=150):
    print(guild.name)

Flattening into a list

guilds = await client.fetch_guilds(limit=150).flatten()
# guilds is now a list of Guild...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of guilds to retrieve. If None, it retrieves every guild you have access to. Note, however, that this would make it a slow operation. Defaults to 100.

• before (Union[abc.Snowflake, datetime.datetime]) – Retrieves guilds before this date or object. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Union[abc.Snowflake, datetime.datetime]) – Retrieve guilds after this date or object. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

Raises:

HTTPException – Retrieving the guilds failed.

Yields:

Guild – The guild with the guild data parsed.

property latency

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

This could be referred to as the Discord WebSocket protocol latency.

Type:

float

is_ws_ratelimited()

Whether the websocket is currently rate limited.

This can be useful to know when deciding whether you should query members using HTTP or via the gateway.

New in version 1.6.

Return type:

bool

property user

Represents the connected client. None if not logged in.

Type:

Optional[ClientUser]

property guilds

The guilds that the connected client is a member of.

Type:

List[Guild]

property emojis

The emojis that the connected client has.

Type:

List[Emoji]

property stickers

The stickers that the connected client has.

New in version 2.0.

Type:

List[GuildSticker]

property cached_messages

Read-only list of messages the connected client has cached.

New in version 1.1.

Type:

Sequence[Message]

property private_channels

The private channels that the connected client is participating on.

Note

This returns only up to 128 most recent private channels due to an internal working on how Discord deals with private channels.

Type:

List[abc.PrivateChannel]

property voice_clients

Represents a list of voice connections.

These are usually VoiceClient instances.

Type:

List[VoiceProtocol]

property application_id

The client’s application ID.

If this is not passed via __init__ then this is retrieved through the gateway when an event contains the data. Usually after on_connect() is called.

New in version 2.0.

Type:

Optional[int]

property application_flags

The client’s application flags.

New in version 2.0.

Type:

ApplicationFlags

property global_application_commands

The client’s global application commands.

Type:

List[Union[APIUserCommand, APIMessageCommand, APISlashCommand]

property global_slash_commands

The client’s global slash commands.

Type:

List[APISlashCommand]

property global_user_commands

The client’s global user commands.

Type:

List[APIUserCommand]

property global_message_commands

The client’s global message commands.

Type:

List[APIMessageCommand]

get_message(id)

Gets the message with the given ID from the bot’s message cache.

Parameters:

id (int) – The ID of the message to look for.

Returns:

The corresponding message.

Return type:

Optional[Message]

await get_or_fetch_user(user_id, *, strict=False)

This function is a coroutine.

Tries to get the user from the cache. If fails, it tries to fetch the user from the API.

Parameters:

• user_id (int) – The ID to search for.

• strict (bool) – Whether to propagate exceptions from fetch_user() instead of returning None in case of failure (e.g. if the user wasn’t found). Defaults to False.

Returns:

The user with the given ID, or None if not found and strict is set to False.

Return type:

Optional[User]

await getch_user(user_id, *, strict=False)

This function is a coroutine.

Tries to get the user from the cache. If fails, it tries to fetch the user from the API.

Parameters:

• user_id (int) – The ID to search for.

• strict (bool) – Whether to propagate exceptions from fetch_user() instead of returning None in case of failure (e.g. if the user wasn’t found). Defaults to False.

Returns:

The user with the given ID, or None if not found and strict is set to False.

Return type:

Optional[User]

is_ready()

Whether the client’s internal cache is ready for use.

Return type:

bool

await on_error(event_method, *args, **kwargs)

This function is a coroutine.

The default error handler provided by the client.

By default this prints to sys.stderr however it could be overridden to have a different implementation. Check on_error() for more details.

await on_gateway_error(event, data, shard_id, exc, /)

This function is a coroutine.

The default gateway error handler provided by the client.

By default this prints to sys.stderr however it could be overridden to have a different implementation. Check on_gateway_error() for more details.

New in version 2.6.

Note

Unlike on_error(), the exception is available as the exc parameter and cannot be obtained through sys.exc_info().

await before_identify_hook(shard_id, *, initial=False)

This function is a coroutine.

A hook that is called before IDENTIFYing a session. This is useful if you wish to have more control over the synchronization of multiple IDENTIFYing clients.

The default implementation sleeps for 5 seconds.

New in version 1.4.

Parameters:

• shard_id (int) – The shard ID that requested being IDENTIFY’d

• initial (bool) – Whether this IDENTIFY is the first initial IDENTIFY.

await login(token)

This function is a coroutine.

Logs in the client with the specified credentials.

Parameters:

token (str) – The authentication token. Do not prefix this token with anything as the library will do it for you.

Raises:

• LoginFailure – The wrong credentials are passed.

• HTTPException – An unknown HTTP related error occurred, usually when it isn’t 200 or the known incorrect credentials passing status code.

await connect(*, reconnect=True, ignore_session_start_limit=False)

This function is a coroutine.

Creates a websocket connection and lets the websocket listen to messages from Discord. This is a loop that runs the entire event system and miscellaneous aspects of the library. Control is not resumed until the WebSocket connection is terminated.

Changed in version 2.6: Added usage of SessionStartLimit when connecting to the API. Added the ignore_session_start_limit parameter.

Parameters:

• reconnect (bool) – Whether reconnecting should be attempted, either due to internet failure or a specific failure on Discord’s part. Certain disconnects that lead to bad state will not be handled (such as invalid sharding payloads or bad tokens).

• ignore_session_start_limit (bool) –

  Whether the API provided session start limit should be ignored when connecting to the API.

  New in version 2.6.

Raises:

• GatewayNotFound – If the gateway to connect to Discord is not found. Usually if this is thrown then there is a Discord API outage.

• ConnectionClosed – The websocket connection has been terminated.

• SessionStartLimitReached – If the client doesn’t have enough connects remaining in the current 24-hour window and ignore_session_start_limit is False this will be raised rather than connecting to the gateawy and Discord resetting the token. However, if ignore_session_start_limit is True, the client will connect regardless and this exception will not be raised.

await close()

This function is a coroutine.

Closes the connection to Discord.

clear()

Clears the internal state of the bot.

After this, the bot can be considered “re-opened”, i.e. is_closed() and is_ready() both return False along with the bot’s internal cache cleared.

await start(token, *, reconnect=True, ignore_session_start_limit=False)

This function is a coroutine.

A shorthand coroutine for login() + connect().

Raises:

TypeError – An unexpected keyword argument was received.

run(*args, **kwargs)

A blocking call that abstracts away the event loop initialisation from you.

If you want more control over the event loop then this function should not be used. Use start() coroutine or connect() + login().

Roughly Equivalent to:

try:
    loop.run_until_complete(start(*args, **kwargs))
except KeyboardInterrupt:
    loop.run_until_complete(close())
    # cancel all tasks lingering
finally:
    loop.close()

Warning

This function must be the last function to call due to the fact that it is blocking. That means that registration of events or anything being called after this function call will not execute until it returns.

is_closed()

Whether the websocket connection is closed.

Return type:

bool

property activity

The activity being used upon logging in.

Type:

Optional[BaseActivity]

property status

The status being used upon logging on to Discord.

New in version 2.0.

Type:

Status

property allowed_mentions

The allowed mention configuration.

New in version 1.4.

Type:

Optional[AllowedMentions]

property intents

The intents configured for this connection.

New in version 1.5.

Type:

Intents

property users

Returns a list of all the users the bot can see.

Type:

List[User]

get_channel(id, /)

Returns a channel or thread with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The returned channel or None if not found.

Return type:

Optional[Union[abc.GuildChannel, Thread, abc.PrivateChannel]]

get_partial_messageable(id, *, type=None)

Returns a partial messageable with the given channel ID.

This is useful if you have a channel_id but don’t want to do an API call to send messages to it.

New in version 2.0.

Parameters:

• id (int) – The channel ID to create a partial messageable for.

• type (Optional[ChannelType]) – The underlying channel type for the partial messageable.

Returns:

The partial messageable

Return type:

PartialMessageable

get_stage_instance(id, /)

Returns a stage instance with the given stage channel ID.

New in version 2.0.

Parameters:

id (int) – The ID to search for.

Returns:

The returns stage instance or None if not found.

Return type:

Optional[StageInstance]

get_guild(id, /)

Returns a guild with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The guild or None if not found.

Return type:

Optional[Guild]

get_user(id, /)

Returns a user with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The user or None if not found.

Return type:

Optional[User]

get_emoji(id, /)

Returns an emoji with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The custom emoji or None if not found.

Return type:

Optional[Emoji]

get_sticker(id, /)

Returns a guild sticker with the given ID.

New in version 2.0.

Note

To retrieve standard stickers, use fetch_sticker(). or fetch_premium_sticker_packs().

Returns:

The sticker or None if not found.

Return type:

Optional[GuildSticker]

for ... in get_all_channels()

A generator that retrieves every abc.GuildChannel the client can ‘access’.

This is equivalent to:

for guild in client.guilds:
    for channel in guild.channels:
        yield channel

Note

Just because you receive a abc.GuildChannel does not mean that you can communicate in said channel. abc.GuildChannel.permissions_for() should be used for that.

Yields:

abc.GuildChannel – A channel the client can ‘access’.

for ... in get_all_members()

Returns a generator with every Member the client can see.

This is equivalent to:

for guild in client.guilds:
    for member in guild.members:
        yield member

Yields:

Member – A member the client can see.

get_guild_application_commands(guild_id)

Returns a list of all application commands in the guild with the given ID.

Parameters:

guild_id (int) – The ID to search for.

Returns:

The list of application commands.

Return type:

List[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

get_guild_slash_commands(guild_id)

Returns a list of all slash commands in the guild with the given ID.

Parameters:

guild_id (int) – The ID to search for.

Returns:

The list of slash commands.

Return type:

List[APISlashCommand]

get_guild_user_commands(guild_id)

Returns a list of all user commands in the guild with the given ID.

Parameters:

guild_id (int) – The ID to search for.

Returns:

The list of user commands.

Return type:

List[APIUserCommand]

get_guild_message_commands(guild_id)

Returns a list of all message commands in the guild with the given ID.

Parameters:

guild_id (int) – The ID to search for.

Returns:

The list of message commands.

Return type:

List[APIMessageCommand]

get_global_command(id)

Returns a global application command with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The application command.

Return type:

Optional[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

get_guild_command(guild_id, id)

Returns a guild application command with the given guild ID and application command ID.

Parameters:

• guild_id (int) – The guild ID to search for.

• id (int) – The command ID to search for.

Returns:

The application command.

Return type:

Optional[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

get_global_command_named(name, cmd_type=None)

Returns a global application command matching the given name.

Parameters:

• name (str) – The name to look for.

• cmd_type (ApplicationCommandType) – The type to look for. By default, no types are checked.

Returns:

The application command.

Return type:

Optional[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

get_guild_command_named(guild_id, name, cmd_type=None)

Returns a guild application command matching the given name.

Parameters:

• guild_id (int) – The guild ID to search for.

• name (str) – The command name to search for.

• cmd_type (ApplicationCommandType) – The type to look for. By default, no types are checked.

Returns:

The application command.

Return type:

Optional[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

await wait_until_ready()

This function is a coroutine.

Waits until the client’s internal cache is all ready.

await wait_until_first_connect()

This function is a coroutine.

Waits until the first connect.

wait_for(event, *, check=None, timeout=None)

This function is a coroutine.

Waits for a WebSocket event to be dispatched.

This could be used to wait for a user to reply to a message, or to react to a message, or to edit a message in a self-contained way.

The timeout parameter is passed onto asyncio.wait_for(). By default, it does not timeout. Note that this does propagate the asyncio.TimeoutError for you in case of timeout and is provided for ease of use.

In case the event returns multiple arguments, a tuple containing those arguments is returned instead. Please check the documentation for a list of events and their parameters.

This function returns the first event that meets the requirements.

Examples

Waiting for a user reply:

@client.event
async def on_message(message):
    if message.content.startswith('$greet'):
        channel = message.channel
        await channel.send('Say hello!')

        def check(m):
            return m.content == 'hello' and m.channel == channel

        msg = await client.wait_for('message', check=check)
        await channel.send(f'Hello {msg.author}!')

# using events enums:
@client.event
async def on_message(message):
    if message.content.startswith('$greet'):
        channel = message.channel
        await channel.send('Say hello!')

        def check(m):
            return m.content == 'hello' and m.channel == channel

        msg = await client.wait_for(Event.message, check=check)
        await channel.send(f'Hello {msg.author}!')

Waiting for a thumbs up reaction from the message author:

@client.event
async def on_message(message):
    if message.content.startswith('$thumb'):
        channel = message.channel
        await channel.send('Send me that 👍 reaction, mate')

        def check(reaction, user):
            return user == message.author and str(reaction.emoji) == '👍'

        try:
            reaction, user = await client.wait_for('reaction_add', timeout=60.0, check=check)
        except asyncio.TimeoutError:
            await channel.send('👎')
        else:
            await channel.send('👍')

Parameters:

• event (Union[str, Event]) – The event name, similar to the event reference, but without the on_ prefix, to wait for. It’s recommended to use Event.

• check (Optional[Callable[…, bool]]) – A predicate to check what to wait for. The arguments must meet the parameters of the event being waited for.

• timeout (Optional[float]) – The number of seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns no arguments, a single argument, or a tuple of multiple arguments that mirrors the parameters passed in the event reference.

Return type:

Any

await change_presence(*, activity=None, status=None)

This function is a coroutine.

Changes the client’s presence.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Example

game = disnake.Game("with the API")
await client.change_presence(status=disnake.Status.idle, activity=game)

Changed in version 2.0: Removed the afk keyword-only parameter.

Parameters:

• activity (Optional[BaseActivity]) – The activity being done. None if no currently active activity is done.

• status (Optional[Status]) – Indicates what status to change to. If None, then Status.online is used.

Raises:

TypeError – If the activity parameter is not the proper type.

await fetch_template(code)

This function is a coroutine.

Retrieves a Template from a discord.new URL or code.

Parameters:

code (Union[Template, str]) – The Discord Template Code or URL (must be a discord.new URL).

Raises:

• NotFound – The template is invalid.

• HTTPException – Retrieving the template failed.

Returns:

The template from the URL/code.

Return type:

Template

await fetch_guild(guild_id, /)

This function is a coroutine.

Retrieves a Guild from the given ID.

Note

Using this, you will not receive Guild.channels, Guild.members, Member.activity and Member.voice per Member.

Note

This method is an API call. For general usage, consider get_guild() instead.

Parameters:

guild_id (int) – The ID of the guild to retrieve.

Raises:

• Forbidden – You do not have access to the guild.

• HTTPException – Retrieving the guild failed.

Returns:

The guild from the given ID.

Return type:

Guild

await fetch_guild_preview(guild_id, /)

This function is a coroutine.

Retrieves a GuildPreview from the given ID. Your bot does not have to be in this guild.

Note

This method may fetch any guild that has DISCOVERABLE in Guild.features, but this information can not be known ahead of time.

This will work for any guild that you are in.

Parameters:

guild_id (int) – The ID of the guild to to retrieve a preview object.

Raises:

NotFound – Retrieving the guild preview failed.

Returns:

The guild preview from the given ID.

Return type:

GuildPreview

await create_guild(*, name, icon=..., code=...)

This function is a coroutine.

Creates a Guild.

See guild_builder() for a more comprehensive alternative.

Bot accounts in 10 or more guilds are not allowed to create guilds.

Changed in version 2.5: Removed the region parameter.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

• name (str) – The name of the guild.

• icon (Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]) –

  The icon of the guild. See ClientUser.edit() for more details on what is expected.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• code (str) –

  The code for a template to create the guild with.

  New in version 1.4.

Raises:

• NotFound – The icon asset couldn’t be found.

• HTTPException – Guild creation failed.

• ValueError – Invalid icon image format given. Must be PNG or JPG.

• TypeError – The icon asset is a lottie sticker (see Sticker.read).

Returns:

The created guild. This is not the same guild that is added to cache.

Return type:

Guild

guild_builder(name)

Creates a builder object that can be used to create more complex guilds.

This is a more comprehensive alternative to create_guild(). See GuildBuilder for details and examples.

Bot accounts in 10 or more guilds are not allowed to create guilds.

New in version 2.8.

Parameters:

name (str) – The name of the guild.

Returns:

The guild builder object for configuring and creating a new guild.

Return type:

GuildBuilder

await fetch_stage_instance(channel_id, /)

This function is a coroutine.

Retrieves a StageInstance with the given ID.

Note

This method is an API call. For general usage, consider get_stage_instance() instead.

New in version 2.0.

Parameters:

channel_id (int) – The stage channel ID.

Raises:

• NotFound – The stage instance or channel could not be found.

• HTTPException – Retrieving the stage instance failed.

Returns:

The stage instance from the given ID.

Return type:

StageInstance

await fetch_invite(url, *, with_counts=True, with_expiration=True, guild_scheduled_event_id=None)

This function is a coroutine.

Retrieves an Invite from a discord.gg URL or ID.

Note

If the invite is for a guild you have not joined, the guild and channel attributes of the returned Invite will be PartialInviteGuild and PartialInviteChannel respectively.

Parameters:

• url (Union[Invite, str]) – The Discord invite ID or URL (must be a discord.gg URL).

• with_counts (bool) – Whether to include count information in the invite. This fills the Invite.approximate_member_count and Invite.approximate_presence_count fields.

• with_expiration (bool) –

  Whether to include the expiration date of the invite. This fills the Invite.expires_at field.

  New in version 2.0.

• guild_scheduled_event_id (int) –

  The ID of the scheduled event to include in the invite. If not provided, defaults to the event parameter in the URL if it exists, or the ID of the scheduled event contained in the provided invite object.

  New in version 2.3.

Raises:

• NotFound – The invite has expired or is invalid.

• HTTPException – Retrieving the invite failed.

Returns:

The invite from the URL/ID.

Return type:

Invite

await delete_invite(invite)

This function is a coroutine.

Revokes an Invite, URL, or ID to an invite.

You must have manage_channels permission in the associated guild to do this.

Parameters:

invite (Union[Invite, str]) – The invite to revoke.

Raises:

• Forbidden – You do not have permissions to revoke invites.

• NotFound – The invite is invalid or expired.

• HTTPException – Revoking the invite failed.

await fetch_voice_regions(guild_id=None)

Retrieves a list of VoiceRegions.

Retrieves voice regions for the user, or a guild if provided.

New in version 2.5.

Parameters:

guild_id (Optional[int]) – The guild to get regions for, if provided.

Raises:

• HTTPException – Retrieving voice regions failed.

• NotFound – The provided guild_id could not be found.

await fetch_widget(guild_id, /)

This function is a coroutine.

Retrieves a Widget for the given guild ID.

Note

The guild must have the widget enabled to get this information.

Parameters:

guild_id (int) – The ID of the guild.

Raises:

• Forbidden – The widget for this guild is disabled.

• HTTPException – Retrieving the widget failed.

Returns:

The guild’s widget.

Return type:

Widget

await application_info()

This function is a coroutine.

Retrieves the bot’s application information.

Raises:

HTTPException – Retrieving the information failed somehow.

Returns:

The bot’s application information.

Return type:

AppInfo

await fetch_user(user_id, /)

This function is a coroutine.

Retrieves a User based on their ID. You do not have to share any guilds with the user to get this information, however many operations do require that you do.

Note

This method is an API call. If you have disnake.Intents.members and member cache enabled, consider get_user() instead.

Parameters:

user_id (int) – The ID of the user to retrieve.

Raises:

• NotFound – A user with this ID does not exist.

• HTTPException – Retrieving the user failed.

Returns:

The user you requested.

Return type:

User

await fetch_channel(channel_id, /)

This function is a coroutine.

Retrieves a abc.GuildChannel, abc.PrivateChannel, or Thread with the specified ID.

Note

This method is an API call. For general usage, consider get_channel() instead.

New in version 1.2.

Parameters:

channel_id (int) – The ID of the channel to retrieve.

Raises:

• InvalidData – An unknown channel type was received from Discord.

• HTTPException – Retrieving the channel failed.

• NotFound – Invalid Channel ID.

• Forbidden – You do not have permission to fetch this channel.

Returns:

The channel from the ID.

Return type:

Union[abc.GuildChannel, abc.PrivateChannel, Thread]

await fetch_webhook(webhook_id, /)

This function is a coroutine.

Retrieves a Webhook with the given ID.

Parameters:

webhook_id (int) – The ID of the webhook to retrieve.

Raises:

• HTTPException – Retrieving the webhook failed.

• NotFound – Invalid webhook ID.

• Forbidden – You do not have permission to fetch this webhook.

Returns:

The webhook you requested.

Return type:

Webhook

await fetch_sticker(sticker_id, /)

This function is a coroutine.

Retrieves a Sticker with the given ID.

New in version 2.0.

Parameters:

sticker_id (int) – The ID of the sticker to retrieve.

Raises:

• HTTPException – Retrieving the sticker failed.

• NotFound – Invalid sticker ID.

Returns:

The sticker you requested.

Return type:

Union[StandardSticker, GuildSticker]

await fetch_premium_sticker_packs()

This function is a coroutine.

Retrieves all available premium sticker packs.

New in version 2.0.

Raises:

HTTPException – Retrieving the sticker packs failed.

Returns:

All available premium sticker packs.

Return type:

List[StickerPack]

await create_dm(user)

This function is a coroutine.

Creates a DMChannel with the given user.

This should be rarely called, as this is done transparently for most people.

New in version 2.0.

Parameters:

user (Snowflake) – The user to create a DM with.

Returns:

The channel that was created.

Return type:

DMChannel

add_view(view, *, message_id=None)

Registers a View for persistent listening.

This method should be used for when a view is comprised of components that last longer than the lifecycle of the program.

New in version 2.0.

Parameters:

• view (disnake.ui.View) – The view to register for dispatching.

• message_id (Optional[int]) – The message ID that the view is attached to. This is currently used to refresh the view’s state during message update events. If not given then message update events are not propagated for the view.

Raises:

• TypeError – A view was not passed.

• ValueError – The view is not persistent. A persistent view has no timeout and all their components have an explicitly provided custom_id.

property persistent_views

A sequence of persistent views added to the client.

New in version 2.0.

Type:

Sequence[View]

await fetch_global_commands(*, with_localizations=True)

This function is a coroutine.

Retrieves a list of global application commands.

New in version 2.1.

Parameters:

with_localizations (bool) –

Whether to include localizations in the response. Defaults to True.

New in version 2.5.

Returns:

A list of application commands.

Return type:

List[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

await fetch_global_command(command_id)

This function is a coroutine.

Retrieves a global application command.

New in version 2.1.

Parameters:

command_id (int) – The ID of the command to retrieve.

Returns:

The requested application command.

Return type:

Union[APIUserCommand, APIMessageCommand, APISlashCommand]

await create_global_command(application_command)

This function is a coroutine.

Creates a global application command.

New in version 2.1.

Parameters:

application_command (ApplicationCommand) – An object representing the application command to create.

Returns:

The application command that was created.

Return type:

Union[APIUserCommand, APIMessageCommand, APISlashCommand]

await edit_global_command(command_id, new_command)

This function is a coroutine.

Edits a global application command.

New in version 2.1.

Parameters:

• command_id (int) – The ID of the application command to edit.

• new_command (ApplicationCommand) – An object representing the edited application command.

Returns:

The edited application command.

Return type:

Union[APIUserCommand, APIMessageCommand, APISlashCommand]

await delete_global_command(command_id)

This function is a coroutine.

Deletes a global application command.

New in version 2.1.

Parameters:

command_id (int) – The ID of the application command to delete.

await bulk_overwrite_global_commands(application_commands)

This function is a coroutine.

Overwrites several global application commands in one API request.

New in version 2.1.

Parameters:

application_commands (List[ApplicationCommand]) – A list of application commands to insert instead of the existing commands.

Returns:

A list of registered application commands.

Return type:

List[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

await fetch_guild_commands(guild_id, *, with_localizations=True)

This function is a coroutine.

Retrieves a list of guild application commands.

New in version 2.1.

Parameters:

• guild_id (int) – The ID of the guild to fetch commands from.

• with_localizations (bool) –

  Whether to include localizations in the response. Defaults to True.

  New in version 2.5.

Returns:

A list of application commands.

Return type:

List[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

await fetch_guild_command(guild_id, command_id)

This function is a coroutine.

Retrieves a guild application command.

New in version 2.1.

Parameters:

• guild_id (int) – The ID of the guild to fetch command from.

• command_id (int) – The ID of the application command to retrieve.

Returns:

The requested application command.

Return type:

Union[APIUserCommand, APIMessageCommand, APISlashCommand]

await create_guild_command(guild_id, application_command)

This function is a coroutine.

Creates a guild application command.

New in version 2.1.

Parameters:

• guild_id (int) – The ID of the guild where the application command should be created.

• application_command (ApplicationCommand) – The application command.

Returns:

The newly created application command.

Return type:

Union[APIUserCommand, APIMessageCommand, APISlashCommand]

await edit_guild_command(guild_id, command_id, new_command)

This function is a coroutine.

Edits a guild application command.

New in version 2.1.

Parameters:

• guild_id (int) – The ID of the guild where the application command should be edited.

• command_id (int) – The ID of the application command to edit.

• new_command (ApplicationCommand) – An object representing the edited application command.

Returns:

The newly edited application command.

Return type:

Union[APIUserCommand, APIMessageCommand, APISlashCommand]

await delete_guild_command(guild_id, command_id)

This function is a coroutine.

Deletes a guild application command.

New in version 2.1.

Parameters:

• guild_id (int) – The ID of the guild where the applcation command should be deleted.

• command_id (int) – The ID of the application command to delete.

await bulk_overwrite_guild_commands(guild_id, application_commands)

This function is a coroutine.

Overwrites several guild application commands in one API request.

New in version 2.1.

Parameters:

• guild_id (int) – The ID of the guild where the application commands should be overwritten.

• application_commands (List[ApplicationCommand]) – A list of application commands to insert instead of the existing commands.

Returns:

A list of registered application commands.

Return type:

List[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

await bulk_fetch_command_permissions(guild_id)

This function is a coroutine.

Retrieves a list of GuildApplicationCommandPermissions configured for the guild with the given ID.

New in version 2.1.

Parameters:

guild_id (int) – The ID of the guild to inspect.

await fetch_command_permissions(guild_id, command_id)

This function is a coroutine.

Retrieves GuildApplicationCommandPermissions for a specific application command in the guild with the given ID.

New in version 2.1.

Parameters:

• guild_id (int) – The ID of the guild to inspect.

• command_id (int) –

  The ID of the application command, or the application ID to fetch application-wide permissions.

  Changed in version 2.5: Can now also fetch application-wide permissions.

Returns:

The permissions configured for the specified application command.

Return type:

GuildApplicationCommandPermissions

await fetch_role_connection_metadata()

This function is a coroutine.

Retrieves the ApplicationRoleConnectionMetadata records for the application.

New in version 2.8.

Raises:

HTTPException – Retrieving the metadata records failed.

Returns:

The list of metadata records.

Return type:

List[ApplicationRoleConnectionMetadata]

await edit_role_connection_metadata(records)

This function is a coroutine.

Edits the ApplicationRoleConnectionMetadata records for the application.

An application can have up to 5 metadata records.

Warning

This will overwrite all existing metadata records. Consider fetching them first, and constructing the new list of metadata records based off of the returned list.

New in version 2.8.

Parameters:

records (Sequence[ApplicationRoleConnectionMetadata]) – The new metadata records.

Raises:

HTTPException – Editing the metadata records failed.

Returns:

The list of newly edited metadata records.

Return type:

List[ApplicationRoleConnectionMetadata]

AutoShardedClient

Attributes

• latencies
• latency
• shard_ids
• shards

Methods

• asyncchange_presence
• asyncclose
• asyncconnect
• defget_shard
• defis_ws_ratelimited

class disnake.AutoShardedClient(*args, shard_ids=None, **kwargs)

A client similar to Client except it handles the complications of sharding for the user into a more manageable and transparent single process bot.

When using this client, you will be able to use it as-if it was a regular Client with a single shard when implementation wise internally it is split up into multiple shards. This allows you to not have to deal with IPC or other complicated infrastructure.

It is recommended to use this client only if you have surpassed at least 1000 guilds.

If no shard_count is provided, then the library will use the Bot Gateway endpoint call to figure out how many shards to use.

If a shard_ids parameter is given, then those shard IDs will be used to launch the internal shards. Note that shard_count must be provided if this is used. By default, when omitted, the client will launch shards from 0 to shard_count - 1.

shard_ids

An optional list of shard_ids to launch the shards with.

Type:

Optional[List[int]]

property latency

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

This operates similarly to Client.latency() except it uses the average latency of every shard’s latency. To get a list of shard latency, check the latencies property. Returns nan if there are no shards ready.

Type:

float

property latencies

A list of latencies between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

This returns a list of tuples with elements (shard_id, latency).

Type:

List[Tuple[int, float]]

get_shard(shard_id)

Gets the shard information of a given shard ID, or None if not found.

Return type:

Optional[ShardInfo]

property shards

Returns a mapping of shard IDs to their respective info object.

Type:

Mapping[int, ShardInfo]

await connect(*, reconnect=True, ignore_session_start_limit=False)

This function is a coroutine.

Creates a websocket connection and lets the websocket listen to messages from Discord. This is a loop that runs the entire event system and miscellaneous aspects of the library. Control is not resumed until the WebSocket connection is terminated.

Changed in version 2.6: Added usage of SessionStartLimit when connecting to the API. Added the ignore_session_start_limit parameter.

Parameters:

• reconnect (bool) – Whether reconnecting should be attempted, either due to internet failure or a specific failure on Discord’s part. Certain disconnects that lead to bad state will not be handled (such as invalid sharding payloads or bad tokens).

• ignore_session_start_limit (bool) –

  Whether the API provided session start limit should be ignored when connecting to the API.

  New in version 2.6.

Raises:

• GatewayNotFound – If the gateway to connect to Discord is not found. Usually if this is thrown then there is a Discord API outage.

• ConnectionClosed – The websocket connection has been terminated.

• SessionStartLimitReached – If the client doesn’t have enough connects remaining in the current 24-hour window and ignore_session_start_limit is False this will be raised rather than connecting to the gateawy and Discord resetting the token. However, if ignore_session_start_limit is True, the client will connect regardless and this exception will not be raised.

await close()

This function is a coroutine.

Closes the connection to Discord.

await change_presence(*, activity=None, status=None, shard_id=None)

This function is a coroutine.

Changes the client’s presence.

Example:

game = disnake.Game("with the API")
await client.change_presence(status=disnake.Status.idle, activity=game)

Changed in version 2.0: Removed the afk keyword-only parameter.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• activity (Optional[BaseActivity]) – The activity being done. None if no currently active activity is done.

• status (Optional[Status]) – Indicates what status to change to. If None, then Status.online is used.

• shard_id (Optional[int]) – The shard_id to change the presence to. If not specified or None, then it will change the presence of every shard the bot can see.

Raises:

TypeError – If the activity parameter is not of proper type.

is_ws_ratelimited()

Whether the websocket is currently rate limited.

This can be useful to know when deciding whether you should query members using HTTP or via the gateway.

This implementation checks if any of the shards are rate limited. For more granular control, consider ShardInfo.is_ws_ratelimited().

New in version 1.6.

Return type:

bool

Application Info

AppInfo

Attributes

• bot_public
• bot_require_code_grant
• cover_image
• custom_install_url
• description
• flags
• guild
• guild_id
• icon
• id
• install_params
• name
• owner
• primary_sku_id
• privacy_policy_url
• role_connections_verification_url
• rpc_origins
• slug
• summary
• tags
• team
• terms_of_service_url
• verify_key

class disnake.AppInfo

Represents the application info for the bot provided by Discord.

id

The application’s ID.

Type:

int

name

The application’s name.

Type:

str

owner

The application’s owner.

Type:

User

team

The application’s team.

New in version 1.3.

Type:

Optional[Team]

description

The application’s description.

Type:

str

bot_public

Whether the bot can be invited by anyone or if it is locked to the application owner.

Type:

bool

bot_require_code_grant

Whether the bot requires the completion of the full oauth2 code grant flow to join.

Type:

bool

rpc_origins

A list of RPC origin URLs, if RPC is enabled.

Type:

Optional[List[str]]

verify_key

The hex encoded key for verification in interactions and the GameSDK’s GetTicket.

New in version 1.3.

Type:

str

guild_id

If this application is a game sold on Discord, this field will be the guild to which it has been linked to.

New in version 1.3.

Type:

Optional[int]

primary_sku_id

If this application is a game sold on Discord, this field will be the ID of the “Game SKU” that is created, if it exists.

New in version 1.3.

Type:

Optional[int]

slug

If this application is a game sold on Discord, this field will be the URL slug that links to the store page.

New in version 1.3.

Type:

Optional[str]

terms_of_service_url

The application’s terms of service URL, if set.

New in version 2.0.

Type:

Optional[str]

privacy_policy_url

The application’s privacy policy URL, if set.

New in version 2.0.

Type:

Optional[str]

flags

The application’s public flags.

New in version 2.3.

Type:

Optional[ApplicationFlags]

tags

The application’s tags.

New in version 2.5.

Type:

Optional[List[str]]

install_params

The installation parameters for this application.

New in version 2.5.

Type:

Optional[InstallParams]

custom_install_url

The custom installation url for this application.

New in version 2.5.

Type:

Optional[str]

role_connections_verification_url

The application’s role connection verification entry point, which when configured will render the app as a verification method in the guild role verification configuration.

New in version 2.8.

Type:

Optional[str]

property icon

Retrieves the application’s icon asset, if any.

Type:

Optional[Asset]

property cover_image

Retrieves the cover image on a store embed, if any.

This is only available if the application is a game sold on Discord.

Type:

Optional[Asset]

property guild

If this application is a game sold on Discord, this field will be the guild to which it has been linked

New in version 1.3.

Type:

Optional[Guild]

property summary

If this application is a game sold on Discord, this field will be the summary field for the store page of its primary SKU.

New in version 1.3.

Deprecated since version 2.5: This field is deprecated by discord and is now always blank. Consider using description instead.

Type:

str

PartialAppInfo

Attributes

• description
• icon
• id
• name
• privacy_policy_url
• rpc_origins
• summary
• terms_of_service_url
• verify_key

class disnake.PartialAppInfo

Represents a partial AppInfo given by create_invite().

New in version 2.0.

id

The application’s ID.

Type:

int

name

The application’s name.

Type:

str

description

The application’s description.

Type:

str

rpc_origins

A list of RPC origin URLs, if RPC is enabled.

Type:

Optional[List[str]]

verify_key

The hex encoded key for verification in interactions and the GameSDK’s GetTicket.

Type:

str

terms_of_service_url

The application’s terms of service URL, if set.

Type:

Optional[str]

privacy_policy_url

The application’s privacy policy URL, if set.

Type:

Optional[str]

property icon

Retrieves the application’s icon asset, if any.

Type:

Optional[Asset]

property summary

If this application is a game sold on Discord, this field will be the summary field for the store page of its primary SKU.

Deprecated since version 2.5: This field is deprecated by discord and is now always blank. Consider using description instead.

Type:

str

Team

Attributes

• icon
• id
• members
• name
• owner
• owner_id

class disnake.Team

Represents an application team for a bot provided by Discord.

id

The team ID.

Type:

int

name

The team name.

Type:

str

owner_id

The team’s owner ID.

Type:

int

members

A list of the members in the team.

New in version 1.3.

Type:

List[TeamMember]

property icon

Retrieves the team’s icon asset, if any.

Type:

Optional[Asset]

property owner

The team’s owner.

Type:

Optional[TeamMember]

TeamMember

Attributes

• avatar
• bot
• discriminator
• id
• membership_state
• name
• team

class disnake.TeamMember

Represents a team member in a team.

x == y

Checks if two team members are equal.

x != y

Checks if two team members are not equal.

hash(x)

Return the team member’s hash.

str(x)

Returns the team member’s name with discriminator.

New in version 1.3.

name

The team member’s username.

Type:

str

id

The team member’s unique ID.

Type:

int

discriminator

The team member’s discriminator. This is given when the username has conflicts.

Type:

str

avatar

The avatar hash the team member has. Could be None.

Type:

Optional[str]

bot

Specifies if the user is a bot account.

Type:

bool

team

The team that the member is from.

Type:

Team

membership_state

The membership state of the member (e.g. invited or accepted)

Type:

TeamMembershipState

InstallParams

Attributes

• permissions
• scopes

Methods

• defto_url

class disnake.InstallParams

Represents the installation parameters for the application, provided by Discord.

New in version 2.5.

scopes

The scopes requested by the application.

Type:

List[str]

permissions

The permissions requested for the bot role.

Type:

Permissions

to_url()

Return a string that can be used to add this application to a server.

Returns:

The invite url.

Return type:

str

Voice Related

VoiceClient

Attributes

• average_latency
• channel
• endpoint
• guild
• latency
• loop
• session_id
• source
• token
• user

Methods

• asyncdisconnect
• defis_connected
• defis_paused
• defis_playing
• asyncmove_to
• defpause
• defplay
• defresume
• defsend_audio_packet
• defstop

class disnake.VoiceClient

Represents a Discord voice connection.

You do not create these, you typically get them from e.g. VoiceChannel.connect().

Warning

In order to use PCM based AudioSources, you must have the opus library installed on your system and loaded through opus.load_opus(). Otherwise, your AudioSources must be opus encoded (e.g. using FFmpegOpusAudio) or the library will not be able to transmit audio.

session_id

The voice connection session ID.

Type:

str

token

The voice connection token.

Type:

str

endpoint

The endpoint we are connecting to.

Type:

str

channel

The voice channel connected to.

Type:

abc.Connectable

loop

The event loop that the voice client is running on.

Type:

asyncio.AbstractEventLoop

property guild

The guild we’re connected to.

Type:

Guild

property user

The user connected to voice (i.e. ourselves).

Type:

ClientUser

property latency

Latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

This could be referred to as the Discord Voice WebSocket latency and is an analogue of user’s voice latencies as seen in the Discord client.

New in version 1.4.

Type:

float

property average_latency

Average of most recent 20 HEARTBEAT latencies in seconds.

New in version 1.4.

Type:

float

await disconnect(*, force=False)

This function is a coroutine.

Disconnects this voice client from voice.

await move_to(channel)

This function is a coroutine.

Moves you to a different voice channel.

Parameters:

channel (abc.Snowflake) – The channel to move to. Must be a voice channel.

is_connected()

Indicates if the voice client is connected to voice.

play(source, *, after=None)

Plays an AudioSource.

The finalizer, after is called after the source has been exhausted or an error occurred.

If an error happens while the audio player is running, the exception is caught and the audio player is then stopped. If no after callback is passed, any caught exception will be displayed as if it were raised.

Parameters:

• source (AudioSource) – The audio source we’re reading from.

• after (Callable[[Optional[Exception]], Any]) – The finalizer that is called after the stream is exhausted. This function must have a single parameter, error, that denotes an optional exception that was raised during playing.

Raises:

• ClientException – Already playing audio or not connected.

• TypeError – Source is not a AudioSource or after is not a callable.

• OpusNotLoaded – Source is not opus encoded and opus is not loaded.

is_playing()

Indicates if we’re currently playing audio.

is_paused()

Indicates if we’re playing audio, but if we’re paused.

stop()

Stops playing audio.

pause()

Pauses the audio playing.

resume()

Resumes the audio playing.

property source

The audio source being played, if playing.

This property can also be used to change the audio source currently being played.

Type:

Optional[AudioSource]

send_audio_packet(data, *, encode=True)

Sends an audio packet composed of the data.

You must be connected to play audio.

Parameters:

• data (bytes) – The bytes-like object denoting PCM or Opus voice data.

• encode (bool) – Indicates if data should be encoded into Opus.

Raises:

• ClientException – You are not connected.

• opus.OpusError – Encoding the data failed.

VoiceProtocol

Methods

• defcleanup
• asyncconnect
• asyncdisconnect
• asyncon_voice_server_update
• asyncon_voice_state_update

class disnake.VoiceProtocol(client, channel)

A class that represents the Discord voice protocol.

This is an abstract class. The library provides a concrete implementation under VoiceClient.

This class allows you to implement a protocol to allow for an external method of sending voice, such as Lavalink or a native library implementation.

These classes are passed to abc.Connectable.connect.

Parameters:

• client (Client) – The client (or its subclasses) that started the connection request.

• channel (abc.Connectable) – The voice channel that is being connected to.

await on_voice_state_update(data)

This function is a coroutine.

An abstract method that is called when the client’s voice state has changed. This corresponds to VOICE_STATE_UPDATE.

Parameters:

data (dict) – The raw voice state payload.

await on_voice_server_update(data)

This function is a coroutine.

An abstract method that is called when initially connecting to voice. This corresponds to VOICE_SERVER_UPDATE.

Parameters:

data (dict) – The raw voice server update payload.

await connect(*, timeout, reconnect)

This function is a coroutine.

An abstract method called when the client initiates the connection request.

When a connection is requested initially, the library calls the constructor under __init__ and then calls connect(). If connect() fails at some point then disconnect() is called.

Within this method, to start the voice connection flow it is recommended to use Guild.change_voice_state() to start the flow. After which, on_voice_server_update() and on_voice_state_update() will be called. The order that these two are called is unspecified.

Parameters:

• timeout (float) – The timeout for the connection.

• reconnect (bool) – Whether reconnection is expected.

await disconnect(*, force)

This function is a coroutine.

An abstract method called when the client terminates the connection.

See cleanup().

Parameters:

force (bool) – Whether the disconnection was forced.

cleanup()

This method must be called to ensure proper clean-up during a disconnect.

It is advisable to call this from within disconnect() when you are completely done with the voice protocol instance.

This method removes it from the internal state cache that keeps track of currently alive voice clients. Failure to clean-up will cause subsequent connections to report that it’s still connected.

AudioSource

Methods

• defcleanup
• defis_opus
• defread

class disnake.AudioSource

Represents an audio stream.

The audio stream can be Opus encoded or not, however if the audio stream is not Opus encoded then the audio format must be 16-bit 48KHz stereo PCM.

Warning

The audio source reads are done in a separate thread.

read()

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

If is_opus() method returns True, then it must return 20ms worth of Opus encoded audio. Otherwise, it must be 20ms worth of 16-bit 48KHz stereo PCM, which is about 3,840 bytes per frame (20ms worth of audio).

Returns:

A bytes like object that represents the PCM or Opus data.

Return type:

bytes

is_opus()

Checks if the audio source is already encoded in Opus.

cleanup()

Called when clean-up is needed to be done.

Useful for clearing buffer data or processes after it is done playing audio.

PCMAudio

Attributes

• stream

Methods

• defread

class disnake.PCMAudio(stream)

Represents raw 16-bit 48KHz stereo PCM audio source.

stream

A file-like object that reads byte data representing raw PCM.

Type:

file object

read()

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

If is_opus() method returns True, then it must return 20ms worth of Opus encoded audio. Otherwise, it must be 20ms worth of 16-bit 48KHz stereo PCM, which is about 3,840 bytes per frame (20ms worth of audio).

Returns:

A bytes like object that represents the PCM or Opus data.

Return type:

bytes

FFmpegAudio

Methods

• defcleanup

class disnake.FFmpegAudio(source, *, executable='ffmpeg', args, **subprocess_kwargs)

Represents an FFmpeg (or AVConv) based AudioSource.

User created AudioSources using FFmpeg differently from how FFmpegPCMAudio and FFmpegOpusAudio work should subclass this.

New in version 1.3.

cleanup()

Called when clean-up is needed to be done.

Useful for clearing buffer data or processes after it is done playing audio.

FFmpegPCMAudio

Methods

• defis_opus
• defread

class disnake.FFmpegPCMAudio(source, *, executable='ffmpeg', pipe=False, stderr=None, before_options=None, options=None)

An audio source from FFmpeg (or AVConv).

This launches a sub-process to a specific input file given.

Warning

You must have the ffmpeg or avconv executable in your path environment variable in order for this to work.

Parameters:

• source (Union[str, io.BufferedIOBase]) – The input that ffmpeg will take and convert to PCM bytes. If pipe is True then this is a file-like object that is passed to the stdin of ffmpeg.

• executable (str) – The executable name (and path) to use. Defaults to ffmpeg.

• pipe (bool) – If True, denotes that source parameter will be passed to the stdin of ffmpeg. Defaults to False.

• stderr (Optional[file object]) – A file-like object to pass to the Popen constructor. Could also be an instance of subprocess.PIPE.

• before_options (Optional[str]) – Extra command line arguments to pass to ffmpeg before the -i flag.

• options (Optional[str]) – Extra command line arguments to pass to ffmpeg after the -i flag.

Raises:

ClientException – The subprocess failed to be created.

read()

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

If is_opus() method returns True, then it must return 20ms worth of Opus encoded audio. Otherwise, it must be 20ms worth of 16-bit 48KHz stereo PCM, which is about 3,840 bytes per frame (20ms worth of audio).

Returns:

A bytes like object that represents the PCM or Opus data.

Return type:

bytes

is_opus()

Checks if the audio source is already encoded in Opus.

FFmpegOpusAudio

Methods

• clsFFmpegOpusAudio.from_probe
• clsFFmpegOpusAudio.probe
• defis_opus
• defread

class disnake.FFmpegOpusAudio(source, *, bitrate=128, codec=None, executable='ffmpeg', pipe=False, stderr=None, before_options=None, options=None)

An audio source from FFmpeg (or AVConv).

This launches a sub-process to a specific input file given. However, rather than producing PCM packets like FFmpegPCMAudio does that need to be encoded to Opus, this class produces Opus packets, skipping the encoding step done by the library.

Alternatively, instead of instantiating this class directly, you can use FFmpegOpusAudio.from_probe() to probe for bitrate and codec information. This can be used to opportunistically skip pointless re-encoding of existing Opus audio data for a boost in performance at the cost of a short initial delay to gather the information. The same can be achieved by passing copy to the codec parameter, but only if you know that the input source is Opus encoded beforehand.

New in version 1.3.

Warning

You must have the ffmpeg or avconv executable in your path environment variable in order for this to work.

Parameters:

• source (Union[str, io.BufferedIOBase]) – The input that ffmpeg will take and convert to Opus bytes. If pipe is True then this is a file-like object that is passed to the stdin of ffmpeg.

• bitrate (int) – The bitrate in kbps to encode the output to. Defaults to 128.

• codec (Optional[str]) –

  The codec to use to encode the audio data. Normally this would be just libopus, but is used by FFmpegOpusAudio.from_probe() to opportunistically skip pointlessly re-encoding Opus audio data by passing copy as the codec value. Any values other than copy, opus, or libopus will be considered libopus. Defaults to libopus.

  Warning

  Do not provide this parameter unless you are certain that the audio input is already Opus encoded. For typical use FFmpegOpusAudio.from_probe() should be used to determine the proper value for this parameter.

• executable (str) – The executable name (and path) to use. Defaults to ffmpeg.

• pipe (bool) – If True, denotes that source parameter will be passed to the stdin of ffmpeg. Defaults to False.

• stderr (Optional[file object]) – A file-like object to pass to the Popen constructor. Could also be an instance of subprocess.PIPE.

• before_options (Optional[str]) – Extra command line arguments to pass to ffmpeg before the -i flag.

• options (Optional[str]) – Extra command line arguments to pass to ffmpeg after the -i flag.

Raises:

ClientException – The subprocess failed to be created.

classmethod await from_probe(source, *, method=None, **kwargs)

This function is a coroutine.

A factory method that creates a FFmpegOpusAudio after probing the input source for audio codec and bitrate information.

Examples

Use this function to create an FFmpegOpusAudio instance instead of the constructor:

source = await disnake.FFmpegOpusAudio.from_probe("song.webm")
voice_client.play(source)

If you are on Windows and don’t have ffprobe installed, use the fallback method to probe using ffmpeg instead:

source = await disnake.FFmpegOpusAudio.from_probe("song.webm", method='fallback')
voice_client.play(source)

Using a custom method of determining codec and bitrate:

def custom_probe(source, executable):
    # some analysis code here
    return codec, bitrate

source = await disnake.FFmpegOpusAudio.from_probe("song.webm", method=custom_probe)
voice_client.play(source)

Parameters:

• source – Identical to the source parameter for the constructor.

• method (Optional[Union[str, Callable[str, str]]]) – The probing method used to determine bitrate and codec information. As a string, valid values are native to use ffprobe (or avprobe) and fallback to use ffmpeg (or avconv). As a callable, it must take two string arguments, source and executable. Both parameters are the same values passed to this factory function. executable will default to ffmpeg if not provided as a keyword argument.

• kwargs – The remaining parameters to be passed to the FFmpegOpusAudio constructor, excluding bitrate and codec.

Raises:

• AttributeError – Invalid probe method, must be 'native' or 'fallback'.

• TypeError – Invalid value for probe parameter, must be str or a callable.

Returns:

An instance of this class.

Return type:

FFmpegOpusAudio

classmethod await probe(source, *, method=None, executable=None)

This function is a coroutine.

Probes the input source for bitrate and codec information.

Parameters:

• source – Identical to the source parameter for FFmpegOpusAudio.

• method – Identical to the method parameter for FFmpegOpusAudio.from_probe().

• executable (str) – Identical to the executable parameter for FFmpegOpusAudio.

Raises:

• AttributeError – Invalid probe method, must be 'native' or 'fallback'.

• TypeError – Invalid value for probe parameter, must be str or a callable.

Returns:

A 2-tuple with the codec and bitrate of the input source.

Return type:

Optional[Tuple[Optional[str], Optional[int]]]

read()

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

If is_opus() method returns True, then it must return 20ms worth of Opus encoded audio. Otherwise, it must be 20ms worth of 16-bit 48KHz stereo PCM, which is about 3,840 bytes per frame (20ms worth of audio).

Returns:

A bytes like object that represents the PCM or Opus data.

Return type:

bytes

is_opus()

Checks if the audio source is already encoded in Opus.

PCMVolumeTransformer

Attributes

• volume

Methods

• defcleanup
• defread

class disnake.PCMVolumeTransformer(original, volume=1.0)

Transforms a previous AudioSource to have volume controls.

This does not work on audio sources that have AudioSource.is_opus() set to True.

Parameters:

• original (AudioSource) – The original AudioSource to transform.

• volume (float) – The initial volume to set it to. See volume for more info.

Raises:

• TypeError – Not an audio source.

• ClientException – The audio source is opus encoded.

property volume

Retrieves or sets the volume as a floating point percentage (e.g. 1.0 for 100%).

cleanup()

Called when clean-up is needed to be done.

Useful for clearing buffer data or processes after it is done playing audio.

read()

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

If is_opus() method returns True, then it must return 20ms worth of Opus encoded audio. Otherwise, it must be 20ms worth of 16-bit 48KHz stereo PCM, which is about 3,840 bytes per frame (20ms worth of audio).

Returns:

A bytes like object that represents the PCM or Opus data.

Return type:

bytes

Opus Library

disnake.opus.load_opus(name)

Loads the libopus shared library for use with voice.

If this function is not called then the library uses the function ctypes.util.find_library() and then loads that one if available.

Not loading a library and attempting to use PCM based AudioSources will lead to voice not working.

This function propagates the exceptions thrown.

Warning

The bitness of the library must match the bitness of your python interpreter. If the library is 64-bit then your python interpreter must be 64-bit as well. Usually if there’s a mismatch in bitness then the load will throw an exception.

Note

On Windows, this function should not need to be called as the binaries are automatically loaded.

Note

On Windows, the .dll extension is not necessary. However, on Linux the full extension is required to load the library, e.g. libopus.so.1. On Linux however, ctypes.util.find_library() will usually find the library automatically without you having to call this.

Parameters:

name (str) – The filename of the shared library.

disnake.opus.is_loaded()

Function to check if opus lib is successfully loaded either via the ctypes.util.find_library() call of load_opus().

This must return True for voice to work.

Returns:

Indicates if the opus library has been loaded.

Return type:

bool

Event Reference

This section outlines the different types of events listened by Client.

There are two ways to register an event, the first way is through the use of Client.event(). The second way is through subclassing Client and overriding the specific events. For example:

import disnake

class MyClient(disnake.Client):
    async def on_message(self, message):
        if message.author == self.user:
            return

        if message.content.startswith('$hello'):
            await message.channel.send('Hello World!')

If an event handler raises an exception, on_error() will be called to handle it, which defaults to print a traceback and ignoring the exception.

Warning

All the events must be a coroutine. If they aren’t, then you might get unexpected errors. In order to turn a function into a coroutine they must be async def functions.

Client

This section documents events related to Client and its connectivity to Discord.

disnake.on_connect()

Called when the client has successfully connected to Discord. This is not the same as the client being fully prepared, see on_ready() for that.

The warnings on on_ready() also apply.

disnake.on_disconnect()

Called when the client has disconnected from Discord, or a connection attempt to Discord has failed. This could happen either through the internet being disconnected, explicit calls to close, or Discord terminating the connection one way or the other.

This function can be called many times without a corresponding on_connect() call.

disnake.on_error(event, *args, **kwargs)

Usually when an event raises an uncaught exception, a traceback is printed to stderr and the exception is ignored. If you want to change this behaviour and handle the exception for whatever reason yourself, this event can be overridden. Which, when done, will suppress the default action of printing the traceback.

The information of the exception raised and the exception itself can be retrieved with a standard call to sys.exc_info().

If you want exception to propagate out of the Client class you can define an on_error handler consisting of a single empty raise statement. Exceptions raised by on_error will not be handled in any way by Client.

Note

on_error will only be dispatched to Client.event().

It will not be received by Client.wait_for(), or, if used, Bots listeners such as listen() or listener().

Parameters:

• event (str) – The name of the event that raised the exception.

• args – The positional arguments for the event that raised the exception.

• kwargs – The keyword arguments for the event that raised the exception.

disnake.on_gateway_error(event, data, shard_id, exc)

When a (known) gateway event cannot be parsed, a traceback is printed to stderr and the exception is ignored by default. This should generally not happen and is usually either a library issue, or caused by a breaking API change.

To change this behaviour, for example to completely stop the bot, this event can be overridden.

This can also be disabled completely by passing enable_gateway_error_handler=False to the client on initialization, restoring the pre-v2.6 behavior.

New in version 2.6.

Note

on_gateway_error will only be dispatched to Client.event().

It will not be received by Client.wait_for(), or, if used, Bots listeners such as listen() or listener().

Note

This will not be dispatched for exceptions that occur while parsing READY and RESUMED event payloads, as exceptions in these events are considered fatal.

Parameters:

• event (str) – The name of the gateway event that was the cause of the exception, for example MESSAGE_CREATE.

• data (Any) – The raw event payload.

• shard_id (Optional[int]) – The ID of the shard the exception occurred in, if applicable.

• exc (Exception) – The exception that was raised.

disnake.on_ready()

Called when the client is done preparing the data received from Discord. Usually after login is successful and the Client.guilds and co. are filled up.

Warning

This function is not guaranteed to be the first event called. Likewise, this function is not guaranteed to only be called once. This library implements reconnection logic and thus will end up calling this event whenever a RESUME request fails.

disnake.on_resumed()

Called when the client has resumed a session.

disnake.on_shard_connect(shard_id)

Similar to on_connect() except used by AutoShardedClient to denote when a particular shard ID has connected to Discord.

New in version 1.4.

Parameters:

shard_id (int) – The shard ID that has connected.

disnake.on_shard_disconnect(shard_id)

Similar to on_disconnect() except used by AutoShardedClient to denote when a particular shard ID has disconnected from Discord.

New in version 1.4.

Parameters:

shard_id (int) – The shard ID that has disconnected.

disnake.on_shard_ready(shard_id)

Similar to on_ready() except used by AutoShardedClient to denote when a particular shard ID has become ready.

Parameters:

shard_id (int) – The shard ID that is ready.

disnake.on_shard_resumed(shard_id)

Similar to on_resumed() except used by AutoShardedClient to denote when a particular shard ID has resumed a session.

New in version 1.4.

Parameters:

shard_id (int) – The shard ID that has resumed.

disnake.on_socket_event_type(event_type)

Called whenever a websocket event is received from the WebSocket.

This is mainly useful for logging how many events you are receiving from the Discord gateway.

New in version 2.0.

Parameters:

event_type (str) – The event type from Discord that is received, e.g. 'READY'.

disnake.on_socket_raw_receive(msg)

Called whenever a message is completely received from the WebSocket, before it’s processed and parsed. This event is always dispatched when a complete message is received and the passed data is not parsed in any way.

This is only really useful for grabbing the WebSocket stream and debugging purposes.

This requires setting the enable_debug_events setting in the Client.

Note

This is only for the messages received from the client WebSocket. The voice WebSocket will not trigger this event.

Parameters:

msg (str) – The message passed in from the WebSocket library.

disnake.on_socket_raw_send(payload)

Called whenever a send operation is done on the WebSocket before the message is sent. The passed parameter is the message that is being sent to the WebSocket.

This is only really useful for grabbing the WebSocket stream and debugging purposes.

This requires setting the enable_debug_events setting in the Client.

Note

This is only for the messages sent from the client WebSocket. The voice WebSocket will not trigger this event.

Parameters:

payload – The message that is about to be passed on to the WebSocket library. It can be bytes to denote a binary message or str to denote a regular text message.

Channels/Threads

This section documents events related to Discord channels and threads.

disnake.on_guild_channel_delete(channel)

disnake.on_guild_channel_create(channel)

Called whenever a guild channel is deleted or created.

Note that you can get the guild from guild.

This requires Intents.guilds to be enabled.

Parameters:

channel (abc.GuildChannel) – The guild channel that got created or deleted.

disnake.on_guild_channel_update(before, after)

Called whenever a guild channel is updated. e.g. changed name, topic, permissions.

This requires Intents.guilds to be enabled.

Parameters:

• before (abc.GuildChannel) – The updated guild channel’s old info.

• after (abc.GuildChannel) – The updated guild channel’s new info.

disnake.on_guild_channel_pins_update(channel, last_pin)

Called whenever a message is pinned or unpinned from a guild channel.

This requires Intents.guilds to be enabled.

Parameters:

• channel (Union[abc.GuildChannel, Thread]) – The guild channel that had its pins updated.

• last_pin (Optional[datetime.datetime]) – The latest message that was pinned as an aware datetime in UTC. Could be None.

disnake.on_private_channel_update(before, after)

Called whenever a private group DM is updated. e.g. changed name or topic.

This requires Intents.messages to be enabled.

Parameters:

• before (GroupChannel) – The updated group channel’s old info.

• after (GroupChannel) – The updated group channel’s new info.

disnake.on_private_channel_pins_update(channel, last_pin)

Called whenever a message is pinned or unpinned from a private channel.

Parameters:

• channel (abc.PrivateChannel) – The private channel that had its pins updated.

• last_pin (Optional[datetime.datetime]) – The latest message that was pinned as an aware datetime in UTC. Could be None.

disnake.on_thread_create(thread)

Called whenever a thread is created.

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

Note

This only works for threads created in channels the bot already has access to, and only for public threads unless the bot has the manage_threads permission.

New in version 2.5.

Parameters:

thread (Thread) – The thread that got created.

disnake.on_thread_join(thread)

Called whenever the bot joins a thread or gets access to a thread (for example, by gaining access to the parent channel).

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

Note

This event will not be called for threads created by the bot or threads created on one of the bot’s messages.

New in version 2.0.

Changed in version 2.5: This is no longer being called when a thread is created, see on_thread_create() instead.

Parameters:

thread (Thread) – The thread that got joined.

disnake.on_thread_member_join(member)

disnake.on_thread_member_remove(member)

Called when a ThreadMember leaves or joins a Thread.

You can get the thread a member belongs in by accessing ThreadMember.thread.

On removal events, if the member being removed is not found in the internal cache, then this event will not be called. Consider using on_raw_thread_member_remove() instead.

This requires Intents.members to be enabled.

New in version 2.0.

Parameters:

member (ThreadMember) – The member who joined or left.

disnake.on_thread_remove(thread)

Called whenever a thread is removed. This is different from a thread being deleted.

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

Warning

Due to technical limitations, this event might not be called as soon as one expects. Since the library tracks thread membership locally, the API only sends updated thread membership status upon being synced by joining a thread.

New in version 2.0.

Parameters:

thread (Thread) – The thread that got removed.

disnake.on_thread_update(before, after)

Called when a thread is updated. If the thread is not found in the internal thread cache, then this event will not be called. Consider using on_raw_thread_update() which will be called regardless of the cache.

This requires Intents.guilds to be enabled.

New in version 2.0.

Parameters:

• before (Thread) – The updated thread’s old info.

• after (Thread) – The updated thread’s new info.

disnake.on_thread_delete(thread)

Called when a thread is deleted. If the thread is not found in the internal thread cache, then this event will not be called. Consider using on_raw_thread_delete() instead.

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

New in version 2.0.

Parameters:

thread (Thread) – The thread that got deleted.

disnake.on_raw_thread_member_remove(payload)

Called when a ThreadMember leaves Thread. Unlike on_thread_member_remove(), this is called regardless of the thread member cache.

You can get the thread a member belongs in by accessing ThreadMember.thread.

This requires Intents.members to be enabled.

New in version 2.5.

Parameters:

payload (RawThreadMemberRemoveEvent) – The raw event payload data.

disnake.on_raw_thread_update(after)

Called whenever a thread is updated. Unlike on_thread_update(), this is called regardless of the state of the internal thread cache.

This requires Intents.guilds to be enabled.

New in version 2.5.

Parameters:

thread (Thread) – The updated thread.

disnake.on_raw_thread_delete(payload)

Called whenever a thread is deleted. Unlike on_thread_delete(), this is called regardless of the state of the internal thread cache.

Note that you can get the guild from Thread.guild.

This requires Intents.guilds to be enabled.

New in version 2.5.

Parameters:

payload (RawThreadDeleteEvent) – The raw event payload data.

disnake.on_webhooks_update(channel)

Called whenever a webhook is created, modified, or removed from a guild channel.

This requires Intents.webhooks to be enabled.

Parameters:

channel (abc.GuildChannel) – The channel that had its webhooks updated.

Guilds

This section documents events related to Discord guilds.

General

disnake.on_guild_join(guild)

Called when a Guild is either created by the Client or when the Client joins a guild.

This requires Intents.guilds to be enabled.

Parameters:

guild (Guild) – The guild that was joined.

disnake.on_guild_remove(guild)

Called when a Guild is removed from the Client.

This happens through, but not limited to, these circumstances:

• The client got banned.

• The client got kicked.

• The client left the guild.

• The client or the guild owner deleted the guild.

In order for this event to be invoked then the Client must have been part of the guild to begin with. (i.e. it is part of Client.guilds)

This requires Intents.guilds to be enabled.

Parameters:

guild (Guild) – The guild that got removed.

disnake.on_guild_update(before, after)

Called when a Guild updates, for example:

• Changed name

• Changed AFK channel

• Changed AFK timeout

• etc

This requires Intents.guilds to be enabled.

Parameters:

• before (Guild) – The guild prior to being updated.

• after (Guild) – The guild after being updated.

disnake.on_guild_available(guild)

disnake.on_guild_unavailable(guild)

Called when a guild becomes available or unavailable. The guild must have existed in the Client.guilds cache.

This requires Intents.guilds to be enabled.

Parameters:

guild – The Guild that has changed availability.

Application Commands

disnake.on_application_command_permissions_update(permissions)

Called when the permissions of an application command or the application-wide command permissions are updated.

Note that this will also be called when permissions of other applications change, not just this application’s permissions.

New in version 2.5.

Parameters:

permissions (GuildApplicationCommandPermissions) – The updated permission object.

AutoMod

disnake.on_automod_action_execution(execution)

Called when an auto moderation action is executed due to a rule triggering for a particular event. You must have the manage_guild permission to receive this.

The guild this action has taken place in can be accessed using AutoModActionExecution.guild.

This requires Intents.automod_execution to be enabled.

In addition, Intents.message_content must be enabled to receive non-empty values for AutoModActionExecution.content and AutoModActionExecution.matched_content.

Note

This event will fire once per executed AutoModAction, which means it will run multiple times when a rule is triggered, if that rule has multiple actions defined.

New in version 2.6.

Parameters:

execution (AutoModActionExecution) – The auto moderation action execution data.

disnake.on_automod_rule_create(rule)

Called when an AutoModRule is created. You must have the manage_guild permission to receive this.

This requires Intents.automod_configuration to be enabled.

New in version 2.6.

Parameters:

rule (AutoModRule) – The auto moderation rule that was created.

disnake.on_automod_rule_update(rule)

Called when an AutoModRule is updated. You must have the manage_guild permission to receive this.

This requires Intents.automod_configuration to be enabled.

New in version 2.6.

Parameters:

rule (AutoModRule) – The auto moderation rule that was updated.

disnake.on_automod_rule_delete(rule)

Called when an AutoModRule is deleted. You must have the manage_guild permission to receive this.

This requires Intents.automod_configuration to be enabled.

New in version 2.6.

Parameters:

rule (AutoModRule) – The auto moderation rule that was deleted.

Emojis

disnake.on_guild_emojis_update(guild, before, after)

Called when a Guild adds or removes Emoji.

This requires Intents.emojis_and_stickers to be enabled.

Parameters:

• guild (Guild) – The guild who got their emojis updated.

• before (Sequence[Emoji]) – A list of emojis before the update.

• after (Sequence[Emoji]) – A list of emojis after the update.

Integrations

disnake.on_guild_integrations_update(guild)

Called whenever an integration is created, modified, or removed from a guild.

This requires Intents.integrations to be enabled.

New in version 1.4.

Parameters:

guild (Guild) – The guild that had its integrations updated.

disnake.on_integration_create(integration)

Called when an integration is created.

This requires Intents.integrations to be enabled.

New in version 2.0.

Parameters:

integration (Integration) – The integration that was created.

disnake.on_integration_update(integration)

Called when an integration is updated.

This requires Intents.integrations to be enabled.

New in version 2.0.

Parameters:

integration (Integration) – The integration that was updated.

disnake.on_raw_integration_delete(payload)

Called when an integration is deleted.

This requires Intents.integrations to be enabled.

New in version 2.0.

Parameters:

payload (RawIntegrationDeleteEvent) – The raw event payload data.

Audit Logs

disnake.on_audit_log_entry_create(entry)

Called when an audit log entry is created. You must have the view_audit_log permission to receive this.

This requires Intents.moderation to be enabled.

Warning

This scope of data in this gateway event is limited, which means it is much more reliant on the cache than Guild.audit_logs(). Because of this, AuditLogEntry.target and AuditLogEntry.user will frequently be of type Object instead of the respective model.

New in version 2.8.

Parameters:

entry (AuditLogEntry) – The audit log entry that was created.

Invites

disnake.on_invite_create(invite)

Called when an Invite is created. You must have the manage_channels permission to receive this.

New in version 1.3.

Note

There is a rare possibility that the Invite.guild and Invite.channel attributes will be of Object rather than the respective models.

This requires Intents.invites to be enabled.

Parameters:

invite (Invite) – The invite that was created.

disnake.on_invite_delete(invite)

Called when an Invite is deleted. You must have the manage_channels permission to receive this.

New in version 1.3.

Note

There is a rare possibility that the Invite.guild and Invite.channel attributes will be of Object rather than the respective models.

Outside of those two attributes, the only other attribute guaranteed to be filled by the Discord gateway for this event is Invite.code.

This requires Intents.invites to be enabled.

Parameters:

invite (Invite) – The invite that was deleted.

Members

disnake.on_member_join(member)

disnake.on_member_remove(member)

Called when a Member leaves or joins a Guild. If on_member_remove() is being used then consider using on_raw_member_remove() which will be called regardless of the cache.

This requires Intents.members to be enabled.

Parameters:

member (Member) – The member who joined or left.

disnake.on_member_update(before, after)

Called when a Member updates their profile. Consider using on_raw_member_update() which will be called regardless of the cache.

This is called when one or more of the following things change, but is not limited to:

• avatar (guild-specific)

• current_timeout

• nickname

• pending

• premium_since

• roles

This requires Intents.members to be enabled.

Parameters:

• before (Member) – The member’s old info.

• after (Member) – The member’s updated info.

disnake.on_raw_member_remove(payload)

Called when a member leaves a Guild. Unlike on_member_remove(), this is called regardless of the member cache.

New in version 2.6.

Parameters:

payload (RawGuildMemberRemoveEvent) – The raw event payload data.

disnake.on_raw_member_update(member)

Called when a member updates their profile. Unlike on_member_update(), this is called regardless of the member cache.

New in version 2.6.

Parameters:

member (Member) – The member that was updated.

disnake.on_member_ban(guild, user)

Called when user gets banned from a Guild.

This requires Intents.moderation to be enabled.

Parameters:

• guild (Guild) – The guild the user got banned from.

• user (Union[User, Member]) – The user that got banned. Can be either User or Member depending on whether the user was in the guild at the time of removal.

disnake.on_member_unban(guild, user)

Called when a User gets unbanned from a Guild.

This requires Intents.moderation to be enabled.

Parameters:

• guild (Guild) – The guild the user got unbanned from.

• user (User) – The user that got unbanned.

disnake.on_presence_update(before, after)

Called when a Member updates their presence.

This is called when one or more of the following things change:

• status

• activity

This requires Intents.presences and Intents.members to be enabled.

New in version 2.0.

Parameters:

• before (Member) – The updated member’s old info.

• after (Member) – The updated member’s updated info.

disnake.on_user_update(before, after)

Called when a User is updated.

This is called when one or more of the following things change, but is not limited to:

• avatar

• discriminator

• name

• public_flags

This requires Intents.members to be enabled.

Parameters:

• before (User) – The user’s old info.

• after (User) – The user’s updated info.

Scheduled Events

disnake.on_guild_scheduled_event_create(event)

disnake.on_guild_scheduled_event_delete(event)

Called when a guild scheduled event is created or deleted.

This requires Intents.guild_scheduled_events to be enabled.

New in version 2.3.

Parameters:

event (GuildScheduledEvent) – The guild scheduled event that was created or deleted.

disnake.on_guild_scheduled_event_update(before, after)

Called when a guild scheduled event is updated. The guild must have existed in the Client.guilds cache.

This requires Intents.guild_scheduled_events to be enabled.

New in version 2.3.

Parameters:

• before (GuildScheduledEvent) – The guild scheduled event before the update.

• after (GuildScheduledEvent) – The guild scheduled event after the update.

disnake.on_guild_scheduled_event_subscribe(event, user)

disnake.on_guild_scheduled_event_unsubscribe(event, user)

Called when a user subscribes to or unsubscribes from a guild scheduled event.

This requires Intents.guild_scheduled_events and Intents.members to be enabled.

New in version 2.3.

Parameters:

• event (GuildScheduledEvent) – The guild scheduled event that the user subscribed to or unsubscribed from.

• user (Union[Member, User]) – The user who subscribed to or unsubscribed from the event.

disnake.on_raw_guild_scheduled_event_subscribe(payload)

disnake.on_raw_guild_scheduled_event_unsubscribe(payload)

Called when a user subscribes to or unsubscribes from a guild scheduled event. Unlike on_guild_scheduled_event_subscribe() and on_guild_scheduled_event_unsubscribe(), this is called regardless of the guild scheduled event cache.

Parameters:

payload (RawGuildScheduledEventUserActionEvent) – The raw event payload data.

Stage Instances

disnake.on_stage_instance_create(stage_instance)

disnake.on_stage_instance_delete(stage_instance)

Called when a StageInstance is created or deleted for a StageChannel.

New in version 2.0.

Parameters:

stage_instance (StageInstance) – The stage instance that was created or deleted.

disnake.on_stage_instance_update(before, after)

Called when a StageInstance is updated.

The following, but not limited to, examples illustrate when this event is called:

• The topic is changed.

• The privacy level is changed.

New in version 2.0.

Parameters:

• before (StageInstance) – The stage instance before the update.

• after (StageInstance) – The stage instance after the update.

Stickers

disnake.on_guild_stickers_update(guild, before, after)

Called when a Guild updates its stickers.

This requires Intents.emojis_and_stickers to be enabled.

New in version 2.0.

Parameters:

• guild (Guild) – The guild who got their stickers updated.

• before (Sequence[GuildSticker]) – A list of stickers before the update.

• after (Sequence[GuildSticker]) – A list of stickers after the update.

Roles

disnake.on_guild_role_create(role)

disnake.on_guild_role_delete(role)

Called when a Guild creates or deletes a Role.

To get the guild it belongs to, use Role.guild.

This requires Intents.guilds to be enabled.

Parameters:

role (Role) – The role that was created or deleted.

disnake.on_guild_role_update(before, after)

Called when a Role is changed guild-wide.

This requires Intents.guilds to be enabled.

Parameters:

• before (Role) – The updated role’s old info.

• after (Role) – The updated role’s updated info.

Voice

disnake.on_voice_state_update(member, before, after)

Called when a Member changes their VoiceState.

The following, but not limited to, examples illustrate when this event is called:

• A member joins a voice or stage channel.

• A member leaves a voice or stage channel.

• A member is muted or deafened by their own accord.

• A member is muted or deafened by a guild administrator.

This requires Intents.voice_states to be enabled.

Parameters:

• member (Member) – The member whose voice states changed.

• before (VoiceState) – The voice state prior to the changes.

• after (VoiceState) – The voice state after the changes.

Interactions

This section documents events related to application commands and other interactions.

disnake.on_application_command(interaction)

Called when an application command is invoked.

Warning

This is a low level function that is not generally meant to be used. Consider using Bot or InteractionBot instead.

Warning

If you decide to override this event and are using Bot or related types, make sure to call Bot.process_application_commands to ensure that the application commands are processed.

New in version 2.0.

Parameters:

interaction (ApplicationCommandInteraction) – The interaction object.

disnake.on_application_command_autocomplete(interaction)

Called when an application command autocomplete is called.

Warning

This is a low level function that is not generally meant to be used. Consider using Bot or InteractionBot instead.

Warning

If you decide to override this event and are using Bot or related types, make sure to call Bot.process_app_command_autocompletion to ensure that the application command autocompletion is processed.

New in version 2.0.

Parameters:

interaction (ApplicationCommandInteraction) – The interaction object.

disnake.on_button_click(interaction)

Called when a button is clicked.

New in version 2.0.

Parameters:

interaction (MessageInteraction) – The interaction object.

disnake.on_dropdown(interaction)

Called when a select menu is clicked.

New in version 2.0.

Parameters:

interaction (MessageInteraction) – The interaction object.

disnake.on_interaction(interaction)

Called when an interaction happened.

This currently happens due to application command invocations or components being used.

Warning

This is a low level function that is not generally meant to be used.

New in version 2.0.

Parameters:

interaction (Interaction) – The interaction object.

disnake.on_message_interaction(interaction)

Called when a message interaction happened.

This currently happens due to components being used.

New in version 2.0.

Parameters:

interaction (MessageInteraction) – The interaction object.

disnake.on_modal_submit(interaction)

Called when a modal is submitted.

New in version 2.4.

Parameters:

interaction (ModalInteraction) – The interaction object.

Messages

This section documents events related to Discord chat messages.

disnake.on_message(message)

Called when a Message is created and sent.

This requires Intents.messages to be enabled.

Warning

Your bot’s own messages and private messages are sent through this event. This can lead cases of ‘recursion’ depending on how your bot was programmed. If you want the bot to not reply to itself, consider checking the user IDs. Note that Bot does not have this problem.

Note

Not all messages will have content. This is a Discord limitation. See the docs of Intents.message_content for more information.

Parameters:

message (Message) – The current message.

disnake.on_message_delete(message)

Called when a message is deleted. If the message is not found in the internal message cache, then this event will not be called. Messages might not be in cache if the message is too old or the client is participating in high traffic guilds.

If this occurs increase the max_messages parameter or use the on_raw_message_delete() event instead.

This requires Intents.messages to be enabled.

Note

Not all messages will have content. This is a Discord limitation. See the docs of Intents.message_content for more information.

Parameters:

message (Message) – The deleted message.

disnake.on_message_edit(before, after)

Called when a Message receives an update event. If the message is not found in the internal message cache, then these events will not be called. Messages might not be in cache if the message is too old or the client is participating in high traffic guilds.

If this occurs increase the max_messages parameter or use the on_raw_message_edit() event instead.

Note

Not all messages will have content. This is a Discord limitation. See the docs of Intents.message_content for more information.

The following non-exhaustive cases trigger this event:

• A message has been pinned or unpinned.

• The message content has been changed.

• The message has received an embed.

  • For performance reasons, the embed server does not do this in a “consistent” manner.

• The message’s embeds were suppressed or unsuppressed.

• A call message has received an update to its participants or ending time.

This requires Intents.messages to be enabled.

Parameters:

• before (Message) – The previous version of the message.

• after (Message) – The current version of the message.

disnake.on_bulk_message_delete(messages)

Called when messages are bulk deleted. If none of the messages deleted are found in the internal message cache, then this event will not be called. If individual messages were not found in the internal message cache, this event will still be called, but the messages not found will not be included in the messages list. Messages might not be in cache if the message is too old or the client is participating in high traffic guilds.

If this occurs increase the max_messages parameter or use the on_raw_bulk_message_delete() event instead.

This requires Intents.messages to be enabled.

Parameters:

messages (List[Message]) – The messages that have been deleted.

disnake.on_raw_message_delete(payload)

Called when a message is deleted. Unlike on_message_delete(), this is called regardless of the message being in the internal message cache or not.

If the message is found in the message cache, it can be accessed via RawMessageDeleteEvent.cached_message

This requires Intents.messages to be enabled.

Parameters:

payload (RawMessageDeleteEvent) – The raw event payload data.

disnake.on_raw_message_edit(payload)

Called when a message is edited. Unlike on_message_edit(), this is called regardless of the state of the internal message cache.

If the message is found in the message cache, it can be accessed via RawMessageUpdateEvent.cached_message. The cached message represents the message before it has been edited. For example, if the content of a message is modified and triggers the on_raw_message_edit() coroutine, the RawMessageUpdateEvent.cached_message will return a Message object that represents the message before the content was modified.

Due to the inherently raw nature of this event, the data parameter coincides with the raw data given by the gateway.

Since the data payload can be partial, care must be taken when accessing stuff in the dictionary. One example of a common case of partial data is when the 'content' key is inaccessible. This denotes an “embed” only edit, which is an edit in which only the embeds are updated by the Discord embed server.

This requires Intents.messages to be enabled.

Parameters:

payload (RawMessageUpdateEvent) – The raw event payload data.

disnake.on_raw_bulk_message_delete(payload)

Called when a bulk delete is triggered. Unlike on_bulk_message_delete(), this is called regardless of the messages being in the internal message cache or not.

If the messages are found in the message cache, they can be accessed via RawBulkMessageDeleteEvent.cached_messages

This requires Intents.messages to be enabled.

Parameters:

payload (RawBulkMessageDeleteEvent) – The raw event payload data.

disnake.on_reaction_add(reaction, user)

Called when a message has a reaction added to it. Similar to on_message_edit(), if the message is not found in the internal message cache, then this event will not be called. Consider using on_raw_reaction_add() instead.

Note

To get the Message being reacted, access it via Reaction.message.

This requires Intents.reactions to be enabled.

Note

This doesn’t require Intents.members within a guild context, but due to Discord not providing updated user information in a direct message it’s required for direct messages to receive this event. Consider using on_raw_reaction_add() if you need this and do not otherwise want to enable the members intent.

Parameters:

• reaction (Reaction) – The current state of the reaction.

• user (Union[Member, User]) – The user who added the reaction.

disnake.on_reaction_remove(reaction, user)

Called when a message has a reaction removed from it. Similar to on_message_edit, if the message is not found in the internal message cache, then this event will not be called.

Note

To get the message being reacted, access it via Reaction.message.

This requires both Intents.reactions and Intents.members to be enabled.

Note

Consider using on_raw_reaction_remove() if you need this and do not want to enable the members intent.

Parameters:

• reaction (Reaction) – The current state of the reaction.

• user (Union[Member, User]) – The user who added the reaction.

disnake.on_reaction_clear(message, reactions)

Called when a message has all its reactions removed from it. Similar to on_message_edit(), if the message is not found in the internal message cache, then this event will not be called. Consider using on_raw_reaction_clear() instead.

This requires Intents.reactions to be enabled.

Parameters:

• message (Message) – The message that had its reactions cleared.

• reactions (List[Reaction]) – The reactions that were removed.

disnake.on_reaction_clear_emoji(reaction)

Called when a message has a specific reaction removed from it. Similar to on_message_edit(), if the message is not found in the internal message cache, then this event will not be called. Consider using on_raw_reaction_clear_emoji() instead.

This requires Intents.reactions to be enabled.

New in version 1.3.

Parameters:

reaction (Reaction) – The reaction that got cleared.

disnake.on_raw_reaction_add(payload)

Called when a message has a reaction added. Unlike on_reaction_add(), this is called regardless of the state of the internal message cache.

This requires Intents.reactions to be enabled.

Parameters:

payload (RawReactionActionEvent) – The raw event payload data.

disnake.on_raw_reaction_remove(payload)

Called when a message has a reaction removed. Unlike on_reaction_remove(), this is called regardless of the state of the internal message cache.

This requires Intents.reactions to be enabled.

Parameters:

payload (RawReactionActionEvent) – The raw event payload data.

disnake.on_raw_reaction_clear(payload)

Called when a message has all its reactions removed. Unlike on_reaction_clear(), this is called regardless of the state of the internal message cache.

This requires Intents.reactions to be enabled.

Parameters:

payload (RawReactionClearEvent) – The raw event payload data.

disnake.on_raw_reaction_clear_emoji(payload)

Called when a message has a specific reaction removed from it. Unlike on_reaction_clear_emoji() this is called regardless of the state of the internal message cache.

This requires Intents.reactions to be enabled.

New in version 1.3.

Parameters:

payload (RawReactionClearEmojiEvent) – The raw event payload data.

disnake.on_typing(channel, user, when)

Called when someone begins typing a message.

The channel parameter can be a abc.Messageable instance, or a ForumChannel. If channel is an abc.Messageable instance, it could be a TextChannel, VoiceChannel, GroupChannel, or DMChannel.

Changed in version 2.5: channel may be a type ForumChannel

If the channel is a TextChannel, ForumChannel, or VoiceChannel then the user parameter is a Member, otherwise it is a User.

If the channel is a DMChannel and the user is not found in the internal user/member cache, then this event will not be called. Consider using on_raw_typing() instead.

This requires Intents.typing and Intents.guilds to be enabled.

Note

This doesn’t require Intents.members within a guild context, but due to Discord not providing updated user information in a direct message it’s required for direct messages to receive this event, if the bot didn’t explicitly open the DM channel in the same session (through User.create_dm(), Client.create_dm(), or indirectly by sending a message to the user). Consider using on_raw_typing() if you need this and do not otherwise want to enable the members intent.

Parameters:

• channel (Union[abc.Messageable, ForumChannel]) – The location where the typing originated from.

• user (Union[User, Member]) – The user that started typing.

• when (datetime.datetime) – When the typing started as an aware datetime in UTC.

disnake.on_raw_typing(data)

Called when someone begins typing a message.

This is similar to on_typing() except that it is called regardless of whether Intents.members and Intents.guilds are enabled.

Parameters:

data (RawTypingEvent) – The raw event payload data.

Utility Functions

disnake.utils.find(predicate, seq)

A helper to return the first element found in the sequence that meets the predicate. For example:

member = disnake.utils.find(lambda m: m.name == 'Mighty', channel.guild.members)

would find the first Member whose name is ‘Mighty’ and return it. If an entry is not found, then None is returned.

This is different from filter() due to the fact it stops the moment it finds a valid entry.

Parameters:

• predicate – A function that returns a boolean-like result.

• seq (collections.abc.Iterable) – The iterable to search through.

disnake.utils.get(iterable, **attrs)

A helper that returns the first element in the iterable that meets all the traits passed in attrs. This is an alternative for find().

When multiple attributes are specified, they are checked using logical AND, not logical OR. Meaning they have to meet every attribute passed in and not one of them.

To have a nested attribute search (i.e. search by x.y) then pass in x__y as the keyword argument.

If nothing is found that matches the attributes passed, then None is returned.

Examples

Basic usage:

member = disnake.utils.get(message.guild.members, name='Foo')

Multiple attribute matching:

channel = disnake.utils.get(guild.voice_channels, name='Foo', bitrate=64000)

Nested attribute matching:

channel = disnake.utils.get(client.get_all_channels(), guild__name='Cool', name='general')

Parameters:

• iterable – An iterable to search through.

• **attrs – Keyword arguments that denote attributes to search with.

disnake.utils.snowflake_time(id)

Parameters:

id (int) – The snowflake ID.

Returns:

An aware datetime in UTC representing the creation time of the snowflake.

Return type:

datetime.datetime

disnake.utils.oauth_url(client_id, *, permissions=..., guild=..., redirect_uri=..., scopes=..., disable_guild_select=False)

A helper function that returns the OAuth2 URL for inviting the bot into guilds.

Parameters:

• client_id (Union[int, str]) – The client ID for your bot.

• permissions (Permissions) – The permissions you’re requesting. If not given then you won’t be requesting any permissions.

• guild (Snowflake) – The guild to pre-select in the authorization screen, if available.

• redirect_uri (str) – An optional valid redirect URI.

• scopes (Iterable[str]) –

  An optional valid list of scopes. Defaults to ('bot',).

  New in version 1.7.

• disable_guild_select (bool) –

  Whether to disallow the user from changing the guild dropdown.

  New in version 2.0.

Returns:

The OAuth2 URL for inviting the bot into guilds.

Return type:

str

disnake.utils.remove_markdown(text, *, ignore_links=True)

A helper function that removes markdown characters.

New in version 1.7.

Note

This function is not markdown aware and may remove meaning from the original text. For example, if the input contains 10 * 5 then it will be converted into 10  5.

Parameters:

• text (str) – The text to remove markdown from.

• ignore_links (bool) – Whether to leave links alone when removing markdown. For example, if a URL in the text contains characters such as _ then it will be left alone. Defaults to True.

Returns:

The text with the markdown special characters removed.

Return type:

str

disnake.utils.escape_markdown(text, *, as_needed=False, ignore_links=True)

A helper function that escapes Discord’s markdown.

Parameters:

• text (str) – The text to escape markdown from.

• as_needed (bool) – Whether to escape the markdown characters as needed. This means that it does not escape extraneous characters if it’s not necessary, e.g. **hello** is escaped into \*\*hello** instead of \*\*hello\*\*. Note however that this can open you up to some clever syntax abuse. Defaults to False.

• ignore_links (bool) – Whether to leave links alone when escaping markdown. For example, if a URL in the text contains characters such as _ then it will be left alone. This option is not supported with as_needed. Defaults to True.

Returns:

The text with the markdown special characters escaped with a slash.

Return type:

str

disnake.utils.escape_mentions(text)

A helper function that escapes everyone, here, role, and user mentions.

Note

This does not include channel mentions.

Note

For more granular control over what mentions should be escaped within messages, refer to the AllowedMentions class.

Parameters:

text (str) – The text to escape mentions from.

Returns:

The text with the mentions removed.

Return type:

str

disnake.utils.resolve_invite(invite, *, with_params=False)

Resolves an invite from a Invite, URL or code.

Parameters:

• invite (Union[Invite, str]) – The invite to resolve.

• with_params (bool) –

  Whether to also return the query parameters of the invite, if it’s a url.

  New in version 2.3.

Returns:

The invite code if with_params is False, otherwise a tuple containing the invite code and the url’s query parameters, if applicable.

Return type:

Union[str, Tuple[str, Dict[str, str]]]

disnake.utils.resolve_template(code)

Resolves a template code from a Template, URL or code.

New in version 1.4.

Parameters:

code (Union[Template, str]) – The code.

Returns:

The template code.

Return type:

str

await disnake.utils.sleep_until(when, result=None)

This function is a coroutine.

Sleep until a specified time.

If the time supplied is in the past this function will yield instantly.

New in version 1.3.

Parameters:

• when (datetime.datetime) – The timestamp in which to sleep until. If the datetime is naive then it is assumed to be local time.

• result (Any) – If provided, is returned to the caller when the coroutine completes.

disnake.utils.utcnow()

A helper function to return an aware UTC datetime representing the current time.

This should be preferred to datetime.datetime.utcnow() since it is an aware datetime, compared to the naive datetime in the standard library.

New in version 2.0.

Returns:

The current aware datetime in UTC.

Return type:

datetime.datetime

disnake.utils.format_dt(dt, /, style='f')

A helper function to format a datetime.datetime, int or float for presentation within Discord.

This allows for a locale-independent way of presenting data using Discord specific Markdown.

Style	Example Output	Description
t	22:57	Short Time
T	22:57:58	Long Time
d	17/05/2016	Short Date
D	17 May 2016	Long Date
f (default)	17 May 2016 22:57	Short Date Time
F	Tuesday, 17 May 2016 22:57	Long Date Time
R	5 years ago	Relative Time

Note that the exact output depends on the user’s locale setting in the client. The example output presented is using the en-GB locale.

New in version 2.0.

Parameters:

• dt (Union[datetime.datetime, int, float]) – The datetime to format. If this is a naive datetime, it is assumed to be local time.

• style (str) – The style to format the datetime with. Defaults to f

Returns:

The formatted string.

Return type:

str

disnake.utils.as_chunks(iterator, max_size)

A helper function that collects an iterator into chunks of a given size.

New in version 2.0.

Parameters:

• iterator (Union[collections.abc.Iterator, collections.abc.AsyncIterator]) – The iterator to chunk, can be sync or async.

• max_size (int) – The maximum chunk size.

Warning

The last chunk collected may not be as large as max_size.

Returns:

A new iterator which yields chunks of a given size.

Return type:

Union[Iterator, AsyncIterator]

for ... in disnake.utils.search_directory(path)

Walk through a directory and yield all modules.

Parameters:

path (str) – The path to search for modules

Yields:

str – The name of the found module. (usable in load_extension)

disnake.utils.as_valid_locale(locale)

Converts the provided locale name to a name that is valid for use with the API, for example by returning en-US for en_US. Returns None for invalid names.

New in version 2.5.

Parameters:

locale (str) – The input locale name.

Enumerations

The API provides some enumerations for certain types of strings to avoid the API from being stringly typed in case the strings change in the future.

All enumerations are subclasses of an internal class which mimics the behaviour of enum.Enum.

class disnake.ChannelType

Specifies the type of channel.

text

A text channel.

voice

A voice channel.

private

A private text channel. Also called a direct message.

group

A private group text channel.

category

A category channel.

news

A guild news channel.

stage_voice

A guild stage voice channel.

New in version 1.7.

news_thread

A news thread.

New in version 2.0.

public_thread

A public thread.

New in version 2.0.

private_thread

A private thread.

New in version 2.0.

guild_directory

A student hub channel.

New in version 2.1.

forum

A channel of only threads.

New in version 2.5.

class disnake.MessageType

Specifies the type of Message. This is used to denote if a message is to be interpreted as a system message or a regular message.

x == y

Checks if two messages are equal.

x != y

Checks if two messages are not equal.

default

The default message type. This is the same as regular messages.

recipient_add

The system message when a user is added to a group private message or a thread.

recipient_remove

The system message when a user is removed from a group private message or a thread.

call

The system message denoting call state, e.g. missed call, started call, etc.

channel_name_change

The system message denoting that a channel’s name has been changed.

channel_icon_change

The system message denoting that a channel’s icon has been changed.

pins_add

The system message denoting that a pinned message has been added to a channel.

new_member

The system message denoting that a new member has joined a Guild.

premium_guild_subscription

The system message denoting that a member has “nitro boosted” a guild.

premium_guild_tier_1

The system message denoting that a member has “nitro boosted” a guild and it achieved level 1.

premium_guild_tier_2

The system message denoting that a member has “nitro boosted” a guild and it achieved level 2.

premium_guild_tier_3

The system message denoting that a member has “nitro boosted” a guild and it achieved level 3.

channel_follow_add

The system message denoting that an announcement channel has been followed.

New in version 1.3.

guild_stream

The system message denoting that a member is streaming in the guild.

New in version 1.7.

guild_discovery_disqualified

The system message denoting that the guild is no longer eligible for Server Discovery.

New in version 1.7.

guild_discovery_requalified

The system message denoting that the guild has become eligible again for Server Discovery.

New in version 1.7.

guild_discovery_grace_period_initial_warning

The system message denoting that the guild has failed to meet the Server Discovery requirements for one week.

New in version 1.7.

guild_discovery_grace_period_final_warning

The system message denoting that the guild has failed to meet the Server Discovery requirements for 3 weeks in a row.

New in version 1.7.

thread_created

The system message denoting that a thread has been created. This is only sent if the thread has been created from an older message. The period of time required for a message to be considered old cannot be relied upon and is up to Discord.

New in version 2.0.

reply

The system message denoting that the author is replying to a message.

New in version 2.0.

application_command

The system message denoting that an application (or “slash”) command was executed.

New in version 2.0.

guild_invite_reminder

The system message sent as a reminder to invite people to the guild.

New in version 2.0.

thread_starter_message

The system message denoting the message in the thread that is the one that started the thread’s conversation topic.

New in version 2.0.

context_menu_command

The system message denoting that a context menu command was executed.

New in version 2.3.

auto_moderation_action

The system message denoting that an auto moderation action was executed.

New in version 2.5.

interaction_premium_upsell

The system message for an application premium subscription upsell.

New in version 2.8.

guild_application_premium_subscription

The system message denoting that a guild member has subscribed to an application.

New in version 2.8.

class disnake.UserFlags

Represents Discord User flags.

staff

The user is a Discord Employee.

partner

The user is a Discord Partner.

hypesquad

The user is a HypeSquad Events member.

bug_hunter

The user is a Bug Hunter.

mfa_sms

The user has SMS recovery for Multi Factor Authentication enabled.

premium_promo_dismissed

The user has dismissed the Discord Nitro promotion.

hypesquad_bravery

The user is a HypeSquad Bravery member.

hypesquad_brilliance

The user is a HypeSquad Brilliance member.

hypesquad_balance

The user is a HypeSquad Balance member.

early_supporter

The user is an Early Supporter.

team_user

The user is a Team User.

system

The user is a system user (i.e. represents Discord officially).

has_unread_urgent_messages

The user has an unread system message.

bug_hunter_level_2

The user is a Bug Hunter Level 2.

verified_bot

The user is a Verified Bot.

verified_bot_developer

The user is an Early Verified Bot Developer.

discord_certified_moderator

The user is a Discord Certified Moderator.

http_interactions_bot

The user is a bot that only uses HTTP interactions.

New in version 2.3.

spammer

The user is marked as a spammer.

New in version 2.3.

active_developer

The user is an Active Developer.

New in version 2.8.

class disnake.ActivityType

Specifies the type of Activity. This is used to check how to interpret the activity itself.

unknown

An unknown activity type. This should generally not happen.

playing

A “Playing” activity type.

streaming

A “Streaming” activity type.

listening

A “Listening” activity type.

watching

A “Watching” activity type.

custom

A custom activity type.

competing

A competing activity type.

New in version 1.5.

class disnake.PartyType

Represents the type of a voice channel activity/application.

poker

The “Poker Night” activity.

betrayal

The “Betrayal.io” activity.

fishing

The “Fishington.io” activity.

chess

The “Chess In The Park” activity.

letter_tile

The “Letter Tile” activity.

word_snack

The “Word Snacks” activity.

doodle_crew

The “Doodle Crew” activity.

checkers

The “Checkers In The Park” activity.

New in version 2.3.

spellcast

The “SpellCast” activity.

New in version 2.3.

watch_together

The “Watch Together” activity, a Youtube application.

New in version 2.3.

sketch_heads

The “Sketch Heads” activity.

New in version 2.4.

ocho

The “Ocho” activity.

New in version 2.4.

class disnake.ApplicationCommandType

Represents the type of an application command.

New in version 2.1.

chat_input

Represents a slash command.

user

Represents a user command from the context menu.

message

Represents a message command from the context menu.

class disnake.ApplicationCommandPermissionType

Represents the type of a permission of an application command.

New in version 2.5.

role

Represents a permission that affects roles.

user

Represents a permission that affects users.

channel

Represents a permission that affects channels.

class disnake.InteractionType

Specifies the type of Interaction.

New in version 2.0.

ping

Represents Discord pinging to see if the interaction response server is alive.

application_command

Represents an application command interaction.

component

Represents a component based interaction, i.e. using the Discord Bot UI Kit.

application_command_autocomplete

Represents an application command autocomplete interaction.

modal_submit

Represents a modal submit interaction.

class disnake.InteractionResponseType

Specifies the response type for the interaction.

New in version 2.0.

pong

Pongs the interaction when given a ping.

See also InteractionResponse.pong()

channel_message

Respond to the interaction with a message.

See also InteractionResponse.send_message()

deferred_channel_message

Responds to the interaction with a message at a later time.

See also InteractionResponse.defer()

deferred_message_update

Acknowledges the component interaction with a promise that the message will update later (though there is no need to actually update the message).

See also InteractionResponse.defer()

message_update

Responds to the interaction by editing the message.

See also InteractionResponse.edit_message()

application_command_autocomplete_result

Responds to the autocomplete interaction with suggested choices.

See also InteractionResponse.autocomplete()

modal

Responds to the interaction by displaying a modal.

See also InteractionResponse.send_modal()

class disnake.ComponentType

Represents the component type of a component.

New in version 2.0.

action_row

Represents the group component which holds different components in a row.

button

Represents a button component.

string_select

Represents a string select component.

New in version 2.7.

select

An alias of string_select.

text_input

Represents a text input component.

user_select

Represents a user select component.

New in version 2.7.

role_select

Represents a role select component.

New in version 2.7.

mentionable_select

Represents a mentionable (user/member/role) select component.

New in version 2.7.

channel_select

Represents a channel select component.

New in version 2.7.

class disnake.OptionType

Represents the type of an option.

New in version 2.1.

sub_command

Represents a sub command of the main command or group.

sub_command_group

Represents a sub command group of the main command.

string

Represents a string option.

integer

Represents an integer option.

boolean

Represents a boolean option.

user

Represents a user option.

channel

Represents a channel option.

role

Represents a role option.

mentionable

Represents a role + user option.

number

Represents a float option.

attachment

Represents an attachment option.

New in version 2.4.

class disnake.ButtonStyle

Represents the style of the button component.

New in version 2.0.

primary

Represents a blurple button for the primary action.

secondary

Represents a grey button for the secondary action.

success

Represents a green button for a successful action.

danger

Represents a red button for a dangerous action.

link

Represents a link button.

blurple

An alias for primary.

grey

An alias for secondary.

gray

An alias for secondary.

green

An alias for success.

red

An alias for danger.

url

An alias for link.

class disnake.TextInputStyle

Represents a style of the text input component.

New in version 2.4.

short

Represents a single-line text input component.

paragraph

Represents a multi-line text input component.

single_line

An alias for short.

multi_line

An alias for paragraph.

long

An alias for paragraph.

class disnake.VerificationLevel

Specifies a Guild's verification level, which is the criteria in which a member must meet before being able to send messages to the guild.

New in version 2.0.

x == y

Checks if two verification levels are equal.

x != y

Checks if two verification levels are not equal.

x > y

Checks if a verification level is higher than another.

x < y

Checks if a verification level is lower than another.

x >= y

Checks if a verification level is higher or equal to another.

x <= y

Checks if a verification level is lower or equal to another.

none

No criteria set.

low

Member must have a verified email on their Discord account.

medium

Member must have a verified email and be registered on Discord for more than five minutes.

high

Member must have a verified email, be registered on Discord for more than five minutes, and be a member of the guild itself for more than ten minutes.

highest

Member must have a verified phone on their Discord account.

class disnake.NotificationLevel

Specifies whether a Guild has notifications on for all messages or mentions only by default.

New in version 2.0.

x == y

Checks if two notification levels are equal.

x != y

Checks if two notification levels are not equal.

x > y

Checks if a notification level is higher than another.

x < y

Checks if a notification level is lower than another.

x >= y

Checks if a notification level is higher or equal to another.

x <= y

Checks if a notification level is lower or equal to another.

all_messages

Members receive notifications for every message regardless of them being mentioned.

only_mentions

Members receive notifications for messages they are mentioned in.

class disnake.ContentFilter

Specifies a Guild's explicit content filter, which is the machine learning algorithms that Discord uses to detect if an image contains pornography or otherwise explicit content.

New in version 2.0.

x == y

Checks if two content filter levels are equal.

x != y

Checks if two content filter levels are not equal.

x > y

Checks if a content filter level is higher than another.

x < y

Checks if a content filter level is lower than another.

x >= y

Checks if a content filter level is higher or equal to another.

x <= y

Checks if a content filter level is lower or equal to another.

disabled

The guild does not have the content filter enabled.

no_role

The guild has the content filter enabled for members without a role.

all_members

The guild has the content filter enabled for every member.

class disnake.Status

Specifies a Member ‘s status.

online

The member is online.

offline

The member is offline.

idle

The member is idle.

dnd

The member is “Do Not Disturb”.

do_not_disturb

An alias for dnd.

invisible

The member is “invisible”. In reality, this is only used in sending a presence a la Client.change_presence(). When you receive a user’s presence this will be offline instead.

streaming

The member is live streaming to Twitch.

New in version 2.3.

class disnake.AuditLogAction

Represents the type of action being done for a AuditLogEntry, which is retrievable via Guild.audit_logs() or via the on_audit_log_entry_create() event.

guild_update

The guild has updated. Things that trigger this include:

• Changing the guild vanity URL

• Changing the guild invite splash

• Changing the guild AFK channel or timeout

• Changing the guild voice server region

• Changing the guild icon, banner, or discovery splash

• Changing the guild moderation settings

• Changing things related to the guild widget

When this is the action, the type of target is the Guild.

Possible attributes for AuditLogDiff:

• afk_channel

• system_channel

• afk_timeout

• default_message_notifications

• explicit_content_filter

• mfa_level

• name

• owner

• splash

• discovery_splash

• icon

• banner

• vanity_url_code

• preferred_locale

• description

• rules_channel

• public_updates_channel

• widget_enabled

• widget_channel

• verification_level

• premium_progress_bar_enabled

• system_channel_flags

channel_create

A new channel was created.

When this is the action, the type of target is either a abc.GuildChannel or Object with an ID.

A more filled out object in the Object case can be found by using after.

Possible attributes for AuditLogDiff:

• name

• type

• overwrites

• topic

• bitrate

• rtc_region

• video_quality_mode

• default_auto_archive_duration

• user_limit

• slowmode_delay

• default_thread_slowmode_delay

• nsfw

• available_tags

• default_reaction

channel_update

A channel was updated. Things that trigger this include:

• The channel name or topic was changed

• The channel bitrate was changed

When this is the action, the type of target is the abc.GuildChannel or Object with an ID.

A more filled out object in the Object case can be found by using after or before.

Possible attributes for AuditLogDiff:

• name

• type

• position

• overwrites

• topic

• bitrate

• rtc_region

• video_quality_mode

• default_auto_archive_duration

• user_limit

• slowmode_delay

• default_thread_slowmode_delay

• nsfw

• available_tags

• default_reaction

channel_delete

A channel was deleted.

When this is the action, the type of target is an Object with an ID.

A more filled out object can be found by using the before object.

Possible attributes for AuditLogDiff:

• name

• type

• overwrites

• topic

• bitrate

• rtc_region

• video_quality_mode

• default_auto_archive_duration

• user_limit

• slowmode_delay

• default_thread_slowmode_delay

• nsfw

• available_tags

• default_reaction

overwrite_create

A channel permission overwrite was created.

When this is the action, the type of target is the abc.GuildChannel or Object with an ID.

When this is the action, the type of extra is either a Role or Member. If the object is not found then it is a Object with an ID being filled, a name, and a type attribute set to either 'role' or 'member' to help dictate what type of ID it is.

Possible attributes for AuditLogDiff:

• deny

• allow

• id

• type

Changed in version 2.6: type for this action is now an int.

overwrite_update

A channel permission overwrite was changed, this is typically when the permission values change.

See overwrite_create for more information on how the target and extra fields are set.

Possible attributes for AuditLogDiff:

• deny

• allow

• id

• type

Changed in version 2.6: type for this action is now an int.

overwrite_delete

A channel permission overwrite was deleted.

See overwrite_create for more information on how the target and extra fields are set.

Possible attributes for AuditLogDiff:

• deny

• allow

• id

• type

Changed in version 2.6: type for this action is now an int.

kick

A member was kicked.

When this is the action, the type of target is the User who got kicked. If the user is not found then it is a Object with the user’s ID.

When this is the action, changes is empty.

member_prune

A member prune was triggered.

When this is the action, the type of target is set to None.

When this is the action, the type of extra is set to an unspecified proxy object with two attributes:

• delete_members_days: An integer specifying how far the prune was.

• members_removed: An integer specifying how many members were removed.

When this is the action, changes is empty.

ban

A member was banned.

When this is the action, the type of target is the User who got banned. If the user is not found then it is a Object with the user’s ID.

When this is the action, changes is empty.

unban

A member was unbanned.

When this is the action, the type of target is the User who got unbanned. If the user is not found then it is a Object with the user’s ID.

When this is the action, changes is empty.

member_update

A member has updated. This triggers in the following situations:

• A nickname was changed

• They were server muted or deafened (or it was undone)

• They were timed out

When this is the action, the type of target is the Member or User who got updated. If the user is not found then it is a Object with the user’s ID.

Possible attributes for AuditLogDiff:

• nick

• mute

• deaf

• timeout

member_role_update

A member’s role has been updated. This triggers when a member either gains a role or loses a role.

When this is the action, the type of target is the Member or User who got the role. If the user is not found then it is a Object with the user’s ID.

Possible attributes for AuditLogDiff:

• roles

member_move

A member’s voice channel has been updated. This triggers when a member is moved to a different voice channel.

When this is the action, the type of extra is set to an unspecified proxy object with two attributes:

• channel: A TextChannel or Object with the channel ID where the members were moved.

• count: An integer specifying how many members were moved.

New in version 1.3.

member_disconnect

A member’s voice state has changed. This triggers when a member is force disconnected from voice.

When this is the action, the type of extra is set to an unspecified proxy object with one attribute:

• count: An integer specifying how many members were disconnected.

New in version 1.3.

bot_add

A bot was added to the guild.

When this is the action, the type of target is the Member or User which was added to the guild. If the user is not found then it is a Object with an ID.

New in version 1.3.

role_create

A new role was created.

When this is the action, the type of target is the Role or a Object with the ID.

Possible attributes for AuditLogDiff:

• colour

• mentionable

• hoist

• name

• permissions

• icon

• emoji

role_update

A role was updated. This triggers in the following situations:

• The name has changed

• The permissions have changed

• The colour has changed

• Its hoist/mentionable state has changed

When this is the action, the type of target is the Role or a Object with the ID.

Possible attributes for AuditLogDiff:

• colour

• mentionable

• hoist

• name

• permissions

• icon

• emoji

role_delete

A role was deleted.

When this is the action, the type of target is the Object with the ID.

Possible attributes for AuditLogDiff:

• colour

• mentionable

• hoist

• name

• permissions

• icon

• emoji

invite_create

An invite was created.

When this is the action, the type of target is the Invite that was created.

Possible attributes for AuditLogDiff:

• max_age

• code

• temporary

• inviter

• channel

• uses

• max_uses

invite_update

An invite was updated.

When this is the action, the type of target is the Invite that was updated.

invite_delete

An invite was deleted.

When this is the action, the type of target is the Invite that was deleted.

Possible attributes for AuditLogDiff:

• max_age

• code

• temporary

• inviter

• channel

• uses

• max_uses

webhook_create

A webhook was created.

When this is the action, the type of target is the Webhook or Object with the webhook ID.

Possible attributes for AuditLogDiff:

• channel

• name

• type

• application_id

• avatar

Changed in version 2.6: Added application_id.

Changed in version 2.6: type for this action is now a WebhookType.

Changed in version 2.6: Added support for Webhook instead of plain Objects.

webhook_update

A webhook was updated. This trigger in the following situations:

• The webhook name changed

• The webhook channel changed

When this is the action, the type of target is the Webhook or Object with the webhook ID.

Possible attributes for AuditLogDiff:

• channel

• name

• avatar

Changed in version 2.6: Added support for Webhook instead of plain Objects.

webhook_delete

A webhook was deleted.

When this is the action, the type of target is the Object with the webhook ID.

Possible attributes for AuditLogDiff:

• channel

• name

• type

• application_id

• avatar

Changed in version 2.6: Added application_id.

Changed in version 2.6: type for this action is now a WebhookType.

emoji_create

An emoji was created.

When this is the action, the type of target is the Emoji or Object with the emoji ID.

Possible attributes for AuditLogDiff:

• name

emoji_update

An emoji was updated. This triggers when the name has changed.

When this is the action, the type of target is the Emoji or Object with the emoji ID.

Possible attributes for AuditLogDiff:

• name

emoji_delete

An emoji was deleted.

When this is the action, the type of target is the Object with the emoji ID.

Possible attributes for AuditLogDiff:

• name

message_delete

A message was deleted by a moderator. Note that this only triggers if the message was deleted by someone other than the author.

When this is the action, the type of target is the Member or User who had their message deleted. If the user is not found then it is a Object with the user’s ID.

When this is the action, the type of extra is set to an unspecified proxy object with two attributes:

• count: An integer specifying how many messages were deleted.

• channel: A TextChannel or Object with the channel ID where the message got deleted.

message_bulk_delete

Messages were bulk deleted by a moderator.

When this is the action, the type of target is the TextChannel or Object with the ID of the channel that was purged.

When this is the action, the type of extra is set to an unspecified proxy object with one attribute:

• count: An integer specifying how many messages were deleted.

New in version 1.3.

message_pin

A message was pinned in a channel.

When this is the action, the type of target is the Member or User who had their message pinned. If the user is not found then it is a Object with the user’s ID.

When this is the action, the type of extra is set to an unspecified proxy object with two attributes:

• channel: A TextChannel or Object with the channel ID where the message was pinned.

• message_id: the ID of the message which was pinned.

New in version 1.3.

message_unpin

A message was unpinned in a channel.

When this is the action, the type of target is the Member or User who had their message unpinned. If the user is not found then it is a Object with the user’s ID.

When this is the action, the type of extra is set to an unspecified proxy object with two attributes:

• channel: A TextChannel or Object with the channel ID where the message was unpinned.

• message_id: the ID of the message which was unpinned.

New in version 1.3.

integration_create

A guild integration was created.

When this is the action, the type of target is the PartialIntegration or Object with the integration ID of the integration which was created.

Possible attributes for AuditLogDiff:

• type

New in version 1.3.

Changed in version 2.6: Added support for PartialIntegration instead of plain Objects.

integration_update

A guild integration was updated.

When this is the action, the type of target is the PartialIntegration or Object with the integration ID of the integration which was updated.

New in version 1.3.

Changed in version 2.6: Added support for PartialIntegration instead of plain Objects.

integration_delete

A guild integration was deleted.

When this is the action, the type of target is the Object with the integration ID of the integration which was deleted.

Possible attributes for AuditLogDiff:

• type

New in version 1.3.

guild_scheduled_event_create

A guild scheduled event was created.

When this is the action, the type of target is the GuildScheduledEvent or Object with the ID of the event which was created.

Possible attributes for AuditLogDiff:

• name

• description

• privacy_level

• status

• entity_type

• channel

• location

• image

New in version 2.3.

guild_scheduled_event_update

A guild scheduled event was updated.

When this is the action, the type of target is the GuildScheduledEvent or Object with the ID of the event which was updated.

Possible attributes for AuditLogDiff:

• name

• description

• privacy_level

• status

• entity_type

• channel

• location

• image

New in version 2.3.

guild_scheduled_event_delete

A guild scheduled event was deleted.

When this is the action, the type of target is the Object with the ID of the event which was deleted.

Possible attributes for AuditLogDiff:

• name

• description

• privacy_level

• status

• entity_type

• channel

• location

• image

New in version 2.3.

stage_instance_create

A stage instance was started.

When this is the action, the type of target is the StageInstance or Object with the ID of the stage instance which was created.

When this is the action, the type of extra is set to an unspecified proxy object with one attribute:

• channel: The StageChannel or Object with the channel ID where the stage instance was started.

Possible attributes for AuditLogDiff:

• topic

• privacy_level

New in version 2.0.

stage_instance_update

A stage instance was updated.

When this is the action, the type of target is the StageInstance or Object with the ID of the stage instance which was updated.

See stage_instance_create for more information on how the extra field is set.

Possible attributes for AuditLogDiff:

• topic

• privacy_level

New in version 2.0.

stage_instance_delete

A stage instance was ended.

See stage_instance_create for more information on how the extra field is set.

Possible attributes for AuditLogDiff:

• topic

• privacy_level

New in version 2.0.

sticker_create

A sticker was created.

When this is the action, the type of target is the GuildSticker or Object with the ID of the sticker which was created.

Possible attributes for AuditLogDiff:

• name

• emoji

• type

• format_type

• description

• available

New in version 2.0.

sticker_update

A sticker was updated.

When this is the action, the type of target is the GuildSticker or Object with the ID of the sticker which was updated.

Possible attributes for AuditLogDiff:

• name

• emoji

• description

New in version 2.0.

sticker_delete

A sticker was deleted.

When this is the action, the type of target is the Object with the ID of the sticker which was deleted.

Possible attributes for AuditLogDiff:

• name

• emoji

• type

• format_type

• description

• available

New in version 2.0.

thread_create

A thread was created.

When this is the action, the type of target is the Thread or Object with the ID of the thread which was created.

Possible attributes for AuditLogDiff:

• name

• archived

• locked

• auto_archive_duration

• type

• slowmode_delay

• invitable

• flags

• applied_tags

New in version 2.0.

thread_update

A thread was updated.

When this is the action, the type of target is the Thread or Object with the ID of the thread which was updated.

Possible attributes for AuditLogDiff:

• name

• archived

• locked

• auto_archive_duration

• slowmode_delay

• invitable

• flags

• applied_tags

New in version 2.0.

thread_delete

A thread was deleted.

When this is the action, the type of target is the Object with the ID of the thread which was deleted.

Possible attributes for AuditLogDiff:

• name

• archived

• locked

• auto_archive_duration

• type

• slowmode_delay

• invitable

• flags

• applied_tags

New in version 2.0.

application_command_permission_update

The permissions of an application command were updated.

When this is the action, the type of target is the ApplicationCommand, PartialIntegration, or Object with the ID of the command whose permissions were updated or the application ID if these are application-wide permissions.

When this is the action, the type of extra is set to an unspecified proxy object with one attribute:

• integration: The PartialIntegration or Object with the application ID of the associated application.

Possible attributes for AuditLogDiff:

• command_permissions

New in version 2.5.

Changed in version 2.6: Added support for PartialIntegration, and added integration to extra.

automod_rule_create

An auto moderation rule was created.

When this is the action, the type of target is the AutoModRule or Object with the ID of the auto moderation rule which was created.

Possible attributes for AuditLogDiff:

• name

• enabled

• trigger_type

• event_type

• actions

• trigger_metadata

• exempt_roles

• exempt_channels

New in version 2.6.

automod_rule_update

An auto moderation rule was updated.

When this is the action, the type of target is the AutoModRule or Object with the ID of the auto moderation rule which was updated.

Possible attributes for AuditLogDiff:

• name

• enabled

• trigger_type

• event_type

• actions

• trigger_metadata

• exempt_roles

• exempt_channels

New in version 2.6.

automod_rule_delete

An auto moderation rule was deleted.

When this is the action, the type of target is the Object with the ID of the auto moderation rule which was deleted.

Possible attributes for AuditLogDiff:

• name

• enabled

• trigger_type

• event_type

• actions

• trigger_metadata

• exempt_roles

• exempt_channels

New in version 2.6.

automod_block_message

A message was blocked by an auto moderation rule.

When this is the action, the type of target is the Member or User who had their message blocked. If the user is not found then it is a Object with the user’s ID.

When this is the action, the type of extra is set to an unspecified proxy object with these attributes:

• channel: A GuildChannel, Thread or Object with the channel ID where the message got blocked. May also be None.

• rule_name: A str with the name of the rule that matched.

• rule_trigger_type: An AutoModTriggerType value with the trigger type of the rule.

automod_send_alert_message

An alert message was sent by an auto moderation rule.

When this is the action, the type of target is the Member or User who had their message flagged. If the user is not found then it is a Object with the user’s ID.

See automod_block_message for more information on how the extra field is set.

automod_timeout

A user was timed out by an auto moderation rule.

When this is the action, the type of target is the Member or User who was timed out. If the user is not found then it is a Object with the user’s ID.

See automod_block_message for more information on how the extra field is set.

class disnake.AuditLogActionCategory

Represents the category that the AuditLogAction belongs to.

This can be retrieved via AuditLogEntry.category.

create

The action is the creation of something.

delete

The action is the deletion of something.

update

The action is the update of something.

class disnake.TeamMembershipState

Represents the membership state of a team member retrieved through Client.application_info().

New in version 1.3.

invited

Represents an invited member.

accepted

Represents a member currently in the team.

class disnake.WebhookType

Represents the type of webhook that can be received.

New in version 1.3.

incoming

Represents a webhook that can post messages to channels with a token.

channel_follower

Represents a webhook that is internally managed by Discord, used for following channels.

application

Represents a webhook that is used for interactions or applications.

New in version 2.0.

class disnake.ExpireBehaviour

Represents the behaviour the Integration should perform when a user’s subscription has finished.

There is an alias for this called ExpireBehavior.

New in version 1.4.

remove_role

This will remove the StreamIntegration.role from the user when their subscription is finished.

kick

This will kick the user when their subscription is finished.

class disnake.DefaultAvatar

Represents the default avatar of a Discord User

blurple

Represents the default avatar with the color blurple. See also Colour.blurple

grey

Represents the default avatar with the color grey. See also Colour.greyple

gray

An alias for grey.

green

Represents the default avatar with the color green. See also Colour.green

orange

Represents the default avatar with the color orange. See also Colour.orange

red

Represents the default avatar with the color red. See also Colour.red

class disnake.StickerType

Represents the type of sticker.

New in version 2.0.

standard

Represents a standard sticker that all Nitro users can use.

guild

Represents a custom sticker created in a guild.

class disnake.StickerFormatType

Represents the type of sticker images.

New in version 1.6.

png

Represents a sticker with a png image.

apng

Represents a sticker with an apng image.

lottie

Represents a sticker with a lottie image.

gif

Represents a sticker with a gif image.

New in version 2.8.

class disnake.InviteTarget

Represents the invite type for voice channel invites.

New in version 2.0.

unknown

The invite doesn’t target anyone or anything.

stream

A stream invite that targets a user.

embedded_application

A stream invite that targets an embedded application.

class disnake.VideoQualityMode

Represents the camera video quality mode for voice channel participants.

New in version 2.0.

auto

Represents auto camera video quality.

full

Represents full camera video quality.

class disnake.StagePrivacyLevel

Represents a stage instance’s privacy level.

New in version 2.0.

public

The stage instance can be joined by external users.

Deprecated since version 2.5: Public stages are no longer supported by discord.

closed

The stage instance can only be joined by members of the guild.

guild_only

Alias for closed

class disnake.NSFWLevel

Represents the NSFW level of a guild.

New in version 2.0.

x == y

Checks if two NSFW levels are equal.

x != y

Checks if two NSFW levels are not equal.

x > y

Checks if a NSFW level is higher than another.

x < y

Checks if a NSFW level is lower than another.

x >= y

Checks if a NSFW level is higher or equal to another.

x <= y

Checks if a NSFW level is lower or equal to another.

default

The guild has not been categorised yet.

explicit

The guild contains NSFW content.

safe

The guild does not contain any NSFW content.

age_restricted

The guild may contain NSFW content.

class disnake.GuildScheduledEventEntityType

Represents the type of a guild scheduled event entity.

New in version 2.3.

stage_instance

The guild scheduled event will take place in a stage channel.

voice

The guild scheduled event will take place in a voice channel.

external

The guild scheduled event will take place in a custom location.

class disnake.GuildScheduledEventStatus

Represents the status of a guild scheduled event.

New in version 2.3.

scheduled

Represents a scheduled event.

active

Represents an active event.

completed

Represents a completed event.

canceled

Represents a canceled event.

cancelled

An alias for canceled.

New in version 2.6.

class disnake.GuildScheduledEventPrivacyLevel

Represents the privacy level of a guild scheduled event.

New in version 2.3.

guild_only

The guild scheduled event is only for a specific guild.

class disnake.ThreadArchiveDuration

Represents the automatic archive duration of a thread in minutes.

New in version 2.3.

hour

The thread will archive after an hour of inactivity.

day

The thread will archive after a day of inactivity.

three_days

The thread will archive after three days of inactivity.

week

The thread will archive after a week of inactivity.

class disnake.WidgetStyle

Represents the supported widget image styles.

New in version 2.5.

shield

A shield style image with a Discord icon and the online member count.

banner1

A large image with guild icon, name and online member count and a footer.

banner2

A small image with guild icon, name and online member count.

banner3

A large image with guild icon, name and online member count and a footer, with a “Chat Now” label on the right.

banner4

A large image with a large Discord logo, guild icon, name and online member count, with a “Join My Server” label at the bottom.

class disnake.Locale

Represents supported locales by Discord.

New in version 2.5.

bg

The bg (Bulgarian) locale.

cs

The cs (Czech) locale.

da

The da (Danish) locale.

de

The de (German) locale.

el

The el (Greek) locale.

en_GB

The en_GB (English, UK) locale.

en_US

The en_US (English, US) locale.

es_ES

The es_ES (Spanish) locale.

fi

The fi (Finnish) locale.

fr

The fr (French) locale.

hi

The hi (Hindi) locale.

hr

The hr (Croatian) locale.

hu

The hu (Hungarian) locale.

id

The id (Indonesian) locale.

New in version 2.8.

it

The it (Italian) locale.

ja

The ja (Japanese) locale.

ko

The ko (Korean) locale.

lt

The lt (Lithuanian) locale.

nl

The nl (Dutch) locale.

no

The no (Norwegian) locale.

pl

The pl (Polish) locale.

pt_BR

The pt_BR (Portuguese) locale.

ro

The ro (Romanian) locale.

ru

The ru (Russian) locale.

sv_SE

The sv_SE (Swedish) locale.

th

The th (Thai) locale.

tr

The tr (Turkish) locale.

uk

The uk (Ukrainian) locale.

vi

The vi (Vietnamese) locale.

zh_CN

The zh_CN (Chinese, China) locale.

zh_TW

The zh_TW (Chinese, Taiwan) locale.

class disnake.AutoModActionType

Represents the type of action an auto moderation rule will take upon execution.

New in version 2.6.

block_message

The rule will prevent matching messages from being posted.

send_alert_message

The rule will send an alert to a specified channel.

timeout

The rule will timeout the user that sent the message.

Note

This action type is only available for rules with trigger type keyword or mention_spam, and moderate_members permissions are required to use it.

class disnake.AutoModEventType

Represents the type of event/context an auto moderation rule will be checked in.

New in version 2.6.

message_send

The rule will apply when a member sends or edits a message in the guild.

class disnake.AutoModTriggerType

Represents the type of content that can trigger an auto moderation rule.

New in version 2.6.

keyword

The rule will filter messages based on a custom keyword list.

This trigger type requires additional metadata.

harmful_link

The rule will filter messages containing malicious links.

spam

The rule will filter messages suspected of being spam.

keyword_preset

The rule will filter messages based on predefined lists containing commonly flagged words.

This trigger type requires additional metadata.

mention_spam

The rule will filter messages based on the number of member/role mentions they contain.

This trigger type requires additional metadata.

class disnake.ThreadSortOrder

Represents the sort order of threads in ForumChannels.

New in version 2.6.

latest_activity

Sort forum threads by activity.

creation_date

Sort forum threads by creation date/time (from newest to oldest).

class disnake.ThreadLayout

Represents the layout of threads in ForumChannels.

New in version 2.8.

not_set

No preferred layout has been set.

list_view

Display forum threads in a text-focused list.

gallery_view

Display forum threads in a media-focused collection of tiles.

class disnake.ApplicationRoleConnectionMetadataType

Represents the type of a role connection metadata value.

These offer comparison operations, which allow guilds to configure role requirements based on the metadata value for each user and a guild-specified configured value.

New in version 2.8.

integer_less_than_or_equal

The metadata value (integer) is less than or equal to the guild’s configured value.

integer_greater_than_or_equal

The metadata value (integer) is greater than or equal to the guild’s configured value.

integer_equal

The metadata value (integer) is equal to the guild’s configured value.

integer_not_equal

The metadata value (integer) is not equal to the guild’s configured value.

datetime_less_than_or_equal

The metadata value (ISO8601 string) is less than or equal to the guild’s configured value (integer; days before current date).

datetime_greater_than_or_equal

The metadata value (ISO8601 string) is greater than or equal to the guild’s configured value (integer; days before current date).

boolean_equal

The metadata value (integer) is equal to the guild’s configured value.

boolean_not_equal

The metadata value (integer) is not equal to the guild’s configured value.

class disnake.Event(value)

Represents all the events of the library.

These offer to register listeners/events in a more pythonic way; additionally autocompletion and documentation are both supported.

New in version 2.8.

connect = <Event.connect: 'connect'>

Called when the client has successfully connected to Discord. Represents the on_connect() event.

disconnect = <Event.disconnect: 'disconnect'>

Called when the client has disconnected from Discord, or a connection attempt to Discord has failed. Represents the on_disconnect() event.

error = <Event.error: 'error'>

Called when an uncaught exception occurred. Represents the on_error() event.

gateway_error = <Event.gateway_error: 'gateway_error'>

Called when a known gateway event cannot be parsed. Represents the on_gateway_error() event.

ready = <Event.ready: 'ready'>

Called when the client is done preparing the data received from Discord. Represents the on_ready() event.

resumed = <Event.resumed: 'resumed'>

Called when the client has resumed a session. Represents the on_resumed() event.

shard_connect = <Event.shard_connect: 'shard_connect'>

Called when a shard has successfully connected to Discord. Represents the on_shard_connect() event.

shard_disconnect = <Event.shard_disconnect: 'shard_disconnect'>

Called when a shard has disconnected from Discord. Represents the on_shard_disconnect() event.

shard_ready = <Event.shard_ready: 'shard_ready'>

Called when a shard has become ready. Represents the on_shard_ready() event.

shard_resumed = <Event.shard_resumed: 'shard_resumed'>

Called when a shard has resumed a session. Represents the on_shard_resumed() event.

socket_event_type = <Event.socket_event_type: 'socket_event_type'>

Called whenever a websocket event is received from the WebSocket. Represents the on_socket_event_type() event.

socket_raw_receive = <Event.socket_raw_receive: 'socket_raw_receive'>

Called whenever a message is completely received from the WebSocket, before it’s processed and parsed. Represents the on_socket_raw_receive() event.

socket_raw_send = <Event.socket_raw_send: 'socket_raw_send'>

Called whenever a send operation is done on the WebSocket before the message is sent. Represents the on_socket_raw_send() event.

guild_channel_create = <Event.guild_channel_create: 'guild_channel_create'>

Called whenever a guild channel is created. Represents the on_guild_channel_create() event.

guild_channel_update = <Event.guild_channel_update: 'guild_channel_update'>

Called whenever a guild channel is updated. Represents the on_guild_channel_update() event.

guild_channel_delete = <Event.guild_channel_delete: 'guild_channel_delete'>

Called whenever a guild channel is deleted. Represents the on_guild_channel_delete() event.

guild_channel_pins_update = <Event.guild_channel_pins_update: 'guild_channel_pins_update'>

Called whenever a message is pinned or unpinned from a guild channel. Represents the on_guild_channel_pins_update() event.

invite_create = <Event.invite_create: 'invite_create'>

Called when an Invite is created. Represents the on_invite_create() event.

invite_delete = <Event.invite_delete: 'invite_delete'>

Called when an Invite is deleted. Represents the on_invite_delete() event.

private_channel_update = <Event.private_channel_update: 'private_channel_update'>

Called whenever a private group DM is updated. Represents the on_private_channel_update() event.

private_channel_pins_update = <Event.private_channel_pins_update: 'private_channel_pins_update'>

Called whenever a message is pinned or unpinned from a private channel. Represents the on_private_channel_pins_update() event.

webhooks_update = <Event.webhooks_update: 'webhooks_update'>

Called whenever a webhook is created, modified, or removed from a guild channel. Represents the on_webhooks_update() event.

thread_create = <Event.thread_create: 'thread_create'>

Called whenever a thread is created. Represents the on_thread_create() event.

thread_update = <Event.thread_update: 'thread_update'>

Called when a thread is updated. Represents the on_thread_update() event.

thread_delete = <Event.thread_delete: 'thread_delete'>

Called when a thread is deleted. Represents the on_thread_delete() event.

thread_join = <Event.thread_join: 'thread_join'>

Called whenever the bot joins a thread or gets access to a thread. Represents the on_thread_join() event.

thread_remove = <Event.thread_remove: 'thread_remove'>

Called whenever a thread is removed. This is different from a thread being deleted. Represents the on_thread_remove() event.

thread_member_join = <Event.thread_member_join: 'thread_member_join'>

Called when a ThreadMember joins a Thread. Represents the on_thread_member_join() event.

thread_member_remove = <Event.thread_member_remove: 'thread_member_remove'>

Called when a ThreadMember leaves a Thread. Represents the on_thread_member_remove() event.

raw_thread_member_remove = <Event.raw_thread_member_remove: 'raw_thread_member_remove'>

Called when a ThreadMember leaves Thread regardless of the thread member cache. Represents the on_raw_thread_member_remove() event.

raw_thread_update = <Event.raw_thread_update: 'raw_thread_update'>

Called whenever a thread is updated regardless of the state of the internal thread cache. Represents the on_raw_thread_update() event.

raw_thread_delete = <Event.raw_thread_delete: 'raw_thread_delete'>

Called whenever a thread is deleted regardless of the state of the internal thread cache. Represents the on_raw_thread_delete() event.

guild_join = <Event.guild_join: 'guild_join'>

Called when a Guild is either created by the Client or when the Client joins a guild. Represents the on_guild_join() event.

guild_remove = <Event.guild_remove: 'guild_remove'>

Called when a Guild is removed from the Client. Represents the on_guild_remove() event.

guild_update = <Event.guild_update: 'guild_update'>

Called when a Guild updates. Represents the on_guild_update() event.

guild_available = <Event.guild_available: 'guild_available'>

Called when a guild becomes available. Represents the on_guild_available() event.

guild_unavailable = <Event.guild_unavailable: 'guild_unavailable'>

Called when a guild becomes unavailable. Represents the on_guild_unavailable() event.

guild_role_create = <Event.guild_role_create: 'guild_role_create'>

Called when a Guild creates a new Role. Represents the on_guild_role_create() event.

guild_role_update = <Event.guild_role_update: 'guild_role_update'>

Called when a Guild updates a Role. Represents the on_guild_role_update() event.

guild_role_delete = <Event.guild_role_delete: 'guild_role_delete'>

Called when a Guild deletes a Role. Represents the on_guild_role_delete() event.

guild_emojis_update = <Event.guild_emojis_update: 'guild_emojis_update'>

Called when a Guild adds or removes Emoji. Represents the on_guild_emojis_update() event.

guild_stickers_update = <Event.guild_stickers_update: 'guild_stickers_update'>

Called when a Guild updates its stickers. Represents the on_guild_stickers_update() event.

guild_integrations_update = <Event.guild_integrations_update: 'guild_integrations_update'>

Called whenever an integration is created, modified, or removed from a guild. Represents the on_guild_integrations_update() event.

guild_scheduled_event_create = <Event.guild_scheduled_event_create: 'guild_scheduled_event_create'>

Called when a guild scheduled event is created. Represents the on_guild_scheduled_event_create() event.

guild_scheduled_event_update = <Event.guild_scheduled_event_update: 'guild_scheduled_event_update'>

Called when a guild scheduled event is updated. Represents the on_guild_scheduled_event_update() event.

guild_scheduled_event_delete = <Event.guild_scheduled_event_delete: 'guild_scheduled_event_delete'>

Called when a guild scheduled event is deleted. Represents the on_guild_scheduled_event_delete() event.

guild_scheduled_event_subscribe = <Event.guild_scheduled_event_subscribe: 'guild_scheduled_event_subscribe'>

Called when a user subscribes from a guild scheduled event. Represents the on_guild_scheduled_event_subscribe() event.

guild_scheduled_event_unsubscribe = <Event.guild_scheduled_event_unsubscribe: 'guild_scheduled_event_unsubscribe'>

Called when a user unsubscribes from a guild scheduled event. Represents the on_guild_scheduled_event_unsubscribe() event.

raw_guild_scheduled_event_subscribe = <Event.raw_guild_scheduled_event_subscribe: 'raw_guild_scheduled_event_subscribe'>

Called when a user subscribes from a guild scheduled event regardless of the guild scheduled event cache. Represents the on_raw_guild_scheduled_event_subscribe() event.

raw_guild_scheduled_event_unsubscribe = <Event.raw_guild_scheduled_event_unsubscribe: 'raw_guild_scheduled_event_unsubscribe'>

Called when a user subscribes to or unsubscribes from a guild scheduled event regardless of the guild scheduled event cache. Represents the on_raw_guild_scheduled_event_unsubscribe() event.

application_command_permissions_update = <Event.application_command_permissions_update: 'application_command_permissions_update'>

Called when the permissions of an application command or the application-wide command permissions are updated. Represents the on_application_command_permissions_update() event.

automod_action_execution = <Event.automod_action_execution: 'automod_action_execution'>

Called when an auto moderation action is executed due to a rule triggering for a particular event. Represents the on_automod_action_execution() event.

automod_rule_create = <Event.automod_rule_create: 'automod_rule_create'>

Called when an AutoModRule is created. Represents the on_automod_rule_create() event.

automod_rule_update = <Event.automod_rule_update: 'automod_rule_update'>

Called when an AutoModRule is updated. Represents the on_automod_rule_update() event.

automod_rule_delete = <Event.automod_rule_delete: 'automod_rule_delete'>

Called when an AutoModRule is deleted. Represents the on_automod_rule_delete() event.

integration_create = <Event.integration_create: 'integration_create'>

Called when an integration is created. Represents the on_integration_create() event.

integration_update = <Event.integration_update: 'integration_update'>

Called when an integration is updated. Represents the on_integration_update() event.

raw_integration_delete = <Event.raw_integration_delete: 'raw_integration_delete'>

Called when an integration is deleted. Represents the on_raw_integration_delete() event.

member_join = <Event.member_join: 'member_join'>

Called when a Member joins a Guild. Represents the on_member_join() event.

member_update = <Event.member_update: 'member_update'>

Called when a Member updates their profile. Represents the on_member_update() event.

member_remove = <Event.member_remove: 'member_remove'>

Called when a Member leaves a Guild. Represents the on_member_remove() event.

raw_member_remove = <Event.raw_member_remove: 'raw_member_remove'>

Called when a member leaves a Guild regardless of the member cache. Represents the on_raw_member_remove() event.

raw_member_update = <Event.raw_member_update: 'raw_member_update'>

Called when a member updates their profile regardless of the member cache. Represents the on_raw_member_update() event.

audit_log_entry_create = <Event.audit_log_entry_create: 'audit_log_entry_create'>

Called when an audit log entry is created. Represents the on_audit_log_entry_create() event.

member_ban = <Event.member_ban: 'member_ban'>

Called when user gets banned from a Guild. Represents the on_member_ban() event.

member_unban = <Event.member_unban: 'member_unban'>

Called when a User gets unbanned from a Guild. Represents the on_member_unban() event.

presence_update = <Event.presence_update: 'presence_update'>

Called when a Member updates their presence. Represents the on_presence_update() event.

user_update = <Event.user_update: 'user_update'>

Called when a User is updated. Represents the on_user_update() event.

voice_state_update = <Event.voice_state_update: 'voice_state_update'>

Called when a Member changes their VoiceState. Represents the on_voice_state_update() event.

stage_instance_create = <Event.stage_instance_create: 'stage_instance_create'>

Called when a StageInstance is created for a StageChannel. Represents the on_stage_instance_create() event.

stage_instance_update = <Event.stage_instance_update: 'stage_instance_update'>

Called when a StageInstance is updated. Represents the on_stage_instance_update() event.

stage_instance_delete = <Event.stage_instance_delete: 'stage_instance_delete'>

Called when a StageInstance is deleted for a StageChannel. Represents the on_stage_instance_delete() event.

application_command = <Event.application_command: 'application_command'>

Called when an application command is invoked. Represents the on_application_command() event.

application_command_autocomplete = <Event.application_command_autocomplete: 'application_command_autocomplete'>

Called when an application command autocomplete is called. Represents the on_application_command_autocomplete() event.

button_click = <Event.button_click: 'button_click'>

Called when a button is clicked. Represents the on_button_click() event.

dropdown = <Event.dropdown: 'dropdown'>

Called when a select menu is clicked. Represents the on_dropdown() event.

interaction = <Event.interaction: 'interaction'>

Called when an interaction happened. Represents the on_interaction() event.

message_interaction = <Event.message_interaction: 'message_interaction'>

Called when a message interaction happened. Represents the on_message_interaction() event.

modal_submit = <Event.modal_submit: 'modal_submit'>

Called when a modal is submitted. Represents the on_modal_submit() event.

message = <Event.message: 'message'>

Called when a Message is created and sent. Represents the on_message() event.

message_edit = <Event.message_edit: 'message_edit'>

Called when a Message receives an update event. Represents the on_message_edit() event.

message_delete = <Event.message_delete: 'message_delete'>

Called when a message is deleted. Represents the on_message_delete() event.

bulk_message_delete = <Event.bulk_message_delete: 'bulk_message_delete'>

Called when messages are bulk deleted. Represents the on_bulk_message_delete() event.

raw_message_delete = <Event.raw_message_delete: 'raw_message_delete'>

Called when a message is deleted regardless of the message being in the internal message cache or not. Represents the on_raw_message_delete() event.

raw_message_edit = <Event.raw_message_edit: 'raw_message_edit'>

Called when a message is edited regardless of the state of the internal message cache. Represents the on_raw_message_edit() event.

raw_bulk_message_delete = <Event.raw_bulk_message_delete: 'raw_bulk_message_delete'>

Called when a bulk delete is triggered regardless of the messages being in the internal message cache or not. Represents the on_raw_bulk_message_delete() event.

reaction_add = <Event.reaction_add: 'reaction_add'>

Called when a message has a reaction added to it. Represents the on_reaction_add() event.

reaction_remove = <Event.reaction_remove: 'reaction_remove'>

Called when a message has a reaction removed from it. Represents the on_reaction_remove() event.

reaction_clear = <Event.reaction_clear: 'reaction_clear'>

Called when a message has all its reactions removed from it. Represents the on_reaction_clear() event.

reaction_clear_emoji = <Event.reaction_clear_emoji: 'reaction_clear_emoji'>

Called when a message has a specific reaction removed from it. Represents the on_reaction_clear_emoji() event.

raw_reaction_add = <Event.raw_reaction_add: 'raw_reaction_add'>

Called when a message has a reaction added regardless of the state of the internal message cache. Represents the on_raw_reaction_add() event.

raw_reaction_remove = <Event.raw_reaction_remove: 'raw_reaction_remove'>

Called when a message has a reaction removed regardless of the state of the internal message cache. Represents the on_raw_reaction_remove() event.

raw_reaction_clear = <Event.raw_reaction_clear: 'raw_reaction_clear'>

Called when a message has all its reactions removed regardless of the state of the internal message cache. Represents the on_raw_reaction_clear() event.

raw_reaction_clear_emoji = <Event.raw_reaction_clear_emoji: 'raw_reaction_clear_emoji'>

Called when a message has a specific reaction removed from it regardless of the state of the internal message cache. Represents the on_raw_reaction_clear_emoji() event.

typing = <Event.typing: 'typing'>

Called when someone begins typing a message. Represents the on_typing() event.

raw_typing = <Event.raw_typing: 'raw_typing'>

Called when someone begins typing a message regardless of whether Intents.members and Intents.guilds are enabled. Represents the on_raw_typing() event.

command = <Event.command: 'command'>

Called when a command is found and is about to be invoked. Represents the on_command() event.

command_completion = <Event.command_completion: 'command_completion'>

Called when a command has completed its invocation. Represents the on_command_completion() event.

command_error = <Event.command_error: 'command_error'>

Called when an error is raised inside a command either through user input error, check failure, or an error in your own code. Represents the on_command_error() event.

slash_command = <Event.slash_command: 'slash_command'>

Called when a slash command is found and is about to be invoked. Represents the on_slash_command() event.

slash_command_completion = <Event.slash_command_completion: 'slash_command_completion'>

Called when a slash command has completed its invocation. Represents the on_slash_command_completion() event.

slash_command_error = <Event.slash_command_error: 'slash_command_error'>

Called when an error is raised inside a slash command either through user input error, check failure, or an error in your own code. Represents the on_slash_command_error() event.

user_command = <Event.user_command: 'user_command'>

Called when a user command is found and is about to be invoked. Represents the on_user_command() event.

user_command_completion = <Event.user_command_completion: 'user_command_completion'>

Called when a user command has completed its invocation. Represents the on_user_command_completion() event.

user_command_error = <Event.user_command_error: 'user_command_error'>

Called when an error is raised inside a user command either through check failure, or an error in your own code. Represents the on_user_command_error() event.

message_command = <Event.message_command: 'message_command'>

Called when a message command is found and is about to be invoked. Represents the on_message_command() event.

message_command_completion = <Event.message_command_completion: 'message_command_completion'>

Called when a message command has completed its invocation. Represents the on_message_command_completion() event.

message_command_error = <Event.message_command_error: 'message_command_error'>

Called when an error is raised inside a message command either through check failure, or an error in your own code. Represents the on_message_command_error() event.

Async Iterator

Some API functions return an “async iterator”. An async iterator is something that is capable of being used in an async for statement.

These async iterators can be used as follows:

async for elem in channel.history():
    # do stuff with elem here

Certain utilities make working with async iterators easier, detailed below.

class disnake.AsyncIterator

Represents the “AsyncIterator” concept. Note that no such class exists, it is purely abstract.

async for x in y

Iterates over the contents of the async iterator.

await next()

This function is a coroutine.

Advances the iterator by one, if possible. If no more items are found then this raises NoMoreItems.

await get(**attrs)

This function is a coroutine.

Similar to utils.get() except run over the async iterator.

Getting the last message by a user named ‘Dave’ or None:

msg = await channel.history().get(author__name='Dave')

await find(predicate)

This function is a coroutine.

Similar to utils.find() except run over the async iterator.

Unlike utils.find(), the predicate provided can be a coroutine.

Getting the last audit log with a reason or None:

def predicate(event):
    return event.reason is not None

event = await guild.audit_logs().find(predicate)

Parameters:

predicate – The predicate to use. Could be a coroutine.

Returns:

The first element that returns True for the predicate or None.

await flatten()

This function is a coroutine.

Flattens the async iterator into a list with all the elements.

Returns:

A list of every element in the async iterator.

Return type:

list

chunk(max_size)

Collects items into chunks of up to a given maximum size. Another AsyncIterator is returned which collects items into lists of a given size. The maximum chunk size must be a positive integer.

New in version 1.6.

Collecting groups of users:

async for leader, *users in reaction.users().chunk(3):
    ...

Warning

The last chunk collected may not be as large as max_size.

Parameters:

max_size – The size of individual chunks.

Return type:

AsyncIterator

map(func)

This is similar to the built-in map function. Another AsyncIterator is returned that executes the function on every element it is iterating over. This function can either be a regular function or a coroutine.

Creating a content iterator:

def transform(message):
    return message.content

async for content in channel.history().map(transform):
    message_length = len(content)

Parameters:

func – The function to call on every element. Could be a coroutine.

Return type:

AsyncIterator

filter(predicate)

This is similar to the built-in filter function. Another AsyncIterator is returned that filters over the original async iterator. This predicate can be a regular function or a coroutine.

Getting messages by non-bot accounts:

def predicate(message):
    return not message.author.bot

async for elem in channel.history().filter(predicate):
    ...

Parameters:

predicate – The predicate to call on every element. Could be a coroutine.

Return type:

AsyncIterator

Audit Log Data

Working with audit logs is a complicated process with a lot of machinery involved. The library attempts to make it easy to use and friendly. In order to accomplish this goal, it must make use of a couple of data classes that aid in this goal.

AuditLogEntry

Attributes

• action
• after
• before
• category
• changes
• created_at
• extra
• id
• reason
• target
• user

class disnake.AuditLogEntry(*, data, guild, application_commands, automod_rules, guild_scheduled_events, integrations, threads, users, webhooks)

Represents an Audit Log entry.

You retrieve these via Guild.audit_logs().

x == y

Checks if two entries are equal.

x != y

Checks if two entries are not equal.

hash(x)

Returns the entry’s hash.

Changed in version 1.7: Audit log entries are now comparable and hashable.

Changed in version 2.8: user can return Object if the user is not found.

action

The action that was done.

Type:

AuditLogAction

user

The user who initiated this action. Usually Member, unless gone then it’s a User.

Type:

Optional[Union[Member, User, Object]]

id

The entry ID.

Type:

int

target

The target that got changed. The exact type of this depends on the action being done.

Type:

Any

extra

Extra information that this entry has that might be useful. For most actions, this is None. However in some cases it contains extra information. See AuditLogAction for which actions have this field filled out.

Type:

Any

reason

The reason this action was done.

Type:

Optional[str]

created_at

Returns the entry’s creation time in UTC.

Type:

datetime.datetime

category

The category of the action, if applicable.

Type:

Optional[AuditLogActionCategory]

changes

The list of changes this entry has.

Type:

AuditLogChanges

before

The target’s prior state.

Type:

AuditLogDiff

after

The target’s subsequent state.

Type:

AuditLogDiff

AuditLogChanges

Attributes

• after
• before

class disnake.AuditLogChanges

An audit log change set.

before

The old value. The attribute has the type of AuditLogDiff.

Depending on the AuditLogActionCategory retrieved by category, the data retrieved by this attribute differs:

Category	Description
create	All attributes are set to None.
delete	All attributes are set the value before deletion.
update	All attributes are set the value before updating.
None	No attributes are set.

after

The new value. The attribute has the type of AuditLogDiff.

Depending on the AuditLogActionCategory retrieved by category, the data retrieved by this attribute differs:

Category	Description
create	All attributes are set to the created value
delete	All attributes are set to None
update	All attributes are set the value after updating.
None	No attributes are set.

AuditLogDiff

Attributes

• actions
• afk_channel
• afk_timeout
• allow
• application_id
• applied_tags
• archived
• auto_archive_duration
• available
• available_tags
• avatar
• banner
• bitrate
• channel
• code
• color
• colour
• command_permissions
• deaf
• default_auto_archive_duration
• default_message_notifications
• default_notifications
• default_reaction
• default_sort_order
• default_thread_slowmode_delay
• deny
• description
• discovery_splash
• emoji
• enabled
• entity_type
• event_type
• exempt_channels
• exempt_roles
• explicit_content_filter
• flags
• format_type
• hoist
• icon
• id
• image
• invitable
• inviter
• location
• locked
• max_age
• max_uses
• mentionable
• mfa_level
• mute
• name
• nick
• nsfw
• overwrites
• owner
• permissions
• position
• preferred_locale
• premium_progress_bar_enabled
• privacy_level
• public_updates_channel
• region
• roles
• rtc_region
• rules_channel
• slowmode_delay
• splash
• status
• system_channel
• system_channel_flags
• temporary
• timeout
• topic
• trigger_metadata
• trigger_type
• type
• user_limit
• uses
• vanity_url_code
• verification_level
• video_quality_mode
• widget_channel
• widget_enabled

class disnake.AuditLogDiff

Represents an audit log “change” object. A change object has dynamic attributes that depend on the type of action being done. Certain actions map to certain attributes being set.

Note that accessing an attribute that does not match the specified action will lead to an attribute error.

To get a list of attributes that have been set, you can iterate over them. To see a list of all possible attributes that could be set based on the action being done, check the documentation for AuditLogAction, otherwise check the documentation below for all attributes that are possible.

iter(diff)

Returns an iterator over (attribute, value) tuple of this diff.

name

A name of something.

Type:

str

icon

A guild’s or role’s icon.

See also Guild.icon or Role.icon.

Type:

Asset

splash

The guild’s invite splash. See also Guild.splash.

Type:

Asset

discovery_splash

The guild’s discovery splash. See also Guild.discovery_splash.

Type:

Asset

banner

The guild’s banner. See also Guild.banner.

Type:

Asset

owner

The guild’s owner. See also Guild.owner

Type:

Union[Member, User, Object]

region

The guild’s voice region. See also Guild.region.

Type:

str

afk_channel

The guild’s AFK channel.

If this could not be found, then it falls back to a Object with the ID being set.

See Guild.afk_channel.

Type:

Union[VoiceChannel, Object]

system_channel

The guild’s system channel.

If this could not be found, then it falls back to a Object with the ID being set.

See Guild.system_channel.

Type:

Union[TextChannel, Object]

rules_channel

The guild’s rules channel.

If this could not be found then it falls back to a Object with the ID being set.

See Guild.rules_channel.

Type:

Union[TextChannel, Object]

public_updates_channel

The guild’s public updates channel.

If this could not be found then it falls back to a Object with the ID being set.

See Guild.public_updates_channel.

Type:

Union[TextChannel, Object]

afk_timeout

The guild’s AFK timeout. See Guild.afk_timeout.

Type:

int

mfa_level

The guild’s MFA level. See Guild.mfa_level.

Type:

int

widget_enabled

The guild’s widget has been enabled or disabled.

Type:

bool

widget_channel

The widget’s channel.

If this could not be found then it falls back to a Object with the ID being set.

Type:

Union[abc.GuildChannel, Object]

verification_level

The guild’s verification level.

See also Guild.verification_level.

Type:

VerificationLevel

premium_progress_bar_enabled

Whether the guild’s premium progress bar is enabled.

See also Guild.premium_progress_bar_enabled.

Type:

bool

default_notifications

The guild’s default notification level.

See also Guild.default_notifications.

Type:

NotificationLevel

explicit_content_filter

The guild’s content filter.

See also Guild.explicit_content_filter.

Type:

ContentFilter

default_message_notifications

The guild’s default message notification setting.

Type:

int

vanity_url_code

The guild’s vanity URL code.

See also Guild.vanity_invite(), Guild.edit(), and Guild.vanity_url_code.

Type:

str

preferred_locale

The guild’s preferred locale.

Type:

Locale

position

The position of a Role or abc.GuildChannel.

Type:

int

type

The type of channel/thread, sticker, webhook, integration (str), or permission overwrite (int).

Type:

Union[ChannelType, StickerType, WebhookType, str, int]

topic

The topic of a TextChannel, StageChannel, StageInstance or ForumChannel.

See also TextChannel.topic, StageChannel.topic, StageInstance.topic or ForumChannel.topic.

Type:

str

bitrate

The bitrate of a VoiceChannel or StageChannel.

See also VoiceChannel.bitrate or StageChannel.bitrate.

Type:

int

overwrites

A list of permission overwrite tuples that represents a target and a PermissionOverwrite for said target.

The first element is the object being targeted, which can either be a Member or User or Role. If this object is not found then it is a Object with an ID being filled and a type attribute set to either 'role' or 'member' to help decide what type of ID it is.

Type:

List[Tuple[Union[Member, User, Role, Object], PermissionOverwrite]]

privacy_level

The privacy level of the stage instance or guild scheduled event.

Type:

Union[StagePrivacyLevel, GuildScheduledEventPrivacyLevel]

roles

A list of roles being added or removed from a member.

If a role is not found then it is a Object with the ID and name being filled in.

Type:

List[Union[Role, Object]]

nick

The nickname of a member.

See also Member.nick

Type:

Optional[str]

deaf

Whether the member is being server deafened.

See also VoiceState.deaf.

Type:

bool

mute

Whether the member is being server muted.

See also VoiceState.mute.

Type:

bool

permissions

The permissions of a role.

See also Role.permissions.

Type:

Permissions

colour

color

The colour of a role.

See also Role.colour

Type:

Colour

hoist

Whether the role is being hoisted or not.

See also Role.hoist

Type:

bool

mentionable

Whether the role is mentionable or not.

See also Role.mentionable

Type:

bool

code

The invite’s code.

See also Invite.code

Type:

str

channel

A guild channel.

If the channel is not found then it is a Object with the ID being set. In some cases the channel name is also set.

Type:

Union[abc.GuildChannel, Object]

inviter

The user who created the invite.

See also Invite.inviter.

Type:

Optional[User, Object]

max_uses

The invite’s max uses.

See also Invite.max_uses.

Type:

int

uses

The invite’s current uses.

See also Invite.uses.

Type:

int

max_age

The invite’s max age in seconds.

See also Invite.max_age.

Type:

int

temporary

If the invite is a temporary invite.

See also Invite.temporary.

Type:

bool

allow

deny

The permissions being allowed or denied.

Type:

Permissions

id

The ID of the object being changed.

Type:

int

avatar

The avatar of a member.

See also User.avatar.

Type:

Asset

slowmode_delay

The number of seconds members have to wait before sending another message or creating another thread in the channel.

See also TextChannel.slowmode_delay, VoiceChannel.slowmode_delay, ForumChannel.slowmode_delay or Thread.slowmode_delay.

Type:

int

default_thread_slowmode_delay

The default number of seconds members have to wait before sending another message in new threads created in the channel.

See also TextChannel.default_thread_slowmode_delay or ForumChannel.default_thread_slowmode_delay.

Type:

int

rtc_region

The region for the voice or stage channel’s voice communication. A value of None indicates automatic voice region detection.

See also VoiceChannel.rtc_region or StageChannel.rtc_region.

Type:

str

video_quality_mode

The camera video quality for the voice or stage channel’s participants.

See also VoiceChannel.video_quality_mode or StageChannel.video_quality_mode.

Type:

VideoQualityMode

user_limit

The voice channel’s user limit.

See also VoiceChannel.user_limit.

Type:

int

nsfw

Whether the channel is marked as “not safe for work”.

See also TextChannel.nsfw, VoiceChannel.nsfw or ForumChannel.nsfw.

Type:

bool

format_type

The format type of a sticker being changed.

See also GuildSticker.format

Type:

StickerFormatType

emoji

The name of the sticker’s or role’s emoji being changed.

See also GuildSticker.emoji or Role.emoji.

Type:

str

description

The description of a guild, sticker or a guild scheduled event being changed.

See also Guild.description, GuildSticker.description, GuildScheduledEvent.description

Type:

str

available

The availability of a sticker being changed.

See also GuildSticker.available

Type:

bool

archived

The thread is now archived.

Type:

bool

locked

The thread is being locked or unlocked.

Type:

bool

auto_archive_duration

The thread’s auto archive duration being changed.

See also Thread.auto_archive_duration

Type:

int

default_auto_archive_duration

The default auto archive duration for newly created threads being changed.

Type:

int

invitable

Whether non-moderators can add other non-moderators to the thread.

Type:

bool

timeout

The datetime when the timeout expires, if any.

Type:

datetime.datetime

entity_type

The entity type of a guild scheduled event being changed.

Type:

GuildScheduledEventEntityType

location

The location of a guild scheduled event being changed.

Type:

str

status

The status of a guild scheduled event being changed.

Type:

GuildScheduledEventStatus

image

The cover image of a guild scheduled event being changed.

Type:

Asset

command_permissions

A mapping of target ID to guild permissions of an application command.

Note that only changed permission entries are included, not necessarily all of the command’s permissions.

Type:

Dict[int, ApplicationCommandPermissions]

application_id

The ID of the application that created a webhook.

Type:

int

flags

The channel’s flags.

See also abc.GuildChannel.flags or Thread.flags.

Type:

ChannelFlags

system_channel_flags

The guild’s system channel settings.

See also Guild.system_channel_flags.

Type:

SystemChannelFlags

enabled

Whether something was enabled or disabled.

Type:

bool

trigger_type

The trigger type of an auto moderation rule being changed.

Type:

AutoModTriggerType

event_type

The event type of an auto moderation rule being changed.

Type:

AutoModEventType

actions

The list of actions of an auto moderation rule being changed.

Type:

List[AutoModAction]

trigger_metadata

The additional trigger metadata of an auto moderation rule being changed.

Type:

AutoModTriggerMetadata

exempt_roles

The list of roles that are exempt from an auto moderation rule being changed.

If a role is not found then it is an Object with the ID being set.

Type:

List[Union[Role, Object]]

exempt_channels

The list of channels that are exempt from an auto moderation rule being changed.

If a channel is not found then it is an Object with the ID being set.

Type:

List[Union[abc.GuildChannel, Object]]

applied_tags

The tags applied to a thread in a forum channel being changed.

If a tag is not found, then it is an Object with the ID being set.

Type:

List[Union[ForumTag, Object]]

available_tags

The available tags for threads in a forum channel being changed.

Type:

List[ForumTag]

default_reaction

The default emoji shown for reacting to threads in a forum channel being changed.

Due to a Discord limitation, this will have an empty name if it is a custom PartialEmoji.

Type:

Optional[Union[Emoji, PartialEmoji]]

default_sort_order

The default sort order of threads in a forum channel being changed.

Type:

Optional[ThreadSortOrder]

Webhook Support

disnake offers support for creating, editing, and executing webhooks through the Webhook class.

Webhook

Attributes

• application_id
• avatar
• channel
• channel_id
• created_at
• guild
• guild_id
• id
• name
• source_channel
• source_guild
• token
• type
• url
• user

Methods

• clsWebhook.from_url
• clsWebhook.partial
• asyncdelete
• asyncdelete_message
• asyncedit
• asyncedit_message
• asyncfetch
• asyncfetch_message
• defis_authenticated
• defis_partial
• asyncsend

class disnake.Webhook

Represents an asynchronous Discord webhook.

Webhooks are a form to send messages to channels in Discord without a bot user or authentication.

There are two main ways to use Webhooks. The first is through the ones received by the library such as Guild.webhooks(), TextChannel.webhooks(), and VoiceChannel.webhooks(). The ones received by the library will automatically be bound using the library’s internal HTTP session.

The second form involves creating a webhook object manually using the from_url() or partial() classmethods.

For example, creating a webhook from a URL and using aiohttp:

from disnake import Webhook
import aiohttp

async def foo():
    async with aiohttp.ClientSession() as session:
        webhook = Webhook.from_url('url-here', session=session)
        await webhook.send('Hello World', username='Foo')

For a synchronous counterpart, see SyncWebhook.

x == y

Checks if two webhooks are equal.

x != y

Checks if two webhooks are not equal.

hash(x)

Returns the webhooks’s hash.

Changed in version 1.4: Webhooks are now comparable and hashable.

id

The webhook’s ID

Type:

int

type

The webhook’s type.

New in version 1.3.

Type:

WebhookType

token

The authentication token of the webhook. If this is None then the webhook cannot be used to make requests.

Type:

Optional[str]

guild_id

The guild ID this webhook belongs to.

Type:

Optional[int]

channel_id

The channel ID this webhook belongs to.

Type:

Optional[int]

user

The user this webhook was created by. If the webhook was received without authentication then this will be None.

Type:

Optional[abc.User]

name

The default name of the webhook.

Type:

Optional[str]

source_guild

The guild of the channel that this webhook is following. Only given if type is WebhookType.channel_follower.

New in version 2.0.

Type:

Optional[PartialWebhookGuild]

source_channel

The channel that this webhook is following. Only given if type is WebhookType.channel_follower.

New in version 2.0.

Type:

Optional[PartialWebhookChannel]

application_id

The ID of the application associated with this webhook, if it was created by an application.

New in version 2.6.

Type:

Optional[int]

property url

Returns the webhook’s url.

Type:

str

classmethod partial(id, token, *, session, bot_token=None)

Creates a partial Webhook.

Parameters:

• id (int) – The webhook’s ID.

• token (str) – The webhook’s authentication token.

• session (aiohttp.ClientSession) –

  The session to use to send requests with. Note that the library does not manage the session and will not close it.

  New in version 2.0.

• bot_token (Optional[str]) –

  The bot authentication token for authenticated requests involving the webhook.

  New in version 2.0.

Returns:

A partial Webhook. A partial webhook is just a webhook object with an ID and a token.

Return type:

Webhook

classmethod from_url(url, *, session, bot_token=None)

Creates a partial Webhook from a webhook URL.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

• url (str) – The webhook’s URL.

• session (aiohttp.ClientSession) –

  The session to use to send requests with. Note that the library does not manage the session and will not close it.

  New in version 2.0.

• bot_token (Optional[str]) –

  The bot authentication token for authenticated requests involving the webhook.

  New in version 2.0.

Raises:

ValueError – The URL is invalid.

Returns:

A partial Webhook. A partial webhook is just a webhook object with an ID and a token.

Return type:

Webhook

await fetch(*, prefer_auth=True)

This function is a coroutine.

Fetches the current webhook.

This could be used to get a full webhook from a partial webhook.

New in version 2.0.

Note

When fetching with an unauthenticated webhook, i.e. is_authenticated() returns False, then the returned webhook does not contain any user information.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

prefer_auth (bool) – Whether to use the bot token over the webhook token, if available. Defaults to True.

Raises:

• HTTPException – Could not fetch the webhook

• NotFound – Could not find the webhook by this ID

• WebhookTokenMissing – This webhook does not have a token associated with it.

Returns:

The fetched webhook.

Return type:

Webhook

await delete(*, reason=None, prefer_auth=True)

This function is a coroutine.

Deletes this Webhook.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• reason (Optional[str]) –

  The reason for deleting this webhook. Shows up on the audit log.

  New in version 1.4.

• prefer_auth (bool) –

  Whether to use the bot token over the webhook token, if available. Defaults to True.

  New in version 2.0.

Raises:

• HTTPException – Deleting the webhook failed.

• NotFound – This webhook does not exist.

• Forbidden – You do not have permissions to delete this webhook.

• WebhookTokenMissing – This webhook does not have a token associated with it.

await edit(*, reason=None, name=..., avatar=..., channel=None, prefer_auth=True)

This function is a coroutine.

Edits this Webhook.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• name (Optional[str]) – The webhook’s new default name.

• avatar (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The webhook’s new default avatar.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• channel (Optional[abc.Snowflake]) –

  The webhook’s new channel. This requires an authenticated webhook.

  New in version 2.0.

• prefer_auth (bool) –

  Whether to use the bot token over the webhook token if available. Defaults to True.

  New in version 2.0.

• reason (Optional[str]) –

  The reason for editing this webhook. Shows up on the audit log.

  New in version 1.4.

Raises:

• HTTPException – Editing the webhook failed.

• NotFound – This webhook does not exist or the avatar asset couldn’t be found.

• TypeError – The avatar asset is a lottie sticker (see Sticker.read()).

• WebhookTokenMissing – This webhook does not have a token associated with it or it tried editing a channel without authentication.

Returns:

The newly edited webhook.

Return type:

Webhook

property avatar

Returns an Asset for the avatar the webhook has.

If the webhook does not have a traditional avatar, an asset for the default avatar is returned instead.

Type:

Asset

property channel

The channel this webhook belongs to.

If this is a partial webhook, then this will always return None.

Webhooks in ForumChannels can not send messages directly, they can only create new threads (see thread_name for Webhook.send) and interact with existing threads.

Type:

Optional[Union[TextChannel, VoiceChannel, ForumChannel]]

property created_at

Returns the webhook’s creation time in UTC.

Type:

datetime.datetime

property guild

The guild this webhook belongs to.

If this is a partial webhook, then this will always return None.

Type:

Optional[Guild]

is_authenticated()

Whether the webhook is authenticated with a bot token.

New in version 2.0.

Return type:

bool

is_partial()

Whether the webhook is a “partial” webhook.

New in version 2.0.

Return type:

bool

await send(content=..., *, username=..., avatar_url=..., tts=False, ephemeral=False, suppress_embeds=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., view=..., components=..., thread=..., thread_name=None, wait=False, delete_after=...)

This function is a coroutine.

Sends a message using the webhook.

The content must be a type that can convert to a string through str(content).

To upload a single file, the file parameter should be used with a single File object.

If the embed parameter is provided, it must be of type Embed and it must be a rich embed type. You cannot mix the embed parameter with the embeds parameter, which must be a list of Embed objects to send.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• username (str) – The username to send with this message. If no username is provided then the default username for the webhook is used.

• avatar_url (str) – The avatar URL to send with this message. If no avatar URL is provided then the default avatar for the webhook is used. If this is not a string then it is explicitly cast using str.

• tts (bool) – Whether the message should be sent using text-to-speech.

• ephemeral (bool) –

  Whether the message should only be visible to the user. This is only available to WebhookType.application webhooks. If a view is sent with an ephemeral message and it has no timeout set then the timeout is set to 15 minutes.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) – A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions, if applicable. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• view (disnake.ui.View) –

  The view to send with the message. You can only send a view if this webhook is not partial and has state attached. A webhook has state attached if the webhook is managed by the library. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• thread (Snowflake) –

  The thread to send this webhook to.

  New in version 2.0.

• thread_name (str) –

  If in a forum channel, and thread is not specified, the name of the newly created thread.

  Note

  If this is set, the returned message’s channel (assuming wait=True), representing the created thread, may be a PartialMessageable.

  New in version 2.6.

• wait (bool) – Whether the server should wait before sending a response. This essentially means that the return type of this function changes from None to a WebhookMessage if set to True. If the type of webhook is WebhookType.application then this is always set to True.

• delete_after (float) –

  If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  New in version 2.1.

  Changed in version 2.7: Added support for ephemeral interaction responses.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• NotFound – This webhook was not found.

• Forbidden – The authorization token for the webhook is incorrect.

• TypeError – Raised by any of the following: You specified both embed and embeds or file and files. ephemeral was passed with the improper webhook type. There was no state attached with this webhook when giving it a view. Both thread and thread_name were provided.

• WebhookTokenMissing – There was no token associated with this webhook.

• ValueError – The length of embeds was invalid.

Returns:

If wait is True then the message that was sent, otherwise None.

Return type:

Optional[WebhookMessage]

await fetch_message(id)

This function is a coroutine.

Retrieves a single WebhookMessage owned by this webhook.

New in version 2.0.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

• WebhookTokenMissing – There was no token associated with this webhook.

Returns:

The message asked for.

Return type:

WebhookMessage

await edit_message(message_id, *, content=..., embed=..., embeds=..., file=..., files=..., attachments=..., view=..., components=..., allowed_mentions=None)

This function is a coroutine.

Edits a message owned by this webhook.

This is a lower level interface to WebhookMessage.edit() in case you only have an ID.

Note

If the original message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

New in version 1.6.

Changed in version 2.0: The edit is no longer in-place, instead the newly edited message is returned.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• message_id (int) – The ID of the message to edit.

• content (Optional[str]) – The content to edit the message with, or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) –

  The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

  New in version 2.0.

• files (List[File]) –

  A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

  New in version 2.0.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• view (Optional[View]) –

  The updated view to update this message with. If None is passed then the view is removed. The webhook must have state attached, similar to send(). This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to update this message with. This cannot be mixed with view.

  New in version 2.4.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files or there is no associated state when sending a view.

• WebhookTokenMissing – There was no token associated with this webhook.

• ValueError – The length of embeds was invalid

Returns:

The newly edited webhook message.

Return type:

WebhookMessage

await delete_message(message_id, /)

This function is a coroutine.

Deletes a message owned by this webhook.

This is a lower level interface to WebhookMessage.delete() in case you only have an ID.

New in version 1.6.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

message_id (int) – The ID of the message to delete.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

• WebhookTokenMissing – There was no token associated with this webhook

WebhookMessage

Methods

• asyncdelete
• asyncedit

class disnake.WebhookMessage

Represents a message sent from your webhook.

This allows you to edit or delete a message sent by your webhook.

This inherits from disnake.Message with changes to edit() and delete() to work.

New in version 1.6.

await edit(content=..., embed=..., embeds=..., file=..., files=..., attachments=..., view=..., components=..., allowed_mentions=None)

This function is a coroutine.

Edits the message.

New in version 1.6.

Changed in version 2.0: The edit is no longer in-place, instead the newly edited message is returned.

Note

If the original message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Parameters:

• content (Optional[str]) – The content to edit the message with, or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) –

  The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

  New in version 2.0.

• files (List[File]) –

  A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

  New in version 2.0.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• view (Optional[View]) –

  The view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

  New in version 2.0.

• components (Optional[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]]) –

  A list of components to update the message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files

• ValueError – The length of embeds was invalid

• WebhookTokenMissing – There was no token associated with this webhook.

Returns:

The newly edited message.

Return type:

WebhookMessage

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message. The waiting is done in the background and deletion failures are ignored.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already.

• HTTPException – Deleting the message failed.

SyncWebhook

Attributes

• application_id
• avatar
• channel
• channel_id
• created_at
• guild
• guild_id
• id
• name
• source_channel
• source_guild
• token
• type
• url
• user

Methods

• clsSyncWebhook.from_url
• clsSyncWebhook.partial
• defdelete
• defdelete_message
• defedit
• defedit_message
• deffetch
• deffetch_message
• defis_authenticated
• defis_partial
• defsend

class disnake.SyncWebhook

Represents a synchronous Discord webhook.

For an asynchronous counterpart, see Webhook.

x == y

Checks if two webhooks are equal.

x != y

Checks if two webhooks are not equal.

hash(x)

Returns the webhooks’s hash.

Changed in version 1.4: Webhooks are now comparable and hashable.

id

The webhook’s ID

Type:

int

type

The webhook’s type.

New in version 1.3.

Type:

WebhookType

token

The authentication token of the webhook. If this is None then the webhook cannot be used to make requests.

Type:

Optional[str]

guild_id

The guild ID this webhook belongs to.

Type:

Optional[int]

channel_id

The channel ID this webhook belongs to.

Type:

Optional[int]

user

The user this webhook was created by. If the webhook was received without authentication then this will be None.

Type:

Optional[abc.User]

name

The default name of the webhook.

Type:

Optional[str]

source_guild

The guild of the channel that this webhook is following. Only given if type is WebhookType.channel_follower.

New in version 2.0.

Type:

Optional[PartialWebhookGuild]

source_channel

The channel that this webhook is following. Only given if type is WebhookType.channel_follower.

New in version 2.0.

Type:

Optional[PartialWebhookChannel]

application_id

The ID of the application associated with this webhook, if it was created by an application.

New in version 2.6.

Type:

Optional[int]

property url

Returns the webhook’s url.

Type:

str

classmethod partial(id, token, *, session=..., bot_token=None)

Creates a partial Webhook.

Parameters:

• id (int) – The webhook’s ID.

• token (str) – The webhook’s authentication token.

• session (requests.Session) – The session to use to send requests with. Note that the library does not manage the session and will not close it. If not given, the requests auto session creation functions are used instead.

• bot_token (Optional[str]) – The bot authentication token for authenticated requests involving the webhook.

Returns:

A partial Webhook. A partial webhook is just a webhook object with an ID and a token.

Return type:

Webhook

classmethod from_url(url, *, session=..., bot_token=None)

Creates a partial Webhook from a webhook URL.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

• url (str) – The webhook’s URL.

• session (requests.Session) – The session to use to send requests with. Note that the library does not manage the session and will not close it. If not given, the requests auto session creation functions are used instead.

• bot_token (Optional[str]) – The bot authentication token for authenticated requests involving the webhook.

Raises:

ValueError – The URL is invalid.

Returns:

A partial Webhook. A partial webhook is just a webhook object with an ID and a token.

Return type:

Webhook

fetch(*, prefer_auth=True)

Fetches the current webhook.

This could be used to get a full webhook from a partial webhook.

Note

When fetching with an unauthenticated webhook, i.e. is_authenticated() returns False, then the returned webhook does not contain any user information.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

prefer_auth (bool) – Whether to use the bot token over the webhook token, if available. Defaults to True.

Raises:

• HTTPException – Could not fetch the webhook

• NotFound – Could not find the webhook by this ID

• WebhookTokenMissing – This webhook does not have a token associated with it.

Returns:

The fetched webhook.

Return type:

SyncWebhook

delete(*, reason=None, prefer_auth=True)

Deletes this Webhook.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• reason (Optional[str]) –

  The reason for deleting this webhook. Shows up on the audit log.

  New in version 1.4.

• prefer_auth (bool) – Whether to use the bot token over the webhook token, if available. Defaults to True.

Raises:

• HTTPException – Deleting the webhook failed.

• NotFound – This webhook does not exist.

• Forbidden – You do not have permissions to delete this webhook.

• WebhookTokenMissing – This webhook does not have a token associated with it.

edit(*, reason=None, name=..., avatar=..., channel=None, prefer_auth=True)

Edits this Webhook.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• name (Optional[str]) – The webhook’s new default name.

• avatar (Optional[bytes]) – A bytes-like object representing the webhook’s new default avatar.

• channel (Optional[abc.Snowflake]) – The webhook’s new channel. This requires an authenticated webhook.

• prefer_auth (bool) – Whether to use the bot token over the webhook token if available. Defaults to True.

• reason (Optional[str]) –

  The reason for editing this webhook. Shows up on the audit log.

  New in version 1.4.

Raises:

• HTTPException – Editing the webhook failed.

• NotFound – This webhook does not exist.

• WebhookTokenMissing – This webhook does not have a token associated with it or it tried editing a channel without authentication.

Returns:

The newly edited webhook.

Return type:

SyncWebhook

send(content=..., *, username=..., avatar_url=..., tts=False, file=..., files=..., embed=..., embeds=..., suppress_embeds=..., allowed_mentions=..., thread=..., thread_name=None, wait=False)

Sends a message using the webhook.

The content must be a type that can convert to a string through str(content).

To upload a single file, the file parameter should be used with a single File object.

If the embed parameter is provided, it must be of type Embed and it must be a rich embed type. You cannot mix the embed parameter with the embeds parameter, which must be a list of Embed objects to send.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• username (str) – The username to send with this message. If no username is provided then the default username for the webhook is used.

• avatar_url (str) – The avatar URL to send with this message. If no avatar URL is provided then the default avatar for the webhook is used. If this is not a string then it is explicitly cast using str.

• tts (bool) – Whether the message should be sent using text-to-speech.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) – A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message.

  New in version 1.4.

• thread (Snowflake) –

  The thread to send this message to.

  New in version 2.0.

• thread_name (str) –

  If in a forum channel, and thread is not specified, the name of the newly created thread.

  New in version 2.6.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

• wait (bool) – Whether the server should wait before sending a response. This essentially means that the return type of this function changes from None to a WebhookMessage if set to True.

Raises:

• HTTPException – Sending the message failed.

• NotFound – This webhook was not found.

• Forbidden – The authorization token for the webhook is incorrect.

• TypeError – You specified both embed and embeds or file and files, or both thread and thread_name were provided.

• ValueError – The length of embeds was invalid

• WebhookTokenMissing – There was no token associated with this webhook.

Returns:

If wait is True then the message that was sent, otherwise None.

Return type:

Optional[SyncWebhookMessage]

fetch_message(id, /)

Retrieves a single SyncWebhookMessage owned by this webhook.

New in version 2.0.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

• WebhookTokenMissing – There was no token associated with this webhook.

Returns:

The message asked for.

Return type:

SyncWebhookMessage

property avatar

Returns an Asset for the avatar the webhook has.

If the webhook does not have a traditional avatar, an asset for the default avatar is returned instead.

Type:

Asset

property channel

The channel this webhook belongs to.

If this is a partial webhook, then this will always return None.

Webhooks in ForumChannels can not send messages directly, they can only create new threads (see thread_name for Webhook.send) and interact with existing threads.

Type:

Optional[Union[TextChannel, VoiceChannel, ForumChannel]]

property created_at

Returns the webhook’s creation time in UTC.

Type:

datetime.datetime

edit_message(message_id, *, content=..., embed=..., embeds=..., file=..., files=..., attachments=..., allowed_mentions=None)

Edits a message owned by this webhook.

This is a lower level interface to WebhookMessage.edit() in case you only have an ID.

Note

If the original message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

New in version 1.6.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• message_id (int) – The ID of the message to edit.

• content (Optional[str]) – The content to edit the message with, or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) – The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• files (List[File]) – A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files

• ValueError – The length of embeds was invalid

• WebhookTokenMissing – There was no token associated with this webhook.

property guild

The guild this webhook belongs to.

If this is a partial webhook, then this will always return None.

Type:

Optional[Guild]

is_authenticated()

Whether the webhook is authenticated with a bot token.

New in version 2.0.

Return type:

bool

is_partial()

Whether the webhook is a “partial” webhook.

New in version 2.0.

Return type:

bool

delete_message(message_id, /)

Deletes a message owned by this webhook.

This is a lower level interface to WebhookMessage.delete() in case you only have an ID.

New in version 1.6.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

message_id (int) – The ID of the message to delete.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

• WebhookTokenMissing – There is no token associated with this webhook.

SyncWebhookMessage

Methods

• defdelete
• defedit

class disnake.SyncWebhookMessage

Represents a message sent from your webhook.

This allows you to edit or delete a message sent by your webhook.

This inherits from disnake.Message with changes to edit() and delete() to work.

New in version 2.0.

edit(content=..., embed=..., embeds=..., file=..., files=..., attachments=..., allowed_mentions=None)

Edits the message.

Note

If the original message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content to edit the message with or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) – The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• files (List[File]) – A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files

• ValueError – The length of embeds was invalid

• WebhookTokenMissing – There is no token associated with this webhook.

Returns:

The newly edited message.

Return type:

SyncWebhookMessage

delete(*, delay=None)

Deletes the message.

Changed in version 2.6: Raises WebhookTokenMissing instead of InvalidArgument.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message. This blocks the thread.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already.

• HTTPException – Deleting the message failed.

• WebhookTokenMissing – There is no token associated with this webhook.

Abstract Base Classes

An abstract base class (also known as an abc) is a class that models can inherit to get their behaviour. Abstract base classes should not be instantiated. They are mainly there for usage with isinstance() and issubclass().

This library has a module related to abstract base classes, in which all the ABCs are subclasses of typing.Protocol.

Snowflake

Attributes

• id

class disnake.abc.Snowflake

An ABC that details the common operations on a Discord model.

Almost all Discord models meet this abstract base class.

If you want to create a snowflake on your own, consider using Object.

id

The model’s unique ID.

Type:

int

User

Attributes

• avatar
• bot
• discriminator
• display_name
• mention
• name

class disnake.abc.User

An ABC that details the common operations on a Discord user.

The following classes implement this ABC:

• User

• ClientUser

• Member

This ABC must also implement Snowflake.

name

The user’s username.

Type:

str

discriminator

The user’s discriminator.

Type:

str

avatar

The avatar asset the user has.

Type:

Asset

bot

Whether the user is a bot account.

Type:

bool

property display_name

Returns the user’s display name.

Type:

str

property mention

Returns a string that allows you to mention the given user.

Type:

str

PrivateChannel

Attributes

• me

class disnake.abc.PrivateChannel

An ABC that details the common operations on a private Discord channel.

The following classes implement this ABC:

• DMChannel

• GroupChannel

This ABC must also implement Snowflake.

me

The user representing yourself.

Type:

ClientUser

GuildChannel

Attributes

• category
• changed_roles
• created_at
• flags
• guild
• jump_url
• mention
• name
• overwrites
• permissions_synced
• position

Methods

• asyncclone
• asynccreate_invite
• asyncdelete
• asyncinvites
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncset_permissions

class disnake.abc.GuildChannel

An ABC that details the common operations on a Discord guild channel.

The following classes implement this ABC:

• TextChannel

• VoiceChannel

• CategoryChannel

• StageChannel

• ForumChannel

This ABC must also implement abc.Snowflake.

name

The channel name.

Type:

str

guild

The guild the channel belongs to.

Type:

Guild

position

The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

Type:

int

property changed_roles

Returns a list of roles that have been overridden from their default values in the Guild.roles attribute.

Type:

List[Role]

property mention

The string that allows you to mention the channel.

Type:

str

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, abc.User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

property overwrites

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

New in version 1.3.

Type:

bool

property flags

The channel flags for this channel.

New in version 2.6.

Type:

ChannelFlags

property jump_url

A URL that can be used to jump to this channel.

New in version 2.4.

Note

This exists for all guild channels but may not be usable by the client for all guild channel types.

permissions_for(obj, /, *, ignore_timeout=...)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

• Guild owner

• Guild roles

• Channel overrides

• Member overrides

• Timeouts

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

• obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

• ignore_timeout (bool) –

  Whether or not to ignore the user’s timeout. Defaults to False.

  New in version 2.4.

  Note

  This only applies to Member objects.

  Changed in version 2.6: The default was changed to False.

Raises:

TypeError – ignore_timeout is only supported for Member objects.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have Permissions.manage_channels permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await set_permissions(target, *, overwrite=..., reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

The overwrite parameter, if given, must either be None or PermissionOverwrite. For convenience, you can pass in keyword arguments denoting Permissions attributes. If this is done, then you cannot mix the keyword arguments with the overwrite parameter.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have Permissions.manage_roles permission to do this.

Note

This method replaces the old overwrites with the ones given.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Examples

Setting allow and deny:

await message.channel.set_permissions(message.author, view_channel=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

Using PermissionOverwrite

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.view_channel = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• TypeError – overwrite is invalid, the target type was not Role or Member, both keyword arguments and overwrite were provided, or invalid permissions were provided as keyword arguments.

await clone(*, name=None, reason=None)

This function is a coroutine.

Clones this channel. This creates a channel with the same properties as this channel.

You must have Permissions.manage_channels permission to do this.

New in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have Permissions.manage_channels permission to do this.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

New in version 1.7.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• beginning (bool) – Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

• end (bool) – Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

• before (abc.Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (abc.Snowflake) – The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

• offset (int) – The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

• category (Optional[abc.Snowflake]) – The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

• sync_permissions (bool) – Whether to sync the permissions with the category (if given).

• reason (Optional[str]) – The reason for moving this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to move the channel.

• HTTPException – Moving the channel failed.

• TypeError – A bad mix of arguments were passed.

• ValueError – An invalid position was given.

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application=None, guild_scheduled_event=None)

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have Permissions.create_instant_invite permission to do this.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – Whether the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.

• unique (bool) – Whether a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.

• target_type (Optional[InviteTarget]) –

  The type of target for the voice channel invite, if any.

  New in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

  New in version 2.0.

• target_application (Optional[PartyType]) –

  The ID of the embedded application for the invite, required if target_type is TargetType.embedded_application.

  New in version 2.0.

• guild_scheduled_event (Optional[GuildScheduledEvent]) –

  The guild scheduled event to include with the invite.

  New in version 2.3.

• reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The newly created invite.

Return type:

Invite

await invites()

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have Permissions.manage_channels permission to use this.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

Messageable

Methods

• asyncfetch_message
• defhistory
• asyncpins
• asyncsend
• asynctrigger_typing
• deftyping

class disnake.abc.Messageable

An ABC that details the common operations on a model that can send messages.

The following classes implement this ABC:

• TextChannel

• DMChannel

• GroupChannel

• User

• Member

• Context

• Thread

• VoiceChannel

• PartialMessageable

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

Connectable

class disnake.abc.Connectable

An ABC that details the common operations on a channel that can connect to a voice server.

The following classes implement this ABC:

• VoiceChannel

• StageChannel

Note

This ABC is not decorated with typing.runtime_checkable(), so will fail isinstance()/issubclass() checks.

Discord Models

Models are classes that are received from Discord and are not meant to be created by the user of the library.

Danger

The classes listed below are not intended to be created by users and are also read-only.

For example, this means that you should not make your own User instances nor should you modify the User instance yourself.

If you want to get one of these model classes instances they’d have to be through the cache, and a common way of doing so is through the utils.find() function or attributes of model classes that you receive from the events specified in the Event Reference.

Note

Nearly all classes here have __slots__ defined which means that it is impossible to have dynamic attributes to the data classes.

ClientUser

Attributes

• accent_color
• accent_colour
• avatar
• banner
• bot
• color
• colour
• created_at
• default_avatar
• discriminator
• display_avatar
• display_name
• id
• locale
• mention
• mfa_enabled
• name
• public_flags
• system
• verified

Methods

• asyncedit
• defmentioned_in

class disnake.ClientUser

Represents your Discord user.

x == y

Checks if two users are equal.

x != y

Checks if two users are not equal.

hash(x)

Return the user’s hash.

str(x)

Returns the user’s name with discriminator.

name

The user’s username.

Type:

str

id

The user’s unique ID.

Type:

int

discriminator

The user’s discriminator. This is given when the username has conflicts.

Type:

str

bot

Specifies if the user is a bot account.

Type:

bool

system

Specifies if the user is a system user (i.e. represents Discord officially).

New in version 1.3.

Type:

bool

verified

Specifies if the user’s email is verified.

Type:

bool

locale

The IETF language tag used to identify the language the user is using.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Optional[Locale]

mfa_enabled

Specifies if the user has MFA turned on and working.

Type:

bool

await edit(*, username=..., avatar=...)

This function is a coroutine.

Edits the current profile of the client.

Note

To upload an avatar, a resource (see below) or a bytes-like object must be passed in that represents the image being uploaded.

The only image formats supported for uploading are JPG and PNG.

Changed in version 2.0: The edit is no longer in-place, instead the newly edited client user is returned.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

• username (str) – The new username you wish to change to.

• avatar (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  A bytes-like object or asset representing the image to upload. Could be None to denote no avatar.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

Raises:

• NotFound – The avatar asset couldn’t be found.

• HTTPException – Editing your profile failed.

• TypeError – The avatar asset is a lottie sticker (see Sticker.read()).

• ValueError – Wrong image format passed for avatar.

Returns:

The newly edited client user.

Return type:

ClientUser

property accent_color

Returns the user’s accent color, if applicable.

There is an alias for this named accent_colour.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Colour]

property accent_colour

Returns the user’s accent colour, if applicable.

There is an alias for this named accent_color.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Colour]

property avatar

Returns an Asset for the avatar the user has.

If the user does not have a traditional avatar, None is returned. If you want the avatar that a user has displayed, consider display_avatar.

Type:

Optional[Asset]

property banner

Returns the user’s banner asset, if available.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Asset]

property color

A property that returns a color denoting the rendered color for the user. This always returns Colour.default().

There is an alias for this named colour.

Type:

Colour

property colour

A property that returns a colour denoting the rendered colour for the user. This always returns Colour.default().

There is an alias for this named color.

Type:

Colour

property created_at

Returns the user’s creation time in UTC.

This is when the user’s Discord account was created.

Type:

datetime.datetime

property default_avatar

Returns the default avatar for a given user. This is calculated by the user’s discriminator.

Type:

Asset

property display_avatar

Returns the user’s display avatar.

For regular users this is just their default avatar or uploaded avatar.

New in version 2.0.

Type:

Asset

property display_name

Returns the user’s display name.

For regular users this is just their username, but if they have a guild specific nickname then that is returned instead.

Type:

str

property mention

Returns a string that allows you to mention the given user.

Type:

str

mentioned_in(message)

Checks if the user is mentioned in the specified message.

Parameters:

message (Message) – The message to check.

Returns:

Indicates if the user is mentioned in the message.

Return type:

bool

property public_flags

The publicly available flags the user has.

Type:

PublicUserFlags

User

Attributes

• accent_color
• accent_colour
• avatar
• banner
• bot
• color
• colour
• created_at
• default_avatar
• discriminator
• display_avatar
• display_name
• dm_channel
• id
• mention
• mutual_guilds
• name
• public_flags
• system

Methods

• asynccreate_dm
• asyncfetch_message
• defhistory
• defmentioned_in
• asyncpins
• asyncsend
• asynctrigger_typing
• deftyping

class disnake.User

Represents a Discord user.

x == y

Checks if two users are equal.

x != y

Checks if two users are not equal.

hash(x)

Return the user’s hash.

str(x)

Returns the user’s name with discriminator.

name

The user’s username.

Type:

str

id

The user’s unique ID.

Type:

int

discriminator

The user’s discriminator. This is given when the username has conflicts.

Type:

str

bot

Specifies if the user is a bot account.

Type:

bool

system

Specifies if the user is a system user (i.e. represents Discord officially).

Type:

bool

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property dm_channel

Returns the channel associated with this user if it exists.

If this returns None, you can create a DM channel by calling the create_dm() coroutine function.

Type:

Optional[DMChannel]

property mutual_guilds

The guilds that the user shares with the client.

Note

This will only return mutual guilds within the client’s internal cache.

New in version 1.7.

Type:

List[Guild]

property accent_color

Returns the user’s accent color, if applicable.

There is an alias for this named accent_colour.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Colour]

property accent_colour

Returns the user’s accent colour, if applicable.

There is an alias for this named accent_color.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Colour]

property avatar

Returns an Asset for the avatar the user has.

If the user does not have a traditional avatar, None is returned. If you want the avatar that a user has displayed, consider display_avatar.

Type:

Optional[Asset]

property banner

Returns the user’s banner asset, if available.

New in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Asset]

property color

A property that returns a color denoting the rendered color for the user. This always returns Colour.default().

There is an alias for this named colour.

Type:

Colour

property colour

A property that returns a colour denoting the rendered colour for the user. This always returns Colour.default().

There is an alias for this named color.

Type:

Colour

await create_dm()

This function is a coroutine.

Creates a DMChannel with this user.

This should be rarely called, as this is done transparently for most people.

Returns:

The channel that was created.

Return type:

DMChannel

property created_at

Returns the user’s creation time in UTC.

This is when the user’s Discord account was created.

Type:

datetime.datetime

property default_avatar

Returns the default avatar for a given user. This is calculated by the user’s discriminator.

Type:

Asset

property display_avatar

Returns the user’s display avatar.

For regular users this is just their default avatar or uploaded avatar.

New in version 2.0.

Type:

Asset

property display_name

Returns the user’s display name.

For regular users this is just their username, but if they have a guild specific nickname then that is returned instead.

Type:

str

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

property mention

Returns a string that allows you to mention the given user.

Type:

str

mentioned_in(message)

Checks if the user is mentioned in the specified message.

Parameters:

message (Message) – The message to check.

Returns:

Indicates if the user is mentioned in the message.

Return type:

bool

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

property public_flags

The publicly available flags the user has.

Type:

PublicUserFlags

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

Attachment

Attributes

• content_type
• description
• ephemeral
• filename
• height
• id
• proxy_url
• size
• url
• width

Methods

• defis_spoiler
• asyncread
• asyncsave
• asyncto_file

class disnake.Attachment

Represents an attachment from Discord.

str(x)

Returns the URL of the attachment.

x == y

Checks if the attachment is equal to another attachment.

x != y

Checks if the attachment is not equal to another attachment.

hash(x)

Returns the hash of the attachment.

Changed in version 1.7: Attachment can now be casted to str and is hashable.

id

The attachment’s ID.

Type:

int

size

The attachment’s size in bytes.

Type:

int

height

The attachment’s height, in pixels. Only applicable to images and videos.

Type:

Optional[int]

width

The attachment’s width, in pixels. Only applicable to images and videos.

Type:

Optional[int]

filename

The attachment’s filename.

Type:

str

url

The attachment URL. If the message this attachment was attached to is deleted, then this will 404.

Type:

str

proxy_url

The proxy URL. This is a cached version of the url in the case of images. When the message is deleted, this URL might be valid for a few minutes or not valid at all.

Type:

str

content_type

The attachment’s media type

New in version 1.7.

Type:

Optional[str]

ephemeral

Whether the attachment is ephemeral.

New in version 2.1.

Type:

bool

description

The attachment’s description

New in version 2.3.

Type:

str

is_spoiler()

Whether this attachment contains a spoiler.

Return type:

bool

await save(fp, *, seek_begin=True, use_cached=False)

This function is a coroutine.

Saves this attachment into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this attachment to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

• use_cached (bool) – Whether to use proxy_url rather than url when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.

Raises:

• HTTPException – Saving the attachment failed.

• NotFound – The attachment was deleted.

Returns:

The number of bytes written.

Return type:

int

await read(*, use_cached=False)

This function is a coroutine.

Retrieves the content of this attachment as a bytes object.

New in version 1.1.

Parameters:

use_cached (bool) – Whether to use proxy_url rather than url when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.

Raises:

• HTTPException – Downloading the attachment failed.

• Forbidden – You do not have permissions to access this attachment

• NotFound – The attachment was deleted.

Returns:

The contents of the attachment.

Return type:

bytes

await to_file(*, use_cached=False, spoiler=False, description=...)

This function is a coroutine.

Converts the attachment into a File suitable for sending via abc.Messageable.send().

New in version 1.3.

Parameters:

• use_cached (bool) –

  Whether to use proxy_url rather than url when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.

  New in version 1.4.

• spoiler (bool) –

  Whether the file is a spoiler.

  New in version 1.4.

• description (Optional[str]) –

  The file’s description. Copies this attachment’s description by default, set to None to remove.

  New in version 2.3.

Raises:

• HTTPException – Downloading the attachment failed.

• Forbidden – You do not have permissions to access this attachment

• NotFound – The attachment was deleted.

Returns:

The attachment as a file suitable for sending.

Return type:

File

Asset

Attributes

• key
• url

Methods

• defis_animated
• asyncread
• defreplace
• asyncsave
• asyncto_file
• defwith_format
• defwith_size
• defwith_static_format

class disnake.Asset

Represents a CDN asset on Discord.

str(x)

Returns the URL of the CDN asset.

len(x)

Returns the length of the CDN asset’s URL.

x == y

Checks if the asset is equal to another asset.

x != y

Checks if the asset is not equal to another asset.

hash(x)

Returns the hash of the asset.

property url

Returns the underlying URL of the asset.

Type:

str

property key

Returns the identifying key of the asset.

Type:

str

is_animated()

Whether the asset is animated.

Return type:

bool

replace(*, size=..., format=..., static_format=...)

Returns a new asset with the passed components replaced.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

• size (int) – The new size of the asset.

• format (str) – The new format to change it to. Must be either ‘webp’, ‘jpeg’, ‘jpg’, ‘png’, or ‘gif’ if it’s animated.

• static_format (str) – The new format to change it to if the asset isn’t animated. Must be either ‘webp’, ‘jpeg’, ‘jpg’, or ‘png’.

Raises:

ValueError – An invalid size or format was passed.

Returns:

The newly updated asset.

Return type:

Asset

with_size(size, /)

Returns a new asset with the specified size.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

size (int) – The new size of the asset.

Raises:

ValueError – The asset had an invalid size.

Returns:

The newly updated asset.

Return type:

Asset

with_format(format, /)

Returns a new asset with the specified format.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

format (str) – The new format of the asset.

Raises:

ValueError – The asset had an invalid format.

Returns:

The newly updated asset.

Return type:

Asset

with_static_format(format, /)

Returns a new asset with the specified static format.

This only changes the format if the underlying asset is not animated. Otherwise, the asset is not changed.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

format (str) – The new static format of the asset.

Raises:

ValueError – The asset had an invalid format.

Returns:

The newly updated asset.

Return type:

Asset

await read()

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

Message

Attributes

• activity
• application
• application_id
• attachments
• author
• channel
• channel_mentions
• clean_content
• components
• content
• created_at
• edited_at
• embeds
• flags
• guild
• id
• interaction
• jump_url
• mention_everyone
• mentions
• nonce
• pinned
• position
• raw_channel_mentions
• raw_mentions
• raw_role_mentions
• reactions
• reference
• role_mentions
• stickers
• system_content
• thread
• tts
• type
• webhook_id

Methods

• asyncadd_reaction
• asyncclear_reaction
• asyncclear_reactions
• asynccreate_thread
• asyncdelete
• asyncedit
• defis_system
• asyncpin
• asyncpublish
• asyncremove_reaction
• asyncreply
• defto_reference
• asyncunpin

class disnake.Message

Represents a message from Discord.

x == y

Checks if two messages are equal.

x != y

Checks if two messages are not equal.

hash(x)

Returns the message’s hash.

tts

Specifies if the message was done with text-to-speech. This can only be accurately received in on_message() due to a Discord limitation.

Type:

bool

type

The type of message. In most cases this should not be checked, but it is helpful in cases where it might be a system message for system_content.

Type:

MessageType

author

A Member that sent the message. If channel is a private channel or the user has the left the guild, then it is a User instead.

Type:

Union[Member, abc.User]

content

The actual contents of the message.

Type:

str

nonce

The value used by the Discord guild and the client to verify that the message is successfully sent. This is not stored long term within Discord’s servers and is only used ephemerally.

Type:

Optional[Union[str, int]]

embeds

A list of embeds the message has.

Type:

List[Embed]

channel

The channel that the message was sent from. Could be a DMChannel or GroupChannel if it’s a private message.

Type:

Union[TextChannel, VoiceChannel, Thread, DMChannel, GroupChannel, PartialMessageable]

position

A number that indicates the approximate position of a message in a Thread. This is a number that starts at 0. e.g. the first message is position 0. This is None if the message was not sent in a Thread, or if it was sent before July 1, 2022.

New in version 2.6.

Type:

Optional[int]

reference

The message that this message references. This is only applicable to messages of type MessageType.pins_add, crossposted messages created by a followed channel integration, or message replies.

New in version 1.5.

Type:

Optional[MessageReference]

interaction

The interaction that this message references. This exists only when the message is a response to an interaction without an existing message.

New in version 2.1.

Type:

Optional[InteractionReference]

mention_everyone

Specifies if the message mentions everyone.

Note

This does not check if the @everyone or the @here text is in the message itself. Rather this boolean indicates if either the @everyone or the @here text is in the message and it did end up mentioning.

Type:

bool

mentions

A list of Member that were mentioned. If the message is in a private message then the list will be of User instead. For messages that are not of type MessageType.default, this array can be used to aid in system messages. For more information, see system_content.

Warning

The order of the mentions list is not in any particular order so you should not rely on it. This is a Discord limitation, not one with the library.

Type:

List[abc.User]

role_mentions

A list of Role that were mentioned. If the message is in a private message then the list is always empty.

Type:

List[Role]

id

The message ID.

Type:

int

application_id

If this message was sent from an interaction, or is an application owned webhook, then this is the ID of the application.

New in version 2.5.

Type:

Optional[int]

webhook_id

If this message was sent by a webhook, then this is the webhook ID’s that sent this message.

Type:

Optional[int]

attachments

A list of attachments given to a message.

Type:

List[Attachment]

pinned

Specifies if the message is currently pinned.

Type:

bool

flags

Extra features of the message.

New in version 1.3.

Type:

MessageFlags

reactions

Reactions to a message. Reactions can be either custom emoji or standard unicode emoji.

Type:

List[Reaction]

activity

The activity associated with this message. Sent with Rich-Presence related messages that for example, request joining, spectating, or listening to or with another member.

It is a dictionary with the following optional keys:

• type: An integer denoting the type of message activity being requested.

• party_id: The party ID associated with the party.

Type:

Optional[dict]

application

The rich presence enabled application associated with this message.

It is a dictionary with the following keys:

• id: A string representing the application’s ID.

• name: A string representing the application’s name.

• description: A string representing the application’s description.

• icon: A string representing the icon ID of the application.

• cover_image: A string representing the embed’s image asset ID.

Type:

Optional[dict]

stickers

A list of sticker items given to the message.

New in version 1.6.

Type:

List[StickerItem]

components

A list of components in the message.

New in version 2.0.

Type:

List[Component]

guild

The guild that the message belongs to, if applicable.

Type:

Optional[Guild]

raw_mentions

A property that returns an array of user IDs matched with the syntax of <@user_id> in the message content.

This allows you to receive the user IDs of mentioned users even in a private message context.

Type:

List[int]

raw_channel_mentions

A property that returns an array of channel IDs matched with the syntax of <#channel_id> in the message content.

Type:

List[int]

raw_role_mentions

A property that returns an array of role IDs matched with the syntax of <@&role_id> in the message content.

Type:

List[int]

channel_mentions

A list of abc.GuildChannel that were mentioned. If the message is in a private message then the list is always empty.

Type:

List[abc.GuildChannel]

clean_content

A property that returns the content in a “cleaned up” manner. This basically means that mentions are transformed into the way the client shows it. e.g. <#id> will transform into #name.

This will also transform @everyone and @here mentions into non-mentions.

Note

This does not affect markdown. If you want to escape or remove markdown then use utils.escape_markdown() or utils.remove_markdown() respectively, along with this function.

Type:

str

property created_at

The message’s creation time in UTC.

Type:

datetime.datetime

property edited_at

An aware UTC datetime object containing the edited time of the message.

Type:

Optional[datetime.datetime]

property jump_url

Returns a URL that allows the client to jump to this message.

Type:

str

property thread

The thread started from this message. None if no thread has been started.

New in version 2.4.

Type:

Optional[Thread]

is_system()

Whether the message is a system message.

A system message is a message that is constructed entirely by the Discord API in response to something.

New in version 1.3.

Return type:

bool

system_content

A property that returns the content that is rendered regardless of the Message.type.

In the case of MessageType.default and MessageType.reply, this just returns the regular Message.content. Otherwise this returns an English message denoting the contents of the system message.

If the message type is unrecognised this method will return None.

Type:

Optional[str]

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Your own messages could be deleted without any proper permissions. However to delete other people’s messages, you need the manage_messages permission.

Changed in version 1.1: Added the new delay keyword-only parameter.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait in the background before deleting the message. If the deletion fails then it is silently ignored.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already

• HTTPException – Deleting the message failed.

await edit(content=..., *, embed=..., embeds=..., file=..., files=..., attachments=..., suppress=..., suppress_embeds=..., allowed_mentions=..., view=..., components=..., delete_after=None)

This function is a coroutine.

Edits the message.

The content must be able to be transformed into a string via str(content).

Note

If the original message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Note

This method cannot be used on messages authored by others, with one exception. The suppress_embeds parameter can be used to change the state of embeds on other users’ messages, requiring the manage_messages permission.

Changed in version 1.3: The suppress keyword-only parameter was added.

Changed in version 2.5: The suppress keyword-only parameter was deprecated in favor of suppress_embeds.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The new content to replace the message with. Could be None to remove the content.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) –

  The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

  New in version 2.0.

• file (File) –

  The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

  New in version 2.1.

• files (List[File]) –

  A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

  New in version 2.1.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  Changed in version 2.5: Supports passing None to clear attachments.

• suppress_embeds (bool) – Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True. If set to False, this brings the embeds back if they were suppressed.

• delete_after (Optional[float]) – If provided, the number of seconds to wait in the background before deleting the message we just edited. If the deletion fails, then it is silently ignored.

• allowed_mentions (Optional[AllowedMentions]) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• view (Optional[View]) –

  The updated view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  The updated components to update this message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Tried to suppress embeds on a message without permissions or edited a message’s content or embed that isn’t yours.

• TypeError – You specified both embed and embeds, or file and files, or view and components.

Returns:

The message that was edited.

Return type:

Message

await publish()

This function is a coroutine.

Publishes this message to your announcement channel.

You must have the send_messages permission to do this.

If the message is not your own then the manage_messages permission is also needed.

Raises:

• Forbidden – You do not have the proper permissions to publish this message.

• HTTPException – Publishing the message failed.

await pin(*, reason=None)

This function is a coroutine.

Pins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

The reason for pinning the message. Shows up on the audit log.

New in version 1.4.

Raises:

• Forbidden – You do not have permissions to pin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Pinning the message failed, probably due to the channel having more than 50 pinned messages.

await unpin(*, reason=None)

This function is a coroutine.

Unpins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

The reason for unpinning the message. Shows up on the audit log.

New in version 1.4.

Raises:

• Forbidden – You do not have permissions to unpin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Unpinning the message failed.

await add_reaction(emoji)

This function is a coroutine.

Adds a reaction to the message.

The emoji may be a unicode emoji or a custom guild Emoji.

You must have the read_message_history permission to use this. If nobody else has reacted to the message using this emoji, the add_reactions permission is required.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to react with.

Raises:

• HTTPException – Adding the reaction failed.

• Forbidden – You do not have the proper permissions to react to the message.

• NotFound – The emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

await remove_reaction(emoji, member)

This function is a coroutine.

Removes a reaction by the member from the message.

The emoji may be a unicode emoji or a custom guild Emoji.

If the reaction is not your own (i.e. member parameter is not you) then the manage_messages permission is needed.

The member parameter must represent a member and meet the abc.Snowflake abc.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to remove.

• member (abc.Snowflake) – The member for which to remove the reaction.

Raises:

• HTTPException – Removing the reaction failed.

• Forbidden – You do not have the proper permissions to remove the reaction.

• NotFound – The member or emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

await clear_reaction(emoji)

This function is a coroutine.

Clears a specific reaction from the message.

The emoji may be a unicode emoji or a custom guild Emoji.

You need the manage_messages permission to use this.

New in version 1.3.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to clear.

Raises:

• HTTPException – Clearing the reaction failed.

• Forbidden – You do not have the proper permissions to clear the reaction.

• NotFound – The emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

await clear_reactions()

This function is a coroutine.

Removes all the reactions from the message.

You need the manage_messages permission to use this.

Raises:

• HTTPException – Removing the reactions failed.

• Forbidden – You do not have the proper permissions to remove all the reactions.

await create_thread(*, name, auto_archive_duration=None, slowmode_delay=None, reason=None)

This function is a coroutine.

Creates a public thread from this message.

You must have create_public_threads in order to create a public thread from a message.

The channel this message belongs in must be a TextChannel.

New in version 2.0.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• name (str) – The name of the thread.

• auto_archive_duration (Union[int, ThreadArchiveDuration]) – The duration in minutes before a thread is automatically archived for inactivity. If not provided, the channel’s default auto archive duration is used. Must be one of 60, 1440, 4320, or 10080.

• slowmode_delay (Optional[int]) –

  Specifies the slowmode rate limit for users in this thread, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If set to None or not provided, slowmode is inherited from the parent’s default_thread_slowmode_delay.

  New in version 2.3.

• reason (Optional[str]) –

  The reason for creating the thread. Shows up on the audit log.

  New in version 2.5.

Raises:

• Forbidden – You do not have permissions to create a thread.

• HTTPException – Creating the thread failed.

• TypeError – This message does not have guild info attached.

Returns:

The created thread.

Return type:

Thread

await reply(content=None, *, fail_if_not_exists=True, **kwargs)

This function is a coroutine.

A shortcut method to abc.Messageable.send() to reply to the Message.

New in version 1.6.

Changed in version 2.3: Added fail_if_not_exists keyword argument. Defaults to True.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

New in version 2.3.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – You specified both embed and embeds, or file and files, or view and components.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

to_reference(*, fail_if_not_exists=True)

Creates a MessageReference from the current message.

New in version 1.6.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

New in version 1.7.

Returns:

The reference to this message.

Return type:

MessageReference

APISlashCommand

Attributes

• application_id
• default_member_permissions
• description
• description_localizations
• dm_permission
• guild_id
• id
• name
• name_localizations
• nsfw
• options
• version

Methods

• defadd_option

class disnake.APISlashCommand

A slash command returned by the API.

New in version 2.4.

name

The slash command’s name.

Type:

str

name_localizations

Localizations for name.

New in version 2.5.

Type:

LocalizationValue

description

The slash command’s description.

Type:

str

description_localizations

Localizations for description.

New in version 2.5.

Type:

LocalizationValue

dm_permission

Whether this command can be used in DMs.

New in version 2.5.

Type:

bool

nsfw

Whether this command is age-restricted.

New in version 2.8.

Type:

bool

id

The slash command’s ID.

Type:

int

options

The list of options the slash command has.

Type:

List[Option]

application_id

The application ID this command belongs to.

Type:

int

guild_id

The ID of the guild this slash command is enabled in, or None if it’s global.

Type:

Optional[int]

version

Autoincrementing version identifier updated during substantial record changes.

Type:

int

add_option(name, description=None, type=None, required=False, choices=None, options=None, channel_types=None, autocomplete=False, min_value=None, max_value=None, min_length=None, max_length=None)

Adds an option to the current list of options, parameters are the same as for Option

property default_member_permissions

The default required member permissions for this command. A member must have all these permissions to be able to invoke the command in a guild.

This is a default value, the set of users/roles that may invoke this command can be overridden by moderators on a guild-specific basis, disregarding this setting.

If None is returned, it means everyone can use the command by default. If an empty Permissions object is returned (that is, all permissions set to False), this means no one can use the command.

New in version 2.5.

Type:

Optional[Permissions]

APIUserCommand

Attributes

• application_id
• default_member_permissions
• dm_permission
• guild_id
• id
• name
• name_localizations
• nsfw
• version

class disnake.APIUserCommand

A user context menu command returned by the API.

New in version 2.4.

name

The user command’s name.

Type:

str

name_localizations

Localizations for name.

New in version 2.5.

Type:

LocalizationValue

dm_permission

Whether this command can be used in DMs.

New in version 2.5.

Type:

bool

nsfw

Whether this command is age-restricted.

New in version 2.8.

Type:

bool

id

The user command’s ID.

Type:

int

application_id

The application ID this command belongs to.

Type:

int

guild_id

The ID of the guild this user command is enabled in, or None if it’s global.

Type:

Optional[int]

version

Autoincrementing version identifier updated during substantial record changes.

Type:

int

property default_member_permissions

The default required member permissions for this command. A member must have all these permissions to be able to invoke the command in a guild.

This is a default value, the set of users/roles that may invoke this command can be overridden by moderators on a guild-specific basis, disregarding this setting.

If None is returned, it means everyone can use the command by default. If an empty Permissions object is returned (that is, all permissions set to False), this means no one can use the command.

New in version 2.5.

Type:

Optional[Permissions]

APIMessageCommand

Attributes

• application_id
• default_member_permissions
• dm_permission
• guild_id
• id
• name
• name_localizations
• nsfw
• version

class disnake.APIMessageCommand

A message context menu command returned by the API.

New in version 2.4.

name

The message command’s name.

Type:

str

name_localizations

Localizations for name.

New in version 2.5.

Type:

LocalizationValue

dm_permission

Whether this command can be used in DMs.

New in version 2.5.

Type:

bool

nsfw

Whether this command is age-restricted.

New in version 2.8.

Type:

bool

id

The message command’s ID.

Type:

int

application_id

The application ID this command belongs to.

Type:

int

guild_id

The ID of the guild this message command is enabled in, or None if it’s global.

Type:

Optional[int]

version

Autoincrementing version identifier updated during substantial record changes.

Type:

int

property default_member_permissions

The default required member permissions for this command. A member must have all these permissions to be able to invoke the command in a guild.

This is a default value, the set of users/roles that may invoke this command can be overridden by moderators on a guild-specific basis, disregarding this setting.

If None is returned, it means everyone can use the command by default. If an empty Permissions object is returned (that is, all permissions set to False), this means no one can use the command.

New in version 2.5.

Type:

Optional[Permissions]

ApplicationCommandPermissions

Attributes

• id
• permission
• type

Methods

• defis_all_channels
• defis_everyone

class disnake.ApplicationCommandPermissions

Represents application command permissions for a role, user, or channel.

id

The ID of the role, user, or channel.

Type:

int

type

The type of the target.

Type:

ApplicationCommandPermissionType

permission

Whether to allow or deny the access to the application command.

Type:

bool

is_everyone()

Whether this permission object is affecting the @everyone role.

New in version 2.5.

Return type:

bool

is_all_channels()

Whether this permission object is affecting all channels.

New in version 2.5.

Return type:

bool

GuildApplicationCommandPermissions

Attributes

• application_id
• guild_id
• id
• permissions

class disnake.GuildApplicationCommandPermissions

Represents application command permissions in a guild.

Changed in version 2.5: Can now also represent application-wide permissions that apply to every command by default.

id

The application command’s ID, or the application ID if these are application-wide permissions.

Type:

int

application_id

The application ID this command belongs to.

Type:

int

guild_id

The ID of the guild where these permissions are applied.

Type:

int

permissions

A list of ApplicationCommandPermissions.

Type:

List[ApplicationCommandPermissions]

Component

Attributes

• type

class disnake.Component

Represents a Discord Bot UI Kit Component.

Currently, the only components supported by Discord are:

• ActionRow

• Button

• subtypes of BaseSelectMenu (ChannelSelectMenu, MentionableSelectMenu, RoleSelectMenu, StringSelectMenu, UserSelectMenu)

• TextInput

This class is abstract and cannot be instantiated.

New in version 2.0.

type

The type of component.

Type:

ComponentType

ActionRow

Attributes

• children
• type

class disnake.ActionRow

Represents an action row.

This is a component that holds up to 5 children components in a row.

This inherits from Component.

New in version 2.0.

type

The type of component.

Type:

ComponentType

children

The children components that this holds, if any.

Type:

List[Union[Button, BaseSelectMenu, TextInput]]

Button

Attributes

• custom_id
• disabled
• emoji
• label
• style
• url

class disnake.Button

Represents a button from the Discord Bot UI Kit.

This inherits from Component.

Note

The user constructible and usable type to create a button is disnake.ui.Button, not this one.

New in version 2.0.

style

The style of the button.

Type:

ButtonStyle

custom_id

The ID of the button that gets received during an interaction. If this button is for a URL, it does not have a custom ID.

Type:

Optional[str]

url

The URL this button sends you to.

Type:

Optional[str]

disabled

Whether the button is disabled or not.

Type:

bool

label

The label of the button, if any.

Type:

Optional[str]

emoji

The emoji of the button, if available.

Type:

Optional[PartialEmoji]

BaseSelectMenu

Attributes

• custom_id
• disabled
• max_values
• min_values
• options
• placeholder

class disnake.BaseSelectMenu

Represents an abstract select menu from the Discord Bot UI Kit.

A select menu is functionally the same as a dropdown, however on mobile it renders a bit differently.

The currently supported select menus are:

• StringSelectMenu

• UserSelectMenu

• RoleSelectMenu

• MentionableSelectMenu

• ChannelSelectMenu

New in version 2.7.

custom_id

The ID of the select menu that gets received during an interaction.

Type:

Optional[str]

placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

min_values

The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

max_values

The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

options

A list of options that can be selected in this select menu.

Type:

List[SelectOption]

disabled

Whether the select menu is disabled or not.

Type:

bool

ChannelSelectMenu

Attributes

• channel_types
• custom_id
• disabled
• max_values
• min_values
• placeholder

class disnake.ChannelSelectMenu

Represents a channel select menu from the Discord Bot UI Kit.

Note

The user constructible and usable type to create a channel select menu is disnake.ui.ChannelSelect.

New in version 2.7.

custom_id

The ID of the select menu that gets received during an interaction.

Type:

Optional[str]

placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

min_values

The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

max_values

The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

disabled

Whether the select menu is disabled or not.

Type:

bool

channel_types

A list of channel types that can be selected in this select menu. If None, channels of all types may be selected.

Type:

Optional[List[ChannelType]]

MentionableSelectMenu

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder

class disnake.MentionableSelectMenu

Represents a mentionable (user/member/role) select menu from the Discord Bot UI Kit.

Note

The user constructible and usable type to create a mentionable select menu is disnake.ui.MentionableSelect.

New in version 2.7.

custom_id

The ID of the select menu that gets received during an interaction.

Type:

Optional[str]

placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

min_values

The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

max_values

The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

disabled

Whether the select menu is disabled or not.

Type:

bool

RoleSelectMenu

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder

class disnake.RoleSelectMenu

Represents a role select menu from the Discord Bot UI Kit.

Note

The user constructible and usable type to create a role select menu is disnake.ui.RoleSelect.

New in version 2.7.

custom_id

The ID of the select menu that gets received during an interaction.

Type:

Optional[str]

placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

min_values

The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

max_values

The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

disabled

Whether the select menu is disabled or not.

Type:

bool

StringSelectMenu

Attributes

• custom_id
• disabled
• max_values
• min_values
• options
• placeholder

class disnake.StringSelectMenu

Represents a string select menu from the Discord Bot UI Kit.

Note

The user constructible and usable type to create a string select menu is disnake.ui.StringSelect.

New in version 2.0.

Changed in version 2.7: Renamed from SelectMenu to StringSelectMenu.

custom_id

The ID of the select menu that gets received during an interaction.

Type:

Optional[str]

placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

min_values

The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

max_values

The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

disabled

Whether the select menu is disabled or not.

Type:

bool

options

A list of options that can be selected in this select menu.

Type:

List[SelectOption]

UserSelectMenu

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder

class disnake.UserSelectMenu

Represents a user select menu from the Discord Bot UI Kit.

Note

The user constructible and usable type to create a user select menu is disnake.ui.UserSelect.

New in version 2.7.

custom_id

The ID of the select menu that gets received during an interaction.

Type:

Optional[str]

placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

min_values

The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

max_values

The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

Type:

int

disabled

Whether the select menu is disabled or not.

Type:

bool

TextInput

Attributes

• custom_id
• label
• max_length
• min_length
• placeholder
• required
• style
• value

class disnake.TextInput

Represents a text input from the Discord Bot UI Kit.

New in version 2.4.

Note

The user constructible and usable type to create a text input is disnake.ui.TextInput, not this one.

style

The style of the text input.

Type:

TextInputStyle

label

The label of the text input.

Type:

Optional[str]

custom_id

The ID of the text input that gets received during an interaction.

Type:

str

placeholder

The placeholder text that is shown if nothing is entered.

Type:

Optional[str]

value

The pre-filled text of the text input.

Type:

Optional[str]

required

Whether the text input is required. Defaults to True.

Type:

bool

min_length

The minimum length of the text input.

Type:

Optional[int]

max_length

The maximum length of the text input.

Type:

Optional[int]

DeletedReferencedMessage

Attributes

• channel_id
• guild_id
• id

class disnake.DeletedReferencedMessage

A special sentinel type that denotes whether the resolved message referenced message had since been deleted.

The purpose of this class is to separate referenced messages that could not be fetched and those that were previously fetched but have since been deleted.

New in version 1.6.

property id

The message ID of the deleted referenced message.

Type:

int

property channel_id

The channel ID of the deleted referenced message.

Type:

int

property guild_id

The guild ID of the deleted referenced message.

Type:

Optional[int]

Reaction

Attributes

• count
• emoji
• me
• message

Methods

• asyncclear
• defis_custom_emoji
• asyncremove
• defusers

class disnake.Reaction

Represents a reaction to a message.

Depending on the way this object was created, some of the attributes can have a value of None.

x == y

Checks if two reactions are equal. This works by checking if the emoji is the same. So two messages with the same reaction will be considered “equal”.

x != y

Checks if two reactions are not equal.

hash(x)

Returns the reaction’s hash.

str(x)

Returns the string form of the reaction’s emoji.

emoji

The reaction emoji. May be a custom emoji, or a unicode emoji.

Type:

Union[Emoji, PartialEmoji, str]

count

Number of times this reaction was made

Type:

int

me

If the user sent this reaction.

Type:

bool

message

The message this reaction belongs to.

Type:

Message

async for ... in users(*, limit=None, after=None)

Returns an AsyncIterator representing the users that have reacted to the message.

The after parameter must represent a member and meet the abc.Snowflake abc.

Examples

Usage

# We do not actually recommend doing this.
async for user in reaction.users():
    await channel.send(f'{user} has reacted with {reaction.emoji}!')

Flattening into a list:

users = await reaction.users().flatten()
# users is now a list of User...
winner = random.choice(users)
await channel.send(f'{winner} has won the raffle.')

Parameters:

• limit (Optional[int]) – The maximum number of results to return. If not provided, returns all the users who reacted to the message.

• after (Optional[abc.Snowflake]) – For pagination, reactions are sorted by member.

Raises:

HTTPException – Getting the users for the reaction failed.

Yields:

Union[User, Member] – The member (if retrievable) or the user that has reacted to this message. The case where it can be a Member is in a guild message context. Sometimes it can be a User if the member has left the guild.

is_custom_emoji()

Whether the emoji is a custom emoji.

Return type:

bool

await remove(user)

This function is a coroutine.

Removes the reaction by the provided User from the message.

If the reaction is not your own (i.e. user parameter is not you) then the manage_messages permission is needed.

The user parameter must represent a user or member and meet the abc.Snowflake abc.

Parameters:

user (abc.Snowflake) – The user or member from which to remove the reaction.

Raises:

• HTTPException – Removing the reaction failed.

• Forbidden – You do not have the proper permissions to remove the reaction.

• NotFound – The user you specified, or the reaction’s message was not found.

await clear()

This function is a coroutine.

Clears this reaction from the message.

You need the manage_messages permission to use this.

New in version 1.3.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Raises:

• HTTPException – Clearing the reaction failed.

• Forbidden – You do not have the proper permissions to clear the reaction.

• NotFound – The emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

Guild

Attributes

• afk_channel
• afk_timeout
• approximate_member_count
• approximate_presence_count
• banner
• bitrate_limit
• categories
• channels
• chunked
• created_at
• default_notifications
• default_role
• description
• discovery_splash
• emoji_limit
• emojis
• explicit_content_filter
• features
• filesize_limit
• forum_channels
• icon
• id
• large
• max_members
• max_presences
• max_video_channel_users
• me
• member_count
• members
• mfa_level
• name
• nsfw_level
• owner
• owner_id
• preferred_locale
• premium_progress_bar_enabled
• premium_subscriber_role
• premium_subscribers
• premium_subscription_count
• premium_tier
• public_updates_channel
• region
• roles
• rules_channel
• scheduled_events
• self_role
• shard_id
• splash
• stage_channels
• stage_instances
• sticker_limit
• stickers
• system_channel
• system_channel_flags
• text_channels
• threads
• unavailable
• vanity_url_code
• verification_level
• voice_channels
• voice_client
• widget_channel_id
• widget_enabled

Methods

• asyncactive_threads
• defaudit_logs
• asyncban
• defbans
• asyncbulk_fetch_command_permissions
• defby_category
• asyncchange_voice_state
• asyncchunk
• asynccreate_automod_rule
• asynccreate_category
• asynccreate_category_channel
• asynccreate_custom_emoji
• asynccreate_forum_channel
• asynccreate_integration
• asynccreate_role
• asynccreate_scheduled_event
• asynccreate_stage_channel
• asynccreate_sticker
• asynccreate_template
• asynccreate_text_channel
• asynccreate_voice_channel
• asyncdelete
• asyncdelete_emoji
• asyncdelete_sticker
• asyncedit
• asyncedit_mfa_level
• asyncedit_role_positions
• asyncedit_welcome_screen
• asyncedit_widget
• asyncestimate_pruned_members
• asyncfetch_automod_rule
• asyncfetch_automod_rules
• asyncfetch_ban
• asyncfetch_channel
• asyncfetch_channels
• asyncfetch_command_permissions
• asyncfetch_emoji
• asyncfetch_emojis
• asyncfetch_member
• deffetch_members
• asyncfetch_roles
• asyncfetch_scheduled_event
• asyncfetch_scheduled_events
• asyncfetch_sticker
• asyncfetch_stickers
• asyncfetch_voice_regions
• defget_channel
• defget_channel_or_thread
• defget_command
• defget_command_named
• defget_member
• defget_member_named
• asyncget_or_fetch_member
• asyncget_or_fetch_members
• defget_role
• defget_scheduled_event
• defget_stage_instance
• defget_thread
• asyncgetch_member
• asyncgetch_members
• asyncintegrations
• asyncinvites
• asynckick
• asyncleave
• asyncprune_members
• asyncquery_members
• asyncsearch_members
• asynctemplates
• asynctimeout
• asyncunban
• asyncvanity_invite
• asyncwebhooks
• asyncwelcome_screen
• asyncwidget
• defwidget_image_url
• asyncwidget_settings

class disnake.Guild

Represents a Discord guild.

This is referred to as a “server” in the official Discord UI.

x == y

Checks if two guilds are equal.

x != y

Checks if two guilds are not equal.

hash(x)

Returns the guild’s hash.

str(x)

Returns the guild’s name.

name

The guild’s name.

Type:

str

emojis

All emojis that the guild owns.

Type:

Tuple[Emoji, …]

stickers

All stickers that the guild owns.

New in version 2.0.

Type:

Tuple[GuildSticker, …]

afk_timeout

The timeout to get sent to the AFK channel.

Type:

int

afk_channel

The channel that denotes the AFK channel. None if it doesn’t exist.

Type:

Optional[VoiceChannel]

id

The guild’s ID.

Type:

int

owner_id

The guild owner’s ID. Use Guild.owner if you need a Member object instead.

Type:

int

unavailable

Whether the guild is unavailable. If this is True then the reliability of other attributes outside of Guild.id is slim and they might all be None. It is best to not do anything with the guild if it is unavailable.

Check on_guild_unavailable() and on_guild_available() events.

Type:

bool

max_presences

The maximum amount of presences for the guild.

Type:

Optional[int]

max_members

The maximum amount of members for the guild.

Note

This attribute is only available via Client.fetch_guild().

Type:

Optional[int]

max_video_channel_users

The maximum amount of users in a video channel.

New in version 1.4.

Type:

Optional[int]

description

The guild’s description.

Type:

Optional[str]

mfa_level

Indicates the guild’s two-factor authentication level. If this value is 0 then the guild does not require 2FA for their administrative members to take moderation actions. If the value is 1, then 2FA is required.

Type:

int

verification_level

The guild’s verification level.

Type:

VerificationLevel

explicit_content_filter

The guild’s explicit content filter.

Type:

ContentFilter

default_notifications

The guild’s notification settings.

Type:

NotificationLevel

features

A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord.

A partial list of features is below:

• ANIMATED_BANNER: Guild can upload an animated banner.

• ANIMATED_ICON: Guild can upload an animated icon.

• AUTO_MODERATION: Guild has set up auto moderation rules.

• BANNER: Guild can upload and use a banner. (i.e. banner)

• COMMUNITY: Guild is a community server.

• DEVELOPER_SUPPORT_SERVER: Guild is set as a support server in the app directory.

• DISCOVERABLE: Guild shows up in Server Discovery.

• ENABLED_DISCOVERABLE_BEFORE: Guild had Server Discovery enabled at least once.

• FEATURABLE: Guild is able to be featured in Server Discovery.

• HAS_DIRECTORY_ENTRY: Guild is listed in a student hub.

• HUB: Guild is a student hub.

• INVITE_SPLASH: Guild’s invite page can have a special splash.

• INVITES_DISABLED: Guild has paused invites, preventing new users from joining.

• LINKED_TO_HUB: Guild is linked to a student hub.

• MEMBER_VERIFICATION_GATE_ENABLED: Guild has Membership Screening enabled.

• MONETIZATION_ENABLED: Guild has enabled monetization.

• MORE_EMOJI: Guild has increased custom emoji slots.

• MORE_STICKERS: Guild has increased custom sticker slots.

• NEWS: Guild can create news channels.

• NEW_THREAD_PERMISSIONS: Guild is using the new thread permission system.

• PARTNERED: Guild is a partnered server.

• PREVIEW_ENABLED: Guild can be viewed before being accepted via Membership Screening.

• PRIVATE_THREADS: Guild has access to create private threads (no longer has any effect).

• ROLE_ICONS: Guild has access to role icons.

• SEVEN_DAY_THREAD_ARCHIVE: Guild has access to the seven day archive time for threads (no longer has any effect).

• TEXT_IN_VOICE_ENABLED: Guild has text in voice channels enabled (no longer has any effect).

• THREE_DAY_THREAD_ARCHIVE: Guild has access to the three day archive time for threads (no longer has any effect).

• THREADS_ENABLED: Guild has access to threads (no longer has any effect).

• TICKETED_EVENTS_ENABLED: Guild has enabled ticketed events (no longer has any effect).

• VANITY_URL: Guild can have a vanity invite URL (e.g. discord.gg/disnake).

• VERIFIED: Guild is a verified server.

• VIP_REGIONS: Guild has VIP voice regions.

• WELCOME_SCREEN_ENABLED: Guild has enabled the welcome screen.

Type:

List[str]

premium_progress_bar_enabled

Whether the server boost progress bar is enabled.

Type:

bool

premium_tier

The premium tier for this guild. Corresponds to “Nitro Server” in the official UI. The number goes from 0 to 3 inclusive.

Type:

int

premium_subscription_count

The number of “boosts” this guild currently has.

Type:

int

preferred_locale

The preferred locale for the guild. Used when filtering Server Discovery results to a specific language.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Locale

nsfw_level

The guild’s NSFW level.

New in version 2.0.

Type:

NSFWLevel

approximate_member_count

The approximate number of members in the guild. Only available for manually fetched guilds.

New in version 2.3.

Type:

Optional[int]

approximate_presence_count

The approximate number of members currently active in the guild. This includes idle, dnd, online, and invisible members. Offline members are excluded. Only available for manually fetched guilds.

New in version 2.3.

Type:

Optional[int]

widget_enabled

Whether the widget is enabled.

New in version 2.5.

Note

This value is unreliable and will only be set after the guild was updated at least once. Avoid using this and use widget_settings() instead.

Type:

Optional[bool]

widget_channel_id

The widget channel ID, if set.

New in version 2.5.

Note

This value is unreliable and will only be set after the guild was updated at least once. Avoid using this and use widget_settings() instead.

Type:

Optional[int]

vanity_url_code

The vanity invite code for this guild, if set.

To get a full Invite object, see Guild.vanity_invite.

New in version 2.5.

Type:

Optional[str]

async for ... in fetch_members(*, limit=1000, after=None)

Retrieves an AsyncIterator that enables receiving the guild’s members. In order to use this, Intents.members() must be enabled.

Note

This method is an API call. For general usage, consider members instead.

New in version 1.3.

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of members to retrieve. Defaults to 1000. Pass None to fetch all members. Note that this is potentially slow.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve members after this date or object. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

Raises:

• ClientException – The members intent is not enabled.

• HTTPException – Retrieving the members failed.

Yields:

Member – The member with the member data parsed.

Examples

Usage

async for member in guild.fetch_members(limit=150):
    print(member.name)

Flattening into a list

members = await guild.fetch_members(limit=150).flatten()
# members is now a list of Member...

async for ... in audit_logs(*, limit=100, before=None, after=None, user=None, action=None)

Returns an AsyncIterator that enables receiving the guild’s audit logs.

You must have view_audit_log permission to use this.

Entries are always returned in order from newest to oldest, regardless of the before and after parameters.

Examples

Getting the first 100 entries:

async for entry in guild.audit_logs(limit=100):
    print(f'{entry.user} did {entry.action} to {entry.target}')

Getting entries for a specific action:

async for entry in guild.audit_logs(action=disnake.AuditLogAction.ban):
    print(f'{entry.user} banned {entry.target}')

Getting entries made by a specific user:

entries = await guild.audit_logs(limit=None, user=guild.me).flatten()
await channel.send(f'I made {len(entries)} moderation actions.')

Parameters:

• limit (Optional[int]) – The number of entries to retrieve. If None retrieve all entries.

• before (Union[abc.Snowflake, datetime.datetime]) – Retrieve entries before this date or entry. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Union[abc.Snowflake, datetime.datetime]) – Retrieve entries after this date or entry. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• user (abc.Snowflake) – The moderator to filter entries from.

• action (AuditLogAction) – The action to filter with.

Raises:

• Forbidden – You are not allowed to fetch audit logs

• HTTPException – An error occurred while fetching the audit logs.

Yields:

AuditLogEntry – The audit log entry.

get_command(application_command_id, /)

Gets a cached application command matching the specified ID.

Parameters:

application_command_id (int) – The application command ID to search for.

Returns:

The application command if found, or None otherwise.

Return type:

Optional[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

get_command_named(name, /)

Gets a cached application command matching the specified name.

Parameters:

name (str) – The application command name to search for.

Returns:

The application command if found, or None otherwise.

Return type:

Optional[Union[APIUserCommand, APIMessageCommand, APISlashCommand]]

property channels

A list of channels that belong to this guild.

Type:

List[abc.GuildChannel]

property threads

A list of threads that you have permission to view.

New in version 2.0.

Type:

List[Thread]

property large

Whether the guild is a ‘large’ guild.

A large guild is defined as having more than large_threshold count members, which for this library is set to the maximum of 250.

Type:

bool

property voice_channels

A list of voice channels that belong to this guild.

This is sorted by the position and are in UI order from top to bottom.

Type:

List[VoiceChannel]

property stage_channels

A list of stage channels that belong to this guild.

New in version 1.7.

This is sorted by the position and are in UI order from top to bottom.

Type:

List[StageChannel]

property forum_channels

A list of forum channels that belong to this guild.

This is sorted by the position and are in UI order from top to bottom.

New in version 2.5.

Type:

List[ForumChannel]

property me

Similar to Client.user except an instance of Member. This is essentially used to get the member version of yourself.

Type:

Member

property voice_client

Returns the VoiceProtocol associated with this guild, if any.

Type:

Optional[VoiceProtocol]

property text_channels

A list of text channels that belong to this guild.

This is sorted by the position and are in UI order from top to bottom.

Type:

List[TextChannel]

property categories

A list of categories that belong to this guild.

This is sorted by the position and are in UI order from top to bottom.

Type:

List[CategoryChannel]

by_category()

Returns every CategoryChannel and their associated channels.

These channels and categories are sorted in the official Discord UI order.

If the channels do not have a category, then the first element of the tuple is None.

Returns:

The categories and their associated channels.

Return type:

List[Tuple[Optional[CategoryChannel], List[abc.GuildChannel]]]

get_channel_or_thread(channel_id, /)

Returns a channel or thread with the given ID.

New in version 2.0.

Parameters:

channel_id (int) – The ID to search for.

Returns:

The returned channel or thread or None if not found.

Return type:

Optional[Union[Thread, abc.GuildChannel]]

get_channel(channel_id, /)

Returns a channel with the given ID.

Note

This does not search for threads.

Parameters:

channel_id (int) – The ID to search for.

Returns:

The returned channel or None if not found.

Return type:

Optional[abc.GuildChannel]

get_thread(thread_id, /)

Returns a thread with the given ID.

New in version 2.0.

Parameters:

thread_id (int) – The ID to search for.

Returns:

The returned thread or None if not found.

Return type:

Optional[Thread]

property system_channel

Returns the guild’s channel used for system messages.

If no channel is set, then this returns None.

Type:

Optional[TextChannel]

property system_channel_flags

Returns the guild’s system channel settings.

Type:

SystemChannelFlags

property rules_channel

Return’s the guild’s channel used for the rules. The guild must be a Community guild.

If no channel is set, then this returns None.

New in version 1.3.

Type:

Optional[TextChannel]

property public_updates_channel

Return’s the guild’s channel where admins and moderators of the guild receive notices from Discord. The guild must be a Community guild.

If no channel is set, then this returns None.

New in version 1.4.

Type:

Optional[TextChannel]

property emoji_limit

The maximum number of emoji slots this guild has.

Type:

int

property sticker_limit

The maximum number of sticker slots this guild has.

New in version 2.0.

Type:

int

property bitrate_limit

The maximum bitrate for voice channels this guild can have. For stage channels, the maximum bitrate is 64000.

Type:

float

property filesize_limit

The maximum number of bytes files can have when uploaded to this guild.

Type:

int

property members

A list of members that belong to this guild.

Type:

List[Member]

get_member(user_id, /)

Returns a member with the given ID.

Parameters:

user_id (int) – The ID to search for.

Returns:

The member or None if not found.

Return type:

Optional[Member]

property premium_subscribers

A list of members who have “boosted” this guild.

Type:

List[Member]

property roles

Returns a list of the guild’s roles in hierarchy order.

The first element of this list will be the lowest role in the hierarchy.

Type:

List[Role]

get_role(role_id, /)

Returns a role with the given ID.

Parameters:

role_id (int) – The ID to search for.

Returns:

The role or None if not found.

Return type:

Optional[Role]

property default_role

Gets the @everyone role that all members have by default.

Type:

Role

property premium_subscriber_role

Gets the premium subscriber role, AKA “boost” role, in this guild, if any.

New in version 1.6.

Type:

Optional[Role]

property self_role

Gets the role associated with this client’s user, if any.

New in version 1.6.

Type:

Optional[Role]

property stage_instances

Returns a list of the guild’s stage instances that are currently running.

New in version 2.0.

Type:

List[StageInstance]

get_stage_instance(stage_instance_id, /)

Returns a stage instance with the given ID.

New in version 2.0.

Parameters:

stage_instance_id (int) – The ID to search for.

Returns:

The stage instance or None if not found.

Return type:

Optional[StageInstance]

property scheduled_events

Returns a list of existing guild scheduled events.

New in version 2.3.

Type:

List[GuildScheduledEvent]

get_scheduled_event(event_id, /)

Returns a guild scheduled event with the given ID.

New in version 2.3.

Parameters:

event_id (int) – The ID to search for.

Returns:

The guild scheduled event or None if not found.

Return type:

Optional[GuildScheduledEvent]

property owner

Returns the member that owns the guild.

Type:

Optional[Member]

property icon

Returns the guild’s icon asset, if available.

Type:

Optional[Asset]

property banner

Returns the guild’s banner asset, if available.

Type:

Optional[Asset]

property splash

Returns the guild’s invite splash asset, if available.

Type:

Optional[Asset]

property discovery_splash

Returns the guild’s discovery splash asset, if available.

Type:

Optional[Asset]

property member_count

Returns the true member count regardless of it being loaded fully or not.

Warning

Due to a Discord limitation, in order for this attribute to remain up-to-date and accurate, it requires Intents.members to be specified.

Type:

int

property region

The region the guild belongs on.

Deprecated since version 2.5: VoiceRegion is no longer set on the guild, and is set on the individual voice channels instead. See VoiceChannel.rtc_region and StageChannel.rtc_region instead.

Changed in version 2.5: No longer a VoiceRegion instance.

Type:

Optional[str]

property chunked

Whether the guild is “chunked”.

A chunked guild means that member_count is equal to the number of members stored in the internal members cache.

If this value returns False, then you should request for offline members.

Type:

bool

property shard_id

Returns the shard ID for this guild if applicable.

Type:

int

property created_at

Returns the guild’s creation time in UTC.

Type:

datetime.datetime

get_member_named(name, /)

Returns the first member found that matches the name provided.

The name can have an optional discriminator argument, e.g. “Jake#0001” or “Jake” will both do the lookup. However the former will give a more precise result. Note that the discriminator must have all 4 digits for this to work.

If a nickname is passed, then it is looked up via the nickname. Note however, that a nickname + discriminator combo will not lookup the nickname but rather the username + discriminator combo due to nickname + discriminator not being unique.

If no member is found, None is returned.

Parameters:

name (str) – The name of the member to lookup with an optional discriminator.

Returns:

The member in this guild with the associated name. If not found then None is returned.

Return type:

Optional[Member]

await create_text_channel(name, *, reason=None, category=None, position=..., topic=..., slowmode_delay=..., default_thread_slowmode_delay=..., default_auto_archive_duration=..., nsfw=..., news=..., overwrites=...)

This function is a coroutine.

Creates a TextChannel for the guild.

You need manage_channels permission to create the channel.

The overwrites parameter can be used to create a ‘secret’ channel upon creation. This parameter expects a dict of overwrites with the target (either a Member or a Role) as the key and a PermissionOverwrite as the value.

Note

Creating a channel of a specified position will not update the position of other channels to follow suit. A follow-up call to edit() will be required to update the position of the channel in the channel list.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Examples

Creating a basic channel:

channel = await guild.create_text_channel('cool-channel')

Creating a “secret” channel:

overwrites = {
    guild.default_role: disnake.PermissionOverwrite(view_channel=False),
    guild.me: disnake.PermissionOverwrite(view_channel=True)
}

channel = await guild.create_text_channel('secret', overwrites=overwrites)

Parameters:

• name (str) – The channel’s name.

• overwrites (Dict[Union[Role, Member], PermissionOverwrite]) – A dict of target (either a role or a member) to PermissionOverwrite to apply upon creation of a channel. Useful for creating secret channels.

• category (Optional[CategoryChannel]) – The category to place the newly created channel under. The permissions will be automatically synced to category if no overwrites are provided.

• position (int) – The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

• topic (Optional[str]) – The channel’s topic.

• slowmode_delay (int) – Specifies the slowmode rate limit for users in this channel, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If not provided, slowmode is disabled.

• default_thread_slowmode_delay (int) –

  Specifies the slowmode rate limit at which users can send messages in newly created threads in this channel, in seconds. A value of 0 disables slowmode by default. The maximum value possible is 21600. If not provided, slowmode is disabled.

  New in version 2.8.

• default_auto_archive_duration (Union[int, ThreadArchiveDuration]) –

  The default auto archive duration in minutes for threads created in this channel. Must be one of 60, 1440, 4320, or 10080.

  New in version 2.5.

• nsfw (bool) – Whether to mark the channel as NSFW.

• news (bool) –

  Whether to make a news channel. News channels are text channels that can be followed. This is only available to guilds that contain NEWS in Guild.features.

  New in version 2.5.

• reason (Optional[str]) – The reason for creating this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

• TypeError – The permission overwrite information is not in proper form.

Returns:

The channel that was just created.

Return type:

TextChannel

await create_voice_channel(name, *, reason=None, category=None, position=..., bitrate=..., user_limit=..., rtc_region=..., video_quality_mode=..., nsfw=..., slowmode_delay=..., overwrites=...)

This function is a coroutine.

This is similar to create_text_channel() except makes a VoiceChannel instead.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• name (str) – The channel’s name.

• overwrites (Dict[Union[Role, Member], PermissionOverwrite]) – A dict of target (either a role or a member) to PermissionOverwrite to apply upon creation of a channel. Useful for creating secret channels.

• category (Optional[CategoryChannel]) – The category to place the newly created channel under. The permissions will be automatically synced to category if no overwrites are provided.

• position (int) – The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

• bitrate (int) – The channel’s preferred audio bitrate in bits per second.

• user_limit (int) – The channel’s limit for number of members that can be in a voice channel.

• rtc_region (Optional[Union[str, VoiceRegion]]) –

  The region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

  New in version 1.7.

• video_quality_mode (VideoQualityMode) –

  The camera video quality for the voice channel’s participants.

  New in version 2.0.

• nsfw (bool) –

  Whether to mark the channel as NSFW.

  New in version 2.5.

• slowmode_delay (int) –

  Specifies the slowmode rate limit for users in this channel, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If not provided, slowmode is disabled.

  New in version 2.6.

• reason (Optional[str]) – The reason for creating this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

• TypeError – The permission overwrite information is not in proper form.

Returns:

The channel that was just created.

Return type:

VoiceChannel

await create_stage_channel(name, *, topic=..., position=..., bitrate=..., overwrites=..., category=None, rtc_region=..., reason=None)

This function is a coroutine.

This is similar to create_text_channel() except makes a StageChannel instead.

New in version 1.7.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• name (str) – The channel’s name.

• topic (Optional[str]) –

  The channel’s topic.

  Changed in version 2.5: This is no longer required to be provided.

• overwrites (Dict[Union[Role, Member], PermissionOverwrite]) – A dict of target (either a role or a member) to PermissionOverwrite to apply upon creation of a channel. Useful for creating secret channels.

• category (Optional[CategoryChannel]) – The category to place the newly created channel under. The permissions will be automatically synced to category if no overwrites are provided.

• position (int) – The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

• bitrate (int) –

  The channel’s preferred audio bitrate in bits per second.

  New in version 2.6.

• rtc_region (Optional[Union[str, VoiceRegion]]) –

  The region for the stage channel’s voice communication. A value of None indicates automatic voice region detection.

  New in version 2.5.

• reason (Optional[str]) – The reason for creating this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

• TypeError – The permission overwrite information is not in proper form.

Returns:

The channel that was just created.

Return type:

StageChannel

await create_forum_channel(name, *, topic=None, category=None, position=..., slowmode_delay=..., default_thread_slowmode_delay=..., default_auto_archive_duration=None, nsfw=..., overwrites=..., available_tags=None, default_reaction=None, default_sort_order=None, reason=None)

This function is a coroutine.

This is similar to create_text_channel() except makes a ForumChannel instead.

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• name (str) – The channel’s name.

• topic (Optional[str]) – The channel’s topic.

• category (Optional[CategoryChannel]) – The category to place the newly created channel under. The permissions will be automatically synced to category if no overwrites are provided.

• position (int) – The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

• slowmode_delay (int) – Specifies the slowmode rate limit at which users can create threads in this channel, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If not provided, slowmode is disabled.

• default_thread_slowmode_delay (int) –

  Specifies the slowmode rate limit at which users can send messages in newly created threads in this channel, in seconds. A value of 0 disables slowmode by default. The maximum value possible is 21600. If not provided, slowmode is disabled.

  New in version 2.6.

• default_auto_archive_duration (Union[int, ThreadArchiveDuration]) – The default auto archive duration in minutes for threads created in this channel. Must be one of 60, 1440, 4320, or 10080.

• nsfw (bool) – Whether to mark the channel as NSFW.

• overwrites (Dict[Union[Role, Member], PermissionOverwrite]) – A dict of target (either a role or a member) to PermissionOverwrite to apply upon creation of a channel. Useful for creating secret channels.

• available_tags (Optional[Sequence[ForumTag]]) –

  The tags available for threads in this channel.

  New in version 2.6.

• default_reaction (Optional[Union[str, Emoji, PartialEmoji]]) –

  The default emoji shown for reacting to threads.

  New in version 2.6.

• default_sort_order (Optional[ThreadSortOrder]) –

  The default sort order of threads in this channel.

  New in version 2.6.

• reason (Optional[str]) – The reason for creating this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

• TypeError – The permission overwrite information is not in proper form.

Returns:

The channel that was just created.

Return type:

ForumChannel

await create_category(name, *, overwrites=..., reason=None, position=...)

This function is a coroutine.

Same as create_text_channel() except makes a CategoryChannel instead.

Note

The category parameter is not supported in this function since categories cannot have categories.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• name (str) – The category’s name.

• overwrites (Dict[Union[Role, Member], PermissionOverwrite]) – A dict of target (either a role or a member) to PermissionOverwrite which can be synced to channels.

• position (int) – The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

• reason (Optional[str]) – The reason for creating this category. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

• TypeError – The permission overwrite information is not in proper form.

Returns:

The channel that was just created.

Return type:

CategoryChannel

await create_category_channel(name, *, overwrites=..., reason=None, position=...)

This function is a coroutine.

Same as create_text_channel() except makes a CategoryChannel instead.

Note

The category parameter is not supported in this function since categories cannot have categories.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• name (str) – The category’s name.

• overwrites (Dict[Union[Role, Member], PermissionOverwrite]) – A dict of target (either a role or a member) to PermissionOverwrite which can be synced to channels.

• position (int) – The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

• reason (Optional[str]) – The reason for creating this category. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

• TypeError – The permission overwrite information is not in proper form.

Returns:

The channel that was just created.

Return type:

CategoryChannel

await leave()

This function is a coroutine.

Leaves the guild.

Note

You cannot leave the guild that you own, you must delete it instead via delete().

Raises:

HTTPException – Leaving the guild failed.

await delete()

This function is a coroutine.

Deletes the guild. You must be the guild owner to delete the guild.

Raises:

• HTTPException – Deleting the guild failed.

• Forbidden – You do not have permissions to delete the guild.

await edit(*, reason=..., name=..., description=..., icon=..., banner=..., splash=..., discovery_splash=..., community=..., invites_disabled=..., afk_channel=..., owner=..., afk_timeout=..., default_notifications=..., verification_level=..., explicit_content_filter=..., vanity_code=..., system_channel=..., system_channel_flags=..., preferred_locale=..., rules_channel=..., public_updates_channel=..., premium_progress_bar_enabled=...)

This function is a coroutine.

Edits the guild.

You must have manage_guild permission to use this.

Changed in version 1.4: The rules_channel and public_updates_channel keyword-only parameters were added.

Changed in version 2.0: The discovery_splash and community keyword-only parameters were added.

Changed in version 2.0: The newly updated guild is returned.

Changed in version 2.5: Removed the region parameter. Use VoiceChannel.edit() or StageChannel.edit() with rtc_region instead.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• name (str) – The new name of the guild.

• description (Optional[str]) – The new description of the guild. Could be None for no description. This is only available to guilds that contain COMMUNITY in Guild.features.

• icon (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The new guild icon. Only PNG/JPG is supported. GIF is only available to guilds that contain ANIMATED_ICON in Guild.features. Could be None to denote removal of the icon.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• banner (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The new guild banner. GIF is only available to guilds that contain ANIMATED_BANNER in Guild.features. Could be None to denote removal of the banner. This is only available to guilds that contain BANNER in Guild.features.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• splash (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The new guild invite splash. Only PNG/JPG is supported. Could be None to denote removing the splash. This is only available to guilds that contain INVITE_SPLASH in Guild.features.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• discovery_splash (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The new guild discovery splash. Only PNG/JPG is supported. Could be None to denote removing the splash. This is only available to guilds that contain DISCOVERABLE in Guild.features.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• community (bool) – Whether the guild should be a Community guild. If set to True, both rules_channel and public_updates_channel parameters are required.

• invites_disabled (bool) –

  Whether the guild has paused invites, preventing new users from joining.

  This is only available to guilds that contain COMMUNITY in Guild.features.

  This cannot be changed at the same time as the community feature due a Discord API limitation.

  New in version 2.6.

• afk_channel (Optional[VoiceChannel]) – The new channel that is the AFK channel. Could be None for no AFK channel.

• afk_timeout (int) – The number of seconds until someone is moved to the AFK channel. This can be set to 60, 300, 900, 1800, and 3600.

• owner (Member) – The new owner of the guild to transfer ownership to. Note that you must be owner of the guild to do this.

• verification_level (VerificationLevel) – The new verification level for the guild.

• default_notifications (NotificationLevel) – The new default notification level for the guild.

• explicit_content_filter (ContentFilter) – The new explicit content filter for the guild.

• vanity_code (str) – The new vanity code for the guild.

• system_channel (Optional[TextChannel]) – The new channel that is used for the system channel. Could be None for no system channel.

• system_channel_flags (SystemChannelFlags) – The new system channel settings to use with the new system channel.

• preferred_locale (Locale) –

  The new preferred locale for the guild. Used as the primary language in the guild.

  Changed in version 2.5: Changed to Locale instead of str.

• rules_channel (Optional[TextChannel]) – The new channel that is used for rules. This is only available to guilds that contain COMMUNITY in Guild.features. Could be None for no rules channel.

• public_updates_channel (Optional[TextChannel]) – The new channel that is used for public updates from Discord. This is only available to guilds that contain COMMUNITY in Guild.features. Could be None for no public updates channel.

• premium_progress_bar_enabled (bool) – Whether the server boost progress bar is enabled.

• reason (Optional[str]) – The reason for editing this guild. Shows up on the audit log.

Raises:

• NotFound – At least one of the assets (icon, banner, splash or discovery_splash) couldn’t be found.

• Forbidden – You do not have permissions to edit the guild.

• HTTPException – Editing the guild failed.

• TypeError – At least one of the assets (icon, banner, splash or discovery_splash) is a lottie sticker (see Sticker.read()), or one of the parameters default_notifications, verification_level, explicit_content_filter, or system_channel_flags was of the incorrect type.

• ValueError – community was set without setting both rules_channel and public_updates_channel parameters, or if you are not the owner of the guild and request an ownership transfer, or the image format passed in to icon is invalid, or both community and invites_disabled were provided.

Returns:

The newly updated guild. Note that this has the same limitations as mentioned in Client.fetch_guild() and may not have full data.

Return type:

Guild

await fetch_channels()

This function is a coroutine.

Retrieves all abc.GuildChannel that the guild has.

Note

This method is an API call. For general usage, consider channels instead.

New in version 1.2.

Raises:

• InvalidData – An unknown channel type was received from Discord.

• HTTPException – Retrieving the channels failed.

Returns:

All channels that the guild has.

Return type:

Sequence[abc.GuildChannel]

await active_threads()

This function is a coroutine.

Returns a list of active Thread that the client can access.

This includes both private and public threads.

New in version 2.0.

Raises:

HTTPException – The request to get the active threads failed.

Returns:

The active threads.

Return type:

List[Thread]

await fetch_scheduled_events(*, with_user_count=False)

This function is a coroutine.

Retrieves a list of all GuildScheduledEvent instances that the guild has.

New in version 2.3.

Parameters:

with_user_count (bool) – Whether to include number of users subscribed to each event.

Raises:

HTTPException – Retrieving the guild scheduled events failed.

Returns:

The existing guild scheduled events.

Return type:

List[GuildScheduledEvent]

await fetch_scheduled_event(event_id, *, with_user_count=False)

This function is a coroutine.

Retrieves a GuildScheduledEvent with the given ID.

New in version 2.3.

Parameters:

• event_id (int) – The ID to look for.

• with_user_count (bool) – Whether to include number of users subscribed to the event.

Raises:

HTTPException – Retrieving the guild scheduled event failed.

Returns:

The guild scheduled event.

Return type:

GuildScheduledEvent

await create_scheduled_event(*, name, scheduled_start_time, channel=..., entity_type=..., scheduled_end_time=..., privacy_level=..., entity_metadata=..., description=..., image=..., reason=None)

This function is a coroutine.

Creates a GuildScheduledEvent.

You must have Permissions.manage_events permission to do this.

Based on the channel/entity type, there are different restrictions regarding other parameter values, as shown in this table:

channel	entity_type	scheduled_end_time	entity_metadata with location
abc.Snowflake with type attribute being ChannelType.voice	voice (set automatically)	optional	unset
abc.Snowflake with type attribute being ChannelType.stage_voice	stage_instance (set automatically)	optional	unset
abc.Snowflake with missing/other type attribute	required	optional	unset
None	external (set automatically)	required	required
unset	external	required	required

New in version 2.3.

Changed in version 2.6: Now raises TypeError instead of ValueError for invalid parameter types.

Changed in version 2.6: Removed channel_id parameter in favor of channel.

Changed in version 2.6: Naive datetime parameters are now assumed to be in the local timezone instead of UTC.

Changed in version 2.6: Infer entity_type from channel if provided.

Parameters:

• name (str) – The name of the guild scheduled event.

• description (str) – The description of the guild scheduled event.

• image (Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]) –

  The cover image of the guild scheduled event.

  New in version 2.4.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• channel (Optional[abc.Snowflake]) –

  The channel in which the guild scheduled event will be hosted. Passing in None assumes the entity_type to be GuildScheduledEventEntityType.external

  New in version 2.6.

• privacy_level (GuildScheduledEventPrivacyLevel) – The privacy level of the guild scheduled event.

• scheduled_start_time (datetime.datetime) – The time to schedule the guild scheduled event. If the datetime is naive, it is assumed to be local time.

• scheduled_end_time (Optional[datetime.datetime]) – The time when the guild scheduled event is scheduled to end. If the datetime is naive, it is assumed to be local time.

• entity_type (GuildScheduledEventEntityType) – The entity type of the guild scheduled event.

• entity_metadata (GuildScheduledEventMetadata) – The entity metadata of the guild scheduled event.

• reason (Optional[str]) – The reason for creating the guild scheduled event. Shows up on the audit log.

Raises:

• NotFound – The image asset couldn’t be found.

• HTTPException – The request failed.

• TypeError – The image asset is a lottie sticker (see Sticker.read()), one of entity_type, privacy_level, or entity_metadata is not of the correct type, or the entity_type was not provided and could not be assumed from the channel.

Returns:

The newly created guild scheduled event.

Return type:

GuildScheduledEvent

await welcome_screen()

This function is a coroutine.

Retrieves the guild’s WelcomeScreen.

Requires the manage_guild permission if the welcome screen is not enabled.

Note

To determine whether the welcome screen is enabled, check for the presence of WELCOME_SCREEN_ENABLED in Guild.features.

New in version 2.5.

Raises:

• NotFound – The welcome screen is not set up, or you do not have permission to view it.

• HTTPException – Retrieving the welcome screen failed.

Returns:

The guild’s welcome screen.

Return type:

WelcomeScreen

await edit_welcome_screen(*, enabled=..., channels=..., description=..., reason=None)

This function is a coroutine.

This is a lower level method to WelcomeScreen.edit() that allows you to edit the welcome screen without fetching it and save an API request.

This requires ‘COMMUNITY’ in Guild.features.

New in version 2.5.

Parameters:

• enabled (bool) – Whether the welcome screen is enabled.

• description (Optional[str]) – The new guild description in the welcome screen.

• channels (Optional[List[WelcomeScreenChannel]]) – The new welcome channels.

• reason (Optional[str]) – The reason for editing the welcome screen. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to change the welcome screen or the guild is not allowed to create welcome screens.

• HTTPException – Editing the welcome screen failed.

• TypeError – channels is not a list of WelcomeScreenChannel instances

Returns:

The newly edited welcome screen.

Return type:

WelcomeScreen

await fetch_member(member_id, /)

This function is a coroutine.

Retrieves a Member with the given ID.

Note

This method is an API call. If you have Intents.members and member cache enabled, consider get_member() instead.

Parameters:

member_id (int) – The member’s ID to fetch from.

Raises:

• Forbidden – You do not have access to the guild.

• HTTPException – Retrieving the member failed.

Returns:

The member from the member ID.

Return type:

Member

await fetch_ban(user)

This function is a coroutine.

Retrieves the BanEntry for a user.

You must have ban_members permission to use this.

Parameters:

user (abc.Snowflake) – The user to get ban information from.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• NotFound – This user is not banned.

• HTTPException – An error occurred while fetching the information.

Returns:

The BanEntry object for the specified user.

Return type:

BanEntry

await fetch_channel(channel_id, /)

This function is a coroutine.

Retrieves a abc.GuildChannel or Thread with the given ID.

Note

This method is an API call. For general usage, consider get_channel_or_thread() instead.

New in version 2.0.

Raises:

• InvalidData – An unknown channel type was received from Discord or the guild the channel belongs to is not the same as the one in this object points to.

• HTTPException – Retrieving the channel failed.

• NotFound – Invalid Channel ID.

• Forbidden – You do not have permission to fetch this channel.

Returns:

The channel from the ID.

Return type:

Union[abc.GuildChannel, Thread]

bans(*, limit=1000, before=None, after=None)

Returns an AsyncIterator that enables receiving the destination’s bans.

You must have the ban_members permission to get this information.

Changed in version 2.5: Due to a breaking change in Discord’s API, this now returns an AsyncIterator instead of a list.

Examples

Usage

counter = 0
async for ban in guild.bans(limit=200):
    if not ban.user.bot:
        counter += 1

Flattening into a list:

bans = await guild.bans(limit=123).flatten()
# bans is now a list of BanEntry...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of bans to retrieve. If None, it retrieves every ban in the guild. Note, however, that this would make it a slow operation. Defaults to 1000.

• before (Optional[Snowflake]) – Retrieve bans before this user.

• after (Optional[Snowflake]) – Retrieve bans after this user.

Raises:

• Forbidden – You do not have permissions to get the bans.

• HTTPException – An error occurred while fetching the bans.

Yields:

BanEntry – The ban with the ban data parsed.

await prune_members(*, days, compute_prune_count=True, roles=..., reason=None)

This function is a coroutine.

Prunes the guild from its inactive members.

The inactive members are denoted if they have not logged on in days number of days and they have no roles.

You must have kick_members permission to use this.

To check how many members you would prune without actually pruning, see the estimate_pruned_members() function.

To prune members that have specific roles see the roles parameter.

Changed in version 1.4: The roles keyword-only parameter was added.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• days (int) – The number of days before counting as inactive.

• compute_prune_count (bool) – Whether to compute the prune count. This defaults to True which makes it prone to timeouts in very large guilds. In order to prevent timeouts, you must set this to False. If this is set to False, then this function will always return None.

• roles (List[abc.Snowflake]) – A list of abc.Snowflake that represent roles to include in the pruning process. If a member has a role that is not specified, they’ll be excluded.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to prune members.

• HTTPException – An error occurred while pruning members.

• TypeError – An integer was not passed for days.

Returns:

The number of members pruned. If compute_prune_count is False then this returns None.

Return type:

Optional[int]

await templates()

This function is a coroutine.

Gets the list of templates from this guild.

You must have manage_guild permission to use this.

New in version 1.7.

Raises:

Forbidden – You don’t have permissions to get the templates.

Returns:

The templates for this guild.

Return type:

List[Template]

await webhooks()

This function is a coroutine.

Gets the list of webhooks from this guild.

You must have manage_webhooks permission to use this.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The webhooks for this guild.

Return type:

List[Webhook]

await estimate_pruned_members(*, days, roles=...)

This function is a coroutine.

Similar to prune_members() except instead of actually pruning members, it returns how many members it would prune from the guild had it been called.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• days (int) – The number of days before counting as inactive.

• roles (List[abc.Snowflake]) –

  A list of abc.Snowflake that represent roles to include in the estimate. If a member has a role that is not specified, they’ll be excluded.

  New in version 1.7.

Raises:

• Forbidden – You do not have permissions to prune members.

• HTTPException – An error occurred while fetching the prune members estimate.

• TypeError – An integer was not passed for days.

Returns:

The number of members estimated to be pruned.

Return type:

int

await invites()

This function is a coroutine.

Returns a list of all active instant invites from the guild.

You must have manage_guild permission to use this.

Note

This method does not include the guild’s vanity URL invite. To get the vanity URL Invite, refer to Guild.vanity_invite().

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

await create_template(*, name, description=...)

This function is a coroutine.

Creates a template for the guild.

You must have manage_guild permission to use this.

New in version 1.7.

Parameters:

• name (str) – The name of the template.

• description (str) – The description of the template.

Returns:

The created template.

Return type:

Template

await create_integration(*, type, id)

This function is a coroutine.

Deprecated since version 2.5: No longer supported, bots cannot use this endpoint anymore.

Attaches an integration to the guild.

You must have manage_guild permission to use this.

New in version 1.4.

Parameters:

• type (str) – The integration type (e.g. Twitch).

• id (int) – The integration ID.

Raises:

• Forbidden – You do not have permission to create the integration.

• HTTPException – The account could not be found.

await integrations()

This function is a coroutine.

Returns a list of all integrations attached to the guild.

You must have manage_guild permission to use this.

New in version 1.4.

Raises:

• Forbidden – You do not have permission to create the integration.

• HTTPException – Fetching the integrations failed.

Returns:

The list of integrations that are attached to the guild.

Return type:

List[Integration]

await fetch_stickers()

This function is a coroutine.

Retrieves a list of all Stickers that the guild has.

New in version 2.0.

Note

This method is an API call. For general usage, consider stickers instead.

Raises:

HTTPException – Retrieving the stickers failed.

Returns:

The retrieved stickers.

Return type:

List[GuildSticker]

await fetch_sticker(sticker_id, /)

This function is a coroutine.

Retrieves a custom Sticker from the guild.

New in version 2.0.

Note

This method is an API call. For general usage, consider iterating over stickers instead.

Parameters:

sticker_id (int) – The sticker’s ID.

Raises:

• NotFound – The sticker requested could not be found.

• HTTPException – Retrieving the sticker failed.

Returns:

The retrieved sticker.

Return type:

GuildSticker

await create_sticker(*, name, description=None, emoji, file, reason=None)

This function is a coroutine.

Creates a Sticker for the guild.

You must have manage_emojis_and_stickers permission to do this.

New in version 2.0.

Parameters:

• name (str) – The sticker name. Must be at least 2 characters.

• description (Optional[str]) – The sticker’s description. You can pass None or an empty string to not set a description.

• emoji (str) – The name of a unicode emoji that represents the sticker’s expression.

• file (File) – The file of the sticker to upload.

• reason (Optional[str]) – The reason for creating this sticker. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to create stickers.

• HTTPException – An error occurred creating a sticker.

Returns:

The newly created sticker.

Return type:

GuildSticker

await delete_sticker(sticker, *, reason=None)

This function is a coroutine.

Deletes the custom Sticker from the guild.

You must have manage_emojis_and_stickers permission to do this.

New in version 2.0.

Parameters:

• sticker (abc.Snowflake) – The sticker you are deleting.

• reason (Optional[str]) – The reason for deleting this sticker. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to delete stickers.

• HTTPException – An error occurred deleting the sticker.

await fetch_emojis()

This function is a coroutine.

Retrieves all custom Emojis that the guild has.

Note

This method is an API call. For general usage, consider emojis instead.

Raises:

HTTPException – Retrieving the emojis failed.

Returns:

The retrieved emojis.

Return type:

List[Emoji]

await fetch_emoji(emoji_id, /)

This function is a coroutine.

Retrieves a custom Emoji from the guild.

Note

This method is an API call. For general usage, consider iterating over emojis instead.

Parameters:

emoji_id (int) – The emoji’s ID.

Raises:

• NotFound – The emoji requested could not be found.

• HTTPException – An error occurred fetching the emoji.

Returns:

The retrieved emoji.

Return type:

Emoji

await create_custom_emoji(*, name, image, roles=..., reason=None)

This function is a coroutine.

Creates a custom Emoji for the guild.

Depending on the boost level of your guild (which can be obtained via premium_tier), the amount of custom emojis that can be created changes:

Boost level	Max custom emoji limit
0	50
1	100
2	150
3	250

You must have manage_emojis permission to do this.

Parameters:

• name (str) – The emoji name. Must be at least 2 characters.

• image (Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]) –

  The image data of the emoji. Only JPG, PNG and GIF images are supported.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• roles (List[Role]) – A list of Roles that can use this emoji. Leave empty to make it available to everyone.

• reason (Optional[str]) – The reason for creating this emoji. Shows up on the audit log.

Raises:

• NotFound – The image asset couldn’t be found.

• Forbidden – You are not allowed to create emojis.

• HTTPException – An error occurred creating an emoji.

• TypeError – The image asset is a lottie sticker (see Sticker.read()).

• ValueError – Wrong image format passed for image.

Returns:

The newly created emoji.

Return type:

Emoji

await delete_emoji(emoji, *, reason=None)

This function is a coroutine.

Deletes the custom Emoji from the guild.

You must have manage_emojis permission to do this.

Parameters:

• emoji (abc.Snowflake) – The emoji you are deleting.

• reason (Optional[str]) – The reason for deleting this emoji. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to delete emojis.

• HTTPException – An error occurred deleting the emoji.

await fetch_roles()

This function is a coroutine.

Retrieves all Role that the guild has.

Note

This method is an API call. For general usage, consider roles instead.

New in version 1.3.

Raises:

HTTPException – Retrieving the roles failed.

Returns:

All roles that the guild has.

Return type:

List[Role]

await get_or_fetch_member(member_id, *, strict=False)

This function is a coroutine.

Tries to get a member from the cache with the given ID. If fails, it fetches the member from the API and caches it.

If you want to make a bulk get-or-fetch call, use get_or_fetch_members().

Parameters:

• member_id (int) – The ID to search for.

• strict (bool) – Whether to propagate exceptions from fetch_member() instead of returning None in case of failure (e.g. if the member wasn’t found). Defaults to False.

Returns:

The member with the given ID, or None if not found and strict is set to False.

Return type:

Optional[Member]

await getch_member(member_id, *, strict=False)

This function is a coroutine.

Tries to get a member from the cache with the given ID. If fails, it fetches the member from the API and caches it.

If you want to make a bulk get-or-fetch call, use get_or_fetch_members().

Parameters:

• member_id (int) – The ID to search for.

• strict (bool) – Whether to propagate exceptions from fetch_member() instead of returning None in case of failure (e.g. if the member wasn’t found). Defaults to False.

Returns:

The member with the given ID, or None if not found and strict is set to False.

Return type:

Optional[Member]

await create_role(*, name=..., permissions=..., color=..., colour=..., hoist=..., icon=..., emoji=..., mentionable=..., reason=None)

This function is a coroutine.

Creates a Role for the guild.

All fields are optional.

You must have manage_roles permission to do this.

Changed in version 1.6: Can now pass int to colour keyword-only parameter.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• name (str) – The role name. Defaults to ‘new role’.

• permissions (Permissions) – The permissions the role should have. Defaults to no permissions.

• colour (Union[Colour, int]) – The colour for the role. Defaults to Colour.default(). This is aliased to color as well.

• hoist (bool) – Whether the role should be shown separately in the member list. Defaults to False.

• icon (Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]) –

  The role’s icon image (if the guild has the ROLE_ICONS feature).

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• emoji (str) – The role’s unicode emoji.

• mentionable (bool) – Whether the role should be mentionable by others. Defaults to False.

• reason (Optional[str]) – The reason for creating this role. Shows up on the audit log.

Raises:

• NotFound – The icon asset couldn’t be found.

• Forbidden – You do not have permissions to create the role.

• HTTPException – Creating the role failed.

• TypeError – An invalid keyword argument was given, or the icon asset is a lottie sticker (see Sticker.read()).

Returns:

The newly created role.

Return type:

Role

await edit_role_positions(positions, *, reason=None)

This function is a coroutine.

Bulk edits a list of Role in the guild.

You must have manage_roles permission to do this.

New in version 1.4.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Example:

positions = {
    bots_role: 1, # penultimate role
    tester_role: 2,
    admin_role: 6
}

await guild.edit_role_positions(positions=positions)

Parameters:

• positions – A dict of Role to int to change the positions of each given role.

• reason (Optional[str]) – The reason for editing the role positions. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to move the roles.

• HTTPException – Moving the roles failed.

• TypeError – An invalid keyword argument was given.

Returns:

A list of all the roles in the guild.

Return type:

List[Role]

await kick(user, *, reason=None)

This function is a coroutine.

Kicks a user from the guild.

The user must meet the abc.Snowflake abc.

You must have kick_members permission to do this.

Parameters:

• user (abc.Snowflake) – The user to kick from the guild.

• reason (Optional[str]) – The reason for kicking this user. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to kick.

• HTTPException – Kicking failed.

await ban(user, *, clean_history_duration=..., delete_message_days=..., reason=None)

This function is a coroutine.

Bans a user from the guild.

The user must meet the abc.Snowflake abc.

You must have ban_members permission to do this.

Parameters:

• user (abc.Snowflake) – The user to ban from the guild.

• clean_history_duration (Union[int, datetime.timedelta]) –

  The timespan (seconds or timedelta) of messages to delete from the user in the guild, up to 7 days (604800 seconds). Defaults to 1 day (86400 seconds).

  This is incompatible with delete_message_days.

  New in version 2.6.

  Note

  This may not be accurate with small durations (e.g. a few minutes) and delete a couple minutes’ worth of messages more than specified.

• delete_message_days (int) –

  The number of days worth of messages to delete from the user in the guild. The minimum is 0 and the maximum is 7.

  This is incompatible with clean_history_duration.

  Deprecated since version 2.6: Use clean_history_duration instead.

• reason (Optional[str]) – The reason for banning this user. Shows up on the audit log.

Raises:

• TypeError – Both clean_history_duration and delete_message_days were provided, or clean_history_duration has an invalid type.

• Forbidden – You do not have the proper permissions to ban.

• HTTPException – Banning failed.

await unban(user, *, reason=None)

This function is a coroutine.

Unbans a user from the guild.

The user must meet the abc.Snowflake abc.

You must have ban_members permission to do this.

Parameters:

• user (abc.Snowflake) – The user to unban.

• reason (Optional[str]) – The reason for unbanning this user. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to unban.

• HTTPException – Unbanning failed.

await vanity_invite(*, use_cached=False)

This function is a coroutine.

Returns the guild’s special vanity invite.

The guild must have VANITY_URL in features.

If use_cached is False, then you must have manage_guild permission to use this.

Parameters:

use_cached (bool) –

Whether to use the cached Guild.vanity_url_code and attempt to convert it into a full invite.

Note

If set to True, the Invite.uses information will not be accurate.

New in version 2.5.

Raises:

• Forbidden – You do not have the proper permissions to get this.

• HTTPException – Retrieving the vanity invite failed.

Returns:

The special vanity invite. If None then the guild does not have a vanity invite set.

Return type:

Optional[Invite]

await widget()

This function is a coroutine.

Retrieves the widget of the guild.

Note

The guild must have the widget enabled to get this information.

Raises:

• Forbidden – The widget for this guild is disabled.

• HTTPException – Retrieving the widget failed.

Returns:

The guild’s widget.

Return type:

Widget

await widget_settings()

This function is a coroutine.

Retrieves the widget settings of the guild.

To edit the widget settings, you may also use edit_widget().

New in version 2.5.

Raises:

• Forbidden – You do not have permission to view the widget settings.

• HTTPException – Retrieving the widget settings failed.

Returns:

The guild’s widget settings.

Return type:

WidgetSettings

await edit_widget(*, enabled=..., channel=..., reason=None)

This function is a coroutine.

Edits the widget of the guild.

You must have manage_guild permission to use this.

New in version 2.0.

Changed in version 2.5: Returns the new widget settings.

Parameters:

• enabled (bool) – Whether to enable the widget for the guild.

• channel (Optional[Snowflake]) – The new widget channel. None removes the widget channel. If set, an invite link for this channel will be generated, which allows users to join the guild from the widget.

• reason (Optional[str]) –

  The reason for editing the widget. Shows up on the audit log.

  New in version 2.4.

Raises:

• Forbidden – You do not have permission to edit the widget.

• HTTPException – Editing the widget failed.

Returns:

The new widget settings.

Return type:

WidgetSettings

widget_image_url(style=<WidgetStyle.shield: 'shield'>)

Returns an URL to the widget’s .png image.

New in version 2.5.

Parameters:

style (WidgetStyle) – The widget style.

Returns:

The widget image URL.

Return type:

str

await edit_mfa_level(mfa_level, *, reason=None)

This function is a coroutine.

Edits the two-factor authentication level of the guild.

You must be the guild owner to use this.

New in version 2.6.

Parameters:

• mfa_level (int) – The new 2FA level. If set to 0, the guild does not require 2FA for their administrative members to take moderation actions. If set to 1, then 2FA is required.

• reason (Optional[str]) – The reason for editing the mfa level. Shows up on the audit log.

Raises:

• HTTPException – Editing the 2FA level failed.

• ValueError – You are not the owner of the guild.

await chunk(*, cache=True)

This function is a coroutine.

Returns a list of all guild members.

Requests all members that belong to this guild. In order to use this, Intents.members() must be enabled.

This is a websocket operation and can be slow.

New in version 1.5.

Parameters:

cache (bool) – Whether to cache the members as well.

Raises:

ClientException – The members intent is not enabled.

Returns:

Returns a list of all the members within the guild.

Return type:

Optional[List[Member]]

await query_members(query=None, *, limit=5, user_ids=None, presences=False, cache=True)

This function is a coroutine.

Request members that belong to this guild whose username starts with the query given.

This is a websocket operation and can be slow.

See also search_members().

New in version 1.3.

Parameters:

• query (Optional[str]) – The string that the username’s start with.

• limit (int) – The maximum number of members to send back. This must be a number between 5 and 100.

• presences (bool) –

  Whether to request for presences to be provided. This defaults to False.

  New in version 1.6.

• cache (bool) – Whether to cache the members internally. This makes operations such as get_member() work for those that matched.

• user_ids (Optional[List[int]]) –

  List of user IDs to search for. If the user ID is not in the guild then it won’t be returned.

  New in version 1.4.

Raises:

• asyncio.TimeoutError – The query timed out waiting for the members.

• ValueError – Invalid parameters were passed to the function

• ClientException – The presences intent is not enabled.

Returns:

The list of members that have matched the query.

Return type:

List[Member]

await search_members(query, *, limit=1, cache=True)

This function is a coroutine.

Retrieves members that belong to this guild whose username or nickname starts with the query given.

Note that unlike query_members(), this is not a websocket operation, but an HTTP operation.

See also query_members().

New in version 2.5.

Parameters:

• query (str) – The string that the usernames or nicknames start with.

• limit (int) – The maximum number of members to send back. This must be a number between 1 and 1000.

• cache (bool) – Whether to cache the members internally. This makes operations such as get_member() work for those that matched.

Raises:

ValueError – Invalid parameters were passed to the function

Returns:

The list of members that have matched the query.

Return type:

List[Member]

await get_or_fetch_members(user_ids, *, presences=False, cache=True)

This function is a coroutine.

Tries to get the guild members matching the provided IDs from cache. If some of them were not found, the method requests the missing members using websocket operations. If cache kwarg is True (default value) the missing members will be cached.

If more than 100 members are missing, several websocket operations are made.

Websocket operations can be slow, however, this method is cheaper than multiple get_or_fetch_member() calls.

New in version 2.4.

Parameters:

• user_ids (List[int]) – List of user IDs to search for. If the user ID is not in the guild then it won’t be returned.

• presences (bool) – Whether to request for presences to be provided. Defaults to False.

• cache (bool) – Whether to cache the missing members internally. This makes operations such as get_member() work for those that matched. It also speeds up this method on repeated calls. Defaults to True.

Raises:

• asyncio.TimeoutError – The query timed out waiting for the members.

• ClientException – The presences intent is not enabled.

Returns:

The list of members with the given IDs, if they exist.

Return type:

List[Member]

await getch_members(user_ids, *, presences=False, cache=True)

This function is a coroutine.

Tries to get the guild members matching the provided IDs from cache. If some of them were not found, the method requests the missing members using websocket operations. If cache kwarg is True (default value) the missing members will be cached.

If more than 100 members are missing, several websocket operations are made.

Websocket operations can be slow, however, this method is cheaper than multiple get_or_fetch_member() calls.

New in version 2.4.

Parameters:

• user_ids (List[int]) – List of user IDs to search for. If the user ID is not in the guild then it won’t be returned.

• presences (bool) – Whether to request for presences to be provided. Defaults to False.

• cache (bool) – Whether to cache the missing members internally. This makes operations such as get_member() work for those that matched. It also speeds up this method on repeated calls. Defaults to True.

Raises:

• asyncio.TimeoutError – The query timed out waiting for the members.

• ClientException – The presences intent is not enabled.

Returns:

The list of members with the given IDs, if they exist.

Return type:

List[Member]

await fetch_voice_regions()

This function is a coroutine.

Retrieves a list of VoiceRegion for this guild.

New in version 2.5.

Raises:

HTTPException – Retrieving voice regions failed.

await change_voice_state(*, channel, self_mute=False, self_deaf=False)

This function is a coroutine.

Changes client’s voice state in the guild.

New in version 1.4.

Parameters:

• channel (Optional[VoiceChannel]) – The channel the client wants to join. Use None to disconnect.

• self_mute (bool) – Whether the client should be self-muted.

• self_deaf (bool) – Whether the client should be self-deafened.

await bulk_fetch_command_permissions()

This function is a coroutine.

Requests a list of GuildApplicationCommandPermissions configured for this guild.

New in version 2.1.

await fetch_command_permissions(command_id)

This function is a coroutine.

Retrieves GuildApplicationCommandPermissions for a specific command.

New in version 2.1.

Parameters:

command_id (int) –

The ID of the application command, or the application ID to fetch application-wide permissions.

Changed in version 2.5: Can now also fetch application-wide permissions.

Returns:

The application command permissions.

Return type:

GuildApplicationCommandPermissions

await timeout(user, *, duration=..., until=..., reason=None)

This function is a coroutine.

Times out the member from the guild; until then, the member will not be able to interact with the guild.

Exactly one of duration or until must be provided. To remove a timeout, set one of the parameters to None.

The user must meet the abc.Snowflake abc.

You must have the moderate_members permission to do this.

New in version 2.3.

Parameters:

• user (abc.Snowflake) – The member to timeout.

• duration (Optional[Union[float, datetime.timedelta]]) – The duration (seconds or timedelta) of the member’s timeout. Set to None to remove the timeout. Supports up to 28 days in the future. May not be used in combination with the until parameter.

• until (Optional[datetime.datetime]) – The expiry date/time of the member’s timeout. Set to None to remove the timeout. Supports up to 28 days in the future. May not be used in combination with the duration parameter.

• reason (Optional[str]) – The reason for this timeout. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to timeout this member.

• HTTPException – Timing out the member failed.

Returns:

The newly updated member.

Return type:

Member

await fetch_automod_rule(rule_id, /)

This function is a coroutine.

Retrieves an auto moderation rules from the guild. See also fetch_automod_rules().

Requires the manage_guild permission.

New in version 2.6.

Raises:

• Forbidden – You do not have proper permissions to retrieve auto moderation rules.

• NotFound – An auto moderation rule with the provided ID does not exist in the guild.

• HTTPException – Retrieving the rule failed.

Returns:

The auto moderation rule.

Return type:

AutoModRule

await fetch_automod_rules()

This function is a coroutine.

Retrieves the guild’s auto moderation rules. See also fetch_automod_rule().

Requires the manage_guild permission.

New in version 2.6.

Raises:

• Forbidden – You do not have proper permissions to retrieve auto moderation rules.

• NotFound – The guild does not have any auto moderation rules set up.

• HTTPException – Retrieving the rules failed.

Returns:

The guild’s auto moderation rules.

Return type:

List[AutoModRule]

await create_automod_rule(*, name, event_type, trigger_type, actions, trigger_metadata=None, enabled=False, exempt_roles=None, exempt_channels=None, reason=None)

This function is a coroutine.

Creates a new AutoModRule for the guild.

You must have Permissions.manage_guild permission to do this.

The maximum number of rules for each trigger type is limited, see the api docs for more details.

New in version 2.6.

Parameters:

• name (str) – The rule name.

• event_type (AutoModEventType) – The type of events that this rule will be applied to.

• trigger_type (AutoModTriggerType) – The type of trigger that determines whether this rule’s actions should run for a specific event. If set to keyword, keyword_preset, or mention_spam, trigger_metadata must be set accordingly. This cannot be changed after creation.

• actions (Sequence[Union[AutoModBlockMessageAction, AutoModSendAlertAction, AutoModTimeoutAction, AutoModAction]]) – The list of actions that will execute if a matching event triggered this rule. Must contain at least one action.

• trigger_metadata (Optional[AutoModTriggerMetadata]) – Additional metadata associated with the trigger type.

• enabled (bool) – Whether to enable the rule. Defaults to False.

• exempt_roles (Optional[Sequence[abc.Snowflake]]) – The roles that are exempt from this rule, up to 20. By default, no roles are exempt.

• exempt_channels (Optional[Sequence[abc.Snowflake]]) – The channels that are exempt from this rule, up to 50. By default, no channels are exempt. Can also include categories, in which case all channels inside that category will be exempt.

• reason (Optional[str]) – The reason for creating the rule. Shows up on the audit log.

Raises:

• ValueError – The specified trigger type requires trigger_metadata to be set, or no actions have been provided.

• Forbidden – You do not have proper permissions to create auto moderation rules.

• HTTPException – Creating the rule failed.

Returns:

The newly created auto moderation rule.

Return type:

AutoModRule

class disnake.BanEntry

A namedtuple which represents a ban returned from bans().

reason

The reason this user was banned.

Type:

Optional[str]

user

The User that was banned.

Type:

User

GuildBuilder

Attributes

• afk_channel
• afk_timeout
• default_notifications
• everyone
• explicit_content_filter
• icon
• name
• system_channel
• system_channel_flags
• verification_level

Methods

• defadd_category
• defadd_role
• defadd_text_channel
• defadd_voice_channel
• asynccreate
• defupdate_everyone_role

class disnake.GuildBuilder

A guild builder object, created by Client.guild_builder().

This allows for easier configuration of more complex guild setups, abstracting away some of the quirks of the guild creation endpoint.

New in version 2.8.

Note

Many methods of this class return unspecified placeholder IDs (called PlaceholderID below) that can be used to reference the created object in other objects, for example referencing a category when creating a new text channel, or a role when setting permission overwrites.

Examples

Basic usage:

builder = client.guild_builder("Cat Pics")
builder.add_text_channel("meow", topic="cat.")
guild = await builder.create()

Adding more channels + roles:

builder = client.guild_builder("More Cat Pics")
builder.add_text_channel("welcome")

# add roles
guests = builder.add_role("guests")
admins = builder.add_role(
    "catmins",
    permissions=Permissions(administrator=True),
    hoist=True,
)

# add cat-egory and text channel
category = builder.add_category("cats!")
meow_channel = builder.add_text_channel(
    "meow",
    topic="cat.",
    category=category,
    overwrites={guests: PermissionOverwrite(send_messages=False)}
)

# set as system channel
builder.system_channel = meow_channel

# add hidden voice channel
builder.add_voice_channel(
    "secret-admin-vc",
    category=category,
    overwrites={builder.everyone: PermissionOverwrite(view_channel=False)}
)

# finally, create the guild
guild = await builder.create()

name

The name of the new guild.

Type:

str

icon

The icon of the new guild.

Type:

Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]

verification_level

The verification level of the new guild.

Type:

Optional[VerificationLevel]

default_notifications

The default notification level for the new guild.

Type:

Optional[NotificationLevel]

explicit_content_filter

The explicit content filter for the new guild.

Type:

Optional[ContentFilter]

afk_channel

The channel that is used as the AFK channel.

Type:

Optional[PlaceholderID]

afk_timeout

The number of seconds until someone is moved to the AFK channel.

Type:

Optional[int]

system_channel

The channel that is used as the system channel.

Type:

Optional[PlaceholderID]

system_channel_flags

The settings to use with the system channel.

Type:

Optional[SystemChannelFlags]

property everyone

The placeholder ID used for the @everyone role.

Type:

PlaceholderID

await create()

This function is a coroutine.

Creates the configured guild.

Raises:

• NotFound – The icon asset couldn’t be found.

• HTTPException – Guild creation failed.

• ValueError – Invalid icon image format given. Must be PNG or JPG.

• TypeError – The icon asset is a lottie sticker (see Sticker.read).

Returns:

The created guild. This is not the same guild that is added to cache.

Note

Due to API limitations, this returned guild does not contain any of the configured channels.

Return type:

Guild

update_everyone_role(*, permissions=...)

Updates attributes of the @everyone role.

Parameters:

permissions (Permissions) – The permissions the role should have.

Returns:

The placeholder ID for the @everyone role. Also available as everyone.

Return type:

PlaceholderID

add_role(name=..., *, permissions=..., color=..., colour=..., hoist=..., mentionable=...)

Adds a role to the guild builder.

The default (@everyone) role can be referenced using everyone and configured through update_everyone_role().

Parameters:

• name (str) – The role name. Defaults to ‘new role’.

• permissions (Permissions) – The permissions the role should have. Defaults to no permissions.

• colour (Union[Colour, int]) – The colour for the role. Defaults to Colour.default(). This is aliased to color as well.

• hoist (bool) – Whether the role should be shown separately in the member list. Defaults to False.

• mentionable (bool) – Whether the role should be mentionable by others. Defaults to False.

Returns:

A placeholder ID for the created role.

Return type:

PlaceholderID

add_category(name, *, overwrites=...)

Adds a category channel to the guild builder.

There is an alias for this named add_category_channel.

Parameters:

• name (str) – The category’s name.

• overwrites (Dict[PlaceholderID, PermissionOverwrite]) – A dict of roles to PermissionOverwrites which can be synced to channels.

Returns:

A placeholder ID for the created category.

Return type:

PlaceholderID

add_text_channel(name, *, overwrites=..., category=..., topic=..., slowmode_delay=..., nsfw=..., default_auto_archive_duration=...)

Adds a text channel to the guild builder.

Parameters:

• name (str) – The channel’s name.

• overwrites (Dict[PlaceholderID, PermissionOverwrite]) – A dict of roles to PermissionOverwrites to apply to the channel.

• category (PlaceholderID) –

  The category to place the new channel under.

  Warning

  Unlike Guild.create_text_channel(), the parent category’s permissions will not be synced to this new channel by default.

• topic (Optional[str]) – The channel’s topic.

• slowmode_delay (int) – Specifies the slowmode rate limit for users in this channel, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If not provided, slowmode is disabled.

• nsfw (bool) – Whether to mark the channel as NSFW.

• default_auto_archive_duration (Union[int, ThreadArchiveDuration]) – The default auto archive duration in minutes for threads created in this channel. Must be one of 60, 1440, 4320, or 10080.

Returns:

A placeholder ID for the created text channel.

Return type:

PlaceholderID

add_voice_channel(name, *, overwrites=..., category=..., slowmode_delay=..., nsfw=..., bitrate=..., user_limit=..., rtc_region=..., video_quality_mode=...)

Adds a voice channel to the guild builder.

Parameters:

• name (str) – The channel’s name.

• overwrites (Dict[PlaceholderID, PermissionOverwrite]) – A dict of roles to PermissionOverwrites to apply to the channel.

• category (PlaceholderID) –

  The category to place the new channel under.

  Warning

  Unlike Guild.create_voice_channel(), the parent category’s permissions will not be synced to this new channel by default.

• slowmode_delay (int) – Specifies the slowmode rate limit for users in this channel, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If not provided, slowmode is disabled.

• nsfw (bool) – Whether to mark the channel as NSFW.

• bitrate (int) – The channel’s preferred audio bitrate in bits per second.

• user_limit (int) – The channel’s limit for number of members that can be in a voice channel.

• rtc_region (Optional[Union[str, VoiceRegion]]) – The region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

• video_quality_mode (VideoQualityMode) – The camera video quality for the voice channel’s participants.

Returns:

A placeholder ID for the created voice channel.

Return type:

PlaceholderID

GuildPreview

Attributes

• approximate_member_count
• approximate_presence_count
• description
• discovery_splash
• emojis
• features
• icon
• id
• name
• splash
• stickers

class disnake.GuildPreview

Represents a Guild preview object.

New in version 2.5.

name

The guild’s name.

Type:

str

emojis

All emojis that the guild owns.

Type:

Tuple[Emoji, …]

stickers

All stickers that the guild owns.

Type:

Tuple[GuildSticker, …]

id

The ID of the guild this preview represents.

Type:

int

description

The guild’s description.

Type:

Optional[str]

features

A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord.

See Guild.features for a list of features.

Type:

List[str]

approximate_member_count

The approximate number of members in the guild.

Type:

int

approximate_presence_count

The approximate number of members currently active in the guild. This includes idle, dnd, online, and invisible members. Offline members are excluded.

Type:

int

property icon

Returns the guild preview’s icon asset, if available.

Type:

Optional[Asset]

property splash

Returns the guild preview’s invite splash asset, if available.

Type:

Optional[Asset]

property discovery_splash

Returns the guild preview’s discovery splash asset, if available.

Type:

Optional[Asset]

GuildScheduledEvent

Attributes

• channel
• channel_id
• created_at
• creator
• creator_id
• description
• entity_id
• entity_metadata
• entity_type
• guild
• guild_id
• id
• image
• name
• privacy_level
• scheduled_end_time
• scheduled_start_time
• status
• url
• user_count

Methods

• asynccancel
• asyncdelete
• asyncedit
• asyncend
• asyncfetch_users
• asyncstart

class disnake.GuildScheduledEvent

Represents a guild scheduled event.

New in version 2.3.

x == y

Checks if two guild scheduled events are equal.

x != y

Checks if two guild scheduled events are not equal.

hash(x)

Returns the guild scheduled event’s hash.

id

The ID of the guild scheduled event.

Type:

int

guild_id

The guild ID which the guild scheduled event belongs to.

Type:

int

channel_id

The channel ID in which the guild scheduled event will be hosted. This field is None if entity_type is GuildScheduledEventEntityType.external.

Type:

Optional[int]

creator_id

The ID of the user that created the guild scheduled event. This field is None for events created before October 25th, 2021.

Type:

Optional[int]

creator

The user that created the guild scheduled event. This field is None for events created before October 25th, 2021.

Type:

Optional[User]

name

The name of the guild scheduled event (1-100 characters).

Type:

str

description

The description of the guild scheduled event (1-1000 characters).

Type:

str

scheduled_start_time

The time when the guild scheduled event will start.

Type:

datetime.datetime

scheduled_end_time

The time when the guild scheduled event will end, or None if the event does not have a scheduled time to end.

Type:

Optional[datetime.datetime]

privacy_level

The privacy level of the guild scheduled event.

Type:

GuildScheduledEventPrivacyLevel

status

The status of the guild scheduled event.

Type:

GuildScheduledEventStatus

entity_type

The type of the guild scheduled event.

Type:

GuildScheduledEventEntityType

entity_id

The ID of an entity associated with the guild scheduled event.

Type:

Optional[int]

entity_metadata

Additional metadata for the guild scheduled event.

Type:

GuildScheduledEventMetadata

user_count

The number of users subscribed to the guild scheduled event. If the guild scheduled event was fetched with with_user_count set to False, this field is None.

Type:

Optional[int]

property created_at

Returns the guild scheduled event’s creation time in UTC.

New in version 2.6.

Type:

datetime.datetime

property url

The guild scheduled event’s URL.

New in version 2.6.

Type:

str

guild

The guild which the guild scheduled event belongs to.

Type:

Optional[Guild]

channel

The channel in which the guild scheduled event will be hosted.

This will be None if entity_type is GuildScheduledEventEntityType.external.

Type:

Optional[abc.GuildChannel]

property image

The cover image asset of the guild scheduled event, if available.

Type:

Optional[Asset]

await delete()

This function is a coroutine.

Deletes the guild scheduled event.

You must have Permissions.manage_events permission to do this.

Raises:

• Forbidden – You do not have proper permissions to delete the event.

• NotFound – The event does not exist.

• HTTPException – Deleting the event failed.

await edit(*, name=..., description=..., image=..., channel=..., privacy_level=..., scheduled_start_time=..., scheduled_end_time=..., entity_type=..., entity_metadata=..., status=..., reason=None)

This function is a coroutine.

Edits the guild scheduled event.

You must have Permissions.manage_events permission to do this.

Changed in version 2.6: Updates must follow requirements of Guild.create_scheduled_event()

Changed in version 2.6: Now raises TypeError instead of ValueError for invalid parameter types.

Changed in version 2.6: Removed channel_id parameter in favor of channel.

Changed in version 2.6: Naive datetime parameters are now assumed to be in the local timezone instead of UTC.

Parameters:

• name (str) – The name of the guild scheduled event.

• description (Optional[str]) – The description of the guild scheduled event.

• image (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The cover image of the guild scheduled event. Set to None to remove the image.

  New in version 2.4.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• channel (Optional[abc.Snowflake]) –

  The channel in which the guild scheduled event will be hosted. Set to None if changing entity_type to GuildScheduledEventEntityType.external.

  New in version 2.6.

• privacy_level (GuildScheduledEventPrivacyLevel) – The privacy level of the guild scheduled event.

• scheduled_start_time (datetime.datetime) – The time to schedule the guild scheduled event. If the datetime is naive, it is assumed to be local time.

• scheduled_end_time (Optional[datetime.datetime]) – The time when the guild scheduled event is scheduled to end. If the datetime is naive, it is assumed to be local time.

• entity_type (GuildScheduledEventEntityType) – The entity type of the guild scheduled event.

• entity_metadata (Optional[GuildScheduledEventMetadata]) – The entity metadata of the guild scheduled event.

• status (GuildScheduledEventStatus) –

  The status of the guild scheduled event.

  See also start(), end(), and cancel().

• reason (Optional[str]) – The reason for editing the guild scheduled event. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to edit the event.

• NotFound – The event does not exist or the image asset couldn’t be found.

• HTTPException – Editing the event failed.

• TypeError – The image asset is a lottie sticker (see Sticker.read()), one of entity_type, privacy_level, entity_metadata or status is not of the correct type, or the provided channel’s type is neither ChannelType.voice nor ChannelType.stage_voice.

Returns:

The newly updated guild scheduled event instance.

Return type:

GuildScheduledEvent

await start(*, reason=None)

This function is a coroutine.

Starts the guild scheduled event.

Changes the event status to active.

You must have Permissions.manage_events permission to do this.

New in version 2.7.

Parameters:

reason (Optional[str]) – The reason for starting the guild scheduled event. Shows up on the audit log.

Raises:

• ValueError – The event has already started or ended, or was cancelled.

• Forbidden – You do not have permissions to start the event.

• HTTPException – Starting the event failed.

Returns:

The started guild scheduled event instance.

Return type:

GuildScheduledEvent

await end(*, reason=None)

This function is a coroutine.

Ends the guild scheduled event.

Changes the event status to completed.

You must have Permissions.manage_events permission to do this.

New in version 2.7.

Parameters:

reason (Optional[str]) – The reason for ending the guild scheduled event. Shows up on the audit log.

Raises:

• ValueError – The event has not started yet, has already ended, or was cancelled.

• Forbidden – You do not have permissions to end the event.

• HTTPException – Ending the event failed.

Returns:

The ended guild scheduled event instance.

Return type:

GuildScheduledEvent

await cancel(*, reason=None)

This function is a coroutine.

Cancels the guild scheduled event.

Changes the event status to cancelled.

You must have Permissions.manage_events permission to do this.

New in version 2.7.

Parameters:

reason (Optional[str]) – The reason for cancelling the guild scheduled event. Shows up on the audit log.

Raises:

• ValueError – The event has already started or ended, or was already cancelled.

• Forbidden – You do not have permissions to cancel the event.

• HTTPException – Cancelling the event failed.

Returns:

The cancelled guild scheduled event instance.

Return type:

GuildScheduledEvent

fetch_users(*, limit=None, with_members=True, before=None, after=None)

This function is a coroutine.

Returns an AsyncIterator of users subscribed to the guild scheduled event.

If before is specified, users are returned in reverse order, i.e. starting with the highest ID.

Changed in version 2.5: Now returns an AsyncIterator instead of a list of the first 100 users.

Parameters:

• limit (Optional[int]) – The number of users to retrieve.

• with_members (bool) – Whether to include some users as members. Defaults to True.

• before (Optional[abc.Snowflake]) – Retrieve users before this object.

• after (Optional[abc.Snowflake]) – Retrieve users after this object.

Raises:

• Forbidden – You do not have proper permissions to fetch the users.

• NotFound – The event does not exist.

• HTTPException – Retrieving the users failed.

Yields:

Union[User, Member] – The member (if retrievable) or user subscribed to the guild scheduled event.

Examples

Usage

async for user in event.fetch_users(limit=500):
    print(user.name)

Flattening into a list

users = await event.fetch_users(limit=250).flatten()

GuildScheduledEventMetadata

Attributes

• location

class disnake.GuildScheduledEventMetadata

Represents a guild scheduled event entity metadata.

New in version 2.3.

location

The location of the guild scheduled event. If GuildScheduledEvent.entity_type is GuildScheduledEventEntityType.external, this value is not None.

Type:

Optional[str]

Integration

class disnake.Integration

Represents a guild integration.

New in version 1.4.

id

The integration ID.

Type:

int

name

The integration name.

Type:

str

guild

The guild of the integration.

Type:

Guild

type

The integration type (i.e. Twitch).

Type:

str

enabled

Whether the integration is currently enabled.

Type:

bool

account

The account linked to this integration.

Type:

IntegrationAccount

user

The user that added this integration.

Type:

User

await delete(*, reason=None)

This function is a coroutine.

Deprecated since version 2.5: Can only be used on the application’s own integration and is therefore equivalent to leaving the guild.

Deletes the integration.

You must have manage_guild permission to use this.

Parameters:

reason (Optional[str]) –

The reason the integration was deleted. Shows up on the audit log.

New in version 2.0.

Raises:

• Forbidden – You do not have permission to delete the integration.

• HTTPException – Deleting the integration failed.

class disnake.IntegrationAccount

Represents an integration account.

New in version 1.4.

id

The account ID.

Type:

str

name

The account name.

Type:

str

class disnake.BotIntegration

Represents a bot integration on Discord.

New in version 2.0.

id

The integration ID.

Type:

int

name

The integration name.

Type:

str

guild

The guild of the integration.

Type:

Guild

type

The integration type (i.e. Twitch).

Type:

str

enabled

Whether the integration is currently enabled.

Type:

bool

user

The user that added this integration.

Type:

User

account

The integration account information.

Type:

IntegrationAccount

application

The application tied to this integration.

Type:

IntegrationApplication

scopes

The OAuth2 scopes the application has been authorized for.

New in version 2.6.

Type:

List[str]

await delete(*, reason=None)

This function is a coroutine.

Deprecated since version 2.5: Can only be used on the application’s own integration and is therefore equivalent to leaving the guild.

Deletes the integration.

You must have manage_guild permission to use this.

Parameters:

reason (Optional[str]) –

The reason the integration was deleted. Shows up on the audit log.

New in version 2.0.

Raises:

• Forbidden – You do not have permission to delete the integration.

• HTTPException – Deleting the integration failed.

class disnake.IntegrationApplication

Represents an application for a bot integration.

New in version 2.0.

id

The application’s ID.

Type:

int

name

The application’s name.

Type:

str

icon

The application’s icon hash.

Type:

Optional[str]

description

The application’s description. Can be an empty string.

Type:

str

user

The bot user associated with this application.

Type:

Optional[User]

property summary

The application’s summary. Can be an empty string.

Deprecated since version 2.5: This field is deprecated by discord and is now always blank. Consider using description instead.

Type:

str

class disnake.StreamIntegration

Represents a stream integration for Twitch or YouTube.

New in version 2.0.

id

The integration ID.

Type:

int

name

The integration name.

Type:

str

guild

The guild of the integration.

Type:

Guild

type

The integration type (i.e. Twitch).

Type:

str

enabled

Whether the integration is currently enabled.

Type:

bool

syncing

Whether the integration is currently syncing.

Type:

bool

enable_emoticons

Whether emoticons should be synced for this integration (currently twitch only).

Type:

Optional[bool]

expire_behaviour

The behaviour of expiring subscribers. Aliased to expire_behavior as well.

Type:

ExpireBehaviour

expire_grace_period

The grace period (in days) for expiring subscribers.

Type:

int

user

The user for the integration.

Type:

User

account

The integration account information.

Type:

IntegrationAccount

synced_at

An aware UTC datetime representing when the integration was last synced.

Type:

datetime.datetime

property expire_behavior

An alias for expire_behaviour.

Type:

ExpireBehaviour

property role

Optional[Role] The role which the integration uses for subscribers.

await edit(*, expire_behaviour=..., expire_grace_period=..., enable_emoticons=...)

This function is a coroutine.

Deprecated since version 2.5: No longer supported, bots cannot use this endpoint anymore.

Edits the integration.

You must have manage_guild permission to use this.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• expire_behaviour (ExpireBehaviour) – The behaviour when an integration subscription lapses. Aliased to expire_behavior as well.

• expire_grace_period (int) – The period (in days) where the integration will ignore lapsed subscriptions.

• enable_emoticons (bool) – Where emoticons should be synced for this integration (currently twitch only).

Raises:

• Forbidden – You do not have permission to edit the integration.

• HTTPException – Editing the guild failed.

• TypeError – expire_behaviour did not receive a ExpireBehaviour.

await sync()

This function is a coroutine.

Deprecated since version 2.5: No longer supported, bots cannot use this endpoint anymore.

Syncs the integration.

You must have manage_guild permission to use this.

Raises:

• Forbidden – You do not have permission to sync the integration.

• HTTPException – Syncing the integration failed.

await delete(*, reason=None)

This function is a coroutine.

Deprecated since version 2.5: Can only be used on the application’s own integration and is therefore equivalent to leaving the guild.

Deletes the integration.

You must have manage_guild permission to use this.

Parameters:

reason (Optional[str]) –

The reason the integration was deleted. Shows up on the audit log.

New in version 2.0.

Raises:

• Forbidden – You do not have permission to delete the integration.

• HTTPException – Deleting the integration failed.

class disnake.PartialIntegration

Represents a partial guild integration.

New in version 2.6.

id

The integration ID.

Type:

int

name

The integration name.

Type:

str

guild

The guild of the integration.

Type:

Guild

type

The integration type (i.e. Twitch).

Type:

str

account

The account linked to this integration.

Type:

IntegrationAccount

application_id

The ID of the application tied to this integration.

Type:

Optional[int]

Interaction

Attributes

• app_permissions
• application_id
• author
• bot
• channel
• channel_id
• client
• created_at
• data
• expires_at
• followup
• guild
• guild_id
• guild_locale
• id
• locale
• me
• permissions
• response
• token
• type
• user

Methods

• asyncdelete_original_message
• asyncdelete_original_response
• asyncedit_original_message
• asyncedit_original_response
• defis_expired
• asyncoriginal_message
• asyncoriginal_response
• asyncsend

class disnake.Interaction

A base class representing a user-initiated Discord interaction.

An interaction happens when a user performs an action that the client needs to be notified of. Current examples are application commands and components.

New in version 2.0.

data

The interaction’s raw data. This might be replaced with a more processed version in subclasses.

Type:

Mapping[str, Any]

id

The interaction’s ID.

Type:

int

type

The interaction’s type.

Type:

InteractionType

application_id

The application ID that the interaction was for.

Type:

int

guild_id

The guild ID the interaction was sent from.

Type:

Optional[int]

guild_locale

The selected language of the interaction’s guild. This value is only meaningful in guilds with COMMUNITY feature and receives a default value otherwise. If the interaction was in a DM, then this value is None.

New in version 2.4.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Optional[Locale]

channel_id

The channel ID the interaction was sent from.

Type:

int

author

The user or member that sent the interaction.

Type:

Union[User, Member]

locale

The selected language of the interaction’s author.

New in version 2.4.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Locale

token

The token to continue the interaction. These are valid for 15 minutes.

Type:

str

client

The interaction client.

Type:

Client

original_message()

An alias of original_response().

edit_original_message()

An alias of edit_original_response().

delete_original_message()

An alias of delete_original_response().

property bot

The bot handling the interaction.

Only applicable when used with Bot. This is an alias for client.

Type:

Bot

property created_at

Returns the interaction’s creation time in UTC.

Type:

datetime.datetime

property user

The user or member that sent the interaction. There is an alias for this named author.

Type:

Union[User, Member]

property guild

The guild the interaction was sent from.

Type:

Optional[Guild]

me

Union[Member, ClientUser]: Similar to Guild.me except it may return the ClientUser in private message contexts.

channel

The channel the interaction was sent from.

Note that due to a Discord limitation, threads that the bot cannot access and DM channels are not resolved since there is no data to complete them. These are PartialMessageable instead.

If you want to compute the interaction author’s or bot’s permissions in the channel, consider using permissions or app_permissions instead.

Type:

Union[abc.GuildChannel, Thread, PartialMessageable]

property permissions

The resolved permissions of the member in the channel, including overwrites.

In a guild context, this is provided directly by Discord.

In a non-guild context this will be an instance of Permissions.private_channel().

Type:

Permissions

property app_permissions

The resolved permissions of the bot in the channel, including overwrites.

In a guild context, this is provided directly by Discord.

In a non-guild context this will be an instance of Permissions.private_channel().

New in version 2.6.

Type:

Permissions

response

Returns an object responsible for handling responding to the interaction.

A response can only be done once. If secondary messages need to be sent, consider using followup instead.

Type:

InteractionResponse

followup

Returns the follow up webhook for follow up interactions.

Type:

Webhook

expires_at

Returns the interaction’s expiration time in UTC.

This is exactly 15 minutes after the interaction was created.

New in version 2.5.

Type:

datetime.datetime

is_expired()

Whether the interaction can still be used to make requests to Discord.

This does not take into account the 3 second limit for the initial response.

New in version 2.5.

Return type:

bool

await original_response()

This function is a coroutine.

Fetches the original interaction response message associated with the interaction.

Here is a table with response types and their associated original response:

Response type	Original response
InteractionResponse.send_message()	The message you sent
InteractionResponse.edit_message()	The message you edited
InteractionResponse.defer()	The message with thinking state (bot is thinking…)
Other response types	None

Repeated calls to this will return a cached value.

Changed in version 2.6: This function was renamed from original_message.

Raises:

HTTPException – Fetching the original response message failed.

Returns:

The original interaction response message.

Return type:

InteractionMessage

await edit_original_response(content=..., *, embed=..., embeds=..., file=..., files=..., attachments=..., view=..., components=..., suppress_embeds=..., allowed_mentions=None)

This function is a coroutine.

Edits the original, previously sent interaction response message.

This is a lower level interface to InteractionMessage.edit() in case you do not want to fetch the message and save an HTTP request.

This method is also the only way to edit the original response if the message sent was ephemeral.

Note

If the original response message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Changed in version 2.6: This function was renamed from edit_original_message.

Parameters:

• content (Optional[str]) – The content to edit the message with, or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) – The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• files (List[File]) – A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• view (Optional[View]) – The updated view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

• components (Optional[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]]) –

  A list of components to update this message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True. If set to False, this brings the embeds back if they were suppressed.

  New in version 2.7.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files

• ValueError – The length of embeds was invalid.

Returns:

The newly edited message.

Return type:

InteractionMessage

await delete_original_response(*, delay=None)

This function is a coroutine.

Deletes the original interaction response message.

This is a lower level interface to InteractionMessage.delete() in case you do not want to fetch the message and save an HTTP request.

Changed in version 2.6: This function was renamed from delete_original_message.

Parameters:

delay (float) – If provided, the number of seconds to wait in the background before deleting the original response message. If the deletion fails, then it is silently ignored.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

await send(content=None, *, embed=..., embeds=..., file=..., files=..., allowed_mentions=..., view=..., components=..., tts=False, ephemeral=False, suppress_embeds=False, delete_after=...)

This function is a coroutine.

Sends a message using either response.send_message or followup.send.

If the interaction hasn’t been responded to yet, this method will call response.send_message. Otherwise, it will call followup.send.

Note

This method does not return a Message object. If you need a message object, use original_response() to fetch it, or use followup.send directly instead of this method if you’re sending a followup message.

Parameters:

• content (Optional[str]) – The content of the message to send.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) – A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

• tts (bool) – Whether the message should be sent using text-to-speech.

• view (disnake.ui.View) – The view to send with the message. This cannot be mixed with components.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to send with the message. This cannot be mixed with view.

  New in version 2.4.

• ephemeral (bool) – Whether the message should only be visible to the user who started the interaction. If a view is sent with an ephemeral message and it has no timeout set then the timeout is set to 15 minutes.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

• delete_after (float) –

  If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  Can be up to 15 minutes after the interaction was created (see also expires_at/is_expired).

  Changed in version 2.7: Added support for ephemeral responses.

Raises:

• HTTPException – Sending the message failed.

• TypeError – You specified both embed and embeds.

• ValueError – The length of embeds was invalid.

ApplicationCommandInteraction

Attributes

• app_permissions
• application_command
• application_id
• author
• bot
• channel
• channel_id
• client
• command_failed
• created_at
• data
• expires_at
• filled_options
• followup
• guild
• guild_id
• guild_locale
• id
• locale
• me
• options
• permissions
• response
• target
• token
• type
• user

Methods

• asyncdelete_original_message
• asyncdelete_original_response
• asyncedit_original_message
• asyncedit_original_response
• defis_expired
• asyncoriginal_message
• asyncoriginal_response
• asyncsend

class disnake.ApplicationCommandInteraction

Represents an interaction with an application command.

Current examples are slash commands, user commands and message commands.

New in version 2.1.

id

The interaction’s ID.

Type:

int

type

The interaction’s type.

Type:

InteractionType

application_id

The application ID that the interaction was for.

Type:

int

guild_id

The guild ID the interaction was sent from.

Type:

Optional[int]

channel_id

The channel ID the interaction was sent from.

Type:

int

author

The user or member that sent the interaction.

Type:

Union[User, Member]

locale

The selected language of the interaction’s author.

New in version 2.4.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Locale

guild_locale

The selected language of the interaction’s guild. This value is only meaningful in guilds with COMMUNITY feature and receives a default value otherwise. If the interaction was in a DM, then this value is None.

New in version 2.4.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Optional[Locale]

token

The token to continue the interaction. These are valid for 15 minutes.

Type:

str

data

The wrapped interaction data.

Type:

ApplicationCommandInteractionData

client

The interaction client.

Type:

Client

application_command

The command invoked by the interaction.

Type:

InvokableApplicationCommand

command_failed

Whether the command failed to be checked or invoked.

Type:

bool

original_message()

An alias of original_response().

edit_original_message()

An alias of edit_original_response().

delete_original_message()

An alias of delete_original_response().

property target

The user or message targetted by a user or message command

Type:

Optional[Union[abc.User, Message]]

property options

The full option tree, including nestings

Type:

Dict[str, Any]

property filled_options

The options of the command (or sub-command) being invoked

Type:

Dict[str, Any]

property app_permissions

The resolved permissions of the bot in the channel, including overwrites.

In a guild context, this is provided directly by Discord.

In a non-guild context this will be an instance of Permissions.private_channel().

New in version 2.6.

Type:

Permissions

property bot

The bot handling the interaction.

Only applicable when used with Bot. This is an alias for client.

Type:

Bot

channel

The channel the interaction was sent from.

Note that due to a Discord limitation, threads that the bot cannot access and DM channels are not resolved since there is no data to complete them. These are PartialMessageable instead.

If you want to compute the interaction author’s or bot’s permissions in the channel, consider using permissions or app_permissions instead.

Type:

Union[abc.GuildChannel, Thread, PartialMessageable]

property created_at

Returns the interaction’s creation time in UTC.

Type:

datetime.datetime

await delete_original_response(*, delay=None)

This function is a coroutine.

Deletes the original interaction response message.

This is a lower level interface to InteractionMessage.delete() in case you do not want to fetch the message and save an HTTP request.

Changed in version 2.6: This function was renamed from delete_original_message.

Parameters:

delay (float) – If provided, the number of seconds to wait in the background before deleting the original response message. If the deletion fails, then it is silently ignored.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

await edit_original_response(content=..., *, embed=..., embeds=..., file=..., files=..., attachments=..., view=..., components=..., suppress_embeds=..., allowed_mentions=None)

This function is a coroutine.

Edits the original, previously sent interaction response message.

This is a lower level interface to InteractionMessage.edit() in case you do not want to fetch the message and save an HTTP request.

This method is also the only way to edit the original response if the message sent was ephemeral.

Note

If the original response message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Changed in version 2.6: This function was renamed from edit_original_message.

Parameters:

• content (Optional[str]) – The content to edit the message with, or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) – The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• files (List[File]) – A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• view (Optional[View]) – The updated view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

• components (Optional[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]]) –

  A list of components to update this message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True. If set to False, this brings the embeds back if they were suppressed.

  New in version 2.7.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files

• ValueError – The length of embeds was invalid.

Returns:

The newly edited message.

Return type:

InteractionMessage

expires_at

Returns the interaction’s expiration time in UTC.

This is exactly 15 minutes after the interaction was created.

New in version 2.5.

Type:

datetime.datetime

followup

Returns the follow up webhook for follow up interactions.

Type:

Webhook

property guild

The guild the interaction was sent from.

Type:

Optional[Guild]

is_expired()

Whether the interaction can still be used to make requests to Discord.

This does not take into account the 3 second limit for the initial response.

New in version 2.5.

Return type:

bool

me

Union[Member, ClientUser]: Similar to Guild.me except it may return the ClientUser in private message contexts.

await original_response()

This function is a coroutine.

Fetches the original interaction response message associated with the interaction.

Here is a table with response types and their associated original response:

Response type	Original response
InteractionResponse.send_message()	The message you sent
InteractionResponse.edit_message()	The message you edited
InteractionResponse.defer()	The message with thinking state (bot is thinking…)
Other response types	None

Repeated calls to this will return a cached value.

Changed in version 2.6: This function was renamed from original_message.

Raises:

HTTPException – Fetching the original response message failed.

Returns:

The original interaction response message.

Return type:

InteractionMessage

property permissions

The resolved permissions of the member in the channel, including overwrites.

In a guild context, this is provided directly by Discord.

In a non-guild context this will be an instance of Permissions.private_channel().

Type:

Permissions

response

Returns an object responsible for handling responding to the interaction.

A response can only be done once. If secondary messages need to be sent, consider using followup instead.

Type:

InteractionResponse

await send(content=None, *, embed=..., embeds=..., file=..., files=..., allowed_mentions=..., view=..., components=..., tts=False, ephemeral=False, suppress_embeds=False, delete_after=...)

This function is a coroutine.

Sends a message using either response.send_message or followup.send.

If the interaction hasn’t been responded to yet, this method will call response.send_message. Otherwise, it will call followup.send.

Note

This method does not return a Message object. If you need a message object, use original_response() to fetch it, or use followup.send directly instead of this method if you’re sending a followup message.

Parameters:

• content (Optional[str]) – The content of the message to send.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) – A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

• tts (bool) – Whether the message should be sent using text-to-speech.

• view (disnake.ui.View) – The view to send with the message. This cannot be mixed with components.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to send with the message. This cannot be mixed with view.

  New in version 2.4.

• ephemeral (bool) – Whether the message should only be visible to the user who started the interaction. If a view is sent with an ephemeral message and it has no timeout set then the timeout is set to 15 minutes.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

• delete_after (float) –

  If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  Can be up to 15 minutes after the interaction was created (see also expires_at/is_expired).

  Changed in version 2.7: Added support for ephemeral responses.

Raises:

• HTTPException – Sending the message failed.

• TypeError – You specified both embed and embeds.

• ValueError – The length of embeds was invalid.

property user

The user or member that sent the interaction. There is an alias for this named author.

Type:

Union[User, Member]

GuildCommandInteraction

class disnake.GuildCommandInteraction

An ApplicationCommandInteraction subclass, primarily meant for annotations.

This prevents the command from being invoked in DMs by automatically setting ApplicationCommand.dm_permission to False for user/message commands and top-level slash commands.

Note that this does not apply to slash subcommands, subcommand groups, or autocomplete callbacks.

Additionally, annotations of some attributes are modified to match the expected types in guilds.

UserCommandInteraction

class disnake.UserCommandInteraction

An ApplicationCommandInteraction subclass meant for annotations.

No runtime behavior is changed but annotations are modified to seem like the interaction is specifically a user command.

MessageCommandInteraction

class disnake.MessageCommandInteraction

An ApplicationCommandInteraction subclass meant for annotations.

No runtime behavior is changed but annotations are modified to seem like the interaction is specifically a message command.

MessageInteraction

Attributes

• app_permissions
• application_id
• author
• bot
• channel
• channel_id
• client
• component
• created_at
• data
• expires_at
• followup
• guild
• guild_id
• guild_locale
• id
• locale
• me
• message
• permissions
• resolved_values
• response
• token
• type
• user
• values

Methods

• asyncdelete_original_message
• asyncdelete_original_response
• asyncedit_original_message
• asyncedit_original_response
• defis_expired
• asyncoriginal_message
• asyncoriginal_response
• asyncsend

class disnake.MessageInteraction

Represents an interaction with a message component.

Current examples are buttons and dropdowns.

New in version 2.1.

id

The interaction’s ID.

Type:

int

type

The interaction type.

Type:

InteractionType

application_id

The application ID that the interaction was for.

Type:

int

token

The token to continue the interaction. These are valid for 15 minutes.

Type:

str

guild_id

The guild ID the interaction was sent from.

Type:

Optional[int]

channel_id

The channel ID the interaction was sent from.

Type:

int

author

The user or member that sent the interaction.

Type:

Union[User, Member]

locale

The selected language of the interaction’s author.

New in version 2.4.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Locale

guild_locale

The selected language of the interaction’s guild. This value is only meaningful in guilds with COMMUNITY feature and receives a default value otherwise. If the interaction was in a DM, then this value is None.

New in version 2.4.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Optional[Locale]

message

The message that sent this interaction.

Type:

Optional[Message]

data

The wrapped interaction data.

Type:

MessageInteractionData

client

The interaction client.

Type:

Client

original_message()

An alias of original_response().

edit_original_message()

An alias of edit_original_response().

delete_original_message()

An alias of delete_original_response().

property values

The values the user selected.

For select menus of type string_select, these are just the string values the user selected. For other select menu types, these are the IDs of the selected entities.

See also resolved_values.

Type:

Optional[List[str]]

resolved_values

The (resolved) values the user selected.

For select menus of type string_select, this is equivalent to values. For other select menu types, these are full objects corresponding to the selected entities.

New in version 2.7.

Type:

Optional[Sequence[str, Member, User, Role, Union[abc.GuildChannel, Thread, PartialMessageable]]]

component

The component the user interacted with

Type:

Union[Button, BaseSelectMenu]

property app_permissions

The resolved permissions of the bot in the channel, including overwrites.

In a guild context, this is provided directly by Discord.

In a non-guild context this will be an instance of Permissions.private_channel().

New in version 2.6.

Type:

Permissions

property bot

The bot handling the interaction.

Only applicable when used with Bot. This is an alias for client.

Type:

Bot

channel

The channel the interaction was sent from.

Note that due to a Discord limitation, threads that the bot cannot access and DM channels are not resolved since there is no data to complete them. These are PartialMessageable instead.

If you want to compute the interaction author’s or bot’s permissions in the channel, consider using permissions or app_permissions instead.

Type:

Union[abc.GuildChannel, Thread, PartialMessageable]

property created_at

Returns the interaction’s creation time in UTC.

Type:

datetime.datetime

await delete_original_response(*, delay=None)

This function is a coroutine.

Deletes the original interaction response message.

This is a lower level interface to InteractionMessage.delete() in case you do not want to fetch the message and save an HTTP request.

Changed in version 2.6: This function was renamed from delete_original_message.

Parameters:

delay (float) – If provided, the number of seconds to wait in the background before deleting the original response message. If the deletion fails, then it is silently ignored.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

await edit_original_response(content=..., *, embed=..., embeds=..., file=..., files=..., attachments=..., view=..., components=..., suppress_embeds=..., allowed_mentions=None)

This function is a coroutine.

Edits the original, previously sent interaction response message.

This is a lower level interface to InteractionMessage.edit() in case you do not want to fetch the message and save an HTTP request.

This method is also the only way to edit the original response if the message sent was ephemeral.

Note

If the original response message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Changed in version 2.6: This function was renamed from edit_original_message.

Parameters:

• content (Optional[str]) – The content to edit the message with, or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) – The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• files (List[File]) – A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• view (Optional[View]) – The updated view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

• components (Optional[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]]) –

  A list of components to update this message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True. If set to False, this brings the embeds back if they were suppressed.

  New in version 2.7.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files

• ValueError – The length of embeds was invalid.

Returns:

The newly edited message.

Return type:

InteractionMessage

expires_at

Returns the interaction’s expiration time in UTC.

This is exactly 15 minutes after the interaction was created.

New in version 2.5.

Type:

datetime.datetime

followup

Returns the follow up webhook for follow up interactions.

Type:

Webhook

property guild

The guild the interaction was sent from.

Type:

Optional[Guild]

is_expired()

Whether the interaction can still be used to make requests to Discord.

This does not take into account the 3 second limit for the initial response.

New in version 2.5.

Return type:

bool

me

Union[Member, ClientUser]: Similar to Guild.me except it may return the ClientUser in private message contexts.

await original_response()

This function is a coroutine.

Fetches the original interaction response message associated with the interaction.

Here is a table with response types and their associated original response:

Response type	Original response
InteractionResponse.send_message()	The message you sent
InteractionResponse.edit_message()	The message you edited
InteractionResponse.defer()	The message with thinking state (bot is thinking…)
Other response types	None

Repeated calls to this will return a cached value.

Changed in version 2.6: This function was renamed from original_message.

Raises:

HTTPException – Fetching the original response message failed.

Returns:

The original interaction response message.

Return type:

InteractionMessage

property permissions

The resolved permissions of the member in the channel, including overwrites.

In a guild context, this is provided directly by Discord.

In a non-guild context this will be an instance of Permissions.private_channel().

Type:

Permissions

response

Returns an object responsible for handling responding to the interaction.

A response can only be done once. If secondary messages need to be sent, consider using followup instead.

Type:

InteractionResponse

await send(content=None, *, embed=..., embeds=..., file=..., files=..., allowed_mentions=..., view=..., components=..., tts=False, ephemeral=False, suppress_embeds=False, delete_after=...)

This function is a coroutine.

Sends a message using either response.send_message or followup.send.

If the interaction hasn’t been responded to yet, this method will call response.send_message. Otherwise, it will call followup.send.

Note

This method does not return a Message object. If you need a message object, use original_response() to fetch it, or use followup.send directly instead of this method if you’re sending a followup message.

Parameters:

• content (Optional[str]) – The content of the message to send.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) – A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

• tts (bool) – Whether the message should be sent using text-to-speech.

• view (disnake.ui.View) – The view to send with the message. This cannot be mixed with components.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to send with the message. This cannot be mixed with view.

  New in version 2.4.

• ephemeral (bool) – Whether the message should only be visible to the user who started the interaction. If a view is sent with an ephemeral message and it has no timeout set then the timeout is set to 15 minutes.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

• delete_after (float) –

  If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  Can be up to 15 minutes after the interaction was created (see also expires_at/is_expired).

  Changed in version 2.7: Added support for ephemeral responses.

Raises:

• HTTPException – Sending the message failed.

• TypeError – You specified both embed and embeds.

• ValueError – The length of embeds was invalid.

property user

The user or member that sent the interaction. There is an alias for this named author.

Type:

Union[User, Member]

ModalInteraction

Attributes

• app_permissions
• application_id
• author
• bot
• channel
• channel_id
• client
• created_at
• custom_id
• data
• expires_at
• followup
• guild
• guild_id
• guild_locale
• id
• locale
• me
• message
• permissions
• response
• text_values
• token
• type
• user

Methods

• asyncdelete_original_message
• asyncdelete_original_response
• asyncedit_original_message
• asyncedit_original_response
• defis_expired
• asyncoriginal_message
• asyncoriginal_response
• asyncsend
• defwalk_raw_components

class disnake.ModalInteraction

Represents an interaction with a modal.

New in version 2.4.

id

The interaction’s ID.

Type:

int

type

The interaction type.

Type:

InteractionType

application_id

The application ID that the interaction was for.

Type:

int

token

The token to continue the interaction. These are valid for 15 minutes.

Type:

str

guild_id

The guild ID the interaction was sent from.

Type:

Optional[int]

channel_id

The channel ID the interaction was sent from.

Type:

int

author

The user or member that sent the interaction.

Type:

Union[User, Member]

locale

The selected language of the interaction’s author.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Locale

guild_locale

The selected language of the interaction’s guild. This value is only meaningful in guilds with COMMUNITY feature and receives a default value otherwise. If the interaction was in a DM, then this value is None.

Changed in version 2.5: Changed to Locale instead of str.

Type:

Optional[Locale]

message

The message that this interaction’s modal originated from, if the modal was sent in response to a component interaction.

New in version 2.5.

Type:

Optional[Message]

data

The wrapped interaction data.

Type:

ModalInteractionData

client

The interaction client.

Type:

Client

original_message()

An alias of original_response().

edit_original_message()

An alias of edit_original_response().

delete_original_message()

An alias of delete_original_response().

for ... in walk_raw_components()

Returns a generator that yields raw component data from action rows one by one, as provided by Discord. This does not contain all fields of the components due to API limitations.

New in version 2.6.

Return type:

Generator[dict, None, None]

text_values

Returns the text values the user has entered in the modal. This is a dict of the form {custom_id: value}.

Type:

Dict[str, str]

property custom_id

The custom ID of the modal.

Type:

str

property app_permissions

The resolved permissions of the bot in the channel, including overwrites.

In a guild context, this is provided directly by Discord.

In a non-guild context this will be an instance of Permissions.private_channel().

New in version 2.6.

Type:

Permissions

property bot

The bot handling the interaction.

Only applicable when used with Bot. This is an alias for client.

Type:

Bot

channel

The channel the interaction was sent from.

Note that due to a Discord limitation, threads that the bot cannot access and DM channels are not resolved since there is no data to complete them. These are PartialMessageable instead.

If you want to compute the interaction author’s or bot’s permissions in the channel, consider using permissions or app_permissions instead.

Type:

Union[abc.GuildChannel, Thread, PartialMessageable]

property created_at

Returns the interaction’s creation time in UTC.

Type:

datetime.datetime

await delete_original_response(*, delay=None)

This function is a coroutine.

Deletes the original interaction response message.

This is a lower level interface to InteractionMessage.delete() in case you do not want to fetch the message and save an HTTP request.

Changed in version 2.6: This function was renamed from delete_original_message.

Parameters:

delay (float) – If provided, the number of seconds to wait in the background before deleting the original response message. If the deletion fails, then it is silently ignored.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

await edit_original_response(content=..., *, embed=..., embeds=..., file=..., files=..., attachments=..., view=..., components=..., suppress_embeds=..., allowed_mentions=None)

This function is a coroutine.

Edits the original, previously sent interaction response message.

This is a lower level interface to InteractionMessage.edit() in case you do not want to fetch the message and save an HTTP request.

This method is also the only way to edit the original response if the message sent was ephemeral.

Note

If the original response message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Changed in version 2.6: This function was renamed from edit_original_message.

Parameters:

• content (Optional[str]) – The content to edit the message with, or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) – The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• files (List[File]) – A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• view (Optional[View]) – The updated view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

• components (Optional[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]]) –

  A list of components to update this message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True. If set to False, this brings the embeds back if they were suppressed.

  New in version 2.7.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files

• ValueError – The length of embeds was invalid.

Returns:

The newly edited message.

Return type:

InteractionMessage

expires_at

Returns the interaction’s expiration time in UTC.

This is exactly 15 minutes after the interaction was created.

New in version 2.5.

Type:

datetime.datetime

followup

Returns the follow up webhook for follow up interactions.

Type:

Webhook

property guild

The guild the interaction was sent from.

Type:

Optional[Guild]

is_expired()

Whether the interaction can still be used to make requests to Discord.

This does not take into account the 3 second limit for the initial response.

New in version 2.5.

Return type:

bool

me

Union[Member, ClientUser]: Similar to Guild.me except it may return the ClientUser in private message contexts.

await original_response()

This function is a coroutine.

Fetches the original interaction response message associated with the interaction.

Here is a table with response types and their associated original response:

Response type	Original response
InteractionResponse.send_message()	The message you sent
InteractionResponse.edit_message()	The message you edited
InteractionResponse.defer()	The message with thinking state (bot is thinking…)
Other response types	None

Repeated calls to this will return a cached value.

Changed in version 2.6: This function was renamed from original_message.

Raises:

HTTPException – Fetching the original response message failed.

Returns:

The original interaction response message.

Return type:

InteractionMessage

property permissions

The resolved permissions of the member in the channel, including overwrites.

In a guild context, this is provided directly by Discord.

In a non-guild context this will be an instance of Permissions.private_channel().

Type:

Permissions

response

Returns an object responsible for handling responding to the interaction.

A response can only be done once. If secondary messages need to be sent, consider using followup instead.

Type:

InteractionResponse

await send(content=None, *, embed=..., embeds=..., file=..., files=..., allowed_mentions=..., view=..., components=..., tts=False, ephemeral=False, suppress_embeds=False, delete_after=...)

This function is a coroutine.

Sends a message using either response.send_message or followup.send.

If the interaction hasn’t been responded to yet, this method will call response.send_message. Otherwise, it will call followup.send.

Note

This method does not return a Message object. If you need a message object, use original_response() to fetch it, or use followup.send directly instead of this method if you’re sending a followup message.

Parameters:

• content (Optional[str]) – The content of the message to send.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) – A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

• tts (bool) – Whether the message should be sent using text-to-speech.

• view (disnake.ui.View) – The view to send with the message. This cannot be mixed with components.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to send with the message. This cannot be mixed with view.

  New in version 2.4.

• ephemeral (bool) – Whether the message should only be visible to the user who started the interaction. If a view is sent with an ephemeral message and it has no timeout set then the timeout is set to 15 minutes.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

• delete_after (float) –

  If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  Can be up to 15 minutes after the interaction was created (see also expires_at/is_expired).

  Changed in version 2.7: Added support for ephemeral responses.

Raises:

• HTTPException – Sending the message failed.

• TypeError – You specified both embed and embeds.

• ValueError – The length of embeds was invalid.

property user

The user or member that sent the interaction. There is an alias for this named author.

Type:

Union[User, Member]

InteractionResponse

Attributes

• type

Methods

• asyncautocomplete
• asyncdefer
• asyncedit_message
• defis_done
• asyncpong
• asyncsend_message
• asyncsend_modal

class disnake.InteractionResponse

Represents a Discord interaction response.

This type can be accessed through Interaction.response.

New in version 2.0.

property type

If a response was successfully made, this is the type of the response.

New in version 2.6.

Type:

Optional[InteractionResponseType]

is_done()

Whether an interaction response has been done before.

An interaction can only be responded to once.

Return type:

bool

await defer(*, with_message=..., ephemeral=...)

This function is a coroutine.

Defers the interaction response.

This is typically used when the interaction is acknowledged and a secondary action will be done later.

Changed in version 2.5: Raises TypeError when an interaction cannot be deferred.

Parameters:

• with_message (bool) –

  Whether the response will be a separate message with thinking state (bot is thinking…). This only applies to interactions of type InteractionType.component (default False) and InteractionType.modal_submit (default True).

  True corresponds to a deferred_channel_message response type, while False corresponds to deferred_message_update.

  Note

  Responses to interactions of type InteractionType.application_command must defer using a message, i.e. this will effectively always be True for those.

  New in version 2.4.

  Changed in version 2.6: Added support for setting this to False in modal interactions.

• ephemeral (bool) –

  Whether the deferred message will eventually be ephemeral. This applies to interactions of type InteractionType.application_command, or when the with_message parameter is True.

  Defaults to False.

Raises:

• HTTPException – Deferring the interaction failed.

• InteractionResponded – This interaction has already been responded to before.

• TypeError – This interaction cannot be deferred.

await pong()

This function is a coroutine.

Pongs the ping interaction.

This should rarely be used.

Raises:

• HTTPException – Ponging the interaction failed.

• InteractionResponded – This interaction has already been responded to before.

await send_message(content=None, *, embed=..., embeds=..., file=..., files=..., allowed_mentions=..., view=..., components=..., tts=False, ephemeral=False, suppress_embeds=False, delete_after=...)

This function is a coroutine.

Responds to this interaction by sending a message.

Parameters:

• content (Optional[str]) – The content of the message to send.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) – A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message.

• view (disnake.ui.View) – The view to send with the message. This cannot be mixed with components.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to send with the message. This cannot be mixed with view.

  New in version 2.4.

• tts (bool) – Whether the message should be sent using text-to-speech.

• ephemeral (bool) – Whether the message should only be visible to the user who started the interaction. If a view is sent with an ephemeral message and it has no timeout set then the timeout is set to 15 minutes.

• delete_after (float) –

  If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  Can be up to 15 minutes after the interaction was created (see also Interaction.expires_at/is_expired).

  Changed in version 2.7: Added support for ephemeral responses.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• TypeError – You specified both embed and embeds.

• ValueError – The length of embeds was invalid.

• InteractionResponded – This interaction has already been responded to before.

await edit_message(content=..., *, embed=..., embeds=..., file=..., files=..., attachments=..., allowed_mentions=..., view=..., components=...)

This function is a coroutine.

Responds to this interaction by editing the original message of a component interaction or modal interaction (if the modal was sent in response to a component interaction).

Changed in version 2.5: Now supports editing the original message of modal interactions that started from a component.

Note

If the original message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Parameters:

• content (Optional[str]) – The new content to replace the message with. None removes the content.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) –

  The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message.

  New in version 2.2.

• files (List[File]) –

  A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message.

  New in version 2.2.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.4.

  Changed in version 2.5: Supports passing None to clear attachments.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message.

• view (Optional[View]) – The updated view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

• components (Optional[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]]) –

  A list of components to update this message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

Raises:

• HTTPException – Editing the message failed.

• TypeError – You specified both embed and embeds.

• InteractionResponded – This interaction has already been responded to before.

await autocomplete(*, choices)

This function is a coroutine.

Responds to this interaction by displaying a list of possible autocomplete results. Only works for autocomplete interactions.

Parameters:

choices (Union[List[OptionChoice], List[Union[str, int]], Dict[str, Union[str, int]]]) – The list of choices to suggest.

Raises:

• HTTPException – Autocomplete response has failed.

• InteractionResponded – This interaction has already been responded to before.

await send_modal(modal=None, *, title=None, custom_id=None, components=None)

This function is a coroutine.

Responds to this interaction by displaying a modal.

New in version 2.4.

Note

Not passing the modal parameter here will not register a callback, and a on_modal_submit() interaction will need to be handled manually.

Parameters:

• modal (Modal) – The modal to display. This cannot be mixed with the title, custom_id and components parameters.

• title (str) – The title of the modal. This cannot be mixed with the modal parameter.

• custom_id (str) – The ID of the modal that gets received during an interaction. This cannot be mixed with the modal parameter.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) – The components to display in the modal. A maximum of 5. This cannot be mixed with the modal parameter.

Raises:

• TypeError – Cannot mix the modal parameter and the title, custom_id, components parameters.

• ValueError – Maximum number of components (5) exceeded.

• HTTPException – Displaying the modal failed.

• ModalChainNotSupported – This interaction cannot be responded with a modal.

• InteractionResponded – This interaction has already been responded to before.

InteractionMessage

Attributes

• attachments
• author
• channel
• channel_mentions
• clean_content
• components
• content
• created_at
• edited_at
• embeds
• flags
• guild
• id
• interaction
• jump_url
• mention_everyone
• mentions
• pinned
• raw_channel_mentions
• raw_mentions
• raw_role_mentions
• reactions
• reference
• role_mentions
• stickers
• system_content
• thread
• type
• webhook_id

Methods

• asyncadd_reaction
• asyncclear_reaction
• asyncclear_reactions
• asynccreate_thread
• asyncdelete
• asyncedit
• defis_system
• asyncpin
• asyncpublish
• asyncremove_reaction
• asyncreply
• defto_reference
• asyncunpin

class disnake.InteractionMessage

Represents the original interaction response message.

This allows you to edit or delete the message associated with the interaction response. To retrieve this object see Interaction.original_response().

This inherits from disnake.Message with changes to edit() and delete() to work.

New in version 2.0.

type

The type of message.

Type:

MessageType

author

A Member that sent the message. If channel is a private channel, then it is a User instead.

Type:

Union[Member, abc.User]

content

The actual contents of the message.

Type:

str

embeds

A list of embeds the message has.

Type:

List[Embed]

channel

The channel that the message was sent from. Could be a DMChannel or GroupChannel if it’s a private message.

Type:

Union[TextChannel, VoiceChannel, Thread, DMChannel, GroupChannel, PartialMessageable]

reference

The message that this message references. This is only applicable to message replies.

Type:

Optional[MessageReference]

interaction

The interaction that this message references. This exists only when the message is a response to an interaction without an existing message.

New in version 2.1.

Type:

Optional[InteractionReference]

mention_everyone

Specifies if the message mentions everyone.

Note

This does not check if the @everyone or the @here text is in the message itself. Rather this boolean indicates if either the @everyone or the @here text is in the message and it did end up mentioning.

Type:

bool

mentions

A list of Member that were mentioned. If the message is in a private message then the list will be of User instead.

Warning

The order of the mentions list is not in any particular order so you should not rely on it. This is a Discord limitation, not one with the library.

Type:

List[abc.User]

role_mentions

A list of Role that were mentioned. If the message is in a private message then the list is always empty.

Type:

List[Role]

id

The message ID.

Type:

int

webhook_id

The ID of the application that sent this message.

Type:

Optional[int]

attachments

A list of attachments given to a message.

Type:

List[Attachment]

pinned

Specifies if the message is currently pinned.

Type:

bool

flags

Extra features of the message.

Type:

MessageFlags

reactions

Reactions to a message. Reactions can be either custom emoji or standard unicode emoji.

Type:

List[Reaction]

stickers

A list of sticker items given to the message.

Type:

List[StickerItem]

components

A list of components in the message.

Type:

List[Component]

guild

The guild that the message belongs to, if applicable.

Type:

Optional[Guild]

await edit(content=..., *, embed=..., embeds=..., file=..., files=..., attachments=..., suppress_embeds=..., allowed_mentions=..., view=..., components=...)

This function is a coroutine.

Edits the message.

Note

If the original message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Parameters:

• content (Optional[str]) – The content to edit the message with, or None to clear it.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) – The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

• file (File) – The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• files (List[File]) – A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.2.

  Changed in version 2.5: Supports passing None to clear attachments.

• view (Optional[View]) – The updated view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

• components (Optional[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]]) –

  A list of components to update this message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True. If set to False, this brings the embeds back if they were suppressed.

  New in version 2.7.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• TypeError – You specified both embed and embeds or file and files

• ValueError – The length of embeds was invalid.

Returns:

The newly edited message.

Return type:

InteractionMessage

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message. The waiting is done in the background and deletion failures are ignored.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already.

• HTTPException – Deleting the message failed.

await add_reaction(emoji)

This function is a coroutine.

Adds a reaction to the message.

The emoji may be a unicode emoji or a custom guild Emoji.

You must have the read_message_history permission to use this. If nobody else has reacted to the message using this emoji, the add_reactions permission is required.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to react with.

Raises:

• HTTPException – Adding the reaction failed.

• Forbidden – You do not have the proper permissions to react to the message.

• NotFound – The emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

channel_mentions

A list of abc.GuildChannel that were mentioned. If the message is in a private message then the list is always empty.

Type:

List[abc.GuildChannel]

clean_content

A property that returns the content in a “cleaned up” manner. This basically means that mentions are transformed into the way the client shows it. e.g. <#id> will transform into #name.

This will also transform @everyone and @here mentions into non-mentions.

Note

This does not affect markdown. If you want to escape or remove markdown then use utils.escape_markdown() or utils.remove_markdown() respectively, along with this function.

Type:

str

await clear_reaction(emoji)

This function is a coroutine.

Clears a specific reaction from the message.

The emoji may be a unicode emoji or a custom guild Emoji.

You need the manage_messages permission to use this.

New in version 1.3.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to clear.

Raises:

• HTTPException – Clearing the reaction failed.

• Forbidden – You do not have the proper permissions to clear the reaction.

• NotFound – The emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

await clear_reactions()

This function is a coroutine.

Removes all the reactions from the message.

You need the manage_messages permission to use this.

Raises:

• HTTPException – Removing the reactions failed.

• Forbidden – You do not have the proper permissions to remove all the reactions.

await create_thread(*, name, auto_archive_duration=None, slowmode_delay=None, reason=None)

This function is a coroutine.

Creates a public thread from this message.

You must have create_public_threads in order to create a public thread from a message.

The channel this message belongs in must be a TextChannel.

New in version 2.0.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• name (str) – The name of the thread.

• auto_archive_duration (Union[int, ThreadArchiveDuration]) – The duration in minutes before a thread is automatically archived for inactivity. If not provided, the channel’s default auto archive duration is used. Must be one of 60, 1440, 4320, or 10080.

• slowmode_delay (Optional[int]) –

  Specifies the slowmode rate limit for users in this thread, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If set to None or not provided, slowmode is inherited from the parent’s default_thread_slowmode_delay.

  New in version 2.3.

• reason (Optional[str]) –

  The reason for creating the thread. Shows up on the audit log.

  New in version 2.5.

Raises:

• Forbidden – You do not have permissions to create a thread.

• HTTPException – Creating the thread failed.

• TypeError – This message does not have guild info attached.

Returns:

The created thread.

Return type:

Thread

property created_at

The message’s creation time in UTC.

Type:

datetime.datetime

property edited_at

An aware UTC datetime object containing the edited time of the message.

Type:

Optional[datetime.datetime]

is_system()

Whether the message is a system message.

A system message is a message that is constructed entirely by the Discord API in response to something.

New in version 1.3.

Return type:

bool

property jump_url

Returns a URL that allows the client to jump to this message.

Type:

str

await pin(*, reason=None)

This function is a coroutine.

Pins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

The reason for pinning the message. Shows up on the audit log.

New in version 1.4.

Raises:

• Forbidden – You do not have permissions to pin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Pinning the message failed, probably due to the channel having more than 50 pinned messages.

await publish()

This function is a coroutine.

Publishes this message to your announcement channel.

You must have the send_messages permission to do this.

If the message is not your own then the manage_messages permission is also needed.

Raises:

• Forbidden – You do not have the proper permissions to publish this message.

• HTTPException – Publishing the message failed.

raw_channel_mentions

A property that returns an array of channel IDs matched with the syntax of <#channel_id> in the message content.

Type:

List[int]

raw_mentions

A property that returns an array of user IDs matched with the syntax of <@user_id> in the message content.

This allows you to receive the user IDs of mentioned users even in a private message context.

Type:

List[int]

raw_role_mentions

A property that returns an array of role IDs matched with the syntax of <@&role_id> in the message content.

Type:

List[int]

await remove_reaction(emoji, member)

This function is a coroutine.

Removes a reaction by the member from the message.

The emoji may be a unicode emoji or a custom guild Emoji.

If the reaction is not your own (i.e. member parameter is not you) then the manage_messages permission is needed.

The member parameter must represent a member and meet the abc.Snowflake abc.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to remove.

• member (abc.Snowflake) – The member for which to remove the reaction.

Raises:

• HTTPException – Removing the reaction failed.

• Forbidden – You do not have the proper permissions to remove the reaction.

• NotFound – The member or emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

await reply(content=None, *, fail_if_not_exists=True, **kwargs)

This function is a coroutine.

A shortcut method to abc.Messageable.send() to reply to the Message.

New in version 1.6.

Changed in version 2.3: Added fail_if_not_exists keyword argument. Defaults to True.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

New in version 2.3.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – You specified both embed and embeds, or file and files, or view and components.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

system_content

A property that returns the content that is rendered regardless of the Message.type.

In the case of MessageType.default and MessageType.reply, this just returns the regular Message.content. Otherwise this returns an English message denoting the contents of the system message.

If the message type is unrecognised this method will return None.

Type:

Optional[str]

property thread

The thread started from this message. None if no thread has been started.

New in version 2.4.

Type:

Optional[Thread]

to_reference(*, fail_if_not_exists=True)

Creates a MessageReference from the current message.

New in version 1.6.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

New in version 1.7.

Returns:

The reference to this message.

Return type:

MessageReference

await unpin(*, reason=None)

This function is a coroutine.

Unpins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

The reason for unpinning the message. Shows up on the audit log.

New in version 1.4.

Raises:

• Forbidden – You do not have permissions to unpin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Unpinning the message failed.

InteractionDataResolved

Attributes

• attachments
• channels
• members
• messages
• roles
• users

class disnake.InteractionDataResolved

Represents the resolved data related to an interaction.

New in version 2.1.

Changed in version 2.7: Renamed from ApplicationCommandInteractionDataResolved to InteractionDataResolved.

members

A mapping of IDs to partial members (deaf and mute attributes are missing).

Type:

Dict[int, Member]

users

A mapping of IDs to users.

Type:

Dict[int, User]

roles

A mapping of IDs to roles.

Type:

Dict[int, Role]

channels

A mapping of IDs to partial channels (only id, name and permissions are included, threads also have thread_metadata and parent_id).

Type:

Dict[int, Union[abc.GuildChannel, Thread, PartialMessageable]]

messages

A mapping of IDs to messages.

Type:

Dict[int, Message]

attachments

A mapping of IDs to attachments.

New in version 2.4.

Type:

Dict[int, Attachment]

ApplicationCommandInteractionData

Attributes

• focused_option
• id
• name
• options
• resolved
• target
• target_id
• type

class disnake.ApplicationCommandInteractionData

Represents the data of an interaction with an application command.

New in version 2.1.

id

The application command ID.

Type:

int

name

The application command name.

Type:

str

type

The application command type.

Type:

ApplicationCommandType

resolved

All resolved objects related to this interaction.

Type:

InteractionDataResolved

options

A list of options from the API.

Type:

List[ApplicationCommandInteractionDataOption]

target_id

ID of the user or message targetted by a user or message command

Type:

int

target

The user or message targetted by a user or message command

Type:

Union[User, Member, Message]

property focused_option

The focused option

ApplicationCommandInteractionDataOption

Attributes

• focused
• name
• options
• type
• value

class disnake.ApplicationCommandInteractionDataOption

This class represents the structure of an interaction data option from the API.

name

The option’s name.

Type:

str

type

The option’s type.

Type:

OptionType

value

The option’s value.

Type:

Any

options

The list of options of this option. Only exists for subcommands and groups.

Type:

List[ApplicationCommandInteractionDataOption]

focused

Whether this option is focused by the user. May be True in autocomplete interactions.

Type:

bool

MessageInteractionData

Attributes

• component_type
• custom_id
• resolved
• values

class disnake.MessageInteractionData

Represents the data of an interaction with a message component.

New in version 2.1.

custom_id

The custom ID of the component.

Type:

str

component_type

The type of the component.

Type:

ComponentType

values

The values the user has selected in a select menu. For non-string select menus, this contains IDs for use with resolved.

Type:

Optional[List[str]]

resolved

All resolved objects related to this interaction.

New in version 2.7.

Type:

InteractionDataResolved

ModalInteractionData

Attributes

• components
• custom_id

class disnake.ModalInteractionData

Represents the data of an interaction with a modal.

New in version 2.4.

custom_id

The custom ID of the modal.

Type:

str

components

The raw component data of the modal interaction, as provided by Discord. This does not contain all fields of the components due to API limitations.

New in version 2.6.

Type:

List[dict]

Member

Attributes

• accent_color
• accent_colour
• activities
• activity
• avatar
• banner
• bot
• color
• colour
• created_at
• current_timeout
• default_avatar
• desktop_status
• display_avatar
• display_name
• dm_channel
• flags
• guild
• guild_avatar
• guild_permissions
• id
• joined_at
• mention
• mobile_status
• mutual_guilds
• name
• nick
• pending
• premium_since
• public_flags
• raw_status
• role_icon
• roles
• status
• system
• top_role
• voice
• web_status

Methods

• asyncadd_roles
• asyncban
• asynccreate_dm
• asyncedit
• asyncfetch_message
• defget_role
• defhistory
• defis_on_mobile
• asynckick
• defmentioned_in
• asyncmove_to
• asyncpins
• asyncremove_roles
• asyncrequest_to_speak
• asyncsend
• asynctimeout
• asynctrigger_typing
• deftyping
• asyncunban

class disnake.Member

Represents a Discord member to a Guild.

This implements a lot of the functionality of User.

x == y

Checks if two members are equal. Note that this works with User instances too.

x != y

Checks if two members are not equal. Note that this works with User instances too.

hash(x)

Returns the member’s hash.

str(x)

Returns the member’s name with the discriminator.

joined_at

An aware datetime object that specifies the date and time in UTC that the member joined the guild. If the member left and rejoined the guild, this will be the latest date. In certain cases, this can be None.

Type:

Optional[datetime.datetime]

activities

The activities that the user is currently doing.

Note

Due to a Discord API limitation, a user’s Spotify activity may not appear if they are listening to a song with a title longer than 128 characters. See #1738 for more information.

Type:

Tuple[Union[BaseActivity, Spotify]]

guild

The guild that the member belongs to.

Type:

Guild

nick

The guild specific nickname of the user.

Type:

Optional[str]

pending

Whether the member is pending member verification.

New in version 1.6.

Type:

bool

premium_since

An aware datetime object that specifies the date and time in UTC when the member used their “Nitro boost” on the guild, if available. This could be None.

Type:

Optional[datetime.datetime]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property name

Equivalent to User.name

property id

Equivalent to User.id

property bot

Equivalent to User.bot

property system

Equivalent to User.system

property created_at

Equivalent to User.created_at

property default_avatar

Equivalent to User.default_avatar

property avatar

Equivalent to User.avatar

property dm_channel

Equivalent to User.dm_channel

await create_dm()

This function is a coroutine.

Creates a DMChannel with this user.

This should be rarely called, as this is done transparently for most people.

Returns:

The channel that was created.

Return type:

DMChannel

property mutual_guilds

Equivalent to User.mutual_guilds

property public_flags

Equivalent to User.public_flags

property banner

Equivalent to User.banner

property accent_color

Equivalent to User.accent_color

property accent_colour

Equivalent to User.accent_colour

property raw_status

The member’s overall status as a string value.

New in version 1.5.

Type:

str

property status

The member’s overall status. If the value is unknown, then it will be a str instead.

Type:

Status

property mobile_status

The member’s status on a mobile device, if applicable.

Type:

Status

property desktop_status

The member’s status on the desktop client, if applicable.

Type:

Status

property web_status

The member’s status on the web client, if applicable.

Type:

Status

is_on_mobile()

Whether the member is active on a mobile device.

Return type:

bool

property colour

A property that returns a colour denoting the rendered colour for the member. If the default colour is the one rendered then an instance of Colour.default() is returned.

There is an alias for this named color.

Type:

Colour

property color

A property that returns a color denoting the rendered color for the member. If the default color is the one rendered then an instance of Colour.default() is returned.

There is an alias for this named colour.

Type:

Colour

property roles

A list of Role that the member belongs to. Note that the first element of this list is always the default ‘@everyone’ role.

These roles are sorted by their position in the role hierarchy.

Type:

List[Role]

property mention

Returns a string that allows you to mention the member.

Type:

str

property display_name

Returns the user’s display name.

For regular users this is just their username, but if they have a guild specific nickname then that is returned instead.

Type:

str

property display_avatar

Returns the member’s display avatar.

For regular members this is just their avatar, but if they have a guild specific avatar then that is returned instead.

New in version 2.0.

Type:

Asset

property guild_avatar

Returns an Asset for the guild avatar the member has. If unavailable, None is returned.

New in version 2.0.

Type:

Optional[Asset]

property activity

Returns the primary activity the user is currently doing. Could be None if no activity is being done.

Note

Due to a Discord API limitation, this may be None if the user is listening to a song on Spotify with a title longer than 128 characters. See #1738 for more information.

Note

A user may have multiple activities, these can be accessed under activities.

Type:

Optional[Union[BaseActivity, Spotify]]

mentioned_in(message)

Whether the member is mentioned in the specified message.

Parameters:

message (Message) – The message to check.

Returns:

Indicates if the member is mentioned in the message.

Return type:

bool

property top_role

Returns the member’s highest role.

This is useful for figuring where a member stands in the role hierarchy chain.

Type:

Role

property role_icon

Returns the member’s displayed role icon, if any.

New in version 2.5.

Type:

Optional[Union[Asset, PartialEmoji]]

property guild_permissions

Returns the member’s guild permissions.

This only takes into consideration the guild permissions and not most of the implied permissions or any of the channel permission overwrites. For 100% accurate permission calculation, please use abc.GuildChannel.permissions_for().

This does take into consideration guild ownership and the administrator implication.

Type:

Permissions

property voice

Returns the member’s current voice state.

Type:

Optional[VoiceState]

property current_timeout

Returns the datetime when the timeout expires, if any.

New in version 2.3.

Type:

Optional[datetime.datetime]

property flags

Returns the member’s flags.

New in version 2.8.

Type:

MemberFlags

await ban(*, clean_history_duration=..., delete_message_days=..., reason=None)

This function is a coroutine.

Bans this member. Equivalent to Guild.ban().

await unban(*, reason=None)

This function is a coroutine.

Unbans this member. Equivalent to Guild.unban().

await kick(*, reason=None)

This function is a coroutine.

Kicks this member. Equivalent to Guild.kick().

await edit(*, nick=..., mute=..., deafen=..., suppress=..., roles=..., voice_channel=..., timeout=..., flags=..., bypasses_verification=..., reason=None)

This function is a coroutine.

Edits the member’s data.

Depending on the parameter passed, this requires different permissions listed below:

Parameter	Permission
nick	Permissions.manage_nicknames
mute	Permissions.mute_members
deafen	Permissions.deafen_members
roles	Permissions.manage_roles
voice_channel	Permissions.move_members
timeout	Permissions.moderate_members
flags	Permissions.moderate_members
bypasses_verification	Permissions.moderate_members

All parameters are optional.

Changed in version 1.1: Can now pass None to voice_channel to kick a member from voice.

Changed in version 2.0: The newly member is now optionally returned, if applicable.

Parameters:

• nick (Optional[str]) – The member’s new nickname. Use None to remove the nickname.

• mute (bool) – Whether the member should be guild muted or un-muted.

• deafen (bool) – Whether the member should be guild deafened or un-deafened.

• suppress (bool) –

  Whether the member should be suppressed in stage channels.

  New in version 1.7.

• roles (Sequence[Role]) – The member’s new list of roles. This replaces the roles.

• voice_channel (Optional[VoiceChannel]) – The voice channel to move the member to. Pass None to kick them from voice.

• timeout (Optional[Union[float, datetime.timedelta, datetime.datetime]]) –

  The duration (seconds or timedelta) or the expiry (datetime) of the timeout; until then, the member will not be able to interact with the guild. Set to None to remove the timeout. Supports up to 28 days in the future.

  New in version 2.3.

• flags (MemberFlags) –

  The member’s new flags. To know what flags are editable, see the documentation.

  If parameter bypasses_verification is provided, that will override the setting of MemberFlags.bypasses_verification.

  New in version 2.8.

• bypasses_verification (bool) –

  Whether the member bypasses guild verification requirements.

  New in version 2.8.

• reason (Optional[str]) – The reason for editing this member. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to the action requested.

• HTTPException – The operation failed.

Returns:

The newly updated member, if applicable. This is only returned when certain fields are updated.

Return type:

Optional[Member]

await request_to_speak()

This function is a coroutine.

Requests to speak in the connected channel.

Only applies to stage channels.

Note

Requesting members that are not the client is equivalent to edit providing suppress as False.

New in version 1.7.

Raises:

• Forbidden – You do not have the proper permissions to the action requested.

• HTTPException – The operation failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await move_to(channel, *, reason=None)

This function is a coroutine.

Moves a member to a new voice channel (they must be connected first).

You must have move_members permission to use this.

This raises the same exceptions as edit().

Changed in version 1.1: Can now pass None to kick a member from voice.

Parameters:

• channel (Optional[VoiceChannel]) – The new voice channel to move the member to. Pass None to kick them from voice.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

await add_roles(*roles, reason=None, atomic=True)

This function is a coroutine.

Gives the member a number of Roles.

You must have manage_roles permission to use this, and the added Roles must appear lower in the list of roles than the highest role of the member.

Parameters:

• *roles (abc.Snowflake) – An argument list of abc.Snowflake representing a Role to give to the member.

• reason (Optional[str]) – The reason for adding these roles. Shows up on the audit log.

• atomic (bool) – Whether to atomically add roles. This will ensure that multiple operations will always be applied regardless of the current state of the cache.

Raises:

• Forbidden – You do not have permissions to add these roles.

• HTTPException – Adding roles failed.

await remove_roles(*roles, reason=None, atomic=True)

This function is a coroutine.

Removes Roles from this member.

You must have manage_roles permission to use this, and the removed Roles must appear lower in the list of roles than the highest role of the member.

Parameters:

• *roles (abc.Snowflake) – An argument list of abc.Snowflake representing a Role to remove from the member.

• reason (Optional[str]) – The reason for removing these roles. Shows up on the audit log.

• atomic (bool) – Whether to atomically remove roles. This will ensure that multiple operations will always be applied regardless of the current state of the cache.

Raises:

• Forbidden – You do not have permissions to remove these roles.

• HTTPException – Removing the roles failed.

get_role(role_id, /)

Returns a role with the given ID from roles which the member has.

New in version 2.0.

Parameters:

role_id (int) – The role ID to search for.

Returns:

The role or None if not found in the member’s roles.

Return type:

Optional[Role]

await timeout(*, duration=..., until=..., reason=None)

This function is a coroutine.

Times out the member from the guild; until then, the member will not be able to interact with the guild.

Exactly one of duration or until must be provided. To remove a timeout, set one of the parameters to None.

You must have the Permissions.moderate_members permission to do this.

New in version 2.3.

Parameters:

• duration (Optional[Union[float, datetime.timedelta]]) – The duration (seconds or timedelta) of the member’s timeout. Set to None to remove the timeout. Supports up to 28 days in the future. May not be used in combination with the until parameter.

• until (Optional[datetime.datetime]) – The expiry date/time of the member’s timeout. Set to None to remove the timeout. Supports up to 28 days in the future. May not be used in combination with the duration parameter.

• reason (Optional[str]) – The reason for this timeout. Appears on the audit log.

Raises:

• Forbidden – You do not have permissions to timeout this member.

• HTTPException – Timing out the member failed.

Returns:

The newly updated member.

Return type:

Member

Spotify

Attributes

• album
• album_cover_url
• artist
• artists
• color
• colour
• created_at
• duration
• end
• name
• party_id
• start
• title
• track_id
• track_url
• type

class disnake.Spotify

Represents a Spotify listening activity from Discord.

x == y

Checks if two activities are equal.

x != y

Checks if two activities are not equal.

hash(x)

Returns the activity’s hash.

str(x)

Returns the string ‘Spotify’.

property type

Returns the activity’s type. This is for compatibility with Activity.

It always returns ActivityType.listening.

Type:

ActivityType

property colour

Returns the Spotify integration colour, as a Colour.

There is an alias for this named color

Type:

Colour

property color

Returns the Spotify integration colour, as a Colour.

There is an alias for this named colour

Type:

Colour

property name

The activity’s name. This will always return “Spotify”.

Type:

str

property title

The title of the song being played.

Type:

str

property artists

The artists of the song being played.

Type:

List[str]

property artist

The artist of the song being played.

This does not attempt to split the artist information into multiple artists. Useful if there’s only a single artist.

Type:

str

property album

The album that the song being played belongs to.

Type:

str

property album_cover_url

The album cover image URL from Spotify’s CDN.

Type:

str

property track_id

The track ID used by Spotify to identify this song.

Type:

str

property track_url

The track URL to listen on Spotify.

New in version 2.0.

Type:

str

property duration

The duration of the song being played, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.timedelta]

property party_id

The party ID of the listening party.

Type:

str

property created_at

When the user started doing this activity in UTC.

New in version 1.3.

Type:

Optional[datetime.datetime]

property end

When the user will stop doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

property start

When the user started doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

VoiceState

Attributes

• afk
• channel
• deaf
• mute
• requested_to_speak_at
• self_deaf
• self_mute
• self_stream
• self_video
• suppress

class disnake.VoiceState

Represents a Discord user’s voice state.

deaf

Whether the user is currently deafened by the guild.

Type:

bool

mute

Whether the user is currently muted by the guild.

Type:

bool

self_mute

Whether the user is currently muted by their own accord.

Type:

bool

self_deaf

Whether the user is currently deafened by their own accord.

Type:

bool

self_stream

Whether the user is currently streaming via ‘Go Live’ feature.

New in version 1.3.

Type:

bool

self_video

Whether the user is currently broadcasting video.

Type:

bool

suppress

Whether the user is suppressed from speaking.

Only applies to stage channels.

New in version 1.7.

Type:

bool

requested_to_speak_at

An aware datetime object that specifies the date and time in UTC that the member requested to speak. It will be None if they are not requesting to speak anymore or have been accepted to speak.

Only applies to stage channels.

New in version 1.7.

Type:

Optional[datetime.datetime]

afk

Whether the user is currently in the AFK channel in the guild.

Type:

bool

channel

The voice channel that the user is currently connected to. None if the user is not currently in a voice channel.

Type:

Optional[Union[VoiceChannel, StageChannel]]

Emoji

Attributes

• animated
• available
• created_at
• guild
• guild_id
• id
• managed
• name
• require_colons
• roles
• url
• user

Methods

• asyncdelete
• asyncedit
• defis_usable
• asyncread
• asyncsave
• asyncto_file

class disnake.Emoji

Represents a custom emoji.

Depending on the way this object was created, some of the attributes can have a value of None.

x == y

Checks if two emoji are the same.

x != y

Checks if two emoji are not the same.

hash(x)

Return the emoji’s hash.

iter(x)

Returns an iterator of (field, value) pairs. This allows this class to be used as an iterable in list/dict/etc constructions.

str(x)

Returns the emoji rendered for Discord.

name

The emoji’s name.

Type:

str

id

The emoji’s ID.

Type:

int

require_colons

Whether colons are required to use this emoji in the client (:PJSalt: vs PJSalt).

Type:

bool

animated

Whether the emoji is animated or not.

Type:

bool

managed

Whether the emoji is managed by a Twitch integration.

Type:

bool

guild_id

The guild ID the emoji belongs to.

Type:

int

available

Whether the emoji is available for use.

Type:

bool

user

The user that created the emoji. This can only be retrieved using Guild.fetch_emoji() and having manage_emojis permission.

Type:

Optional[User]

property created_at

Returns the emoji’s creation time in UTC.

Type:

datetime.datetime

property url

Returns the URL of the emoji.

Type:

str

property roles

A list of roles that are allowed to use this emoji.

If roles is empty, the emoji is unrestricted.

Type:

List[Role]

property guild

The guild this emoji belongs to.

Type:

Guild

is_usable()

Whether the bot can use this emoji.

New in version 1.3.

Return type:

bool

await delete(*, reason=None)

This function is a coroutine.

Deletes the custom emoji.

You must have manage_emojis permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this emoji. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to delete emojis.

• HTTPException – An error occurred deleting the emoji.

await edit(*, name=..., roles=..., reason=None)

This function is a coroutine.

Edits the custom emoji.

You must have manage_emojis permission to do this.

Changed in version 2.0: The newly updated emoji is returned.

Parameters:

• name (str) – The new emoji name.

• roles (Optional[List[Snowflake]]) – A list of roles that can use this emoji. An empty list can be passed to make it available to everyone.

• reason (Optional[str]) – The reason for editing this emoji. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to edit emojis.

• HTTPException – An error occurred editing the emoji.

Returns:

The newly updated emoji.

Return type:

Emoji

await read()

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

PartialEmoji

Attributes

• animated
• created_at
• id
• name
• url

Methods

• clsPartialEmoji.from_str
• defis_custom_emoji
• defis_unicode_emoji
• asyncread
• asyncsave
• asyncto_file

class disnake.PartialEmoji

Represents a “partial” emoji.

This model will be given in two scenarios:

• “Raw” data events such as on_raw_reaction_add()

• Custom emoji that the bot cannot see from e.g. Message.reactions

x == y

Checks if two emoji are the same.

x != y

Checks if two emoji are not the same.

hash(x)

Return the emoji’s hash.

str(x)

Returns the emoji rendered for Discord.

name

The custom emoji name, if applicable, or the unicode codepoint of the non-custom emoji. This can be None if the emoji got deleted (e.g. removing a reaction with a deleted emoji).

Type:

Optional[str]

animated

Whether the emoji is animated or not.

Type:

bool

id

The ID of the custom emoji, if applicable.

Type:

Optional[int]

classmethod from_str(value)

Converts a Discord string representation of an emoji to a PartialEmoji.

The formats accepted are:

• a:name:id

• <a:name:id>

• name:id

• <:name:id>

If the format does not match then it is assumed to be a unicode emoji.

New in version 2.0.

Parameters:

value (str) – The string representation of an emoji.

Returns:

The partial emoji from this string.

Return type:

PartialEmoji

is_custom_emoji()

Whether the partial emoji is a custom non-Unicode emoji.

Return type:

bool

is_unicode_emoji()

Whether the partial emoji is a Unicode emoji.

Return type:

bool

property created_at

Returns the emoji’s creation time in UTC, or None if it’s a Unicode emoji.

New in version 1.6.

Type:

Optional[datetime.datetime]

property url

Returns the URL of the emoji, if it is custom.

If this isn’t a custom emoji then an empty string is returned

Type:

str

await read()

This function is a coroutine.

Retrieves the data of this emoji as a bytes object.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Raises:

• TypeError – The emoji is not a custom emoji.

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

Role

Attributes

• color
• colour
• created_at
• emoji
• guild
• hoist
• icon
• id
• managed
• members
• mention
• mentionable
• name
• permissions
• position
• tags

Methods

• asyncdelete
• asyncedit
• defis_assignable
• defis_bot_managed
• defis_default
• defis_integration
• defis_linked_role
• defis_premium_subscriber

class disnake.Role

Represents a Discord role in a Guild.

x == y

Checks if two roles are equal.

x != y

Checks if two roles are not equal.

x > y

Checks if a role is higher than another in the hierarchy.

x < y

Checks if a role is lower than another in the hierarchy.

x >= y

Checks if a role is higher or equal to another in the hierarchy.

x <= y

Checks if a role is lower or equal to another in the hierarchy.

hash(x)

Return the role’s hash.

str(x)

Returns the role’s name.

id

The ID of the role.

Type:

int

name

The name of the role.

Type:

str

guild

The guild the role belongs to.

Type:

Guild

hoist

Indicates if the role will be displayed separately from other members.

Type:

bool

position

The position of the role. This number is usually positive. The bottom role has a position of 0.

Warning

Multiple roles can have the same position number. As a consequence of this, comparing via role position is prone to subtle bugs if checking for role hierarchy. The recommended and correct way to compare for roles in the hierarchy is using the comparison operators on the role objects themselves.

Type:

int

managed

Indicates if the role is managed by the guild through some form of integrations such as Twitch.

Type:

bool

mentionable

Indicates if the role can be mentioned by users.

Type:

bool

tags

The role tags associated with this role.

Type:

Optional[RoleTags]

is_default()

Checks if the role is the default role.

Return type:

bool

is_bot_managed()

Whether the role is associated with a bot.

New in version 1.6.

Return type:

bool

is_premium_subscriber()

Whether the role is the premium subscriber, AKA “boost”, role for the guild.

New in version 1.6.

Return type:

bool

is_linked_role()

Whether the role is a linked role for the guild.

New in version 2.8.

Return type:

bool

is_integration()

Whether the role is managed by an integration.

New in version 1.6.

Return type:

bool

is_assignable()

Whether the role is able to be assigned or removed by the bot.

New in version 2.0.

Return type:

bool

property permissions

Returns the role’s permissions.

Type:

Permissions

property colour

Returns the role colour. An alias exists under color.

Type:

Colour

property color

Returns the role color. An alias exists under colour.

Type:

Colour

property icon

Returns the role’s icon asset, if available.

New in version 2.0.

Type:

Optional[Asset]

property emoji

Returns the role’s emoji, if available.

New in version 2.0.

Type:

Optional[PartialEmoji]

property created_at

Returns the role’s creation time in UTC.

Type:

datetime.datetime

property mention

Returns a string that allows you to mention a role.

Type:

str

property members

Returns all the members with this role.

Type:

List[Member]

await edit(*, name=..., permissions=..., colour=..., color=..., hoist=..., icon=..., emoji=..., mentionable=..., position=..., reason=...)

This function is a coroutine.

Edits the role.

You must have the manage_roles permission to use this.

All fields are optional.

Changed in version 1.4: Can now pass int to colour keyword-only parameter.

Changed in version 2.0: Edits are no longer in-place, the newly edited role is returned instead.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• name (str) – The new role name to change to.

• permissions (Permissions) – The new permissions to change to.

• colour (Union[Colour, int]) – The new colour to change to. (aliased to color as well)

• hoist (bool) – Indicates if the role should be shown separately in the member list.

• icon (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The role’s new icon image (if the guild has the ROLE_ICONS feature).

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• emoji (Optional[str]) – The role’s new unicode emoji.

• mentionable (bool) – Indicates if the role should be mentionable by others.

• position (int) – The new role’s position. This must be below your top role’s position or it will fail.

• reason (Optional[str]) – The reason for editing this role. Shows up on the audit log.

Raises:

• NotFound – The icon asset couldn’t be found.

• Forbidden – You do not have permissions to change the role.

• HTTPException – Editing the role failed.

• TypeError – The default role was asked to be moved or the icon asset is a lottie sticker (see Sticker.read())

• ValueError – An invalid position was provided.

Returns:

The newly edited role.

Return type:

Role

await delete(*, reason=None)

This function is a coroutine.

Deletes the role.

You must have the manage_roles permission to use this.

Parameters:

reason (Optional[str]) – The reason for deleting this role. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to delete the role.

• HTTPException – Deleting the role failed.

RoleTags

Attributes

• bot_id
• integration_id

Methods

• defis_bot_managed
• defis_integration
• defis_linked_role
• defis_premium_subscriber

class disnake.RoleTags

Represents tags on a role.

A role tag is a piece of extra information attached to a managed role that gives it context for the reason the role is managed.

While this can be accessed, a useful interface is also provided in the Role and Guild classes as well.

New in version 1.6.

bot_id

The bot’s user ID that manages this role.

Type:

Optional[int]

integration_id

The integration ID that manages the role.

Type:

Optional[int]

is_bot_managed()

Whether the role is associated with a bot.

Return type:

bool

is_premium_subscriber()

Whether the role is the premium subscriber, AKA “boost”, role for the guild.

Return type:

bool

is_linked_role()

Whether the role is a linked role for the guild.

New in version 2.8.

Return type:

bool

is_integration()

Whether the role is managed by an integration.

Return type:

bool

PartialMessageable

Attributes

• id
• type

Methods

• asyncfetch_message
• defget_partial_message
• defhistory
• asyncpins
• asyncsend
• asynctrigger_typing
• deftyping

class disnake.PartialMessageable

Represents a partial messageable to aid with working messageable channels when only a channel ID is present.

The only way to construct this class is through Client.get_partial_messageable().

Note that this class is trimmed down and has no rich attributes.

New in version 2.0.

x == y

Checks if two partial messageables are equal.

x != y

Checks if two partial messageables are not equal.

hash(x)

Returns the partial messageable’s hash.

id

The channel ID associated with this partial messageable.

Type:

int

type

The channel type associated with this partial messageable, if given.

Type:

Optional[ChannelType]

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

get_partial_message(message_id, /)

Creates a PartialMessage from the given message ID.

This is useful if you want to work with a message and only have its ID without doing an unnecessary API call.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message object.

Return type:

PartialMessage

TextChannel

Attributes

• category
• category_id
• changed_roles
• created_at
• default_auto_archive_duration
• default_thread_slowmode_delay
• flags
• guild
• id
• jump_url
• last_message
• last_message_id
• last_pin_timestamp
• members
• mention
• name
• nsfw
• overwrites
• permissions_synced
• position
• slowmode_delay
• threads
• topic
• type

Methods

• defarchived_threads
• asyncclone
• asynccreate_invite
• asynccreate_thread
• asynccreate_webhook
• asyncdelete
• asyncdelete_messages
• asyncedit
• asyncfetch_message
• asyncfollow
• defget_partial_message
• defget_thread
• defhistory
• asyncinvites
• defis_news
• defis_nsfw
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncpins
• asyncpurge
• asyncsend
• asyncset_permissions
• asynctrigger_typing
• deftyping
• asyncwebhooks

class disnake.TextChannel

Represents a Discord guild text channel.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel’s hash.

str(x)

Returns the channel’s name.

name

The channel’s name.

Type:

str

guild

The guild the channel belongs to.

Type:

Guild

id

The channel’s ID.

Type:

int

category_id

The category channel ID this channel belongs to, if applicable.

Type:

Optional[int]

topic

The channel’s topic. None if it doesn’t exist.

Type:

Optional[str]

position

The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

Type:

int

last_message_id

The last message ID of the message sent to this channel. It may not point to an existing or valid message.

Type:

Optional[int]

slowmode_delay

The number of seconds a member must wait between sending messages in this channel.

A value of 0 denotes that it is disabled. Bots, and users with manage_channels or manage_messages permissions, bypass slowmode.

See also default_thread_slowmode_delay.

Type:

int

default_thread_slowmode_delay

The default number of seconds a member must wait between sending messages in newly created threads in this channel.

A value of 0 denotes that it is disabled. Bots, and users with manage_channels or manage_messages, bypass slowmode.

New in version 2.8.

Type:

int

nsfw

Whether the channel is marked as “not safe for work”.

Note

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Type:

bool

default_auto_archive_duration

The default auto archive duration in minutes for threads created in this channel.

New in version 2.0.

Type:

int

last_pin_timestamp

The time the most recent message was pinned, or None if no message is currently pinned.

New in version 2.5.

Type:

Optional[datetime.datetime]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property type

The channel’s Discord type.

This always returns ChannelType.text or ChannelType.news.

Type:

ChannelType

permissions_for(obj, /, *, ignore_timeout=...)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

• Guild owner

• Guild roles

• Channel overrides

• Member overrides

• Timeouts

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

• obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

• ignore_timeout (bool) –

  Whether or not to ignore the user’s timeout. Defaults to False.

  New in version 2.4.

  Note

  This only applies to Member objects.

  Changed in version 2.6: The default was changed to False.

Raises:

TypeError – ignore_timeout is only supported for Member objects.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

property members

Returns all members that can see this channel.

Type:

List[Member]

property threads

Returns all the threads that you can see.

New in version 2.0.

Type:

List[Thread]

is_nsfw()

Whether the channel is marked as NSFW.

Return type:

bool

is_news()

Whether the channel is a news channel.

Return type:

bool

property last_message

Gets the last message in this channel from the cache.

The message might not be valid or point to an existing message.

Reliable Fetching

For a slightly more reliable method of fetching the last message, consider using either history() or fetch_message() with the last_message_id attribute.

Returns:

The last message in this channel or None if not found.

Return type:

Optional[Message]

await edit(*, name=..., topic=..., position=..., nsfw=..., sync_permissions=..., category=..., slowmode_delay=..., default_thread_slowmode_delay=..., default_auto_archive_duration=..., type=..., overwrites=..., flags=..., reason=None, **kwargs)

This function is a coroutine.

Edits the channel.

You must have manage_channels permission to do this.

Changed in version 1.3: The overwrites keyword-only parameter was added.

Changed in version 1.4: The type keyword-only parameter was added.

Changed in version 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• name (str) – The new channel’s name.

• topic (Optional[str]) – The new channel’s topic.

• position (int) – The new channel’s position.

• nsfw (bool) – Whether to mark the channel as NSFW.

• sync_permissions (bool) – Whether to sync permissions with the channel’s new or pre-existing category. Defaults to False.

• category (Optional[abc.Snowflake]) – The new category for this channel. Can be None to remove the category.

• slowmode_delay (Optional[int]) – Specifies the slowmode rate limit for users in this channel, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600.

• default_thread_slowmode_delay (Optional[int]) –

  Specifies the slowmode rate limit at which users can send messages in newly created threads in this channel, in seconds. This does not apply retroactively to existing threads. A value of 0 or None disables slowmode. The maximum value possible is 21600.

  New in version 2.8.

• type (ChannelType) – The new type of this text channel. Currently, only conversion between ChannelType.text and ChannelType.news is supported. This is only available to guilds that contain NEWS in Guild.features.

• overwrites (Mapping) – A Mapping of target (either a role or a member) to PermissionOverwrite to apply to the channel.

• default_auto_archive_duration (Optional[Union[int, ThreadArchiveDuration]]) – The new default auto archive duration in minutes for threads created in this channel. Must be one of 60, 1440, 4320, or 10080.

• flags (ChannelFlags) –

  The new flags to set for this channel. This will overwrite any existing flags set on this channel.

  New in version 2.6.

• reason (Optional[str]) – The reason for editing this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit the channel.

• HTTPException – Editing the channel failed.

• TypeError – The permission overwrite information is not in proper form.

• ValueError – The position is less than 0.

Returns:

The newly edited text channel. If the edit was only positional then None is returned instead.

Return type:

Optional[TextChannel]

await clone(*, name=None, reason=None)

This function is a coroutine.

Clones this channel. This creates a channel with the same properties as this channel.

You must have Permissions.manage_channels permission to do this.

New in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

await delete_messages(messages)

This function is a coroutine.

Deletes a list of messages. This is similar to Message.delete() except it bulk deletes multiple messages.

As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then single message delete is done. If it’s more than two, then bulk delete is used.

You cannot bulk delete more than 100 messages or messages that are older than 14 days.

You must have manage_messages permission to do this.

Parameters:

messages (Iterable[abc.Snowflake]) – An iterable of messages denoting which ones to bulk delete.

Raises:

• ClientException – The number of messages to delete was more than 100.

• Forbidden – You do not have proper permissions to delete the messages.

• NotFound – If single delete, then the message was already deleted.

• HTTPException – Deleting the messages failed.

await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=False, bulk=True)

This function is a coroutine.

Purges a list of messages that meet the criteria given by the predicate check. If a check is not provided then all messages are deleted without discrimination.

You must have manage_messages permission to delete messages even if they are your own. read_message_history permission is also needed to retrieve message history.

Examples

Deleting bot’s messages

def is_me(m):
    return m.author == client.user

deleted = await channel.purge(limit=100, check=is_me)
await channel.send(f'Deleted {len(deleted)} message(s)')

Parameters:

• limit (Optional[int]) – The number of messages to search through. This is not the number of messages that will be deleted, though it can be.

• check (Callable[[Message], bool]) – The function used to check if a message should be deleted. It must take a Message as its sole parameter.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as before in history().

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as after in history().

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as around in history().

• oldest_first (Optional[bool]) – Same as oldest_first in history().

• bulk (bool) – If True, use bulk delete. Setting this to False is useful for mass-deleting a bot’s own messages without Permissions.manage_messages. When True, will fall back to single delete if messages are older than two weeks.

Raises:

• Forbidden – You do not have proper permissions to do the actions required.

• HTTPException – Purging the messages failed.

Returns:

A list of messages that were deleted.

Return type:

List[Message]

await webhooks()

This function is a coroutine.

Retrieves the list of webhooks this channel has.

You must have manage_webhooks permission to use this.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The list of webhooks this channel has.

Return type:

List[Webhook]

await create_webhook(*, name, avatar=None, reason=None)

This function is a coroutine.

Creates a webhook for this channel.

You must have manage_webhooks permission to do this.

Changed in version 1.1: The reason keyword-only parameter was added.

Parameters:

• name (str) – The webhook’s name.

• avatar (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The webhook’s default avatar. This operates similarly to edit().

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

• reason (Optional[str]) – The reason for creating this webhook. Shows up in the audit logs.

Raises:

• NotFound – The avatar asset couldn’t be found.

• Forbidden – You do not have permissions to create a webhook.

• HTTPException – Creating the webhook failed.

• TypeError – The avatar asset is a lottie sticker (see Sticker.read()).

Returns:

The newly created webhook.

Return type:

Webhook

await follow(*, destination, reason=None)

This function is a coroutine.

Follows a channel using a webhook.

Only news channels can be followed.

Note

The webhook returned will not provide a token to do webhook actions, as Discord does not provide it.

New in version 1.3.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• destination (TextChannel) – The channel you would like to follow from.

• reason (Optional[str]) –

  The reason for following the channel. Shows up on the destination guild’s audit log.

  New in version 1.4.

Raises:

• HTTPException – Following the channel failed.

• Forbidden – You do not have the permissions to create a webhook.

• TypeError – The current or provided channel is not of the correct type.

Returns:

The newly created webhook.

Return type:

Webhook

get_partial_message(message_id, /)

Creates a PartialMessage from the given message ID.

This is useful if you want to work with a message and only have its ID without doing an unnecessary API call.

New in version 1.6.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message object.

Return type:

PartialMessage

get_thread(thread_id, /)

Returns a thread with the given ID.

New in version 2.0.

Parameters:

thread_id (int) – The ID to search for.

Returns:

The returned thread or None if not found.

Return type:

Optional[Thread]

await create_thread(*, name, message=None, auto_archive_duration=None, type=None, invitable=None, slowmode_delay=None, reason=None)

This function is a coroutine.

Creates a thread in this text channel.

To create a public thread, you must have create_public_threads permission. For a private thread, create_private_threads permission is needed instead.

New in version 2.0.

Changed in version 2.5:

• Only one of message and type may be provided.

• type is now required if message is not provided.

Parameters:

• name (str) – The name of the thread.

• message (abc.Snowflake) –

  A snowflake representing the message to create the thread with.

  Changed in version 2.5: Cannot be provided with type.

• type (ChannelType) –

  The type of thread to create.

  Changed in version 2.5: Cannot be provided with message. Now required if message is not provided.

• auto_archive_duration (Union[int, ThreadArchiveDuration]) – The duration in minutes before a thread is automatically archived for inactivity. If not provided, the channel’s default auto archive duration is used. Must be one of 60, 1440, 4320, or 10080.

• invitable (bool) –

  Whether non-moderators can add other non-moderators to this thread. Only available for private threads. If a message is passed then this parameter is ignored, as a thread created with a message is always a public thread. Defaults to True.

  New in version 2.3.

• slowmode_delay (Optional[int]) –

  Specifies the slowmode rate limit for users in this thread, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If set to None or not provided, slowmode is inherited from the parent’s default_thread_slowmode_delay.

  New in version 2.3.

• reason (Optional[str]) – The reason for creating the thread. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to create a thread.

• HTTPException – Starting the thread failed.

Returns:

The newly created thread

Return type:

Thread

archived_threads(*, private=False, joined=False, limit=50, before=None)

Returns an AsyncIterator that iterates over all archived threads in the channel.

You must have read_message_history permission to use this. If iterating over private threads then manage_threads permission is also required.

New in version 2.0.

Parameters:

• limit (Optional[int]) – The number of threads to retrieve. If None, retrieves every archived thread in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve archived channels before the given date or ID.

• private (bool) – Whether to retrieve private archived threads.

• joined (bool) – Whether to retrieve private archived threads that you’ve joined. You cannot set joined to True and private to False.

Raises:

• Forbidden – You do not have permissions to get archived threads.

• HTTPException – The request to get the archived threads failed.

Yields:

Thread – The archived threads.

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the Guild.roles attribute.

Type:

List[Role]

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application=None, guild_scheduled_event=None)

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have Permissions.create_instant_invite permission to do this.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – Whether the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.

• unique (bool) – Whether a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.

• target_type (Optional[InviteTarget]) –

  The type of target for the voice channel invite, if any.

  New in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

  New in version 2.0.

• target_application (Optional[PartyType]) –

  The ID of the embedded application for the invite, required if target_type is TargetType.embedded_application.

  New in version 2.0.

• guild_scheduled_event (Optional[GuildScheduledEvent]) –

  The guild scheduled event to include with the invite.

  New in version 2.3.

• reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The newly created invite.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have Permissions.manage_channels permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

property flags

The channel flags for this channel.

New in version 2.6.

Type:

ChannelFlags

await invites()

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have Permissions.manage_channels permission to use this.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

property jump_url

A URL that can be used to jump to this channel.

New in version 2.4.

Note

This exists for all guild channels but may not be usable by the client for all guild channel types.

property mention

The string that allows you to mention the channel.

Type:

str

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have Permissions.manage_channels permission to do this.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

New in version 1.7.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• beginning (bool) – Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

• end (bool) – Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

• before (abc.Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (abc.Snowflake) – The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

• offset (int) – The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

• category (Optional[abc.Snowflake]) – The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

• sync_permissions (bool) – Whether to sync the permissions with the category (if given).

• reason (Optional[str]) – The reason for moving this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to move the channel.

• HTTPException – Moving the channel failed.

• TypeError – A bad mix of arguments were passed.

• ValueError – An invalid position was given.

property overwrites

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, abc.User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

New in version 1.3.

Type:

bool

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await set_permissions(target, *, overwrite=..., reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

The overwrite parameter, if given, must either be None or PermissionOverwrite. For convenience, you can pass in keyword arguments denoting Permissions attributes. If this is done, then you cannot mix the keyword arguments with the overwrite parameter.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have Permissions.manage_roles permission to do this.

Note

This method replaces the old overwrites with the ones given.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Examples

Setting allow and deny:

await message.channel.set_permissions(message.author, view_channel=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

Using PermissionOverwrite

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.view_channel = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• TypeError – overwrite is invalid, the target type was not Role or Member, both keyword arguments and overwrite were provided, or invalid permissions were provided as keyword arguments.

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

Thread

Attributes

• applied_tags
• archive_timestamp
• archived
• auto_archive_duration
• category
• category_id
• create_timestamp
• created_at
• flags
• guild
• id
• invitable
• jump_url
• last_message
• last_message_id
• last_pin_timestamp
• locked
• me
• member_count
• members
• mention
• message_count
• name
• owner
• owner_id
• parent
• parent_id
• slowmode_delay
• total_message_sent
• type

Methods

• asyncadd_tags
• asyncadd_user
• asyncdelete
• asyncdelete_messages
• asyncedit
• asyncfetch_member
• asyncfetch_members
• asyncfetch_message
• defget_partial_message
• defhistory
• defis_news
• defis_nsfw
• defis_pinned
• defis_private
• asyncjoin
• asyncleave
• defpermissions_for
• asyncpins
• asyncpurge
• asyncremove_tags
• asyncremove_user
• asyncsend
• asynctrigger_typing
• deftyping

class disnake.Thread

Represents a Discord thread.

x == y

Checks if two threads are equal.

x != y

Checks if two threads are not equal.

hash(x)

Returns the thread’s hash.

str(x)

Returns the thread’s name.

New in version 2.0.

name

The thread name.

Type:

str

guild

The guild the thread belongs to.

Type:

Guild

id

The thread ID.

Type:

int

parent_id

The parent TextChannel or ForumChannel ID this thread belongs to.

Type:

int

owner_id

The user’s ID that created this thread.

Type:

Optional[int]

last_message_id

The last message ID of the message sent to this thread. It may not point to an existing or valid message.

Type:

Optional[int]

slowmode_delay

The number of seconds a member must wait between sending messages in this thread. A value of 0 denotes that it is disabled. Bots, and users with manage_channels or manage_messages, bypass slowmode.

Type:

int

message_count

An approximate number of messages in this thread.

Note

If the thread was created before July 1, 2022, this could be inaccurate.

Type:

Optional[int]

member_count

An approximate number of members in this thread. This caps at 50.

Type:

Optional[int]

total_message_sent

The total number of messages sent in the thread, including deleted messages.

New in version 2.6.

Note

If the thread was created before July 1, 2022, this could be inaccurate.

Type:

Optional[int]

me

A thread member representing yourself, if you’ve joined the thread. This could not be available.

Type:

Optional[ThreadMember]

archived

Whether the thread is archived.

Type:

bool

locked

Whether the thread is locked.

Type:

bool

invitable

Whether non-moderators can add other non-moderators to this thread. This is always True for public threads.

Type:

bool

auto_archive_duration

The duration in minutes until the thread is automatically archived due to inactivity. Usually a value of 60, 1440, 4320 and 10080.

Type:

int

archive_timestamp

An aware timestamp of when the thread’s archived status was last updated in UTC.

Type:

datetime.datetime

create_timestamp

An aware timestamp of when the thread was created in UTC. This is only available for threads created after 2022-01-09.

New in version 2.4.

Type:

Optional[datetime.datetime]

last_pin_timestamp

The time the most recent message was pinned, or None if no message is currently pinned.

New in version 2.5.

Type:

Optional[datetime.datetime]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property type

The channel’s Discord type.

This always returns ChannelType.public_thread, ChannelType.private_thread, or ChannelType.news_thread.

Type:

ChannelType

property parent

The parent channel this thread belongs to.

Type:

Optional[Union[TextChannel, ForumChannel]]

property owner

The member this thread belongs to.

Type:

Optional[Member]

property mention

The string that allows you to mention the thread.

Type:

str

property members

A list of thread members in this thread.

This requires Intents.members to be properly filled. Most of the time however, this data is not provided by the gateway and a call to fetch_members() is needed.

Type:

List[ThreadMember]

property last_message

Gets the last message in this channel from the cache.

The message might not be valid or point to an existing message.

Reliable Fetching

For a slightly more reliable method of fetching the last message, consider using either history() or fetch_message() with the last_message_id attribute.

Returns:

The last message in this channel or None if not found.

Return type:

Optional[Message]

property category

The category channel the parent channel belongs to, if applicable.

Raises:

ClientException – The parent channel was not cached and returned None.

Returns:

The parent channel’s category.

Return type:

Optional[CategoryChannel]

property category_id

The category channel ID the parent channel belongs to, if applicable.

Raises:

ClientException – The parent channel was not cached and returned None.

Returns:

The parent channel’s category ID.

Return type:

Optional[int]

property created_at

Returns the thread’s creation time in UTC.

Changed in version 2.4: If create_timestamp is provided by discord, that will be used instead of the time in the ID.

Type:

datetime.datetime

property flags

The channel flags for this thread.

New in version 2.5.

Type:

ChannelFlags

property jump_url

A URL that can be used to jump to this thread.

New in version 2.4.

is_private()

Whether the thread is a private thread.

A private thread is only viewable by those that have been explicitly invited or have manage_threads permissions.

Return type:

bool

is_news()

Whether the thread is a news thread.

A news thread is a thread that has a parent that is a news channel, i.e. TextChannel.is_news() is True.

Return type:

bool

is_nsfw()

Whether the thread is NSFW or not.

An NSFW thread is a thread that has a parent that is an NSFW channel, i.e. TextChannel.is_nsfw() is True.

Return type:

bool

is_pinned()

Whether the thread is pinned in a ForumChannel

Pinned threads are not affected by the auto archive duration.

This is a shortcut to self.flags.pinned.

New in version 2.5.

Return type:

bool

property applied_tags

The tags currently applied to this thread. Only applicable to threads in ForumChannels.

New in version 2.6.

Type:

List[ForumTag]

permissions_for(obj, /, *, ignore_timeout=...)

Handles permission resolution for the Member or Role.

Since threads do not have their own permissions, they inherit them from the parent channel. This is a convenience method for calling permissions_for() on the parent channel.

Parameters:

• obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

• ignore_timeout (bool) –

  Whether or not to ignore the user’s timeout. Defaults to False.

  New in version 2.4.

  Note

  This only applies to Member objects.

  Changed in version 2.6: The default was changed to False.

Raises:

ClientException – The parent channel was not cached and returned None

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

await delete_messages(messages)

This function is a coroutine.

Deletes a list of messages. This is similar to Message.delete() except it bulk deletes multiple messages.

As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then single message delete is done. If it’s more than two, then bulk delete is used.

You cannot bulk delete more than 100 messages or messages that are older than 14 days old.

You must have the manage_messages permission to use this.

Usable only by bot accounts.

Parameters:

messages (Iterable[abc.Snowflake]) – An iterable of messages denoting which ones to bulk delete.

Raises:

• ClientException – The number of messages to delete was more than 100.

• Forbidden – You do not have proper permissions to delete the messages or you’re not using a bot account.

• NotFound – If single delete, then the message was already deleted.

• HTTPException – Deleting the messages failed.

await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=False, bulk=True)

This function is a coroutine.

Purges a list of messages that meet the criteria given by the predicate check. If a check is not provided then all messages are deleted without discrimination.

You must have the manage_messages permission to delete messages even if they are your own (unless you are a user account). The read_message_history permission is also needed to retrieve message history.

Examples

Deleting bot’s messages

def is_me(m):
    return m.author == client.user

deleted = await thread.purge(limit=100, check=is_me)
await thread.send(f'Deleted {len(deleted)} message(s)')

Parameters:

• limit (Optional[int]) – The number of messages to search through. This is not the number of messages that will be deleted, though it can be.

• check (Callable[[Message], bool]) – The function used to check if a message should be deleted. It must take a Message as its sole parameter.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as before in history().

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as after in history().

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as around in history().

• oldest_first (Optional[bool]) – Same as oldest_first in history().

• bulk (bool) – If True, use bulk delete. Setting this to False is useful for mass-deleting a bot’s own messages without Permissions.manage_messages. When True, will fall back to single delete if messages are older than two weeks.

Raises:

• Forbidden – You do not have proper permissions to do the actions required.

• HTTPException – Purging the messages failed.

Returns:

The list of messages that were deleted.

Return type:

List[Message]

await edit(*, name=..., archived=..., locked=..., invitable=..., slowmode_delay=..., auto_archive_duration=..., pinned=..., flags=..., applied_tags=..., reason=None)

This function is a coroutine.

Edits the thread.

Editing the thread requires Permissions.manage_threads. The thread creator can also edit name, archived, auto_archive_duration and applied_tags. Note that if the thread is locked then only those with Permissions.manage_threads can unarchive a thread.

The thread must be unarchived to be edited.

Parameters:

• name (str) – The new name of the thread.

• archived (bool) – Whether to archive the thread or not.

• locked (bool) – Whether to lock the thread or not.

• invitable (bool) – Whether non-moderators can add other non-moderators to this thread. Only available for private threads.

• auto_archive_duration (Union[int, ThreadArchiveDuration]) – The new duration in minutes before a thread is automatically archived for inactivity. Must be one of 60, 1440, 4320, or 10080.

• slowmode_delay (int) – Specifies the slowmode rate limit for users in this thread, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600.

• pinned (bool) –

  Whether to pin the thread or not. This is only available for threads created in a ForumChannel.

  New in version 2.5.

• flags (ChannelFlags) –

  The new channel flags to set for this thread. This will overwrite any existing flags set on this channel. If parameter pinned is provided, that will override the setting of ChannelFlags.pinned.

  New in version 2.6.

• applied_tags (Sequence[abc.Snowflake]) –

  The new tags of the thread. Maximum of 5. Can also be used to reorder existing tags.

  This is only available for threads in a ForumChannel.

  If moderated tags are edited, Permissions.manage_threads permissions are required.

  See also add_tags() and remove_tags().

  New in version 2.6.

• reason (Optional[str]) –

  The reason for editing this thread. Shows up on the audit log.

  New in version 2.5.

Raises:

• Forbidden – You do not have permissions to edit the thread.

• HTTPException – Editing the thread failed.

Returns:

The newly edited thread.

Return type:

Thread

await join()

This function is a coroutine.

Joins this thread.

You must have send_messages_in_threads to join a thread. If the thread is private, manage_threads is also needed.

Raises:

• Forbidden – You do not have permissions to join the thread.

• HTTPException – Joining the thread failed.

await leave()

This function is a coroutine.

Leaves this thread.

Raises:

HTTPException – Leaving the thread failed.

await add_user(user)

This function is a coroutine.

Adds a user to this thread.

You must have send_messages permission to add a user to a public thread. If the thread is private then send_messages and either create_private_threads or manage_messages permissions is required to add a user to the thread.

Parameters:

user (abc.Snowflake) – The user to add to the thread.

Raises:

• Forbidden – You do not have permissions to add the user to the thread.

• HTTPException – Adding the user to the thread failed.

await remove_user(user)

This function is a coroutine.

Removes a user from this thread.

You must have manage_threads or be the creator of the thread to remove a user.

Parameters:

user (abc.Snowflake) – The user to add to the thread.

Raises:

• Forbidden – You do not have permissions to remove the user from the thread.

• HTTPException – Removing the user from the thread failed.

await fetch_member(member_id, /)

This function is a coroutine.

Retrieves a single ThreadMember from this thread.

Parameters:

member_id (int) – The ID of the member to fetch.

Raises:

• NotFound – The specified member was not found.

• HTTPException – Retrieving the member failed.

Returns:

The thread member asked for.

Return type:

ThreadMember

await fetch_members()

This function is a coroutine.

Retrieves all ThreadMember that are in this thread.

This requires Intents.members to get information about members other than yourself.

Raises:

HTTPException – Retrieving the members failed.

Returns:

All thread members in the thread.

Return type:

List[ThreadMember]

await delete(*, reason=None)

This function is a coroutine.

Deletes this thread.

You must have manage_threads to delete threads. Alternatively, you may delete a thread if it’s in a ForumChannel, you are the thread creator, and there are no messages other than the initial message.

Parameters:

reason (Optional[str]) –

The reason for deleting this thread. Shows up on the audit log.

New in version 2.5.

Raises:

• Forbidden – You do not have permissions to delete this thread.

• HTTPException – Deleting the thread failed.

await add_tags(*tags, reason=None)

This function is a coroutine.

Adds the given tags to this thread, up to 5 in total.

The thread must be in a ForumChannel.

Adding tags requires you to have Permissions.manage_threads permissions, or be the owner of the thread. However, adding moderated tags always requires Permissions.manage_threads permissions.

New in version 2.6.

Parameters:

• *tags (abc.Snowflake) – An argument list of abc.Snowflake representing the ForumTags to add to the thread.

• reason (Optional[str]) – The reason for editing this thread. Shows up on the audit log.

Raises:

• Forbidden – You do not have permission to add these tags.

• HTTPException – Editing the thread failed.

await remove_tags(*tags, reason=None)

This function is a coroutine.

Removes the given tags from this thread.

The thread must be in a ForumChannel.

Removing tags requires you to have Permissions.manage_threads permissions, or be the owner of the thread. However, removing moderated tags always requires Permissions.manage_threads permissions.

New in version 2.6.

Parameters:

• *tags (abc.Snowflake) – An argument list of abc.Snowflake representing the ForumTags to remove from the thread.

• reason (Optional[str]) – The reason for editing this thread. Shows up on the audit log.

Raises:

• Forbidden – You do not have permission to remove these tags.

• HTTPException – Editing the thread failed.

get_partial_message(message_id, /)

Creates a PartialMessage from the message ID.

This is useful if you want to work with a message and only have its ID without doing an unnecessary API call.

New in version 2.0.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message.

Return type:

PartialMessage

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

ThreadMember

Attributes

• id
• joined_at
• thread
• thread_id

class disnake.ThreadMember

Represents a Discord thread member.

x == y

Checks if two thread members are equal.

x != y

Checks if two thread members are not equal.

hash(x)

Returns the thread member’s hash.

str(x)

Returns the thread member’s name.

New in version 2.0.

id

The thread member’s ID.

Type:

int

thread_id

The thread’s ID.

Type:

int

joined_at

The time the member joined the thread in UTC.

Type:

datetime.datetime

property thread

The thread this member belongs to.

Type:

Thread

ForumTag

Attributes

• emoji
• id
• moderated
• name

Methods

• defwith_changes

class disnake.ForumTag

Represents a tag for threads in forum channels.

x == y

Checks if two tags are equal.

x != y

Checks if two tags are not equal.

hash(x)

Returns the tag’s hash.

str(x)

Returns the tag’s name.

New in version 2.6.

Examples

Creating a new tag:

tags = forum.available_tags
tags.append(ForumTag(name="cool new tag", moderated=True))
await forum.edit(available_tags=tags)

Editing an existing tag:

tags = []
for tag in forum.available_tags:
    if tag.id == 1234:
        tag = tag.with_changes(name="whoa new name")
    tags.append(tag)
await forum.edit(available_tags=tags)

id

The tag’s ID. Note that if this tag was manually constructed, this will be 0.

Type:

int

name

The tag’s name.

Type:

str

moderated

Whether only moderators can add this tag to threads or remove it. Defaults to False.

Type:

bool

emoji

The emoji associated with this tag, if any. Due to a Discord limitation, this will have an empty name if it is a custom PartialEmoji.

Type:

Optional[Union[Emoji, PartialEmoji]]

with_changes(*, name=..., emoji=..., moderated=...)

Returns a new instance with the given changes applied, for easy use with ForumChannel.edit(). All other fields will be kept intact.

Returns:

The new tag instance.

Return type:

ForumTag

VoiceChannel

Attributes

• bitrate
• category
• category_id
• changed_roles
• created_at
• flags
• guild
• id
• jump_url
• last_message
• last_message_id
• members
• mention
• name
• nsfw
• overwrites
• permissions_synced
• position
• rtc_region
• slowmode_delay
• type
• user_limit
• video_quality_mode
• voice_states

Methods

• asyncclone
• asyncconnect
• asynccreate_invite
• asynccreate_webhook
• asyncdelete
• asyncdelete_messages
• asyncedit
• asyncfetch_message
• defget_partial_message
• defhistory
• asyncinvites
• defis_nsfw
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncpins
• asyncpurge
• asyncsend
• asyncset_permissions
• asynctrigger_typing
• deftyping
• asyncwebhooks

class disnake.VoiceChannel

Represents a Discord guild voice channel.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel’s hash.

str(x)

Returns the channel’s name.

name

The channel’s name.

Type:

str

guild

The guild the channel belongs to.

Type:

Guild

id

The channel’s ID.

Type:

int

category_id

The category channel ID this channel belongs to, if applicable.

Type:

Optional[int]

position

The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

Type:

int

bitrate

The channel’s preferred audio bitrate in bits per second.

Type:

int

user_limit

The channel’s limit for number of members that can be in a voice channel.

Type:

int

rtc_region

The region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

New in version 1.7.

Changed in version 2.5: No longer a VoiceRegion instance.

Type:

Optional[str]

video_quality_mode

The camera video quality for the voice channel’s participants.

Type:

VideoQualityMode

nsfw

Whether the channel is marked as “not safe for work”.

Note

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

New in version 2.3.

Type:

bool

slowmode_delay

The number of seconds a member must wait between sending messages in this channel. A value of 0 denotes that it is disabled. Bots, and users with manage_channels or manage_messages, bypass slowmode.

New in version 2.3.

Type:

int

last_message_id

The last message ID of the message sent to this channel. It may not point to an existing or valid message.

New in version 2.3.

Type:

Optional[int]

property type

The channel’s Discord type.

This always returns ChannelType.voice.

Type:

ChannelType

await clone(*, name=None, reason=None)

This function is a coroutine.

Clones this channel. This creates a channel with the same properties as this channel.

You must have Permissions.manage_channels permission to do this.

New in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

is_nsfw()

Whether the channel is marked as NSFW.

New in version 2.3.

Return type:

bool

property last_message

Gets the last message in this channel from the cache.

The message might not be valid or point to an existing message.

Reliable Fetching

For a slightly more reliable method of fetching the last message, consider using either history() or fetch_message() with the last_message_id attribute.

New in version 2.3.

Returns:

The last message in this channel or None if not found.

Return type:

Optional[Message]

get_partial_message(message_id, /)

Creates a PartialMessage from the given message ID.

This is useful if you want to work with a message and only have its ID without doing an unnecessary API call.

New in version 2.3.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message object.

Return type:

PartialMessage

permissions_for(obj, /, *, ignore_timeout=...)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

• Guild owner

• Guild roles

• Channel overrides

• Member overrides

• Timeouts

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

• obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

• ignore_timeout (bool) –

  Whether or not to ignore the user’s timeout. Defaults to False.

  New in version 2.4.

  Note

  This only applies to Member objects.

  Changed in version 2.6: The default was changed to False.

Raises:

TypeError – ignore_timeout is only supported for Member objects.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

await edit(*, name=..., bitrate=..., user_limit=..., position=..., sync_permissions=..., category=..., overwrites=..., rtc_region=..., video_quality_mode=..., nsfw=..., slowmode_delay=..., flags=..., reason=None, **kwargs)

This function is a coroutine.

Edits the channel.

You must have manage_channels permission to do this.

Changed in version 1.3: The overwrites keyword-only parameter was added.

Changed in version 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• name (str) – The new channel’s name.

• bitrate (int) – The new channel’s bitrate.

• user_limit (int) – The new channel’s user limit.

• position (int) – The new channel’s position.

• sync_permissions (bool) – Whether to sync permissions with the channel’s new or pre-existing category. Defaults to False.

• category (Optional[abc.Snowflake]) – The new category for this channel. Can be None to remove the category.

• reason (Optional[str]) – The reason for editing this channel. Shows up on the audit log.

• overwrites (Mapping) – A Mapping of target (either a role or a member) to PermissionOverwrite to apply to the channel.

• rtc_region (Optional[Union[str, VoiceRegion]]) –

  The new region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

  New in version 1.7.

• video_quality_mode (VideoQualityMode) –

  The camera video quality for the voice channel’s participants.

  New in version 2.0.

• nsfw (bool) –

  Whether to mark the channel as NSFW.

  New in version 2.3.

• slowmode_delay (Optional[int]) –

  Specifies the slowmode rate limit for users in this channel, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600.

  New in version 2.3.

• flags (ChannelFlags) –

  The new flags to set for this channel. This will overwrite any existing flags set on this channel.

  New in version 2.6.

Raises:

• Forbidden – You do not have permissions to edit the channel.

• HTTPException – Editing the channel failed.

• TypeError – The permission overwrite information is not in proper form.

• ValueError – The position is less than 0.

Returns:

The newly edited voice channel. If the edit was only positional then None is returned instead.

Return type:

Optional[VoiceChannel]

await delete_messages(messages)

This function is a coroutine.

Deletes a list of messages. This is similar to Message.delete() except it bulk deletes multiple messages.

As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then single message delete is done. If it’s more than two, then bulk delete is used.

You cannot bulk delete more than 100 messages or messages that are older than 14 days.

You must have manage_messages permission to do this.

New in version 2.5.

Parameters:

messages (Iterable[abc.Snowflake]) – An iterable of messages denoting which ones to bulk delete.

Raises:

• ClientException – The number of messages to delete was more than 100.

• Forbidden – You do not have proper permissions to delete the messages.

• NotFound – If single delete, then the message was already deleted.

• HTTPException – Deleting the messages failed.

await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=False, bulk=True)

This function is a coroutine.

Purges a list of messages that meet the criteria given by the predicate check. If a check is not provided then all messages are deleted without discrimination.

You must have manage_messages permission to delete messages even if they are your own. read_message_history permission is also needed to retrieve message history.

New in version 2.5.

Note

See TextChannel.purge() for examples.

Parameters:

• limit (Optional[int]) – The number of messages to search through. This is not the number of messages that will be deleted, though it can be.

• check (Callable[[Message], bool]) – The function used to check if a message should be deleted. It must take a Message as its sole parameter.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as before in history().

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as after in history().

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as around in history().

• oldest_first (Optional[bool]) – Same as oldest_first in history().

• bulk (bool) – If True, use bulk delete. Setting this to False is useful for mass-deleting a bot’s own messages without Permissions.manage_messages. When True, will fall back to single delete if messages are older than two weeks.

Raises:

• Forbidden – You do not have proper permissions to do the actions required.

• HTTPException – Purging the messages failed.

Returns:

A list of messages that were deleted.

Return type:

List[Message]

await webhooks()

This function is a coroutine.

Retrieves the list of webhooks this channel has.

You must have manage_webhooks permission to use this.

New in version 2.5.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The list of webhooks this channel has.

Return type:

List[Webhook]

await create_webhook(*, name, avatar=None, reason=None)

This function is a coroutine.

Creates a webhook for this channel.

You must have manage_webhooks permission to do this.

New in version 2.5.

Parameters:

• name (str) – The webhook’s name.

• avatar (Optional[bytes]) – The webhook’s default avatar. This operates similarly to edit().

• reason (Optional[str]) – The reason for creating this webhook. Shows up in the audit logs.

Raises:

• NotFound – The avatar asset couldn’t be found.

• Forbidden – You do not have permissions to create a webhook.

• HTTPException – Creating the webhook failed.

• TypeError – The avatar asset is a lottie sticker (see Sticker.read()).

Returns:

The newly created webhook.

Return type:

Webhook

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the Guild.roles attribute.

Type:

List[Role]

await connect(*, timeout=60.0, reconnect=True, cls=<class 'disnake.voice_client.VoiceClient'>)

This function is a coroutine.

Connects to voice and creates a VoiceClient to establish your connection to the voice server.

This requires Intents.voice_states.

Parameters:

• timeout (float) – The timeout in seconds to wait for the voice endpoint.

• reconnect (bool) – Whether the bot should automatically attempt a reconnect if a part of the handshake fails or the gateway goes down.

• cls (Type[VoiceProtocol]) – A type that subclasses VoiceProtocol to connect with. Defaults to VoiceClient.

Raises:

• asyncio.TimeoutError – Could not connect to the voice channel in time.

• ClientException – You are already connected to a voice channel.

• opus.OpusNotLoaded – The opus library has not been loaded.

Returns:

A voice client that is fully connected to the voice server.

Return type:

VoiceProtocol

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application=None, guild_scheduled_event=None)

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have Permissions.create_instant_invite permission to do this.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – Whether the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.

• unique (bool) – Whether a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.

• target_type (Optional[InviteTarget]) –

  The type of target for the voice channel invite, if any.

  New in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

  New in version 2.0.

• target_application (Optional[PartyType]) –

  The ID of the embedded application for the invite, required if target_type is TargetType.embedded_application.

  New in version 2.0.

• guild_scheduled_event (Optional[GuildScheduledEvent]) –

  The guild scheduled event to include with the invite.

  New in version 2.3.

• reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The newly created invite.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have Permissions.manage_channels permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

property flags

The channel flags for this channel.

New in version 2.6.

Type:

ChannelFlags

history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

await invites()

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have Permissions.manage_channels permission to use this.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

property jump_url

A URL that can be used to jump to this channel.

New in version 2.4.

Note

This exists for all guild channels but may not be usable by the client for all guild channel types.

property members

Returns all members that are currently inside this voice channel.

Type:

List[Member]

property mention

The string that allows you to mention the channel.

Type:

str

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have Permissions.manage_channels permission to do this.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

New in version 1.7.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• beginning (bool) – Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

• end (bool) – Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

• before (abc.Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (abc.Snowflake) – The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

• offset (int) – The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

• category (Optional[abc.Snowflake]) – The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

• sync_permissions (bool) – Whether to sync the permissions with the category (if given).

• reason (Optional[str]) – The reason for moving this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to move the channel.

• HTTPException – Moving the channel failed.

• TypeError – A bad mix of arguments were passed.

• ValueError – An invalid position was given.

property overwrites

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, abc.User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

New in version 1.3.

Type:

bool

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await set_permissions(target, *, overwrite=..., reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

The overwrite parameter, if given, must either be None or PermissionOverwrite. For convenience, you can pass in keyword arguments denoting Permissions attributes. If this is done, then you cannot mix the keyword arguments with the overwrite parameter.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have Permissions.manage_roles permission to do this.

Note

This method replaces the old overwrites with the ones given.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Examples

Setting allow and deny:

await message.channel.set_permissions(message.author, view_channel=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

Using PermissionOverwrite

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.view_channel = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• TypeError – overwrite is invalid, the target type was not Role or Member, both keyword arguments and overwrite were provided, or invalid permissions were provided as keyword arguments.

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property voice_states

Returns a mapping of member IDs who have voice states in this channel.

New in version 1.3.

Note

This function is intentionally low level to replace members when the member cache is unavailable.

Returns:

The mapping of member ID to a voice state.

Return type:

Mapping[int, VoiceState]

StageChannel

Attributes

• bitrate
• category
• category_id
• changed_roles
• created_at
• flags
• guild
• id
• instance
• jump_url
• listeners
• members
• mention
• moderators
• name
• overwrites
• permissions_synced
• position
• requesting_to_speak
• rtc_region
• speakers
• topic
• type
• user_limit
• video_quality_mode
• voice_states

Methods

• asyncclone
• asyncconnect
• asynccreate_instance
• asynccreate_invite
• asyncdelete
• asyncedit
• asyncfetch_instance
• asyncinvites
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncset_permissions

class disnake.StageChannel

Represents a Discord guild stage channel.

New in version 1.7.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel’s hash.

str(x)

Returns the channel’s name.

name

The channel’s name.

Type:

str

guild

The guild the channel belongs to.

Type:

Guild

id

The channel’s ID.

Type:

int

topic

The channel’s topic. None if it isn’t set.

Type:

Optional[str]

category_id

The category channel ID this channel belongs to, if applicable.

Type:

Optional[int]

position

The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

Type:

int

bitrate

The channel’s preferred audio bitrate in bits per second.

Type:

int

user_limit

The channel’s limit for number of members that can be in a stage channel.

Type:

int

rtc_region

The region for the stage channel’s voice communication. A value of None indicates automatic voice region detection.

Changed in version 2.5: No longer a VoiceRegion instance.

Type:

Optional[str]

video_quality_mode

The camera video quality for the stage channel’s participants.

New in version 2.0.

Type:

VideoQualityMode

property requesting_to_speak

A list of members who are requesting to speak in the stage channel.

Type:

List[Member]

property speakers

A list of members who have been permitted to speak in the stage channel.

New in version 2.0.

Type:

List[Member]

property listeners

A list of members who are listening in the stage channel.

New in version 2.0.

Type:

List[Member]

property moderators

A list of members who are moderating the stage channel.

New in version 2.0.

Type:

List[Member]

property type

The channel’s Discord type.

This always returns ChannelType.stage_voice.

Type:

ChannelType

await clone(*, name=None, reason=None)

This function is a coroutine.

Clones this channel. This creates a channel with the same properties as this channel.

You must have Permissions.manage_channels permission to do this.

New in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

property instance

The running stage instance of the stage channel.

New in version 2.0.

Type:

Optional[StageInstance]

permissions_for(obj, /, *, ignore_timeout=...)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

• Guild owner

• Guild roles

• Channel overrides

• Member overrides

• Timeouts

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

• obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

• ignore_timeout (bool) –

  Whether or not to ignore the user’s timeout. Defaults to False.

  New in version 2.4.

  Note

  This only applies to Member objects.

  Changed in version 2.6: The default was changed to False.

Raises:

TypeError – ignore_timeout is only supported for Member objects.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

await create_instance(*, topic, privacy_level=..., notify_everyone=False, reason=None)

This function is a coroutine.

Creates a stage instance.

You must have manage_channels permission to do this.

New in version 2.0.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• topic (str) – The stage instance’s topic.

• privacy_level (StagePrivacyLevel) – The stage instance’s privacy level. Defaults to StagePrivacyLevel.guild_only.

• reason (Optional[str]) – The reason the stage instance was created. Shows up on the audit log.

• notify_everyone (bool) –

  Whether to notify @everyone that the stage instance has started. Requires the mention_everyone permission on the stage channel. Defaults to False.

  New in version 2.5.

Raises:

• Forbidden – You do not have permissions to create a stage instance.

• HTTPException – Creating a stage instance failed.

• TypeError – If the privacy_level parameter is not the proper type.

Returns:

The newly created stage instance.

Return type:

StageInstance

await fetch_instance()

This function is a coroutine.

Retrieves the running StageInstance.

New in version 2.0.

Raises:

• NotFound – The stage instance or channel could not be found.

• HTTPException – Retrieving the stage instance failed.

Returns:

The stage instance.

Return type:

StageInstance

await edit(*, name=..., position=..., sync_permissions=..., category=..., overwrites=..., rtc_region=..., video_quality_mode=..., bitrate=..., flags=..., reason=None, **kwargs)

This function is a coroutine.

Edits the channel.

You must have manage_channels permission to do this.

Changed in version 2.0: The topic parameter must now be set via create_instance.

Changed in version 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• name (str) – The new channel’s name.

• position (int) – The new channel’s position.

• sync_permissions (bool) – Whether to sync permissions with the channel’s new or pre-existing category. Defaults to False.

• category (Optional[abc.Snowflake]) – The new category for this channel. Can be None to remove the category.

• overwrites (Mapping) – A Mapping of target (either a role or a member) to PermissionOverwrite to apply to the channel.

• rtc_region (Optional[Union[str, VoiceRegion]]) – The new region for the stage channel’s voice communication. A value of None indicates automatic voice region detection.

• video_quality_mode (VideoQualityMode) –

  The camera video quality for the stage channel’s participants.

  New in version 2.0.

• bitrate (int) –

  The new channel’s bitrate.

  New in version 2.6.

• flags (ChannelFlags) –

  The new flags to set for this channel. This will overwrite any existing flags set on this channel.

  New in version 2.6.

• reason (Optional[str]) – The reason for editing this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit the channel.

• HTTPException – Editing the channel failed.

• TypeError – The permission overwrite information is not in proper form.

• ValueError – The position is less than 0.

Returns:

The newly edited stage channel. If the edit was only positional then None is returned instead.

Return type:

Optional[StageChannel]

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the Guild.roles attribute.

Type:

List[Role]

await connect(*, timeout=60.0, reconnect=True, cls=<class 'disnake.voice_client.VoiceClient'>)

This function is a coroutine.

Connects to voice and creates a VoiceClient to establish your connection to the voice server.

This requires Intents.voice_states.

Parameters:

• timeout (float) – The timeout in seconds to wait for the voice endpoint.

• reconnect (bool) – Whether the bot should automatically attempt a reconnect if a part of the handshake fails or the gateway goes down.

• cls (Type[VoiceProtocol]) – A type that subclasses VoiceProtocol to connect with. Defaults to VoiceClient.

Raises:

• asyncio.TimeoutError – Could not connect to the voice channel in time.

• ClientException – You are already connected to a voice channel.

• opus.OpusNotLoaded – The opus library has not been loaded.

Returns:

A voice client that is fully connected to the voice server.

Return type:

VoiceProtocol

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application=None, guild_scheduled_event=None)

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have Permissions.create_instant_invite permission to do this.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – Whether the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.

• unique (bool) – Whether a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.

• target_type (Optional[InviteTarget]) –

  The type of target for the voice channel invite, if any.

  New in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

  New in version 2.0.

• target_application (Optional[PartyType]) –

  The ID of the embedded application for the invite, required if target_type is TargetType.embedded_application.

  New in version 2.0.

• guild_scheduled_event (Optional[GuildScheduledEvent]) –

  The guild scheduled event to include with the invite.

  New in version 2.3.

• reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The newly created invite.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have Permissions.manage_channels permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

property flags

The channel flags for this channel.

New in version 2.6.

Type:

ChannelFlags

await invites()

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have Permissions.manage_channels permission to use this.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

property jump_url

A URL that can be used to jump to this channel.

New in version 2.4.

Note

This exists for all guild channels but may not be usable by the client for all guild channel types.

property members

Returns all members that are currently inside this voice channel.

Type:

List[Member]

property mention

The string that allows you to mention the channel.

Type:

str

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have Permissions.manage_channels permission to do this.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

New in version 1.7.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• beginning (bool) – Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

• end (bool) – Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

• before (abc.Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (abc.Snowflake) – The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

• offset (int) – The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

• category (Optional[abc.Snowflake]) – The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

• sync_permissions (bool) – Whether to sync the permissions with the category (if given).

• reason (Optional[str]) – The reason for moving this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to move the channel.

• HTTPException – Moving the channel failed.

• TypeError – A bad mix of arguments were passed.

• ValueError – An invalid position was given.

property overwrites

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, abc.User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

New in version 1.3.

Type:

bool

await set_permissions(target, *, overwrite=..., reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

The overwrite parameter, if given, must either be None or PermissionOverwrite. For convenience, you can pass in keyword arguments denoting Permissions attributes. If this is done, then you cannot mix the keyword arguments with the overwrite parameter.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have Permissions.manage_roles permission to do this.

Note

This method replaces the old overwrites with the ones given.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Examples

Setting allow and deny:

await message.channel.set_permissions(message.author, view_channel=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

Using PermissionOverwrite

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.view_channel = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• TypeError – overwrite is invalid, the target type was not Role or Member, both keyword arguments and overwrite were provided, or invalid permissions were provided as keyword arguments.

property voice_states

Returns a mapping of member IDs who have voice states in this channel.

New in version 1.3.

Note

This function is intentionally low level to replace members when the member cache is unavailable.

Returns:

The mapping of member ID to a voice state.

Return type:

Mapping[int, VoiceState]

ForumChannel

Attributes

• available_tags
• category
• category_id
• changed_roles
• created_at
• default_auto_archive_duration
• default_layout
• default_reaction
• default_sort_order
• default_thread_slowmode_delay
• flags
• guild
• id
• jump_url
• last_thread
• last_thread_id
• members
• mention
• name
• nsfw
• overwrites
• permissions_synced
• position
• slowmode_delay
• threads
• topic
• type

Methods

• defarchived_threads
• asyncclone
• asynccreate_invite
• asynccreate_thread
• asynccreate_webhook
• asyncdelete
• asyncedit
• defget_tag
• defget_tag_by_name
• defget_thread
• asyncinvites
• defis_nsfw
• asyncmove
• defoverwrites_for
• defpermissions_for
• defrequires_tag
• asyncset_permissions
• asynctrigger_typing
• deftyping
• asyncwebhooks

class disnake.ForumChannel

Represents a Discord Forum channel.

New in version 2.5.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel’s hash.

str(x)

Returns the channel’s name.

id

The channel’s ID.

Type:

int

name

The channel’s name.

Type:

str

guild

The guild the channel belongs to.

Type:

Guild

topic

The channel’s topic. None if it isn’t set.

Type:

Optional[str]

category_id

The category channel ID this channel belongs to, if applicable.

Type:

Optional[int]

position

The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

Type:

int

nsfw

Whether the channel is marked as “not safe for work”.

Note

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Type:

bool

last_thread_id

The ID of the last created thread in this channel. It may not point to an existing or valid thread.

Type:

Optional[int]

default_auto_archive_duration

The default auto archive duration in minutes for threads created in this channel.

Type:

int

slowmode_delay

The number of seconds a member must wait between creating threads in this channel.

A value of 0 denotes that it is disabled. Bots, and users with manage_channels or manage_messages, bypass slowmode.

See also default_thread_slowmode_delay.

Type:

int

default_thread_slowmode_delay

The default number of seconds a member must wait between sending messages in newly created threads in this channel.

A value of 0 denotes that it is disabled. Bots, and users with manage_channels or manage_messages, bypass slowmode.

New in version 2.6.

Type:

int

default_sort_order

The default sort order of threads in this channel. Members will still be able to change this locally.

New in version 2.6.

Type:

Optional[ThreadSortOrder]

default_layout

The default layout of threads in this channel. Members will still be able to change this locally.

New in version 2.8.

Type:

ThreadLayout

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property type

The channel’s Discord type.

This always returns ChannelType.forum.

Type:

ChannelType

permissions_for(obj, /, *, ignore_timeout=...)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

• Guild owner

• Guild roles

• Channel overrides

• Member overrides

• Timeouts

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

• obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

• ignore_timeout (bool) –

  Whether or not to ignore the user’s timeout. Defaults to False.

  New in version 2.4.

  Note

  This only applies to Member objects.

  Changed in version 2.6: The default was changed to False.

Raises:

TypeError – ignore_timeout is only supported for Member objects.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

property members

Returns all members that can see this channel.

Type:

List[Member]

property threads

Returns all the threads that you can see.

Type:

List[Thread]

is_nsfw()

Whether the channel is marked as NSFW.

Return type:

bool

requires_tag()

Whether all newly created threads in this channel are required to have a tag.

This is a shortcut to self.flags.require_tag.

New in version 2.6.

Return type:

bool

property default_reaction

Optional[Union[Emoji, PartialEmoji]]: The default emoji shown for reacting to threads.

Due to a Discord limitation, this will have an empty name if it is a custom PartialEmoji.

New in version 2.6.

property last_thread

Gets the last created thread in this channel from the cache.

The thread might not be valid or point to an existing thread.

Reliable Fetching

For a slightly more reliable method of fetching the last thread, use Guild.fetch_channel() with the last_thread_id attribute.

Returns:

The last created thread in this channel or None if not found.

Return type:

Optional[Thread]

property available_tags

The available tags for threads in this forum channel.

To create/edit/delete tags, use edit().

New in version 2.6.

Type:

List[ForumTag]

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the desination.

Typing indicator will go away after 10 seconds.

await edit(*, name=..., topic=..., position=..., nsfw=..., sync_permissions=..., category=..., slowmode_delay=..., default_thread_slowmode_delay=..., default_auto_archive_duration=..., overwrites=..., flags=..., require_tag=..., available_tags=..., default_reaction=..., default_sort_order=..., default_layout=..., reason=None, **kwargs)

This function is a coroutine.

Edits the channel.

You must have manage_channels permission to do this.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• name (str) – The channel’s new name.

• topic (Optional[str]) – The channel’s new topic.

• position (int) – The channel’s new position.

• nsfw (bool) – Whether to mark the channel as NSFW.

• sync_permissions (bool) – Whether to sync permissions with the channel’s new or pre-existing category. Defaults to False.

• category (Optional[abc.Snowflake]) – The new category for this channel. Can be None to remove the category.

• slowmode_delay (Optional[int]) – Specifies the slowmode rate limit at which users can create threads in this channel, in seconds. A value of 0 or None disables slowmode. The maximum value possible is 21600.

• default_thread_slowmode_delay (Optional[int]) –

  Specifies the slowmode rate limit at which users can send messages in newly created threads in this channel, in seconds. This does not apply retroactively to existing threads. A value of 0 or None disables slowmode. The maximum value possible is 21600.

  New in version 2.6.

• overwrites (Mapping) – A Mapping of target (either a role or a member) to PermissionOverwrite to apply to the channel.

• default_auto_archive_duration (Optional[Union[int, ThreadArchiveDuration]]) – The new default auto archive duration in minutes for threads created in this channel. Must be one of 60, 1440, 4320, or 10080.

• flags (ChannelFlags) –

  The new flags to set for this channel. This will overwrite any existing flags set on this channel. If parameter require_tag is provided, that will override the setting of ChannelFlags.require_tag.

  New in version 2.6.

• require_tag (bool) –

  Whether all newly created threads are required to have a tag.

  New in version 2.6.

• available_tags (Sequence[ForumTag]) –

  The new ForumTags available for threads in this channel. Can be used to create new tags and edit/reorder/delete existing tags. Maximum of 20.

  Note that this overwrites all tags, removing existing tags unless they’re passed as well.

  See ForumTag for examples regarding creating/editing tags.

  New in version 2.6.

• default_reaction (Optional[Union[str, Emoji, PartialEmoji]]) –

  The new default emoji shown for reacting to threads.

  New in version 2.6.

• default_sort_order (Optional[ThreadSortOrder]) –

  The new default sort order of threads in this channel.

  New in version 2.6.

• default_layout (ThreadLayout) –

  The new default layout of threads in this channel.

  New in version 2.8.

• reason (Optional[str]) – The reason for editing this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit the channel.

• HTTPException – Editing the channel failed.

• TypeError – The permission overwrite information is not in proper form.

• ValueError – The position is less than 0.

Returns:

The newly edited forum channel. If the edit was only positional then None is returned instead.

Return type:

Optional[ForumChannel]

await clone(*, name=None, reason=None)

This function is a coroutine.

Clones this channel. This creates a channel with the same properties as this channel.

You must have Permissions.manage_channels permission to do this.

New in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

get_thread(thread_id, /)

Returns a thread with the given ID.

Parameters:

thread_id (int) – The ID to search for.

Returns:

The returned thread of None if not found.

Return type:

Optional[Thread]

await create_thread(*, name, auto_archive_duration=..., slowmode_delay=..., applied_tags=..., content=..., embed=..., embeds=..., file=..., files=..., suppress_embeds=..., stickers=..., allowed_mentions=..., view=..., components=..., reason=None)

This function is a coroutine.

Creates a thread in this forum channel.

You must have the create_forum_threads permission to do this.

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Changed in version 2.6: The content parameter is no longer required.

Parameters:

• name (str) – The name of the thread.

• auto_archive_duration (Union[int, ThreadArchiveDuration]) – The duration in minutes before the thread is automatically archived for inactivity. If not provided, the channel’s default auto archive duration is used. Must be one of 60, 1440, 4320, or 10080.

• slowmode_delay (Optional[int]) – Specifies the slowmode rate limit for users in this thread, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600. If set to None or not provided, slowmode is inherited from the parent’s default_thread_slowmode_delay.

• applied_tags (Sequence[abc.Snowflake]) –

  The tags to apply to the new thread. Maximum of 5.

  New in version 2.6.

• content (str) – The content of the message to send.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) – A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

• suppress_embeds (bool) – Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) – A list of stickers to upload. Must be a maximum of 3.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

• view (ui.View) – A Discord UI View to add to the message. This cannot be mixed with components.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) – A list of components to include in the message. This cannot be mixed with view.

• reason (Optional[str]) – The reason for creating the thread. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to create a thread.

• HTTPException – Starting the thread failed.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components. or you have passed an object that is not File to file or files.

• ValueError – Specified more than 10 embeds, or more than 10 files.

Returns:

A NamedTuple with the newly created thread and the message sent in it.

These values can also be accessed through the thread and message fields.

Return type:

Tuple[Thread, Message]

archived_threads(*, limit=50, before=None)

Returns an AsyncIterator that iterates over all archived threads in the channel.

You must have read_message_history permission to use this.

Parameters:

• limit (Optional[int]) – The number of threads to retrieve. If None, retrieves every archived thread in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve archived channels before the given date or ID.

Raises:

• Forbidden – You do not have permissions to get archived threads.

• HTTPException – The request to get the archived threads failed.

Yields:

Thread – The archived threads.

await webhooks()

This function is a coroutine.

Retrieves the list of webhooks this channel has.

You must have manage_webhooks permission to use this.

New in version 2.6.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The list of webhooks this channel has.

Return type:

List[Webhook]

await create_webhook(*, name, avatar=None, reason=None)

This function is a coroutine.

Creates a webhook for this channel.

You must have manage_webhooks permission to do this.

New in version 2.6.

Parameters:

• name (str) – The webhook’s name.

• avatar (Optional[bytes]) – The webhook’s default avatar. This operates similarly to edit().

• reason (Optional[str]) – The reason for creating this webhook. Shows up in the audit logs.

Raises:

• NotFound – The avatar asset couldn’t be found.

• Forbidden – You do not have permissions to create a webhook.

• HTTPException – Creating the webhook failed.

• TypeError – The avatar asset is a lottie sticker (see Sticker.read()).

Returns:

The newly created webhook.

Return type:

Webhook

get_tag(tag_id, /)

Returns a thread tag with the given ID.

New in version 2.6.

Parameters:

tag_id (int) – The ID to search for.

Returns:

The tag with the given ID, or None if not found.

Return type:

Optional[ForumTag]

get_tag_by_name(name, /)

Returns a thread tag with the given name.

Tags can be uniquely identified based on the name, as tag names in a forum channel must be unique.

New in version 2.6.

Parameters:

name (str) – The name to search for.

Returns:

The tag with the given name, or None if not found.

Return type:

Optional[ForumTag]

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the Guild.roles attribute.

Type:

List[Role]

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application=None, guild_scheduled_event=None)

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have Permissions.create_instant_invite permission to do this.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – Whether the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.

• unique (bool) – Whether a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.

• target_type (Optional[InviteTarget]) –

  The type of target for the voice channel invite, if any.

  New in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

  New in version 2.0.

• target_application (Optional[PartyType]) –

  The ID of the embedded application for the invite, required if target_type is TargetType.embedded_application.

  New in version 2.0.

• guild_scheduled_event (Optional[GuildScheduledEvent]) –

  The guild scheduled event to include with the invite.

  New in version 2.3.

• reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The newly created invite.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have Permissions.manage_channels permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

property flags

The channel flags for this channel.

New in version 2.6.

Type:

ChannelFlags

await invites()

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have Permissions.manage_channels permission to use this.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

property jump_url

A URL that can be used to jump to this channel.

New in version 2.4.

Note

This exists for all guild channels but may not be usable by the client for all guild channel types.

property mention

The string that allows you to mention the channel.

Type:

str

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have Permissions.manage_channels permission to do this.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

New in version 1.7.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• beginning (bool) – Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

• end (bool) – Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

• before (abc.Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (abc.Snowflake) – The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

• offset (int) – The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

• category (Optional[abc.Snowflake]) – The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

• sync_permissions (bool) – Whether to sync the permissions with the category (if given).

• reason (Optional[str]) – The reason for moving this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to move the channel.

• HTTPException – Moving the channel failed.

• TypeError – A bad mix of arguments were passed.

• ValueError – An invalid position was given.

property overwrites

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, abc.User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

New in version 1.3.

Type:

bool

await set_permissions(target, *, overwrite=..., reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

The overwrite parameter, if given, must either be None or PermissionOverwrite. For convenience, you can pass in keyword arguments denoting Permissions attributes. If this is done, then you cannot mix the keyword arguments with the overwrite parameter.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have Permissions.manage_roles permission to do this.

Note

This method replaces the old overwrites with the ones given.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Examples

Setting allow and deny:

await message.channel.set_permissions(message.author, view_channel=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

Using PermissionOverwrite

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.view_channel = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• TypeError – overwrite is invalid, the target type was not Role or Member, both keyword arguments and overwrite were provided, or invalid permissions were provided as keyword arguments.

StageInstance

Attributes

• channel
• channel_id
• discoverable_disabled
• guild
• guild_scheduled_event
• guild_scheduled_event_id
• id
• privacy_level
• topic

Methods

• asyncdelete
• asyncedit
• defis_public

class disnake.StageInstance

Represents a stage instance of a stage channel in a guild.

New in version 2.0.

x == y

Checks if two stage instances are equal.

x != y

Checks if two stage instances are not equal.

hash(x)

Returns the stage instance’s hash.

id

The stage instance’s ID.

Type:

int

guild

The guild that the stage instance is running in.

Type:

Guild

channel_id

The ID of the channel that the stage instance is running in.

Type:

int

topic

The topic of the stage instance.

Type:

str

privacy_level

The privacy level of the stage instance.

Type:

StagePrivacyLevel

guild_scheduled_event_id

The ID of the stage instance’s associated scheduled event, if applicable. See also guild_scheduled_event.

Type:

Optional[int]

channel

The channel that stage instance is running in.

Type:

Optional[StageChannel]

property discoverable_disabled

Whether discoverability for the stage instance is disabled.

Deprecated since version 2.5: Stages can no longer be discoverable.

Type:

bool

is_public()

Whether the stage instance is public.

Deprecated since version 2.5: Stages can no longer be public.

Return type:

bool

property guild_scheduled_event

The stage instance’s scheduled event.

This is only set if this stage instance has an associated scheduled event, and requires that event to be cached (which requires the guild_scheduled_events intent).

Type:

Optional[GuildScheduledEvent]

await edit(*, topic=..., privacy_level=..., reason=None)

This function is a coroutine.

Edits the stage instance.

You must have the manage_channels permission to use this.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• topic (str) – The stage instance’s new topic.

• privacy_level (StagePrivacyLevel) – The stage instance’s new privacy level.

• reason (Optional[str]) – The reason the stage instance was edited. Shows up on the audit log.

Raises:

• TypeError – If the privacy_level parameter is not the proper type.

• Forbidden – You do not have permissions to edit the stage instance.

• HTTPException – Editing a stage instance failed.

await delete(*, reason=None)

This function is a coroutine.

Deletes the stage instance.

You must have the manage_channels permission to use this.

Parameters:

reason (Optional[str]) – The reason the stage instance was deleted. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to delete the stage instance.

• HTTPException – Deleting the stage instance failed.

CategoryChannel

Attributes

• category
• changed_roles
• channels
• created_at
• flags
• forum_channels
• guild
• id
• jump_url
• mention
• name
• nsfw
• overwrites
• permissions_synced
• position
• stage_channels
• text_channels
• type
• voice_channels

Methods

• asyncclone
• asynccreate_forum_channel
• asynccreate_invite
• asynccreate_stage_channel
• asynccreate_text_channel
• asynccreate_voice_channel
• asyncdelete
• asyncedit
• asyncinvites
• defis_nsfw
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncset_permissions

class disnake.CategoryChannel

Represents a Discord channel category.

These are useful to group channels to logical compartments.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the category’s hash.

str(x)

Returns the category’s name.

name

The category name.

Type:

str

guild

The guild the category belongs to.

Type:

Guild

id

The category channel ID.

Type:

int

position

The position in the category list. This is a number that starts at 0. e.g. the top category is position 0.

Type:

int

nsfw

If the channel is marked as “not safe for work”.

Note

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Type:

bool

property type

The channel’s Discord type.

This always returns ChannelType.category.

Type:

ChannelType

is_nsfw()

Whether the category is marked as NSFW.

Return type:

bool

await clone(*, name=None, reason=None)

This function is a coroutine.

Clones this channel. This creates a channel with the same properties as this channel.

You must have Permissions.manage_channels permission to do this.

New in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

await edit(*, name=..., position=..., nsfw=..., overwrites=..., flags=..., reason=None, **kwargs)

This function is a coroutine.

Edits the category.

You must have manage_channels permission to do this.

Changed in version 1.3: The overwrites keyword-only parameter was added.

Changed in version 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• name (str) – The new category’s name.

• position (int) – The new category’s position.

• nsfw (bool) – Whether to mark the category as NSFW.

• overwrites (Mapping) – A Mapping of target (either a role or a member) to PermissionOverwrite to apply to the category.

• flags (ChannelFlags) –

  The new flags to set for this channel. This will overwrite any existing flags set on this channel.

  New in version 2.6.

• reason (Optional[str]) – The reason for editing this category. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit the category.

• HTTPException – Editing the category failed.

• TypeError – The permission overwrite information is not in proper form.

• ValueError – The position is less than 0.

Returns:

The newly edited category channel. If the edit was only positional then None is returned instead.

Return type:

Optional[CategoryChannel]

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have Permissions.manage_channels permission to do this.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

New in version 1.7.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• beginning (bool) – Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

• end (bool) – Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

• before (abc.Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (abc.Snowflake) – The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

• offset (int) – The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

• category (Optional[abc.Snowflake]) – The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

• sync_permissions (bool) – Whether to sync the permissions with the category (if given).

• reason (Optional[str]) – The reason for moving this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to move the channel.

• HTTPException – Moving the channel failed.

• TypeError – A bad mix of arguments were passed.

• ValueError – An invalid position was given.

property channels

Returns the channels that are under this category.

These are sorted by the official Discord UI, which places voice channels below the text channels.

Type:

List[abc.GuildChannel]

property text_channels

Returns the text channels that are under this category.

Type:

List[TextChannel]

property voice_channels

Returns the voice channels that are under this category.

Type:

List[VoiceChannel]

property stage_channels

Returns the stage channels that are under this category.

New in version 1.7.

Type:

List[StageChannel]

property forum_channels

Returns the forum channels that are under this category.

New in version 2.5.

Type:

List[ForumChannel]

await create_text_channel(name, **options)

This function is a coroutine.

A shortcut method to Guild.create_text_channel() to create a TextChannel in the category.

Returns:

The newly created text channel.

Return type:

TextChannel

await create_voice_channel(name, **options)

This function is a coroutine.

A shortcut method to Guild.create_voice_channel() to create a VoiceChannel in the category.

Returns:

The newly created voice channel.

Return type:

VoiceChannel

await create_stage_channel(name, **options)

This function is a coroutine.

A shortcut method to Guild.create_stage_channel() to create a StageChannel in the category.

New in version 1.7.

Returns:

The newly created stage channel.

Return type:

StageChannel

await create_forum_channel(name, **options)

This function is a coroutine.

A shortcut method to Guild.create_forum_channel() to create a ForumChannel in the category.

New in version 2.5.

Returns:

The newly created forum channel.

Return type:

ForumChannel

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the Guild.roles attribute.

Type:

List[Role]

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application=None, guild_scheduled_event=None)

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have Permissions.create_instant_invite permission to do this.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – Whether the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.

• unique (bool) – Whether a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.

• target_type (Optional[InviteTarget]) –

  The type of target for the voice channel invite, if any.

  New in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

  New in version 2.0.

• target_application (Optional[PartyType]) –

  The ID of the embedded application for the invite, required if target_type is TargetType.embedded_application.

  New in version 2.0.

• guild_scheduled_event (Optional[GuildScheduledEvent]) –

  The guild scheduled event to include with the invite.

  New in version 2.3.

• reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The newly created invite.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have Permissions.manage_channels permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

property flags

The channel flags for this channel.

New in version 2.6.

Type:

ChannelFlags

await invites()

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have Permissions.manage_channels permission to use this.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

property jump_url

A URL that can be used to jump to this channel.

New in version 2.4.

Note

This exists for all guild channels but may not be usable by the client for all guild channel types.

property mention

The string that allows you to mention the channel.

Type:

str

property overwrites

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, abc.User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

permissions_for(obj, /, *, ignore_timeout=...)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

• Guild owner

• Guild roles

• Channel overrides

• Member overrides

• Timeouts

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

• obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

• ignore_timeout (bool) –

  Whether or not to ignore the user’s timeout. Defaults to False.

  New in version 2.4.

  Note

  This only applies to Member objects.

  Changed in version 2.6: The default was changed to False.

Raises:

TypeError – ignore_timeout is only supported for Member objects.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

New in version 1.3.

Type:

bool

await set_permissions(target, *, overwrite=..., reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

The overwrite parameter, if given, must either be None or PermissionOverwrite. For convenience, you can pass in keyword arguments denoting Permissions attributes. If this is done, then you cannot mix the keyword arguments with the overwrite parameter.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have Permissions.manage_roles permission to do this.

Note

This method replaces the old overwrites with the ones given.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Examples

Setting allow and deny:

await message.channel.set_permissions(message.author, view_channel=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

Using PermissionOverwrite

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.view_channel = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• TypeError – overwrite is invalid, the target type was not Role or Member, both keyword arguments and overwrite were provided, or invalid permissions were provided as keyword arguments.

DMChannel

Attributes

• created_at
• flags
• id
• jump_url
• last_pin_timestamp
• me
• recipient
• type

Methods

• asyncfetch_message
• defget_partial_message
• defhistory
• defpermissions_for
• asyncpins
• asyncsend
• asynctrigger_typing
• deftyping

class disnake.DMChannel

Represents a Discord direct message channel.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel’s hash.

str(x)

Returns a string representation of the channel

recipient

The user you are participating with in the direct message channel. If this channel is received through the gateway, the recipient information may not be always available.

Type:

Optional[User]

me

The user presenting yourself.

Type:

ClientUser

id

The direct message channel ID.

Type:

int

last_pin_timestamp

The time the most recent message was pinned, or None if no message is currently pinned.

New in version 2.5.

Type:

Optional[datetime.datetime]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property type

The channel’s Discord type.

This always returns ChannelType.private.

Type:

ChannelType

property created_at

Returns the direct message channel’s creation time in UTC.

Type:

datetime.datetime

property jump_url

A URL that can be used to jump to this channel.

New in version 2.4.

property flags

The channel flags for this channel.

New in version 2.6.

Type:

ChannelFlags

permissions_for(obj=None, /, *, ignore_timeout=...)

Handles permission resolution for a User.

This function is there for compatibility with other channel types.

Actual direct messages do not really have the concept of permissions.

This returns all the Permissions.private_channel() permissions set to True.

Parameters:

• obj (User) – The user to check permissions for. This parameter is ignored but kept for compatibility with other permissions_for methods.

• ignore_timeout (bool) – Whether to ignore the guild timeout when checking permsisions. This parameter is ignored but kept for compatibility with other permissions_for methods.

Returns:

The resolved permissions.

Return type:

Permissions

get_partial_message(message_id, /)

Creates a PartialMessage from the given message ID.

This is useful if you want to work with a message and only have its ID without doing an unnecessary API call.

New in version 1.6.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message object.

Return type:

PartialMessage

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

GroupChannel

Attributes

• created_at
• icon
• id
• me
• name
• owner
• owner_id
• recipients
• type

Methods

• asyncfetch_message
• defhistory
• asyncleave
• defpermissions_for
• asyncpins
• asyncsend
• asynctrigger_typing
• deftyping

class disnake.GroupChannel

Represents a Discord group channel.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel’s hash.

str(x)

Returns a string representation of the channel

recipients

The users you are participating with in the group channel.

Type:

List[User]

me

The user presenting yourself.

Type:

ClientUser

id

The group channel ID.

Type:

int

owner

The user that owns the group channel.

Type:

Optional[User]

owner_id

The owner ID that owns the group channel.

New in version 2.0.

Type:

int

name

The group channel’s name if provided.

Type:

Optional[str]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination’s message history.

You must have Permissions.read_message_history permission to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages before this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages after this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve messages around this date or message. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time. When using this argument, the maximum limit is 101. Note that if the limit is an even number then this will return at most limit + 1 messages.

• oldest_first (Optional[bool]) – If set to True, return messages in oldest->newest order. Defaults to True if after is specified, otherwise False.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, suppress_embeds=False, allowed_mentions=None, reference=None, mention_author=None, view=None, components=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content).

At least one of content, embed/embeds, file/files, stickers, components, or view must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The content of the message to send.

• tts (bool) – Whether the message should be sent using text-to-speech.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with the embeds parameter.

• embeds (List[Embed]) –

  A list of embeds to send with the content. Must be a maximum of 10. This cannot be mixed with the embed parameter.

  New in version 2.0.

• file (File) – The file to upload. This cannot be mixed with the files parameter.

• files (List[File]) – A list of files to upload. Must be a maximum of 10. This cannot be mixed with the file parameter.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  New in version 2.0.

• nonce (Union[str, int]) – The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

• delete_after (float) – If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions. If no object is passed at all then the defaults given by Client.allowed_mentions are used instead.

  New in version 1.4.

• reference (Union[Message, MessageReference, PartialMessage]) –

  A reference to the Message to which you are replying, this can be created using Message.to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the AllowedMentions.replied_user attribute of allowed_mentions or by setting mention_author.

  New in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the AllowedMentions.replied_user attribute of allowed_mentions.

  New in version 1.6.

• view (ui.View) –

  A Discord UI View to add to the message. This cannot be mixed with components.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  A list of components to include in the message. This cannot be mixed with view.

  New in version 2.4.

• suppress_embeds (bool) –

  Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True.

  New in version 2.5.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – Specified both file and files, or you specified both embed and embeds, or you specified both view and components, or the reference object is not a Message, MessageReference or PartialMessage.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

property type

The channel’s Discord type.

This always returns ChannelType.group.

Type:

ChannelType

property icon

Returns the channel’s icon asset if available.

Type:

Optional[Asset]

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

permissions_for(obj, /, *, ignore_timeout=...)

Handles permission resolution for a User.

This function is there for compatibility with other channel types.

Actual direct messages do not really have the concept of permissions.

This returns all the Permissions.private_channel() permissions set to True.

This also checks the kick_members permission if the user is the owner.

Parameters:

• obj (Snowflake) – The user to check permissions for.

• ignore_timeout (bool) – Whether to ignore the guild timeout when checking permsisions. This parameter is ignored but kept for compatibility with other permissions_for methods.

Returns:

The resolved permissions for the user.

Return type:

Permissions

await leave()

This function is a coroutine.

Leaves the group.

If you are the only one in the group, this deletes it as well.

Raises:

HTTPException – Leaving the group failed.

PartialInviteGuild

Attributes

• banner
• created_at
• description
• features
• icon
• id
• name
• nsfw_level
• premium_subscription_count
• splash
• vanity_url_code
• verification_level

class disnake.PartialInviteGuild

Represents a “partial” invite guild.

This model will be given when the user is not part of the guild the Invite resolves to.

x == y

Checks if two partial guilds are the same.

x != y

Checks if two partial guilds are not the same.

hash(x)

Return the partial guild’s hash.

str(x)

Returns the partial guild’s name.

name

The partial guild’s name.

Type:

str

id

The partial guild’s ID.

Type:

int

description

The partial guild’s description.

Type:

Optional[str]

features

A list of features the partial guild has. See Guild.features for more information.

Type:

List[str]

nsfw_level

The partial guild’s nsfw level.

New in version 2.4.

Type:

NSFWLevel

vanity_url_code

The partial guild’s vanity url code, if any.

New in version 2.4.

Type:

Optional[str]

verification_level

The partial guild’s verification level.

Type:

VerificationLevel

premium_subscription_count

The number of “boosts” this guild currently has.

New in version 2.5.

Type:

int

property created_at

Returns the guild’s creation time in UTC.

Type:

datetime.datetime

property icon

Returns the guild’s icon asset, if available.

Type:

Optional[Asset]

property banner

Returns the guild’s banner asset, if available.

Type:

Optional[Asset]

property splash

Returns the guild’s invite splash asset, if available.

Type:

Optional[Asset]

PartialInviteChannel

Attributes

• created_at
• icon
• id
• mention
• name
• type

class disnake.PartialInviteChannel

Represents a “partial” invite channel.

This model will be given when the user is not part of the guild the Invite resolves to.

x == y

Checks if two partial channels are the same.

x != y

Checks if two partial channels are not the same.

hash(x)

Return the partial channel’s hash.

str(x)

Returns the partial channel’s name.

Changed in version 2.5: if the channel is of type ChannelType.group, returns the name that’s rendered by the official client.

name

The partial channel’s name.

Type:

Optional[str]

id

The partial channel’s ID.

Type:

int

type

The partial channel’s type.

Type:

ChannelType

property mention

The string that allows you to mention the channel.

Type:

str

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

property icon

Returns the channel’s icon asset if available.

New in version 2.6.

Type:

Optional[Asset]

Invite

Attributes

• approximate_member_count
• approximate_presence_count
• channel
• code
• created_at
• expires_at
• guild
• guild_scheduled_event
• guild_welcome_screen
• id
• inviter
• max_age
• max_uses
• target_application
• target_type
• target_user
• temporary
• url
• uses

Methods

• asyncdelete

class disnake.Invite

Represents a Discord Guild or abc.GuildChannel invite.

Depending on the way this object was created, some of the attributes can have a value of None (see table below).

x == y

Checks if two invites are equal.

x != y

Checks if two invites are not equal.

hash(x)

Returns the invite hash.

str(x)

Returns the invite URL.

The following table illustrates what methods will obtain the attributes:

Attribute	Method
max_age	abc.GuildChannel.invites(), Guild.invites()
max_uses	abc.GuildChannel.invites(), Guild.invites()
created_at	abc.GuildChannel.invites(), Guild.invites()
temporary	abc.GuildChannel.invites(), Guild.invites()
uses	abc.GuildChannel.invites(), Guild.invites()
approximate_member_count	Client.fetch_invite() with with_counts enabled
approximate_presence_count	Client.fetch_invite() with with_counts enabled
expires_at	Client.fetch_invite() with with_expiration enabled
guild_scheduled_event	Client.fetch_invite() with valid guild_scheduled_event_id or valid event ID in URL or invite object

If something is not in the table above, then it’s available by all methods.

code

The URL fragment used for the invite.

Type:

str

guild

The guild the invite is for. Can be None if it’s from a group direct message.

Type:

Optional[Union[Guild, Object, PartialInviteGuild]]

max_age

How long before the invite expires in seconds. A value of 0 indicates that it doesn’t expire.

Optional according to the table above.

Type:

Optional[int]

max_uses

How many times the invite can be used. A value of 0 indicates that it has unlimited uses.

Optional according to the table above.

Type:

Optional[int]

created_at

An aware UTC datetime object denoting the time the invite was created.

Optional according to the table above.

Type:

Optional[datetime.datetime]

temporary

Whether the invite grants temporary membership. If True, members who joined via this invite will be kicked upon disconnect.

Optional according to the table above.

Type:

Optional[bool]

uses

How many times the invite has been used.

Optional according to the table above.

Type:

Optional[int]

approximate_member_count

The approximate number of members in the guild.

Optional according to the table above.

Type:

Optional[int]

approximate_presence_count

The approximate number of members currently active in the guild. This includes idle, dnd, online, and invisible members. Offline members are excluded.

Optional according to the table above.

Type:

Optional[int]

expires_at

The expiration date of the invite. If the value is None when received through Client.fetch_invite() with with_expiration enabled, the invite will never expire.

New in version 2.0.

Type:

Optional[datetime.datetime]

inviter

The user who created the invite, if any.

This is None in vanity invites, for example.

Type:

Optional[User]

channel

The channel the invite is for.

Type:

Optional[Union[abc.GuildChannel, Object, PartialInviteChannel]]

target_type

The type of target for the voice channel invite.

New in version 2.0.

Type:

InviteTarget

target_user

The user whose stream to display for this invite, if any.

New in version 2.0.

Type:

Optional[User]

target_application

The embedded application the invite targets, if any.

New in version 2.0.

Type:

Optional[PartialAppInfo]

guild_scheduled_event

The guild scheduled event included in the invite, if any.

New in version 2.3.

Type:

Optional[GuildScheduledEvent]

guild_welcome_screen

The partial guild’s welcome screen, if any.

New in version 2.5.

Type:

Optional[WelcomeScreen]

property id

Returns the proper code portion of the invite.

Type:

str

property url

A property that retrieves the invite URL.

Type:

str

await delete(*, reason=None)

This function is a coroutine.

Revokes the instant invite.

You must have manage_channels permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this invite. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to revoke invites.

• NotFound – The invite is invalid or expired.

• HTTPException – Revoking the invite failed.

Template

Attributes

• code
• created_at
• creator
• description
• is_dirty
• name
• source_guild
• updated_at
• url
• uses

Methods

• asynccreate_guild
• asyncdelete
• asyncedit
• asyncsync

class disnake.Template

Represents a Discord template.

New in version 1.4.

code

The template code.

Type:

str

uses

How many times the template has been used.

Type:

int

name

The name of the template.

Type:

str

description

The description of the template.

Type:

str

creator

The creator of the template.

Type:

User

created_at

An aware datetime in UTC representing when the template was created.

Type:

datetime.datetime

updated_at

An aware datetime in UTC representing when the template was last updated. This is referred to as “last synced” in the official Discord client.

Type:

datetime.datetime

source_guild

The source guild.

Type:

Guild

is_dirty

Whether the template has unsynced changes.

New in version 2.0.

Type:

Optional[bool]

await create_guild(name, icon=None)

This function is a coroutine.

Creates a Guild using the template.

Bot accounts in more than 10 guilds are not allowed to create guilds.

Changed in version 2.5: Removed the region parameter.

Changed in version 2.6: Raises ValueError instead of InvalidArgument.

Parameters:

• name (str) – The name of the guild.

• icon (Optional[Union[bytes, Asset, Emoji, PartialEmoji, StickerItem, Sticker]]) –

  The icon of the guild. See ClientUser.edit() for more details on what is expected.

  Changed in version 2.5: Now accepts various resource types in addition to bytes.

Raises:

• NotFound – The icon asset couldn’t be found.

• HTTPException – Guild creation failed.

• TypeError – The icon asset is a lottie sticker (see Sticker.read()).

• ValueError – Invalid icon image format given. Must be PNG or JPG.

Returns:

The guild created. This is not the same guild that is added to cache.

Return type:

Guild

await sync()

This function is a coroutine.

Syncs the template to the guild’s current state.

You must have the manage_guild permission in the source guild to do this.

New in version 1.7.

Changed in version 2.0: The template is no longer edited in-place, instead it is returned.

Raises:

• HTTPException – Editing the template failed.

• Forbidden – You don’t have permissions to edit the template.

• NotFound – This template does not exist.

Returns:

The newly edited template.

Return type:

Template

await edit(*, name=..., description=...)

This function is a coroutine.

Edits the template metadata.

You must have the manage_guild permission in the source guild to do this.

New in version 1.7.

Changed in version 2.0: The template is no longer edited in-place, instead it is returned.

Parameters:

• name (str) – The template’s new name.

• description (Optional[str]) – The template’s new description.

Raises:

• HTTPException – Editing the template failed.

• Forbidden – You don’t have permissions to edit the template.

• NotFound – This template does not exist.

Returns:

The newly edited template.

Return type:

Template

await delete()

This function is a coroutine.

Deletes the template.

You must have the manage_guild permission in the source guild to do this.

New in version 1.7.

Raises:

• HTTPException – Editing the template failed.

• Forbidden – You don’t have permissions to edit the template.

• NotFound – This template does not exist.

property url

The template url.

New in version 2.0.

Type:

str

WidgetChannel

Attributes

• created_at
• id
• mention
• name
• position

class disnake.WidgetChannel

Represents a “partial” widget channel.

x == y

Checks if two partial channels are the same.

x != y

Checks if two partial channels are not the same.

hash(x)

Return the partial channel’s hash.

str(x)

Returns the partial channel’s name.

id

The channel’s ID.

Type:

int

name

The channel’s name.

Type:

str

position

The channel’s position

Type:

int

property mention

The string that allows you to mention the channel.

Type:

str

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

WidgetMember

Attributes

• activity
• avatar
• connected_channel
• deafened
• discriminator
• display_avatar
• display_name
• id
• muted
• name
• status
• suppress

class disnake.WidgetMember

Represents a “partial” member of the widget’s guild.

x == y

Checks if two widget members are the same.

x != y

Checks if two widget members are not the same.

hash(x)

Return the widget member’s hash.

str(x)

Returns the widget member’s name#discriminator.

id

The member’s anonymized ID.

Type:

int

name

The member’s nickname (if set in the guild) or username.

Type:

str

discriminator

The member’s anonymized discriminator.

Type:

str

status

The member’s status.

Type:

Status

activity

The member’s activity. This generally only has the name set.

Type:

Optional[Union[BaseActivity, Spotify]]

deafened

Whether the member is currently deafened.

Type:

Optional[bool]

muted

Whether the member is currently muted.

Type:

Optional[bool]

suppress

Whether the member is currently being suppressed.

Type:

Optional[bool]

connected_channel

Which channel the member is connected to.

Type:

Optional[WidgetChannel]

property avatar

The user’s avatar. The size can be chosen using Asset.with_size(), however the format is always static and cannot be changed through Asset.with_format() or similar methods.

Type:

Optional[Asset]

property display_name

Returns the member’s name.

Type:

str

property display_avatar

Returns the user’s display avatar.

For regular users this is just their default avatar or uploaded avatar.

New in version 2.0.

Type:

Asset

WidgetSettings

Attributes

• channel
• channel_id
• enabled
• guild

Methods

• asyncedit

class disnake.WidgetSettings

Represents a Guild’s widget settings.

New in version 2.5.

guild

The widget’s guild.

Type:

Guild

enabled

Whether the widget is enabled.

Type:

bool

channel_id

The widget channel ID. If set, an invite link for this channel will be generated, which allows users to join the guild from the widget.

Type:

Optional[int]

property channel

The widget channel, if set.

Type:

Optional[abc.GuildChannel]

await edit(*, enabled=..., channel=..., reason=None)

This function is a coroutine.

Edits the widget.

You must have manage_guild permission to do this.

Parameters:

• enabled (bool) – Whether to enable the widget.

• channel (Optional[Snowflake]) – The new widget channel. Pass None to remove the widget channel. If set, an invite link for this channel will be generated, which allows users to join the guild from the widget.

• reason (Optional[str]) – The reason for editing the widget. Shows up on the audit log.

Raises:

• Forbidden – You do not have permission to edit the widget.

• HTTPException – Editing the widget failed.

Returns:

The new widget settings.

Return type:

WidgetSettings

Widget

Attributes

• channels
• created_at
• id
• invite_url
• json_url
• members
• name
• presence_count

Methods

• asyncedit
• asyncfetch_invite
• defimage_url

class disnake.Widget

Represents a Guild widget.

x == y

Checks if two widgets are the same.

x != y

Checks if two widgets are not the same.

str(x)

Returns the widget’s JSON URL.

id

The guild’s ID.

Type:

int

name

The guild’s name.

Type:

str

channels

The publicly accessible voice and stage channels in the guild.

Type:

List[WidgetChannel]

members

The online members in the server. Offline members do not appear in the widget.

Note

Due to a Discord limitation, if this data is available the users will be “anonymized” with linear IDs and discriminator information being incorrect. Likewise, the number of members retrieved is capped.

Type:

List[WidgetMember]

presence_count

The number of online members in the server.

New in version 2.6.

Type:

int

property created_at

Returns the member’s creation time in UTC.

Type:

datetime.datetime

property json_url

The JSON URL of the widget.

Type:

str

property invite_url

The invite URL for the guild, if available.

Type:

Optional[str]

await fetch_invite(*, with_counts=True)

This function is a coroutine.

Retrieves an Invite from the widget’s invite URL. This is the same as Client.fetch_invite(); the invite code is abstracted away.

Changed in version 2.6: This may now return None if the widget does not have an attached invite URL.

Parameters:

with_counts (bool) – Whether to include count information in the invite. This fills the Invite.approximate_member_count and Invite.approximate_presence_count fields.

Returns:

The invite from the widget’s invite URL, if available.

Return type:

Optional[Invite]

await edit(*, enabled=..., channel=..., reason=None)

This function is a coroutine.

Edits the widget.

You must have manage_guild permission to do this

New in version 2.4.

Parameters:

• enabled (bool) – Whether to enable the widget.

• channel (Optional[Snowflake]) – The new widget channel. Pass None to remove the widget channel.

• reason (Optional[str]) – The reason for editing the widget. Shows up on the audit log.

Raises:

• Forbidden – You do not have permission to edit the widget.

• HTTPException – Editing the widget failed.

image_url(style=<WidgetStyle.shield: 'shield'>)

Returns an URL to the widget’s .png image.

New in version 2.5.

Parameters:

style (WidgetStyle) – The widget style.

Returns:

The widget image URL.

Return type:

str

WelcomeScreen

Attributes

• channels
• description
• enabled

Methods

• asyncedit

class disnake.WelcomeScreen

Represents a Discord welcome screen for a Guild.

New in version 2.5.

description

The guild description in the welcome screen.

Type:

Optional[str]

channels

The welcome screen’s channels.

Type:

List[WelcomeScreenChannel]

property enabled

Whether the welcome screen is displayed to users. This is equivalent to checking if WELCOME_SCREEN_ENABLED is present in Guild.features.

Type:

bool

await edit(*, enabled=..., description=..., channels=..., reason=None)

This function is a coroutine.

Edits the welcome screen.

You must have the manage_guild permission to use this.

This requires ‘COMMUNITY’ in Guild.features.

Parameters:

• enabled (bool) – Whether the welcome screen is enabled.

• description (Optional[str]) – The new guild description in the welcome screen.

• channels (Optional[List[WelcomeScreenChannel]]) – The new welcome channels.

• reason (Optional[str]) – The reason for editing the welcome screen. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to change the welcome screen or the guild is not allowed to create welcome screens.

• HTTPException – Editing the welcome screen failed.

• TypeError – channels is not a list of WelcomeScreenChannel instances

Returns:

The newly edited welcome screen.

Return type:

WelcomeScreen

WelcomeScreenChannel

Attributes

• description
• emoji
• id

class disnake.WelcomeScreenChannel

Represents a Discord welcome screen channel.

New in version 2.5.

id

The ID of the guild channel this welcome screen channel represents.

Type:

int

description

The description of this channel in the official UI.

Type:

str

emoji

The emoji associated with this channel’s welcome message, if any.

Type:

Optional[Union[Emoji, PartialEmoji]]

VoiceRegion

Attributes

• custom
• deprecated
• id
• name
• optimal

class disnake.VoiceRegion

Represents a Discord voice region.

New in version 2.5.

id

Unique ID for the region.

Type:

str

name

The name of the region.

Type:

str

optimal

True for a single region that is closest to your client.

Type:

bool

deprecated

Whether this is a deprecated voice region (avoid switching to these).

Type:

bool

custom

Whether this is a custom voice region (used for events/etc)

Type:

bool

StickerPack

Attributes

• banner
• cover_sticker
• cover_sticker_id
• description
• id
• name
• sku_id
• stickers

class disnake.StickerPack

Represents a sticker pack.

New in version 2.0.

Changed in version 2.8: cover_sticker_id, cover_sticker and banner are now optional.

str(x)

Returns the name of the sticker pack.

x == y

Checks if the sticker pack is equal to another sticker pack.

x != y

Checks if the sticker pack is not equal to another sticker pack.

name

The name of the sticker pack.

Type:

str

description

The description of the sticker pack.

Type:

str

id

The id of the sticker pack.

Type:

int

stickers

The stickers of this sticker pack.

Type:

List[StandardSticker]

sku_id

The SKU ID of the sticker pack.

Type:

int

cover_sticker_id

The ID of the sticker used for the cover of the sticker pack, if any.

Type:

Optional[int]

cover_sticker

The sticker used for the cover of the sticker pack, if any.

Type:

Optional[StandardSticker]

property banner

The banner asset of the sticker pack, if any.

Type:

Optional[Asset]

StickerItem

Attributes

• format
• id
• name
• url

Methods

• asyncfetch
• asyncread
• asyncsave
• asyncto_file

class disnake.StickerItem

Represents a sticker item.

New in version 2.0.

str(x)

Returns the name of the sticker item.

x == y

Checks if the sticker item is equal to another sticker item.

x != y

Checks if the sticker item is not equal to another sticker item.

name

The sticker’s name.

Type:

str

id

The ID of the sticker.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

await fetch()

This function is a coroutine.

Attempts to retrieve the full sticker data of the sticker item.

Raises:

HTTPException – Retrieving the sticker failed.

Returns:

The retrieved sticker.

Return type:

Union[StandardSticker, GuildSticker]

await read()

This function is a coroutine.

Retrieves the content of this sticker as a bytes object.

Note

Stickers that use the StickerFormatType.lottie format cannot be read.

Raises:

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The sticker is a lottie type.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

property url

The url for the sticker’s image.

Type:

str

Sticker

Attributes

• created_at
• description
• format
• id
• name
• pack_id
• url

Methods

• asyncread
• asyncsave
• asyncto_file

class disnake.Sticker

Represents a sticker.

New in version 1.6.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The ID of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

pack_id

The ID of the sticker’s pack.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

property created_at

Returns the sticker’s creation time in UTC.

Type:

datetime.datetime

await read()

This function is a coroutine.

Retrieves the content of this sticker as a bytes object.

Note

Stickers that use the StickerFormatType.lottie format cannot be read.

Raises:

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The sticker is a lottie type.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

property url

The url for the sticker’s image.

Type:

str

StandardSticker

Attributes

• created_at
• description
• format
• id
• name
• pack_id
• sort_value
• tags
• url

Methods

• asyncpack
• asyncread
• asyncsave
• asyncto_file

class disnake.StandardSticker

Represents a sticker that is found in a standard sticker pack.

New in version 2.0.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The ID of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

pack_id

The ID of the sticker’s pack.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

tags

A list of tags for the sticker.

Type:

List[str]

sort_value

The sticker’s sort order within its pack.

Type:

int

await pack()

This function is a coroutine.

Retrieves the sticker pack that this sticker belongs to.

Raises:

• InvalidData – The corresponding sticker pack was not found.

• HTTPException – Retrieving the sticker pack failed.

Returns:

The retrieved sticker pack.

Return type:

StickerPack

property created_at

Returns the sticker’s creation time in UTC.

Type:

datetime.datetime

await read()

This function is a coroutine.

Retrieves the content of this sticker as a bytes object.

Note

Stickers that use the StickerFormatType.lottie format cannot be read.

Raises:

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The sticker is a lottie type.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

property url

The url for the sticker’s image.

Type:

str

GuildSticker

Attributes

• available
• created_at
• description
• emoji
• format
• guild
• guild_id
• id
• name
• url
• user

Methods

• asyncdelete
• asyncedit
• asyncread
• asyncsave
• asyncto_file

class disnake.GuildSticker

Represents a sticker that belongs to a guild.

New in version 2.0.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The ID of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

format

The format for the sticker’s image.

Type:

StickerFormatType

available

Whether this sticker is available for use.

Type:

bool

guild_id

The ID of the guild that this sticker is from.

Type:

int

user

The user that created this sticker. This can only be retrieved using Guild.fetch_sticker()/Guild.fetch_stickers() and having the manage_emojis_and_stickers permission.

Type:

Optional[User]

emoji

The name of a unicode emoji that represents this sticker.

Type:

str

guild

The guild that this sticker is from. Could be None if the bot is not in the guild.

New in version 2.0.

Type:

Optional[Guild]

await edit(*, name=..., description=..., emoji=..., reason=None)

This function is a coroutine.

Edits a GuildSticker for the guild.

Parameters:

• name (str) – The sticker’s new name. Must be at least 2 characters.

• description (Optional[str]) – The sticker’s new description. Can be None.

• emoji (str) – The name of a unicode emoji that represents the sticker’s expression.

• reason (Optional[str]) – The reason for editing this sticker. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to edit stickers.

• HTTPException – An error occurred editing the sticker.

Returns:

The newly modified sticker.

Return type:

GuildSticker

await delete(*, reason=None)

This function is a coroutine.

Deletes the custom Sticker from the guild.

You must have manage_emojis_and_stickers permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this sticker. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to delete stickers.

• HTTPException – An error occurred deleting the sticker.

property created_at

Returns the sticker’s creation time in UTC.

Type:

datetime.datetime

await read()

This function is a coroutine.

Retrieves the content of this sticker as a bytes object.

Note

Stickers that use the StickerFormatType.lottie format cannot be read.

Raises:

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The sticker is a lottie type.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, spoiler=False, filename=None, description=None)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

New in version 2.5.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• spoiler (bool) – Whether the file is a spoiler.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given, it defaults to the name of the asset’s URL.

• description (Optional[str]) – The file’s description.

Raises:

• DiscordException – The asset does not have an associated state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

• TypeError – The asset is a unicode emoji or a sticker with lottie type.

Returns:

The asset as a file suitable for sending.

Return type:

File

property url

The url for the sticker’s image.

Type:

str

AutoModRule

Attributes

• actions
• creator
• creator_id
• enabled
• event_type
• exempt_channel_ids
• exempt_channels
• exempt_role_ids
• exempt_roles
• guild
• id
• name
• trigger_metadata
• trigger_type

Methods

• asyncdelete
• asyncedit

class disnake.AutoModRule

Represents an auto moderation rule.

New in version 2.6.

id

The rule ID.

Type:

int

name

The rule name.

Type:

str

enabled

Whether this rule is enabled.

Type:

bool

guild

The guild of the rule.

Type:

Guild

creator_id

The rule creator’s ID. See also creator.

Type:

int

event_type

The event type this rule is applied to.

Type:

AutoModEventType

trigger_type

The type of trigger that determines whether this rule’s actions should run for a specific event.

Type:

AutoModTriggerType

trigger_metadata

Additional metadata associated with this rule’s trigger_type.

Type:

AutoModTriggerMetadata

exempt_role_ids

The role IDs that are exempt from this rule.

Type:

FrozenSet[int]

exempt_channel_ids

The channel IDs that are exempt from this rule.

Type:

FrozenSet[int]

property actions

List[Union[AutoModBlockMessageAction, AutoModSendAlertAction, AutoModTimeoutAction, AutoModAction]]: The list of actions that will execute if a matching event triggered this rule.

property creator

The guild member that created this rule. May be None if the member cannot be found. See also creator_id.

Type:

Optional[Member]

property exempt_roles

The list of roles that are exempt from this rule.

Type:

List[Role]

property exempt_channels

The list of channels that are exempt from this rule.

Type:

List[abc.GuildChannel]

await edit(*, name=..., event_type=..., trigger_metadata=..., actions=..., enabled=..., exempt_roles=..., exempt_channels=..., reason=None)

This function is a coroutine.

Edits the auto moderation rule.

You must have Permissions.manage_guild permission to do this.

All fields are optional.

Examples

Edit name and enable rule:

await rule.edit(name="cool new rule", enabled=True)

Add an action:

await rule.edit(
    actions=rule.actions + [AutoModTimeoutAction(3600)],
)

Add a keyword to a keyword filter rule:

meta = rule.trigger_metadata
await rule.edit(
    trigger_metadata=meta.with_changes(
        keyword_filter=meta.keyword_filter + ["stuff"],
    ),
)

Parameters:

• name (str) – The rule’s new name.

• event_type (AutoModEventType) – The rule’s new event type.

• trigger_metadata (AutoModTriggerMetadata) – The rule’s new associated trigger metadata.

• actions (Sequence[Union[AutoModBlockMessageAction, AutoModSendAlertAction, AutoModTimeoutAction, AutoModAction]]) – The rule’s new actions. If provided, must contain at least one action.

• enabled (bool) – Whether to enable the rule.

• exempt_roles (Optional[Iterable[abc.Snowflake]]) – The rule’s new exempt roles, up to 20. If [] or None is passed then all role exemptions are removed.

• exempt_channels (Optional[Iterable[abc.Snowflake]]) – The rule’s new exempt channels, up to 50. Can also include categories, in which case all channels inside that category will be exempt. If [] or None is passed then all channel exemptions are removed.

• reason (Optional[str]) – The reason for editing the rule. Shows up on the audit log.

Raises:

• ValueError – When editing the list of actions, at least one action must be provided.

• Forbidden – You do not have proper permissions to edit the rule.

• NotFound – The rule does not exist.

• HTTPException – Editing the rule failed.

Returns:

The newly updated auto moderation rule.

Return type:

AutoModRule

await delete(*, reason=None)

This function is a coroutine.

Deletes the auto moderation rule.

You must have Permissions.manage_guild permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this rule. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the rule.

• NotFound – The rule does not exist.

• HTTPException – Deleting the rule failed.

AutoModActionExecution

Attributes

• action
• alert_message
• alert_message_id
• channel
• channel_id
• content
• guild
• matched_content
• matched_keyword
• message
• message_id
• rule_id
• rule_trigger_type
• user
• user_id

class disnake.AutoModActionExecution

Represents the data for an on_automod_action_execution() event.

New in version 2.6.

action

The action that was executed.

Type:

Union[AutoModBlockMessageAction, AutoModSendAlertAction, AutoModTimeoutAction, AutoModAction]

guild

The guild this action was executed in.

Type:

Guild

rule_id

The ID of the rule that matched.

Type:

int

rule_trigger_type

The trigger type of the rule that matched.

Type:

AutoModTriggerType

user_id

The ID of the user that triggered this action. See also user.

Type:

int

channel_id

The channel or thread ID in which the event occurred, if any. See also channel.

Type:

Optional[int]

message_id

The ID of the message that matched. None if the message was blocked, or if the content was not part of a message. See also message.

Type:

Optional[int]

alert_message_id

The ID of the alert message sent as a result of this action, if any. See also alert_message.

Type:

Optional[int]

content

The content that matched.

Requires Intents.message_content to be enabled, otherwise this field will be empty.

Type:

str

matched_keyword

The keyword or regex that matched.

Type:

Optional[str]

matched_content

The substring of content that matched the rule/keyword.

Requires Intents.message_content to be enabled, otherwise this field will be empty.

Type:

Optional[str]

property user

The guild member that triggered this action. May be None if the member cannot be found. See also user_id.

Type:

Optional[Member]

property channel

Optional[Union[abc.GuildChannel, Thread]]: The channel or thread in which the event occurred, if any.

property message

The message that matched, if any. Not available if the message was blocked, if the content was not part of a message, or if the message was not found in the message cache.

Type:

Optional[Message]

property alert_message

The alert message sent as a result of this action, if any. Only available if action.type is send_alert_message and the message was found in the message cache.

Type:

Optional[Message]

RawMessageDeleteEvent

Attributes

• cached_message
• channel_id
• guild_id
• message_id

class disnake.RawMessageDeleteEvent

Represents the event payload for an on_raw_message_delete() event.

channel_id

The channel ID where the deletion took place.

Type:

int

guild_id

The guild ID where the deletion took place, if applicable.

Type:

Optional[int]

message_id

The message ID that got deleted.

Type:

int

cached_message

The cached message, if found in the internal message cache.

Type:

Optional[Message]

RawBulkMessageDeleteEvent

Attributes

• cached_messages
• channel_id
• guild_id
• message_ids

class disnake.RawBulkMessageDeleteEvent

Represents the event payload for an on_raw_bulk_message_delete() event.

message_ids

A set of the message IDs that were deleted.

Type:

Set[int]

channel_id

The channel ID where the deletion took place.

Type:

int

guild_id

The guild ID where the deletion took place, if applicable.

Type:

Optional[int]

cached_messages

The cached messages, if found in the internal message cache.

Type:

List[Message]

RawMessageUpdateEvent

Attributes

• cached_message
• channel_id
• data
• guild_id
• message_id

class disnake.RawMessageUpdateEvent

Represents the event payload for an on_raw_message_edit() event.

message_id

The message ID that got updated.

Type:

int

channel_id

The channel ID where the update took place.

New in version 1.3.

Type:

int

guild_id

The guild ID where the update took place, if applicable.

New in version 1.7.

Type:

Optional[int]

data

The raw data given by the gateway.

Type:

dict

cached_message

The cached message, if found in the internal message cache. Represents the message before it is modified by the data in RawMessageUpdateEvent.data.

Type:

Optional[Message]

RawReactionActionEvent

Attributes

• channel_id
• emoji
• event_type
• guild_id
• member
• message_id
• user_id

class disnake.RawReactionActionEvent

Represents the event payload for on_raw_reaction_add() and on_raw_reaction_remove() events.

message_id

The message ID that got or lost a reaction.

Type:

int

user_id

The user ID who added the reaction or whose reaction was removed.

Type:

int

channel_id

The channel ID where the reaction addition or removal took place.

Type:

int

guild_id

The guild ID where the reaction addition or removal took place, if applicable.

Type:

Optional[int]

emoji

The custom or unicode emoji being used.

Type:

PartialEmoji

member

The member who added the reaction. Only available if event_type is REACTION_ADD and the reaction is inside a guild.

New in version 1.3.

Type:

Optional[Member]

event_type

The event type that triggered this action. Can be REACTION_ADD for reaction addition or REACTION_REMOVE for reaction removal.

New in version 1.3.

Type:

str

RawReactionClearEvent

Attributes

• channel_id
• guild_id
• message_id

class disnake.RawReactionClearEvent

Represents the event payload for an on_raw_reaction_clear() event.

message_id

The message ID that got its reactions cleared.

Type:

int

channel_id

The channel ID where the reaction clear took place.

Type:

int

guild_id

The guild ID where the reaction clear took place, if applicable.

Type:

Optional[int]

RawReactionClearEmojiEvent

Attributes

• channel_id
• emoji
• guild_id
• message_id

class disnake.RawReactionClearEmojiEvent

Represents the event payload for an on_raw_reaction_clear_emoji() event.

New in version 1.3.

message_id

The message ID that got its reactions cleared.

Type:

int

channel_id

The channel ID where the reaction clear took place.

Type:

int

guild_id

The guild ID where the reaction clear took place, if applicable.

Type:

Optional[int]

emoji

The custom or unicode emoji being removed.

Type:

PartialEmoji

RawIntegrationDeleteEvent

Attributes

• application_id
• guild_id
• integration_id

class disnake.RawIntegrationDeleteEvent

Represents the event payload for an on_raw_integration_delete() event.

New in version 2.0.

integration_id

The ID of the integration that got deleted.

Type:

int

application_id

The ID of the bot/OAuth2 application for this deleted integration.

Type:

Optional[int]

guild_id

The guild ID where the integration deletion took place.

Type:

int

RawGuildScheduledEventUserActionEvent

Attributes

• event_id
• guild_id
• user_id

class disnake.RawGuildScheduledEventUserActionEvent

Represents the event payload for an on_raw_guild_scheduled_event_subscribe() and on_raw_guild_scheduled_event_unsubscribe() events.

New in version 2.3.

event_id

The ID of the guild scheduled event that the user subscribed to or unsubscribed from.

Type:

int

user_id

The ID of the user doing the action.

Type:

int

guild_id

The guild ID where the guild scheduled event is located.

Type:

int

RawThreadDeleteEvent

Attributes

• guild_id
• parent_id
• thread
• thread_id
• thread_type

class disnake.RawThreadDeleteEvent

Represents the payload for a on_raw_thread_delete() event.

New in version 2.5.

thread_id

The ID of the thread that was deleted.

Type:

int

guild_id

The ID of the guild the thread was deleted in.

Type:

int

thread_type

The type of the deleted thread.

Type:

ChannelType

parent_id

The ID of the channel the thread belonged to.

Type:

int

thread

The thread, if it could be found in the internal cache.

Type:

Optional[Thread]

RawThreadMemberRemoveEvent

Attributes

• cached_member
• member_id
• thread

class disnake.RawThreadMemberRemoveEvent

Represents the event payload for an on_raw_thread_member_remove() event.

New in version 2.5.

thread

The Thread that the member was removed from

Type:

Thread

member_id

The ID of the removed member.

Type:

int

cached_member

The member, if they could be found in the internal cache.

Type:

Optional[ThreadMember]

RawTypingEvent

Attributes

• channel_id
• guild_id
• member
• timestamp
• user_id

class disnake.RawTypingEvent

Represents the event payload for an on_raw_typing() event.

New in version 2.3.

user_id

The ID of the user who started typing.

Type:

int

channel_id

The ID of the channel where the user started typing.

Type:

int

guild_id

The ID of the guild where the user started typing or None if it was in a DM.

Type:

Optional[int]

member

The member object of the user who started typing or None if it was in a DM.

Type:

Optional[Member]

timestamp

The UTC datetime when the user started typing.

Type:

datetime.datetime

RawGuildMemberRemoveEvent

Attributes

• guild_id
• user

class disnake.RawGuildMemberRemoveEvent

Represents the event payload for an on_raw_member_remove() event.

New in version 2.6.

guild_id

The ID of the guild where the member was removed from.

Type:

int

user

The user object of the member that was removed.

Type:

Union[User, Member]

PartialWebhookGuild

Attributes

• icon
• id
• name

class disnake.PartialWebhookGuild

Represents a partial guild for webhooks.

These are typically given for channel follower webhooks.

New in version 2.0.

id

The partial guild’s ID.

Type:

int

name

The partial guild’s name.

Type:

str

property icon

Returns the guild’s icon asset, if available.

Type:

Optional[Asset]

PartialWebhookChannel

Attributes

• id
• name

class disnake.PartialWebhookChannel

Represents a partial channel for webhooks.

These are typically given for channel follower webhooks.

New in version 2.0.

id

The partial channel’s ID.

Type:

int

name

The partial channel’s name.

Type:

str

Data Classes

Some classes are just there to be data containers, this lists them.

Unlike models you are allowed to create most of these yourself, even if they can also be used to hold attributes.

Nearly all classes here have __slots__ defined which means that it is impossible to have dynamic attributes to the data classes.

The only exception to this rule is Object, which is made with dynamic attributes in mind.

Object

Attributes

• created_at
• id

class disnake.Object(id)

Represents a generic Discord object.

The purpose of this class is to allow you to create ‘miniature’ versions of data classes if you want to pass in just an ID. Most functions that take in a specific data class with an ID can also take in this class as a substitute instead. Note that even though this is the case, not all objects (if any) actually inherit from this class.

There are also some cases where some websocket events are received in strange order and when such events happened you would receive this class rather than the actual data class. These cases are extremely rare.

x == y

Checks if two objects are equal.

x != y

Checks if two objects are not equal.

hash(x)

Returns the object’s hash.

id

The ID of the object.

Type:

int

property created_at

Returns the snowflake’s creation time in UTC.

Type:

datetime.datetime

Embed

Attributes

• author
• colour
• description
• fields
• footer
• image
• provider
• thumbnail
• timestamp
• title
• type
• url
• video

Methods

• clsEmbed.from_dict
• clsEmbed.get_default_color
• clsEmbed.get_default_colour
• clsEmbed.set_default_color
• clsEmbed.set_default_colour
• defadd_field
• defcheck_limits
• defclear_fields
• defcopy
• definsert_field_at
• defremove_author
• defremove_field
• defremove_footer
• defset_author
• defset_field_at
• defset_footer
• defset_image
• defset_thumbnail
• defto_dict

class disnake.Embed(*, title=None, type='rich', description=None, url=None, timestamp=None, colour=..., color=...)

Represents a Discord embed.

x == y

Checks if two embeds are equal.

New in version 2.6.

x != y

Checks if two embeds are not equal.

New in version 2.6.

len(x)

Returns the total size of the embed. Useful for checking if it’s within the 6000 character limit. Check if all aspects of the embed are within the limits with Embed.check_limits().

bool(b)

Returns whether the embed has any data set.

New in version 2.0.

Certain properties return an EmbedProxy, a type that acts similar to a regular dict except using dotted access, e.g. embed.author.icon_url.

For ease of use, all parameters that expect a str are implicitly cast to str for you.

title

The title of the embed.

Type:

Optional[str]

type

The type of embed. Usually “rich”. Possible strings for embed types can be found on Discord’s api-docs.

Type:

Optional[str]

description

The description of the embed.

Type:

Optional[str]

url

The URL of the embed.

Type:

Optional[str]

timestamp

The timestamp of the embed content. This is an aware datetime. If a naive datetime is passed, it is converted to an aware datetime with the local timezone.

Type:

Optional[datetime.datetime]

colour

The colour code of the embed. Aliased to color as well. In addition to Colour, int can also be assigned to it, in which case the value will be converted to a Colour object.

Type:

Optional[Colour]

classmethod from_dict(data)

Converts a dict to a Embed provided it is in the format that Discord expects it to be in.

You can find out about this format in the official Discord documentation.

Parameters:

data (dict) – The dictionary to convert into an embed.

copy()

Returns a shallow copy of the embed.

property footer

Returns an EmbedProxy denoting the footer contents.

Possible attributes you can access are:

• text

• icon_url

• proxy_icon_url

If an attribute is not set, it will be None.

set_footer(*, text, icon_url=None)

Sets the footer for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

• text (str) –

  The footer text.

  Changed in version 2.6: No longer optional, must be set to a valid string.

• icon_url (Optional[str]) – The URL of the footer icon. Only HTTP(S) is supported.

remove_footer()

Clears embed’s footer information.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.0.

property image

Returns an EmbedProxy denoting the image contents.

Possible attributes you can access are:

• url

• proxy_url

• width

• height

If an attribute is not set, it will be None.

set_image(url=..., *, file=...)

Sets the image for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Exactly one of url or file must be passed.

Warning

Passing a disnake.File object will make the embed not reusable.

Changed in version 1.4: Passing None removes the image.

Parameters:

• url (Optional[str]) – The source URL for the image. Only HTTP(S) is supported.

• file (File) –

  The file to use as the image.

  New in version 2.2.

property thumbnail

Returns an EmbedProxy denoting the thumbnail contents.

Possible attributes you can access are:

• url

• proxy_url

• width

• height

If an attribute is not set, it will be None.

set_thumbnail(url=..., *, file=...)

Sets the thumbnail for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Exactly one of url or file must be passed.

Warning

Passing a disnake.File object will make the embed not reusable.

Changed in version 1.4: Passing None removes the thumbnail.

Parameters:

• url (Optional[str]) – The source URL for the thumbnail. Only HTTP(S) is supported.

• file (File) –

  The file to use as the image.

  New in version 2.2.

property video

Returns an EmbedProxy denoting the video contents.

Possible attributes include:

• url for the video URL.

• proxy_url for the proxied video URL.

• height for the video height.

• width for the video width.

If an attribute is not set, it will be None.

property provider

Returns an EmbedProxy denoting the provider contents.

The only attributes that might be accessed are name and url.

If an attribute is not set, it will be None.

property author

Returns an EmbedProxy denoting the author contents.

See set_author() for possible values you can access.

If an attribute is not set, it will be None.

set_author(*, name, url=None, icon_url=None)

Sets the author for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

• name (str) – The name of the author.

• url (Optional[str]) – The URL for the author.

• icon_url (Optional[str]) – The URL of the author icon. Only HTTP(S) is supported.

remove_author()

Clears embed’s author information.

This function returns the class instance to allow for fluent-style chaining.

New in version 1.4.

property fields

Returns a list of EmbedProxy denoting the field contents.

See add_field() for possible values you can access.

If an attribute is not set, it will be None.

Type:

List[EmbedProxy]

add_field(name, value, *, inline=True)

Adds a field to the embed object.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

• name (str) – The name of the field.

• value (str) – The value of the field.

• inline (bool) – Whether the field should be displayed inline. Defaults to True.

insert_field_at(index, name, value, *, inline=True)

Inserts a field before a specified index to the embed.

This function returns the class instance to allow for fluent-style chaining.

New in version 1.2.

Parameters:

• index (int) – The index of where to insert the field.

• name (str) – The name of the field.

• value (str) – The value of the field.

• inline (bool) – Whether the field should be displayed inline. Defaults to True.

clear_fields()

Removes all fields from this embed.

remove_field(index)

Removes a field at a specified index.

If the index is invalid or out of bounds then the error is silently swallowed.

Note

When deleting a field by index, the index of the other fields shift to fill the gap just like a regular list.

Parameters:

index (int) – The index of the field to remove.

set_field_at(index, name, value, *, inline=True)

Modifies a field to the embed object.

The index must point to a valid pre-existing field.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

• index (int) – The index of the field to modify.

• name (str) – The name of the field.

• value (str) – The value of the field.

• inline (bool) – Whether the field should be displayed inline. Defaults to True.

Raises:

IndexError – An invalid index was provided.

to_dict()

Converts this embed object into a dict.

classmethod set_default_colour(value)

Set the default colour of all new embeds.

New in version 2.4.

Returns:

The colour that was set.

Return type:

Optional[Colour]

classmethod set_default_color(value)

Set the default colour of all new embeds.

New in version 2.4.

Returns:

The colour that was set.

Return type:

Optional[Colour]

classmethod get_default_colour()

Get the default colour of all new embeds.

New in version 2.4.

Returns:

The default colour.

Return type:

Optional[Colour]

classmethod get_default_color()

Get the default colour of all new embeds.

New in version 2.4.

Returns:

The default colour.

Return type:

Optional[Colour]

check_limits()

Checks if this embed fits within the limits dictated by Discord. There is also a 6000 character limit across all embeds in a message.

Returns nothing on success, raises ValueError if an attribute exceeds the limits.

Field	Limit
title	256 characters
description	4096 characters
fields	Up to 25 field objects
field.name	256 characters
field.value	1024 characters
footer.text	2048 characters
author.name	256 characters

New in version 2.6.

Raises:

ValueError – One or more of the embed attributes are too long.

AllowedMentions

Attributes

• everyone
• replied_user
• roles
• users

Methods

• clsAllowedMentions.all
• clsAllowedMentions.from_message
• clsAllowedMentions.none

class disnake.AllowedMentions(*, everyone=True, users=True, roles=True, replied_user=True)

A class that represents what mentions are allowed in a message.

This class can be set during Client initialisation to apply to every message sent. It can also be applied on a per message basis via abc.Messageable.send() for more fine-grained control.

everyone

Whether to allow everyone and here mentions. Defaults to True.

Type:

bool

users

Controls the users being mentioned. If True (the default) then users are mentioned based on the message content. If False then users are not mentioned at all. If a list of abc.Snowflake is given then only the users provided will be mentioned, provided those users are in the message content.

Type:

Union[bool, List[abc.Snowflake]]

roles

Controls the roles being mentioned. If True (the default) then roles are mentioned based on the message content. If False then roles are not mentioned at all. If a list of abc.Snowflake is given then only the roles provided will be mentioned, provided those roles are in the message content.

Type:

Union[bool, List[abc.Snowflake]]

replied_user

Whether to mention the author of the message being replied to. Defaults to True.

New in version 1.6.

Type:

bool

classmethod all()

A factory method that returns a AllowedMentions with all fields explicitly set to True

New in version 1.5.

classmethod none()

A factory method that returns a AllowedMentions with all fields set to False

New in version 1.5.

classmethod from_message(message)

A factory method that returns a AllowedMentions derived from the current Message state.

Note that this is not what AllowedMentions the message was sent with, but what the message actually mentioned. For example, a message that successfully mentioned everyone will have everyone set to True.

New in version 2.6.

MessageReference

Attributes

• cached_message
• channel_id
• fail_if_not_exists
• guild_id
• jump_url
• message_id
• resolved

Methods

• clsMessageReference.from_message

class disnake.MessageReference(*, message_id, channel_id, guild_id=None, fail_if_not_exists=True)

Represents a reference to a Message.

New in version 1.5.

Changed in version 1.6: This class can now be constructed by users.

message_id

The ID of the message referenced.

Type:

Optional[int]

channel_id

The channel ID of the message referenced.

Type:

int

guild_id

The guild ID of the message referenced.

Type:

Optional[int]

fail_if_not_exists

Whether replying to the referenced message should raise HTTPException if the message no longer exists or Discord could not fetch the message.

New in version 1.7.

Type:

bool

resolved

The message that this reference resolved to. If this is None then the original message was not fetched either due to the Discord API not attempting to resolve it or it not being available at the time of creation. If the message was resolved at a prior point but has since been deleted then this will be of type DeletedReferencedMessage.

Currently, this is mainly the replied to message when a user replies to a message.

New in version 1.6.

Type:

Optional[Union[Message, DeletedReferencedMessage]]

classmethod from_message(message, *, fail_if_not_exists=True)

Creates a MessageReference from an existing Message.

New in version 1.6.

Parameters:

• message (Message) – The message to be converted into a reference.

• fail_if_not_exists (bool) –

  Whether replying to the referenced message should raise HTTPException if the message no longer exists or Discord could not fetch the message.

  New in version 1.7.

Returns:

A reference to the message.

Return type:

MessageReference

property cached_message

The cached message, if found in the internal message cache.

Type:

Optional[Message]

property jump_url

Returns a URL that allows the client to jump to the referenced message.

New in version 1.7.

Type:

str

InteractionReference

Attributes

• id
• name
• type
• user

class disnake.InteractionReference(*, state, data)

Represents an interaction being referenced in a message.

This means responses to message components do not include this property, instead including a message reference object as components always exist on preexisting messages.

New in version 2.1.

id

The ID of the interaction.

Type:

int

type

The type of interaction.

Type:

InteractionType

name

The name of the application command, including group and subcommand name if applicable (separated by spaces).

Note

For interaction references created before July 18th, 2022, this will not include group or subcommand names.

Type:

str

user

The interaction author.

Type:

User

PartialMessage

Attributes

• channel
• created_at
• guild
• id
• jump_url

Methods

• asyncadd_reaction
• asyncclear_reaction
• asyncclear_reactions
• asyncdelete
• asyncedit
• asyncfetch
• asyncpin
• asyncpublish
• asyncremove_reaction
• asyncreply
• defto_reference
• asyncunpin

class disnake.PartialMessage(*, channel, id)

Represents a partial message to aid with working messages when only a message and channel ID are present.

There are two ways to construct this class. The first one is through the constructor itself, and the second is via the following:

• TextChannel.get_partial_message()

• VoiceChannel.get_partial_message()

• Thread.get_partial_message()

• DMChannel.get_partial_message()

• PartialMessageable.get_partial_message()

Note that this class is trimmed down and has no rich attributes.

New in version 1.6.

x == y

Checks if two partial messages are equal.

x != y

Checks if two partial messages are not equal.

hash(x)

Returns the partial message’s hash.

channel

The channel associated with this partial message.

Type:

Union[TextChannel, Thread, DMChannel, VoiceChannel, PartialMessageable]

id

The message ID.

Type:

int

property jump_url

Returns a URL that allows the client to jump to this message.

Type:

str

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Your own messages could be deleted without any proper permissions. However to delete other people’s messages, you need the manage_messages permission.

Changed in version 1.1: Added the new delay keyword-only parameter.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait in the background before deleting the message. If the deletion fails then it is silently ignored.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already

• HTTPException – Deleting the message failed.

await publish()

This function is a coroutine.

Publishes this message to your announcement channel.

You must have the send_messages permission to do this.

If the message is not your own then the manage_messages permission is also needed.

Raises:

• Forbidden – You do not have the proper permissions to publish this message.

• HTTPException – Publishing the message failed.

await pin(*, reason=None)

This function is a coroutine.

Pins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

The reason for pinning the message. Shows up on the audit log.

New in version 1.4.

Raises:

• Forbidden – You do not have permissions to pin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Pinning the message failed, probably due to the channel having more than 50 pinned messages.

await unpin(*, reason=None)

This function is a coroutine.

Unpins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

The reason for unpinning the message. Shows up on the audit log.

New in version 1.4.

Raises:

• Forbidden – You do not have permissions to unpin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Unpinning the message failed.

await add_reaction(emoji)

This function is a coroutine.

Adds a reaction to the message.

The emoji may be a unicode emoji or a custom guild Emoji.

You must have the read_message_history permission to use this. If nobody else has reacted to the message using this emoji, the add_reactions permission is required.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to react with.

Raises:

• HTTPException – Adding the reaction failed.

• Forbidden – You do not have the proper permissions to react to the message.

• NotFound – The emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

await remove_reaction(emoji, member)

This function is a coroutine.

Removes a reaction by the member from the message.

The emoji may be a unicode emoji or a custom guild Emoji.

If the reaction is not your own (i.e. member parameter is not you) then the manage_messages permission is needed.

The member parameter must represent a member and meet the abc.Snowflake abc.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to remove.

• member (abc.Snowflake) – The member for which to remove the reaction.

Raises:

• HTTPException – Removing the reaction failed.

• Forbidden – You do not have the proper permissions to remove the reaction.

• NotFound – The member or emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

await clear_reaction(emoji)

This function is a coroutine.

Clears a specific reaction from the message.

The emoji may be a unicode emoji or a custom guild Emoji.

You need the manage_messages permission to use this.

New in version 1.3.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to clear.

Raises:

• HTTPException – Clearing the reaction failed.

• Forbidden – You do not have the proper permissions to clear the reaction.

• NotFound – The emoji you specified was not found.

• TypeError – The emoji parameter is invalid.

await clear_reactions()

This function is a coroutine.

Removes all the reactions from the message.

You need the manage_messages permission to use this.

Raises:

• HTTPException – Removing the reactions failed.

• Forbidden – You do not have the proper permissions to remove all the reactions.

await reply(content=None, *, fail_if_not_exists=True, **kwargs)

This function is a coroutine.

A shortcut method to abc.Messageable.send() to reply to the Message.

New in version 1.6.

Changed in version 2.3: Added fail_if_not_exists keyword argument. Defaults to True.

Changed in version 2.6: Raises TypeError or ValueError instead of InvalidArgument.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

New in version 2.3.

Raises:

• HTTPException – Sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• TypeError – You specified both embed and embeds, or file and files, or view and components.

• ValueError – The files or embeds list is too large.

Returns:

The message that was sent.

Return type:

Message

to_reference(*, fail_if_not_exists=True)

Creates a MessageReference from the current message.

New in version 1.6.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

New in version 1.7.

Returns:

The reference to this message.

Return type:

MessageReference

property created_at

The partial message’s creation time in UTC.

Type:

datetime.datetime

guild

The guild that the partial message belongs to, if applicable.

Type:

Optional[Guild]

await fetch()

This function is a coroutine.

Fetches the partial message to a full Message.

Raises:

• NotFound – The message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The full message.

Return type:

Message

await edit(content=..., *, embed=..., embeds=..., file=..., files=..., attachments=..., suppress=..., suppress_embeds=..., allowed_mentions=..., view=..., components=..., delete_after=None)

This function is a coroutine.

Edits the message.

The content must be able to be transformed into a string via str(content).

Note

If the original message has embeds with images that were created from local files (using the file parameter with Embed.set_image() or Embed.set_thumbnail()), those images will be removed if the message’s attachments are edited in any way (i.e. by setting file/files/attachments, or adding an embed with local files).

Note

This method cannot be used on messages authored by others, with one exception. The suppress_embeds parameter can be used to change the state of embeds on other users’ messages, requiring the manage_messages permission.

Changed in version 2.1: disnake.Message is always returned.

Changed in version 2.5: The suppress keyword-only parameter was deprecated in favor of suppress_embeds.

Changed in version 2.6: Raises TypeError instead of InvalidArgument.

Parameters:

• content (Optional[str]) – The new content to replace the message with. Could be None to remove the content.

• embed (Optional[Embed]) – The new embed to replace the original with. This cannot be mixed with the embeds parameter. Could be None to remove the embed.

• embeds (List[Embed]) –

  The new embeds to replace the original with. Must be a maximum of 10. This cannot be mixed with the embed parameter. To remove all embeds [] should be passed.

  New in version 2.1.

• file (File) –

  The file to upload. This cannot be mixed with the files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

  New in version 2.1.

• files (List[File]) –

  A list of files to upload. This cannot be mixed with the file parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

  New in version 2.1.

• attachments (Optional[List[Attachment]]) –

  A list of attachments to keep in the message. If [] or None is passed then all existing attachments are removed. Keeps existing attachments if not provided.

  New in version 2.1.

  Changed in version 2.5: Supports passing None to clear attachments.

• suppress_embeds (bool) – Whether to suppress embeds for the message. This hides all the embeds from the UI if set to True. If set to False, this brings the embeds back if they were suppressed.

• delete_after (Optional[float]) – If provided, the number of seconds to wait in the background before deleting the message we just edited. If the deletion fails, then it is silently ignored.

• allowed_mentions (Optional[AllowedMentions]) –

  Controls the mentions being processed in this message. If this is passed, then the object is merged with Client.allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in Client.allowed_mentions.

  Note

  Unlike Message.edit(), this does not default to Client.allowed_mentions if no object is passed.

• view (Optional[View]) –

  The updated view to update this message with. This cannot be mixed with components. If None is passed then the view is removed.

  New in version 2.0.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) –

  The updated components to update this message with. This cannot be mixed with view. If None is passed then the components are removed.

  New in version 2.4.

Raises:

• NotFound – The message was not found.

• HTTPException – Editing the message failed.

• Forbidden – Tried to suppress embeds on a message without permissions or edited a message’s content or embed that isn’t yours.

• TypeError – You specified both embed and embeds, or file and files, or view and components.

Returns:

The message that was edited.

Return type:

Message

ApplicationCommand

Attributes

• default_member_permissions
• dm_permission
• name
• name_localizations
• nsfw
• type

class disnake.ApplicationCommand

The base class for application commands.

The following classes implement this ABC:

• SlashCommand

• MessageCommand

• UserCommand

type

The command type

Type:

ApplicationCommandType

name

The command name

Type:

str

name_localizations

Localizations for name.

New in version 2.5.

Type:

LocalizationValue

dm_permission

Whether this command can be used in DMs. Defaults to True.

New in version 2.5.

Type:

bool

nsfw

Whether this command is age-restricted. Defaults to False.

New in version 2.8.

Type:

bool

property default_member_permissions

The default required member permissions for this command. A member must have all these permissions to be able to invoke the command in a guild.

This is a default value, the set of users/roles that may invoke this command can be overridden by moderators on a guild-specific basis, disregarding this setting.

If None is returned, it means everyone can use the command by default. If an empty Permissions object is returned (that is, all permissions set to False), this means no one can use the command.

New in version 2.5.

Type:

Optional[Permissions]

SlashCommand

Attributes

• default_member_permissions
• description
• description_localizations
• dm_permission
• name
• name_localizations
• nsfw
• options

Methods

• defadd_option

class disnake.SlashCommand

The base class for building slash commands.

name

The slash command’s name.

Type:

str

name_localizations

Localizations for name.

New in version 2.5.

Type:

LocalizationValue

description

The slash command’s description.

Type:

str

description_localizations

Localizations for description.

New in version 2.5.

Type:

LocalizationValue

dm_permission

Whether this command can be used in DMs. Defaults to True.

New in version 2.5.

Type:

bool

nsfw

Whether this command is age-restricted. Defaults to False.

New in version 2.8.

Type:

bool

options

The list of options the slash command has.

Type:

List[Option]

add_option(name, description=None, type=None, required=False, choices=None, options=None, channel_types=None, autocomplete=False, min_value=None, max_value=None, min_length=None, max_length=None)

Adds an option to the current list of options, parameters are the same as for Option

property default_member_permissions

The default required member permissions for this command. A member must have all these permissions to be able to invoke the command in a guild.

This is a default value, the set of users/roles that may invoke this command can be overridden by moderators on a guild-specific basis, disregarding this setting.

If None is returned, it means everyone can use the command by default. If an empty Permissions object is returned (that is, all permissions set to False), this means no one can use the command.

New in version 2.5.

Type:

Optional[Permissions]

UserCommand

Attributes

• default_member_permissions
• dm_permission
• name
• name_localizations
• nsfw

class disnake.UserCommand

A user context menu command.

name

The user command’s name.

Type:

str

name_localizations

Localizations for name.

New in version 2.5.

Type:

LocalizationValue

dm_permission

Whether this command can be used in DMs. Defaults to True.

New in version 2.5.

Type:

bool

nsfw

Whether this command is age-restricted. Defaults to False.

New in version 2.8.

Type:

bool

property default_member_permissions

The default required member permissions for this command. A member must have all these permissions to be able to invoke the command in a guild.

This is a default value, the set of users/roles that may invoke this command can be overridden by moderators on a guild-specific basis, disregarding this setting.

If None is returned, it means everyone can use the command by default. If an empty Permissions object is returned (that is, all permissions set to False), this means no one can use the command.

New in version 2.5.

Type:

Optional[Permissions]

MessageCommand

Attributes

• default_member_permissions
• dm_permission
• name
• name_localizations
• nsfw

class disnake.MessageCommand

A message context menu command

name

The message command’s name.

Type:

str

name_localizations

Localizations for name.

New in version 2.5.

Type:

LocalizationValue

dm_permission

Whether this command can be used in DMs. Defaults to True.

New in version 2.5.

Type:

bool

nsfw

Whether this command is age-restricted. Defaults to False.

New in version 2.8.

Type:

bool

property default_member_permissions

The default required member permissions for this command. A member must have all these permissions to be able to invoke the command in a guild.

This is a default value, the set of users/roles that may invoke this command can be overridden by moderators on a guild-specific basis, disregarding this setting.

If None is returned, it means everyone can use the command by default. If an empty Permissions object is returned (that is, all permissions set to False), this means no one can use the command.

New in version 2.5.

Type:

Optional[Permissions]

Option

Methods

• defadd_choice
• defadd_option

class disnake.Option

Represents a slash command option.

Parameters:

• name (Union[str, Localized]) –

  The option’s name.

  Changed in version 2.5: Added support for localizations.

• description (Optional[Union[str, Localized]]) –

  The option’s description.

  Changed in version 2.5: Added support for localizations.

• type (OptionType) – The option type, e.g. OptionType.user.

• required (bool) – Whether this option is required.

• choices (Union[List[OptionChoice], List[Union[str, int]], Dict[str, Union[str, int]]]) – The list of option choices.

• options (List[Option]) – The list of sub options. Normally you don’t have to specify it directly, instead consider using @main_cmd.sub_command or @main_cmd.sub_command_group decorators.

• channel_types (List[ChannelType]) – The list of channel types that your option supports, if the type is OptionType.channel. By default, it supports all channel types.

• autocomplete (bool) – Whether this option can be autocompleted.

• min_value (Union[int, float]) – The minimum value permitted.

• max_value (Union[int, float]) – The maximum value permitted.

• min_length (int) –

  The minimum length for this option if this is a string option.

  New in version 2.6.

• max_length (int) –

  The maximum length for this option if this is a string option.

  New in version 2.6.

add_choice(name, value)

Adds an OptionChoice to the list of current choices, parameters are the same as for OptionChoice.

add_option(name, description=None, type=None, required=False, choices=None, options=None, channel_types=None, autocomplete=False, min_value=None, max_value=None, min_length=None, max_length=None)

Adds an option to the current list of options, parameters are the same as for Option.

OptionChoice

class disnake.OptionChoice

Represents an option choice.

Parameters:

• name (Union[str, Localized]) –

  The name of the option choice (visible to users).

  Changed in version 2.5: Added support for localizations.

• value (Union[str, int]) – The value of the option choice.

SelectOption

Attributes

• default
• description
• emoji
• label
• value

class disnake.SelectOption(*, label, value=..., description=None, emoji=None, default=False)

Represents a string select menu’s option.

These can be created by users.

New in version 2.0.

label

The label of the option. This is displayed to users. Can only be up to 100 characters.

Type:

str

value

The value of the option. This is not displayed to users. If not provided when constructed then it defaults to the label. Can only be up to 100 characters.

Type:

str

description

An additional description of the option, if any. Can only be up to 100 characters.

Type:

Optional[str]

emoji

The emoji of the option, if available.

Type:

Optional[Union[str, Emoji, PartialEmoji]]

default

Whether this option is selected by default.

Type:

bool

Intents

Attributes

• automod
• automod_configuration
• automod_execution
• bans
• dm_messages
• dm_reactions
• dm_typing
• emojis
• emojis_and_stickers
• guild_messages
• guild_reactions
• guild_scheduled_events
• guild_typing
• guilds
• integrations
• invites
• members
• message_content
• messages
• moderation
• presences
• reactions
• typing
• value
• voice_states
• webhooks

Methods

• clsIntents.all
• clsIntents.default
• clsIntents.none

class disnake.Intents(value=None, **kwargs)

Wraps up a Discord gateway intent flag.

Similar to Permissions, the properties provided are two way. You can set and retrieve individual bits using the properties as if they were regular bools.

To construct an object you can pass keyword arguments denoting the flags to enable or disable. Arguments are applied in order, similar to Permissions.

This is used to disable certain gateway features that are unnecessary to run your bot. To make use of this, it is passed to the intents keyword argument of Client.

New in version 1.5.

x == y

Checks if two Intents instances are equal.

x != y

Checks if two Intents instances are not equal.

x <= y

Checks if an Intents instance is a subset of another Intents instance.

New in version 2.6.

x >= y

Checks if an Intents instance is a superset of another Intents instance.

New in version 2.6.

x < y

Checks if an Intents instance is a strict subset of another Intents instance.

New in version 2.6.

x > y

Checks if an Intents instance is a strict superset of another Intents instance.

New in version 2.6.

x | y, x |= y

Returns a new Intents instance with all enabled intents from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y

Returns a new Intents instance with only intents enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y

Returns a new Intents instance with only intents enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x

Returns a new Intents instance with all intents inverted from x.

New in version 2.6.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

Additionally supported are a few operations on class attributes.

Intents.y | Intents.z, Intents(y=True) | Intents.z

Returns a Intents instance with all provided flags enabled.

New in version 2.6.

~Intents.y

Returns a Intents instance with all flags except y inverted from their default value.

New in version 2.6.

value

The raw value. You should query flags via the properties rather than using this raw value.

Changed in version 2.6: This can be now be provided on initialisation.

Type:

int

classmethod all()

A factory method that creates a Intents with everything enabled.

classmethod none()

A factory method that creates a Intents with everything disabled.

classmethod default()

A factory method that creates a Intents with everything enabled except presences, members, and message_content.

guilds

Whether guild related events are enabled.

This corresponds to the following events:

• on_guild_join()

• on_guild_remove()

• on_guild_available()

• on_guild_unavailable()

• on_guild_channel_update()

• on_guild_channel_create()

• on_guild_channel_delete()

• on_guild_channel_pins_update()

This also corresponds to the following attributes and classes in terms of cache:

• Client.guilds

• Guild and all its attributes.

• Client.get_channel()

• Client.get_all_channels()

It is highly advisable to leave this intent enabled for your bot to function.

Type:

bool

members

Whether guild member related events are enabled.

This corresponds to the following events:

• on_member_join()

• on_member_remove()

• on_member_update()

• on_user_update()

• on_guild_scheduled_event_subscribe()

• on_guild_scheduled_event_unsubscribe()

This also corresponds to the following attributes and classes in terms of cache:

• Client.get_all_members()

• Client.get_user()

• Guild.chunk()

• Guild.fetch_members()

• Guild.get_member()

• Guild.members

• Member.roles

• Member.nick

• Member.premium_since

• User.name

• User.avatar

• User.discriminator

For more information go to the member intent documentation.

Note

Currently, this requires opting in explicitly via the developer portal as well. Bots in over 100 guilds will need to apply to Discord for verification.

Type:

bool

moderation

Whether guild moderation related events are enabled.

This corresponds to the following events:

• on_member_ban()

• on_member_unban()

• on_audit_log_entry_create()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

bans

Alias of moderation.

Changed in version 2.8: Changed to an alias.

Type:

bool

emojis

Alias of emojis_and_stickers.

Changed in version 2.0: Changed to an alias.

Type:

bool

emojis_and_stickers

Whether guild emoji and sticker related events are enabled.

New in version 2.0.

This corresponds to the following events:

• on_guild_emojis_update()

• on_guild_stickers_update()

This also corresponds to the following attributes and classes in terms of cache:

• Emoji

• GuildSticker

• Client.get_emoji()

• Client.get_sticker()

• Client.emojis()

• Client.stickers()

• Guild.emojis

• Guild.stickers

Type:

bool

integrations

Whether guild integration related events are enabled.

This corresponds to the following events:

• on_guild_integrations_update()

• on_integration_create()

• on_integration_update()

• on_raw_integration_delete()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

webhooks

Whether guild webhook related events are enabled.

This corresponds to the following events:

• on_webhooks_update()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

invites

Whether guild invite related events are enabled.

This corresponds to the following events:

• on_invite_create()

• on_invite_delete()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

voice_states

Whether guild voice state related events are enabled.

This corresponds to the following events:

• on_voice_state_update()

This also corresponds to the following attributes and classes in terms of cache:

• VoiceChannel.members

• VoiceChannel.voice_states

• Member.voice

Note

This intent is required to connect to voice.

Type:

bool

presences

Whether guild presence related events are enabled.

This corresponds to the following events:

• on_presence_update()

This also corresponds to the following attributes and classes in terms of cache:

• Member.activities

• Member.status

• Member.raw_status

For more information go to the presence intent documentation.

Note

Currently, this requires opting in explicitly via the developer portal as well. Bots in over 100 guilds will need to apply to Discord for verification.

Type:

bool

messages

Whether guild and direct message related events are enabled.

This is a shortcut to set or get both guild_messages and dm_messages.

This corresponds to the following events:

• on_message() (both guilds and DMs)

• on_message_edit() (both guilds and DMs)

• on_message_delete() (both guilds and DMs)

• on_raw_message_delete() (both guilds and DMs)

• on_raw_message_edit() (both guilds and DMs)

This also corresponds to the following attributes and classes in terms of cache:

• Message

• Client.cached_messages

Note that due to an implicit relationship this also corresponds to the following events:

• on_reaction_add() (both guilds and DMs)

• on_reaction_remove() (both guilds and DMs)

• on_reaction_clear() (both guilds and DMs)

Note

Intents.message_content is required to receive the content of messages.

Type:

bool

guild_messages

Whether guild message related events are enabled.

See also dm_messages for DMs or messages for both.

This corresponds to the following events:

• on_message() (only for guilds)

• on_message_edit() (only for guilds)

• on_message_delete() (only for guilds)

• on_raw_message_delete() (only for guilds)

• on_raw_message_edit() (only for guilds)

This also corresponds to the following attributes and classes in terms of cache:

• Message

• Client.cached_messages (only for guilds)

Note that due to an implicit relationship this also corresponds to the following events:

• on_reaction_add() (only for guilds)

• on_reaction_remove() (only for guilds)

• on_reaction_clear() (only for guilds)

Type:

bool

dm_messages

Whether direct message related events are enabled.

See also guild_messages for guilds or messages for both.

This corresponds to the following events:

• on_message() (only for DMs)

• on_message_edit() (only for DMs)

• on_message_delete() (only for DMs)

• on_raw_message_delete() (only for DMs)

• on_raw_message_edit() (only for DMs)

This also corresponds to the following attributes and classes in terms of cache:

• Message

• Client.cached_messages (only for DMs)

Note that due to an implicit relationship this also corresponds to the following events:

• on_reaction_add() (only for DMs)

• on_reaction_remove() (only for DMs)

• on_reaction_clear() (only for DMs)

Type:

bool

message_content

Whether messages will have access to message content.

New in version 2.5.

This applies to the following fields on Message instances:

• content

• embeds

• attachments

• components

The following cases will always have the above fields:

• Messages the bot sends

• Messages the bot receives as a direct message

• Messages in which the bot is mentioned

• Messages received from an interaction payload, these will typically be attributes on MessageInteraction instances.

In addition, this also corresponds to the following fields:

• AutoModActionExecution.content

• AutoModActionExecution.matched_content

For more information go to the message content intent documentation.

Note

Currently, this requires opting in explicitly via the developer portal as well. Bots in over 100 guilds will need to apply to Discord for verification.

Type:

bool

reactions

Whether guild and direct message reaction related events are enabled.

This is a shortcut to set or get both guild_reactions and dm_reactions.

This corresponds to the following events:

• on_reaction_add() (both guilds and DMs)

• on_reaction_remove() (both guilds and DMs)

• on_reaction_clear() (both guilds and DMs)

• on_raw_reaction_add() (both guilds and DMs)

• on_raw_reaction_remove() (both guilds and DMs)

• on_raw_reaction_clear() (both guilds and DMs)

This also corresponds to the following attributes and classes in terms of cache:

• Message.reactions (both guild and DM messages)

Type:

bool

guild_reactions

Whether guild message reaction related events are enabled.

See also dm_reactions for DMs or reactions for both.

This corresponds to the following events:

• on_reaction_add() (only for guilds)

• on_reaction_remove() (only for guilds)

• on_reaction_clear() (only for guilds)

• on_raw_reaction_add() (only for guilds)

• on_raw_reaction_remove() (only for guilds)

• on_raw_reaction_clear() (only for guilds)

This also corresponds to the following attributes and classes in terms of cache:

• Message.reactions (only for guild messages)

Type:

bool

dm_reactions

Whether direct message reaction related events are enabled.

See also guild_reactions for guilds or reactions for both.

This corresponds to the following events:

• on_reaction_add() (only for DMs)

• on_reaction_remove() (only for DMs)

• on_reaction_clear() (only for DMs)

• on_raw_reaction_add() (only for DMs)

• on_raw_reaction_remove() (only for DMs)

• on_raw_reaction_clear() (only for DMs)

This also corresponds to the following attributes and classes in terms of cache:

• Message.reactions (only for DM messages)

Type:

bool

typing

Whether guild and direct message typing related events are enabled.

This is a shortcut to set or get both guild_typing and dm_typing.

This corresponds to the following events:

• on_typing() (both guilds and DMs)

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

guild_typing

Whether guild and direct message typing related events are enabled.

See also dm_typing for DMs or typing for both.

This corresponds to the following events:

• on_typing() (only for guilds)

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

dm_typing

Whether guild and direct message typing related events are enabled.

See also guild_typing for guilds or typing for both.

This corresponds to the following events:

• on_typing() (only for DMs)

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

guild_scheduled_events

Whether guild scheduled event related events are enabled.

New in version 2.3.

This corresponds to the following events:

• on_guild_scheduled_event_create()

• on_guild_scheduled_event_delete()

• on_guild_scheduled_event_update()

• on_guild_scheduled_event_subscribe()

• on_guild_scheduled_event_unsubscribe()

• on_raw_guild_scheduled_event_subscribe()

• on_raw_guild_scheduled_event_unsubscribe()

This also corresponds to the following attributes and classes in terms of cache:

• Guild.scheduled_events

• Guild.get_scheduled_event()

• StageInstance.guild_scheduled_event

Type:

bool

automod_configuration

Whether auto moderation configuration related events are enabled.

New in version 2.6.

This corresponds to the following events:

• on_automod_rule_create()

• on_automod_rule_delete()

• on_automod_rule_update()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

automod_execution

Whether auto moderation execution related events are enabled.

New in version 2.6.

This corresponds to the following events:

• on_automod_action_execution()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

automod

Whether auto moderation related events are enabled.

New in version 2.6.

This is a shortcut to set or get both automod_configuration and automod_execution.

This corresponds to the following events:

• on_automod_rule_create()

• on_automod_rule_delete()

• on_automod_rule_update()

• on_automod_action_execution()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

MemberCacheFlags

Attributes

• joined
• value
• voice

Methods

• clsMemberCacheFlags.all
• clsMemberCacheFlags.from_intents
• clsMemberCacheFlags.none

class disnake.MemberCacheFlags(**kwargs)

Controls the library’s cache policy when it comes to members.

This allows for finer grained control over what members are cached. Note that the bot’s own member is always cached. This class is passed to the member_cache_flags parameter in Client.

Due to a quirk in how Discord works, in order to ensure proper cleanup of cache resources it is recommended to have Intents.members enabled. Otherwise the library cannot know when a member leaves a guild and is thus unable to cleanup after itself.

To construct an object you can pass keyword arguments denoting the flags to enable or disable. Arguments are applied in order, similar to Permissions.

The default value is all flags enabled.

New in version 1.5.

x == y

Checks if two MemberCacheFlags instances are equal.

x != y

Checks if two MemberCacheFlags instances are not equal.

x <= y

Checks if a MemberCacheFlags instance is a subset of another MemberCacheFlags instance.

New in version 2.6.

x >= y

Checks if a MemberCacheFlags instance is a superset of another MemberCacheFlags instance.

New in version 2.6.

x < y

Checks if a MemberCacheFlags instance is a strict subset of another MemberCacheFlags instance.

New in version 2.6.

x > y

Checks if a MemberCacheFlags instance is a strict superset of another MemberCacheFlags instance.

New in version 2.6.

x | y, x |= y

Returns a new MemberCacheFlags instance with all enabled flags from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y

Returns a new MemberCacheFlags instance with only flags enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y

Returns a new MemberCacheFlags instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x

Returns a new MemberCacheFlags instance with all flags from x inverted.

New in version 2.6.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

Additionally supported are a few operations on class attributes.

MemberCacheFlags.y | MemberCacheFlags.z, MemberCacheFlags(y=True) | MemberCacheFlags.z

Returns a MemberCacheFlags instance with all provided flags enabled.

New in version 2.6.

~MemberCacheFlags.y

Returns a MemberCacheFlags instance with all flags except y inverted from their default value.

New in version 2.6.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

classmethod all()

A factory method that creates a MemberCacheFlags with everything enabled.

classmethod none()

A factory method that creates a MemberCacheFlags with everything disabled.

voice

Whether to cache members that are in voice.

This requires Intents.voice_states.

Members that leave voice are no longer cached.

Type:

bool

joined

Whether to cache members that joined the guild or are chunked as part of the initial log in flow.

This requires Intents.members.

Members that leave the guild are no longer cached.

Type:

bool

classmethod from_intents(intents)

A factory method that creates a MemberCacheFlags based on the currently selected Intents.

Parameters:

intents (Intents) – The intents to select from.

Returns:

The resulting member cache flags.

Return type:

MemberCacheFlags

ApplicationFlags

Attributes

• application_command_badge
• embedded
• gateway_guild_members
• gateway_guild_members_limited
• gateway_message_content
• gateway_message_content_limited
• gateway_presence
• gateway_presence_limited
• value
• verification_pending_guild_limit

class disnake.ApplicationFlags(**kwargs)

Wraps up the Discord Application flags.

x == y

Checks if two ApplicationFlags instances are equal.

x != y

Checks if two ApplicationFlags instances are not equal.

x <= y

Checks if an ApplicationFlags instance is a subset of another ApplicationFlags instance.

New in version 2.6.

x >= y

Checks if an ApplicationFlags instance is a superset of another ApplicationFlags instance.

New in version 2.6.

x < y

Checks if an ApplicationFlags instance is a strict subset of another ApplicationFlags instance.

New in version 2.6.

x > y

Checks if an ApplicationFlags instance is a strict superset of another ApplicationFlags instance.

New in version 2.6.

x | y, x |= y

Returns a new ApplicationFlags instance with all enabled flags from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y

Returns a new ApplicationFlags instance with only flags enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y

Returns a new ApplicationFlags instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x

Returns a new ApplicationFlags instance with all flags from x inverted.

New in version 2.6.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Additionally supported are a few operations on class attributes.

ApplicationFlags.y | ApplicationFlags.z, ApplicationFlags(y=True) | ApplicationFlags.z

Returns a ApplicationFlags instance with all provided flags enabled.

New in version 2.6.

~ApplicationFlags.y

Returns a ApplicationFlags instance with all flags except y inverted from their default value.

New in version 2.6.

New in version 2.0.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

gateway_presence

Returns True if the application is verified and is allowed to receive presence information over the gateway.

Type:

bool

gateway_presence_limited

Returns True if the application is allowed to receive limited presence information over the gateway.

Type:

bool

gateway_guild_members

Returns True if the application is verified and is allowed to receive guild members information over the gateway.

Type:

bool

gateway_guild_members_limited

Returns True if the application is allowed to receive limited guild members information over the gateway.

Type:

bool

verification_pending_guild_limit

Returns True if the application is currently pending verification and has hit the guild limit.

Type:

bool

embedded

Returns True if the application is embedded within the Discord client.

Type:

bool

gateway_message_content

Returns True if the application is verified and is allowed to receive message content over the gateway.

Type:

bool

gateway_message_content_limited

Returns True if the application is verified and is allowed to receive limited message content over the gateway.

Type:

bool

application_command_badge

Returns True if the application has registered global application commands.

New in version 2.6.

Type:

bool

ChannelFlags

Attributes

• pinned
• require_tag
• value

class disnake.ChannelFlags(**kwargs)

Wraps up the Discord Channel flags.

x == y

Checks if two ChannelFlags instances are equal.

x != y

Checks if two ChannelFlags instances are not equal.

x <= y

Checks if a ChannelFlags instance is a subset of another ChannelFlags instance.

New in version 2.6.

x >= y

Checks if a ChannelFlags instance is a superset of another ChannelFlags instance.

New in version 2.6.

x < y

Checks if a ChannelFlags instance is a strict subset of another ChannelFlags instance.

New in version 2.6.

x > y

Checks if a ChannelFlags instance is a strict superset of another ChannelFlags instance.

New in version 2.6.

x | y, x |= y

Returns a new ChannelFlags instance with all enabled flags from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y

Returns a new ChannelFlags instance with only flags enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y

Returns a new ChannelFlags instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x

Returns a new ChannelFlags instance with all flags from x inverted.

New in version 2.6.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Additionally supported are a few operations on class attributes.

ChannelFlags.y | ChannelFlags.z, ChannelFlags(y=True) | ChannelFlags.z

Returns a ChannelFlags instance with all provided flags enabled.

New in version 2.6.

~ChannelFlags.y

Returns a ChannelFlags instance with all flags except y inverted from their default value.

New in version 2.6.

New in version 2.5.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

pinned

Returns True if the thread is pinned.

This only applies to channels of type Thread.

Type:

bool

require_tag

Returns True if the channel requires all newly created threads to have a tag.

This only applies to channels of type ForumChannel.

New in version 2.6.

Type:

bool

AutoModKeywordPresets

Attributes

• profanity
• sexual_content
• slurs
• values

Methods

• clsAutoModKeywordPresets.all
• clsAutoModKeywordPresets.none

class disnake.AutoModKeywordPresets(**kwargs)

Wraps up the pre-defined auto moderation keyword lists, provided by Discord.

x == y

Checks if two AutoModKeywordPresets instances are equal.

x != y

Checks if two AutoModKeywordPresets instances are not equal.

x <= y

Checks if an AutoModKeywordPresets instance is a subset of another AutoModKeywordPresets instance.

x >= y

Checks if an AutoModKeywordPresets instance is a superset of another AutoModKeywordPresets instance.

x < y

Checks if an AutoModKeywordPresets instance is a strict subset of another AutoModKeywordPresets instance.

x > y

Checks if an AutoModKeywordPresets instance is a strict superset of another AutoModKeywordPresets instance.

x | y, x |= y

Returns a new AutoModKeywordPresets instance with all enabled flags from both x and y. (Using |= will update in place).

x & y, x &= y

Returns a new AutoModKeywordPresets instance with only flags enabled on both x and y. (Using &= will update in place).

x ^ y, x ^= y

Returns a new AutoModKeywordPresets instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

~x

Returns a new AutoModKeywordPresets instance with all flags from x inverted.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Additionally supported are a few operations on class attributes.

AutoModKeywordPresets.y | AutoModKeywordPresets.z, AutoModKeywordPresets(y=True) | AutoModKeywordPresets.z

Returns a AutoModKeywordPresets instance with all provided flags enabled.

~AutoModKeywordPresets.y

Returns a AutoModKeywordPresets instance with all flags except y inverted from their default value.

New in version 2.6.

values

The raw values. You should query flags via the properties rather than using these raw values.

Type:

int

classmethod all()

A factory method that creates a AutoModKeywordPresets with everything enabled.

classmethod none()

A factory method that creates a AutoModKeywordPresets with everything disabled.

profanity

Returns True if the profanity preset is enabled (contains words that may be considered swearing or cursing).

Type:

bool

sexual_content

Returns True if the sexual content preset is enabled (contains sexually explicit words).

Type:

bool

slurs

Returns True if the slurs preset is enabled (contains insults or words that may be considered hate speech).

Type:

bool

AutoModTriggerMetadata

Attributes

• allow_list
• keyword_filter
• mention_total_limit
• presets
• regex_patterns

Methods

• defwith_changes

class disnake.AutoModTriggerMetadata(*, keyword_filter=None, regex_patterns=None, presets=None, allow_list=None, mention_total_limit=None)

Metadata for an auto moderation trigger.

Based on the trigger type, different fields can be used with various limits:

Trigger Type	keyword_filter	regex_patterns	presets	allow_list	mention_total_limit
keyword	✅ (x1000)	✅ (x10)	❌	✅ (x100)	❌
spam	❌	❌	❌	❌	❌
keyword_preset	❌	❌	✅	✅ (x1000)	❌
mention_spam	❌	❌	❌	❌	✅

New in version 2.6.

keyword_filter

The list of keywords to check for, up to 1000 keywords. Used with AutoModTriggerType.keyword.

See api docs for details about how keyword matching works. Each keyword must be 60 characters or less.

Type:

Optional[Sequence[str]]

regex_patterns

The list of regular expressions to check for. Used with AutoModTriggerType.keyword.

A maximum of 10 regexes can be added, each with up to 260 characters.

Note

Only Rust flavored regex is currently supported, which can be tested in online editors such as Rustexp.

New in version 2.7.

Type:

Optional[Sequence[str]]

presets

The keyword presets. Used with AutoModTriggerType.keyword_preset.

Type:

Optional[AutoModKeywordPresets]

allow_list

The keywords that should be exempt from a preset. Used with AutoModTriggerType.keyword (up to 100 exemptions) and AutoModTriggerType.keyword_preset (up to 1000 exemptions).

Each keyword must be 60 characters or less.

Type:

Optional[Sequence[str]]

mention_total_limit

The maximum number of mentions (members + roles) allowed, between 1 and 50. Used with AutoModTriggerType.mention_spam.

Type:

Optional[int]

with_changes(*, keyword_filter=..., regex_patterns=..., presets=..., allow_list=..., mention_total_limit=...)

Returns a new instance with the given changes applied. All other fields will be kept intact.

Returns:

The new metadata instance.

Return type:

AutoModTriggerMetadata

AutoModAction

Attributes

• type

class disnake.AutoModAction

A base class for auto moderation actions.

This class is not meant to be instantiated by the user. The user-constructible subclasses are:

• AutoModBlockMessageAction

• AutoModSendAlertAction

• AutoModTimeoutAction

Actions received from the API may be of this type (and not one of the subtypes above) if the action type is not implemented yet.

New in version 2.6.

type

The action type.

Type:

AutoModActionType

AutoModBlockMessageAction

Attributes

• type

class disnake.AutoModBlockMessageAction

Represents an auto moderation action that blocks content from being sent.

New in version 2.6.

type

The action type. Always set to block_message.

Type:

AutoModActionType

AutoModSendAlertAction

Attributes

• channel_id
• type

class disnake.AutoModSendAlertAction(channel)

Represents an auto moderation action that sends an alert to a channel.

New in version 2.6.

Parameters:

channel (abc.Snowflake) – The channel to send an alert in when the rule is triggered.

type

The action type. Always set to send_alert_message.

Type:

AutoModActionType

property channel_id

The channel ID to send an alert in when the rule is triggered.

Type:

int

AutoModTimeoutAction

Attributes

• duration
• type

class disnake.AutoModTimeoutAction(duration)

Represents an auto moderation action that times out the user.

New in version 2.6.

Parameters:

duration (Union[int, datetime.timedelta]) – The duration (seconds or timedelta) for which to timeout the user when the rule is triggered.

type

The action type. Always set to timeout.

Type:

AutoModActionType

property duration

The duration (in seconds) for which to timeout the user when the rule is triggered.

Type:

int

ApplicationRoleConnectionMetadata

Attributes

• description
• description_localizations
• key
• name
• name_localizations
• type

class disnake.ApplicationRoleConnectionMetadata(*, type, key, name, description)

Represents the role connection metadata of an application.

See the API documentation for further details and limits.

The list of metadata records associated with the current application/bot can be retrieved/edited using Client.fetch_role_connection_metadata() and Client.edit_role_connection_metadata().

New in version 2.8.

type

The type of the metadata value.

Type:

ApplicationRoleConnectionMetadataType

key

The dictionary key for the metadata field.

Type:

str

name

The name of the metadata field.

Type:

str

name_localizations

The localizations for name.

Type:

LocalizationValue

description

The description of the metadata field.

Type:

str

description_localizations

The localizations for description.

Type:

LocalizationValue

File

Attributes

• bytes_length
• closed
• description
• filename
• fp
• spoiler

class disnake.File(fp, filename=None, *, spoiler=False, description=None)

A parameter object used for sending file objects.

Note

File objects are single use and are not meant to be reused in multiple abc.Messageable.send(), Message.edit(), Interaction.send(), or Interaction.edit_original_response() calls or similar methods.

fp

A file-like object opened in binary mode and read mode or a filename representing a file in the hard drive to open.

Note

If the file-like object passed is opened via open then the modes ‘rb’ should be used.

To pass binary data, consider usage of io.BytesIO.

Type:

Union[os.PathLike, io.BufferedIOBase]

filename

The filename to display when uploading to Discord. If this is not given then it defaults to fp.name or if fp is a string then the filename will default to the string given.

Type:

Optional[str]

spoiler

Whether the attachment is a spoiler.

Type:

bool

description

The file’s description.

New in version 2.3.

Type:

Optional[str]

property closed

Whether the file is closed.

This is a shorthand for File.fp.closed.

New in version 2.8.

Type:

bool

property bytes_length

The bytes length of the fp object.

New in version 2.8.

Type:

int

Colour

Attributes

• b
• g
• r
• value

Methods

• clsColour.blue
• clsColour.blurple
• clsColour.brand_green
• clsColour.brand_red
• clsColour.dark_blue
• clsColour.dark_gold
• clsColour.dark_gray
• clsColour.dark_green
• clsColour.dark_grey
• clsColour.dark_magenta
• clsColour.dark_orange
• clsColour.dark_purple
• clsColour.dark_red
• clsColour.dark_teal
• clsColour.dark_theme
• clsColour.darker_gray
• clsColour.darker_grey
• clsColour.default
• clsColour.from_hsv
• clsColour.from_rgb
• clsColour.fuchsia
• clsColour.gold
• clsColour.green
• clsColour.greyple
• clsColour.light_gray
• clsColour.light_grey
• clsColour.lighter_gray
• clsColour.lighter_grey
• clsColour.magenta
• clsColour.og_blurple
• clsColour.old_blurple
• clsColour.orange
• clsColour.purple
• clsColour.random
• clsColour.red
• clsColour.teal
• clsColour.yellow
• defto_rgb

class disnake.Colour(value)

Represents a Discord role colour. This class is similar to a (red, green, blue) tuple.

There is an alias for this called Color.

x == y

Checks if two colours are equal.

x != y

Checks if two colours are not equal.

hash(x)

Return the colour’s hash.

str(x)

Returns the hex format for the colour.

int(x)

Returns the raw colour value.

value

The raw integer colour value.

Type:

int

property r

Returns the red component of the colour.

Type:

int

property g

Returns the green component of the colour.

Type:

int

property b

Returns the blue component of the colour.

Type:

int

to_rgb()

Tuple[int, int, int]: Returns an (r, g, b) tuple representing the colour.

classmethod from_rgb(r, g, b)

Constructs a Colour from an RGB tuple.

classmethod from_hsv(h, s, v)

Constructs a Colour from an HSV tuple.

classmethod default()

A factory method that returns a Colour with a value of 0.

classmethod random(*, seed=None)

A factory method that returns a Colour with a random hue.

Note

The random algorithm works by choosing a colour with a random hue but with maxed out saturation and value.

New in version 1.6.

Parameters:

seed (Optional[Union[int, str, float, bytes, bytearray]]) –

The seed to initialize the RNG with. If None is passed the default RNG is used.

New in version 1.7.

classmethod teal()

A factory method that returns a Colour with a value of 0x1abc9c.

classmethod dark_teal()

A factory method that returns a Colour with a value of 0x11806a.

classmethod brand_green()

A factory method that returns a Colour with a value of 0x57F287.

New in version 2.0.

classmethod green()

A factory method that returns a Colour with a value of 0x2ecc71.

classmethod dark_green()

A factory method that returns a Colour with a value of 0x1f8b4c.

classmethod blue()

A factory method that returns a Colour with a value of 0x3498db.

classmethod dark_blue()

A factory method that returns a Colour with a value of 0x206694.

classmethod purple()

A factory method that returns a Colour with a value of 0x9b59b6.

classmethod dark_purple()

A factory method that returns a Colour with a value of 0x71368a.

classmethod magenta()

A factory method that returns a Colour with a value of 0xe91e63.

classmethod dark_magenta()

A factory method that returns a Colour with a value of 0xad1457.

classmethod gold()

A factory method that returns a Colour with a value of 0xf1c40f.

classmethod dark_gold()

A factory method that returns a Colour with a value of 0xc27c0e.

classmethod orange()

A factory method that returns a Colour with a value of 0xe67e22.

classmethod dark_orange()

A factory method that returns a Colour with a value of 0xa84300.

classmethod brand_red()

A factory method that returns a Colour with a value of 0xED4245.

New in version 2.0.

classmethod red()

A factory method that returns a Colour with a value of 0xe74c3c.

classmethod dark_red()

A factory method that returns a Colour with a value of 0x992d22.

classmethod lighter_grey()

A factory method that returns a Colour with a value of 0x95a5a6.

classmethod lighter_gray()

A factory method that returns a Colour with a value of 0x95a5a6.

classmethod dark_grey()

A factory method that returns a Colour with a value of 0x607d8b.

classmethod dark_gray()

A factory method that returns a Colour with a value of 0x607d8b.

classmethod light_grey()

A factory method that returns a Colour with a value of 0x979c9f.

classmethod light_gray()

A factory method that returns a Colour with a value of 0x979c9f.

classmethod darker_grey()

A factory method that returns a Colour with a value of 0x546e7a.

classmethod darker_gray()

A factory method that returns a Colour with a value of 0x546e7a.

classmethod og_blurple()

A factory method that returns a Colour with a value of 0x7289da.

classmethod old_blurple()

A factory method that returns a Colour with a value of 0x7289da.

classmethod blurple()

A factory method that returns a Colour with a value of 0x5865F2.

classmethod greyple()

A factory method that returns a Colour with a value of 0x99aab5.

classmethod dark_theme()

A factory method that returns a Colour with a value of 0x36393F. This will appear transparent on Discord’s dark theme.

New in version 1.5.

classmethod fuchsia()

A factory method that returns a Colour with a value of 0xEB459E.

New in version 2.0.

classmethod yellow()

A factory method that returns a Colour with a value of 0xFEE75C.

New in version 2.0.

BaseActivity

Attributes

• created_at
• end
• start

class disnake.BaseActivity(*, created_at=None, timestamps=None, assets=None, **kwargs)

The base activity that all user-settable activities inherit from. A user-settable activity is one that can be used in Client.change_presence().

The following types currently count as user-settable:

• Activity

• Game

• Streaming

• CustomActivity

Note that although these types are considered user-settable by the library, Discord typically ignores certain combinations of activity depending on what is currently set. This behaviour may change in the future so there are no guarantees on whether Discord will actually let you set these types.

New in version 1.3.

property created_at

When the user started doing this activity in UTC.

New in version 1.3.

Type:

Optional[datetime.datetime]

property end

When the user will stop doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

property start

When the user started doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

Activity

Attributes

• application_id
• assets
• buttons
• created_at
• details
• emoji
• end
• large_image_text
• large_image_url
• name
• party
• small_image_text
• small_image_url
• start
• state
• type
• url

class disnake.Activity(*, name=None, url=None, type=None, state=None, details=None, party=None, application_id=None, flags=None, buttons=None, emoji=None, id=None, platform=None, sync_id=None, session_id=None, **kwargs)

Represents an activity in Discord.

This could be an activity such as streaming, playing, listening or watching.

For memory optimisation purposes, some activities are offered in slimmed down versions:

• Game

• Streaming

Parameters:

• name (Optional[str]) – The name of the activity.

• url (Optional[str]) – A stream URL that the activity could be doing.

• type (ActivityType) – The type of activity currently being done.

application_id

The application ID of the game.

Type:

Optional[int]

name

The name of the activity.

Type:

Optional[str]

url

A stream URL that the activity could be doing.

Type:

Optional[str]

type

The type of activity currently being done.

Type:

ActivityType

state

The user’s current state. For example, “In Game”.

Type:

Optional[str]

details

The detail of the user’s current activity.

Type:

Optional[str]

assets

A dictionary representing the images and their hover text of an activity. It contains the following optional keys:

• large_image: A string representing the ID for the large image asset.

• large_text: A string representing the text when hovering over the large image asset.

• small_image: A string representing the ID for the small image asset.

• small_text: A string representing the text when hovering over the small image asset.

Type:

dict

party

A dictionary representing the activity party. It contains the following optional keys:

• id: A string representing the party ID.

• size: A list of two integers denoting (current_size, maximum_size).

Type:

dict

buttons

A list of strings representing the labels of custom buttons shown in a rich presence.

New in version 2.0.

Changed in version 2.6: Changed type to List[str] to match API types.

Type:

List[str]

emoji

The emoji that belongs to this activity.

Type:

Optional[PartialEmoji]

property large_image_url

Returns a URL pointing to the large image asset of this activity, if applicable.

Type:

Optional[str]

property small_image_url

Returns a URL pointing to the small image asset of this activity, if applicable.

Type:

Optional[str]

property large_image_text

Returns the large image asset hover text of this activity, if applicable.

Type:

Optional[str]

property small_image_text

Returns the small image asset hover text of this activity, if applicable.

Type:

Optional[str]

property created_at

When the user started doing this activity in UTC.

New in version 1.3.

Type:

Optional[datetime.datetime]

property end

When the user will stop doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

property start

When the user started doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

Game

Attributes

• assets
• created_at
• end
• name
• start
• type

class disnake.Game(name, *, platform=None, **kwargs)

A slimmed down version of Activity that represents a Discord game.

This is typically displayed via Playing on the official Discord client.

x == y

Checks if two games are equal.

x != y

Checks if two games are not equal.

hash(x)

Returns the game’s hash.

str(x)

Returns the game’s name.

Parameters:

name (str) – The game’s name.

name

The game’s name.

Type:

str

assets

A dictionary with the same structure as Activity.assets.

Type:

dict

property type

Returns the game’s type. This is for compatibility with Activity.

It always returns ActivityType.playing.

Type:

ActivityType

property created_at

When the user started doing this activity in UTC.

New in version 1.3.

Type:

Optional[datetime.datetime]

property end

When the user will stop doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

property start

When the user started doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

Streaming

Attributes

• assets
• created_at
• details
• end
• game
• name
• platform
• start
• twitch_name
• type
• url

class disnake.Streaming(*, name, url, details=None, state=None, **kwargs)

A slimmed down version of Activity that represents a Discord streaming status.

This is typically displayed via Streaming on the official Discord client.

x == y

Checks if two streams are equal.

x != y

Checks if two streams are not equal.

hash(x)

Returns the stream’s hash.

str(x)

Returns the stream’s name.

platform

Where the user is streaming from (ie. YouTube, Twitch).

New in version 1.3.

Type:

Optional[str]

name

The stream’s name.

Type:

Optional[str]

details

An alias for name

Type:

Optional[str]

game

The game being streamed.

New in version 1.3.

Type:

Optional[str]

url

The stream’s URL.

Type:

str

assets

A dictionary with the same structure as Activity.assets.

Type:

dict

property type

Returns the game’s type. This is for compatibility with Activity.

It always returns ActivityType.streaming.

Type:

ActivityType

property twitch_name

If provided, the twitch name of the user streaming.

This corresponds to the large_image key of the Streaming.assets dictionary if it starts with twitch:. Typically set by the Discord client.

Type:

Optional[str]

property created_at

When the user started doing this activity in UTC.

New in version 1.3.

Type:

Optional[datetime.datetime]

property end

When the user will stop doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

property start

When the user started doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

CustomActivity

Attributes

• created_at
• emoji
• end
• name
• start
• type

class disnake.CustomActivity(name, *, emoji=None, state=None, **kwargs)

Represents a Custom activity from Discord.

x == y

Checks if two activities are equal.

x != y

Checks if two activities are not equal.

hash(x)

Returns the activity’s hash.

str(x)

Returns the custom status text.

New in version 1.3.

name

The custom activity’s name.

Type:

Optional[str]

emoji

The emoji to pass to the activity, if any.

Type:

Optional[PartialEmoji]

property type

Returns the activity’s type. This is for compatibility with Activity.

It always returns ActivityType.custom.

Type:

ActivityType

property created_at

When the user started doing this activity in UTC.

New in version 1.3.

Type:

Optional[datetime.datetime]

property end

When the user will stop doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

property start

When the user started doing this activity in UTC, if applicable.

Changed in version 2.6: This attribute can now be None.

Type:

Optional[datetime.datetime]

Permissions

Attributes

• add_reactions
• administrator
• attach_files
• ban_members
• change_nickname
• connect
• create_forum_threads
• create_instant_invite
• create_private_threads
• create_public_threads
• deafen_members
• embed_links
• external_emojis
• external_stickers
• kick_members
• manage_channels
• manage_emojis
• manage_emojis_and_stickers
• manage_events
• manage_guild
• manage_messages
• manage_nicknames
• manage_permissions
• manage_roles
• manage_threads
• manage_webhooks
• mention_everyone
• moderate_members
• move_members
• mute_members
• priority_speaker
• read_message_history
• read_messages
• request_to_speak
• send_messages
• send_messages_in_threads
• send_tts_messages
• speak
• start_embedded_activities
• stream
• use_application_commands
• use_embedded_activities
• use_external_emojis
• use_external_stickers
• use_slash_commands
• use_voice_activation
• value
• view_audit_log
• view_channel
• view_guild_insights

Methods

• clsPermissions.advanced
• clsPermissions.all
• clsPermissions.all_channel
• clsPermissions.events
• clsPermissions.general
• clsPermissions.membership
• clsPermissions.none
• clsPermissions.private_channel
• clsPermissions.stage
• clsPermissions.stage_moderator
• clsPermissions.text
• clsPermissions.voice
• defis_strict_subset
• defis_strict_superset
• defis_subset
• defis_superset
• defupdate

class disnake.Permissions(permissions=0, **kwargs)

Wraps up the Discord permission value.

The properties provided are two way. You can set and retrieve individual bits using the properties as if they were regular bools. This allows you to edit permissions.

To construct an object you can pass keyword arguments denoting the permissions to enable or disable. Arguments are applied in order, which notably also means that supplying a flag and its alias will make whatever comes last overwrite the first one; as an example, Permissions(external_emojis=True, use_external_emojis=False) and Permissions(use_external_emojis=True, external_emojis=False) both result in the same permissions value (0).

Changed in version 1.3: You can now use keyword arguments to initialize Permissions similar to update().

x == y

Checks if two permissions are equal.

x != y

Checks if two permissions are not equal.

x <= y

Checks if a permission is a subset of another permission.

x >= y

Checks if a permission is a superset of another permission.

x < y

Checks if a permission is a strict subset of another permission.

x > y

Checks if a permission is a strict superset of another permission.

x | y, x |= y

Returns a new Permissions instance with all enabled permissions from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y

Returns a new Permissions instance with only permissions enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y

Returns a new Permissions instance with only permissions enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x

Returns a new Permissions instance with all permissions from x inverted.

New in version 2.6.

hash(x)

Return the permission’s hash.

iter(x)

Returns an iterator of (perm, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Additionally supported are a few operations on class attributes.

Permissions.y | Permissions.z, Permissions(y=True) | Permissions.z

Returns a Permissions instance with all provided permissions enabled.

New in version 2.6.

~Permissions.y

Returns a Permissions instance with all permissions except y inverted from their default value.

New in version 2.6.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available permissions. You should query permissions via the properties rather than using this raw value.

Type:

int

is_subset(other)

Returns True if self has the same or fewer permissions as other.

is_superset(other)

Returns True if self has the same or more permissions as other.

is_strict_subset(other)

Returns True if the permissions on self are a strict subset of those on other.

is_strict_superset(other)

Returns True if the permissions on self are a strict superset of those on other.

classmethod none()

A factory method that creates a Permissions with all permissions set to False.

classmethod all()

A factory method that creates a Permissions with all permissions set to True.

classmethod all_channel()

A Permissions with all channel-specific permissions set to True and the guild-specific ones set to False. The guild-specific permissions are currently:

• manage_emojis

• view_audit_log

• view_guild_insights

• manage_guild

• change_nickname

• manage_nicknames

• kick_members

• ban_members

• administrator

Changed in version 1.7: Added stream, priority_speaker and use_slash_commands permissions.

Changed in version 2.0: Added create_public_threads, create_private_threads, manage_threads, use_external_stickers, send_messages_in_threads and request_to_speak permissions.

Changed in version 2.3: Added use_embedded_activities permission.

classmethod general()

A factory method that creates a Permissions with all “General” permissions from the official Discord UI set to True.

Changed in version 1.7: Permission read_messages is now included in the general permissions, but permissions administrator, create_instant_invite, kick_members, ban_members, change_nickname and manage_nicknames are no longer part of the general permissions.

classmethod membership()

A factory method that creates a Permissions with all “Membership” permissions from the official Discord UI set to True.

New in version 1.7.

Changed in version 2.3: Added moderate_members permission.

classmethod text()

A factory method that creates a Permissions with all “Text” permissions from the official Discord UI set to True.

Changed in version 1.7: Permission read_messages is no longer part of the text permissions. Added use_slash_commands permission.

Changed in version 2.0: Added create_public_threads, create_private_threads, manage_threads, send_messages_in_threads and use_external_stickers permissions.

classmethod voice()

A factory method that creates a Permissions with all “Voice” permissions from the official Discord UI set to True.

Changed in version 2.3: Added use_embedded_activities permission.

classmethod stage()

A factory method that creates a Permissions with all “Stage Channel” permissions from the official Discord UI set to True.

New in version 1.7.

classmethod stage_moderator()

A factory method that creates a Permissions with all “Stage Moderator” permissions from the official Discord UI set to True.

New in version 1.7.

classmethod events()

A factory method that creates a Permissions with all “Events” permissions from the official Discord UI set to True.

New in version 2.4.

classmethod advanced()

A factory method that creates a Permissions with all “Advanced” permissions from the official Discord UI set to True.

New in version 1.7.

classmethod private_channel()

A factory method that creates a Permissions with the best representation of a PrivateChannel’s permissions.

This exists to maintain compatibility with other channel types.

This is equivalent to Permissions.text() with view_channel with the following set to False:

• send_tts_messages: You cannot send TTS messages in a DM.

• manage_messages: You cannot delete others messages in a DM.

• manage_threads: You cannot manage threads in a DM.

• send_messages_in_threads: You cannot make threads in a DM.

• create_public_threads: You cannot make public threads in a DM.

• create_private_threads: You cannot make private threads in a DM.

New in version 2.4.

update(**kwargs)

Bulk updates this permission object.

Allows you to set multiple attributes by using keyword arguments. The names must be equivalent to the properties listed. Extraneous key/value pairs will be silently ignored.

Arguments are applied in order, similar to the constructor.

Parameters:

**kwargs – A list of key/value pairs to bulk update permissions with.

create_instant_invite

Returns True if the user can create instant invites.

Type:

bool

kick_members

Returns True if the user can kick users from the guild.

Type:

bool

ban_members

Returns True if a user can ban users from the guild.

Type:

bool

administrator

Returns True if a user is an administrator. This role overrides all other permissions.

This also bypasses all channel-specific overrides.

Type:

bool

manage_channels

Returns True if a user can edit, delete, or create channels in the guild.

This also corresponds to the “Manage Channel” channel-specific override.

Type:

bool

manage_guild

Returns True if a user can edit guild properties.

Type:

bool

add_reactions

Returns True if a user can add reactions to messages.

Type:

bool

view_audit_log

Returns True if a user can view the guild’s audit log.

Type:

bool

priority_speaker

Returns True if a user can be more easily heard while talking.

Type:

bool

stream

Returns True if a user can stream in a voice channel.

Type:

bool

view_channel

Returns True if a user can view all or specific channels.

New in version 1.3.

Changed in version 2.4: read_messages is now an alias of view_channel.

Type:

bool

read_messages

An alias for view_channel.

Type:

bool

send_messages

Returns True if a user can send messages from all or specific text channels and create threads in forum channels.

Type:

bool

create_forum_threads

An alias for send_messages.

New in version 2.5.

Type:

bool

send_tts_messages

Returns True if a user can send TTS messages from all or specific text channels.

Type:

bool

manage_messages

Returns True if a user can delete or pin messages in a text channel.

Note

Note that there are currently no ways to edit other people’s messages.

Type:

bool

embed_links

Returns True if a user’s messages will automatically be embedded by Discord.

Type:

bool

attach_files

Returns True if a user can send files in their messages.

Type:

bool

read_message_history

Returns True if a user can read a text channel’s previous messages.

Type:

bool

mention_everyone

Returns True if a user’s @everyone or @here will mention everyone in the text channel.

Type:

bool

external_emojis

Returns True if a user can use emojis from other guilds.

Type:

bool

use_external_emojis

An alias for external_emojis.

New in version 1.3.

Type:

bool

view_guild_insights

Returns True if a user can view the guild’s insights.

New in version 1.3.

Type:

bool

connect

Returns True if a user can connect to a voice channel.

Type:

bool

speak

Returns True if a user can speak in a voice channel.

Type:

bool

mute_members

Returns True if a user can mute other users.

Type:

bool

deafen_members

Returns True if a user can deafen other users.

Type:

bool

move_members

Returns True if a user can move users between other voice channels.

Type:

bool

use_voice_activation

Returns True if a user can use voice activation in voice channels.

Type:

bool

change_nickname

Returns True if a user can change their nickname in the guild.

Type:

bool

manage_nicknames

Returns True if a user can change other user’s nickname in the guild.

Type:

bool

manage_roles

Returns True if a user can create or edit roles less than their role’s position.

This also corresponds to the “Manage Permissions” channel-specific override.

Type:

bool

manage_permissions

An alias for manage_roles.

New in version 1.3.

Type:

bool

manage_webhooks

Returns True if a user can create, edit, or delete webhooks.

Type:

bool

manage_emojis

Returns True if a user can create, edit, or delete emojis.

Type:

bool

manage_emojis_and_stickers

An alias for manage_emojis.

New in version 2.0.

Type:

bool

use_application_commands

Returns True if a user can use application commands.

New in version 2.6.

Type:

bool

use_slash_commands

An alias for use_application_commands.

New in version 1.7.

Changed in version 2.6: Became an alias for use_application_commands.

Type:

bool

request_to_speak

Returns True if a user can request to speak in a stage channel.

New in version 1.7.

Type:

bool

manage_events

Returns True if a user can manage guild events.

New in version 2.0.

Type:

bool

manage_threads

Returns True if a user can manage threads.

New in version 2.0.

Type:

bool

create_public_threads

Returns True if a user can create public threads.

New in version 2.0.

Type:

bool

create_private_threads

Returns True if a user can create private threads.

New in version 2.0.

Type:

bool

external_stickers

Returns True if a user can use stickers from other guilds.

New in version 2.0.

Type:

bool

use_external_stickers

An alias for external_stickers.

New in version 2.0.

Type:

bool

send_messages_in_threads

Returns True if a user can send messages in threads.

New in version 2.0.

Type:

bool

use_embedded_activities

Returns True if a user can use activities (applications with the embedded flag) in a voice channel.

New in version 2.6.

Type:

bool

start_embedded_activities

An alias for use_embedded_activities.

New in version 2.3.

Changed in version 2.6: Became an alias for use_embedded_activities.

Type:

bool

moderate_members

Returns True if a user can perform limited moderation actions, such as timeouts or editing members’ flags.

New in version 2.3.

Type:

bool

PermissionOverwrite

Methods

• clsPermissionOverwrite.from_pair
• defis_empty
• defpair
• defupdate

class disnake.PermissionOverwrite(**kwargs)

A type that is used to represent a channel specific permission.

Unlike a regular Permissions, the default value of a permission is equivalent to None and not False. Setting a value to False is explicitly denying that permission, while setting a value to True is explicitly allowing that permission.

The values supported by this are the same as Permissions with the added possibility of it being set to None.

x == y

Checks if two overwrites are equal.

x != y

Checks if two overwrites are not equal.

iter(x)

Returns an iterator of (perm, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Parameters:

**kwargs – Set the value of permissions by their name.

pair()

Tuple[Permissions, Permissions]: Returns the (allow, deny) pair from this overwrite.

classmethod from_pair(allow, deny)

Creates an overwrite from an allow/deny pair of Permissions.

is_empty()

Checks if the permission overwrite is currently empty.

An empty permission overwrite is one that has no overwrites set to True or False.

Returns:

Indicates if the overwrite is empty.

Return type:

bool

update(**kwargs)

Bulk updates this permission overwrite object.

Allows you to set multiple attributes by using keyword arguments. The names must be equivalent to the properties listed. Extraneous key/value pairs will be silently ignored.

Parameters:

**kwargs – A list of key/value pairs to bulk update with.

ShardInfo

Attributes

• id
• latency
• shard_count

Methods

• asyncconnect
• asyncdisconnect
• defis_closed
• defis_ws_ratelimited
• asyncreconnect

class disnake.ShardInfo

A class that gives information and control over a specific shard.

You can retrieve this object via AutoShardedClient.get_shard() or AutoShardedClient.shards.

New in version 1.4.

id

The shard ID for this shard.

Type:

int

shard_count

The shard count for this cluster. If this is None then the bot has not started yet.

Type:

Optional[int]

is_closed()

Whether the shard connection is currently closed.

Return type:

bool

await disconnect()

This function is a coroutine.

Disconnects a shard. When this is called, the shard connection will no longer be open.

If the shard is already disconnected this does nothing.

await reconnect()

This function is a coroutine.

Disconnects and then connects the shard again.

await connect()

This function is a coroutine.

Connects a shard. If the shard is already connected this does nothing.

property latency

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds for this shard.

Type:

float

is_ws_ratelimited()

Whether the websocket is currently rate limited.

This can be useful to know when deciding whether you should query members using HTTP or via the gateway.

New in version 1.6.

Return type:

bool

SessionStartLimit

Attributes

• max_concurrency
• remaining
• reset_after
• reset_time
• total

class disnake.SessionStartLimit

A class that contains information about the current session start limit, at the time when the client connected for the first time.

New in version 2.5.

total

The total number of allowed session starts.

Type:

int

remaining

The remaining number of allowed session starts.

Type:

int

reset_after

The number of milliseconds after which the remaining limit resets, relative to when the client connected. See also reset_time.

Type:

int

max_concurrency

The number of allowed IDENTIFY requests per 5 seconds.

Type:

int

reset_time

The approximate time at which which the remaining limit resets.

Type:

datetime.datetime

GatewayParams

class disnake.GatewayParams

Container type for configuring gateway connections.

New in version 2.6.

Parameters:

• encoding (str) – The payload encoding (json is currently the only supported encoding). Defaults to "json".

• zlib (bool) – Whether to enable transport compression. Defaults to True.

SystemChannelFlags

Attributes

• guild_reminder_notifications
• join_notification_replies
• join_notifications
• premium_subscriptions
• value

class disnake.SystemChannelFlags

Wraps up a Discord system channel flag value.

Similar to Permissions, the properties provided are two way. You can set and retrieve individual bits using the properties as if they were regular bools. This allows you to edit the system flags easily.

To construct an object you can pass keyword arguments denoting the flags to enable or disable. Arguments are applied in order, similar to Permissions.

x == y

Checks if two SystemChannelFlags instances are equal.

x != y

Checks if two SystemChannelFlags instances are not equal.

x <= y

Checks if a SystemChannelFlags instance is a subset of another SystemChannelFlags instance.

New in version 2.6.

x >= y

Checks if a SystemChannelFlags instance is a superset of another SystemChannelFlags instance.

New in version 2.6.

x < y

Checks if a SystemChannelFlags instance is a strict subset of another SystemChannelFlags instance.

New in version 2.6.

x > y

Checks if a SystemChannelFlags instance is a strict superset of another SystemChannelFlags instance.

New in version 2.6.

x | y, x |= y

Returns a new SystemChannelFlags instance with all enabled flags from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y

Returns a new SystemChannelFlags instance with only flags enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y

Returns a new SystemChannelFlags instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x

Returns a new SystemChannelFlags instance with all flags from x inverted.

New in version 2.6.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

Additionally supported are a few operations on class attributes.

SystemChannelFlags.y | SystemChannelFlags.z, SystemChannelFlags(y=True) | SystemChannelFlags.z

Returns a SystemChannelFlags instance with all provided flags enabled.

~SystemChannelFlags.y

Returns a SystemChannelFlags instance with all flags except y inverted from their default value.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

join_notifications

Returns True if the system channel is used for member join notifications.

Type:

bool

premium_subscriptions

Returns True if the system channel is used for “Nitro boosting” notifications.

Type:

bool

guild_reminder_notifications

Returns True if the system channel is used for server setup helpful tips notifications.

New in version 2.0.

Type:

bool

join_notification_replies

Returns True if the system channel shows sticker reply buttons for member join notifications.

New in version 2.3.

Type:

bool

MessageFlags

Attributes

• crossposted
• ephemeral
• failed_to_mention_roles_in_thread
• has_thread
• is_crossposted
• loading
• source_message_deleted
• suppress_embeds
• urgent
• value

class disnake.MessageFlags

Wraps up a Discord Message flag value.

See SystemChannelFlags.

x == y

Checks if two MessageFlags instances are equal.

x != y

Checks if two MessageFlags instances are not equal.

x <= y

Checks if a MessageFlags instance is a subset of another MessageFlags instance.

New in version 2.6.

x >= y

Checks if a MessageFlags instance is a superset of another MessageFlags instance.

New in version 2.6.

x < y

Checks if a MessageFlags instance is a strict subset of another MessageFlags instance.

New in version 2.6.

x > y

Checks if a MessageFlags instance is a strict superset of another MessageFlags instance.

New in version 2.6.

x | y, x |= y

Returns a new MessageFlags instance with all enabled flags from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y

Returns a new MessageFlags instance with only flags enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y

Returns a new MessageFlags instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x

Returns a new MessageFlags instance with all flags from x inverted.

New in version 2.6.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

Additionally supported are a few operations on class attributes.

MessageFlags.y | MessageFlags.z, MessageFlags(y=True) | MessageFlags.z

Returns a MessageFlags instance with all provided flags enabled.

New in version 2.6.

~MessageFlags.y

Returns a MessageFlags instance with all flags except y inverted from their default value.

New in version 2.6.

New in version 1.3.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

crossposted

Returns True if the message is the original crossposted message.

Type:

bool

is_crossposted

Returns True if the message was crossposted from another channel.

Type:

bool

suppress_embeds

Returns True if the message’s embeds have been suppressed.

Type:

bool

source_message_deleted

Returns True if the source message for this crosspost has been deleted.

Type:

bool

urgent

Returns True if the source message is an urgent message.

An urgent message is one sent by Discord Trust and Safety.

Type:

bool

has_thread

Returns True if the source message is associated with a thread.

New in version 2.0.

Type:

bool

ephemeral

Returns True if the source message is ephemeral.

New in version 2.0.

Type:

bool

loading

Returns True if the source message is a deferred interaction response and shows a “thinking” state.

New in version 2.3.

Type:

bool

failed_to_mention_roles_in_thread

Returns True if the source message failed to mention some roles and add their members to the thread.

New in version 2.4.

Type:

bool

PublicUserFlags

Attributes

• active_developer
• bug_hunter
• bug_hunter_level_2
• discord_certified_moderator
• early_supporter
• early_verified_bot_developer
• http_interactions_bot
• hypesquad
• hypesquad_balance
• hypesquad_bravery
• hypesquad_brilliance
• moderator_programs_alumni
• partner
• spammer
• staff
• system
• team_user
• value
• verified_bot
• verified_bot_developer

Methods

• defall

class disnake.PublicUserFlags

Wraps up the Discord User Public flags.

x == y

Checks if two PublicUserFlags instances are equal.

x != y

Checks if two PublicUserFlags instances are not equal.

x <= y

Checks if a PublicUserFlags instance is a subset of another PublicUserFlags instance.

New in version 2.6.

x >= y

Checks if a PublicUserFlags instance is a superset of another PublicUserFlags instance.

New in version 2.6.

x < y

Checks if a PublicUserFlags instance is a strict subset of another PublicUserFlags instance.

New in version 2.6.

x > y

Checks if a PublicUserFlags instance is a strict superset of another PublicUserFlags instance.

New in version 2.6.

x | y, x |= y

Returns a new PublicUserFlags instance with all enabled flags from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y

Returns a new PublicUserFlags instance with only flags enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y

Returns a new PublicUserFlags instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x

Returns a new PublicUserFlags instance with all flags from x inverted.

New in version 2.6.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Additionally supported are a few operations on class attributes.

PublicUserFlags.y | PublicUserFlags.z, PublicUserFlags(y=True) | PublicUserFlags.z

Returns a PublicUserFlags instance with all provided flags enabled.

New in version 2.6.

~PublicUserFlags.y

Returns a PublicUserFlags instance with all flags except y inverted from their default value.

New in version 2.6.

New in version 1.4.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

staff

Returns True if the user is a Discord Employee.

Type:

bool

partner

Returns True if the user is a Discord Partner.

Type:

bool

hypesquad

Returns True if the user is a HypeSquad Events member.

Type:

bool

bug_hunter

Returns True if the user is a Bug Hunter

Type:

bool

hypesquad_bravery

Returns True if the user is a HypeSquad Bravery member.

Type:

bool

hypesquad_brilliance

Returns True if the user is a HypeSquad Brilliance member.

Type:

bool

hypesquad_balance

Returns True if the user is a HypeSquad Balance member.

Type:

bool

early_supporter

Returns True if the user is an Early Supporter.

Type:

bool

team_user

Returns True if the user is a Team User.

Type:

bool

system

Returns True if the user is a system user (i.e. represents Discord officially).

Type:

bool

bug_hunter_level_2

Returns True if the user is a Bug Hunter Level 2

Type:

bool

verified_bot

Returns True if the user is a Verified Bot.

Type:

bool

verified_bot_developer

Returns True if the user is an Early Verified Bot Developer.

Type:

bool

early_verified_bot_developer

An alias for verified_bot_developer.

New in version 1.5.

Type:

bool

moderator_programs_alumni

Returns True if the user is a Discord Moderator Programs Alumni.

New in version 2.8.

Type:

bool

discord_certified_moderator

An alias for moderator_programs_alumni.

New in version 2.0.

Type:

bool

http_interactions_bot

Returns True if the user is a bot that only uses HTTP interactions.

New in version 2.3.

Type:

bool

spammer

Returns True if the user is marked as a spammer.

New in version 2.3.

Type:

bool

active_developer

Returns True if the user is an Active Developer.

New in version 2.8.

Type:

bool

all()

List[UserFlags]: Returns all public flags the user has.

MemberFlags

Attributes

• bypasses_verification
• completed_onboarding
• did_rejoin
• started_onboarding
• value

class disnake.MemberFlags

Wraps up Discord Member flags.

x == y

Checks if two MemberFlags instances are equal.

x != y

Checks if two MemberFlags instances are not equal.

x <= y

Checks if an MemberFlags instance is a subset of another MemberFlags instance.

x >= y

Checks if an MemberFlags instance is a superset of another MemberFlags instance.

x < y

Checks if an MemberFlags instance is a strict subset of another MemberFlags instance.

x > y

Checks if an MemberFlags instance is a strict superset of another MemberFlags instance.

x | y, x |= y

Returns a new MemberFlags instance with all enabled flags from both x and y. (Using |= will update in place).

x & y, x &= y

Returns a new MemberFlags instance with only flags enabled on both x and y. (Using &= will update in place).

x ^ y, x ^= y

Returns a new MemberFlags instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

~x

Returns a new MemberFlags instance with all flags from x inverted.

hash(x)

Returns the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Additionally supported are a few operations on class attributes.

MemberFlags.y | MemberFlags.z, MemberFlags(y=True) | MemberFlags.z

Returns a MemberFlags instance with all provided flags enabled.

~MemberFlags.y

Returns a MemberFlags instance with all flags except y inverted from their default value.

New in version 2.8.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

did_rejoin

Returns True if the member has left and rejoined the guild.

Type:

bool

completed_onboarding

Returns True if the member has completed onboarding.

Type:

bool

bypasses_verification

Returns True if the member is able to bypass guild verification requirements.

Type:

bool

started_onboarding

Returns True if the member has started onboarding.

Type:

bool

Bot UI Kit

The library has helpers to help create component-based UIs.

View

Attributes

• children
• timeout

Methods

• clsView.from_message
• defadd_item
• defclear_items
• asyncinteraction_check
• defis_dispatching
• defis_finished
• defis_persistent
• asyncon_error
• asyncon_timeout
• defremove_item
• defstop
• asyncwait

class disnake.ui.View(*, timeout=180.0)

Represents a UI view.

This object must be inherited to create a UI within Discord.

Alternatively, components can be handled with disnake.ui.ActionRows and event listeners for a more low-level approach. Relevant events are disnake.on_button_click(), disnake.on_dropdown(), and the more generic disnake.on_message_interaction().

New in version 2.0.

Parameters:

timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

timeout

Timeout from last interaction with the UI before no longer accepting input. If None then there is no timeout.

Type:

Optional[float]

children

The list of children attached to this view.

Type:

List[Item]

classmethod from_message(message, /, *, timeout=180.0)

Converts a message’s components into a View.

The Message.components of a message are read-only and separate types from those in the disnake.ui namespace. In order to modify and edit message components they must be converted into a View first.

Parameters:

• message (disnake.Message) – The message with components to convert into a view.

• timeout (Optional[float]) – The timeout of the converted view.

Returns:

The converted view. This always returns a View and not one of its subclasses.

Return type:

View

add_item(item)

Adds an item to the view.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

item (Item) – The item to add to the view.

Raises:

• TypeError – An Item was not passed.

• ValueError – Maximum number of children has been exceeded (25) or the row the item is trying to be added to is full.

remove_item(item)

Removes an item from the view.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

item (Item) – The item to remove from the view.

clear_items()

Removes all items from the view.

This function returns the class instance to allow for fluent-style chaining.

await interaction_check(interaction)

This function is a coroutine.

A callback that is called when an interaction happens within the view that checks whether the view should process item callbacks for the interaction.

This is useful to override if, for example, you want to ensure that the interaction author is a given user.

The default implementation of this returns True.

Note

If an exception occurs within the body then the check is considered a failure and on_error() is called.

Parameters:

interaction (MessageInteraction) – The interaction that occurred.

Returns:

Whether the view children’s callbacks should be called.

Return type:

bool

await on_timeout()

This function is a coroutine.

A callback that is called when a view’s timeout elapses without being explicitly stopped.

await on_error(error, item, interaction)

This function is a coroutine.

A callback that is called when an item’s callback or interaction_check() fails with an error.

The default implementation prints the traceback to stderr.

Parameters:

• error (Exception) – The exception that was raised.

• item (Item) – The item that failed the dispatch.

• interaction (MessageInteraction) – The interaction that led to the failure.

stop()

Stops listening to interaction events from this view.

This operation cannot be undone.

is_finished()

Whether the view has finished interacting.

Return type:

bool

is_dispatching()

Whether the view has been added for dispatching purposes.

Return type:

bool

is_persistent()

Whether the view is set up as persistent.

A persistent view has all their components with a set custom_id and a timeout set to None.

Return type:

bool

await wait()

Waits until the view has finished interacting.

A view is considered finished when stop() is called or it times out.

Returns:

If True, then the view timed out. If False then the view finished normally.

Return type:

bool

ActionRow

Attributes

• children
• walk_components

Methods

• clsActionRow.rows_from_message
• clsActionRow.with_message_components
• clsActionRow.with_modal_components
• defadd_button
• defadd_channel_select
• defadd_mentionable_select
• defadd_role_select
• defadd_string_select
• defadd_text_input
• defadd_user_select
• defappend_item
• defclear_items
• definsert_item
• defpop
• defremove_item

class disnake.ui.ActionRow(*components)

Represents a UI action row. Useful for lower level component manipulation.

x[i]

Returns the component at position i. Also supports slices.

New in version 2.6.

len(x)

Returns the number of components in this row.

New in version 2.6.

iter(x)

Returns an iterator for the components in this row.

New in version 2.6.

To handle interactions created by components sent in action rows or entirely independently, event listeners must be used. For buttons and selects, the related events are disnake.on_button_click() and disnake.on_dropdown(), respectively. Alternatively, disnake.on_message_interaction() can be used for either. For modals, the related event is disnake.on_modal_submit().

New in version 2.4.

Changed in version 2.6: Requires and provides stricter typing for contained components.

Parameters:

*components (WrappedComponent) –

The components of this action row.

Changed in version 2.6: Components can now be either valid in the context of a message, or in the context of a modal. Combining components from both contexts is not supported.

property children

Sequence[WrappedComponent]: A read-only copy of the UI components stored in this action row. To add/remove components to/from the action row, use its methods to directly modify it.

Changed in version 2.6: Returns an immutable sequence instead of a list.

append_item(item)

Append a component to the action row. The component’s type must match that of the action row.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

item (WrappedComponent) – The component to append to the action row.

Raises:

ValueError – The width of the action row exceeds 5.

insert_item(index, item)

Insert a component to the action row at a given index. The component’s type must match that of the action row.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.6.

Parameters:

• index (int) – The index at which to insert the component into the action row.

• item (WrappedComponent) – The component to insert into the action row.

Raises:

ValueError – The width of the action row exceeds 5.

add_button(index=None, *, style=<ButtonStyle.secondary: 2>, label=None, disabled=False, custom_id=None, url=None, emoji=None)

Add a button to the action row. Can only be used if the action row holds message components.

To append a pre-existing Button use the append_item() method instead.

This function returns the class instance to allow for fluent-style chaining.

Changed in version 2.6: Now allows for inserting at a given index. The default behaviour of appending is preserved.

Parameters:

• index (int) – The index at which to insert the button into the action row. If not provided, this method defaults to appending the button to the action row.

• style (ButtonStyle) – The style of the button.

• custom_id (Optional[str]) – The ID of the button that gets received during an interaction. If this button is for a URL, it does not have a custom ID.

• url (Optional[str]) – The URL this button sends you to.

• disabled (bool) – Whether the button is disabled or not.

• label (Optional[str]) – The label of the button, if any.

• emoji (Optional[Union[PartialEmoji, Emoji, str]]) – The emoji of the button, if available.

Raises:

ValueError – The width of the action row exceeds 5.

add_string_select(*, custom_id=..., placeholder=None, min_values=1, max_values=1, options=..., disabled=False)

Add a string select menu to the action row. Can only be used if the action row holds message components.

To append a pre-existing StringSelect use the append_item() method instead.

This function returns the class instance to allow for fluent-style chaining.

Changed in version 2.7: Renamed from add_select to add_string_select.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• options (Union[List[disnake.SelectOption], List[str], Dict[str, str]]) – A list of options that can be selected in this menu. Use explicit SelectOptions for fine-grained control over the options. Alternatively, a list of strings will be treated as a list of labels, and a dict will be treated as a mapping of labels to values.

• disabled (bool) – Whether the select is disabled or not.

Raises:

ValueError – The width of the action row exceeds 5.

add_user_select(*, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False)

Add a user select menu to the action row. Can only be used if the action row holds message components.

To append a pre-existing UserSelect use the append_item() method instead.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.7.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not.

Raises:

ValueError – The width of the action row exceeds 5.

add_role_select(*, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False)

Add a role select menu to the action row. Can only be used if the action row holds message components.

To append a pre-existing RoleSelect use the append_item() method instead.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.7.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not.

Raises:

ValueError – The width of the action row exceeds 5.

add_mentionable_select(*, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False)

Add a mentionable (user/member/role) select menu to the action row. Can only be used if the action row holds message components.

To append a pre-existing MentionableSelect use the append_item() method instead.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.7.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not.

Raises:

ValueError – The width of the action row exceeds 5.

add_channel_select(*, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, channel_types=None)

Add a channel select menu to the action row. Can only be used if the action row holds message components.

To append a pre-existing ChannelSelect use the append_item() method instead.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.7.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not.

• channel_types (Optional[List[ChannelType]]) – The list of channel types that can be selected in this select menu. Defaults to all types (i.e. None).

Raises:

ValueError – The width of the action row exceeds 5.

add_text_input(*, label, custom_id, style=<TextInputStyle.short: 1>, placeholder=None, value=None, required=True, min_length=None, max_length=None)

Add a text input to the action row. Can only be used if the action row holds modal components.

To append a pre-existing TextInput use the append_item() method instead.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.4.

Parameters:

• style (TextInputStyle) – The style of the text input.

• label (str) – The label of the text input.

• custom_id (str) – The ID of the text input that gets received during an interaction.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is entered.

• value (Optional[str]) – The pre-filled value of the text input.

• required (bool) – Whether the text input is required. Defaults to True.

• min_length (Optional[int]) – The minimum length of the text input.

• max_length (Optional[int]) – The maximum length of the text input.

Raises:

ValueError – The width of the action row exceeds 5.

clear_items()

Remove all components from the action row.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.6.

remove_item(item)

Remove a component from the action row.

This function returns the class instance to allow for fluent-style chaining.

New in version 2.6.

Parameters:

item (WrappedComponent) – The component to remove from the action row.

Raises:

ValueError – The component could not be found on the action row.

pop(index)

Pop the component at the provided index from the action row.

New in version 2.6.

Parameters:

index (int) – The index at which to pop the component.

Raises:

IndexError – There is no component at the provided index.

classmethod with_modal_components()

Create an empty action row meant to store components compatible with disnake.ui.Modal. Saves the need to import type specifiers to typehint empty action rows.

New in version 2.6.

Returns:

The newly created empty action row, intended for modal components.

Return type:

ActionRow

classmethod with_message_components()

Create an empty action row meant to store components compatible with disnake.Message. Saves the need to import type specifiers to typehint empty action rows.

New in version 2.6.

Returns:

The newly created empty action row, intended for message components.

Return type:

ActionRow

classmethod rows_from_message(message, *, strict=True)

Create a list of up to 5 action rows from the components on an existing message.

This will abide by existing component format on the message, including component ordering and rows. Components will be transformed to UI kit components, such that they can be easily modified and re-sent as action rows.

New in version 2.6.

Parameters:

• message (disnake.Message) – The message from which to extract the components.

• strict (bool) – Whether or not to raise an exception if an unknown component type is encountered.

Raises:

TypeError – Strict-mode is enabled and an unknown component type is encountered.

Returns:

The action rows parsed from the components on the message.

Return type:

List[ActionRow]

staticmethod for ... in walk_components(action_rows)

Iterate over the components in a sequence of action rows, yielding each individual component together with the action row of which it is a child.

New in version 2.6.

Parameters:

action_rows (Sequence[ActionRow]) – The sequence of action rows over which to iterate.

Yields:

Tuple[ActionRow, WrappedComponent] – A tuple containing an action row and a component of that action row.

Item

Attributes

• view

Methods

• asynccallback

class disnake.ui.Item

Represents the base UI item that all UI items inherit from.

This class adds more functionality on top of the WrappedComponent base class. This functionality mostly relates to disnake.ui.View.

The current UI items supported are:

• disnake.ui.Button

• subtypes of disnake.ui.BaseSelect (disnake.ui.ChannelSelect, disnake.ui.MentionableSelect, disnake.ui.RoleSelect, disnake.ui.StringSelect, disnake.ui.UserSelect)

New in version 2.0.

property view

The underlying view for this item.

Type:

Optional[View]

await callback(interaction, /)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameters:

interaction (MessageInteraction) – The interaction that triggered this UI item.

WrappedComponent

class disnake.ui.WrappedComponent

Represents the base UI component that all UI components inherit from.

The following classes implement this ABC:

• disnake.ui.Button

• subtypes of disnake.ui.BaseSelect (disnake.ui.ChannelSelect, disnake.ui.MentionableSelect, disnake.ui.RoleSelect, disnake.ui.StringSelect, disnake.ui.UserSelect)

• disnake.ui.TextInput

New in version 2.4.

Button

Attributes

• custom_id
• disabled
• emoji
• label
• style
• url
• view

Methods

• asynccallback

class disnake.ui.Button(*, style=<ButtonStyle.secondary: 2>, label=None, disabled=False, custom_id=None, url=None, emoji=None, row=None)

Represents a UI button.

New in version 2.0.

Parameters:

• style (disnake.ButtonStyle) – The style of the button.

• custom_id (Optional[str]) – The ID of the button that gets received during an interaction. If this button is for a URL, it does not have a custom ID.

• url (Optional[str]) – The URL this button sends you to.

• disabled (bool) – Whether the button is disabled.

• label (Optional[str]) – The label of the button, if any.

• emoji (Optional[Union[PartialEmoji, Emoji, str]]) – The emoji of the button, if available.

• row (Optional[int]) – The relative row this button belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

property style

The style of the button.

Type:

disnake.ButtonStyle

property custom_id

The ID of the button that gets received during an interaction.

If this button is for a URL, it does not have a custom ID.

Type:

Optional[str]

property url

The URL this button sends you to.

Type:

Optional[str]

await callback(interaction, /)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameters:

interaction (MessageInteraction) – The interaction that triggered this UI item.

property disabled

Whether the button is disabled.

Type:

bool

property view

The underlying view for this item.

Type:

Optional[View]

property label

The label of the button, if available.

Type:

Optional[str]

property emoji

The emoji of the button, if available.

Type:

Optional[PartialEmoji]

disnake.ui.button(cls=disnake.ui.Button, *, style=ButtonStyle.secondary, label=None, disabled=False, custom_id=..., url=None, emoji=None, row=None)

A decorator that attaches a button to a component.

The function being decorated should have three parameters, self representing the disnake.ui.View, the disnake.ui.Button that was interacted with, and the disnake.MessageInteraction.

Note

Buttons with a URL cannot be created with this function. Consider creating a Button manually instead. This is because buttons with a URL do not have a callback associated with them since Discord does not do any processing with it.

Parameters:

• cls (Type[Button]) –

  The button subclass to create an instance of. If provided, the following parameters described below do no apply. Instead, this decorator will accept the same keywords as the passed cls does.

  New in version 2.6.

• label (Optional[str]) – The label of the button, if any.

• custom_id (Optional[str]) – The ID of the button that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• style (ButtonStyle) – The style of the button. Defaults to ButtonStyle.grey.

• disabled (bool) – Whether the button is disabled. Defaults to False.

• emoji (Optional[Union[str, Emoji, PartialEmoji]]) – The emoji of the button. This can be in string form or a PartialEmoji or a full Emoji.

• row (Optional[int]) – The relative row this button belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

BaseSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder
• view

Methods

• asynccallback
• defis_dispatchable

class disnake.ui.BaseSelect(underlying_type, component_type, *, custom_id, placeholder, min_values, max_values, disabled, row)

Represents an abstract UI select menu.

This is usually represented as a drop down menu.

This isn’t meant to be used directly, instead use one of the concrete select menu types:

• disnake.ui.StringSelect

• disnake.ui.UserSelect

• disnake.ui.RoleSelect

• disnake.ui.MentionableSelect

• disnake.ui.ChannelSelect

New in version 2.7.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property disabled

Whether the select menu is disabled.

Type:

bool

await callback(interaction, /)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameters:

interaction (MessageInteraction) – The interaction that triggered this UI item.

property view

The underlying view for this item.

Type:

Optional[View]

is_dispatchable()

Whether the select menu is dispatchable. This will always return True.

Return type:

bool

ChannelSelect

Attributes

• channel_types
• custom_id
• disabled
• max_values
• min_values
• placeholder
• values
• view

Methods

• asynccallback
• defis_dispatchable

class disnake.ui.ChannelSelect(*, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, channel_types=None, row=None)

Represents a UI channel select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use values.

New in version 2.7.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• channel_types (Optional[List[ChannelType]]) – The list of channel types that can be selected in this select menu. Defaults to all types (i.e. None).

values

A list of channels that have been selected by the user.

Type:

List[Union[abc.GuildChannel, Thread, PartialMessageable]]

await callback(interaction, /)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameters:

interaction (MessageInteraction) – The interaction that triggered this UI item.

property channel_types

A list of channel types that can be selected in this select menu.

Type:

Optional[List[disnake.ChannelType]]

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select menu is disabled.

Type:

bool

is_dispatchable()

Whether the select menu is dispatchable. This will always return True.

Return type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

disnake.ui.channel_select(cls=disnake.ui.ChannelSelect, *, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, channel_types=None, row=None)

A decorator that attaches a channel select menu to a component.

The function being decorated should have three parameters, self representing the disnake.ui.View, the disnake.ui.ChannelSelect that was interacted with, and the disnake.MessageInteraction.

In order to get the selected items that the user has chosen within the callback use ChannelSelect.values.

New in version 2.7.

Parameters:

• cls (Type[ChannelSelect]) – The select subclass to create an instance of. If provided, the following parameters described below do no apply. Instead, this decorator will accept the same keywords as the passed cls does.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled. Defaults to False.

• channel_types (Optional[List[ChannelType]]) – The list of channel types that can be selected in this select menu. Defaults to all types (i.e. None).

MentionableSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder
• values
• view

Methods

• asynccallback
• defis_dispatchable

class disnake.ui.MentionableSelect(*, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

Represents a UI mentionable (user/member/role) select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use values.

New in version 2.7.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

values

A list of users, members and/or roles that have been selected by the user.

Type:

List[Union[User, Member, Role]]

await callback(interaction, /)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameters:

interaction (MessageInteraction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select menu is disabled.

Type:

bool

is_dispatchable()

Whether the select menu is dispatchable. This will always return True.

Return type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

disnake.ui.mentionable_select(cls=disnake.ui.MentionableSelect, *, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

A decorator that attaches a mentionable (user/member/role) select menu to a component.

The function being decorated should have three parameters, self representing the disnake.ui.View, the disnake.ui.MentionableSelect that was interacted with, and the disnake.MessageInteraction.

In order to get the selected items that the user has chosen within the callback use MentionableSelect.values.

New in version 2.7.

Parameters:

• cls (Type[MentionableSelect]) – The select subclass to create an instance of. If provided, the following parameters described below do no apply. Instead, this decorator will accept the same keywords as the passed cls does.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled. Defaults to False.

RoleSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder
• values
• view

Methods

• asynccallback
• defis_dispatchable

class disnake.ui.RoleSelect(*, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

Represents a UI user select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use values.

New in version 2.7.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

values

A list of roles that have been selected by the user.

Type:

List[Role]

await callback(interaction, /)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameters:

interaction (MessageInteraction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select menu is disabled.

Type:

bool

is_dispatchable()

Whether the select menu is dispatchable. This will always return True.

Return type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

disnake.ui.role_select(cls=disnake.ui.RoleSelect, *, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

A decorator that attaches a role select menu to a component.

The function being decorated should have three parameters, self representing the disnake.ui.View, the disnake.ui.RoleSelect that was interacted with, and the disnake.MessageInteraction.

In order to get the selected items that the user has chosen within the callback use RoleSelect.values.

New in version 2.7.

Parameters:

• cls (Type[RoleSelect]) – The select subclass to create an instance of. If provided, the following parameters described below do no apply. Instead, this decorator will accept the same keywords as the passed cls does.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled. Defaults to False.

StringSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• options
• placeholder
• values
• view

Methods

• defadd_option
• defappend_option
• asynccallback
• defis_dispatchable

class disnake.ui.StringSelect(*, custom_id=..., placeholder=None, min_values=1, max_values=1, options=..., disabled=False, row=None)

Represents a UI string select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use values.

New in version 2.0.

Changed in version 2.7: Renamed from Select to StringSelect.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• options (Union[List[disnake.SelectOption], List[str], Dict[str, str]]) –

  A list of options that can be selected in this menu. Use explicit SelectOptions for fine-grained control over the options. Alternatively, a list of strings will be treated as a list of labels, and a dict will be treated as a mapping of labels to values.

  Changed in version 2.5: Now also accepts a list of str or a dict of str to str, which are then appropriately parsed as SelectOption labels and values.

• disabled (bool) – Whether the select is disabled.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

values

A list of values that have been selected by the user.

Type:

List[str]

property options

A list of options that can be selected in this select menu.

Type:

List[disnake.SelectOption]

add_option(*, label, value=..., description=None, emoji=None, default=False)

Adds an option to the select menu.

To append a pre-existing SelectOption use the append_option() method instead.

Parameters:

• label (str) – The label of the option. This is displayed to users. Can only be up to 100 characters.

• value (str) – The value of the option. This is not displayed to users. If not given, defaults to the label. Can only be up to 100 characters.

• description (Optional[str]) – An additional description of the option, if any. Can only be up to 100 characters.

• emoji (Optional[Union[str, Emoji, PartialEmoji]]) – The emoji of the option, if available. This can either be a string representing the custom or unicode emoji or an instance of PartialEmoji or Emoji.

• default (bool) – Whether this option is selected by default.

Raises:

ValueError – The number of options exceeds 25.

append_option(option)

Appends an option to the select menu.

Parameters:

option (disnake.SelectOption) – The option to append to the select menu.

Raises:

ValueError – The number of options exceeds 25.

await callback(interaction, /)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameters:

interaction (MessageInteraction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select menu is disabled.

Type:

bool

is_dispatchable()

Whether the select menu is dispatchable. This will always return True.

Return type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

disnake.ui.string_select(cls=disnake.ui.StringSelect, *, custom_id=..., placeholder=None, min_values=1, max_values=1, options=..., disabled=False, row=None)

A decorator that attaches a string select menu to a component.

The function being decorated should have three parameters, self representing the disnake.ui.View, the disnake.ui.StringSelect that was interacted with, and the disnake.MessageInteraction.

In order to get the selected items that the user has chosen within the callback use StringSelect.values.

Changed in version 2.7: Renamed from select to string_select.

Parameters:

• cls (Type[StringSelect]) –

  The select subclass to create an instance of. If provided, the following parameters described below do no apply. Instead, this decorator will accept the same keywords as the passed cls does.

  New in version 2.6.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• options (Union[List[disnake.SelectOption], List[str], Dict[str, str]]) –

  A list of options that can be selected in this menu. Use explicit SelectOptions for fine-grained control over the options. Alternatively, a list of strings will be treated as a list of labels, and a dict will be treated as a mapping of labels to values.

  Changed in version 2.5: Now also accepts a list of str or a dict of str to str, which are then appropriately parsed as SelectOption labels and values.

• disabled (bool) – Whether the select is disabled. Defaults to False.

UserSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder
• values
• view

Methods

• asynccallback
• defis_dispatchable

class disnake.ui.UserSelect(*, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

Represents a UI user select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use values.

New in version 2.7.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

values

A list of users/members that have been selected by the user.

Type:

List[User, Member]

await callback(interaction, /)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameters:

interaction (MessageInteraction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select menu is disabled.

Type:

bool

is_dispatchable()

Whether the select menu is dispatchable. This will always return True.

Return type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

disnake.ui.user_select(cls=disnake.ui.UserSelect, *, custom_id=..., placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

A decorator that attaches a user select menu to a component.

The function being decorated should have three parameters, self representing the disnake.ui.View, the disnake.ui.UserSelect that was interacted with, and the disnake.MessageInteraction.

In order to get the selected items that the user has chosen within the callback use UserSelect.values.

New in version 2.7.

Parameters:

• cls (Type[UserSelect]) – The select subclass to create an instance of. If provided, the following parameters described below do no apply. Instead, this decorator will accept the same keywords as the passed cls does.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled. Defaults to False.

Modal

Methods

• defadd_text_input
• defappend_component
• asynccallback
• asyncon_error
• asyncon_timeout

class disnake.ui.Modal(*, title, components, custom_id=..., timeout=600)

Represents a UI Modal.

New in version 2.4.

Parameters:

• title (str) – The title of the modal.

• components (Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[Union[disnake.ui.ActionRow, disnake.ui.WrappedComponent, List[disnake.ui.WrappedComponent]]]]) – The components to display in the modal. Up to 5 action rows.

• custom_id (str) – The custom ID of the modal.

• timeout (float) – The time to wait until the modal is removed from cache, if no interaction is made. Modals without timeouts are not supported, since there’s no event for when a modal is closed. Defaults to 600 seconds.

append_component(component)

Adds one or multiple component(s) to the modal.

Parameters:

component (Union[TextInput, List[TextInput]]) – The component(s) to add to the modal. This can be a single component or a list of components.

Raises:

• ValueError – Maximum number of components (5) exceeded.

• TypeError – An object of type TextInput was not passed.

add_text_input(*, label, custom_id, style=<TextInputStyle.short: 1>, placeholder=None, value=None, required=True, min_length=None, max_length=None)

Creates and adds a text input component to the modal.

To append a pre-existing instance of TextInput use the append_component() method.

Parameters:

• label (str) – The label of the text input.

• custom_id (str) – The ID of the text input that gets received during an interaction.

• style (TextInputStyle) – The style of the text input.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is entered.

• value (Optional[str]) – The pre-filled value of the text input.

• required (bool) – Whether the text input is required. Defaults to True.

• min_length (Optional[int]) – The minimum length of the text input.

• max_length (Optional[int]) – The maximum length of the text input.

Raises:

ValueError – Maximum number of components (5) exceeded.

await callback(interaction, /)

This function is a coroutine.

The callback associated with this modal.

This can be overriden by subclasses.

Parameters:

interaction (ModalInteraction) – The interaction that triggered this modal.

await on_error(error, interaction)

This function is a coroutine.

A callback that is called when an error occurs.

The default implementation prints the traceback to stderr.

Parameters:

• error (Exception) – The exception that was raised.

• interaction (ModalInteraction) – The interaction that triggered this modal.

await on_timeout()

This function is a coroutine.

A callback that is called when the modal is removed from the cache without an interaction being made.

TextInput

Attributes

• custom_id
• label
• max_length
• min_length
• placeholder
• required
• style
• value

class disnake.ui.TextInput(*, label, custom_id, style=<TextInputStyle.short: 1>, placeholder=None, value=None, required=True, min_length=None, max_length=None)

Represents a UI text input.

This can only be used in a Modal.

New in version 2.4.

Parameters:

• label (str) – The label of the text input.

• custom_id (str) – The ID of the text input that gets received during an interaction.

• style (TextInputStyle) – The style of the text input.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is entered.

• value (Optional[str]) – The pre-filled value of the text input.

• required (bool) – Whether the text input is required. Defaults to True.

• min_length (Optional[int]) – The minimum length of the text input.

• max_length (Optional[int]) – The maximum length of the text input.

property style

The style of the text input.

Type:

TextInputStyle

property label

The label of the text input.

Type:

str

property custom_id

The ID of the text input that gets received during an interaction.

Type:

str

property placeholder

The placeholder text that is shown if nothing is entered.

Type:

Optional[str]

property value

The pre-filled text of the text input.

Type:

Optional[str]

property required

Whether the text input is required.

Type:

bool

property min_length

The minimum length of the text input.

Type:

Optional[int]

property max_length

The maximum length of the text input.

Type:

Optional[int]

Localization

The library uses the following types/methods to support localization.

Localized

class disnake.Localized(string=None, *, key=..., data=...)

A container type used for localized parameters.

Exactly one of key or data must be provided.

There is an alias for this called Localised.

New in version 2.5.

Parameters:

• string (Optional[str]) – The default (non-localized) value of the string. Whether this is optional or not depends on the localized parameter type.

• key (str) – A localization key used for lookups. Incompatible with data.

• data (Union[Dict[Locale, str], Dict[str, str]]) – A mapping of locales to localized values. Incompatible with key.

LocalizationValue

class disnake.LocalizationValue(localizations)

Container type for (pending) localization data.

New in version 2.5.

property data

A dict with a locale -> localization mapping, if available.

Type:

Optional[Dict[str, str]]

LocalizationProtocol

class disnake.LocalizationProtocol

Manages a key-value mapping of localizations.

This is an abstract class, a concrete implementation is provided as LocalizationStore.

New in version 2.5.

abstractmethod get(key)

Returns localizations for the specified key.

Parameters:

key (str) – The lookup key.

Raises:

LocalizationKeyError – May be raised if no localizations for the provided key were found, depending on the implementation.

Returns:

The localizations for the provided key. May return None if no localizations could be found.

Return type:

Optional[Dict[str, str]]

load(path)

Adds localizations from the provided path.

Parameters:

path (Union[str, os.PathLike]) – The path to the file/directory to load.

Raises:

RuntimeError – The provided path is invalid or couldn’t be loaded

reload()

Clears localizations and reloads all previously loaded sources again. If an exception occurs, the previous data gets restored and the exception is re-raised.

LocalizationStore

class disnake.LocalizationStore(*, strict)

Manages a key-value mapping of localizations using .json files.

New in version 2.5.

strict

Specifies whether get() raises an exception if localizations for a provided key couldn’t be found.

Type:

bool

get(key)

Returns localizations for the specified key.

Parameters:

key (str) – The lookup key.

Raises:

LocalizationKeyError – No localizations for the provided key were found. Raised only if strict is enabled, returns None otherwise.

Returns:

The localizations for the provided key. Returns None if no localizations could be found and strict is disabled.

Return type:

Optional[Dict[str, str]]

load(path)

Adds localizations from the provided path to the store. If the path points to a file, the file gets loaded. If it’s a directory, all .json files in that directory get loaded (non-recursive).

Parameters:

path (Union[str, os.PathLike]) – The path to the file/directory to load.

Raises:

RuntimeError – The provided path is invalid or couldn’t be loaded

reload()

Clears localizations and reloads all previously loaded files/directories again. If an exception occurs, the previous data gets restored and the exception is re-raised. See load() for possible raised exceptions.

Exceptions

The following exceptions are thrown by the library.

exception disnake.DiscordException

Base exception class for disnake.

Ideally speaking, this could be caught to handle any exceptions raised from this library.

exception disnake.ClientException

Exception that’s raised when an operation in the Client fails.

These are usually for exceptions that happened due to user input.

exception disnake.LoginFailure

Exception that’s raised when the Client.login() function fails to log you in from improper credentials or some other misc. failure.

exception disnake.NoMoreItems

Exception that is raised when an async iteration operation has no more items.

exception disnake.HTTPException(response, message)

Exception that’s raised when an HTTP request operation fails.

response

The response of the failed HTTP request. This is an instance of aiohttp.ClientResponse. In some cases this could also be a requests.Response.

Type:

aiohttp.ClientResponse

text

The text of the error. Could be an empty string.

Type:

str

status

The status code of the HTTP request.

Type:

int

code

The Discord specific error code for the failure.

Type:

int

exception disnake.Forbidden(response, message)

Exception that’s raised for when status code 403 occurs.

Subclass of HTTPException.

exception disnake.NotFound(response, message)

Exception that’s raised for when status code 404 occurs.

Subclass of HTTPException.

exception disnake.DiscordServerError(response, message)

Exception that’s raised for when a 500 range status code occurs.

Subclass of HTTPException.

New in version 1.5.

exception disnake.InvalidData

Exception that’s raised when the library encounters unknown or invalid data from Discord.

exception disnake.WebhookTokenMissing

Exception that’s raised when a Webhook or SyncWebhook is missing a token to make requests with.

New in version 2.6.

exception disnake.GatewayNotFound

An exception that is raised when the gateway for Discord could not be found

exception disnake.ConnectionClosed(socket, *, shard_id, code=None, voice=False)

Exception that’s raised when the gateway connection is closed for reasons that could not be handled internally.

code

The close code of the websocket.

Type:

int

reason

The reason provided for the closure.

Type:

str

shard_id

The shard ID that got closed if applicable.

Type:

Optional[int]

exception disnake.PrivilegedIntentsRequired(shard_id)

Exception that’s raised when the gateway is requesting privileged intents but they’re not ticked in the developer page yet.

Go to https://discord.com/developers/applications/ and enable the intents that are required. Currently these are as follows:

• Intents.members

• Intents.presences

• Intents.message_content

shard_id

The shard ID that got closed if applicable.

Type:

Optional[int]

exception disnake.SessionStartLimitReached(session_start_limit, requested=1)

Exception that’s raised when Client.connect() function fails to connect to Discord due to the session start limit being reached.

New in version 2.6.

session_start_limit

The current state of the session start limit.

Type:

SessionStartLimit

exception disnake.InteractionException

Exception that’s raised when an interaction operation fails

New in version 2.0.

interaction

The interaction that was responded to.

Type:

Interaction

exception disnake.InteractionResponded(interaction)

Exception that’s raised when sending another interaction response using InteractionResponse when one has already been done before.

An interaction can only be responded to once.

New in version 2.0.

interaction

The interaction that’s already been responded to.

Type:

Interaction

exception disnake.InteractionNotResponded(interaction)

Exception that’s raised when editing an interaction response without sending a response message first.

An interaction must be responded to exactly once.

New in version 2.0.

interaction

The interaction that hasn’t been responded to.

Type:

Interaction

exception disnake.InteractionTimedOut(interaction)

Exception that’s raised when an interaction takes more than 3 seconds to respond but is not deferred.

New in version 2.0.

interaction

The interaction that was responded to.

Type:

Interaction

exception disnake.ModalChainNotSupported(interaction)

Exception that’s raised when responding to a modal with another modal.

New in version 2.4.

interaction

The interaction that was responded to.

Type:

ModalInteraction

exception disnake.LocalizationKeyError(key)

Exception that’s raised when a localization key lookup fails.

New in version 2.5.

key

The localization key that couldn’t be found.

Type:

str

exception disnake.opus.OpusError(code)

An exception that is thrown for libopus related errors.

code

The error code returned.

Type:

int

exception disnake.opus.OpusNotLoaded

An exception that is thrown for when libopus is not loaded.

Exception Hierarchy

• Exception

  • DiscordException

    • ClientException

      • InvalidData

      • LoginFailure

      • ConnectionClosed

      • PrivilegedIntentsRequired

      • SessionStartLimitReached

      • InteractionException

        • InteractionResponded

        • InteractionNotResponded

        • InteractionTimedOut

        • ModalChainNotSupported

    • NoMoreItems

    • GatewayNotFound

    • HTTPException

      • Forbidden

      • NotFound

      • DiscordServerError

    • LocalizationKeyError

    • WebhookTokenMissing

Warnings

class disnake.DiscordWarning

Base warning class for disnake.

New in version 2.3.

class disnake.ConfigWarning

Warning class related to configuration issues.

New in version 2.3.

class disnake.SyncWarning

Warning class for application command synchronization issues.

New in version 2.3.

class disnake.LocalizationWarning

Warning class for localization issues.

New in version 2.5.

Warning Hierarchy

• DiscordWarning

  • ConfigWarning

  • SyncWarning

  • LocalizationWarning