Referencia de API<a class="headerlink" href="#api-reference" title="Enlazar permanentemente con este título">¶

get_global_command_named(name, cmd_type=None)¶

Returns a global application command matching the specified name.

Parámetros

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

Devuelve

The application command.

Tipo del valor devuelto

get_guild_command_named(guild_id, name, cmd_type=None)¶

Returns a guild application command matching the name.

Parámetros

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.

Devuelve

The application command.

Tipo del valor devuelto

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.

Ejemplos

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}!')

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('👍')

Parámetros

event (str) – The event name, similar to the event reference, but without the on_ prefix, to wait for.
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.

Muestra

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

Devuelve

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

Tipo del valor devuelto

Any

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

This function is a coroutine.

Changes the client’s presence.

Ejemplo

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

Distinto en la versión 2.0: Removed the afk keyword-only parameter.

Parámetros

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.

Muestra

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

await fetch_template(code)¶

This function is a coroutine.

Gets a Template from a disnake.new URL or code.

Parámetros

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

Muestra

NotFound – The template is invalid.
HTTPException – Getting the template failed.

Devuelve

The template from the URL/code.

Tipo del valor devuelto

Template

await fetch_guild(guild_id, /)¶

This function is a coroutine.

Retrieves a Guild from an ID.

Nota

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

Nota

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

Parámetros

guild_id (int) – The guild’s ID to fetch from.

Muestra

Forbidden – You do not have access to the guild.
HTTPException – Getting the guild failed.

Devuelve

The guild from the ID.

Tipo del valor devuelto

await create_guild(*, name, region=<VoiceRegion.us_west: 'us-west'>, icon=..., code=...)¶

This function is a coroutine.

Creates a Guild.

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

Parámetros

name (str) – The name of the guild.
region (VoiceRegion) – The region for the voice communication server. Defaults to VoiceRegion.us_west.
icon (Optional[bytes]) – The bytes-like object representing the icon. See ClientUser.edit() for more details on what is expected.
code (str) –
The code for a template to create the guild with.

Nuevo en la versión 1.4.

Muestra

HTTPException – Guild creation failed.
InvalidArgument – Invalid icon image format given. Must be PNG or JPG.

Devuelve

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

Tipo del valor devuelto

await fetch_stage_instance(channel_id, /)¶

This function is a coroutine.

Gets a StageInstance for a stage channel id.

Nuevo en la versión 2.0.

Parámetros

channel_id (int) – The stage channel ID.

Muestra

NotFound – The stage instance or channel could not be found.
HTTPException – Getting the stage instance failed.

Devuelve

The stage instance from the stage channel ID.

Tipo del valor devuelto

StageInstance

await fetch_invite(url, *, with_counts=True, with_expiration=True)¶

This function is a coroutine.

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

Nota

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.

Parámetros

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.

Nuevo en la versión 2.0.

Muestra

NotFound – The invite has expired or is invalid.
HTTPException – Getting the invite failed.

Devuelve

The invite from the URL/ID.

Tipo del valor devuelto

await delete_invite(invite)¶

This function is a coroutine.

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

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

Parámetros

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

Muestra

Forbidden – You do not have permissions to revoke invites.
NotFound – The invite is invalid or expired.
HTTPException – Revoking the invite failed.

await fetch_widget(guild_id, /)¶

This function is a coroutine.

Gets a Widget from a guild ID.

Nota

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

Parámetros

guild_id (int) – The ID of the guild.

Muestra

Forbidden – The widget for this guild is disabled.
HTTPException – Retrieving the widget failed.

Devuelve

The guild’s widget.

Tipo del valor devuelto

Widget

await application_info()¶

This function is a coroutine.

Retrieves the bot’s application information.

Muestra: HTTPException – Retrieving the information failed somehow.
Devuelve: The bot’s application information.
Tipo del valor devuelto: 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.

Nota

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

Parámetros

user_id (int) – The user’s ID to fetch from.

Muestra

NotFound – A user with this ID does not exist.
HTTPException – Fetching the user failed.

Devuelve

The user you requested.

Tipo del valor devuelto

User

await fetch_channel(channel_id, /)¶

This function is a coroutine.

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

Nota

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

Nuevo en la versión 1.2.

Muestra

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.

Devuelve

The channel from the ID.

Tipo del valor devuelto

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

await fetch_webhook(webhook_id, /)¶

This function is a coroutine.

Retrieves a Webhook with the specified ID.

Muestra

HTTPException – Retrieving the webhook failed.
NotFound – Invalid webhook ID.
Forbidden – You do not have permission to fetch this webhook.

Devuelve

The webhook you requested.

Tipo del valor devuelto

await fetch_sticker(sticker_id, /)¶

This function is a coroutine.

Retrieves a Sticker with the specified ID.

Nuevo en la versión 2.0.

Muestra

HTTPException – Retrieving the sticker failed.
NotFound – Invalid sticker ID.

Devuelve

The sticker you requested.

Tipo del valor devuelto

Union[StandardSticker, GuildSticker]

await fetch_premium_sticker_packs()¶

This function is a coroutine.

Retrieves all available premium sticker packs.

Nuevo en la versión 2.0.

Muestra: HTTPException – Retrieving the sticker packs failed.
Devuelve: All available premium sticker packs.
Tipo del valor devuelto: List[StickerPack]

await create_dm(user)¶

This function is a coroutine.

Creates a DMChannel with this user.

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

Nuevo en la versión 2.0.

Parámetros: user (Snowflake) – The user to create a DM with.
Devuelve: The channel that was created.
Tipo del valor devuelto: 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.

Nuevo en la versión 2.0.

Parámetros

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.

Muestra

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: Sequence[disnake.ui.view.View]¶

A sequence of persistent views added to the client.

Nuevo en la versión 2.0.

Type: Sequence[View]

await fetch_global_commands()¶

This function is a coroutine.

Requests a list of global application commands.

Nuevo en la versión 2.1.

Devuelve: A list of application commands.
Tipo del valor devuelto: List[ApplicationCommand]

await fetch_global_command(command_id)¶

This function is a coroutine.

Requests a global application command.

Nuevo en la versión 2.1.

Parámetros: command_id (int) – the ID of the command to request.
Devuelve: The requested application command.
Tipo del valor devuelto: ApplicationCommand

await create_global_command(application_command)¶

This function is a coroutine.

Creates a global application command.

Nuevo en la versión 2.1.

Parámetros: application_command (ApplicationCommand) – an object representing the application command.
Devuelve: The application command that was created.
Tipo del valor devuelto: ApplicationCommand

await edit_global_command(command_id, new_command)¶

This function is a coroutine.

Edits a global application command.

Nuevo en la versión 2.1.

Parámetros

command_id (int) – the ID of the command to edit.
new_command (ApplicationCommand) – an object representing the edited command.

Devuelve

The edited application command.

Tipo del valor devuelto

await delete_global_command(command_id)¶

This function is a coroutine.

Deletes a global application command.

Nuevo en la versión 2.1.

Parámetros: command_id (int) – the ID of the command to delete.

await bulk_overwrite_global_commands(application_commands)¶

This function is a coroutine.

Overwrites several global application commands in one API request.

Nuevo en la versión 2.1.

Parámetros: application_commands (List[ApplicationCommand]) – a list of application commands to insert instead of the existing commands.
Devuelve: A list of registered application commands.
Tipo del valor devuelto: List[ApplicationCommand]

await fetch_guild_commands(guild_id)¶

This function is a coroutine.

Requests a list of guild application commands.

Nuevo en la versión 2.1.

Parámetros: guild_id (int) – the ID of the guild to fetch commands from.
Devuelve: A list of application commands.
Tipo del valor devuelto: List[ApplicationCommand]

await fetch_guild_command(guild_id, command_id)¶

This function is a coroutine.

Requests a guild application command.

Nuevo en la versión 2.1.

Parámetros

guild_id (int) – the ID of the guild to fetch command from.
command_id (int) – the ID of the command to request.

Devuelve

The requested application command.

Tipo del valor devuelto

await create_guild_command(guild_id, application_command)¶

This function is a coroutine.

Creates a guild application command.

Nuevo en la versión 2.1.

Parámetros

guild_id (int) – the ID of the guild where the command should be inserted.
application_command (ApplicationCommand) – an object representing the application command.

Devuelve

The application command that was created.

Tipo del valor devuelto

await edit_guild_command(guild_id, command_id, new_command)¶

This function is a coroutine.

Edits a guild application command.

Nuevo en la versión 2.1.

Parámetros

guild_id (int) – the ID of the guild where the command should be edited.
command_id (int) – the ID of the command to edit.
new_command (ApplicationCommand) – an object representing the edited command.

Devuelve

The edited application command.

Tipo del valor devuelto

GuildApplicationCommandPermissions

await delete_guild_command(guild_id, command_id)¶

This function is a coroutine.

Deletes a guild application command.

Nuevo en la versión 2.1.

Parámetros

guild_id (int) – the ID of the guild where the command should be deleted.
command_id (int) – the ID of the 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.

Nuevo en la versión 2.1.

Parámetros

guild_id (int) – the ID of the guild where the commands should be overwritten.
application_commands (List[ApplicationCommand]) – a list of application commands to insert instead of the existing commands.

Devuelve

A list of registered application commands.

Tipo del valor devuelto

List[ApplicationCommand]

await bulk_fetch_command_permissions(guild_id)¶

This function is a coroutine.

Requests a list of GuildApplicationCommandPermissions configured for this guild.

Nuevo en la versión 2.1.

Parámetros: guild_id (int) – The ID of the guild to inspect.

await fetch_command_permissions(guild_id, command_id)¶

This function is a coroutine.

Requests GuildApplicationCommandPermissions for a specific command.

Nuevo en la versión 2.1.

Parámetros

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

Devuelve

The edited app command permissions.

Tipo del valor devuelto

await edit_command_permissions(guild_id, command_id, *, permissions=None, role_ids=None, user_ids=None)¶

Edits guild permissions of a single command.

Parámetros

guild_id (int) – The ID of the guild where the permissions should be applied.
command_id (int) – The ID of the app command you want to apply these permissions to.
permissions (Mapping[Union[Role, disnake.abc.User], bool]) – Roles or users to booleans. True means «allow», False means «deny».
role_ids (Mapping[int, bool]) – Role IDs to booleans.
user_ids (Mapping[int, bool]) – User IDs to booleans.

Devuelve

The object representing the edited app command permissions.

Tipo del valor devuelto

GuildApplicationCommandPermissions

await bulk_edit_command_permissions(guild_id, permissions)¶

This function is a coroutine.

Edits guild permissions of multiple application commands at once.

Nuevo en la versión 2.1.

Parámetros

guild_id (int) – The ID of the guild where the permissions should be applied.
permissions (List[PartialGuildApplicationCommandPermissions]) – A list of partial permissions for each app command you want to edit.

Devuelve

A list of edited permissions of application commands.

Tipo del valor devuelto

List[GuildApplicationCommandPermissions]

AutoShardedClient¶

Attributes

latencies
latency
shard_ids
shards

Methods

asyncchange_presence
asyncclose
asyncconnect
defget_shard
defis_ws_ratelimited

class disnake.AutoShardedClient(*args, loop=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: float¶

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: List[Tuple[int, float]]¶

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)¶: Optional[ShardInfo]: Gets the shard information at a given shard ID or None if not found.

property shards: Dict[int, disnake.shard.ShardInfo]¶

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

Type: Mapping[int, ShardInfo]

await connect(*, reconnect=True)¶

This function is a coroutine.

Parámetros

Muestra

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.

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)

Distinto en la versión 2.0: Removed the afk keyword-only parameter.

Parámetros

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.

Muestra

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

is_ws_ratelimited()¶

bool: 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().

Nuevo en la versión 1.6.

Application Info¶

AppInfo¶

Attributes

bot_public
bot_require_code_grant
cover_image
description
guild
guild_id
icon
id
name
owner
primary_sku_id
privacy_policy_url
rpc_origins
slug
summary
team
terms_of_service_url
verify_key

class disnake.AppInfo¶

Represents the application info for the bot provided by Discord.

id¶

The application ID.

Type: int

name¶

The application name.

Type: str

owner¶

The application owner.

Type: User

team¶

The application’s team.

Nuevo en la versión 1.3.

Type: Optional[Team]

description¶

The application 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]]

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.

Nuevo en la versión 1.3.

Type: str

verify_key¶

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

Nuevo en la versión 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.

Nuevo en la versión 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.

Nuevo en la versión 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.

Nuevo en la versión 1.3.

Type: Optional[str]

terms_of_service_url¶

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

Nuevo en la versión 2.0.

Type: Optional[str]

privacy_policy_url¶

The application’s privacy policy URL, if set.

Nuevo en la versión 2.0.

Type: Optional[str]

property icon: Optional[disnake.asset.Asset]¶

Retrieves the application’s icon asset, if any.

Type: Optional[Asset]

property cover_image: Optional[disnake.asset.Asset]¶

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: Optional[Guild]¶

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

Nuevo en la versión 1.3.

Type: Optional[Guild]

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()

Nuevo en la versión 2.0.

id¶

The application ID.

Type: int

name¶

The application name.

Type: str

description¶

The application description.

Type: str

rpc_origins¶

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

Type: Optional[List[str]]

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.

Type: 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: Optional[disnake.asset.Asset]¶

Retrieves the application’s icon asset, if any.

Type: Optional[Asset]

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

Nuevo en la versión 1.3.

Type: List[TeamMember]

property icon: Optional[disnake.asset.Asset]¶

Retrieves the team’s icon asset, if any.

Type: Optional[Asset]

property owner: Optional[disnake.team.TeamMember]¶

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.

Nuevo en la versión 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

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.

Advertencia

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.

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_shard_connect(shard_id)¶

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

Nuevo en la versión 1.4.

Parámetros: shard_id (int) – The shard ID that has connected.

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_shard_disconnect(shard_id)¶

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

Nuevo en la versión 1.4.

Parámetros: shard_id (int) – The shard ID that has disconnected.

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.

Advertencia

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_shard_ready(shard_id)¶

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

Parámetros: shard_id (int) – The shard ID that is ready.

disnake.on_resumed()¶: Called when the client has resumed a session.

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.

Nuevo en la versión 1.4.

Parámetros: shard_id (int) – The shard ID that has resumed.

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.

Nota

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().

Parámetros

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_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.

Nuevo en la versión 2.0.

Parámetros: 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.

Nota

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

Parámetros: 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.

Nota

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

Parámetros: 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.

disnake.on_typing(channel, user, when)¶

Called when someone begins typing a message.

The channel parameter can be a abc.Messageable instance. Which could either be TextChannel, GroupChannel, or DMChannel.

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

This requires Intents.typing to be enabled.

Parámetros

channel (abc.Messageable) – 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_message(message)¶

Called when a Message is created and sent.

This requires Intents.messages to be enabled.

Advertencia

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.

Parámetros: 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.

Parámetros: message (Message) – The deleted 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.

Parámetros: 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.

Parámetros: payload (RawMessageDeleteEvent) – 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.

Parámetros: payload (RawBulkMessageDeleteEvent) – The raw event payload data.

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.

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.

Parámetros

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

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.

Parámetros: payload (RawMessageUpdateEvent) – 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.

Nota

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

This requires Intents.reactions to be enabled.

Nota

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.

Parámetros

reaction (Reaction) – The current state of the reaction.
user (Union[Member, User]) – The user who added the reaction.

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.

Parámetros: payload (RawReactionActionEvent) – The raw event payload data.

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.

Nota

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

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

Nota

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

Parámetros

reaction (Reaction) – The current state of the reaction.
user (Union[Member, User]) – The user who added the reaction.

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.

Parámetros: payload (RawReactionActionEvent) – The raw event payload data.

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.

Parámetros

message (Message) – The message that had its reactions cleared.
reactions (List[Reaction]) – The reactions that were removed.

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.

Parámetros: payload (RawReactionClearEvent) – The raw event payload data.

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.

Nuevo en la versión 1.3.

Parámetros: reaction (Reaction) – The reaction that got cleared.

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.

Nuevo en la versión 1.3.

Parámetros: payload (RawReactionClearEmojiEvent) – The raw event payload data.

disnake.on_interaction(interaction)¶

Called when an interaction happened.

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

Advertencia

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

Nuevo en la versión 2.0.

Parámetros: interaction (Interaction) – The interaction object.

disnake.on_message_interaction(interaction)¶

Called when a message interaction happened.

This currently happens due to components being used.

Advertencia

This is a low level function that is not generally meant to be used. If you are working with components, consider using the callbacks associated with the View instead as it provides a nicer user experience.

Nuevo en la versión 2.0.

Parámetros: interaction (MessageInteraction) – The interaction object.

disnake.on_button_click(interaction)¶

Called when a button is clicked.

Advertencia

Consider using the callbacks associated with the View instead.

Nuevo en la versión 2.0.

Parámetros: interaction (MessageInteraction) – The interaction object.

disnake.on_dropdown(interaction)¶

Called when a select menu is clicked.

Advertencia

Consider using the callbacks associated with the View instead.

Nuevo en la versión 2.0.

Parámetros: interaction (MessageInteraction) – The interaction object.

disnake.on_application_command(interaction)¶

Called when an application_command is invoked.

Advertencia

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

Nuevo en la versión 2.0.

Parámetros: interaction (ApplicationCommandInteraction) – The interaction object.

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.

Parámetros

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.

Parámetros

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_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.

Parámetros: 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.

Parámetros

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.

Parámetros

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_thread_join(thread)¶

Called whenever a thread is joined or created. Note that from the API’s perspective there is no way to differentiate between a thread being created or the bot joining a thread.

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

This requires Intents.guilds to be enabled.

Nuevo en la versión 2.0.

Parámetros: thread (Thread) – The thread that got joined.

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.

Advertencia

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.

Nuevo en la versión 2.0.

Parámetros: thread (Thread) – The thread that got removed.

disnake.on_thread_delete(thread)¶

Called whenever a thread is deleted.

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

This requires Intents.guilds to be enabled.

Nuevo en la versión 2.0.

Parámetros: thread (Thread) – The thread that got deleted.

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.

This requires Intents.members to be enabled.

Nuevo en la versión 2.0.

Parámetros: member (ThreadMember) – The member who joined or left.

disnake.on_thread_update(before, after)¶

Called whenever a thread is updated.

This requires Intents.guilds to be enabled.

Nuevo en la versión 2.0.

Parámetros

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

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.

Nuevo en la versión 1.4.

Parámetros: 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.

Nuevo en la versión 2.0.

Parámetros: 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.

Nuevo en la versión 2.0.

Parámetros: integration (Integration) – The integration that was created.

disnake.on_raw_integration_delete(payload)¶

Called when an integration is deleted.

This requires Intents.integrations to be enabled.

Nuevo en la versión 2.0.

Parámetros: payload (RawIntegrationDeleteEvent) – 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.

Parámetros: channel (abc.GuildChannel) – The channel that had its webhooks updated.

disnake.on_member_join(member)¶

disnake.on_member_remove(member)¶

Called when a Member leaves or joins a Guild.

This requires Intents.members to be enabled.

Parámetros: member (Member) – The member who joined or left.

disnake.on_member_update(before, after)¶

Called when a Member updates their profile.

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

nickname
roles
pending

This requires Intents.members to be enabled.

Parámetros

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

disnake.on_member_screening_reject(member)¶

Called when a Member leaves a Guild without completing membership screening. This does not replace on_member_remove(); both will be called, given the approriate intents are enabled.

If the member is not found in the internal member cache, this event will not be called (hence the requirement for Intents.members). Consider using on_raw_member_screening_reject() instead.

This requires Intents.members to be enabled.

Nuevo en la versión 2.3.

Parámetros: member (Member) – The member that left.

disnake.on_raw_member_screening_reject(payload)¶

Called when a Member leaves a Guild without completing membership screening. Unlike on_member_screening_reject(), this is called regardless of the state of the internal member cache, and therefore does not require Intents.members to be enabled.

Nuevo en la versión 2.3.

Parámetros: payload (RawMemberScreeningRejectEvent) – The raw event payload data.

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.

Nuevo en la versión 2.0.

Parámetros

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 updates their profile.

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

avatar
username
discriminator

This requires Intents.members to be enabled.

Parámetros

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

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.

Parámetros: 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.

Parámetros: 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.

Parámetros

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

disnake.on_guild_role_create(role)¶

disnake.on_guild_role_delete(role)¶

Called when a Guild creates or deletes a new Role.

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

This requires Intents.guilds to be enabled.

Parámetros: 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.

Parámetros

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

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.

Parámetros

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.

disnake.on_guild_stickers_update(guild, before, after)¶

Called when a Guild updates its stickers.

This requires Intents.emojis_and_stickers to be enabled.

Nuevo en la versión 2.0.

Parámetros

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.

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.

Parámetros: guild – The Guild that has changed availability.

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.

Parámetros

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.

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.

Nuevo en la versión 2.0.

Parámetros: 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.

Nuevo en la versión 2.0.

Parámetros

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

disnake.on_member_ban(guild, user)¶

Called when user gets banned from a Guild.

This requires Intents.bans to be enabled.

Parámetros

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 if the user was in the guild or not at the time of removal.

disnake.on_member_unban(guild, user)¶

Called when a User gets unbanned from a Guild.

This requires Intents.bans to be enabled.

Parámetros

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

disnake.on_invite_create(invite)¶

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

Nuevo en la versión 1.3.

Nota

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.

Parámetros: 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.

Nuevo en la versión 1.3.

Nota

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.

Parámetros: invite (Invite) – The invite that was deleted.

disnake.on_group_join(channel, user)¶

disnake.on_group_remove(channel, user)¶

Called when someone joins or leaves a GroupChannel.

Parámetros

channel (GroupChannel) – The group that the user joined or left.
user (User) – The user that joined or left.

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.

Parámetros

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.

Ejemplos

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')

Parámetros

iterable – An iterable to search through.
**attrs – Keyword arguments that denote attributes to search with.

disnake.utils.snowflake_time(id)¶

Parámetros: id (int) – The snowflake ID.
Devuelve: An aware datetime in UTC representing the creation time of the snowflake.
Tipo del valor devuelto: 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.

Parámetros

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',).

Nuevo en la versión 1.7.
disable_guild_select (bool) –
Whether to disallow the user from changing the guild dropdown.

Nuevo en la versión 2.0.

Devuelve

The OAuth2 URL for inviting the bot into guilds.

Tipo del valor devuelto

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

A helper function that removes markdown characters.

Nuevo en la versión 1.7.

Nota

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.

Parámetros

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.

Devuelve

The text with the markdown special characters removed.

Tipo del valor devuelto

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

A helper function that escapes Discord’s markdown.

Parámetros

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.

Devuelve

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

Tipo del valor devuelto

disnake.utils.escape_mentions(text)¶

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

Nota

This does not include channel mentions.

Nota

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

Parámetros: text (str) – The text to escape mentions from.
Devuelve: The text with the mentions removed.
Tipo del valor devuelto: str

disnake.utils.resolve_invite(invite)¶

Resolves an invite from a Invite, URL or code.

Parámetros: invite (Union[Invite, str]) – The invite.
Devuelve: The invite code.
Tipo del valor devuelto: str

disnake.utils.resolve_template(code)¶

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

Nuevo en la versión 1.4.

Parámetros: code (Union[Template, str]) – The code.
Devuelve: The template code.
Tipo del valor devuelto: 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.

Nuevo en la versión 1.3.

Parámetros

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.

Nuevo en la versión 2.0.

Devuelve: The current aware datetime in UTC.
Tipo del valor devuelto: 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.

Nuevo en la versión 2.0.

Parámetros

dt (Union[datetime.datetime, int, float]) – The datetime to format.
style (str) – The style to format the datetime with. Defaults to f

Devuelve

The formatted string.

Tipo del valor devuelto

disnake.utils.as_chunks(iterator, max_size)¶

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

Nuevo en la versión 2.0.

Parámetros

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

Advertencia

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

Devuelve: A new iterator which yields chunks of a given size.
Tipo del valor devuelto: Union[Iterator, AsyncIterator]

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.

store¶: A guild store channel.

stage_voice¶: A guild stage voice channel.

Nuevo en la versión 1.7.

news_thread¶: A news thread.

Nuevo en la versión 2.0.

public_thread¶: A public thread.

Nuevo en la versión 2.0.

private_thread¶: A private thread.

Nuevo en la versión 2.0.

guild_directory¶: A student hub channel.

Nuevo en la versión 2.1.

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.

Nuevo en la versión 1.3.

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

Nuevo en la versión 1.7.

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

Nuevo en la versión 1.7.

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

Nuevo en la versión 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.

Nuevo en la versión 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.

Nuevo en la versión 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.

Nuevo en la versión 2.0.

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

Nuevo en la versión 2.0.

application_command¶: The system message denoting that an application (or «slash») command was executed.

Nuevo en la versión 2.0.

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

Nuevo en la versión 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.

Nuevo en la versión 2.0.

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.

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.

Nuevo en la versión 1.5.

class disnake.ApplicationCommandType¶

Represents the type of an application command.

Nuevo en la versión 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.InteractionType¶

Specifies the type of Interaction.

Nuevo en la versión 2.0.

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

application_command¶: Represents a slash command interaction.

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

class disnake.InteractionResponseType¶

Specifies the response type for the interaction.

Nuevo en la versión 2.0.

pong¶

Pongs the interaction when given a ping.

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)

Parámetros: predicate – The predicate to use. Could be a coroutine.
Devuelve: 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.

Devuelve: A list of every element in the async iterator.
Tipo del valor devuelto: 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.

Nuevo en la versión 1.6.

Collecting groups of users:

async for leader, *users in reaction.users().chunk(3):
    ...

Advertencia

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

Parámetros: max_size – The size of individual chunks.
Tipo del valor devuelto: 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)

Parámetros: func – The function to call on every element. Could be a coroutine.
Tipo del valor devuelto: 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):
    ...

Parámetros: predicate – The predicate to call on every element. Could be a coroutine.
Tipo del valor devuelto: AsyncIterator

Audit Log Data¶

Working with Guild.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(*, users, data, guild)¶

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.

Distinto en la versión 1.7: Audit log entries are now comparable and hashable.

action¶

The action that was done.

Type: AuditLogAction

user¶

The user who initiated this action. Usually a Member, unless gone then it’s a User.

Type: abc.User

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

reason¶

The reason this action was done.

Type: Optional[str]

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

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¶

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 icon. See also Guild.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]

region¶

The guild’s voice region. See also Guild.region.

Type: VoiceRegion

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[TextChannel, Object]

verification_level¶

The guild’s verification level.

Webhook Support¶

disnake offers support for creating, editing, and executing webhooks through the Webhook class.

Webhook¶

Attributes

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() and TextChannel.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.

Distinto en la versión 1.4: Webhooks are now comparable and hashable.

id¶

The webhook’s ID

Type: int

type¶

The type of the webhook.

Nuevo en la versión 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 is for.

Type: Optional[int]

channel_id¶

The channel ID this webhook is for.

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.

Nuevo en la versión 2.0.

Type: Optional[PartialWebhookGuild]

source_channel¶

The channel that this webhook is following. Only given if type is WebhookType.channel_follower.

Nuevo en la versión 2.0.

Type: Optional[PartialWebhookChannel]

property url: str¶

Returns the webhook’s url.

Type: str

classmethod partial(id, token, *, session, bot_token=None)¶

Creates a partial Webhook.

Parámetros

id (int) – The ID of the webhook.
token (str) – The authentication token of the webhook.
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.

Nuevo en la versión 2.0.
bot_token (Optional[str]) –
The bot authentication token for authenticated requests involving the webhook.

Nuevo en la versión 2.0.

Devuelve

A partial Webhook. A partial webhook is just a webhook object with an ID and a token.

Tipo del valor devuelto

classmethod from_url(url, *, session, bot_token=None)¶

Creates a partial Webhook from a webhook URL.

Parámetros

url (str) – The URL of the webhook.
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.

Nuevo en la versión 2.0.
bot_token (Optional[str]) –
The bot authentication token for authenticated requests involving the webhook.

Nuevo en la versión 2.0.

Muestra

InvalidArgument – The URL is invalid.

Devuelve

A partial Webhook. A partial webhook is just a webhook object with an ID and a token.

Tipo del valor devuelto

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.

Nuevo en la versión 2.0.

Nota

When fetching with an unauthenticated webhook, i.e. is_authenticated() returns False, then the returned webhook does not contain any user information.

Parámetros

prefer_auth (bool) – Whether to use the bot token over the webhook token if available. Defaults to True.

Muestra

HTTPException – Could not fetch the webhook
NotFound – Could not find the webhook by this ID
InvalidArgument – This webhook does not have a token associated with it.

Devuelve

The fetched webhook.

Tipo del valor devuelto

await delete(*, reason=None, prefer_auth=True)¶

This function is a coroutine.

Deletes this Webhook.

Parámetros

reason (Optional[str]) –
The reason for deleting this webhook. Shows up on the audit log.

Nuevo en la versión 1.4.
prefer_auth (bool) –
Whether to use the bot token over the webhook token if available. Defaults to True.

Nuevo en la versión 2.0.

Muestra

HTTPException – Deleting the webhook failed.
NotFound – This webhook does not exist.
Forbidden – You do not have permissions to delete this webhook.
InvalidArgument – 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.

Parámetros

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.

Nuevo en la versión 2.0.
reason (Optional[str]) –
The reason for editing this webhook. Shows up on the audit log.

Nuevo en la versión 1.4.
prefer_auth (bool) –
Whether to use the bot token over the webhook token if available. Defaults to True.

Nuevo en la versión 2.0.

Muestra

HTTPException – Editing the webhook failed.
NotFound – This webhook does not exist.
InvalidArgument – This webhook does not have a token associated with it or it tried editing a channel without authentication.

property avatar: disnake.asset.Asset¶

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: Optional[TextChannel]¶

The text channel this webhook belongs to.

If this is a partial webhook, then this will always return None.

Type: Optional[TextChannel]

property created_at: datetime.datetime¶

Returns the webhook’s creation time in UTC.

Type: datetime.datetime

property guild: Optional[Guild]¶

The guild this webhook belongs to.

If this is a partial webhook, then this will always return None.

Type: Optional[Guild]

is_authenticated()¶: bool: Whether the webhook is authenticated with a bot token.

Nuevo en la versión 2.0.

is_partial()¶: bool: Whether the webhook is a «partial» webhook.

Nuevo en la versión 2.0.

await send(content=..., *, username=..., avatar_url=..., tts=False, ephemeral=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., view=..., thread=..., 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.

Parámetros

content (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) – Indicates if the message should be sent using text-to-speech.
ephemeral (bool) –
Indicates if 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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 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.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
thread (Snowflake) –
The thread to send this webhook to.

Nuevo en la versión 2.0.
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.

Nuevo en la versión 2.1.

Muestra

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.
ValueError – The length of embeds was invalid.
InvalidArgument – There was no token associated with this webhook or ephemeral was passed with the improper webhook type or there was no state attached with this webhook when giving it a view.

Devuelve

If wait is True then the message that was sent, otherwise None.

Tipo del valor devuelto

Optional[WebhookMessage]

await fetch_message(id)¶

This function is a coroutine.

Retrieves a single WebhookMessage owned by this webhook.

Nuevo en la versión 2.0.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.
InvalidArgument – There was no token associated with this webhook.

Devuelve

The message asked for.

Tipo del valor devuelto

WebhookMessage

await edit_message(message_id, *, content=..., embed=..., embeds=..., file=..., files=..., attachments=..., view=..., 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.

Nuevo en la versión 1.6.

Distinto en la versión 2.0: The edit is no longer in-place, instead the newly edited message is returned.

Nota

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).

Parámetros

message_id (int) – The message ID 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 files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
attachments (List[Attachment]) –
A list of attachments to keep in the message. If [] is passed then all existing attachments are removed. Keeps existing attachments if not provided.

Nuevo en la versión 2.1.
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().

Nuevo en la versión 2.0.
allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Muestra

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
InvalidArgument – There was no token associated with this webhook or the webhook had no state.

Devuelve

The newly edited webhook message.

Tipo del valor devuelto

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.

Nuevo en la versión 1.6.

Parámetros

message_id (int) – The message ID to delete.

Muestra

HTTPException – Deleting the message failed.
Forbidden – Deleted a message that is not yours.

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.

Nuevo en la versión 1.6.

await edit(content=..., embed=..., embeds=..., file=..., files=..., attachments=..., view=..., allowed_mentions=None)¶

This function is a coroutine.

Edits the message.

Nuevo en la versión 1.6.

Distinto en la versión 2.0: The edit is no longer in-place, instead the newly edited message is returned.

Nota

Parámetros

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 files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
attachments (List[Attachment]) –
A list of attachments to keep in the message. If [] is passed then all existing attachments are removed. Keeps existing attachments if not provided.

Nuevo en la versión 2.1.
view (Optional[View]) –
The updated view to update this message with. If None is passed then the view is removed.

Nuevo en la versión 2.0.
allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Muestra

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
InvalidArgument – There was no token associated with this webhook.

Devuelve

The newly edited message.

Tipo del valor devuelto

WebhookMessage

await delete(*, delay=None)¶

This function is a coroutine.

Deletes the message.

Parámetros

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.

Muestra

Forbidden – You do not have proper permissions to delete the message.
NotFound – The message was deleted already.
HTTPException – Deleting the message failed.

SyncWebhook¶

Attributes

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.

Distinto en la versión 1.4: Webhooks are now comparable and hashable.

id¶

The webhook’s ID

Type: int

type¶

The type of the webhook.

Nuevo en la versión 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 is for.

Type: Optional[int]

channel_id¶

The channel ID this webhook is for.

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.

Nuevo en la versión 2.0.

Type: Optional[PartialWebhookGuild]

source_channel¶

The channel that this webhook is following. Only given if type is WebhookType.channel_follower.

Nuevo en la versión 2.0.

Type: Optional[PartialWebhookChannel]

property url: str¶

Returns the webhook’s url.

Type: str

classmethod partial(id, token, *, session=..., bot_token=None)¶

Creates a partial Webhook.

Parámetros

id (int) – The ID of the webhook.
token (str) – The authentication token of the webhook.
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.

Devuelve

A partial Webhook. A partial webhook is just a webhook object with an ID and a token.

Tipo del valor devuelto

classmethod from_url(url, *, session=..., bot_token=None)¶

Creates a partial Webhook from a webhook URL.

Parámetros

url (str) – The URL of the webhook.
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.

Muestra

InvalidArgument – The URL is invalid.

Devuelve

A partial Webhook. A partial webhook is just a webhook object with an ID and a token.

Tipo del valor devuelto

fetch(*, prefer_auth=True)¶

Fetches the current webhook.

This could be used to get a full webhook from a partial webhook.

Nota

When fetching with an unauthenticated webhook, i.e. is_authenticated() returns False, then the returned webhook does not contain any user information.

Parámetros

prefer_auth (bool) – Whether to use the bot token over the webhook token if available. Defaults to True.

Muestra

HTTPException – Could not fetch the webhook
NotFound – Could not find the webhook by this ID
InvalidArgument – This webhook does not have a token associated with it.

Devuelve

The fetched webhook.

Tipo del valor devuelto

SyncWebhook

delete(*, reason=None, prefer_auth=True)¶

Deletes this Webhook.

Parámetros

reason (Optional[str]) –
The reason for deleting this webhook. Shows up on the audit log.

Nuevo en la versión 1.4.
prefer_auth (bool) – Whether to use the bot token over the webhook token if available. Defaults to True.

Muestra

HTTPException – Deleting the webhook failed.
NotFound – This webhook does not exist.
Forbidden – You do not have permissions to delete this webhook.
InvalidArgument – This webhook does not have a token associated with it.

edit(*, reason=None, name=..., avatar=..., channel=None, prefer_auth=True)¶

Edits this Webhook.

Parámetros

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.
reason (Optional[str]) –
The reason for editing this webhook. Shows up on the audit log.

Nuevo en la versión 1.4.
prefer_auth (bool) – Whether to use the bot token over the webhook token if available. Defaults to True.

Muestra

HTTPException – Editing the webhook failed.
NotFound – This webhook does not exist.
InvalidArgument – This webhook does not have a token associated with it or it tried editing a channel without authentication.

Devuelve

The newly edited webhook.

Tipo del valor devuelto

SyncWebhook

send(content=..., *, username=..., avatar_url=..., tts=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., thread=..., 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.

Parámetros

content (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) – Indicates if the message should be sent using text-to-speech.
file (File) – The file to upload. This cannot be mixed with 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 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.

Nuevo en la versión 1.4.
thread (Snowflake) –
The thread to send this message to.

Nuevo en la versión 2.0.
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.

Muestra

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
ValueError – The length of embeds was invalid
InvalidArgument – There was no token associated with this webhook.

Devuelve

If wait is True then the message that was sent, otherwise None.

Tipo del valor devuelto

Optional[SyncWebhookMessage]

fetch_message(id, /)¶

Retrieves a single SyncWebhookMessage owned by this webhook.

Nuevo en la versión 2.0.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.
InvalidArgument – There was no token associated with this webhook.

Devuelve

The message asked for.

Tipo del valor devuelto

SyncWebhookMessage

property avatar: disnake.asset.Asset¶

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: Optional[TextChannel]¶

The text channel this webhook belongs to.

If this is a partial webhook, then this will always return None.

Type: Optional[TextChannel]

property created_at: datetime.datetime¶

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.

Nuevo en la versión 1.6.

Nota

Parámetros

message_id (int) – The message ID 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 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 (List[Attachment]) –
A list of attachments to keep in the message. If [] is passed then all existing attachments are removed. Keeps existing attachments if not provided.

Nuevo en la versión 2.1.
allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Muestra

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
InvalidArgument – There was no token associated with this webhook.

property guild: Optional[Guild]¶

The guild this webhook belongs to.

If this is a partial webhook, then this will always return None.

Type: Optional[Guild]

is_authenticated()¶: bool: Whether the webhook is authenticated with a bot token.

Nuevo en la versión 2.0.

is_partial()¶: bool: Whether the webhook is a «partial» webhook.

Nuevo en la versión 2.0.

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.

Nuevo en la versión 1.6.

Parámetros

message_id (int) – The message ID to delete.

Muestra

HTTPException – Deleting the message failed.
Forbidden – Deleted a message that is not yours.

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.

Nuevo en la versión 2.0.

edit(content=..., embed=..., embeds=..., file=..., files=..., attachments=..., allowed_mentions=None)¶

Edits the message.

Nota

Parámetros

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 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 (List[Attachment]) –
A list of attachments to keep in the message. If [] is passed then all existing attachments are removed. Keeps existing attachments if not provided.

Nuevo en la versión 2.1.
allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Muestra

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
InvalidArgument – There was no token associated with this webhook.

Devuelve

The newly edited message.

Tipo del valor devuelto

SyncWebhookMessage

delete(*, delay=None)¶

Deletes the message.

Parámetros

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message. This blocks the thread.

Muestra

Forbidden – You do not have proper permissions to delete the message.
NotFound – The message was deleted already.
HTTPException – Deleting the message failed.

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

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 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¶

If the user is a bot account.

Type: bool

property display_name: str¶

Returns the user’s display name.

Type: str

property mention: str¶

Returns a string that allows you to mention the given user.

Type: str

PrivateChannel¶

Attributes

class disnake.abc.PrivateChannel¶

An ABC that details the common operations on a private Discord channel.

The following implement this ABC:

DMChannel
GroupChannel

This ABC must also implement Snowflake.

me¶

The user presenting yourself.

Type: ClientUser

GuildChannel¶

Attributes

category
changed_roles
created_at
guild
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 implement this ABC:

TextChannel
VoiceChannel
CategoryChannel
StageChannel

This ABC must also implement 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: List[disnake.role.Role]¶

Returns a list of roles that have been overridden from their default values in the roles attribute.

Type: List[Role]

property mention: str¶

The string that allows you to mention the channel.

Type: str

property created_at: datetime¶

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.

Parámetros: obj (Union[Role, User]) – The role or user denoting whose overwrite to get.
Devuelve: The permission overwrites for this object.
Tipo del valor devuelto: PermissionOverwrite

property overwrites: Dict[Union[Role, Member], PermissionOverwrite]¶

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.

Devuelve: The channel’s permission overwrites.
Tipo del valor devuelto: Dict[Union[Role, Member], PermissionOverwrite]

property category: Optional[CategoryChannel]¶

The category this channel belongs to.

If there is no category then this is None.

Type: Optional[CategoryChannel]

property permissions_synced: bool¶

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.

Nuevo en la versión 1.3.

Type: bool

permissions_for(obj, /)¶

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

Guild owner
Guild roles
Channel overrides
Member overrides

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

Distinto en la versión 2.0: The object passed in can now be a role object.

Parámetros: 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.
Devuelve: The resolved permissions for the member or role.
Tipo del valor devuelto: Permissions

await delete(*, reason=None)¶

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parámetros

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Muestra

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=see - below, 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 the manage_roles permission to use this.

Nota

This method replaces the old overwrites with the ones given.

Ejemplos

Setting allow and deny:

await message.channel.set_permissions(message.author, read_messages=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parámetros

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.

Muestra

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.
InvalidArgument – The overwrite parameter invalid or the target type was not Role or Member.

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 the manage_channels permission to do this.

Nuevo en la versión 1.1.

Parámetros

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.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.

Devuelve

The channel that was created.

Tipo del valor devuelto

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 the manage_channels permission to do this.

Nota

Voice channels will always be sorted below text channels. This is a Discord limitation.

Nuevo en la versión 1.7.

Parámetros

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 (Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.
after (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[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 (str) – The reason for the move.

Muestra

InvalidArgument – An invalid position was given or a bad mix of arguments were passed.
Forbidden – You do not have permissions to move the channel.
HTTPException – Moving the channel failed.

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application=None)¶

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have the create_instant_invite permission to do this.

Parámetros

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) – Denotes that the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.
unique (bool) – Indicates if a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.
reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.
target_type (Optional[InviteTarget]) –
The type of target for the voice channel invite, if any.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
target_application (Optional[PartyType]) –
The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

Nuevo en la versión 2.0.

Muestra

HTTPException – Invite creation failed.
NotFound – The channel that was passed is a category or an invalid channel.

Devuelve

The invite that was created.

Tipo del valor devuelto

await invites()¶

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have manage_channels to get this information.

Muestra

Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.

Devuelve

The list of invites that are currently active.

Tipo del valor devuelto

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 implement this ABC:

TextChannel
DMChannel
GroupChannel
User
Member
Context
Thread

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 read_message_history permissions to use this.

Ejemplos

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.

Parámetros

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[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[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[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.

Muestra

Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.

Campos

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.

Nota

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=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=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). If the content is set to None (the default), then the embed parameter 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.

Parámetros

content (Optional[str]) – The content of the message to send.
tts (bool) – Indicates if the message should be sent using text-to-speech.
embed (Embed) – The rich embed for the content to send. This cannot be mixed with 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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.

Nuevo en la versión 2.0.
nonce (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.

Nuevo en la versión 1.4.
reference (Union[Message, MessageReference, PartialMessage]) –
A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

Nuevo en la versión 1.6.
mention_author (Optional[bool]) –
If set, overrides the replied_user attribute of allowed_mentions.

Nuevo en la versión 1.6.
view (disnake.ui.View) – A Discord UI View to add to the message.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size, you specified both file and files, or you specified both embed and embeds, or the reference object is not a Message, MessageReference or PartialMessage.

Devuelve

The message that was sent.

Tipo del valor devuelto

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.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The message asked for.

Tipo del valor devuelto

await pins()¶

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Nota

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Muestra: HTTPException – Retrieving the pinned messages failed.
Devuelve: The messages that are currently pinned.
Tipo del valor devuelto: 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 implement this ABC:

VoiceChannel
StageChannel

Nota

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.

Peligro

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.

Nota

Nearly all classes here have __slots__ defined which means that it is impossible to have dynamic attributes to the data classes.

ClientUser¶

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).

Nuevo en la versión 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.

Type: Optional[str]

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.

Nota

To upload an avatar, a bytes-like object must be passed in that represents the image being uploaded. If this is done through a file then the file must be opened via open('some_filename', 'rb') and the bytes-like object is given through the use of fp.read().

The only image formats supported for uploading is JPEG and PNG.

Distinto en la versión 2.0: The edit is no longer in-place, instead the newly edited client user is returned.

Parámetros

username (str) – The new username you wish to change to.
avatar (bytes) – A bytes-like object representing the image to upload. Could be None to denote no avatar.

Muestra

HTTPException – Editing your profile failed.
InvalidArgument – Wrong image format passed for avatar.

Devuelve

The newly edited client user.

Tipo del valor devuelto

ClientUser

property accent_color: Optional[disnake.colour.Colour]¶

Returns the user’s accent color, if applicable.

There is an alias for this named accent_colour.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Colour]

property accent_colour: Optional[disnake.colour.Colour]¶

Returns the user’s accent colour, if applicable.

There is an alias for this named accent_color.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Colour]

property avatar: Optional[disnake.asset.Asset]¶

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: Optional[disnake.asset.Asset]¶

Returns the user’s banner asset, if available.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Asset]

property color: disnake.colour.Colour¶

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: disnake.colour.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: datetime¶

Returns the user’s creation time in UTC.

This is when the user’s Discord account was created.

Type: datetime.datetime

property default_avatar: disnake.asset.Asset¶

Returns the default avatar for a given user. This is calculated by the user’s discriminator.

Type: Asset

property display_avatar: disnake.asset.Asset¶

Returns the user’s display avatar.

For regular users this is just their default avatar or uploaded avatar.

Nuevo en la versión 2.0.

Type: Asset

property display_name: str¶

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: str¶

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.

Parámetros: message (Message) – The message to check if you’re mentioned in.
Devuelve: Indicates if the user is mentioned in the message.
Tipo del valor devuelto: bool

property public_flags: disnake.flags.PublicUserFlags¶

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 read_message_history permissions to use this.

Ejemplos

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.

Parámetros

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[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[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[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.

Muestra

Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.

Campos

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.

Nota

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: Optional[DMChannel]¶

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: List[Guild]¶

The guilds that the user shares with the client.

Nota

This will only return mutual guilds within the client’s internal cache.

Nuevo en la versión 1.7.

Type: List[Guild]

property accent_color: Optional[disnake.colour.Colour]¶

Returns the user’s accent color, if applicable.

There is an alias for this named accent_colour.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Colour]

property accent_colour: Optional[disnake.colour.Colour]¶

Returns the user’s accent colour, if applicable.

There is an alias for this named accent_color.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Colour]

property avatar: Optional[disnake.asset.Asset]¶

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: Optional[disnake.asset.Asset]¶

Returns the user’s banner asset, if available.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Asset]

property color: disnake.colour.Colour¶

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: disnake.colour.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.

Devuelve: The channel that was created.
Tipo del valor devuelto: DMChannel

property created_at: datetime¶

Returns the user’s creation time in UTC.

This is when the user’s Discord account was created.

Type: datetime.datetime

property default_avatar: disnake.asset.Asset¶

Returns the default avatar for a given user. This is calculated by the user’s discriminator.

Type: Asset

property display_avatar: disnake.asset.Asset¶

Returns the user’s display avatar.

For regular users this is just their default avatar or uploaded avatar.

Nuevo en la versión 2.0.

Type: Asset

property display_name: str¶

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.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The message asked for.

Tipo del valor devuelto

property mention: str¶

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.

Parámetros: message (Message) – The message to check if you’re mentioned in.
Devuelve: Indicates if the user is mentioned in the message.
Tipo del valor devuelto: bool

await pins()¶

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Nota

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Muestra: HTTPException – Retrieving the pinned messages failed.
Devuelve: The messages that are currently pinned.
Tipo del valor devuelto: List[Message]

property public_flags: disnake.flags.PublicUserFlags¶

The publicly available flags the user has.

Type: PublicUserFlags

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). If the content is set to None (the default), then the embed parameter must be provided.

Parámetros

content (Optional[str]) – The content of the message to send.
tts (bool) – Indicates if the message should be sent using text-to-speech.
embed (Embed) – The rich embed for the content to send. This cannot be mixed with 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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.

Nuevo en la versión 2.0.
nonce (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.

Nuevo en la versión 1.4.
reference (Union[Message, MessageReference, PartialMessage]) –
A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

Nuevo en la versión 1.6.
mention_author (Optional[bool]) –
If set, overrides the replied_user attribute of allowed_mentions.

Nuevo en la versión 1.6.
view (disnake.ui.View) – A Discord UI View to add to the message.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size, you specified both file and files, or you specified both embed and embeds, or the reference object is not a Message, MessageReference or PartialMessage.

Devuelve

The message that was sent.

Tipo del valor devuelto

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.

Distinto en la versión 1.7: Attachment can now be casted to str and is hashable.

id¶

The attachment ID.

Type: int

size¶

The attachment 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

Nuevo en la versión 1.7.

Type: Optional[str]

ephemeral¶

Whether the attachment is ephemeral.

Nuevo en la versión 2.1.

Type: bool

description¶

The attachment’s description

Nuevo en la versión 2.3.

Type: str

is_spoiler()¶: bool: Whether this attachment contains a spoiler.

await save(fp, *, seek_begin=True, use_cached=False)¶

This function is a coroutine.

Saves this attachment into a file-like object.

Parámetros

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.

Muestra

HTTPException – Saving the attachment failed.
NotFound – The attachment was deleted.

Devuelve

The number of bytes written.

Tipo del valor devuelto

await read(*, use_cached=False)¶

This function is a coroutine.

Retrieves the content of this attachment as a bytes object.

Nuevo en la versión 1.1.

Parámetros

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.

Muestra

HTTPException – Downloading the attachment failed.
Forbidden – You do not have permissions to access this attachment
NotFound – The attachment was deleted.

Devuelve

The contents of the attachment.

Tipo del valor devuelto

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().

Nuevo en la versión 1.3.

Parámetros

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.

Nuevo en la versión 1.4.
spoiler (bool) –
Whether the file is a spoiler.

Nuevo en la versión 1.4.
description (Optional[str]) –
The file’s description. Copies this attachment’s description by default, set to None to remove.

Nuevo en la versión 2.3.

Muestra

HTTPException – Downloading the attachment failed.
Forbidden – You do not have permissions to access this attachment
NotFound – The attachment was deleted.

Devuelve

The attachment as a file suitable for sending.

Tipo del valor devuelto

File

Asset¶

Attributes

Methods

defis_animated
asyncread
defreplace
asyncsave
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: str¶

Returns the underlying URL of the asset.

Type: str

property key: str¶

Returns the identifying key of the asset.

Type: str

is_animated()¶: bool: Returns whether the asset is animated.

replace(*, size=..., format=..., static_format=...)¶

Returns a new asset with the passed components replaced.

Parámetros

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”.

Muestra

InvalidArgument – An invalid size or format was passed.

Devuelve

The newly updated asset.

Tipo del valor devuelto

Asset

with_size(size, /)¶

Returns a new asset with the specified size.

Parámetros: size (int) – The new size of the asset.
Muestra: InvalidArgument – The asset had an invalid size.
Devuelve: The new updated asset.
Tipo del valor devuelto: Asset

with_format(format, /)¶

Returns a new asset with the specified format.

Parámetros: format (str) – The new format of the asset.
Muestra: InvalidArgument – The asset had an invalid format.
Devuelve: The new updated asset.
Tipo del valor devuelto: 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.

Parámetros: format (str) – The new static format of the asset.
Muestra: InvalidArgument – The asset had an invalid format.
Devuelve: The new updated asset.
Tipo del valor devuelto: Asset

await read()¶

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Muestra

DiscordException – There was no internal connection state.
HTTPException – Downloading the asset failed.
NotFound – The asset was deleted.

Devuelve

The content of the asset.

Tipo del valor devuelto

await save(fp, *, seek_begin=True)¶

This function is a coroutine.

Saves this asset into a file-like object.

Parámetros

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.

Muestra

DiscordException – There was no internal connection state.
HTTPException – Downloading the asset failed.
NotFound – The asset was deleted.

Devuelve

The number of bytes written.

Tipo del valor devuelto

Message¶

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 disnake 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 disnake 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 TextChannel or Thread that the message was sent from. Could be a DMChannel or GroupChannel if it’s a private message.

Type: Union[TextChannel, Thread, DMChannel, GroupChannel, PartialMessageable]

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.

Nuevo en la versión 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.

Nuevo en la versión 2.1.

Type: Optional[InteractionReference]

mention_everyone¶

Specifies if the message mentions everyone.

Nota

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.

Advertencia

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]

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]

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¶

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.

Nuevo en la versión 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.

Nuevo en la versión 1.6.

Type: List[StickerItem]

components¶

A list of components in the message.

Nuevo en la versión 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]

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.

Nota

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: datetime.datetime¶

The message’s creation time in UTC.

Type: datetime.datetime

property edited_at: Optional[datetime.datetime]¶

An aware UTC datetime object containing the edited time of the message.

Type: Optional[datetime.datetime]

property jump_url: str¶

Returns a URL that allows the client to jump to this message.

Type: str

is_system()¶

bool: 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.

Nuevo en la versión 1.3.

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.

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.

Distinto en la versión 1.1: Added the new delay keyword-only parameter.

Parámetros

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.

Muestra

Forbidden – You do not have proper permissions to delete the message.
NotFound – The message was deleted already
HTTPException – Deleting the message failed.

await edit(**fields)¶

This function is a coroutine.

Edits the message.

The content must be able to be transformed into a string via str(content).

Distinto en la versión 1.3: The suppress keyword-only parameter was added.

Nota

Parámetros

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.

Nuevo en la versión 2.0.
file (File) –
The file to upload. This cannot be mixed with files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

Nuevo en la versión 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.

Nuevo en la versión 2.1.
attachments (List[Attachment]) – A list of attachments to keep in the message. If [] is passed then all existing attachments are removed. Keeps existing attachments if not provided.
suppress (bool) – Whether to suppress embeds for the message. This removes all the embeds if set to True. If set to False this brings the embeds back if they were suppressed. Using this parameter requires manage_messages.
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.

Nuevo en la versión 1.4.
view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.

Muestra

HTTPException – Editing the message failed.
Forbidden – Tried to suppress a message without permissions or edited a message’s content or embed that isn’t yours.
InvalidArgument – You specified both embed and embeds or file and files.

Devuelve

The message that was edited.

Tipo del valor devuelto

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.

Muestra

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.

Parámetros

reason (Optional[str]) –

The reason for pinning the message. Shows up on the audit log.

Nuevo en la versión 1.4.

Muestra

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.

Parámetros

reason (Optional[str]) –

The reason for unpinning the message. Shows up on the audit log.

Nuevo en la versión 1.4.

Muestra

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.

Add 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.

Parámetros

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to react with.

Muestra

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.
InvalidArgument – The emoji parameter is invalid.

await remove_reaction(emoji, member)¶

This function is a coroutine.

Remove 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.

Parámetros

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to remove.
member (abc.Snowflake) – The member for which to remove the reaction.

Muestra

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.
InvalidArgument – 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.

Nuevo en la versión 1.3.

Parámetros

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to clear.

Muestra

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.
InvalidArgument – 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.

Muestra

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=...)¶

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.

Nuevo en la versión 2.0.

Parámetros

name (str) – The name of the thread.
auto_archive_duration (int) – The duration in minutes before a thread is automatically archived for inactivity. If not provided, the channel’s default auto archive duration is used.

Muestra

Forbidden – You do not have permissions to create a thread.
HTTPException – Creating the thread failed.
InvalidArgument – This message does not have guild info attached.

Devuelve

The created thread.

Tipo del valor devuelto

Thread

await reply(content=None, **kwargs)¶

This function is a coroutine.

A shortcut method to abc.Messageable.send() to reply to the Message.

Nuevo en la versión 1.6.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size or you specified both file and files.

Devuelve

The message that was sent.

Tipo del valor devuelto

PartialGuildApplicationCommandPermissions

to_reference(*, fail_if_not_exists=True)¶

Creates a MessageReference from the current message.

Nuevo en la versión 1.6.

Parámetros

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.

Nuevo en la versión 1.7.

Devuelve

The reference to this message.

Tipo del valor devuelto

MessageReference

ApplicationCommand¶

class disnake.ApplicationCommand¶: The base class for application commands

SlashCommand¶

Methods

defadd_option

class disnake.SlashCommand¶

The base class for building slash commands.

Parámetros

name (str) – The command name
description (str) – The command description (it’ll be displayed by disnake)
options (List[Option]) – The options of the command
default_permission (bool) – Whether the command is enabled by default when the app is added to a guild

add_option(name, description=None, type=None, required=False, choices=None, options=None, channel_types=None, autocomplete=False, min_value=None, max_value=None)¶: Adds an option to the current list of options Parameters are the same as for Option

UserCommand¶

class disnake.UserCommand¶

MessageCommand¶

class disnake.MessageCommand¶

Option¶

Methods

defadd_choice
defadd_option

class disnake.Option¶

Represents a slash command option.

Parámetros

name (str) – option’s name
description (str) – option’s description
type (OptionType) – the option type, e.g. OptionType.user
required (bool) – whether this option is required or not
choices (Union[List[OptionChoice], 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

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)¶: Adds an option to the current list of options Parameters are the same as for Option

OptionChoice¶

class disnake.OptionChoice¶

Represents an option choice.

Parámetros

name (str) – the name of the option choice (visible to users)
value (Union[str, int]) – the value of the option choice

ApplicationCommandPermissions¶

Attributes

id
permission
type

class disnake.ApplicationCommandPermissions¶

Represents application command permissions for a role or a user.

id¶

ID of a target

Type: int

type¶

1 if target is a role; 2 if target is a user

Type: int

permission¶

Allow or deny the access to the command

Type: bool

GuildApplicationCommandPermissions¶

Attributes

application_id
guild_id
id
permissions

Methods

asyncedit

class disnake.GuildApplicationCommandPermissions¶

Represents application command permissions in a guild.

id¶

The ID of the corresponding command.

Type: int

application_id¶

The ID of your application.

Type: int

guild_id¶

The ID of the guild where these permissions are applied.

Type: int

permissions¶

A list of ApplicationCommandPermissions.

Type: List[ApplicationCommandPermissions]

await edit(*, permissions=None, roles=None, users=None)¶

Replaces current permissions with specified ones.

Parámetros

permissions (Mapping[Union[Role, disnake.abc.User], bool]) – Roles or users to booleans. True means «allow», False means «deny».
roles (Mapping[int, bool]) – Role IDs to booleans.
users (Mapping[int, bool]) – User IDs to booleans.

PartialGuildApplicationCommandPermissions¶

class disnake.PartialGuildApplicationCommandPermissions¶

Creates an object representing permissions of the application command.

Parámetros

command_id (int) – The ID of the app command you want to apply these permissions to.
permissions (Mapping[Union[Role, disnake.abc.User], bool]) – Roles or users to booleans. True means «allow», False means «deny».
roles (Mapping[int, bool]) – Role IDs to booleans.
users (Mapping[int, bool]) – User IDs to booleans.

UnresolvedGuildApplicationCommandPermissions¶

Methods

defresolve

class disnake.UnresolvedGuildApplicationCommandPermissions¶

Creates an object representing permissions of an application command, without a specific command ID.

Parámetros

permissions (Mapping[Union[Role, disnake.abc.User], bool]) – Roles or users to booleans. True means «allow», False means «deny».
roles (Mapping[int, bool]) – Role IDs to booleans.
users (Mapping[int, bool]) – User IDs to booleans.
owner (bool) – Allow/deny the bot owner(s).

resolve(*, command_id, owners)¶

Creates a new PartialGuildApplicationCommandPermissions object, combining the previously supplied permission values with the provided command ID and owner IDs.

Parámetros

command_id (int) – the command ID to be used
owners (Iterable[int]) – the owner IDs, used for extending the user ID mapping based on the previously set owner permission if applicable

Devuelve

A new permissions object based on this instance and the provided command ID and owner IDs.

Tipo del valor devuelto

Component¶

Attributes

type

class disnake.Component¶

Represents a Discord Bot UI Kit Component.

Currently, the only components supported by Discord are:

ActionRow
Button
SelectMenu

This class is abstract and cannot be instantiated.

Nuevo en la versión 2.0.

type¶

The type of component.

Type: ComponentType

ActionRow¶

Attributes

children
type

class disnake.ActionRow¶

Represents a Discord Bot UI Kit Action Row.

This is a component that holds up to 5 children components in a row.

This inherits from Component.

Nuevo en la versión 2.0.

type¶

The type of component.

Type: ComponentType

children¶

The children components that this holds, if any.

Type: List[Component]

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.

Nota

The user constructible and usable type to create a button is disnake.ui.Button not this one.

Nuevo en la versión 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]

SelectMenu¶

Attributes

custom_id
disabled
max_values
min_values
options
placeholder

class disnake.SelectMenu¶

Represents a 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.

Nota

The user constructible and usable type to create a select menu is disnake.ui.Select not this one.

Nuevo en la versión 2.0.

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 menu.

Type: List[SelectOption]

disabled¶

Whether the select is disabled or not.

Type: bool

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.

Nuevo en la versión 1.6.

property id: int¶

The message ID of the deleted referenced message.

Type: int

property channel_id: int¶

The channel ID of the deleted referenced message.

Type: int

property guild_id: Optional[int]¶

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¶

Message this reaction is for.

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.

Ejemplos

Usage

# I 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.')

Parámetros

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.

Muestra

HTTPException – Getting the users for the reaction failed.

Campos

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()¶: bool: If this is a custom emoji.

await remove(user)¶

This function is a coroutine.

Remove 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.

Parámetros

user (abc.Snowflake) – The user or member from which to remove the reaction.

Muestra

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.

Nuevo en la versión 1.3.

Muestra

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.
InvalidArgument – The emoji parameter is invalid.

Guild¶

Methods

asyncactive_threads
defaudit_logs
asyncban
asyncbans
asyncbulk_edit_command_permissions
asyncbulk_fetch_command_permissions
defby_category
asyncchange_voice_state
asyncchunk
asynccreate_category
asynccreate_category_channel
asynccreate_custom_emoji
asynccreate_integration
asynccreate_role
asynccreate_stage_channel
asynccreate_sticker
asynccreate_template
asynccreate_text_channel
asynccreate_voice_channel
asyncdelete
asyncdelete_emoji
asyncdelete_sticker
asyncedit
asyncedit_command_permissions
asyncedit_role_positions
asyncedit_widget
asyncestimate_pruned_members
asyncfetch_ban
asyncfetch_channel
asyncfetch_channels
asyncfetch_command_permissions
asyncfetch_emoji
asyncfetch_emojis
asyncfetch_member
deffetch_members
asyncfetch_roles
asyncfetch_sticker
asyncfetch_stickers
defget_channel
defget_channel_or_thread
defget_command
defget_command_named
defget_member
defget_member_named
asyncget_or_fetch_member
defget_role
defget_stage_instance
defget_thread
asyncgetch_member
asyncintegrations
asyncinvites
asynckick
asyncleave
asyncprune_members
asyncquery_members
asynctemplates
asyncunban
asyncvanity_invite
asyncwebhooks
asyncwidget

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 name.

Type: str

emojis¶

All emojis that the guild owns.

Type: Tuple[Emoji, …]

stickers¶

All stickers that the guild owns.

Nuevo en la versión 2.0.

Type: Tuple[GuildSticker, …]

region¶

The region the guild belongs on. There is a chance that the region will be a str if the value is not recognised by the enumerator.

Type: VoiceRegion

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 instead.

Type: int

unavailable¶

Indicates if 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 the 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.

Nota

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.

Nuevo en la versión 1.4.

Type: Optional[int]

description¶

The guild’s description.

Type: Optional[str]

mfa_level¶

Indicates the guild’s two factor authorisation level. If this value is 0 then the guild does not require 2FA for their administrative members. If the value is 1 then they do.

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.

They are currently as follows:

ANIMATED_BANNER: Guild can upload an animated banner.
ANIMATED_ICON: Guild can upload an animated icon.
BANNER: Guild can upload and use a banner. (i.e. banner)
COMMERCE: Guild can sell things using store channels.
COMMUNITY: Guild is a community server.
DISCOVERABLE: Guild shows up in Server Discovery.
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.
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.
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.
SEVEN_DAY_THREAD_ARCHIVE: Guild has access to the seven day archive time for threads.
THREE_DAY_THREAD_ARCHIVE: Guild has access to the three day archive time for threads.
TICKETED_EVENTS_ENABLED: Guild has enabled ticketed events.
VANITY_URL: Guild can have a vanity invite URL (e.g. discord.gg/disnake-api).
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.

Type: Optional[str]

nsfw_level¶

The guild’s NSFW level.

Nuevo en la versión 2.0.

Type: NSFWLevel

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.

Nota

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

Nuevo en la versión 1.3.

All parameters are optional.

Parámetros

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.

Muestra

ClientException – The members intent is not enabled.
HTTPException – Getting the members failed.

Campos

Member – The member with the member data parsed.

Ejemplos

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, oldest_first=None, user=None, action=None)¶

Returns an AsyncIterator that enables receiving the guild’s audit logs.

You must have the view_audit_log permission to use this.

Ejemplos

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.')

Parámetros

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.
oldest_first (bool) – If set to True, return entries in oldest->newest order. Defaults to True if after is specified, otherwise False.
user (abc.Snowflake) – The moderator to filter entries from.
action (AuditLogAction) – The action to filter with.

Muestra

Forbidden – You are not allowed to fetch audit logs
HTTPException – An error occurred while fetching the audit logs.

Campos

AuditLogEntry – The audit log entry.

get_command(application_command_id, /)¶

Gets a cached application command matching the specified ID.

Parámetros: name (int) – the ID to compare to.

get_command_named(name, /)¶

Gets a cached application command matching the specified name.

Parámetros: name (str) – the name to compare to.

property channels: List[GuildChannel]¶

A list of channels that belongs to this guild.

Type: List[abc.GuildChannel]

property threads: List[disnake.threads.Thread]¶

A list of threads that you have permission to view.

Nuevo en la versión 2.0.

Type: List[Thread]

property large: bool¶

Indicates if 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: List[disnake.channel.VoiceChannel]¶

A list of voice channels that belongs to this guild.

This is sorted by the position and are in UI order from top to bottom.

Type: List[VoiceChannel]

property stage_channels: List[disnake.channel.StageChannel]¶

A list of stage channels that belongs to this guild.

Nuevo en la versión 1.7.

This is sorted by the position and are in UI order from top to bottom.

Type: List[StageChannel]

property me: disnake.member.Member¶

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: Optional[VoiceProtocol]¶

Returns the VoiceProtocol associated with this guild, if any.

Type: Optional[VoiceProtocol]

property text_channels: List[disnake.channel.TextChannel]¶

A list of text channels that belongs to this guild.

This is sorted by the position and are in UI order from top to bottom.

Type: List[TextChannel]

property categories: List[disnake.channel.CategoryChannel]¶

A list of categories that belongs 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.

Devuelve: The categories and their associated channels.
Tipo del valor devuelto: List[Tuple[Optional[CategoryChannel], List[abc.GuildChannel]]]

get_channel_or_thread(channel_id, /)¶

Returns a channel or thread with the given ID.

Nuevo en la versión 2.0.

Parámetros: channel_id (int) – The ID to search for.
Devuelve: The returned channel or thread or None if not found.
Tipo del valor devuelto: Optional[Union[Thread, abc.GuildChannel]]

get_channel(channel_id, /)¶

Returns a channel with the given ID.

Nota

This does not search for threads.

Parámetros: channel_id (int) – The ID to search for.
Devuelve: The returned channel or None if not found.
Tipo del valor devuelto: Optional[abc.GuildChannel]

get_thread(thread_id, /)¶

Returns a thread with the given ID.

Nuevo en la versión 2.0.

Parámetros: thread_id (int) – The ID to search for.
Devuelve: The returned thread or None if not found.
Tipo del valor devuelto: Optional[Thread]

property system_channel: Optional[disnake.channel.TextChannel]¶

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: disnake.flags.SystemChannelFlags¶

Returns the guild’s system channel settings.

Type: SystemChannelFlags

property rules_channel: Optional[disnake.channel.TextChannel]¶

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.

Nuevo en la versión 1.3.

Type: Optional[TextChannel]

property public_updates_channel: Optional[disnake.channel.TextChannel]¶

Return’s the guild’s channel where admins and moderators of the guilds receive notices from Discord. The guild must be a Community guild.

If no channel is set, then this returns None.

Nuevo en la versión 1.4.

Type: Optional[TextChannel]

property emoji_limit: int¶

The maximum number of emoji slots this guild has.

Type: int

property sticker_limit: int¶

The maximum number of sticker slots this guild has.

Nuevo en la versión 2.0.

Type: int

property bitrate_limit: float¶

The maximum bitrate for voice channels this guild can have.

Type: float

property filesize_limit: int¶

The maximum number of bytes files can have when uploaded to this guild.

Type: int

property members: List[disnake.member.Member]¶

A list of members that belong to this guild.

Type: List[Member]

get_member(user_id, /)¶

Returns a member with the given ID.

Parámetros: user_id (int) – The ID to search for.
Devuelve: The member or None if not found.
Tipo del valor devuelto: Optional[Member]

property premium_subscribers: List[disnake.member.Member]¶

A list of members who have «boosted» this guild.

Type: List[Member]

property roles: List[disnake.role.Role]¶

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.

Parámetros: role_id (int) – The ID to search for.
Devuelve: The role or None if not found.
Tipo del valor devuelto: Optional[Role]

property default_role: disnake.role.Role¶

Gets the @everyone role that all members have by default.

Type: Role

property premium_subscriber_role: Optional[disnake.role.Role]¶

Gets the premium subscriber role, AKA «boost» role, in this guild.

Nuevo en la versión 1.6.

Type: Optional[Role]

property self_role: Optional[disnake.role.Role]¶

Gets the role associated with this client’s user, if any.

Nuevo en la versión 1.6.

Type: Optional[Role]

property stage_instances: List[disnake.stage_instance.StageInstance]¶

Returns a list of the guild’s stage instances that are currently running.

Nuevo en la versión 2.0.

Type: List[StageInstance]

get_stage_instance(stage_instance_id, /)¶

Returns a stage instance with the given ID.

Nuevo en la versión 2.0.

Parámetros: stage_instance_id (int) – The ID to search for.
Devuelve: The stage instance or None if not found.
Tipo del valor devuelto: Optional[StageInstance]

property owner: Optional[disnake.member.Member]¶

The member that owns the guild.

Type: Optional[Member]

property icon: Optional[disnake.asset.Asset]¶

Returns the guild’s icon asset, if available.

Type: Optional[Asset]

property banner: Optional[disnake.asset.Asset]¶

Returns the guild’s banner asset, if available.

Type: Optional[Asset]

property splash: Optional[disnake.asset.Asset]¶

Returns the guild’s invite splash asset, if available.

Type: Optional[Asset]

property discovery_splash: Optional[disnake.asset.Asset]¶

Returns the guild’s discovery splash asset, if available.

Type: Optional[Asset]

property member_count: int¶

Returns the true member count regardless of it being loaded fully or not.

Advertencia

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 chunked: bool¶

Returns a boolean indicating if 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: int¶

Returns the shard ID for this guild if applicable.

Type: int

property created_at: datetime.datetime¶

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.

Parámetros: name (str) – The name of the member to lookup with an optional discriminator.
Devuelve: The member in this guild with the associated name. If not found then None is returned.
Tipo del valor devuelto: Optional[Member]

await create_text_channel(name, *, reason=None, category=None, position=..., topic=..., slowmode_delay=..., nsfw=..., overwrites=...)¶

This function is a coroutine.

Creates a TextChannel for the guild.

Note that you need the 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.

Nota

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.

Ejemplos

Creating a basic channel:

channel = await guild.create_text_channel('cool-channel')

Creating a «secret» channel:

overwrites = {
    guild.default_role: disnake.PermissionOverwrite(read_messages=False),
    guild.me: disnake.PermissionOverwrite(read_messages=True)
}

channel = await guild.create_text_channel('secret', overwrites=overwrites)

Parámetros

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 (str) – The new channel’s topic.
slowmode_delay (int) – Specifies the slowmode rate limit for user in this channel, in seconds. The maximum value possible is 21600.
nsfw (bool) – To mark the channel as NSFW or not.
reason (Optional[str]) – The reason for creating this channel. Shows up on the audit log.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.
InvalidArgument – The permission overwrite information is not in proper form.

Devuelve

The channel that was just created.

Tipo del valor devuelto

TextChannel

await create_voice_channel(name, *, reason=None, category=None, position=..., bitrate=..., user_limit=..., rtc_region=..., video_quality_mode=..., overwrites=...)¶

This function is a coroutine.

This is similar to create_text_channel() except makes a VoiceChannel instead.

Parámetros

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[VoiceRegion]) –
The region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

Nuevo en la versión 1.7.
video_quality_mode (VideoQualityMode) –
The camera video quality for the voice channel’s participants.

Nuevo en la versión 2.0.
reason (Optional[str]) – The reason for creating this channel. Shows up on the audit log.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.
InvalidArgument – The permission overwrite information is not in proper form.

Devuelve

The channel that was just created.

Tipo del valor devuelto

VoiceChannel

await create_stage_channel(name, *, topic, position=..., overwrites=..., category=None, reason=None)¶

This function is a coroutine.

This is similar to create_text_channel() except makes a StageChannel instead.

Nuevo en la versión 1.7.

Parámetros

name (str) – The channel’s name.
topic (str) – The new channel’s topic.
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.
reason (Optional[str]) – The reason for creating this channel. Shows up on the audit log.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.
InvalidArgument – The permission overwrite information is not in proper form.

Devuelve

The channel that was just created.

Tipo del valor devuelto

StageChannel

await create_category(name, *, overwrites=..., reason=None, position=...)¶

This function is a coroutine.

Same as create_text_channel() except makes a CategoryChannel instead.

Nota

The category parameter is not supported in this function since categories cannot have categories.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.
InvalidArgument – The permission overwrite information is not in proper form.

Devuelve

The channel that was just created.

Tipo del valor devuelto

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.

Nota

The category parameter is not supported in this function since categories cannot have categories.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.
InvalidArgument – The permission overwrite information is not in proper form.

Devuelve

The channel that was just created.

Tipo del valor devuelto

CategoryChannel

await leave()¶

This function is a coroutine.

Leaves the guild.

Nota

You cannot leave the guild that you own, you must delete it instead via delete().

Muestra: 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.

Muestra

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=..., region=..., 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 the manage_guild permission to edit the guild.

Distinto en la versión 1.4: The rules_channel and public_updates_channel keyword-only parameters were added.

Distinto en la versión 2.0: The discovery_splash and community keyword-only parameters were added.

Distinto en la versión 2.0: The newly updated guild is returned.

Parámetros

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 PUBLIC in Guild.features.
icon (bytes) – A bytes-like object representing the icon. Only PNG/JPEG is supported. GIF is only available to guilds that contain ANIMATED_ICON in Guild.features. Could be None to denote removal of the icon.
banner (bytes) – A bytes-like object representing the 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.
splash (bytes) – A bytes-like object representing the invite splash. Only PNG/JPEG supported. Could be None to denote removing the splash. This is only available to guilds that contain INVITE_SPLASH in Guild.features.
discovery_splash (bytes) – A bytes-like object representing the discovery splash. Only PNG/JPEG supported. Could be None to denote removing the splash. This is only available to guilds that contain DISCOVERABLE in Guild.features.
community (bool) – Whether the guild should be a Community guild. If set to True, both rules_channel and public_updates_channel parameters are required.
region (Union[str, VoiceRegion]) – The new region for the guild’s voice communication.
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.
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 (str) – The new preferred locale for the guild. Used as the primary language in the guild. If set, this must be an ISO 639 code, e.g. en-US or ja or zh-CN.
rules_channel (Optional[TextChannel]) – The new channel that is used for rules. This is only available to guilds that contain PUBLIC 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 PUBLIC in Guild.features. Could be None for no public updates channel.
reason (Optional[str]) – The reason for editing this guild. Shows up on the audit log.
premium_progress_bar_enabled (bool) – Whether the server boost progress bar is enabled.

Muestra

Forbidden – You do not have permissions to edit the guild.
HTTPException – Editing the guild failed.
InvalidArgument – The image format passed in to icon is invalid. It must be PNG or JPG. This is also raised if you are not the owner of the guild and request an ownership transfer.

Devuelve

The newly updated guild. Note that this has the same limitations as mentioned in Client.fetch_guild() and may not have full data.

Tipo del valor devuelto

await fetch_channels()¶

This function is a coroutine.

Retrieves all abc.GuildChannel that the guild has.

Nota

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

Nuevo en la versión 1.2.

Muestra

InvalidData – An unknown channel type was received from Discord.
HTTPException – Retrieving the channels failed.

Devuelve

All channels in the guild.

Tipo del valor devuelto

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.

Nuevo en la versión 2.0.

Muestra: HTTPException – The request to get the active threads failed.
Devuelve: The active threads
Tipo del valor devuelto: List[Thread]

await fetch_member(member_id, /)¶

This function is a coroutine.

Retrieves a Member from a guild ID, and a member ID.

Nota

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

Parámetros

member_id (int) – The member’s ID to fetch from.

Muestra

Forbidden – You do not have access to the guild.
HTTPException – Fetching the member failed.

Devuelve

The member from the member ID.

Tipo del valor devuelto

Member

await fetch_ban(user)¶

This function is a coroutine.

Retrieves the BanEntry for a user.

You must have the ban_members permission to get this information.

Parámetros

user (abc.Snowflake) – The user to get ban information from.

Muestra

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.

Devuelve

The BanEntry object for the specified user.

Tipo del valor devuelto

BanEntry

await fetch_channel(channel_id, /)¶

This function is a coroutine.

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

Nota

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

Nuevo en la versión 2.0.

Muestra

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.

Devuelve

The channel from the ID.

Tipo del valor devuelto

Union[abc.GuildChannel, Thread]

await bans()¶

This function is a coroutine.

Retrieves all the users that are banned from the guild as a list of BanEntry.

You must have the ban_members permission to get this information.

Muestra

Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.

Devuelve

A list of BanEntry objects.

Tipo del valor devuelto

List[BanEntry]

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 the 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.

Distinto en la versión 1.4: The roles keyword-only parameter was added.

Parámetros

days (int) – The number of days before counting as inactive.
reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.
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.

Muestra

Forbidden – You do not have permissions to prune members.
HTTPException – An error occurred while pruning members.
InvalidArgument – An integer was not passed for days.

Devuelve

The number of members pruned. If compute_prune_count is False then this returns None.

Tipo del valor devuelto

Optional[int]

await templates()¶

This function is a coroutine.

Gets the list of templates from this guild.

Requires manage_guild permissions.

Nuevo en la versión 1.7.

Muestra: Forbidden – You don’t have permissions to get the templates.
Devuelve: The templates for this guild.
Tipo del valor devuelto: List[Template]

await webhooks()¶

This function is a coroutine.

Gets the list of webhooks from this guild.

Requires manage_webhooks permissions.

Muestra: Forbidden – You don’t have permissions to get the webhooks.
Devuelve: The webhooks for this guild.
Tipo del valor devuelto: 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.

Parámetros

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.

Nuevo en la versión 1.7.

Muestra

Forbidden – You do not have permissions to prune members.
HTTPException – An error occurred while fetching the prune members estimate.
InvalidArgument – An integer was not passed for days.

Devuelve

The number of members estimated to be pruned.

Tipo del valor devuelto

GuildApplicationCommandPermissions

await invites()¶

This function is a coroutine.

Returns a list of all active instant invites from the guild.

You must have the manage_guild permission to get this information.

Muestra

Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.

Devuelve

The list of invites that are currently active.

Tipo del valor devuelto

List[Invite]

await create_template(*, name, description=...)¶

This function is a coroutine.

Creates a template for the guild.

You must have the manage_guild permission to do this.

Nuevo en la versión 1.7.

Parámetros

name (str) – The name of the template.
description (str) – The description of the template.

await create_integration(*, type, id)¶

This function is a coroutine.

Attaches an integration to the guild.

You must have the manage_guild permission to do this.

Nuevo en la versión 1.4.

Parámetros

type (str) – The integration type (e.g. Twitch).
id (int) – The integration ID.

Muestra

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 the manage_guild permission to do this.

Nuevo en la versión 1.4.

Muestra

Forbidden – You do not have permission to create the integration.
HTTPException – Fetching the integrations failed.

Devuelve

The list of integrations that are attached to the guild.

Tipo del valor devuelto

List[Integration]

await fetch_stickers()¶

This function is a coroutine.

Retrieves a list of all Stickers for the guild.

Nuevo en la versión 2.0.

Nota

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

Muestra: HTTPException – An error occurred fetching the stickers.
Devuelve: The retrieved stickers.
Tipo del valor devuelto: List[GuildSticker]

await fetch_sticker(sticker_id, /)¶

This function is a coroutine.

Retrieves a custom Sticker from the guild.

Nuevo en la versión 2.0.

Nota

This method is an API call. For general usage, consider iterating over stickers instead.

Parámetros

sticker_id (int) – The sticker’s ID.

Muestra

NotFound – The sticker requested could not be found.
HTTPException – An error occurred fetching the sticker.

Devuelve

The retrieved sticker.

Tipo del valor devuelto

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.

Nuevo en la versión 2.0.

Parámetros

name (str) – The sticker name. Must be at least 2 characters.
description (Optional[str]) – The sticker’s description. Can be None.
emoji (str) – The name of a unicode emoji that represents the sticker’s expression.
file (File) – The file of the sticker to upload.
reason (str) – The reason for creating this sticker. Shows up on the audit log.

Muestra

Forbidden – You are not allowed to create stickers.
HTTPException – An error occurred creating a sticker.

Devuelve

The created sticker.

Tipo del valor devuelto

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.

Nuevo en la versión 2.0.

Parámetros

sticker (abc.Snowflake) – The sticker you are deleting.
reason (Optional[str]) – The reason for deleting this sticker. Shows up on the audit log.

Muestra

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 from the guild.

Nota

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

Muestra: HTTPException – An error occurred fetching the emojis.
Devuelve: The retrieved emojis.
Tipo del valor devuelto: List[Emoji]

await fetch_emoji(emoji_id, /)¶

This function is a coroutine.

Retrieves a custom Emoji from the guild.

Nota

This method is an API call. For general usage, consider iterating over emojis instead.

Parámetros

emoji_id (int) – The emoji’s ID.

Muestra

NotFound – The emoji requested could not be found.
HTTPException – An error occurred fetching the emoji.

Devuelve

The retrieved emoji.

Tipo del valor devuelto

Emoji

await create_custom_emoji(*, name, image, roles=..., reason=None)¶

This function is a coroutine.

Creates a custom Emoji for the guild.

There is currently a limit of 50 static and animated emojis respectively per guild, unless the guild has the MORE_EMOJI feature which extends the limit to 200.

You must have the manage_emojis permission to do this.

Parámetros

name (str) – The emoji name. Must be at least 2 characters.
image (bytes) – The bytes-like object representing the image data to use. Only JPG, PNG and GIF images are supported.
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.

Muestra

Forbidden – You are not allowed to create emojis.
HTTPException – An error occurred creating an emoji.

Devuelve

The created emoji.

Tipo del valor devuelto

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.

Parámetros

emoji (abc.Snowflake) – The emoji you are deleting.
reason (Optional[str]) – The reason for deleting this emoji. Shows up on the audit log.

Muestra

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.

Nota

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

Nuevo en la versión 1.3.

Muestra: HTTPException – Retrieving the roles failed.
Devuelve: All roles in the guild.
Tipo del valor devuelto: List[Role]

await get_or_fetch_member(member_id, *, strict=False)¶

This function is a coroutine.

Tries to get a member from the cache by ID. If fails, it fetcehs the user from the API and caches it.

Parámetros: member_id (int) – The ID to search for.
Devuelve: The member with the given ID
Tipo del valor devuelto: Member

await getch_member(member_id, *, strict=False)¶

This function is a coroutine.

Tries to get a member from the cache by ID. If fails, it fetcehs the user from the API and caches it.

Parámetros: member_id (int) – The ID to search for.
Devuelve: The member with the given ID
Tipo del valor devuelto: 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 the manage_roles permission to do this.

Distinto en la versión 1.6: Can now pass int to colour keyword-only parameter.

Parámetros

name (str) – The role name. Defaults to “new role”.
permissions (Permissions) – The permissions to 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) – Indicates if the role should be shown separately in the member list. Defaults to False.
icon (bytes) – The role’s new icon image (if the guild has the ROLE_ICONS feature).
emoji (str) – The role’s new unicode emoji.
mentionable (bool) – Indicates if 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.

Muestra

Forbidden – You do not have permissions to create the role.
HTTPException – Creating the role failed.
InvalidArgument – An invalid keyword argument was given.

Devuelve

The newly created role.

Tipo del valor devuelto

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 the manage_roles permission to do this.

Nuevo en la versión 1.4.

Example:

positions = {
    bots_role: 1, # penultimate role
    tester_role: 2,
    admin_role: 6
}

await guild.edit_role_positions(positions=positions)

Parámetros

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.

Muestra

Forbidden – You do not have permissions to move the roles.
HTTPException – Moving the roles failed.
InvalidArgument – An invalid keyword argument was given.

Devuelve

A list of all the roles in the guild.

Tipo del valor devuelto

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 the kick_members permission to do this.

Parámetros

user (abc.Snowflake) – The user to kick from their guild.
reason (Optional[str]) – The reason the user got kicked.

Muestra

Forbidden – You do not have the proper permissions to kick.
HTTPException – Kicking failed.

await ban(user, *, reason=None, delete_message_days=1)¶

This function is a coroutine.

Bans a user from the guild.

The user must meet the abc.Snowflake abc.

You must have the ban_members permission to do this.

Parámetros

user (abc.Snowflake) – The user to ban from their guild.
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.
reason (Optional[str]) – The reason the user got banned.

Muestra

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 the ban_members permission to do this.

Parámetros

user (abc.Snowflake) – The user to unban.
reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Muestra

Forbidden – You do not have the proper permissions to unban.
HTTPException – Unbanning failed.

await vanity_invite()¶

This function is a coroutine.

Returns the guild’s special vanity invite.

The guild must have VANITY_URL in features.

You must have the manage_guild permission to use this as well.

Muestra

Forbidden – You do not have the proper permissions to get this.
HTTPException – Retrieving the vanity invite failed.

Devuelve

The special vanity invite. If None then the guild does not have a vanity invite set.

Tipo del valor devuelto

Optional[Invite]

await widget()¶

This function is a coroutine.

Returns the widget of the guild.

Nota

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

Muestra

Forbidden – The widget for this guild is disabled.
HTTPException – Retrieving the widget failed.

Devuelve

The guild’s widget.

Tipo del valor devuelto

Widget

await edit_widget(*, enabled=..., channel=...)¶

This function is a coroutine.

Edits the widget of the guild.

You must have the manage_guild permission to use this

Nuevo en la versión 2.0.

Parámetros

enabled (bool) – Whether to enable the widget for the guild.
channel (Optional[Snowflake]) – The new widget channel. None removes the widget channel.

Muestra

Forbidden – You do not have permission to edit the widget.
HTTPException – Editing the widget failed.

await chunk(*, cache=True)¶

This function is a coroutine.

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.

Nuevo en la versión 1.5.

Parámetros: cache (bool) – Whether to cache the members as well.
Muestra: ClientException – The members intent is not enabled.

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.

Nuevo en la versión 1.3.

Parámetros

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.

Nuevo en la versión 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.

Nuevo en la versión 1.4.

Muestra

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.

Devuelve

The list of members that have matched the query.

Tipo del valor devuelto

List[Member]

await change_voice_state(*, channel, self_mute=False, self_deaf=False)¶

This function is a coroutine.

Changes client’s voice state in the guild.

Nuevo en la versión 1.4.

Parámetros

channel (Optional[VoiceChannel]) – Channel the client wants to join. Use None to disconnect.
self_mute (bool) – Indicates if the client should be self-muted.
self_deaf (bool) – Indicates if 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.

Nuevo en la versión 2.1.

await fetch_command_permissions(command_id)¶

This function is a coroutine.

Requests GuildApplicationCommandPermissions for a specific command.

Nuevo en la versión 2.1.

Parámetros: command_id (int) – the ID of the application command
Devuelve: The edited app command permissions.
Tipo del valor devuelto: GuildApplicationCommandPermissions

await edit_command_permissions(command_id, *, permissions=None, role_ids=None, user_ids=None)¶

Edits guild permissions of a single command.

Parámetros

command_id (int) – The ID of the app command you want to apply these permissions to.
permissions (Mapping[Union[Role, disnake.abc.User], bool]) – Roles or users to booleans. True means «allow», False means «deny».
role_ids (Mapping[int, bool]) – Role IDs to booleans.
user_ids (Mapping[int, bool]) – User IDs to booleans.

Devuelve

The object representing the edited app command permissions.

Tipo del valor devuelto

await bulk_edit_command_permissions(permissions)¶

This function is a coroutine.

Edits guild permissions of multiple application commands at once.

Nuevo en la versión 2.1.

Parámetros: permissions (List[PartialGuildApplicationCommandPermissions]) – A list of partial permissions for each app command you want to edit.
Devuelve: A list of edited permissions of application commands.
Tipo del valor devuelto: List[GuildApplicationCommandPermissions]

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

Integration¶

class disnake.Integration¶

Represents a guild integration.

Nuevo en la versión 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.

Deletes the integration.

You must have the manage_guild permission to do this.

Parámetros

reason (str) –

The reason the integration was deleted. Shows up on the audit log.

Nuevo en la versión 2.0.

Muestra

Forbidden – You do not have permission to delete the integration.
HTTPException – Deleting the integration failed.

class disnake.IntegrationAccount¶

Represents an integration account.

Nuevo en la versión 1.4.

id¶

The account ID.

Type: str

name¶

The account name.

Type: str

class disnake.BotIntegration¶

Represents a bot integration on disnake.

Nuevo en la versión 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

class disnake.IntegrationApplication¶

Represents an application for a bot integration.

Nuevo en la versión 2.0.

id¶

The ID for this application.

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

summary¶

The summary of the application. Can be an empty string.

Type: str

user¶

The bot user on this application.

Type: Optional[User]

class disnake.StreamIntegration¶

Represents a stream integration for Twitch or YouTube.

Nuevo en la versión 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¶

Where 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: disnake.enums.ExpireBehaviour¶

An alias for expire_behaviour.

Type: ExpireBehaviour

property role: Optional[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.

Edits the integration.

You must have the manage_guild permission to do this.

Parámetros

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).

Muestra

Forbidden – You do not have permission to edit the integration.
HTTPException – Editing the guild failed.
InvalidArgument – expire_behaviour did not receive a ExpireBehaviour.

await sync()¶

This function is a coroutine.

Syncs the integration.

You must have the manage_guild permission to do this.

Muestra

Forbidden – You do not have permission to sync the integration.
HTTPException – Syncing the integration failed.

Interaction¶

Attributes

application_id
author
channel
channel_id
followup
guild
guild_id
id
me
permissions
response
token
type

Methods

asyncdelete_original_message
asyncedit_original_message
asyncoriginal_message
asyncsend

class disnake.Interaction¶

A base class representing a Discord interaction.

An interaction happens when a user does an action that needs to be notified. Current examples are application commands and components.

Nuevo en la versión 2.0.

id¶

The interaction’s ID.

Type: int

type¶

The interaction type.

Type: InteractionType

guild_id¶

The guild ID the interaction was sent from.

Type: Optional[int]

channel_id¶

The channel ID the interaction was sent from.

Type: Optional[int]

application_id¶

The application ID that the interaction was for.

Type: int

author¶

The user or member that sent the interaction.

Type: Optional[Union[User, Member]]

token¶

The token to continue the interaction. These are valid for 15 minutes.

Type: str

property guild: Optional[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, DM channels are not resolved since there is no data to complete them. These are PartialMessageable instead.

Type: Optional[Union[abc.GuildChannel, PartialMessageable, Thread]]

property permissions: disnake.permissions.Permissions¶

The resolved permissions of the member in the channel, including overwrites.

In a non-guild context where this doesn’t apply, an empty permissions object is returned.

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

await original_message()¶

This function is a coroutine.

Fetches the original interaction response message associated with the interaction.

If the interaction response was InteractionResponse.send_message() then this would return the message that was sent using that response. Otherwise, this would return the message that triggered the interaction.

Repeated calls to this will return a cached value.

Muestra

HTTPException – Fetching the original response message failed.
ClientException – The channel for the message could not be resolved.

Devuelve

The original interaction response message.

Tipo del valor devuelto

InteractionMessage

await edit_original_message(*, content=..., embed=..., embeds=..., file=..., files=..., attachments=..., view=..., 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 message if the message sent was ephemeral.

Nota

Parámetros

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 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 (List[Attachment]) –
A list of attachments to keep in the message. If [] is passed then all existing attachments are removed. Keeps existing attachments if not provided.

Nuevo en la versión 2.1.
view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.
allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Muestra

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.

Devuelve

The newly edited message.

Tipo del valor devuelto

InteractionMessage

await delete_original_message(*, 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.

Parámetros

delay (float) – If provided, the number of seconds to wait in the background before deleting the original message. If the deletion fails, then it is silently ignored.

Muestra

HTTPException – Deleting the message failed.
Forbidden – Deleted a message that is not yours.

await send(content=None, *, embed=..., embeds=..., file=..., files=..., allowed_mentions=..., view=..., tts=False, ephemeral=False, delete_after=...)¶

This function is a coroutine.

Sends a message using either response.send_message() or followup.send().

If the interaction is not responded, this method will call response.send_message(). followup.send() otherwise.

Parámetros

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 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 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) – Indicates if the message should be sent using text-to-speech.
view (disnake.ui.View) – The view to send with the message.
ephemeral (bool) – Indicates if 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.

Muestra

HTTPException – Sending the message failed.
TypeError – You specified both embed and embeds.
ValueError – The length of embeds was invalid.

ApplicationCommandInteraction¶

Attributes

application_id
author
channel
channel_id
data
filled_options
followup
guild
guild_id
id
me
options
permissions
response
target
token
type

class disnake.ApplicationCommandInteraction¶

Represents an interaction with an application command.

Current examples are slash commands, user commands and message commands.

Nuevo en la versión 2.1.

id¶

The interaction’s ID.

Type: int

type¶

The interaction type.

Type: InteractionType

guild_id¶

The guild ID the interaction was sent from.

Type: Optional[int]

channel_id¶

The channel ID the interaction was sent from.

Type: Optional[int]

application_id¶

The application ID that the interaction was for.

Type: int

author¶

The user or member that sent the interaction.

Type: Optional[Union[User, Member]]

guild¶

The guild the interaction was sent from.

Type: Optional[Guild]

channel¶

The channel the interaction was sent from.

Type: Optional[Union[abc.GuildChannel, PartialMessageable, Thread]]

me¶

Similar to Guild.me

Type: Union[Member, ClientUser]

permissions¶

The resolved permissions of the member in the channel, including overwrites.

Type: Permissions

response¶

Returns an object responsible for handling responding to the interaction.

Type: InteractionResponse

followup¶

Returns the follow up webhook for follow up interactions.

Type: Webhook

type¶

The interaction type.

Type: InteractionType

token¶

The token to continue the interaction. These are valid for 15 minutes.

Type: str

data¶

The wrapped interaction data.

Type: ApplicationCommandInteractionData

property target: Optional[Union[disnake.user.User, disnake.member.Member, disnake.message.Message]]¶

The user or message targetted by a user or message command

Type: Optional[Union[abc.User, Message]]

property options: Dict[str, Any]¶

The full option tree, including nestings

Type: Dict[str, Any]

property filled_options: Dict[str, Any]¶

The options of the command (or sub-command) being invoked

Type: Dict[str, Any]

MessageInteraction¶

Attributes

application_id
author
channel
channel_id
component
data
followup
guild
guild_id
id
me
message
permissions
response
token
type
values

class disnake.MessageInteraction¶

Represents an interaction with a message component.

Current examples are buttons and dropdowns.

Nuevo en la versión 2.1.

id¶

The interaction’s ID.

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: Optional[int]

application_id¶

The application ID that the interaction was for.

Type: int

author¶

The user or member that sent the interaction.

Type: Optional[Union[User, Member]]

guild¶

The guild the interaction was sent from.

Type: Optional[Guild]

channel¶

The channel the interaction was sent from.

Type: Optional[Union[abc.GuildChannel, PartialMessageable, Thread]]

message¶

The message that sent this interaction.

Type: Optional[Message]

me¶

Similar to Guild.me

Type: Union[Member, ClientUser]

permissions¶

The resolved permissions of the member in the channel, including overwrites.

Type: Permissions

response¶

Returns an object responsible for handling responding to the interaction.

Type: InteractionResponse

followup¶

Returns the follow up webhook for follow up interactions.

Type: Webhook

type¶

The interaction type.

Type: InteractionType

token¶

The token to continue the interaction. These are valid for 15 minutes.

Type: str

data¶

The wrapped interaction data.

Type: MessageInteractionData

property values: Optional[List[str]]¶

The values the user selected

Type: Optional[List[str]]

component¶

The component the user interacted with

Type: Union[Button, SelectMenu]

InteractionResponse¶

Methods

asyncautocomplete
asyncdefer
asyncedit_message
defis_done
asyncpong
asyncsend_message

class disnake.InteractionResponse¶

Represents a Discord interaction response.

This type can be accessed through Interaction.response.

Nuevo en la versión 2.0.

is_done()¶

bool: Indicates whether an interaction response has been done before.

An interaction can only be responded to once.

await defer(*, ephemeral=False)¶

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.

Parámetros

ephemeral (bool) – Indicates whether the deferred message will eventually be ephemeral. This only applies for interactions of type InteractionType.application_command.

Muestra

HTTPException – Deferring the interaction failed.
InteractionResponded – This interaction has already been responded to before.

await pong()¶

This function is a coroutine.

Pongs the ping interaction.

This should rarely be used.

Muestra

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=..., tts=False, ephemeral=False, delete_after=...)¶

This function is a coroutine.

Responds to this interaction by sending a message.

Parámetros

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 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 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.
tts (bool) – Indicates if the message should be sent using text-to-speech.
ephemeral (bool) – Indicates if 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.

Muestra

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=..., allowed_mentions=..., view=...)¶

This function is a coroutine.

Responds to this interaction by editing the original message of a component interaction.

Nota

The attachments parameter is currently non-functional, removing/replacing existing attachments using this method is presently not supported (API limitation, see this). As a workaround, respond to the interaction first (e.g. using defer()), then edit the message using edit_original_message().

Nota

Parámetros

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 files parameter. Files will be appended to the message.

Nuevo en la versión 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.

Nuevo en la versión 2.1.
allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message.
view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.

Muestra

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.

Parámetros

choices (Union[Dict[str, str], List[OptionChoice]]) – The list of choices to suggest.

Muestra

HTTPException – Autocomplete response has failed.
InteractionResponded – This interaction has already been responded to before.

InteractionMessage¶

Methods

asyncdelete
asyncedit

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_message().

This inherits from disnake.Message with changes to edit() and delete() to work.

Nuevo en la versión 2.0.

await edit(content=..., embed=..., embeds=..., file=..., files=..., attachments=..., view=..., allowed_mentions=None)¶

This function is a coroutine.

Edits the message.

Nota

Parámetros

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 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 (List[Attachment]) –
A list of attachments to keep in the message. If [] is passed then all existing attachments are removed. Keeps existing attachments if not provided.

Nuevo en la versión 2.1.
view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.
allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Muestra

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.

Devuelve

The newly edited message.

Tipo del valor devuelto

InteractionMessage

await delete(*, delay=None)¶

This function is a coroutine.

Deletes the message.

Parámetros

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.

Muestra

Forbidden – You do not have proper permissions to delete the message.
NotFound – The message was deleted already.
HTTPException – Deleting the message failed.

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.

Nuevo en la versión 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: ApplicationCommandInteractionDataResolved

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: disnake.interactions.application_command.ApplicationCommandInteractionDataOption¶: 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 name of the option.

Type: str

type¶

The type of the option.

Type: OptionType

value¶

The value of the option.

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 case of ApplicationCommandAutocompleteInteraction.

Type: bool

ApplicationCommandInteractionDataResolved¶

Attributes

channels
members
messages
roles
users

class disnake.ApplicationCommandInteractionDataResolved¶

Represents the resolved data related to an interaction with an application command.

Nuevo en la versión 2.1.

members¶

IDs and partial members (missing deaf and mute)

Type: Dict[int, Member]

users¶

IDs and users

Type: Dict[int, User]

roles¶

IDs and roles

Type: Dict[int, Role]

channels¶

IDs and partial channels (only id, name and permissions are included, threads also have thread_metadata and parent_id).

Type: Dict[int, Channel]

messages¶

IDs and messages

Type: Dict[int, Message]

MessageInteractionData¶

Attributes

component_type
custom_id
values

class disnake.MessageInteractionData¶

Represents the data of an interaction with a message component.

Nuevo en la versión 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.

Type: Optional[List[str]]

Member¶

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
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.

Nota

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 GH-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.

Nuevo en la versión 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 read_message_history permissions to use this.

Ejemplos

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.

Parámetros

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[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[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[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.

Muestra

Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.

Campos

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.

Nota

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.

Devuelve: The channel that was created.
Tipo del valor devuelto: 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: str¶

The member’s overall status as a string value.

Nuevo en la versión 1.5.

Type: str

property status: disnake.enums.Status¶

The member’s overall status. If the value is unknown, then it will be a str instead.

Type: Status

property mobile_status: disnake.enums.Status¶

The member’s status on a mobile device, if applicable.

Type: Status

property desktop_status: disnake.enums.Status¶

The member’s status on the desktop client, if applicable.

Type: Status

property web_status: disnake.enums.Status¶

The member’s status on the web client, if applicable.

Type: Status

is_on_mobile()¶: bool: A helper function that determines if a member is active on a mobile device.

property colour: disnake.colour.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: disnake.colour.Colour¶

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: List[Role]¶

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: str¶

Returns a string that allows you to mention the member.

Type: str

property display_name: str¶

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: disnake.asset.Asset¶

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.

Nuevo en la versión 2.0.

Type: Asset

property guild_avatar: Optional[disnake.asset.Asset]¶

Returns an Asset for the guild avatar the member has. If unavailable, None is returned.

Nuevo en la versión 2.0.

Type: Optional[Asset]

property activity: Optional[Union[disnake.activity.Activity, disnake.activity.Game, disnake.activity.CustomActivity, disnake.activity.Streaming, disnake.activity.Spotify]]¶

Returns the primary activity the user is currently doing. Could be None if no activity is being done.

Nota

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 GH-1738 for more information.

Nota

A user may have multiple activities, these can be accessed under activities.

Type: Optional[Union[BaseActivity, Spotify]]

mentioned_in(message)¶

Checks if the member is mentioned in the specified message.

Parámetros: message (Message) – The message to check if you’re mentioned in.
Devuelve: Indicates if the member is mentioned in the message.
Tipo del valor devuelto: bool

property top_role: Role¶

Returns the member’s highest role.

This is useful for figuring where a member stands in the role hierarchy chain.

Type: Role

property guild_permissions: disnake.permissions.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: Optional[disnake.member.VoiceState]¶

Returns the member’s current voice state.

Type: Optional[VoiceState]

await ban(*, delete_message_days=1, 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=..., 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`

All parameters are optional.

Distinto en la versión 1.1: Can now pass None to voice_channel to kick a member from voice.

Distinto en la versión 2.0: The newly member is now optionally returned, if applicable.

Parámetros

nick (Optional[str]) – The member’s new nickname. Use None to remove the nickname.
mute (bool) – Indicates if the member should be guild muted or un-muted.
deafen (bool) – Indicates if the member should be guild deafened or un-deafened.
suppress (bool) –
Indicates if the member should be suppressed in stage channels.

Nuevo en la versión 1.7.
roles (List[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.
reason (Optional[str]) – The reason for editing this member. Shows up on the audit log.

Muestra

Forbidden – You do not have the proper permissions to the action requested.
HTTPException – The operation failed.

Devuelve

The newly updated member, if applicable. This is only returned when certain fields are updated.

Tipo del valor devuelto

Optional[Member]

await request_to_speak()¶

This function is a coroutine.

Request to speak in the connected channel.

Only applies to stage channels.

Nota

Requesting members that are not the client is equivalent to edit providing suppress as False.

Nuevo en la versión 1.7.

Muestra

Forbidden – You do not have the proper permissions to the action requested.
HTTPException – The operation failed.

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 the move_members permission to use this.

This raises the same exceptions as edit().

Distinto en la versión 1.1: Can now pass None to kick a member from voice.

Parámetros

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 add_roles(*roles, reason=None, atomic=True)¶

This function is a coroutine.

Gives the member a number of Roles.

You must have the 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.

Parámetros

*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.

Muestra

Forbidden – You do not have permissions to add these roles.
HTTPException – Adding roles failed.

await fetch_message(id, /)¶

This function is a coroutine.

Retrieves a single Message from the destination.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The message asked for.

Tipo del valor devuelto

await pins()¶

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Nota

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Muestra: HTTPException – Retrieving the pinned messages failed.
Devuelve: The messages that are currently pinned.
Tipo del valor devuelto: List[Message]

await remove_roles(*roles, reason=None, atomic=True)¶

This function is a coroutine.

Removes Roles from this member.

You must have the 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.

Parámetros

*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.

Muestra

Forbidden – You do not have permissions to remove these roles.
HTTPException – Removing the roles failed.

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). If the content is set to None (the default), then the embed parameter must be provided.

Parámetros

content (Optional[str]) – The content of the message to send.
tts (bool) – Indicates if the message should be sent using text-to-speech.
embed (Embed) – The rich embed for the content to send. This cannot be mixed with 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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.

Nuevo en la versión 2.0.
nonce (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.

Nuevo en la versión 1.4.
reference (Union[Message, MessageReference, PartialMessage]) –
A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

Nuevo en la versión 1.6.
mention_author (Optional[bool]) –
If set, overrides the replied_user attribute of allowed_mentions.

Nuevo en la versión 1.6.
view (disnake.ui.View) – A Discord UI View to add to the message.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size, you specified both file and files, or you specified both embed and embeds, or the reference object is not a Message, MessageReference or PartialMessage.

Devuelve

The message that was sent.

Tipo del valor devuelto

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.

get_role(role_id, /)¶

Returns a role with the given ID from roles which the member has.

Nuevo en la versión 2.0.

Parámetros: role_id (int) – The ID to search for.
Devuelve: The role or None if not found in the member’s roles.
Tipo del valor devuelto: Optional[Role]

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. This is a special case of Activity that makes it easier to work with the Spotify integration.

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: disnake.enums.ActivityType¶

Returns the activity’s type. This is for compatibility with Activity.

It always returns ActivityType.listening.

Type: ActivityType

property created_at: Optional[datetime.datetime]¶

When the user started listening in UTC.

Nuevo en la versión 1.3.

Type: Optional[datetime.datetime]

property colour: disnake.colour.Colour¶

Returns the Spotify integration colour, as a Colour.

There is an alias for this named color

Type: Colour

property color: disnake.colour.Colour¶

Returns the Spotify integration colour, as a Colour.

There is an alias for this named colour

Type: Colour

property name: str¶

The activity’s name. This will always return «Spotify».

Type: str

property title: str¶

The title of the song being played.

Type: str

property artists: List[str]¶

The artists of the song being played.

Type: List[str]

property artist: str¶

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: str¶

The album that the song being played belongs to.

Type: str

property album_cover_url: str¶

The album cover image URL from Spotify’s CDN.

Type: str

property track_id: str¶

The track ID used by Spotify to identify this song.

Type: str

property track_url: str¶

The track URL to listen on Spotify.

Nuevo en la versión 2.0.

Type: str

property start: datetime.datetime¶

When the user started playing this song in UTC.

Type: datetime.datetime

property end: datetime.datetime¶

When the user will stop playing this song in UTC.

Type: datetime.datetime

property duration: datetime.timedelta¶

The duration of the song being played.

Type: datetime.timedelta

property party_id: str¶

The party ID of the listening party.

Type: str

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¶

Indicates if the user is currently deafened by the guild.

Type: bool

mute¶

Indicates if the user is currently muted by the guild.

Type: bool

self_mute¶

Indicates if the user is currently muted by their own accord.

Type: bool

self_deaf¶

Indicates if the user is currently deafened by their own accord.

Type: bool

self_stream¶

Indicates if the user is currently streaming via “Go Live” feature.

Nuevo en la versión 1.3.

Type: bool

self_video¶

Indicates if the user is currently broadcasting video.

Type: bool

suppress¶

Indicates if the user is suppressed from speaking.

Only applies to stage channels.

Nuevo en la versión 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 applicable to stage channels.

Nuevo en la versión 1.7.

Type: Optional[datetime.datetime]

afk¶

Indicates if 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

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 disnake.

name¶

The name of the emoji.

Type: str

id¶

The emoji’s ID.

Type: int

require_colons¶

If colons are required to use this emoji in the client (:PJSalt: vs PJSalt).

Type: bool

animated¶

Whether an emoji is animated or not.

Type: bool

managed¶

If this 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 the manage_emojis permission.

Type: Optional[User]

property created_at: datetime¶

Returns the emoji’s creation time in UTC.

Type: datetime.datetime

property url: str¶

Returns the URL of the emoji.

Type: str

property roles: List[Role]¶

A list of roles that is allowed to use this emoji.

If roles is empty, the emoji is unrestricted.

Type: List[Role]

property guild: Guild¶

The guild this emoji belongs to.

Type: Guild

is_usable()¶: bool: Whether the bot can use this emoji.

Nuevo en la versión 1.3.

await delete(*, reason=None)¶

This function is a coroutine.

Deletes the custom emoji.

You must have manage_emojis permission to do this.

Parámetros

reason (Optional[str]) – The reason for deleting this emoji. Shows up on the audit log.

Muestra

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.

Distinto en la versión 2.0: The newly updated emoji is returned.

Parámetros

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.

Muestra

Forbidden – You are not allowed to edit emojis.
HTTPException – An error occurred editing the emoji.

Devuelve

The newly updated emoji.

Tipo del valor devuelto

Emoji

await read()¶

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Muestra

DiscordException – There was no internal connection state.
HTTPException – Downloading the asset failed.
NotFound – The asset was deleted.

Devuelve

The content of the asset.

Tipo del valor devuelto

await save(fp, *, seek_begin=True)¶

This function is a coroutine.

Saves this asset into a file-like object.

Parámetros

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.

Muestra

DiscordException – There was no internal connection state.
HTTPException – Downloading the asset failed.
NotFound – The asset was deleted.

Devuelve

The number of bytes written.

Tipo del valor devuelto

PartialEmoji¶

Attributes

animated
created_at
id
name
url

Methods

clsPartialEmoji.from_str
defis_custom_emoji
defis_unicode_emoji
asyncread
asyncsave

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 disnake.

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.

Nuevo en la versión 2.0.

Parámetros: value (str) – The string representation of an emoji.
Devuelve: The partial emoji from this string.
Tipo del valor devuelto: PartialEmoji

is_custom_emoji()¶: bool: Checks if this is a custom non-Unicode emoji.

is_unicode_emoji()¶: bool: Checks if this is a Unicode emoji.

property created_at: Optional[datetime]¶

Returns the emoji’s creation time in UTC, or None if Unicode emoji.

Nuevo en la versión 1.6.

Type: Optional[datetime.datetime]

property url: str¶

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 content of this asset as a bytes object.

Muestra

DiscordException – There was no internal connection state.
HTTPException – Downloading the asset failed.
NotFound – The asset was deleted.

Devuelve

The content of the asset.

Tipo del valor devuelto

await save(fp, *, seek_begin=True)¶

This function is a coroutine.

Saves this asset into a file-like object.

Parámetros

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.

Muestra

DiscordException – There was no internal connection state.
HTTPException – Downloading the asset failed.
NotFound – The asset was deleted.

Devuelve

The number of bytes written.

Tipo del valor devuelto

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_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 for 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.

Advertencia

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()¶: bool: Checks if the role is the default role.

is_bot_managed()¶: bool: Whether the role is associated with a bot.

Nuevo en la versión 1.6.

is_premium_subscriber()¶: bool: Whether the role is the premium subscriber, AKA «boost», role for the guild.

Nuevo en la versión 1.6.

is_integration()¶: bool: Whether the role is managed by an integration.

Nuevo en la versión 1.6.

is_assignable()¶: bool: Whether the role is able to be assigned or removed by the bot.

Nuevo en la versión 2.0.

property permissions: disnake.permissions.Permissions¶

Returns the role’s permissions.

Type: Permissions

property colour: disnake.colour.Colour¶

Returns the role colour. An alias exists under color.

Type: Colour

property color: disnake.colour.Colour¶

Returns the role color. An alias exists under colour.

Type: Colour

property icon: Optional[disnake.asset.Asset]¶

Returns the role’s icon asset, if available.

Nuevo en la versión 2.0.

Type: Optional[Asset]

property emoji: Optional[disnake.partial_emoji.PartialEmoji]¶

Returns the role’s emoji, if available.

Nuevo en la versión 2.0.

Type: Optional[PartialEmoji]

property created_at: datetime.datetime¶

Returns the role’s creation time in UTC.

Type: datetime.datetime

property mention: str¶

Returns a string that allows you to mention a role.

Type: str

property members: List[Member]¶

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.

Distinto en la versión 1.4: Can now pass int to colour keyword-only parameter.

Distinto en la versión 2.0: Edits are no longer in-place, the newly edited role is returned instead.

Parámetros

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 (bytes) – The role’s new icon image (if the guild has the ROLE_ICONS feature).
emoji (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.

Muestra

Forbidden – You do not have permissions to change the role.
HTTPException – Editing the role failed.
InvalidArgument – An invalid position was given or the default role was asked to be moved.

Devuelve

The newly edited role.

Tipo del valor devuelto

Role

await delete(*, reason=None)¶

This function is a coroutine.

Deletes the role.

You must have the manage_roles permission to use this.

Parámetros

reason (Optional[str]) – The reason for deleting this role. Shows up on the audit log.

Muestra

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_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.

Nuevo en la versión 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()¶: bool: Whether the role is associated with a bot.

is_premium_subscriber()¶: bool: Whether the role is the premium subscriber, AKA «boost», role for the guild.

is_integration()¶: bool: Whether the role is managed by an integration.

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 are 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.

Nuevo en la versión 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.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The message asked for.

Tipo del valor devuelto

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 read_message_history permissions to use this.

Ejemplos

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.

Parámetros

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[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[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[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.

Muestra

Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.

Campos

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.

Nota

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Muestra: HTTPException – Retrieving the pinned messages failed.
Devuelve: The messages that are currently pinned.
Tipo del valor devuelto: List[Message]

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). If the content is set to None (the default), then the embed parameter must be provided.

Parámetros

content (Optional[str]) – The content of the message to send.
tts (bool) – Indicates if the message should be sent using text-to-speech.
embed (Embed) – The rich embed for the content to send. This cannot be mixed with 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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.

Nuevo en la versión 2.0.
nonce (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.

Nuevo en la versión 1.4.
reference (Union[Message, MessageReference, PartialMessage]) –
A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

Nuevo en la versión 1.6.
mention_author (Optional[bool]) –
If set, overrides the replied_user attribute of allowed_mentions.

Nuevo en la versión 1.6.
view (disnake.ui.View) – A Discord UI View to add to the message.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size, you specified both file and files, or you specified both embed and embeds, or the reference object is not a Message, MessageReference or PartialMessage.

Devuelve

The message that was sent.

Tipo del valor devuelto

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.

Nota

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 message ID.

This is useful if you want to work with a message and only have its ID without doing an unnecessary API call.

Parámetros: message_id (int) – The message ID to create a partial message for.
Devuelve: The partial message.
Tipo del valor devuelto: PartialMessage

TextChannel¶

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 name.

Type: str

guild¶

The guild the channel belongs to.

Type: Guild

id¶

The channel 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 bypass slowmode.

Type: int

nsfw¶

If the channel is marked as «not safe for work».

Nota

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.

Nuevo en la versión 2.0.

Type: int

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 read_message_history permissions to use this.

Ejemplos

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.

Parámetros

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[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[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[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.

Muestra

Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.

Campos

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.

Nota

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: disnake.enums.ChannelType¶

The channel’s Discord type.

Type: ChannelType

permissions_for(obj, /)¶

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

Guild owner
Guild roles
Channel overrides
Member overrides

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

Distinto en la versión 2.0: The object passed in can now be a role object.

Parámetros: 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.
Devuelve: The resolved permissions for the member or role.
Tipo del valor devuelto: Permissions

property members: List[Member]¶

Returns all members that can see this channel.

Type: List[Member]

property threads: List[disnake.threads.Thread]¶

Returns all the threads that you can see.

Nuevo en la versión 2.0.

Type: List[Thread]

is_nsfw()¶: bool: Checks if the channel is NSFW.

is_news()¶: bool: Checks if the channel is a news channel.

property last_message: Optional[Message]¶

Fetches the last message from this channel in 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.

Devuelve: The last message in this channel or None if not found.
Tipo del valor devuelto: Optional[Message]

await edit(*, reason=None, **options)¶

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Distinto en la versión 1.3: The overwrites keyword-only parameter was added.

Distinto en la versión 1.4: The type keyword-only parameter was added.

Distinto en la versión 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parámetros

name (str) – The new channel name.
topic (str) – The new channel’s topic.
position (int) – The new channel’s position.
nsfw (bool) – To mark the channel as NSFW or not.
sync_permissions (bool) – Whether to sync permissions with the channel’s new or pre-existing category. Defaults to False.
category (Optional[CategoryChannel]) – The new category for this channel. Can be None to remove the category.
slowmode_delay (int) – Specifies the slowmode rate limit for user in this channel, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600.
type (ChannelType) – Change the 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.
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.
default_auto_archive_duration (int) – The new default auto archive duration in minutes for threads created in this channel. Must be one of 60, 1440, 4320, or 10080.

Muestra

InvalidArgument – If position is less than 0 or greater than the number of channels, or if the permission overwrite information is not in proper form.
Forbidden – You do not have permissions to edit the channel.
HTTPException – Editing the channel failed.

Devuelve

The newly edited text channel. If the edit was only positional then None is returned instead.

Tipo del valor devuelto

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 the manage_channels permission to do this.

Nuevo en la versión 1.1.

Parámetros

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.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.

Devuelve

The channel that was created.

Tipo del valor devuelto

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.

Parámetros

messages (Iterable[abc.Snowflake]) – An iterable of messages denoting which ones to bulk delete.

Muestra

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 the manage_messages permission to delete messages even if they are your own. The read_message_history permission is also needed to retrieve message history.

Ejemplos

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)')

Parámetros

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.

Muestra

Forbidden – You do not have proper permissions to do the actions required.
HTTPException – Purging the messages failed.

Devuelve

The list of messages that were deleted.

Tipo del valor devuelto

List[Message]

await webhooks()¶

This function is a coroutine.

Gets the list of webhooks from this channel.

Requires manage_webhooks permissions.

Muestra: Forbidden – You don’t have permissions to get the webhooks.
Devuelve: The webhooks for this channel.
Tipo del valor devuelto: List[Webhook]

await create_webhook(*, name, avatar=None, reason=None)¶

This function is a coroutine.

Creates a webhook for this channel.

Requires manage_webhooks permissions.

Distinto en la versión 1.1: Added the reason keyword-only parameter.

Parámetros

name (str) – The webhook’s name.
avatar (Optional[bytes]) – A bytes-like object representing 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.

Muestra

HTTPException – Creating the webhook failed.
Forbidden – You do not have permissions to create a webhook.

Devuelve

The created webhook.

Tipo del valor devuelto

await follow(*, destination, reason=None)¶

Follows a channel using a webhook.

Only news channels can be followed.

Nota

The webhook returned will not provide a token to do webhook actions, as Discord does not provide it.

Nuevo en la versión 1.3.

Parámetros

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.

Nuevo en la versión 1.4.

Muestra

HTTPException – Following the channel failed.
Forbidden – You do not have the permissions to create a webhook.

Devuelve

The created webhook.

Tipo del valor devuelto

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.

Nuevo en la versión 1.6.

Parámetros: message_id (int) – The message ID to create a partial message for.
Devuelve: The partial message.
Tipo del valor devuelto: PartialMessage

get_thread(thread_id, /)¶

Returns a thread with the given ID.

Nuevo en la versión 2.0.

Parámetros: thread_id (int) – The ID to search for.
Devuelve: The returned thread or None if not found.
Tipo del valor devuelto: Optional[Thread]

await create_thread(*, name, message=None, auto_archive_duration=..., type=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. For a private thread, create_private_threads is needed instead.

Nuevo en la versión 2.0.

Parámetros

name (str) – The name of the thread.
message (Optional[abc.Snowflake]) – A snowflake representing the message to create the thread with. If None is passed then a private thread is created. Defaults to None.
auto_archive_duration (int) – The duration in minutes before a thread is automatically archived for inactivity. If not provided, the channel’s default auto archive duration is used.
type (Optional[ChannelType]) – The type of thread to create. If a message is passed then this parameter is ignored, as a thread created with a message is always a public thread. By default this creates a private thread if this is None.
reason (str) – The reason for creating a new thread. Shows up on the audit log.

Muestra

Forbidden – You do not have permissions to create a thread.
HTTPException – Starting the thread failed.

Devuelve

The created thread

Tipo del valor devuelto

Thread

archived_threads(*, private=False, joined=False, limit=50, before=None)¶

Returns an AsyncIterator that iterates over all archived threads in the guild.

You must have read_message_history to use this. If iterating over private threads then manage_threads is also required.

Nuevo en la versión 2.0.

Parámetros

limit (Optional[bool]) – 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.

Muestra

Forbidden – You do not have permissions to get archived threads.
HTTPException – The request to get the archived threads failed.

Campos

Thread – The archived threads.

property category: Optional[CategoryChannel]¶

The category this channel belongs to.

If there is no category then this is None.

Type: Optional[CategoryChannel]

property changed_roles: List[disnake.role.Role]¶

Returns a list of roles that have been overridden from their default values in the 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)¶

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have the create_instant_invite permission to do this.

Parámetros

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) – Denotes that the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.
unique (bool) – Indicates if a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.
reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.
target_type (Optional[InviteTarget]) –
The type of target for the voice channel invite, if any.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
target_application (Optional[PartyType]) –
The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

Nuevo en la versión 2.0.

Muestra

HTTPException – Invite creation failed.
NotFound – The channel that was passed is a category or an invalid channel.

Devuelve

The invite that was created.

Tipo del valor devuelto

property created_at: datetime¶

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 manage_channels permission to use this.

Parámetros

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Muestra

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.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The message asked for.

Tipo del valor devuelto

await invites()¶

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have manage_channels to get this information.

Muestra

Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.

Devuelve

The list of invites that are currently active.

Tipo del valor devuelto

List[Invite]

property mention: str¶

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 the manage_channels permission to do this.

Nota

Voice channels will always be sorted below text channels. This is a Discord limitation.

Nuevo en la versión 1.7.

Parámetros

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 (Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.
after (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[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 (str) – The reason for the move.

Muestra

InvalidArgument – An invalid position was given or a bad mix of arguments were passed.
Forbidden – You do not have permissions to move the channel.
HTTPException – Moving the channel failed.

property overwrites: Dict[Union[Role, Member], PermissionOverwrite]¶

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.

Devuelve: The channel’s permission overwrites.
Tipo del valor devuelto: Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)¶

Returns the channel-specific overwrites for a member or a role.

Parámetros: obj (Union[Role, User]) – The role or user denoting whose overwrite to get.
Devuelve: The permission overwrites for this object.
Tipo del valor devuelto: PermissionOverwrite

property permissions_synced: bool¶

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.

Nuevo en la versión 1.3.

Type: bool

await pins()¶

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Nota

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Muestra: HTTPException – Retrieving the pinned messages failed.
Devuelve: The messages that are currently pinned.
Tipo del valor devuelto: List[Message]

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). If the content is set to None (the default), then the embed parameter must be provided.

Parámetros

content (Optional[str]) – The content of the message to send.
tts (bool) – Indicates if the message should be sent using text-to-speech.
embed (Embed) – The rich embed for the content to send. This cannot be mixed with 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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.

Nuevo en la versión 2.0.
nonce (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.

Nuevo en la versión 1.4.
reference (Union[Message, MessageReference, PartialMessage]) –
A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

Nuevo en la versión 1.6.
mention_author (Optional[bool]) –
If set, overrides the replied_user attribute of allowed_mentions.

Nuevo en la versión 1.6.
view (disnake.ui.View) – A Discord UI View to add to the message.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size, you specified both file and files, or you specified both embed and embeds, or the reference object is not a Message, MessageReference or PartialMessage.

Devuelve

The message that was sent.

Tipo del valor devuelto

await set_permissions(target, *, overwrite=see - below, 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.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have the manage_roles permission to use this.

Nota

This method replaces the old overwrites with the ones given.

Ejemplos

Setting allow and deny:

await message.channel.set_permissions(message.author, read_messages=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parámetros

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.

Muestra

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.
InvalidArgument – The overwrite parameter invalid or the target type was not Role or Member.

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¶

Methods

asyncadd_user
asyncdelete
asyncdelete_messages
asyncedit
asyncfetch_member
asyncfetch_members
asyncfetch_message
defget_partial_message
defhistory
defis_news
defis_nsfw
defis_private
asyncjoin
asyncleave
defpermissions_for
asyncpins
asyncpurge
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.

Nuevo en la versión 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 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. This caps at 50.

Type: Optional[int]

member_count¶

An approximate number of members in this thread. This caps at 50.

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

archiver_id¶

The user’s ID that archived this thread.

Type: Optional[int]

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

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 read_message_history permissions to use this.

Ejemplos

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.

Parámetros

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[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[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[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.

Muestra

Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.

Campos

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.

Nota

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: disnake.enums.ChannelType¶

The channel’s Discord type.

Type: ChannelType

property parent: Optional[TextChannel]¶

The parent channel this thread belongs to.

Type: Optional[TextChannel]

property owner: Optional[Member]¶

The member this thread belongs to.

Type: Optional[Member]

property mention: str¶

The string that allows you to mention the thread.

Type: str

property members: List[disnake.threads.ThreadMember]¶

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: Optional[Message]¶

Fetches the last message from this channel in 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.

Devuelve: The last message in this channel or None if not found.
Tipo del valor devuelto: Optional[Message]

property category: Optional[CategoryChannel]¶

The category channel the parent channel belongs to, if applicable.

Muestra: ClientException – The parent channel was not cached and returned None.
Devuelve: The parent channel’s category.
Tipo del valor devuelto: Optional[CategoryChannel]

property category_id: Optional[int]¶

The category channel ID the parent channel belongs to, if applicable.

Muestra: ClientException – The parent channel was not cached and returned None.
Devuelve: The parent channel’s category ID.
Tipo del valor devuelto: Optional[int]

property created_at: datetime.datetime¶

Returns the thread’s creation time in UTC.

Type: datetime.datetime

is_private()¶

bool: Whether the thread is a private thread.

A private thread is only viewable by those that have been explicitly invited or have manage_threads.

is_news()¶

bool: 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.

is_nsfw()¶

bool: 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.

permissions_for(obj, /)¶

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.

Parámetros: 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.
Muestra: ClientException – The parent channel was not cached and returned None
Devuelve: The resolved permissions for the member or role.
Tipo del valor devuelto: 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.

Parámetros

messages (Iterable[abc.Snowflake]) – An iterable of messages denoting which ones to bulk delete.

Muestra

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.

Ejemplos

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)')

Parámetros

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.

Muestra

Forbidden – You do not have proper permissions to do the actions required.
HTTPException – Purging the messages failed.

Devuelve

The list of messages that were deleted.

Tipo del valor devuelto

List[Message]

await edit(*, name=..., archived=..., locked=..., invitable=..., slowmode_delay=..., auto_archive_duration=...)¶

This function is a coroutine.

Edits the thread.

Editing the thread requires Permissions.manage_threads. The thread creator can also edit name, archived or auto_archive_duration. 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.

Parámetros

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 (int) – 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 user in this thread, in seconds. A value of 0 disables slowmode. The maximum value possible is 21600.

Muestra

Forbidden – You do not have permissions to edit the thread.
HTTPException – Editing the thread failed.

Devuelve

The newly edited thread.

Tipo del valor devuelto

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.

Muestra

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.

Muestra: 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 and use_threads to add a user to a public thread. If the thread is private then send_messages and either use_private_threads or manage_messages is required to add a user to the thread.

Parámetros

user (abc.Snowflake) – The user to add to the thread.

Muestra

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.

Parámetros

user (abc.Snowflake) – The user to add to the thread.

Muestra

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.

Retrieve a single ThreadMember from this thread.

Parámetros

member_id (int) – The ID of the member to fetch.

Muestra

NotFound – The specified member was not found.
HTTPException – Retrieving the member failed.

Devuelve

The thread member asked for.

Tipo del valor devuelto

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.

Muestra: HTTPException – Retrieving the members failed.
Devuelve: All thread members in the thread.
Tipo del valor devuelto: List[ThreadMember]

await delete()¶

This function is a coroutine.

Deletes this thread.

You must have manage_threads to delete threads.

Muestra

Forbidden – You do not have permissions to delete this thread.
HTTPException – Deleting 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.

Nuevo en la versión 2.0.

Parámetros: message_id (int) – The message ID to create a partial message for.
Devuelve: The partial message.
Tipo del valor devuelto: PartialMessage

await fetch_message(id, /)¶

This function is a coroutine.

Retrieves a single Message from the destination.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The message asked for.

Tipo del valor devuelto

await pins()¶

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Nota

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Muestra: HTTPException – Retrieving the pinned messages failed.
Devuelve: The messages that are currently pinned.
Tipo del valor devuelto: List[Message]

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). If the content is set to None (the default), then the embed parameter must be provided.

Parámetros

content (Optional[str]) – The content of the message to send.
tts (bool) – Indicates if the message should be sent using text-to-speech.
embed (Embed) – The rich embed for the content to send. This cannot be mixed with 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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.

Nuevo en la versión 2.0.
nonce (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.

Nuevo en la versión 1.4.
reference (Union[Message, MessageReference, PartialMessage]) –
A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

Nuevo en la versión 1.6.
mention_author (Optional[bool]) –
If set, overrides the replied_user attribute of allowed_mentions.

Nuevo en la versión 1.6.
view (disnake.ui.View) – A Discord UI View to add to the message.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size, you specified both file and files, or you specified both embed and embeds, or the reference object is not a Message, MessageReference or PartialMessage.

Devuelve

The message that was sent.

Tipo del valor devuelto

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.

Nuevo en la versión 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: disnake.threads.Thread¶

The thread this member belongs to.

Type: Thread

StoreChannel¶

Attributes

category
category_id
changed_roles
created_at
guild
id
mention
name
nsfw
overwrites
permissions_synced
position
type

Methods

asyncclone
asynccreate_invite
asyncdelete
asyncedit
asyncinvites
defis_nsfw
asyncmove
defoverwrites_for
defpermissions_for
asyncset_permissions

class disnake.StoreChannel¶

Represents a Discord guild store 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 name.

Type: str

guild¶

The guild the channel belongs to.

Type: Guild

id¶

The channel ID.

Type: int

category_id¶

The category channel ID this channel belongs to.

Type: 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¶

If the channel is marked as «not safe for work».

Nota

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Type: bool

property type: disnake.enums.ChannelType¶

The channel’s Discord type.

Type: ChannelType

permissions_for(obj, /)¶

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

Guild owner
Guild roles
Channel overrides
Member overrides

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

Distinto en la versión 2.0: The object passed in can now be a role object.

Parámetros: 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.
Devuelve: The resolved permissions for the member or role.
Tipo del valor devuelto: Permissions

is_nsfw()¶: bool: Checks if the channel is NSFW.

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 the manage_channels permission to do this.

Nuevo en la versión 1.1.

Parámetros

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.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.

Devuelve

The channel that was created.

Tipo del valor devuelto

await edit(*, reason=None, **options)¶

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Distinto en la versión 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parámetros

name (str) – The new channel name.
position (int) – The new channel’s position.
nsfw (bool) – To mark the channel as NSFW or not.
sync_permissions (bool) – Whether to sync permissions with the channel’s new or pre-existing category. Defaults to False.
category (Optional[CategoryChannel]) – 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.

Nuevo en la versión 1.3.

Muestra

InvalidArgument – If position is less than 0 or greater than the number of channels, or if the permission overwrite information is not in proper form.
Forbidden – You do not have permissions to edit the channel.
HTTPException – Editing the channel failed.

Devuelve

The newly edited store channel. If the edit was only positional then None is returned instead.

Tipo del valor devuelto

Optional[StoreChannel]

property category: Optional[CategoryChannel]¶

The category this channel belongs to.

If there is no category then this is None.

Type: Optional[CategoryChannel]

property changed_roles: List[disnake.role.Role]¶

Returns a list of roles that have been overridden from their default values in the 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)¶

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have the create_instant_invite permission to do this.

Parámetros

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) – Denotes that the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.
unique (bool) – Indicates if a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.
reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.
target_type (Optional[InviteTarget]) –
The type of target for the voice channel invite, if any.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
target_application (Optional[PartyType]) –
The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

Nuevo en la versión 2.0.

Muestra

HTTPException – Invite creation failed.
NotFound – The channel that was passed is a category or an invalid channel.

Devuelve

The invite that was created.

Tipo del valor devuelto

property created_at: datetime¶

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 manage_channels permission to use this.

Parámetros

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Muestra

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 invites()¶

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have manage_channels to get this information.

Muestra

Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.

Devuelve

The list of invites that are currently active.

Tipo del valor devuelto

List[Invite]

property mention: str¶

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 the manage_channels permission to do this.

Nota

Voice channels will always be sorted below text channels. This is a Discord limitation.

Nuevo en la versión 1.7.

Parámetros

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 (Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.
after (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[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 (str) – The reason for the move.

Muestra

InvalidArgument – An invalid position was given or a bad mix of arguments were passed.
Forbidden – You do not have permissions to move the channel.
HTTPException – Moving the channel failed.

property overwrites: Dict[Union[Role, Member], PermissionOverwrite]¶

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.

Devuelve: The channel’s permission overwrites.
Tipo del valor devuelto: Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)¶

Returns the channel-specific overwrites for a member or a role.

Parámetros: obj (Union[Role, User]) – The role or user denoting whose overwrite to get.
Devuelve: The permission overwrites for this object.
Tipo del valor devuelto: PermissionOverwrite

property permissions_synced: bool¶

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.

Nuevo en la versión 1.3.

Type: bool

await set_permissions(target, *, overwrite=see - below, 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.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have the manage_roles permission to use this.

Nota

This method replaces the old overwrites with the ones given.

Ejemplos

Setting allow and deny:

await message.channel.set_permissions(message.author, read_messages=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parámetros

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.

Muestra

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.
InvalidArgument – The overwrite parameter invalid or the target type was not Role or Member.

VoiceChannel¶

Attributes

bitrate
category
category_id
changed_roles
created_at
guild
id
members
mention
name
overwrites
permissions_synced
position
rtc_region
type
user_limit
video_quality_mode
voice_states

Methods

asyncclone
asyncconnect
asynccreate_invite
asyncdelete
asyncedit
asyncinvites
asyncmove
defoverwrites_for
defpermissions_for
asyncset_permissions

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 name.

Type: str

guild¶

The guild the channel belongs to.

Type: Guild

id¶

The channel 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.

Nuevo en la versión 1.7.

Type: Optional[VoiceRegion]

video_quality_mode¶

The camera video quality for the voice channel’s participants.

Type: VideoQualityMode

property type: disnake.enums.ChannelType¶

The channel’s Discord type.

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 the manage_channels permission to do this.

Nuevo en la versión 1.1.

Parámetros

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.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.

Devuelve

The channel that was created.

Tipo del valor devuelto

await edit(*, reason=None, **options)¶

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Distinto en la versión 1.3: The overwrites keyword-only parameter was added.

Distinto en la versión 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parámetros

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[CategoryChannel]) – 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[VoiceRegion]) –
The new region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

Nuevo en la versión 1.7.
video_quality_mode (VideoQualityMode) –
The camera video quality for the voice channel’s participants.

Nuevo en la versión 2.0.

Muestra

InvalidArgument – If the permission overwrite information is not in proper form.
Forbidden – You do not have permissions to edit the channel.
HTTPException – Editing the channel failed.

Devuelve

The newly edited voice channel. If the edit was only positional then None is returned instead.

Tipo del valor devuelto

Optional[VoiceChannel]

property category: Optional[CategoryChannel]¶

The category this channel belongs to.

If there is no category then this is None.

Type: Optional[CategoryChannel]

property changed_roles: List[disnake.role.Role]¶

Returns a list of roles that have been overridden from their default values in the 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.

Parámetros

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.

Muestra

asyncio.TimeoutError – Could not connect to the voice channel in time.
ClientException – You are already connected to a voice channel.
OpusNotLoaded – The opus library has not been loaded.

Devuelve

A voice client that is fully connected to the voice server.

Tipo del valor devuelto

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)¶

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have the create_instant_invite permission to do this.

Parámetros

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) – Denotes that the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.
unique (bool) – Indicates if a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.
reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.
target_type (Optional[InviteTarget]) –
The type of target for the voice channel invite, if any.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
target_application (Optional[PartyType]) –
The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

Nuevo en la versión 2.0.

Muestra

HTTPException – Invite creation failed.
NotFound – The channel that was passed is a category or an invalid channel.

Devuelve

The invite that was created.

Tipo del valor devuelto

property created_at: datetime¶

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 manage_channels permission to use this.

Parámetros

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Muestra

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 invites()¶

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have manage_channels to get this information.

Muestra

Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.

Devuelve

The list of invites that are currently active.

Tipo del valor devuelto

List[Invite]

property members: List[Member]¶

Returns all members that are currently inside this voice channel.

Type: List[Member]

property mention: str¶

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 the manage_channels permission to do this.

Nota

Voice channels will always be sorted below text channels. This is a Discord limitation.

Nuevo en la versión 1.7.

Parámetros

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 (Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.
after (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[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 (str) – The reason for the move.

Muestra

InvalidArgument – An invalid position was given or a bad mix of arguments were passed.
Forbidden – You do not have permissions to move the channel.
HTTPException – Moving the channel failed.

property overwrites: Dict[Union[Role, Member], PermissionOverwrite]¶

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.

Devuelve: The channel’s permission overwrites.
Tipo del valor devuelto: Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)¶

Returns the channel-specific overwrites for a member or a role.

Parámetros: obj (Union[Role, User]) – The role or user denoting whose overwrite to get.
Devuelve: The permission overwrites for this object.
Tipo del valor devuelto: PermissionOverwrite

permissions_for(obj, /)¶

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

Guild owner
Guild roles
Channel overrides
Member overrides

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

Distinto en la versión 2.0: The object passed in can now be a role object.

Parámetros: 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.
Devuelve: The resolved permissions for the member or role.
Tipo del valor devuelto: Permissions

property permissions_synced: bool¶

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.

Nuevo en la versión 1.3.

Type: bool

await set_permissions(target, *, overwrite=see - below, 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.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have the manage_roles permission to use this.

Nota

This method replaces the old overwrites with the ones given.

Ejemplos

Setting allow and deny:

await message.channel.set_permissions(message.author, read_messages=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parámetros

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.

Muestra

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.
InvalidArgument – The overwrite parameter invalid or the target type was not Role or Member.

property voice_states: Dict[int, VoiceState]¶

Returns a mapping of member IDs who have voice states in this channel.

Nuevo en la versión 1.3.

Nota

This function is intentionally low level to replace members when the member cache is unavailable.

Devuelve: The mapping of member ID to a voice state.
Tipo del valor devuelto: Mapping[int, VoiceState]

StageChannel¶

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.

Nuevo en la versión 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 name.

Type: str

guild¶

The guild the channel belongs to.

Type: Guild

id¶

The channel 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.

Type: Optional[VoiceRegion]

video_quality_mode¶

The camera video quality for the stage channel’s participants.

Nuevo en la versión 2.0.

Type: VideoQualityMode

property requesting_to_speak: List[Member]¶

A list of members who are requesting to speak in the stage channel.

Type: List[Member]

property speakers: List[Member]¶

A list of members who have been permitted to speak in the stage channel.

Nuevo en la versión 2.0.

Type: List[Member]

property listeners: List[Member]¶

A list of members who are listening in the stage channel.

Nuevo en la versión 2.0.

Type: List[Member]

property moderators: List[Member]¶

A list of members who are moderating the stage channel.

Nuevo en la versión 2.0.

Type: List[Member]

property type: disnake.enums.ChannelType¶

The channel’s Discord type.

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 the manage_channels permission to do this.

Nuevo en la versión 1.1.

Parámetros

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.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.

Devuelve

The channel that was created.

Tipo del valor devuelto

property instance: Optional[disnake.stage_instance.StageInstance]¶

The running stage instance of the stage channel.

Nuevo en la versión 2.0.

Type: Optional[StageInstance]

await create_instance(*, topic, privacy_level=..., reason=None)¶

This function is a coroutine.

Create a stage instance.

You must have the manage_channels permission to use this.

Nuevo en la versión 2.0.

Parámetros

topic (str) – The stage instance’s topic.
privacy_level (StagePrivacyLevel) – The stage instance’s privacy level. Defaults to StagePrivacyLevel.guild_only.
reason (str) – The reason the stage instance was created. Shows up on the audit log.

Muestra

InvalidArgument – If the privacy_level parameter is not the proper type.
Forbidden – You do not have permissions to create a stage instance.
HTTPException – Creating a stage instance failed.

Devuelve

The newly created stage instance.

Tipo del valor devuelto

StageInstance

await fetch_instance()¶

This function is a coroutine.

Gets the running StageInstance.

Nuevo en la versión 2.0.

Muestra

NotFound – The stage instance or channel could not be found.
HTTPException – Getting the stage instance failed.

Devuelve

The stage instance.

Tipo del valor devuelto

StageInstance

await edit(*, reason=None, **options)¶

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Distinto en la versión 2.0: The topic parameter must now be set via create_instance.

Distinto en la versión 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parámetros

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[CategoryChannel]) – 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[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.

Nuevo en la versión 2.0.

Muestra

InvalidArgument – If the permission overwrite information is not in proper form.
Forbidden – You do not have permissions to edit the channel.
HTTPException – Editing the channel failed.

Devuelve

The newly edited stage channel. If the edit was only positional then None is returned instead.

Tipo del valor devuelto

Optional[StageChannel]

property category: Optional[CategoryChannel]¶

The category this channel belongs to.

If there is no category then this is None.

Type: Optional[CategoryChannel]

property changed_roles: List[disnake.role.Role]¶

Returns a list of roles that have been overridden from their default values in the 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.

Parámetros

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.

Muestra

asyncio.TimeoutError – Could not connect to the voice channel in time.
ClientException – You are already connected to a voice channel.
OpusNotLoaded – The opus library has not been loaded.

Devuelve

A voice client that is fully connected to the voice server.

Tipo del valor devuelto

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)¶

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have the create_instant_invite permission to do this.

Parámetros

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) – Denotes that the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.
unique (bool) – Indicates if a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.
reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.
target_type (Optional[InviteTarget]) –
The type of target for the voice channel invite, if any.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
target_application (Optional[PartyType]) –
The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

Nuevo en la versión 2.0.

Muestra

HTTPException – Invite creation failed.
NotFound – The channel that was passed is a category or an invalid channel.

Devuelve

The invite that was created.

Tipo del valor devuelto

property created_at: datetime¶

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 manage_channels permission to use this.

Parámetros

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Muestra

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 invites()¶

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have manage_channels to get this information.

Muestra

Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.

Devuelve

The list of invites that are currently active.

Tipo del valor devuelto

List[Invite]

property members: List[Member]¶

Returns all members that are currently inside this voice channel.

Type: List[Member]

property mention: str¶

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 the manage_channels permission to do this.

Nota

Voice channels will always be sorted below text channels. This is a Discord limitation.

Nuevo en la versión 1.7.

Parámetros

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 (Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.
after (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[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 (str) – The reason for the move.

Muestra

InvalidArgument – An invalid position was given or a bad mix of arguments were passed.
Forbidden – You do not have permissions to move the channel.
HTTPException – Moving the channel failed.

property overwrites: Dict[Union[Role, Member], PermissionOverwrite]¶

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.

Devuelve: The channel’s permission overwrites.
Tipo del valor devuelto: Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)¶

Returns the channel-specific overwrites for a member or a role.

Parámetros: obj (Union[Role, User]) – The role or user denoting whose overwrite to get.
Devuelve: The permission overwrites for this object.
Tipo del valor devuelto: PermissionOverwrite

permissions_for(obj, /)¶

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

Guild owner
Guild roles
Channel overrides
Member overrides

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

Distinto en la versión 2.0: The object passed in can now be a role object.

Parámetros: 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.
Devuelve: The resolved permissions for the member or role.
Tipo del valor devuelto: Permissions

property permissions_synced: bool¶

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.

Nuevo en la versión 1.3.

Type: bool

await set_permissions(target, *, overwrite=see - below, 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.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have the manage_roles permission to use this.

Nota

This method replaces the old overwrites with the ones given.

Ejemplos

Setting allow and deny:

await message.channel.set_permissions(message.author, read_messages=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parámetros

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.

Muestra

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.
InvalidArgument – The overwrite parameter invalid or the target type was not Role or Member.

property voice_states: Dict[int, VoiceState]¶

Returns a mapping of member IDs who have voice states in this channel.

Nuevo en la versión 1.3.

Nota

This function is intentionally low level to replace members when the member cache is unavailable.

Devuelve: The mapping of member ID to a voice state.
Tipo del valor devuelto: Mapping[int, VoiceState]

StageInstance¶

Attributes

channel
channel_id
discoverable_disabled
guild
id
privacy_level
topic

Methods

asyncdelete
asyncedit

class disnake.StageInstance¶

Represents a stage instance of a stage channel in a guild.

Nuevo en la versión 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

discoverable_disabled¶

Whether discoverability for the stage instance is disabled.

Type: bool

channel¶

The channel that stage instance is running in.

Type: Optional[StageChannel]

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.

Parámetros

topic (str) – The stage instance’s new topic.
privacy_level (StagePrivacyLevel) – The stage instance’s new privacy level.
reason (str) – The reason the stage instance was edited. Shows up on the audit log.

Muestra

InvalidArgument – 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.

Parámetros

reason (str) – The reason the stage instance was deleted. Shows up on the audit log.

Muestra

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
guild
id
mention
name
nsfw
overwrites
permissions_synced
position
stage_channels
text_channels
type
voice_channels

Methods

asyncclone
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».

Nota

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Type: bool

property type: disnake.enums.ChannelType¶

The channel’s Discord type.

Type: ChannelType

is_nsfw()¶: bool: Checks if the category is NSFW.

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 the manage_channels permission to do this.

Nuevo en la versión 1.1.

Parámetros

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.

Muestra

Forbidden – You do not have the proper permissions to create this channel.
HTTPException – Creating the channel failed.

Devuelve

The channel that was created.

Tipo del valor devuelto

await edit(*, reason=None, **options)¶

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Distinto en la versión 1.3: The overwrites keyword-only parameter was added.

Distinto en la versión 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parámetros

name (str) – The new category’s name.
position (int) – The new category’s position.
nsfw (bool) – To mark the category as NSFW or not.
reason (Optional[str]) – The reason for editing this category. 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.

Muestra

InvalidArgument – If position is less than 0 or greater than the number of categories.
Forbidden – You do not have permissions to edit the category.
HTTPException – Editing the category failed.

Devuelve

The newly edited category channel. If the edit was only positional then None is returned instead.

Tipo del valor devuelto

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 the manage_channels permission to do this.

Nota

Voice channels will always be sorted below text channels. This is a Discord limitation.

Nuevo en la versión 1.7.

Parámetros

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 (Snowflake) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.
after (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[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 (str) – The reason for the move.

Muestra

InvalidArgument – An invalid position was given or a bad mix of arguments were passed.
Forbidden – You do not have permissions to move the channel.
HTTPException – Moving the channel failed.

property channels: List[GuildChannelType]¶

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: List[disnake.channel.TextChannel]¶

Returns the text channels that are under this category.

Type: List[TextChannel]

property voice_channels: List[disnake.channel.VoiceChannel]¶

Returns the voice channels that are under this category.

Type: List[VoiceChannel]

property stage_channels: List[disnake.channel.StageChannel]¶

Returns the stage channels that are under this category.

Nuevo en la versión 1.7.

Type: List[StageChannel]

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.

Devuelve: The channel that was just created.
Tipo del valor devuelto: 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.

Devuelve: The channel that was just created.
Tipo del valor devuelto: 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.

Nuevo en la versión 1.7.

Devuelve: The channel that was just created.
Tipo del valor devuelto: StageChannel

property category: Optional[CategoryChannel]¶

The category this channel belongs to.

If there is no category then this is None.

Type: Optional[CategoryChannel]

property changed_roles: List[disnake.role.Role]¶

Returns a list of roles that have been overridden from their default values in the 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)¶

This function is a coroutine.

Creates an instant invite from a text or voice channel.

You must have the create_instant_invite permission to do this.

Parámetros

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) – Denotes that the invite grants temporary membership (i.e. they get kicked after they disconnect). Defaults to False.
unique (bool) – Indicates if a unique invite URL should be created. Defaults to True. If this is set to False then it will return a previously created invite.
reason (Optional[str]) – The reason for creating this invite. Shows up on the audit log.
target_type (Optional[InviteTarget]) –
The type of target for the voice channel invite, if any.

Nuevo en la versión 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.

Nuevo en la versión 2.0.
target_application (Optional[PartyType]) –
The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

Nuevo en la versión 2.0.

Muestra

HTTPException – Invite creation failed.
NotFound – The channel that was passed is a category or an invalid channel.

Devuelve

The invite that was created.

Tipo del valor devuelto

property created_at: datetime¶

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 manage_channels permission to use this.

Parámetros

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Muestra

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 invites()¶

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have manage_channels to get this information.

Muestra

Forbidden – You do not have proper permissions to get the information.
HTTPException – An error occurred while fetching the information.

Devuelve

The list of invites that are currently active.

Tipo del valor devuelto

List[Invite]

property mention: str¶

The string that allows you to mention the channel.

Type: str

property overwrites: Dict[Union[Role, Member], PermissionOverwrite]¶

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.

Devuelve: The channel’s permission overwrites.
Tipo del valor devuelto: Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)¶

Returns the channel-specific overwrites for a member or a role.

Parámetros: obj (Union[Role, User]) – The role or user denoting whose overwrite to get.
Devuelve: The permission overwrites for this object.
Tipo del valor devuelto: PermissionOverwrite

permissions_for(obj, /)¶

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

Guild owner
Guild roles
Channel overrides
Member overrides

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

Distinto en la versión 2.0: The object passed in can now be a role object.

Parámetros: 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.
Devuelve: The resolved permissions for the member or role.
Tipo del valor devuelto: Permissions

property permissions_synced: bool¶

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.

Nuevo en la versión 1.3.

Type: bool

await set_permissions(target, *, overwrite=see - below, 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.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have the manage_roles permission to use this.

Nota

This method replaces the old overwrites with the ones given.

Ejemplos

Setting allow and deny:

await message.channel.set_permissions(message.author, read_messages=True,
                                                      send_messages=False)

Deleting overwrites

await channel.set_permissions(member, overwrite=None)

overwrite = disnake.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parámetros

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.

Muestra

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.
InvalidArgument – The overwrite parameter invalid or the target type was not Role or Member.

DMChannel¶

Attributes

created_at
id
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

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 read_message_history permissions to use this.

Ejemplos

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.

Parámetros

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[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[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[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.

Muestra

Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.

Campos

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.

Nota

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: disnake.enums.ChannelType¶

The channel’s Discord type.

Type: ChannelType

property created_at: datetime.datetime¶

Returns the direct message channel’s creation time in UTC.

Type: datetime.datetime

permissions_for(obj=None, /)¶

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 Text related permissions set to True except:

send_tts_messages: You cannot send TTS messages in a DM.
manage_messages: You cannot delete others messages in a DM.

Parámetros: obj (User) – The user to check permissions for. This parameter is ignored but kept for compatibility with other permissions_for methods.
Devuelve: The resolved permissions.
Tipo del valor devuelto: Permissions

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.

Nuevo en la versión 1.6.

Parámetros: message_id (int) – The message ID to create a partial message for.
Devuelve: The partial message.
Tipo del valor devuelto: PartialMessage

await fetch_message(id, /)¶

This function is a coroutine.

Retrieves a single Message from the destination.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The message asked for.

Tipo del valor devuelto

await pins()¶

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Nota

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Muestra: HTTPException – Retrieving the pinned messages failed.
Devuelve: The messages that are currently pinned.
Tipo del valor devuelto: List[Message]

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). If the content is set to None (the default), then the embed parameter must be provided.

Parámetros

content (Optional[str]) – The content of the message to send.
tts (bool) – Indicates if the message should be sent using text-to-speech.
embed (Embed) – The rich embed for the content to send. This cannot be mixed with 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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.

Nuevo en la versión 2.0.
nonce (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.

Nuevo en la versión 1.4.
reference (Union[Message, MessageReference, PartialMessage]) –
A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

Nuevo en la versión 1.6.
mention_author (Optional[bool]) –
If set, overrides the replied_user attribute of allowed_mentions.

Nuevo en la versión 1.6.
view (disnake.ui.View) – A Discord UI View to add to the message.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size, you specified both file and files, or you specified both embed and embeds, or the reference object is not a Message, MessageReference or PartialMessage.

Devuelve

The message that was sent.

Tipo del valor devuelto

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.

Nuevo en la versión 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 read_message_history permissions to use this.

Ejemplos

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.

Parámetros

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[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[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[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.

Muestra

Forbidden – You do not have permissions to get channel message history.
HTTPException – The request to get message history failed.

Campos

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.

Nota

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: disnake.enums.ChannelType¶

The channel’s Discord type.

Type: ChannelType

property icon: Optional[disnake.asset.Asset]¶

Returns the channel’s icon asset if available.

Type: Optional[Asset]

property created_at: datetime.datetime¶

Returns the channel’s creation time in UTC.

Type: datetime.datetime

permissions_for(obj, /)¶

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 Text related permissions set to True except:

send_tts_messages: You cannot send TTS messages in a DM.
manage_messages: You cannot delete others messages in a DM.

This also checks the kick_members permission if the user is the owner.

Parámetros: obj (Snowflake) – The user to check permissions for.
Devuelve: The resolved permissions for the user.
Tipo del valor devuelto: Permissions

await leave()¶

This function is a coroutine.

Leave the group.

If you are the only one in the group, this deletes it as well.

Muestra: HTTPException – Leaving the group failed.

await fetch_message(id, /)¶

This function is a coroutine.

Retrieves a single Message from the destination.

Parámetros

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

Muestra

NotFound – The specified message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The message asked for.

Tipo del valor devuelto

await pins()¶

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Nota

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Muestra: HTTPException – Retrieving the pinned messages failed.
Devuelve: The messages that are currently pinned.
Tipo del valor devuelto: List[Message]

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). If the content is set to None (the default), then the embed parameter must be provided.

Parámetros

content (Optional[str]) – The content of the message to send.
tts (bool) – Indicates if the message should be sent using text-to-speech.
embed (Embed) – The rich embed for the content to send. This cannot be mixed with 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.

Nuevo en la versión 2.0.
file (File) – The file to upload. This cannot be mixed with 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.

Nuevo en la versión 2.0.
nonce (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.

Nuevo en la versión 1.4.
reference (Union[Message, MessageReference, PartialMessage]) –
A reference to the Message to which you are replying, this can be created using to_reference() or passed directly as a Message. You can control whether this mentions the author of the referenced message using the replied_user attribute of allowed_mentions or by setting mention_author.

Nuevo en la versión 1.6.
mention_author (Optional[bool]) –
If set, overrides the replied_user attribute of allowed_mentions.

Nuevo en la versión 1.6.
view (disnake.ui.View) – A Discord UI View to add to the message.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size, you specified both file and files, or you specified both embed and embeds, or the reference object is not a Message, MessageReference or PartialMessage.

Devuelve

The message that was sent.

Tipo del valor devuelto

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.

PartialInviteGuild¶

Attributes

banner
created_at
description
features
icon
id
name
splash
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

verification_level¶

The partial guild’s verification level.

Type: VerificationLevel

features¶

A list of features the guild has. See Guild.features for more information.

Type: List[str]

description¶

The partial guild’s description.

Type: Optional[str]

property created_at: datetime.datetime¶

Returns the guild’s creation time in UTC.

Type: datetime.datetime

property icon: Optional[disnake.asset.Asset]¶

Returns the guild’s icon asset, if available.

Type: Optional[Asset]

property banner: Optional[disnake.asset.Asset]¶

Returns the guild’s banner asset, if available.

Type: Optional[Asset]

property splash: Optional[disnake.asset.Asset]¶

Returns the guild’s invite splash asset, if available.

Type: Optional[Asset]

PartialInviteChannel¶

Attributes

created_at
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.

name¶

The partial channel’s name.

Type: str

id¶

The partial channel’s ID.

Type: int

type¶

The partial channel’s type.

Type: ChannelType

property mention: str¶

The string that allows you to mention the channel.

Type: str

property created_at: datetime.datetime¶

Returns the channel’s creation time in UTC.

Type: datetime.datetime

Invite¶

Attributes

approximate_member_count
approximate_presence_count
channel
code
created_at
expires_at
guild
id
inviter
max_age
max_uses
revoked
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.

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

If it’s not in the table above then it is available by all methods.

max_age¶

How long before the invite expires in seconds. A value of 0 indicates that it doesn’t expire.

Type: int

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]]

revoked¶

Indicates if the invite has been revoked.

Type: bool

created_at¶

An aware UTC datetime object denoting the time the invite was created.

Type: datetime.datetime

temporary¶

Indicates that the invite grants temporary membership. If True, members who joined via this invite will be kicked upon disconnect.

Type: bool

uses¶

How many times the invite has been used.

Type: int

max_uses¶

How many times the invite can be used. A value of 0 indicates that it has unlimited uses.

Type: int

inviter¶

The user who created the invite.

Type: Optional[User]

approximate_member_count¶

The approximate number of members in the guild.

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.

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.

Nuevo en la versión 2.0.

Type: Optional[datetime.datetime]

channel¶

The channel the invite is for.

Type: Union[abc.GuildChannel, Object, PartialInviteChannel]

target_type¶

The type of target for the voice channel invite.

Nuevo en la versión 2.0.

Type: InviteTarget

target_user¶

The user whose stream to display for this invite, if any.

Nuevo en la versión 2.0.

Type: Optional[User]

target_application¶

The embedded application the invite targets, if any.

Nuevo en la versión 2.0.

Type: Optional[PartialAppInfo]

property id: str¶

Returns the proper code portion of the invite.

Type: str

property url: str¶

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 the manage_channels permission to do this.

Parámetros

reason (Optional[str]) – The reason for deleting this invite. Shows up on the audit log.

Muestra

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.

Nuevo en la versión 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.

Nuevo en la versión 2.0.

Type: Optional[bool]

await create_guild(name, region=None, 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.

Parámetros

name (str) – The name of the guild.
region (VoiceRegion) – The region for the voice communication server. Defaults to VoiceRegion.us_west.
icon (bytes) – The bytes-like object representing the icon. See ClientUser.edit() for more details on what is expected.

Muestra

HTTPException – Guild creation failed.
InvalidArgument – Invalid icon image format given. Must be PNG or JPG.

Devuelve

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

Tipo del valor devuelto

await sync()¶

This function is a coroutine.

Sync the template to the guild’s current state.

You must have the manage_guild permission in the source guild to do this.

Nuevo en la versión 1.7.

Distinto en la versión 2.0: The template is no longer edited in-place, instead it is returned.

Muestra

HTTPException – Editing the template failed.
Forbidden – You don’t have permissions to edit the template.
NotFound – This template does not exist.

Devuelve

The newly edited template.

Tipo del valor devuelto

Template

await edit(*, name=..., description=...)¶

This function is a coroutine.

Edit the template metadata.

You must have the manage_guild permission in the source guild to do this.

Nuevo en la versión 1.7.

Distinto en la versión 2.0: The template is no longer edited in-place, instead it is returned.

Parámetros

name (str) – The template’s new name.
description (Optional[str]) – The template’s new description.

Muestra

HTTPException – Editing the template failed.
Forbidden – You don’t have permissions to edit the template.
NotFound – This template does not exist.

Devuelve

The newly edited template.

Tipo del valor devuelto

Template

await delete()¶

This function is a coroutine.

Delete the template.

You must have the manage_guild permission in the source guild to do this.

Nuevo en la versión 1.7.

Muestra

HTTPException – Editing the template failed.
Forbidden – You don’t have permissions to edit the template.
NotFound – This template does not exist.

property url: str¶

The template url.

Nuevo en la versión 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: str¶

The string that allows you to mention the channel.

Type: str

property created_at: datetime.datetime¶

Returns the channel’s creation time in UTC.

Type: datetime.datetime

WidgetMember¶

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 ID.

Type: int

name¶

The member’s username.

Type: str

discriminator¶

The member’s discriminator.

Type: str

bot¶

Whether the member is a bot.

Type: bool

status¶

The member’s status.

Type: Status

nick¶

The member’s nickname.

Type: Optional[str]

avatar¶

The member’s avatar hash.

Type: Optional[str]

activity¶

The member’s activity.

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 display_name: str¶

Returns the member’s display name.

Type: str

property accent_color: Optional[disnake.colour.Colour]¶

Returns the user’s accent color, if applicable.

There is an alias for this named accent_colour.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Colour]

property accent_colour: Optional[disnake.colour.Colour]¶

Returns the user’s accent colour, if applicable.

There is an alias for this named accent_color.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Colour]

property banner: Optional[disnake.asset.Asset]¶

Returns the user’s banner asset, if available.

Nuevo en la versión 2.0.

Nota

This information is only available via Client.fetch_user().

Type: Optional[Asset]

property color: disnake.colour.Colour¶

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: disnake.colour.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: datetime¶

Returns the user’s creation time in UTC.

This is when the user’s Discord account was created.

Type: datetime.datetime

property default_avatar: disnake.asset.Asset¶

Returns the default avatar for a given user. This is calculated by the user’s discriminator.

Type: Asset

property display_avatar: disnake.asset.Asset¶

Returns the user’s display avatar.

For regular users this is just their default avatar or uploaded avatar.

Nuevo en la versión 2.0.

Type: Asset

property mention: str¶

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.

Parámetros: message (Message) – The message to check if you’re mentioned in.
Devuelve: Indicates if the user is mentioned in the message.
Tipo del valor devuelto: bool

property public_flags: disnake.flags.PublicUserFlags¶

The publicly available flags the user has.

Type: PublicUserFlags

Widget¶

Attributes

channels
created_at
id
invite_url
json_url
members
name

Methods

asyncfetch_invite

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 accessible voice channels in the guild.

Type: List[WidgetChannel]

members¶

The online members in the server. Offline members do not appear in the widget.

Nota

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[Member]

property created_at: datetime.datetime¶

Returns the member’s creation time in UTC.

Type: datetime.datetime

property json_url: str¶

The JSON URL of the widget.

Type: str

property invite_url: str¶

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.

Parámetros: with_counts (bool) – Whether to include count information in the invite. This fills the Invite.approximate_member_count and Invite.approximate_presence_count fields.
Devuelve: The invite from the widget’s invite URL.
Tipo del valor devuelto: Invite

StickerPack¶

Attributes

banner
cover_sticker
cover_sticker_id
description
id
name
sku_id
stickers

class disnake.StickerPack¶

Represents a sticker pack.

Nuevo en la versión 2.0.

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.

Type: int

cover_sticker¶

The sticker used for the cover of the sticker pack.

Type: StandardSticker

property banner: disnake.asset.Asset¶

The banner asset of the sticker pack.

Type: Asset

StickerItem¶

Attributes

format
id
name
url

Methods

asyncfetch

class disnake.StickerItem¶

Represents a sticker item.

Nuevo en la versión 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

url¶

The URL for the sticker’s image.

Type: str

await fetch()¶

This function is a coroutine.

Attempts to retrieve the full sticker data of the sticker item.

Muestra: HTTPException – Retrieving the sticker failed.
Devuelve: The retrieved sticker.
Tipo del valor devuelto: Union[StandardSticker, GuildSticker]

Sticker¶

Attributes

created_at
description
format
id
name
pack_id
url

class disnake.Sticker¶

Represents a sticker.

Nuevo en la versión 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

url¶

The URL for the sticker’s image.

Type: str

property created_at: datetime.datetime¶

Returns the sticker’s creation time in UTC.

Type: datetime.datetime

StandardSticker¶

Attributes

description
format
id
name
pack_id
sort_value
tags

Methods

asyncpack

class disnake.StandardSticker¶

Represents a sticker that is found in a standard sticker pack.

Nuevo en la versión 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.

Muestra

InvalidData – The corresponding sticker pack was not found.
HTTPException – Retrieving the sticker pack failed.

Devuelve

The retrieved sticker pack.

Tipo del valor devuelto

StickerPack

GuildSticker¶

Attributes

available
description
emoji
format
guild
guild_id
id
name
user

Methods

asyncdelete
asyncedit

class disnake.GuildSticker¶

Represents a sticker that belongs to a guild.

Nuevo en la versión 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() 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.

Nuevo en la versión 2.0.

Type: Optional[Guild]

await edit(*, name=..., description=..., emoji=..., reason=None)¶

This function is a coroutine.

Edits a GuildSticker for the guild.

Parámetros

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 (str) – The reason for editing this sticker. Shows up on the audit log.

Muestra

Forbidden – You are not allowed to edit stickers.
HTTPException – An error occurred editing the sticker.

Devuelve

The newly modified sticker.

Tipo del valor devuelto

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.

Parámetros

reason (Optional[str]) – The reason for deleting this sticker. Shows up on the audit log.

Muestra

Forbidden – You are not allowed to delete stickers.
HTTPException – An error occurred deleting the sticker.

RawMessageDeleteEvent¶

Attributes

cached_message
channel_id
guild_id
message_id

class disnake.RawMessageDeleteEvent¶

Represents the event payload for a 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 a 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 message got deleted.

Type: int

guild_id¶

The guild ID where the message got deleted, 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 payload for a 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.

Nuevo en la versión 1.3.

Type: int

guild_id¶

The guild ID where the message got updated, if applicable.

Nuevo en la versión 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 payload for a on_raw_reaction_add() or on_raw_reaction_remove() event.

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 got added or removed.

Type: int

guild_id¶

The guild ID where the reaction got added or removed, 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.

Nuevo en la versión 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.

Nuevo en la versión 1.3.

Type: str

RawReactionClearEvent¶

Attributes

channel_id
guild_id
message_id

class disnake.RawReactionClearEvent¶

Represents the payload for a on_raw_reaction_clear() event.

message_id¶

The message ID that got its reactions cleared.

Type: int

channel_id¶

The channel ID where the reactions got cleared.

Type: int

guild_id¶

The guild ID where the reactions got cleared.

Type: Optional[int]

RawReactionClearEmojiEvent¶

Attributes

channel_id
emoji
guild_id
message_id

class disnake.RawReactionClearEmojiEvent¶

Represents the payload for a on_raw_reaction_clear_emoji() event.

Nuevo en la versión 1.3.

message_id¶

The message ID that got its reactions cleared.

Type: int

channel_id¶

The channel ID where the reactions got cleared.

Type: int

guild_id¶

The guild ID where the reactions got cleared.

Type: Optional[int]

emoji¶

The custom or unicode emoji being removed.

Type: PartialEmoji

RawMemberScreeningRejectEvent¶

Attributes

guild_id
user_id

class disnake.RawMemberScreeningRejectEvent¶

Represents the payload for a on_raw_member_screening_reject() event.

Nuevo en la versión 2.3.

guild_id¶

The guild ID of the guild which the user left.

Type: int

user_id¶

The user ID of the user who left the guild.

Type: int

RawIntegrationDeleteEvent¶

Attributes

application_id
guild_id
integration_id

class disnake.RawIntegrationDeleteEvent¶

Represents the payload for a on_raw_integration_delete() event.

Nuevo en la versión 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 got deleted.

Type: int

PartialWebhookGuild¶

Attributes

icon
id
name

class disnake.PartialWebhookGuild¶

Represents a partial guild for webhooks.

These are typically given for channel follower webhooks.

Nuevo en la versión 2.0.

id¶

The partial guild’s ID.

Type: int

name¶

The partial guild’s name.

Type: str

property icon: Optional[disnake.asset.Asset]¶

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.

Nuevo en la versión 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: datetime.datetime¶

Returns the snowflake’s creation time in UTC.

Type: datetime.datetime

Embed¶

Attributes

Empty
author
colour
description
fields
footer
image
provider
thumbnail
timestamp
title
type
url
video

Methods

clsEmbed.from_dict
defadd_field
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(*, colour=Embed.Empty, color=Embed.Empty, title=Embed.Empty, type='rich', url=Embed.Empty, description=Embed.Empty, timestamp=None)¶

Represents a Discord embed.

len(x): Returns the total size of the embed. Useful for checking if it’s within the 6000 character limit.

bool(b): Returns whether the embed has any data set.

Nuevo en la versión 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. If the attribute is invalid or empty, then a special sentinel value is returned, Embed.Empty.

For ease of use, all parameters that expect a str are implicitly casted to str for you.

title¶

The title of the embed. This can be set during initialisation.

Type: str

type¶

The type of embed. Usually «rich». This can be set during initialisation. Possible strings for embed types can be found on disnake’s api docs

Type: str

description¶

The description of the embed. This can be set during initialisation.

Type: str

url¶

The URL of the embed. This can be set during initialisation.

Type: 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: datetime.datetime

colour¶

The colour code of the embed. Aliased to color as well. This can be set during initialisation.

Type: Union[Colour, int]

Empty¶

A special sentinel value used by EmbedProxy and this class to denote that the value or attribute is empty.

Type: Final

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.

Parámetros: data (dict) – The dictionary to convert into an embed.

copy()¶: Returns a shallow copy of the embed.

property footer: _EmbedFooterProxy¶

Returns an EmbedProxy denoting the footer contents.

See set_footer() for possible values you can access.

If the attribute has no value then Empty is returned.

set_footer(*, text=Embed.Empty, icon_url=Embed.Empty)¶

Sets the footer for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Parámetros

text (str) – The footer text.
icon_url (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.

Nuevo en la versión 2.0.

property image: _EmbedMediaProxy¶

Returns an EmbedProxy denoting the image contents.

Possible attributes you can access are:

url
proxy_url
width
height

If the attribute has no value then Empty is returned.

set_image(url=..., *, file=...)¶

Sets the image for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Distinto en la versión 1.4: Passing Empty removes the image.

Parámetros

url (str) – The source URL for the image. Only HTTP(S) is supported.
file (File) –
The file to use as the image.

Nuevo en la versión 2.2.

property thumbnail: _EmbedMediaProxy¶

Returns an EmbedProxy denoting the thumbnail contents.

Possible attributes you can access are:

url
proxy_url
width
height

If the attribute has no value then Empty is returned.

set_thumbnail(url=..., *, file=...)¶

Sets the thumbnail for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Distinto en la versión 1.4: Passing Empty removes the thumbnail.

Parámetros

url (str) – The source URL for the thumbnail. Only HTTP(S) is supported.
file (File) –
The file to use as the image.

Nuevo en la versión 2.2.

property video: _EmbedVideoProxy¶

Returns an EmbedProxy denoting the video contents.

Possible attributes include:

url for the video URL.
height for the video height.
width for the video width.

If the attribute has no value then Empty is returned.

property provider: _EmbedProviderProxy¶

Returns an EmbedProxy denoting the provider contents.

The only attributes that might be accessed are name and url.

If the attribute has no value then Empty is returned.

property author: _EmbedAuthorProxy¶

Returns an EmbedProxy denoting the author contents.

See set_author() for possible values you can access.

If the attribute has no value then Empty is returned.

set_author(*, name, url=Embed.Empty, icon_url=Embed.Empty)¶

Sets the author for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Parámetros

name (str) – The name of the author.
url (str) – The URL for the author.
icon_url (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.

Nuevo en la versión 1.4.

property fields: List[_EmbedFieldProxy]¶

Returns a list of EmbedProxy denoting the field contents.

See add_field() for possible values you can access.

If the attribute has no value then Empty is returned.

Type: List[Union[EmbedProxy, Empty]]

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.

Parámetros

name (str) – The name of the field.
value (str) – The value of the field.
inline (bool) – Whether the field should be displayed inline.

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.

Nuevo en la versión 1.2.

Parámetros

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.

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.

Nota

When deleting a field by index, the index of the other fields shift to fill the gap just like a regular list.

Parámetros: 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.

Parámetros

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.

Muestra

IndexError – An invalid index was provided.

to_dict()¶: Converts this embed object into a dict.

AllowedMentions¶

Attributes

everyone
replied_user
roles
users

Methods

clsAllowedMentions.all
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.

Nuevo en la versión 1.6.

Type: bool

classmethod all()¶: A factory method that returns a AllowedMentions with all fields explicitly set to True

Nuevo en la versión 1.5.

classmethod none()¶: A factory method that returns a AllowedMentions with all fields set to False

Nuevo en la versión 1.5.

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.

Nuevo en la versión 1.5.

Distinto en la versión 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.

Nuevo en la versión 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.

Nuevo en la versión 1.6.

Type: Optional[Union[Message, DeletedReferencedMessage]]

classmethod from_message(message, *, fail_if_not_exists=True)¶

Creates a MessageReference from an existing Message.

Nuevo en la versión 1.6.

Parámetros

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.

Nuevo en la versión 1.7.

Devuelve

A reference to the message.

Tipo del valor devuelto

MessageReference

property cached_message: Optional[disnake.message.Message]¶

The cached message, if found in the internal message cache.

Type: Optional[Message]

property jump_url: str¶

Returns a URL that allows the client to jump to the referenced message.

Nuevo en la versión 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.

Nuevo en la versión 2.1.

id¶

ID of the interaction

Type: int

type¶

The type of interaction

Type: InteractionType

name¶

The name of the application command

Type: str

user¶

The user who invoked the interaction

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()
Thread.get_partial_message()
DMChannel.get_partial_message()

Note that this class is trimmed down and has no rich attributes.

Nuevo en la versión 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]

id¶

The message ID.

Type: int

property jump_url: str¶

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.

Distinto en la versión 1.1: Added the new delay keyword-only parameter.

Parámetros

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.

Muestra

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.

Muestra

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.

Parámetros

reason (Optional[str]) –

The reason for pinning the message. Shows up on the audit log.

Nuevo en la versión 1.4.

Muestra

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.

Parámetros

reason (Optional[str]) –

The reason for unpinning the message. Shows up on the audit log.

Nuevo en la versión 1.4.

Muestra

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.

Add 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.

Parámetros

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to react with.

Muestra

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.
InvalidArgument – The emoji parameter is invalid.

await remove_reaction(emoji, member)¶

This function is a coroutine.

Remove 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.

Parámetros

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to remove.
member (abc.Snowflake) – The member for which to remove the reaction.

Muestra

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.
InvalidArgument – 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.

Nuevo en la versión 1.3.

Parámetros

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to clear.

Muestra

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.
InvalidArgument – 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.

Muestra

HTTPException – Removing the reactions failed.
Forbidden – You do not have the proper permissions to remove all the reactions.

await reply(content=None, **kwargs)¶

This function is a coroutine.

A shortcut method to abc.Messageable.send() to reply to the Message.

Nuevo en la versión 1.6.

Muestra

HTTPException – Sending the message failed.
Forbidden – You do not have the proper permissions to send the message.
InvalidArgument – The files list is not of the appropriate size or you specified both file and files.

Devuelve

The message that was sent.

Tipo del valor devuelto

to_reference(*, fail_if_not_exists=True)¶

Creates a MessageReference from the current message.

Nuevo en la versión 1.6.

Parámetros

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.

Nuevo en la versión 1.7.

Devuelve

The reference to this message.

Tipo del valor devuelto

MessageReference

property created_at: datetime.datetime¶

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.

Muestra

NotFound – The message was not found.
Forbidden – You do not have the permissions required to get a message.
HTTPException – Retrieving the message failed.

Devuelve

The full message.

Tipo del valor devuelto

await edit(**fields)¶

This function is a coroutine.

Edits the message.

The content must be able to be transformed into a string via str(content).

Distinto en la versión 2.1: disnake.Message is always returned.

Nota

Parámetros

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.

Nuevo en la versión 2.1.
file (File) –
The file to upload. This cannot be mixed with files parameter. Files will be appended to the message, see the attachments parameter to remove/replace existing files.

Nuevo en la versión 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.

Nuevo en la versión 2.1.
attachments (List[Attachment]) –
A list of attachments to keep in the message. If [] is passed then all existing attachments are removed. Keeps existing attachments if not provided.

Nuevo en la versión 2.1.
suppress (bool) – Whether to suppress embeds for the message. This removes all the embeds if set to True. If set to False this brings the embeds back if they were suppressed. Using this parameter requires manage_messages.
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.

Nota

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. If None is passed then the view is removed.

Nuevo en la versión 2.0.

Muestra

NotFound – The message was not found.
HTTPException – Editing the message failed.
Forbidden – Tried to suppress a message without permissions or edited a message’s content or embed that isn’t yours.
InvalidArgument – You specified both embed and embeds or file and files.

Devuelve

The message that was edited.

Tipo del valor devuelto