API Reference

The following section outlines the API of nextcord.

Note

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

Version Related Info

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

nextcord.version_info

A named tuple that is similar to sys.version_info.

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

nextcord.__version__

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

Clients

Client

Attributes

• activity
• all_views
• allowed_mentions
• application_flags
• application_id
• cached_messages
• default_guild_ids
• emojis
• guilds
• intents
• latency
• loop
• private_channels
• scheduled_events
• status
• stickers
• user
• users
• voice_clients
• ws

Methods

• defadd_all_application_commands
• defadd_all_cog_commands
• defadd_application_command
• defadd_application_command_check
• defadd_listener
• defadd_modal
• defadd_view
• @application_command_after_invoke
• @application_command_before_invoke
• @application_command_check
• asyncapplication_info
• asyncbefore_identify_hook
• asyncchange_presence
• asyncclear
• asyncclose
• asyncconnect
• asynccreate_application_emoji
• asynccreate_dm
• asynccreate_guild
• asyncdelete_application_commands
• asyncdelete_invite
• asyncdiscover_application_commands
• @event
• asyncfetch_application_emoji
• asyncfetch_application_emojis
• asyncfetch_channel
• asyncfetch_guild
• asyncfetch_guild_preview
• deffetch_guilds
• asyncfetch_invite
• asyncfetch_premium_sticker_packs
• asyncfetch_stage_instance
• asyncfetch_sticker
• asyncfetch_template
• asyncfetch_user
• asyncfetch_webhook
• asyncfetch_widget
• defget_all_application_commands
• defget_all_channels
• defget_all_members
• defget_application_command
• defget_application_command_from_signature
• defget_application_commands
• defget_channel
• defget_emoji
• defget_guild
• defget_interaction
• defget_partial_messageable
• defget_scheduled_event
• defget_stage_instance
• defget_sticker
• defget_user
• defis_closed
• defis_ready
• defis_ws_ratelimited
• @listen
• asynclogin
• defmessage_command
• asyncon_application_command_error
• asyncon_error
• defparse_mentions
• asyncprocess_application_commands
• asyncregister_application_commands
• asyncregister_new_application_commands
• defremove_application_command_check
• defremove_listener
• defremove_modal
• defremove_view
• defrun
• defslash_command
• asyncstart
• asyncsync_all_application_commands
• asyncsync_application_commands
• defuser_command
• defviews
• asyncwait_for
• asyncwait_until_ready

class nextcord.Client(*, max_messages=1000, connector=None, proxy=None, proxy_auth=None, shard_id=None, shard_count=None, application_id=None, intents=<Intents value=3243773>, member_cache_flags=..., chunk_guilds_at_startup=..., status=None, activity=None, allowed_mentions=None, heartbeat_timeout=60.0, guild_ready_timeout=2.0, assume_unsync_clock=True, enable_debug_events=False, loop=None, lazy_load_commands=True, rollout_associate_known=True, rollout_delete_unknown=True, rollout_register_new=True, rollout_update_known=True, rollout_all_guilds=False, default_guild_ids=None)

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

A number of options can be passed to the Client.

Parameters:

• max_messages (Optional[int]) –

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

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

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

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

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

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

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

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

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

• intents (Intents) –

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

  Added in version 1.5.

• member_cache_flags (MemberCacheFlags) –

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

  Added in version 1.5.

• chunk_guilds_at_startup (bool) –

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

  Added in version 1.5.

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

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

• allowed_mentions (Optional[AllowedMentions]) –

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

  Added in version 1.4.

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

• guild_ready_timeout (float) –

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

  Added in version 1.4.

• assume_unsync_clock (bool) –

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

  Added in version 1.3.

• enable_debug_events (bool) –

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

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

  Added in version 2.0.

• lazy_load_commands (bool) –

  Whether to attempt to associate an unknown incoming application command ID with an existing application command.

  If this is set to True, the default, then the library will attempt to match up an unknown incoming application command payload to an application command in the library.

• rollout_associate_known (bool) – Whether during the application command rollout to associate found Discord commands with commands added locally. Defaults to True.

• rollout_delete_unknown (bool) – Whether during the application command rollout to delete commands from Discord that don’t correspond with a locally added command. Defaults to True.

• rollout_register_new (bool) – Whether during the application command rollout to register new application commands that were added locally but not found on Discord. Defaults to True.

• rollout_update_known (bool) – Whether during the application command rollout to update known applications that share the same signature but don’t quite match what is registered on Discord. Defaults to True.

• rollout_all_guilds (bool) –

  Whether during the application command rollout to update to all guilds, instead of only ones with at least one command to roll out to them. Defaults to False

  Warning: While enabling this will prevent “ghost” commands on guilds with removed code references, rolling out to ALL guilds with anything other than a very small bot will likely cause it to get rate limited.

• default_guild_ids (Optional[List[int]]) –

  The default guild ids for every application command set. If the application command doesn’t have any explicit guild ids set and this list is not empty, then the application command’s guild ids will be set to this. Defaults to None.

  Added in version 2.3.

ws

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

loop

The event loop that the client uses for asynchronous operations.

Type:

asyncio.AbstractEventLoop

@event

A decorator that registers an event to listen to.

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

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

Example

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

Raises:

TypeError – The coroutine passed is not actually a coroutine.

@slash_command(name=None, description=None, *, name_localizations=None, description_localizations=None, guild_ids=..., nsfw=False, default_member_permissions=None, integration_types=None, contexts=None, force_global=False)

Creates a Slash application command from the decorated function.

Parameters:

• name (str) – Name of the command that users will see. If not set, it defaults to the name of the callback.

• description (str) – Description of the command that users will see. If not set, the docstring will be used. If no docstring is found for the command callback, it defaults to “No description provided”.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the command for users of specific locales. The locale code should be the key, with the localized name as the value.

• description_localizations (Dict[Union[Locale, str], str]) – Description(s) of the command for users of specific locales. The locale code should be the key, with the localized description as the value.

• guild_ids (Optional[Iterable[int]]) – IDs of Guild’s to add this command to. If not passed and Client.default_guild_ids is set, then those default guild ids will be used instead. If both of those are unset, then the command will be a global command.

• default_member_permissions (Optional[Union[Permissions, int]]) – Permission(s) required to use the command. Inputting 8 or Permissions(administrator=True) for example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by default. Server owners CAN override the permission requirements.

• nsfw (bool) –

  Whether the command can only be used in age-restricted channels. Defaults to False.

  Added in version 2.4.

• integration_types (Optional[Iterable[Union[IntegrationType, int]]]) –

  Where the command is available, only for globally-scoped commands. Defaults to guild_install.

  Added in version 3.0.

• contexts (Optional[Iterable[Union[InteractionContextType, int]]]) –

  Where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands.

  Added in version 3.0.

• force_global (bool) – If True, will force this command to register as a global command, even if guild_ids is set. Will still register to guilds. Has no effect if guild_ids are never set or added to.

@user_command(name=None, *, name_localizations=None, guild_ids=..., default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, force_global=False)

Creates a User context command from the decorated function.

Parameters:

• name (str) – Name of the command that users will see. If not set, it defaults to the name of the callback.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the command for users of specific locales. The locale code should be the key, with the localized name as the value

• guild_ids (Optional[Iterable[int]]) – IDs of Guild’s to add this command to. If not passed and Client.default_guild_ids is set, then those default guild ids will be used instead. If both of those are unset, then the command will be a global command.

• default_member_permissions (Optional[Union[Permissions, int]]) – Permission(s) required to use the command. Inputting 8 or Permissions(administrator=True) for example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by default. Server owners CAN override the permission requirements.

• nsfw (bool) –

  Whether the command can only be used in age-restricted channels. Defaults to False.

  Added in version 2.4.

• integration_types (Optional[Iterable[Union[IntegrationType, int]]]) –

  Where the command is available, only for globally-scoped commands. Defaults to guild_install.

  Added in version 3.0.

• contexts (Optional[Iterable[Union[InteractionContextType, int]]]) –

  Where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands.

  Added in version 3.0.

• force_global (bool) – If True, will force this command to register as a global command, even if guild_ids is set. Will still register to guilds. Has no effect if guild_ids are never set or added to.

@message_command(name=None, *, name_localizations=None, guild_ids=..., default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, force_global=False)

Creates a Message context command from the decorated function.

Parameters:

• name (str) – Name of the command that users will see. If not set, it defaults to the name of the callback.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the command for users of specific locales. The locale code should be the key, with the localized name as the value

• guild_ids (Optional[Iterable[int]]) – IDs of Guild’s to add this command to. If not passed and Client.default_guild_ids is set, then those default guild ids will be used instead. If both of those are unset, then the command will be a global command.

• default_member_permissions (Optional[Union[Permissions, int]]) – Permission(s) required to use the command. Inputting 8 or Permissions(administrator=True) for example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by default. Server owners CAN override the permission requirements.

• nsfw (bool) –

  Whether the command can only be used in age-restricted channels. Defaults to False.

  Added in version 2.4.

• integration_types (Optional[Iterable[Union[IntegrationType, int]]]) –

  Where the command is available, only for globally-scoped commands. Defaults to guild_install.

  Added in version 3.0.

• contexts (Optional[Iterable[Union[InteractionContextType, int]]]) –

  Where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands.

  Added in version 3.0.

• force_global (bool) – If True, will force this command to register as a global command, even if guild_ids is set. Will still register to guilds. Has no effect if guild_ids are never set or added to.

async for ... in fetch_guilds(*, limit=200, with_counts=False, before=None, after=None)

This function returns an async iterator.

Returns an async iterator that enables receiving your guilds.

Note

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

Note

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

Examples

Usage

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

All parameters are optional.

Parameters:

• limit (Optional[int]) –

  The number of guilds to retrieve. If None, it retrieves every guild you have access to. Note, however, that this would make it a slow operation. Defaults to 200.

  Changed in version 2.0: Changed default to 200.

• with_counts (bool) –

  Whether to include approximate member and presence counts for the guilds. Defaults to False.

  Added in version 2.6.

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

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

Raises:

.HTTPException – Getting the guilds failed.

Yields:

Guild – The guild with the guild data parsed.

property latency

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

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

Type:

float

is_ws_ratelimited()

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.

Added in version 1.6.

property user

Represents the connected client. None if not logged in.

Type:

Optional[ClientUser]

property guilds

The guilds that the connected client is a member of.

Type:

List[Guild]

property emojis

The emojis that the connected client has.

Type:

List[Emoji]

property stickers

The stickers that the connected client has.

Added in version 2.0.

Type:

List[GuildSticker]

property cached_messages

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

Added in version 1.1.

Type:

Sequence[Message]

property private_channels

The private channels that the connected client is participating on.

Note

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

Type:

List[abc.PrivateChannel]

property voice_clients

Represents a list of voice connections.

These are usually VoiceClient instances.

Type:

List[VoiceProtocol]

property application_id

The client’s application ID.

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

Added in version 2.0.

Type:

Optional[int]

property application_flags

The client’s application flags.

Added in version 2.0.

Type:

ApplicationFlags

property default_guild_ids

List[int] The default guild ids for all application commands.

Added in version 2.3.

is_ready()

bool: Specifies if the client’s internal cache is ready for use.

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

This function is a coroutine.

The default error handler provided by the client.

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

await on_application_command_error(interaction, exception)

This function is a coroutine.

The default application command error handler provided by the bot.

By default this prints to stderr however it could be overridden to have a different implementation.

This only fires if you do not specify any listeners for command error.

await before_identify_hook(shard_id, *, initial=False)

This function is a coroutine.

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

The default implementation sleeps for 5 seconds.

Added in version 1.4.

Parameters:

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

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

await login(token)

This function is a coroutine.

Logs in the client with the specified credentials.

Parameters:

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

Raises:

• .LoginFailure – The wrong credentials are passed.

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

await connect(*, reconnect=True)

This function is a coroutine.

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

Parameters:

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

Raises:

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

• .ConnectionClosed – The websocket connection has been terminated.

await close()

This function is a coroutine.

Closes the connection to Discord.

await clear()

Clears the internal state of the bot.

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

await start(token, *, reconnect=True)

This function is a coroutine.

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

Raises:

TypeError – An unexpected keyword argument was received.

run(token, *, reconnect=True)

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

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

Roughly Equivalent to:

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

Warning

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

is_closed()

bool: Indicates if the websocket connection is closed.

property activity

The activity being used upon logging in.

Type:

Optional[BaseActivity]

property status

Status: The status being used upon logging on to Discord.

property allowed_mentions

The allowed mention configuration.

Added in version 1.4.

Type:

Optional[AllowedMentions]

property intents

The intents configured for this connection.

Added in version 1.5.

Type:

Intents

property users

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

Type:

List[User]

get_channel(id, /)

Returns a channel or thread with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The returned channel or None if not found.

Return type:

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

get_partial_messageable(id, *, type=None)

Returns a partial messageable with the given channel ID.

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

Added in version 2.0.

Parameters:

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

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

Returns:

The partial messageable

Return type:

PartialMessageable

get_stage_instance(id, /)

Returns a stage instance with the given stage channel ID.

Added in version 2.0.

Parameters:

id (int) – The ID to search for.

Returns:

The returns stage instance of None if not found.

Return type:

Optional[StageInstance]

get_guild(id, /)

Returns a guild with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The guild or None if not found.

Return type:

Optional[Guild]

get_user(id, /)

Returns a user with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The user or None if not found.

Return type:

Optional[User]

get_emoji(id, /)

Returns an emoji with the given ID.

Parameters:

id (int) – The ID to search for.

Returns:

The custom emoji or None if not found.

Return type:

Optional[Emoji]

get_sticker(id, /)

Returns a guild sticker with the given ID.

Added in version 2.0.

Note

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

Returns:

The sticker or None if not found.

Return type:

Optional[GuildSticker]

get_scheduled_event(id, /)

Returns a scheduled event with the given ID.

Added in version 2.0.

Parameters:

id (int) – The scheduled event’s ID to search for.

Returns:

The scheduled event or None if not found.

Return type:

Optional[ScheduledEvent]

get_all_channels()

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

This is equivalent to:

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

Note

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

Yields:

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

get_all_members()

Returns a generator with every Member the client can see.

This is equivalent to:

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

Yields:

Member – A member the client can see.

await wait_until_ready()

This function is a coroutine.

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

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

This function is a coroutine.

Waits for a WebSocket event to be dispatched.

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

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

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

This function returns the first event that meets the requirements.

Examples

Waiting for a user reply:

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

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

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

Waiting for a thumbs up reaction from the message author:

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

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

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

Parameters:

• event (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.

Raises:

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

Returns:

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

Return type:

Any

add_listener(func, name=...)

The non decorator alternative to listen().

Added in version 3.0.

Parameters:

• func (coroutine) – The function to call.

• name (str) – The name of the event to listen for. Defaults to func.__name__.

Example

async def on_ready(): pass
async def my_message(message): pass

client.add_listener(on_ready)
client.add_listener(my_message, 'on_message')

remove_listener(func, name=...)

Removes a listener from the pool of listeners.

Added in version 3.0.

Parameters:

• func – The function that was used as a listener to remove.

• name (str) – The name of the event we want to remove. Defaults to func.__name__.

listen(name=...)

A decorator that registers another function as an external event listener. Basically this allows you to listen to multiple events from different places e.g. such as on_ready()

The functions being listened to must be a coroutine.

Added in version 3.0.

Example

@client.listen()
async def on_message(message):
    print('one')

# in some other file...

@client.listen('on_message')
async def my_message(message):
    print('two')

Would print one and two in an unspecified order.

Raises:

TypeError – The function being listened to is not a coroutine.

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

This function is a coroutine.

Changes the client’s presence.

Example

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

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

Parameters:

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

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

Raises:

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

await fetch_template(code)

This function is a coroutine.

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

Parameters:

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

Raises:

• .NotFound – The template is invalid.

• .HTTPException – Getting the template failed.

Returns:

The template from the URL/code.

Return type:

Template

await fetch_guild(guild_id, /, *, with_counts=True)

This function is a coroutine.

Retrieves a Guild from an ID.

Note

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

Note

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

Parameters:

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

• with_counts (bool) –

  Whether to include count information in the guild. This fills the Guild.approximate_member_count and Guild.approximate_presence_count attributes without needing any privileged intents. Defaults to True.

  Added in version 2.0.

Raises:

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

• .HTTPException – Getting the guild failed.

Returns:

The guild from the ID.

Return type:

Guild

await fetch_guild_preview(guild_id, /)

This function is a coroutine.

Fetches a GuildPreview from an ID.

Note

This will only fetch guilds that the bot is in or that are discoverable.

Added in version 2.6.

Parameters:

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

Raises:

.NotFound – The guild provided is unknown.

Returns:

The guild preview from the ID

Return type:

GuildPreview

await create_guild(*, name, region=VoiceRegion.us_west, icon=None, code=...)

This function is a coroutine.

Creates a Guild.

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

Changed in version 2.1: The icon parameter now accepts File, Attachment, and Asset.

Parameters:

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

• region (VoiceRegion) – The region for the voice communication server. Defaults to VoiceRegion.us_west.

• icon (Optional[Union[bytes, Asset, Attachment, File]]) – The bytes-like object, File, Attachment, or Asset 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.

  Added in version 1.4.

Raises:

• .HTTPException – Guild creation failed.

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

Returns:

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

Return type:

Guild

await fetch_stage_instance(channel_id, /)

This function is a coroutine.

Gets a StageInstance for a stage channel id.

Added in version 2.0.

Parameters:

channel_id (int) – The stage channel ID.

Raises:

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

• .HTTPException – Getting the stage instance failed.

Returns:

The stage instance from the stage channel ID.

Return type:

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.

Note

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

Parameters:

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

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

• with_expiration (bool) –

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

  Added in version 2.0.

Raises:

• .NotFound – The invite has expired or is invalid.

• .HTTPException – Getting the invite failed.

Returns:

The invite from the URL/ID.

Return type:

Invite

await delete_invite(invite)

This function is a coroutine.

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

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

Parameters:

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

Raises:

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

• .NotFound – The invite is invalid or expired.

• .HTTPException – Revoking the invite failed.

await fetch_widget(guild_id, /)

This function is a coroutine.

Gets a Widget from a guild ID.

Note

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

Parameters:

guild_id (int) – The ID of the guild.

Raises:

• .Forbidden – The widget for this guild is disabled.

• .HTTPException – Retrieving the widget failed.

Returns:

The guild’s widget.

Return type:

Widget

await application_info()

This function is a coroutine.

Retrieves the bot’s application information.

Raises:

.HTTPException – Retrieving the information failed somehow.

Returns:

The bot’s application information.

Return type:

AppInfo

await fetch_user(user_id, /)

This function is a coroutine.

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

Note

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

Parameters:

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

Raises:

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

• .HTTPException – Fetching the user failed.

Returns:

The user you requested.

Return type:

User

await fetch_channel(channel_id, /)

This function is a coroutine.

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

Note

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

Added in version 1.2.

Raises:

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

• .HTTPException – Retrieving the channel failed.

• .NotFound – Invalid Channel ID.

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

Returns:

The channel from the ID.

Return type:

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

await fetch_webhook(webhook_id, /)

This function is a coroutine.

Retrieves a Webhook with the specified ID.

Raises:

• .HTTPException – Retrieving the webhook failed.

• .NotFound – Invalid webhook ID.

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

Returns:

The webhook you requested.

Return type:

Webhook

await fetch_sticker(sticker_id, /)

This function is a coroutine.

Retrieves a Sticker with the specified ID.

Added in version 2.0.

Raises:

• .HTTPException – Retrieving the sticker failed.

• .NotFound – Invalid sticker ID.

Returns:

The sticker you requested.

Return type:

Union[StandardSticker, GuildSticker]

await fetch_premium_sticker_packs()

This function is a coroutine.

Retrieves all available premium sticker packs.

Added in version 2.0.

Raises:

.HTTPException – Retrieving the sticker packs failed.

Returns:

All available premium sticker packs.

Return type:

List[StickerPack]

await create_dm(user)

This function is a coroutine.

Creates a DMChannel with this user.

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

Added in version 2.0.

Parameters:

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

Returns:

The channel that was created.

Return type:

DMChannel

add_view(view, *, message_id=None)

Registers a View for persistent listening or for non- persistent storage.

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

Added in version 2.0.

Changed in version 2.6: Non-persistent views can now be stored during the lifetime of the bot.

Parameters:

• view (nextcord.ui.View) – The view to register for dispatching or to add to storage.

• 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. This cannot be provided if the view is non-persistent.

Raises:

• TypeError – A view was not passed.

• ValueError – The message_id parameter was passed in with a non-persistent view.

remove_view(view, message_id=None)

Removes a View from persistent listening or non-persistent storage.

This method should be used if a persistent view is set in a cog and should be freed when the cog is unloaded to save memory or if you want to stop tracking a non-persistent view.

Added in version 2.3.

Changed in version 2.6: Non-persistent views can now be removed from storage.

Parameters:

• view (nextcord.ui.View) – The view to remove from dispatching.

• message_id (Optional[int]) – The message ID that the view is attached to. This is used to properly remove the view from the view store. This cannot be provided if the view is non-persistent.

Raises:

• TypeError – A view was not passed.

• ValueError – The message_id parameter was passed in with a non-persistent view.

add_modal(modal, *, user_id=None)

Registers a Modal for persistent listening.

This method can be called for modals whose lifetime must be eventually superior to the one of the program or for modals whose call does not depend on particular criteria.

Parameters:

• modal (nextcord.ui.Modal) – The view to register for dispatching.

• user_id (Optional[int]) – The user ID that the view is attached to. This is used to filter the modal calls based on the users.

Raises:

• TypeError – A modal was not passed.

• ValueError – The modal is not persistent. A persistent modal has a set custom_id and all their components with a set custom_id and a timeout set to None.

remove_modal(modal)

Removes a Modal from persistent listening.

This method should be used if a persistent modal is set in a cog and should be freed when the cog is unloaded to save memory.

Added in version 2.3.

Parameters:

modal (nextcord.ui.Modal) – The modal to remove from dispatching.

Raises:

• TypeError – A modal was not passed.

• ValueError – The modal is not persistent. A persistent modal has a set custom_id and all their components with a set custom_id and a timeout set to None.

property all_views

List[View] A sequence of all views added to the client.

Added in version 2.6.

views(*, persistent=True)

Returns all persistent or non-persistent views.

Added in version 2.6.

Parameters:

persistent (bool) – Whether or not we should grab persistent views. Defaults to True.

Returns:

The views requested.

Return type:

List[ui.View]

property scheduled_events

A list of scheduled events

Added in version 2.0.

Type:

List[ScheduledEvent]

await process_application_commands(interaction)

This function is a coroutine. Processes the data in the given interaction and calls associated applications or autocomplete if possible. Lazy-loads commands if enabled.

Parameters:

interaction (Interaction) – Interaction from Discord to read data from.

get_application_command(command_id)

Gets an application command from the cache that has the given command ID.

Parameters:

command_id (int) – Command ID corresponding to an application command.

Returns:

Returns the application command corresponding to the ID. If no command is found, None is returned instead.

Return type:

Optional[BaseApplicationCommand]

get_application_command_from_signature(qualified_name, *, type=ApplicationCommandType.chat_input, guild=None, search_localizations=False)

Gets a locally stored application command object that matches the given signature.

Added in version 2.0.

Changed in version 3.0: - Subcommands/Subcommand groups can now be retrieved with this method. - name parameter was renamed to qualified_name and now accepts subcommands/subcommand groups separated by a space. - cmd_type parameter was renamed to type, defaults to ApplicationCommandType.chat_input and is now a keyword-only parameter. - guild_id parameter was renamed to guild with type Union[int, Snowflake], defaults to None and is now a keyword-only parameter.

Parameters:

• qualified_name (str) – Full name of the application command. Case sensitive. Subcommands must be separated by a space, E.g, parent group subcommand.

• type (Union[int, ApplicationCommandType]) – Type of application command. Defaults to ApplicationCommandType.chat_input.

• guild (Optional[Union[int, Snowflake]]) – Guild ID of the signature. If set to None, it will attempt to get the global signature. Defaults to None.

• search_localizations (bool) –

  Whether to also search through the command’s name_localizations. Defaults to False.

  Added in version 3.0.

Returns:

command – Application Command with the given signature. If no command with that signature is found, None is returned instead.

Return type:

Optional[BaseApplicationCommand, SlashApplicationSubcommand]

get_all_application_commands()

Returns a copied set of all added BaseApplicationCommand objects.

get_application_commands(rollout=False)

Gets registered global commands.

Parameters:

rollout (bool) – Whether unregistered/unassociated commands should be returned as well. Defaults to False

Returns:

List of BaseApplicationCommand objects that are global.

Return type:

List[BaseApplicationCommand]

add_application_command(command, overwrite=False, use_rollout=False, pre_remove=True)

Adds a BaseApplicationCommand object to the client for use.

Parameters:

• command (ApplicationCommand) – Command to add to the client for usage.

• overwrite (bool) – If to overwrite any existing commands that would conflict with this one. Defaults to False

• use_rollout (bool) – If to apply the rollout signatures instead of existing ones. Defaults to False

• pre_remove (bool) – If the command should be removed before adding it. This will clear all signatures from storage, including rollout ones.

await sync_all_application_commands(data=None, *, use_rollout=True, associate_known=True, delete_unknown=True, update_known=True, register_new=True, ignore_forbidden=True)

This function is a coroutine.

Syncs all application commands with Discord. Will sync global commands if any commands added are global, and syncs with all guilds that have an application command targeting them.

This may call Discord many times depending on how different guilds you have local commands for, and how many commands Discord needs to be updated or added, which may cause your bot to be rate limited or even Cloudflare banned in VERY extreme cases.

This may incur high CPU usage depending on how many commands you have and how complex they are, which may cause your bot to halt while it checks local commands against the existing commands that Discord has.

For a more targeted version of this method, see Client.sync_application_commands()

Parameters:

• data (Optional[Dict[Optional[int], List[dict]]]) – Data to use when comparing local application commands to what Discord has. The key should be the int guild ID (None for global) corresponding to the value list of application command payloads from Discord. Any guild ID’s not provided will be fetched if needed. Defaults to None

• use_rollout (bool) – If the rollout guild IDs of commands should be used. Defaults to True

• associate_known (bool) – If local commands that match a command already on Discord should be associated with each other. Defaults to True

• delete_unknown (bool) – If commands on Discord that don’t match a local command should be deleted. Defaults to True

• update_known (bool) – If commands on Discord have a basic match with a local command, but don’t fully match, should be updated. Defaults to True

• register_new (bool) – If a local command that doesn’t have a basic match on Discord should be added to Discord. Defaults to True

• ignore_forbidden (bool) – If this command should suppress a errors.Forbidden exception when the bot encounters a guild where it doesn’t have permissions to view application commands. Defaults to True

await sync_application_commands(data=None, *, guild_id=None, associate_known=True, delete_unknown=True, update_known=True, register_new=True)

This function is a coroutine. Syncs the locally added application commands with the Guild corresponding to the given ID, or syncs global commands if the guild_id is None.

Changed in version 3.0: This replaces the now removed delete_unknown_application_commands, associate_application_commands, update_application_commands, and rollout_application_commands methods.

Parameters:

• data (Optional[List[dict]]) – Data to use when comparing local application commands to what Discord has. Should be a list of application command data from Discord. If left as None, it will be fetched if needed. Defaults to None.

• guild_id (Optional[int]) – ID of the guild to sync application commands with. If set to None, global commands will be synced instead. Defaults to None.

• associate_known (bool) – If local commands that match a command already on Discord should be associated with each other. Defaults to True.

• delete_unknown (bool) – If commands on Discord that don’t match a local command should be deleted. Defaults to True.

• update_known (bool) – If commands on Discord have a basic match with a local command, but don’t fully match, should be updated. Defaults to True.

• register_new (bool) – If a local command that doesn’t have a basic match on Discord should be added to Discord. Defaults to True.

await discover_application_commands(data=None, *, guild_id=None, associate_known=True, delete_unknown=True, update_known=True)

This function is a coroutine. Associates existing, deletes unknown, and updates modified commands for either global commands or a specific guild. This does a deep check on found commands, which may be expensive CPU-wise.

Running this for global or the same guild multiple times at once may cause unexpected or unstable behavior.

Changed in version 3.0: This replaces the now removed deploy_application_commands method.

Parameters:

• data (Optional[List[dict]]) – Payload from HTTPClient.get_guild_commands or HTTPClient.get_global_commands to deploy with. If None, the payload will be retrieved from Discord.

• guild_id (Optional[int]) – Guild ID to deploy application commands to. If None, global commands are deployed to.

• associate_known (bool) – If True, commands on Discord that pass a signature check and a deep check will be associated with locally added ApplicationCommand objects.

• delete_unknown (bool) – If True, commands on Discord that fail a signature check will be removed. If update_known is False, commands that pass the signature check but fail the deep check will also be removed.

• update_known (bool) – If True, commands on Discord that pass a signature check but fail the deep check will be updated.

await register_new_application_commands(data=None, guild_id=None)

This function is a coroutine. Registers locally added application commands that don’t match a signature that Discord has registered for either global commands or a specific guild.

Parameters:

• data (Optional[List[dict]]) – Data to use when comparing local application commands to what Discord has. Should be a list of application command data from Discord. If left as None, it will be fetched if needed. Defaults to None

• guild_id (Optional[int]) – ID of the guild to sync application commands with. If set to None, global commands will be synced instead. Defaults to None.

await register_application_commands(*commands, guild_id=None)

This function is a coroutine. Registers the given application commands either for a specific guild or globally, and adds the commands to the bot.

Parameters:

• commands (BaseApplicationCommand) – Application command to register. Multiple args are accepted.

• guild_id (Optional[int]) – ID of the guild to register the application commands to. If set to None, the commands will be registered as global commands instead. Defaults to None.

await delete_application_commands(*commands, guild_id=None)

This function is a coroutine. Deletes the given application commands either from a specific guild or globally, and removes the command IDs + signatures from the bot.

Parameters:

• commands (BaseApplicationCommand) – Application command to delete. Multiple args are accepted.

• guild_id (Optional[int]) – ID of the guild to delete the application commands from. If set to None, the commands will be deleted from global commands instead. Defaults to None.

add_all_application_commands()

Adds application commands that are either decorated by the Client or added via a cog to the state. This does not register commands with Discord. If you want that, use sync_all_application_commands() instead.

Changed in version 3.0: This replaces the now removed add_startup_application_commands method.

add_all_cog_commands()

Adds all ApplicationCommand objects inside added cogs to the application command list.

parse_mentions(text)

Parses user mentions in a string and returns a list of User objects.

Note

This does not include role or channel mentions. See Guild.parse_mentions for Member objects, Guild.parse_role_mentions for Role objects, and Guild.parse_channel_mentions for GuildChannel objects.

Note

Only cached users will be returned. To get the IDs of all users mentioned, use parse_raw_mentions() instead.

Added in version 2.2.

Parameters:

text (str) – String to parse mentions in.

Returns:

List of User objects that were mentioned in the string.

Return type:

List[User]

get_interaction(data, *, cls=<class 'nextcord.interactions.Interaction'>)

Returns an interaction for a gateway event.

Parameters:

• data – The data direct from the gateway.

• cls – The factory class that will be used to create the interaction. By default, this is Interaction. Should a custom class be provided, it should be a subclass of Interaction.

Returns:

• Interaction – An instance Interaction or the provided subclass.

• .. note:: – This is synchronous due to how slash commands are implemented.

add_application_command_check(func)

Adds a global application command check to the client.

This is the non-decorator interface to application_command_check().

Parameters:

func (Callable[[Interaction], MaybeCoro[bool]]]) – The function that was used as a global application check.

remove_application_command_check(func)

Removes a global application command check from the client.

This function is idempotent and will not raise an exception if the function is not in the global checks.

Parameters:

func (Callable[[Interaction], MaybeCoro[bool]]]) – The function to remove from the global application checks.

application_command_check(func)

A decorator that adds a global applications command check to the client.

A global check is similar to a check() that is applied on a per command basis except it is run before any command checks have been verified and applies to every application command the client has.

Note

This function can either be a regular function or a coroutine.

Similar to a application command check(), this takes a single parameter of type Interaction and can only raise exceptions inherited from ApplicationError.

Example

@client.application_command_check
def check_commands(interaction: Interaction) -> bool:
    return interaction.application_command.qualified_name in allowed_commands

application_command_before_invoke(coro)

A decorator that registers a coroutine as a pre-invoke hook.

A pre-invoke hook is called directly before the command is called. This makes it a useful function to set up database connections or any type of set up required.

This pre-invoke hook takes a sole parameter, a Interaction.

Note

The application_command_before_invoke() and application_command_after_invoke() hooks are only called if all checks pass without error. If any check fails, then the hooks are not called.

Parameters:

coro (coroutine) – The coroutine to register as the pre-invoke hook.

Raises:

TypeError – The coroutine passed is not actually a coroutine.

application_command_after_invoke(coro)

A decorator that registers a coroutine as a post-invoke hook.

A post-invoke hook is called directly after the command is called. This makes it a useful function to clean-up database connections or any type of clean up required. There may only be one global post-invoke hook.

This post-invoke hook takes a sole parameter, a Interaction.

Note

Similar to application_command_before_invoke(), this is not called unless checks succeed. This hook is, however, always called regardless of the internal command callback raising an error (i.e. ApplicationInvokeError). This makes it ideal for clean-up scenarios.

Parameters:

coro (coroutine) – The coroutine to register as the post-invoke hook.

Raises:

TypeError – The coroutine passed is not actually a coroutine.

await create_application_emoji(*, name, image)

This function is a coroutine.

Creates an emoji for the current application.

Parameters:

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

• image (Union[bytes, Asset, Attachment, File]) – The image data to create the emoji with.

Returns:

The created emoji.

Return type:

Emoji

Raises:

• HTTPException – An error occurred creating the emoji.

• TypeError – The client’s application ID was not set.

await fetch_application_emojis()

This function is a coroutine.

Fetches the emojis that the current application has.

Raises:

TypeError – The client’s application ID was not set.

Returns:

The emojis that the application has.

Return type:

List[Emoji]

await fetch_application_emoji(emoji_id)

This function is a coroutine.

Fetches an emoji that the current application has.

Parameters:

emoji_id (int) – The ID of the emoji to fetch.

Raises:

• TypeError – The client’s application ID was not set.

• NotFound – The emoji requested was not found.

Returns:

The emoji that the application has.

Return type:

Emoji

AutoShardedClient

Attributes

• latencies
• latency
• shard_ids
• shards

Methods

• asyncchange_presence
• asyncclose
• asyncconnect
• defget_shard
• defis_ws_ratelimited

class nextcord.AutoShardedClient(*, shard_ids=None, max_messages=1000, connector=None, proxy=None, proxy_auth=None, shard_id=None, shard_count=None, application_id=None, intents=<Intents value=3243773>, member_cache_flags=..., chunk_guilds_at_startup=..., status=None, activity=None, allowed_mentions=None, heartbeat_timeout=60.0, guild_ready_timeout=2.0, assume_unsync_clock=True, enable_debug_events=False, loop=None, lazy_load_commands=True, rollout_associate_known=True, rollout_delete_unknown=True, rollout_register_new=True, rollout_update_known=True, rollout_all_guilds=False, default_guild_ids=None)

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

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

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

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

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

shard_ids

An optional list of shard_ids to launch the shards with.

Type:

Optional[List[int]]

property latency

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

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

Type:

float

property latencies

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

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

Type:

List[Tuple[int, float]]

get_shard(shard_id)

Optional[ShardInfo]: Gets the shard information at a given shard ID or None if not found.

property shards

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

Type:

Mapping[int, ShardInfo]

await connect(*, reconnect=True)

This function is a coroutine.

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

Parameters:

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

Raises:

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

• .ConnectionClosed – The websocket connection has been terminated.

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 = nextcord.Game("with the API")
await client.change_presence(status=nextcord.Status.idle, activity=game)

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

Parameters:

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

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

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

Raises:

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

Added in version 1.6.

Application Info

InstallParams

Attributes

• permissions
• scopes

class nextcord.InstallParams

Represents the default scopes and permissions for an installation context.

Added in version 3.0.

scopes

Scopes to add the application to this installation context with.

Type:

List[str]

permissions

Permissions to request for the bot role.

Type:

Permissions

ApplicationIntegrationTypeConfig

Attributes

• oauth2_install_params

class nextcord.ApplicationIntegrationTypeConfig

Represents the default scopes and permissions for an installation context.

Added in version 3.0.

oauth2_install_params

The scopes and permissions for this installation context.

Type:

InstallParams

AppInfo

Attributes

• bot_public
• bot_require_code_grant
• description
• icon
• id
• integration_types_config
• name
• owner
• privacy_policy_url
• rpc_origins
• team
• terms_of_service_url
• verify_key

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

Added in version 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]]

verify_key

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

Added in version 1.3.

Type:

str

terms_of_service_url

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

Added in version 2.0.

Type:

Optional[str]

privacy_policy_url

The application’s privacy policy URL, if set.

Added in version 2.0.

Type:

Optional[str]

integration_types_config

The default scopes and permissions for each supported installation context.

Added in version 3.0.

Type:

Optional[Dict[IntegrationType, ApplicationIntegrationTypeConfig]]

property icon

Retrieves the application’s icon asset, if any.

Type:

Optional[Asset]

PartialAppInfo

Attributes

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

class nextcord.PartialAppInfo

Represents a partial AppInfo given by create_invite()

Added in version 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]]

verify_key

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

Type:

str

terms_of_service_url

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

Type:

Optional[str]

privacy_policy_url

The application’s privacy policy URL, if set.

Type:

Optional[str]

property icon

Retrieves the application’s icon asset, if any.

Type:

Optional[Asset]

Team

Attributes

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

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

Added in version 1.3.

Type:

List[TeamMember]

property icon

Retrieves the team’s icon asset, if any.

Type:

Optional[Asset]

property owner

The team’s owner.

Type:

Optional[TeamMember]

TeamMember

Attributes

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

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

Added in version 1.3.

name

The team member’s username.

Type:

str

id

The team member’s unique ID.

Type:

int

discriminator

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

Type:

str

avatar

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

Type:

Optional[str]

bot

Specifies if the user is a bot account.

Type:

bool

team

The team that the member is from.

Type:

Team

membership_state

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

Type:

TeamMembershipState

Voice Related

VoiceClient

Attributes

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

Methods

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

class nextcord.VoiceClient

Represents a Discord voice connection.

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

Warning

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

session_id

The voice connection session ID.

Type:

str

token

The voice connection token.

Type:

str

endpoint

The endpoint we are connecting to.

Type:

str

channel

The voice channel connected to.

Type:

abc.Connectable

loop

The event loop that the voice client is running on.

Type:

asyncio.AbstractEventLoop

property guild

The guild we’re connected to, if applicable.

Type:

Optional[Guild]

property user

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

Type:

ClientUser

property latency

Latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

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

Added in version 1.4.

Type:

float

property average_latency

Average of most recent 20 HEARTBEAT latencies in seconds.

Added in version 1.4.

Type:

float

await disconnect(*, force=False)

This function is a coroutine.

Disconnects this voice client from voice.

await move_to(channel)

This function is a coroutine.

Moves you to a different voice channel.

Parameters:

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

is_connected()

Indicates if the voice client is connected to voice.

play(source, *, after=None)

Plays an AudioSource.

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

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

Parameters:

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

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

Raises:

• ClientException – Already playing audio or not connected.

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

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

is_playing()

Indicates if we’re currently playing audio.

is_paused()

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

stop()

Stops playing audio.

pause()

Pauses the audio playing.

resume()

Resumes the audio playing.

property source

The audio source being played, if playing.

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

Type:

Optional[AudioSource]

send_audio_packet(data, *, encode=True)

Sends an audio packet composed of the data.

You must be connected to play audio.

Parameters:

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

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

Raises:

• ClientException – You are not connected.

• opus.OpusError – Encoding the data failed.

VoiceProtocol

Methods

• defcleanup
• asyncconnect
• asyncdisconnect
• asyncon_voice_server_update
• asyncon_voice_state_update

class nextcord.VoiceProtocol(client, channel)

A class that represents the Discord voice protocol.

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

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

These classes are passed to abc.Connectable.connect.

Parameters:

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

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

await on_voice_state_update(data)

This function is a coroutine.

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

Parameters:

data (dict) –

The raw voice state payload.

await on_voice_server_update(data)

This function is a coroutine.

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

Parameters:

data (dict) –

The raw voice server update payload.

await connect(*, timeout, reconnect)

This function is a coroutine.

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

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

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

Parameters:

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

• reconnect (bool) – Whether reconnection is expected.

await disconnect(*, force)

This function is a coroutine.

An abstract method called when the client terminates the connection.

See cleanup().

Parameters:

force (bool) – Whether the disconnection was forced.

cleanup()

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

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

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

AudioSource

Methods

• defcleanup
• defis_opus
• defread

class nextcord.AudioSource

Represents an audio stream.

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

Warning

The audio source reads are done in a separate thread.

read()

Reads 20ms worth of audio.

Subclasses must implement this.

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

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

Returns:

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

Return type:

bytes

is_opus()

Checks if the audio source is already encoded in Opus.

cleanup()

Called when clean-up is needed to be done.

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

PCMAudio

Attributes

• stream

Methods

• defread

class nextcord.PCMAudio(stream)

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

stream

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

Type:

file object

read()

Reads 20ms worth of audio.

Subclasses must implement this.

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

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

Returns:

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

Return type:

bytes

FFmpegAudio

Methods

• defcleanup

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

Represents an FFmpeg (or AVConv) based AudioSource.

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

Added in version 1.3.

Warning

As this wraps a subprocess call, ensure that arguments such as executable are not set from direct user input.

cleanup()

Called when clean-up is needed to be done.

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

FFmpegPCMAudio

Methods

• defis_opus
• defread

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

An audio source from FFmpeg (or AVConv).

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

Warning

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

Parameters:

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

• executable (str) –

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

  Warning

  As this wraps a subprocess call, ensure that this argument is not set from direct user input.

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

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

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

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

Raises:

ClientException – The subprocess failed to be created.

read()

Reads 20ms worth of audio.

Subclasses must implement this.

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

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

Returns:

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

Return type:

bytes

is_opus()

Checks if the audio source is already encoded in Opus.

FFmpegOpusAudio

Methods

• asyncfrom_probe
• defis_opus
• asyncprobe
• defread

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

An audio source from FFmpeg (or AVConv).

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

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

Added in version 1.3.

Warning

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

Parameters:

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

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

• codec (Optional[str]) –

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

  Warning

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

• executable (str) –

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

  Warning

  As this wraps a subprocess call, ensure that this argument is not set from direct user input.

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

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

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

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

Raises:

ClientException – The subprocess failed to be created.

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

This function is a coroutine.

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

Examples

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

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

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

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

Using a custom method of determining codec and bitrate:

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

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

Parameters:

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

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

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

Raises:

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

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

Returns:

An instance of this class.

Return type:

FFmpegOpusAudio

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

This function is a coroutine.

Probes the input source for bitrate and codec information.

Parameters:

• source – Identical to the source parameter for FFmpegOpusAudio.

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

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

Raises:

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

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

Returns:

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

Return type:

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

read()

Reads 20ms worth of audio.

Subclasses must implement this.

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

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

Returns:

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

Return type:

bytes

is_opus()

Checks if the audio source is already encoded in Opus.

PCMVolumeTransformer

Attributes

• volume

Methods

• defcleanup
• defread

class nextcord.PCMVolumeTransformer(original, volume=1.0)

Transforms a previous AudioSource to have volume controls.

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

Parameters:

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

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

Raises:

• TypeError – Not an audio source.

• ClientException – The audio source is opus encoded.

property volume

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

cleanup()

Called when clean-up is needed to be done.

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

read()

Reads 20ms worth of audio.

Subclasses must implement this.

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

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

Returns:

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

Return type:

bytes

Opus Library

nextcord.opus.load_opus(name)

Loads the libopus shared library for use with voice.

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

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

This function propagates the exceptions thrown.

Warning

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

Note

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

Note

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

Parameters:

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

nextcord.opus.is_loaded()

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

This must return True for voice to work.

Returns:

Indicates if the opus library has been loaded.

Return type:

bool

Event Reference

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

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

import nextcord

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

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

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

Warning

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

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

nextcord.on_shard_connect(shard_id)

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

Added in version 1.4.

Parameters:

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

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

nextcord.on_shard_disconnect(shard_id)

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

Added in version 1.4.

Parameters:

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

nextcord.on_http_ratelimit(limit, remaining, reset_after, bucket, scope)

Called when a HTTP request in progress either exhausts its bucket or gets a 429 response. For more information on how a ratelimit bucket is defined, check out the [Discord API Docs](https://discord.dev/topics/rate-limits).

If the 429 response is a global ratelimit, then use on_global_http_ratelimit() instead.

Added in version 2.4.

Parameters:

• limit (int) – The amount of requests that have been made under the bucket that the request correlates to.

• remaining (int) – The amount of remaining requests that can be made under the bucket that the request correlates to.

• reset_after (float) – The amount of time we have to wait before making another request under the same bucket.

• bucket (str) – The hash correlating to the bucket of the request from Discord. This hash denotes the rate limit being encountered.

• scope (Optional[str]) – If we get a 429, the scope of the 429 response. This value can either be “user” (rate limit relating to the user) or “shared” (rate limit relating to a resource).

nextcord.on_global_http_ratelimit(retry_after)

Called when a HTTP request in progress gets a 429 response and the scope is global.

If the 429 response is a non-global ratelimit or you want to track when the bucket expires, then use on_http_ratelimit() instead.

Added in version 2.4.

Parameters:

retry_after (float) – The amount of time we have to wait before making another request.

nextcord.on_ready()

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

Warning

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

nextcord.on_shard_ready(shard_id)

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

Parameters:

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

nextcord.on_resumed()

Called when the client has resumed a session.

nextcord.on_shard_resumed(shard_id)

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

Added in version 1.4.

Parameters:

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

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

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

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

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

Note

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

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

Parameters:

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

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

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

nextcord.on_close()

Called when the client is exiting the event loop and shutting down.

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

Added in version 2.0.

Parameters:

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

nextcord.on_socket_raw_receive(msg)

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

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

This requires setting the enable_debug_events setting in the Client.

Note

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

Parameters:

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

nextcord.on_socket_raw_send(payload)

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

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

This requires setting the enable_debug_events setting in the Client.

Note

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

Parameters:

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

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

Parameters:

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

nextcord.on_raw_typing(payload)

Called when someone begins typing a message. Unlike on_typing(), this is called regardless if the user can be found in the bot’s cache or not.

If the typing event is occuring in a guild, the member that started typing can be accessed via RawTypingEvent.member

This requires Intents.typing to be enabled.

Parameters:

payload (RawTypingEvent) – The raw typing payload.

nextcord.on_message(message)

Called when a Message is created and sent.

This requires Intents.messages to be enabled.

Warning

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

Parameters:

message (Message) – The current message.

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

Parameters:

message (Message) – The deleted message.

nextcord.on_bulk_message_delete(messages)

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

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

This requires Intents.messages to be enabled.

Parameters:

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

nextcord.on_raw_message_delete(payload)

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

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

This requires Intents.messages to be enabled.

Parameters:

payload (RawMessageDeleteEvent) – The raw event payload data.

nextcord.on_raw_bulk_message_delete(payload)

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

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

This requires Intents.messages to be enabled.

Parameters:

payload (RawBulkMessageDeleteEvent) – The raw event payload data.

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

Parameters:

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

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

nextcord.on_raw_message_edit(payload)

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

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

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

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

This requires Intents.messages to be enabled.

Parameters:

payload (RawMessageUpdateEvent) – The raw event payload data.

nextcord.on_reaction_add(reaction, user)

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

Note

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

This requires Intents.reactions to be enabled.

Note

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

Parameters:

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

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

nextcord.on_raw_reaction_add(payload)

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

This requires Intents.reactions to be enabled.

Parameters:

payload (RawReactionActionEvent) – The raw event payload data.

nextcord.on_reaction_remove(reaction, user)

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

Note

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

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

Note

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

Parameters:

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

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

nextcord.on_raw_reaction_remove(payload)

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

This requires Intents.reactions to be enabled.

Parameters:

payload (RawReactionActionEvent) – The raw event payload data.

nextcord.on_reaction_clear(message, reactions)

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

This requires Intents.reactions to be enabled.

Parameters:

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

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

nextcord.on_raw_reaction_clear(payload)

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

This requires Intents.reactions to be enabled.

Parameters:

payload (RawReactionClearEvent) – The raw event payload data.

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

Added in version 1.3.

Parameters:

reaction (Reaction) – The reaction that got cleared.

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

Added in version 1.3.

Parameters:

payload (RawReactionClearEmojiEvent) – The raw event payload data.

nextcord.on_interaction(interaction)

Called when an interaction happened.

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

Warning

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.

Added in version 2.0.

Parameters:

interaction (Interaction) – The interaction data.

nextcord.on_private_channel_update(before, after)

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

This requires Intents.messages to be enabled.

Parameters:

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

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

nextcord.on_private_channel_pins_update(channel, last_pin)

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

Parameters:

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

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

nextcord.on_guild_channel_delete(channel)

nextcord.on_guild_channel_create(channel)

Called whenever a guild channel is deleted or created.

Note that you can get the guild from guild.

This requires Intents.guilds to be enabled.

Parameters:

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

nextcord.on_guild_channel_update(before, after)

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

This requires Intents.guilds to be enabled.

Parameters:

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

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

nextcord.on_guild_channel_pins_update(channel, last_pin)

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

This requires Intents.guilds to be enabled.

Parameters:

• channel (Union[TextChannel, 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.

nextcord.on_thread_create(thread)

Called when a thread is created.

Added in version 2.4.

Parameters:

thread (Thread) – The thread that got created.

nextcord.on_thread_join(thread)

Called whenever a thread is joined or created.

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

This requires Intents.guilds to be enabled.

Note

This event is also called when a thread is created. To differentiate, use on_thread_create() instead. This is done to avoid a breaking change in v2.

Added in version 2.0.

Parameters:

thread (Thread) – The thread that got joined.

nextcord.on_thread_remove(thread)

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

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

This requires Intents.guilds to be enabled.

Warning

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

Added in version 2.0.

Parameters:

thread (Thread) – The thread that got removed.

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

Added in version 2.0.

Parameters:

thread (Thread) – The thread that got deleted.

nextcord.on_thread_member_join(member)

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

Added in version 2.0.

Parameters:

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

nextcord.on_thread_update(before, after)

Called whenever a thread is updated.

This requires Intents.guilds to be enabled.

Added in version 2.0.

Parameters:

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

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

nextcord.on_guild_integrations_update(guild)

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

This requires Intents.integrations to be enabled.

Added in version 1.4.

Parameters:

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

nextcord.on_integration_create(integration)

Called when an integration is created.

This requires Intents.integrations to be enabled.

Added in version 2.0.

Parameters:

integration (Integration) – The integration that was created.

nextcord.on_integration_update(integration)

Called when an integration is updated.

This requires Intents.integrations to be enabled.

Added in version 2.0.

Parameters:

integration (Integration) – The integration that was created.

nextcord.on_raw_integration_delete(payload)

Called when an integration is deleted.

This requires Intents.integrations to be enabled.

Added in version 2.0.

Parameters:

payload (RawIntegrationDeleteEvent) – The raw event payload data.

nextcord.on_webhooks_update(channel)

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

This requires Intents.webhooks to be enabled.

Parameters:

channel (TextChannel) – The channel that had its webhooks updated.

nextcord.on_member_join(member)

nextcord.on_member_remove(member)

Called when a Member leaves or joins a Guild.

This requires Intents.members to be enabled.

Parameters:

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

nextcord.on_raw_member_remove(payload)

Called when a Member leaves a Guild. Unlike on_member_remove() this is called regardless of the state of the internal message cache.

This requires Intents.members to be enabled.

Added in version 2.0.

Parameters:

payload (RawMemberRemoveEvent) – The raw event payload data.

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

• flags

This requires Intents.members to be enabled.

Parameters:

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

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

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

Added in version 2.0.

Parameters:

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

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

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

Parameters:

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

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

nextcord.on_guild_join(guild)

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

This requires Intents.guilds to be enabled.

Parameters:

guild (Guild) – The guild that was joined.

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

For this event to be invoked, the Client must have been part of the guild to begin with. (i.e. it is part of Client.guilds)

This requires Intents.guilds to be enabled.

Parameters:

guild (Guild) – The guild that got removed.

nextcord.on_guild_update(before, after)

Called when a Guild updates, for example:

• Changed name

• Changed AFK channel

• Changed AFK timeout

• etc

This requires Intents.guilds to be enabled.

Parameters:

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

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

nextcord.on_guild_role_create(role)

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

Parameters:

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

nextcord.on_guild_role_update(before, after)

Called when a Role is changed guild-wide.

This requires Intents.guilds to be enabled.

Parameters:

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

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

nextcord.on_guild_emojis_update(guild, before, after)

Called when a Guild adds or removes Emoji.

This requires Intents.emojis_and_stickers to be enabled.

Parameters:

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

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

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

nextcord.on_guild_stickers_update(guild, before, after)

Called when a Guild updates its stickers.

This requires Intents.emojis_and_stickers to be enabled.

Added in version 2.0.

Parameters:

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

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

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

nextcord.on_guild_available(guild)

nextcord.on_guild_unavailable(guild)

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

This requires Intents.guilds to be enabled.

Parameters:

guild – The Guild that has changed availability.

nextcord.on_voice_state_update(member, before, after)

Called when a Member changes their VoiceState.

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

• A member joins a voice or stage channel.

• A member leaves a voice or stage channel.

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

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

This requires Intents.voice_states to be enabled.

Parameters:

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

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

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

nextcord.on_stage_instance_create(stage_instance)

nextcord.on_stage_instance_delete(stage_instance)

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

Added in version 2.0.

Parameters:

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

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

Added in version 2.0.

Parameters:

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

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

nextcord.on_member_ban(guild, user)

Called when user gets banned from a Guild.

This requires Intents.bans to be enabled.

Parameters:

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

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

nextcord.on_member_unban(guild, user)

Called when a User gets unbanned from a Guild.

This requires Intents.bans to be enabled.

Parameters:

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

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

nextcord.on_invite_create(invite)

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

Added in version 1.3.

Note

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

This requires Intents.invites to be enabled.

Parameters:

invite (Invite) – The invite that was created.

nextcord.on_invite_delete(invite)

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

Added in version 1.3.

Note

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

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

This requires Intents.invites to be enabled.

Parameters:

invite (Invite) – The invite that was deleted.

nextcord.on_group_join(channel, user)

nextcord.on_group_remove(channel, user)

Called when someone joins or leaves a GroupChannel.

Parameters:

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

• user (User) – The user that joined or left.

nextcord.on_guild_scheduled_event_create(event)

Called when a ScheduledEvent is created.

Parameters:

event (ScheduledEvent) – The event that was created.

nextcord.on_guild_scheduled_event_update(before, after)

Called when a ScheduledEvent is updated.

Parameters:

• before (ScheduledEvent) – The event before it was updated.

• after (ScheduledEvent) – The event after it was updated.

nextcord.on_guild_scheduled_event_delete(event)

Called when a ScheduledEvent is deleted.

Parameters:

event (ScheduledEvent) – The event that was deleted.

nextcord.on_guild_scheduled_event_user_add(event, user)

nextcord.on_guild_scheduled_event_user_remove(event, user)

Called when a ScheduledEventUser is interested in a ScheduledEvent.

Parameters:

• event (ScheduledEvent) – The event that the user is interested in.

• user (ScheduledEventUser) – The user that interested.

nextcord.on_auto_moderation_rule_create(rule)

Called when an AutoModerationRule is created.

Added in version 2.1.

Parameters:

rule (AutoModerationRule) – The rule that was created.

nextcord.on_auto_moderation_rule_update(rule)

Called when an AutoModerationRule is edited.

Added in version 2.1.

Parameters:

rule (AutoModerationRule) – The newly edited rule.

nextcord.on_auto_moderation_rule_delete(rule)

Called when a AutoModerationRule is deleted.

Added in version 2.1.

Parameters:

rule (AutoModerationRule) – The deleted rule.

nextcord.on_auto_moderation_action_execution(execution)

Called when an AutoModerationAction is executed.

Added in version 2.1.

Parameters:

execution (AutoModerationActionExecution) – The object containing the execution information.

nextcord.on_guild_audit_log_entry_create(entry)

Called when an AuditLogEntry is created.

Added in version 2.4.

Parameters:

entry (AuditLogEntry) – The entry that was created.

Utility Functions

nextcord.utils.find(predicate, seq)

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

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

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

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

Parameters:

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

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

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

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

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

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

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

Examples

Basic usage:

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

Multiple attribute matching:

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

Nested attribute matching:

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

Parameters:

• iterable – An iterable to search through.

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

nextcord.utils.snowflake_time(id)

Parameters:

id (int) – The snowflake ID.

Returns:

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

Return type:

datetime.datetime

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

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

Parameters:

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

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

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

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

• scopes (Iterable[str]) –

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

  Added in version 1.7.

• disable_guild_select (bool) –

  Whether to disallow the user from changing the guild dropdown.

  Added in version 2.0.

• integration_type (IntegrationType) –

  The integration type (otherwise known as installation context) that the invite is for.

  Added in version 3.0.

Returns:

The OAuth2 URL for inviting the bot into guilds.

Return type:

str

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

A helper function that removes markdown characters.

Added in version 1.7.

Note

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

Parameters:

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

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

Returns:

The text with the markdown special characters removed.

Return type:

str

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

A helper function that escapes Discord’s markdown.

Parameters:

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

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

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

Returns:

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

Return type:

str

nextcord.utils.escape_mentions(text)

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

Note

This does not include channel mentions.

Note

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

Parameters:

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

Returns:

The text with the mentions removed.

Return type:

str

nextcord.utils.parse_raw_mentions(text)

A helper function that parses mentions from a string as an array of User IDs matched with the syntax of <@user_id> or <@!user_id>.

Note

This does not include role or channel mentions. See parse_raw_role_mentions() and parse_raw_channel_mentions() for those.

Added in version 2.2.

Parameters:

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

Returns:

A list of user IDs that were mentioned.

Return type:

List[int]

nextcord.utils.parse_raw_role_mentions(text)

A helper function that parses mentions from a string as an array of Role IDs matched with the syntax of <@&role_id>.

Added in version 2.2.

Parameters:

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

Returns:

A list of role IDs that were mentioned.

Return type:

List[int]

nextcord.utils.parse_raw_channel_mentions(text)

A helper function that parses mentions from a string as an array of GuildChannel IDs matched with the syntax of <#channel_id>.

Added in version 2.2.

Parameters:

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

Returns:

A list of channel IDs that were mentioned.

Return type:

List[int]

nextcord.utils.resolve_invite(invite)

Resolves an invite from a Invite, URL or code.

Parameters:

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

Returns:

The invite code.

Return type:

str

nextcord.utils.resolve_template(code)

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

Added in version 1.4.

Parameters:

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

Returns:

The template code.

Return type:

str

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

Added in version 1.3.

Parameters:

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

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

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

Added in version 2.0.

Returns:

The current aware datetime in UTC.

Return type:

datetime.datetime

nextcord.utils.format_dt(dt, /, style=None)

A helper function to format a datetime.datetime 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.

Added in version 2.0.

Parameters:

• dt (datetime.datetime) – The datetime to format.

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

Returns:

The formatted string.

Return type:

str

nextcord.utils.as_chunks(iterator, max_size)

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

Added in version 2.0.

Parameters:

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

• max_size (int) – The maximum chunk size.

Warning

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

Returns:

A new iterator which yields chunks of a given size.

Return type:

Union[Iterator, AsyncIterator]

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

Specifies the type of channel.

text = 0

A text channel

private = 1

A private text channel. Also called a direct message.

voice = 2

A voice channel

group = 3

A private group text channel.

category = 4

A category channel.

news = 5

A guild news channel.

news_thread = 10

A news thread.

public_thread = 11

A public thread.

private_thread = 12

A private thread.

stage_voice = 13

A guild stage voice channel.

guild_directory = 14

A channel containing the guilds in a Student Hub

forum = 15

A forum channel.

class nextcord.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 = 0

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

recipient_add = 1

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

recipient_remove = 2

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

call = 3

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

channel_name_change = 4

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

channel_icon_change = 5

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

pins_add = 6

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

new_member = 7

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

premium_guild_subscription = 8

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

premium_guild_tier_1 = 9

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

premium_guild_tier_2 = 10

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

premium_guild_tier_3 = 11

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

channel_follow_add = 12

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

Added in version 1.3.

guild_stream = 13

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

Added in version 1.7.

guild_discovery_disqualified = 14

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

Added in version 1.7.

guild_discovery_requalified = 15

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

Added in version 1.7.

guild_discovery_grace_period_initial_warning = 16

The system message denoting that the guild has failed to meet the Server

Discovery requirements for one week.

Added in version 1.7.

guild_discovery_grace_period_final_warning = 17

The system message denoting that the guild has failed to meet the Server

Discovery requirements for 3 weeks in a row.

Added in version 1.7.

thread_created = 18

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.

Added in version 2.0.

reply = 19

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

Added in version 2.0.

chat_input_command = 20

The system message denoting that a slash command was executed.

Added in version 2.0.

thread_starter_message = 21

The system message denoting the message in the thread that is the one that started the

thread’s conversation topic.

Added in version 2.0.

guild_invite_reminder = 22

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

Added in version 2.0.

context_menu_command = 23

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

Added in version 2.0.

auto_moderation_action = 24

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

Added in version 2.1.

role_subscription_purchase = 25

The system message denoting that a role subscription was purchased.

Added in version 3.2.

stage_start = 27

The system message denoting that a stage channel has started.

Added in version 2.6.

stage_end = 28

The system message denoting that a stage channel has ended.

Added in version 2.6.

stage_speaker = 29

The system message denoting that a stage channel has a new speaker.

Added in version 2.6.

stage_topic = 31

The system message denoting that a stage channel has a new topic.

Added in version 2.6.

class nextcord.VoiceRegion

Specifies the region a voice server belongs to.

us_west = 'us-west'

The US West region.

us_east = 'us-east'

The US East region.

us_south = 'us-south'

The US South region.

us_central = 'us-central'

The US Central region.

eu_west = 'eu-west'

The Western Europe region.

eu_central = 'eu-central'

The Central Europe region.

singapore = 'singapore'

The Singapore region.

london = 'london'

The London region.

sydney = 'sydney'

The Sydney region.

amsterdam = 'amsterdam'

The Amsterdam region.

frankfurt = 'frankfurt'

The Frankfurt region.

brazil = 'brazil'

The Brazil region.

hongkong = 'hongkong'

The Hong Kong region.

russia = 'russia'

The Russia region.

japan = 'japan'

The Japan region.

southafrica = 'southafrica'

The South Africa region.

south_korea = 'south-korea'

The South Korea region.

india = 'india'

The India region.

Added in version 1.2.

europe = 'europe'

The Europe region.

Added in version 1.3.

dubai = 'dubai'

The Dubai region.

Added in version 1.3.

vip_us_east = 'vip-us-east'

The US East region for VIP guilds.

vip_us_west = 'vip-us-west'

The US West region for VIP guilds.

vip_amsterdam = 'vip-amsterdam'

The Amsterdam region for VIP guilds.

class nextcord.VerificationLevel

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

Added in version 2.0.

x == y

Checks if two verification levels are equal.

x != y

Checks if two verification levels are not equal.

x > y

Checks if a verification level is higher than another.

x < y

Checks if a verification level is lower than another.

x >= y

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

x <= y

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

none = 0

No citeria set.

low = 1

Member must have a verified email on their Discord account.

medium = 2

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

high = 3

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

highest = 4

Member must have a verified phone on their Discord account.

class nextcord.ContentFilter

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

Added in version 2.0.

x == y

Checks if two content filter levels are equal.

x != y

Checks if two content filter levels are not equal.

x > y

Checks if a content filter level is higher than another.

x < y

Checks if a content filter level is lower than another.

x >= y

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

x <= y

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

disabled = 0

The guild does not have the content filter enabled.

no_role = 1

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

all_members = 2

The guild has the content filter enabled for every member.

class nextcord.Status

Specifies a Member ‘s status.

online = 'online'

The member is online.

offline = 'offline'

The member is offline.

idle = 'idle'

The member is idle.

dnd = 'dnd'

The member is “Do Not Disturb.

do_not_disturb = 'dnd'

An alias for Status.dnd.

invisible = 'invisible'

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

class nextcord.DefaultAvatar

Represents the default avatar of a Discord User.

blurple = 0

Represents the default avatar with the color blurple. See also Colour.blurple

grey = 1

Represents the default avatar with the color grey. See also Colour.greyple

gray = 1

An alias for DefaultAvatar.grey.

green = 2

Represents the default avatar with the color green. See also Colour.green

orange = 3

Represents the default avatar with the color orange. See also Colour.orange

red = 4

Represents the default avatar with the color red. See also Colour.red

fuchsia = 5

Represents the default avatar with the color fuchsia. See also Colour.fuchsia

Added in version 2.6.

pink = 5

An alias for DefaultAvatar.fuchsia.

Added in version 2.6.

class nextcord.NotificationLevel

Specifies whether a Guild has notifications on for all

messages or mentions only by default.

Added in version 2.0.

x == y

Checks if two notification levels are equal.

x != y

Checks if two notification levels are not equal.

x > y

Checks if a notification level is higher than another.

x < y

Checks if a notification level is lower than another.

x >= y

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

x <= y

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

all_messages = 0

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

only_mentions = 1

Members receive notifications for messages they are mentioned in.

class nextcord.AuditLogActionCategory

Represents the category that the AuditLogAction belongs to.

This can be retrieved via AuditLogEntry.category.

create = 1

The action is the creation of something.

delete = 2

The action is the deletion of something.

update = 3

The action is the update of something.

class nextcord.UserFlags

Represents Discord User flags.

staff = 1

The user is a Discord Employee.

partner = 2

The user is a Discord Partner.

hypesquad = 4

The user is a HypeSquad Events member.

bug_hunter = 8

The user is a Bug Hunter.

mfa_sms = 16

The user has SMS recovery for Multi Factor Authentication enabled.

premium_promo_dismissed = 32

The user has dismissed the Discord Nitro promotion.

hypesquad_bravery = 64

The user is a HypeSquad Bravery member.

hypesquad_brilliance = 128

The user is a HypeSquad Brilliance member.

hypesquad_balance = 256

The user is a HypeSquad Balance member.

early_supporter = 512

The user is an Early Supporter.

team_user = 1024

The user is a Team User.

system = 4096

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

has_unread_urgent_messages = 8192

The user has an unread system message.

bug_hunter_level_2 = 16384

The user is a Bug Hunter Level 2.

verified_bot = 65536

The user is a Verified Bot.

verified_bot_developer = 131072

The user is an Early Verified Bot Developer.

discord_certified_moderator = 262144

The user is a Discord Certified Moderator.

bot_http_interactions = 524288

The user is a bot that uses only HTTP interactions and is shown in the

online member list.

Added in version 2.4.

known_spammer = 1048576

The user is a Known Spammer.

active_developer = 4194304

The user is an Active Developer.

Added in version 2.4.

class nextcord.ActivityType

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

unknown = -1

An unknown activity type. This should generally not happen.

playing = 0

A “Playing” activity type.

streaming = 1

A “Streaming” activity type.

listening = 2

A “Listening” activity type.

watching = 3

A “Watching” activity type.

custom = 4

A “Custom” activity type.

competing = 5

A “Competing” activity type.

Added in version 1.5.

class nextcord.TeamMembershipState

Represents the membership state of a team member retrieved

through Client.application_info().

Added in version 1.3.

invited = 1

Represents an invited member.

accepted = 2

Represents a member currently in the team.

class nextcord.WebhookType

Represents the type of webhook that can be received.

Added in version 1.3.

incoming = 1

Represents a webhook that can post messages to channels with a token.

channel_follower = 2

Represents a webhook that is internally managed by Discord, used for following channels.

application = 3

Represents a webhook that is used for interactions or applications.

Added in version 2.0.

class nextcord.ExpireBehaviour

Represents the behaviour the Integration should perform when a user’s subscription has finished.

There is an alias for this called ExpireBehavior.

Added in version 1.4.

remove_role = 0

This will remove the StreamIntegration.role from the user when their subscription is finished.

kick = 1

This will kick the user when their subscription is finished.

class nextcord.StickerType

Represents the type of sticker.

Added in version 2.0.

standard = 1

Represents a standard sticker.

guild = 2

Represents a custom sticker created in a guild.

class nextcord.StickerFormatType

Represents the type of sticker images.

Added in version 1.6.

png = 1

Represents a sticker with a png image.

apng = 2

Represents a sticker with an apng image.

lottie = 3

Represents a sticker with a lottie image.

gif = 4

Represents a sticker with a GIF image.

Added in version 2.4.

class nextcord.InviteTarget

Represents the invite type for voice channel invites.

Added in version 2.0.

unknown = 0

The invite doesn’t target anyone or anything.

stream = 1

A stream invite that targets a user.

embedded_application = 2

A stream invite that targets an embedded application.

class nextcord.InteractionType

Specifies the type of Interaction.

Added in version 2.0.

ping = 1

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

application_command = 2

Represents a slash command or context menu interaction.

component = 3

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

application_command_autocomplete = 4

Represents a slash command autocomplete interaction.

modal_submit = 5

Represents a modal submit interaction.

class nextcord.InteractionResponseType

Specifies the response type for the interaction.

Added in version 2.0.

pong = 1

Pongs the interaction when given a ping.

See also InteractionResponse.pong()

channel_message = 4

Respond to the interaction with a message.

See also InteractionResponse.send_message()

deferred_channel_message = 5

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

See also InteractionResponse.defer()

deferred_message_update = 6

Acknowledges the component interaction with a promise that

the message will update later (though there is no need to actually update the message).

See also InteractionResponse.defer()

message_update = 7

Responds to the interaction by editing the message.

See also InteractionResponse.edit_message()

class nextcord.Locale

da = 'da'

Danish | Dansk

de = 'de'

German | Deutsch

en_GB = 'en-GB'

English, UK | English, UK

en_US = 'en-US'

English, US | English, US

es_ES = 'es-ES'

Spanish | Español

fr = 'fr'

French | Français

hr = 'hr'

Croatian | Hrvatski

id = 'id'

Indonesian | Bahasa Indonesia

Added in version 2.4.

it = 'it'

Italian | Italiano

lt = 'lt'

Lithuanian | Lietuviškai

hu = 'hu'

Hungarian | Magyar

nl = 'nl'

Dutch | Nederlands

no = 'no'

Norwegian | Norsk

pl = 'pl'

Polish | Polski

pt_BR = 'pt-BR'

Portuguese, Brazilian | Português do Brasil

ro = 'ro'

Romanian, Romania | Română

fi = 'fi'

Finnish | Suomi

sv_SE = 'sv-SE'

Swedish | Svenska

vi = 'vi'

Vietnamese | Tiếng Việt

tr = 'tr'

Turkish | Türkçe

cs = 'cs'

Czech | Čeština

el = 'el'

Greek | Ελληνικά

bg = 'bg'

Bulgarian | български

ru = 'ru'

Russian | Pусский

uk = 'uk'

Ukrainian | Українська

hi = 'hi'

Hindi | हिन्दी

th = 'th'

Thai | ไทย

zh_CN = 'zh-CN'

Chinese, China | 中文

ja = 'ja'

Japanese | 日本語

zh_TW = 'zh-TW'

Chinese, Taiwan | 繁體中文

ko = 'ko'

Korean | 한국어

class nextcord.VideoQualityMode

Represents the camera video quality mode for voice channel participants.

Added in version 2.0.

auto = 1

Represents auto camera video quality.

full = 2

Represents full camera video quality.

class nextcord.ComponentType

Represents the component type of a component.

Added in version 2.0.

action_row = 1

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

button = 2

Represents a button component.

select = 3

Represents a select string component.

string_select = 3

An alias for ComponentType.select.

Added in version 2.3.

text_input = 4

Represents a text input component.

user_select = 5

Represents a user select component.

Added in version 2.3.

role_select = 6

Represents a role select component.

Added in version 2.3.

mentionable_select = 7

Represents a mentionable select component.

Added in version 2.3.

channel_select = 8

Represents a channel select component.

Added in version 2.3.

class nextcord.ButtonStyle

Represents the style of the button component.

Added in version 2.0.

primary = 1

Represents a blurple button for the primary action.

secondary = 2

Represents a grey button for secondary actions.

success = 3

Represents a green button for success actions.

danger = 4

Represents a red button for dangerous actions.

link = 5

Represents a link button.

blurple = 1

An alias for ButtonStyle.primary.

grey = 2

An alias for ButtonStyle.secondary.

gray = 2

An alias for ButtonStyle.secondary.

green = 3

An alias for ButtonStyle.success.

red = 4

An alias for ButtonStyle.danger.

url = 5

An alias for ButtonStyle.link.

class nextcord.TextInputStyle

Represent the style of a text input component.

Added in version 2.0.

short = 1

Represent a single line input.

paragraph = 2

Represent a multi line input.

class nextcord.StagePrivacyLevel

Represents a stage instance’s privacy level.

Added in version 2.0.

public = 1

The stage instance can be joined by external users.

closed = 2

The stage instance can only be joined by members of the guild.

guild_only = 2

An alias for StagePrivacyLevel.closed.

class nextcord.NSFWLevel

Represents the NSFW level of a guild.

Added in version 2.0.

x == y

Checks if two NSFW levels are equal.

x != y

Checks if two NSFW levels are not equal.

x > y

Checks if a NSFW level is higher than another.

x < y

Checks if a NSFW level is lower than another.

x >= y

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

x <= y

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

default = 0

The guild has not been categorised yet.

explicit = 1

The guild contains NSFW content.

safe = 2

The guild does not contain any NSFW content.

age_restricted = 3

The guild may contain NSFW content.

class nextcord.ScheduledEventEntityType

Represents the type of an entity on a scheduled event.

stage_instance = 1

The event is for a stage

voice = 2

The event is for a voice channel.

external = 3

The event is happening elsewhere.

class nextcord.ScheduledEventPrivacyLevel

Represents the privacy level of scheduled event.

guild_only = 2

The scheduled event is only visible to members of the guild.

class nextcord.ScheduledEventStatus

Represents the status of a scheduled event.

scheduled = 1

The event is scheduled to happen.

active = 2

The event is happening.

completed = 3

The event has finished.

canceled = 4

The event was cancelled.

cancelled = 4

An alias for ScheduledEventStatus.canceled.

class nextcord.AutoModerationEventType

Represents what event context an auto moderation rule will be checked.

Added in version 2.1.

message_send = 1

A member sends or edits a message in the guild.

member_update = 2

A member edits their profile.

Added in version 3.2.

class nextcord.AutoModerationTriggerType

Represents the type of content which can trigger an auto moderation rule.

Added in version 2.1.

Changed in version 2.2: Removed harmful_link as it is no longer used by Discord.

keyword = 1

This rule checks if content contains words from a user defined list of keywords.

spam = 3

This rule checks if content represents generic spam.

keyword_preset = 4

This rule checks if content contains words from Discord pre-defined wordsets.

mention_spam = 5

This rule checks if the number of mentions in the message is more than the maximum allowed.

Added in version 2.3.

member_profile = 6

This rule checks if member profile contains words from a user defined list of keywords.

Added in version 3.2.

class nextcord.KeywordPresetType

Represents the type of a keyword preset auto moderation rule.

Added in version 2.1.

profanity = 1

Words that may be considered forms of swearing or cursing.

sexual_content = 2

Words that refer to sexually explicit behaviour or activity.

slurs = 3

Personal insults or words that may be considered hate speech.

class nextcord.AutoModerationActionType

Represents the action that will be taken if an auto moderation rule is triggered.

Added in version 2.1.

block_message = 1

Blocks a message with content matching the rule.

send_alert_message = 2

Logs message content to a specified channel.

timeout = 3

Timeout user for a specified duration.

Note

This action type can only be used with the Permissions.moderate_members permission.

block_member_interaction = 4

Prevents a member from using text, voice, or other interactions.

Added in version 3.2.

class nextcord.SortOrderType

The default sort order type used to sort posts in a ForumChannel.

Added in version 2.3.

latest_activity = 0

Sort forum posts by their activity.

creation_date = 1

Sort forum posts by their creation date.

class nextcord.RoleConnectionMetadataType

Represents the type of comparison a role connection metadata record will use.

Added in version 2.4.

integer_greater_than_or_equal = 2

The metadata value must be less than or equal to the guild’s configured value.

integer_not_equal = 4

The metadata value must be greater than or equal to the guild’s configured value.

datetime_greater_than_or_equal = 6

The metadata value must be equal to the guild’s configured value.

boolean_not_equal = 8

The metadata value must be not equal to the guild’s configured value.

class nextcord.ForumLayoutType

The default layout type used to display posts in a ForumChannel.

Added in version 2.4.

not_set = 0

No default has been set by channel administrators.

list = 1

Display posts as a list, more text focused.

gallery = 2

Display posts as a collection of posts with images, this is more image focused.

class nextcord.AuditLogAction

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

guild_update = 1

The guild has updated. Things that trigger this include:

• Changing the guild vanity URL

• Changing the guild invite splash

• Changing the guild AFK channel or timeout

• Changing the guild voice server region

• Changing the guild icon, banner, or discovery splash

• Changing the guild moderation settings

• Changing things related to the guild widget

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

Possible attributes for nextcord.AuditLogDiff:

• afk_channel

• system_channel

• afk_timeout

• default_message_notifications

• explicit_content_filter

• mfa_level

• name

• owner

• splash

• discovery_splash

• icon

• banner

• vanity_url_code

channel_create = 10

A new channel was created.

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

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

Possible attributes for nextcord.AuditLogDiff:

• name

• type

• overwrites

channel_update = 11

A channel was updated. Things that trigger this include:

• The channel name or topic was changed

• The channel bitrate was changed

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

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

Possible attributes for nextcord.AuditLogDiff:

• name

• type

• position

• overwrites

• topic

• bitrate

• rtc_region

• video_quality_mode

• default_auto_archive_duration

channel_delete = 12

A channel was deleted.

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

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

Possible attributes for nextcord.AuditLogDiff:

• name

• type

• overwrites

overwrite_create = 13

A channel permission overwrite was created.

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

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

Possible attributes for nextcord.AuditLogDiff:

• deny

• allow

• id

• type

overwrite_update = 14

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

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

Possible attributes for nextcord.AuditLogDiff:

• deny

• allow

• id

• type

overwrite_delete = 15

A channel permission overwrite was deleted.

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

Possible attributes for nextcord.AuditLogDiff:

• deny

• allow

• id

• type

kick = 20

A member was kicked.

When this is the action, the type of target is the User who got kicked.

When this is the action, changes is empty.

member_prune = 21

A member prune was triggered.

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

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

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

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

When this is the action, changes is empty.

ban = 22

A member was banned.

When this is the action, the type of target is the User who got banned.

When this is the action, changes is empty.

unban = 23

A member was unbanned.

When this is the action, the type of target is the User who got unbanned.

When this is the action, changes is empty.

member_update = 24

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

• A nickname was changed

• They were server muted or deafened (or it was undo’d)

When this is the action, the type of target is the Member or User who got updated.

Possible attributes for nextcord.AuditLogDiff:

• nick

• mute

• deaf

member_role_update = 25

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

When this is the action, the type of target is the Member or User who got the role.

Possible attributes for nextcord.AuditLogDiff:

• roles

member_move = 26

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

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

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

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

Added in version 1.3.

member_disconnect = 27

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

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

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

Added in version 1.3.

bot_add = 28

A bot was added to the guild.

When this is the action, the type of target is the Member or User which was added to the guild.

Added in version 1.3.

role_create = 30

A new role was created.

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

Possible attributes for nextcord.AuditLogDiff:

• colour

• mentionable

• hoist

• name

• permissions

role_update = 31

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

• The name has changed

• The permissions have changed

• The colour has changed

• Its hoist/mentionable state has changed

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

Possible attributes for nextcord.AuditLogDiff:

• colour

• mentionable

• hoist

• name

• permissions

role_delete = 32

A role was deleted.

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

Possible attributes for nextcord.AuditLogDiff:

• colour

• mentionable

• hoist

• name

• permissions

invite_create = 40

An invite was created.

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

Possible attributes for nextcord.AuditLogDiff:

• max_age

• code

• temporary

• inviter

• channel

• uses

• max_uses

invite_update = 41

An invite was updated.

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

invite_delete = 42

An invite was deleted.

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

Possible attributes for nextcord.AuditLogDiff:

• max_age

• code

• temporary

• inviter

• channel

• uses

• max_uses

webhook_create = 50

A webhook was created.

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

Possible attributes for nextcord.AuditLogDiff:

• channel

• name

• type (always set to 1 if so)

webhook_update = 51

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

• The webhook name changed

• The webhook channel changed

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

Possible attributes for nextcord.AuditLogDiff:

• channel

• name

• avatar

webhook_delete = 52

A webhook was deleted.

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

Possible attributes for nextcord.AuditLogDiff:

• channel

• name

• type (always set to 1 if so)

emoji_create = 60

An emoji was created.

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

Possible attributes for nextcord.AuditLogDiff:

• name

emoji_update = 61

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

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

Possible attributes for nextcord.AuditLogDiff:

• name

emoji_delete = 62

An emoji was deleted.

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

Possible attributes for nextcord.AuditLogDiff:

• name

message_delete = 72

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

When this is the action, the type of target is the Member or User who had their message deleted.

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

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

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

message_bulk_delete = 73

Messages were bulk deleted by a moderator.

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

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

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

Added in version 1.3.

message_pin = 74

A message was pinned in a channel.

When this is the action, the type of target is the Member or User who had their message pinned.

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

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

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

Added in version 1.3.

message_unpin = 75

A message was unpinned in a channel.

When this is the action, the type of target is the Member or User who had their message unpinned.

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

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

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

Added in version 1.3.

integration_create = 80

A guild integration was created.

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

Added in version 1.3.

integration_update = 81

A guild integration was updated.

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

Added in version 1.3.

integration_delete = 82

A guild integration was deleted.

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

Added in version 1.3.

stage_instance_create = 83

A stage instance was started.

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

Possible attributes for nextcord.AuditLogDiff:

• topic

• privacy_level

Added in version 2.0.

stage_instance_update = 84

A stage instance was updated.

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

Possible attributes for nextcord.AuditLogDiff:

• topic

• privacy_level

Added in version 2.0.

stage_instance_delete = 85

A stage instance was ended.

Added in version 2.0.

sticker_create = 90

A sticker was created.

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

Possible attributes for nextcord.AuditLogDiff:

• name

• emoji

• type

• format_type

• description

• available

Added in version 2.0.

sticker_update = 91

A sticker was updated.

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

Possible attributes for nextcord.AuditLogDiff:

• name

• emoji

• type

• format_type

• description

• available

Added in version 2.0.

sticker_delete = 92

A sticker was deleted.

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

Possible attributes for nextcord.AuditLogDiff:

• name

• emoji

• type

• format_type

• description

• available

Added in version 2.0.

scheduled_event_create = 100

A scheduled event was created.

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

scheduled_event_update = 101

A scheduled event was updated.

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

scheduled_event_delete = 102

A scheduled event was deleted.

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

thread_create = 110

A thread was created.

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

Possible attributes for nextcord.AuditLogDiff:

• name

• archived

• locked

• auto_archive_duration

Added in version 2.0.

thread_update = 111

A thread was updated.

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

Possible attributes for nextcord.AuditLogDiff:

• name

• archived

• locked

• auto_archive_duration

Added in version 2.0.

thread_delete = 112

A thread was deleted.

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

Possible attributes for nextcord.AuditLogDiff:

• name

• archived

• locked

• auto_archive_duration

Added in version 2.0.

auto_moderation_rule_create = 140

An auto moderation rule was created.

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

Possible attributes for nextcord.AuditLogDiff:

• actions

• enabled

• exempt_channels

• exempt_roles

• event_type

• name

• trigger_type

• trigger_metadata

Added in version 2.1.

auto_moderation_rule_update = 141

An auto moderation rule was updated.

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

Possible attributes for nextcord.AuditLogDiff:

• actions

• enabled

• exempt_channels

• exempt_roles

• event_type

• name

• trigger_type

• trigger_metadata

Added in version 2.1.

auto_moderation_rule_delete = 142

An auto moderation rule was deleted.

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

Possible attributes for nextcord.AuditLogDiff:

• actions

• enabled

• exempt_channels

• exempt_roles

• event_type

• name

• trigger_type

• trigger_metadata

Added in version 2.1.

auto_moderation_block_message = 143

A message was blocked by an auto moderation rule.

When this is the action, the type of target is the Member or User whose message was blocked.

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

• channel: A GuildChannel, Thread or Object with the channel ID where the message was blocked.

• rule_name: A str with the name of the rule.

• rule_trigger_type: A AutoModerationTriggerType value with the trigger type of the rule.

Added in version 2.1.

auto_moderation_flag_to_channel = 144

A message was flagged by an auto moderation rule.

When this is the action, the type of target is the Member or User whose message was flagged.

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

• channel: A GuildChannel, Thread or Object with the channel ID where the message was flagged.

• rule_name: A str with the name of the rule.

• rule_trigger_type: A AutoModerationTriggerType value with the trigger type of the rule.

Added in version 2.3.

auto_moderation_user_communication_disabled = 145

A member was timed out by an auto moderation rule.

When this is the action, the type of target is the Member or User who was timed out.

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

• channel: A GuildChannel, Thread or Object with the channel ID where the member was timed out.

• rule_name: A str with the name of the rule.

• rule_trigger_type: A AutoModerationTriggerType value with the trigger type of the rule.

Added in version 2.3.

class nextcord.InviteType

Represents the type of an invite.

Added in version 3.0.

guild = 0

The invite is for a guild.

group_dm = 1

The invite is for a group DM.

friend = 2

The invite is for a Discord user.

class nextcord.IntegrationType

Where a BaseApplicationCommand is available, only for globally-scoped commands.

Added in version 3.0.

guild_install = 0

App is installable to servers.

user_install = 1

App is installable to users.

class nextcord.InteractionContextType

Where a BaseApplicationCommand can be used, only for globally-scoped commands, or where a Interaction originates from.

Added in version 3.0.

guild = 0

The BaseApplicationCommand can be used within servers, or the Interaction originates from a server.

bot_dm = 1

The BaseApplicationCommand can be used within DMs with the app’s bot user, or the Interaction originates from such DMs.

private_channel = 2

The BaseApplicationCommand can be used within Group DMs and DMs other than the app’s bot user, or the Interaction originates from such channels.

class nextcord.ApplicationCommandType

Represents the type of application command.

Added in version 2.0.

chat_input = 1

The command is a slash command.

user = 2

The command is a user context menu command.

message = 3

The command is a message context menu command.

class nextcord.MessageReferenceType

Represents the type of reference that a message is.

Added in version 3.0.

default = 0

The reference is used as a reply.

forward = 1

The reference is used to point to a message.

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

You can also chunk data using the utils.as_chunks() utility method.

It can be used as follows:

async for chunk in utils.as_chunks(channel.history(), 10):
    # do stuff with chunks here

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. 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
• guild
• id
• reason
• target
• user

class nextcord.AuditLogEntry(*, auto_moderation_rules, 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.

Changed in version 1.7: Audit log entries are now comparable and hashable.

guild

The guild to which the audit log belongs.

Type:

Guild

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

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

target

The target that got changed. The exact type of this depends on the action being done.

Type:

Any

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

An audit log change set.

before

The old value. The attribute has the type of AuditLogDiff.

Depending on the AuditLogActionCategory retrieved by category, the data retrieved by this attribute differs:

Category	Description
create	All attributes are set to None.
delete	All attributes are set the value before deletion.
update	All attributes are set the value before updating.
None	No attributes are set.

after

The new value. The attribute has the type of AuditLogDiff.

Depending on the AuditLogActionCategory retrieved by category, the data retrieved by this attribute differs:

Category	Description
create	All attributes are set to the created value
delete	All attributes are set to None
update	All attributes are set the value after updating.
None	No attributes are set.

AuditLogDiff

Attributes

• actions
• afk_channel
• afk_timeout
• allow
• archived
• auto_archive_duration
• available
• avatar
• banner
• bitrate
• channel
• code
• color
• colour
• deaf
• default_auto_archive_duration
• default_message_notifications
• default_notifications
• deny
• description
• discovery_splash
• emoji
• enabled
• event_type
• exempt_channels
• exempt_roles
• explicit_content_filter
• format_type
• hoist
• icon
• id
• inviter
• locked
• max_age
• max_uses
• mentionable
• mfa_level
• mute
• name
• nick
• overwrites
• owner
• permissions
• position
• privacy_level
• public_updates_channel
• region
• roles
• rtc_region
• rules_channel
• slowmode_delay
• splash
• system_channel
• temporary
• topic
• trigger_metadata
• trigger_type
• type
• uses
• vanity_url_code
• verification_level
• video_quality_mode
• widget_channel
• widget_enabled

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

See also Guild.verification_level.

Type:

VerificationLevel

default_notifications

The guild’s default notification level.

See also Guild.default_notifications.

Type:

NotificationLevel

explicit_content_filter

The guild’s content filter.

See also Guild.explicit_content_filter.

Type:

ContentFilter

default_message_notifications

The guild’s default message notification setting.

Type:

int

vanity_url_code

The guild’s vanity URL.

See also Guild.vanity_invite() and Guild.edit().

Type:

str

position

The position of a Role or abc.GuildChannel.

Type:

int

type

The type of channel or sticker.

Type:

Union[ChannelType, StickerType]

topic

The topic of a TextChannel or StageChannel.

See also TextChannel.topic or StageChannel.topic.

Type:

str

bitrate

The bitrate of a VoiceChannel.

See also VoiceChannel.bitrate.

Type:

int

overwrites

A list of permission overwrite tuples that represents a target and a PermissionOverwrite for said target.

The first element is the object being targeted, which can either be a Member or User or Role. If this object is not found then it is a Object with an ID being filled and a type attribute set to either 'role' or 'member' to help decide what type of ID it is.

Type:

List[Tuple[target, PermissionOverwrite]]

privacy_level

The privacy level of the stage instance.

Type:

StagePrivacyLevel

roles

A list of roles being added or removed from a member.

If a role is not found then it is a Object with the ID and name being filled in.

Type:

List[Union[Role, Object]]

nick

The nickname of a member.

See also Member.nick

Type:

Optional[str]

deaf

Whether the member is being server deafened.

See also VoiceState.deaf.

Type:

bool

mute

Whether the member is being server muted.

See also VoiceState.mute.

Type:

bool

permissions

The permissions of a role.

See also Role.permissions.

Type:

Permissions

colour

color

The colour of a role.

See also Role.colour

Type:

Colour

hoist

Whether the role is being hoisted or not.

See also Role.hoist

Type:

bool

mentionable

Whether the role is mentionable or not.

See also Role.mentionable

Type:

bool

code

The invite’s code.

See also Invite.code

Type:

str

channel

A guild channel.

If the channel is not found then it is a Object with the ID being set. In some cases the channel name is also set.

Type:

Union[abc.GuildChannel, Object]

inviter

The user who created the invite.

See also Invite.inviter.

Type:

Optional[User]

max_uses

The invite’s max uses.

See also Invite.max_uses.

Type:

int

uses

The invite’s current uses.

See also Invite.uses.

Type:

int

max_age

The invite’s max age in seconds.

See also Invite.max_age.

Type:

int

temporary

If the invite is a temporary invite.

See also Invite.temporary.

Type:

bool

allow

deny

The permissions being allowed or denied.

Type:

Permissions

id

The ID of the object being changed.

Type:

int

avatar

The avatar of a member.

See also User.avatar.

Type:

Asset

slowmode_delay

The number of seconds members have to wait before sending another message in the channel.

See also TextChannel.slowmode_delay.

Type:

int

rtc_region

The region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

See also VoiceChannel.rtc_region.

Type:

VoiceRegion

video_quality_mode

The camera video quality for the voice channel’s participants.

See also VoiceChannel.video_quality_mode.

Type:

VideoQualityMode

format_type

The format type of a sticker being changed.

See also GuildSticker.format

Type:

StickerFormatType

emoji

The name of the emoji that represents a sticker being changed.

See also GuildSticker.emoji

Type:

str

description

The description of a sticker being changed.

See also GuildSticker.description

Type:

str

available

The availability of a sticker being changed.

See also GuildSticker.available

Type:

bool

archived

The thread is now archived.

Type:

bool

locked

The thread is being locked or unlocked.

Type:

bool

auto_archive_duration

The thread’s auto archive duration being changed.

See also Thread.auto_archive_duration

Type:

int

default_auto_archive_duration

The default auto archive duration for newly created threads being changed.

Type:

int

enabled

Whether something was enabled or disabled.

Type:

bool

trigger_type

The trigger type of an auto moderation rule being changed.

Type:

AutoModerationTriggerType

event_type

The event type of an auto moderation rule being changed.

Type:

AutoModerationEventType

actions

The list of actions being changed.

Type:

List[AutoModerationAction]

trigger_metadata

The trigger metadata of an auto moderation rule being changed.

Type:

AutoModTriggerMetadata

exempt_roles

The list of roles that are exempt from an auto moderation rule being changed.

If a role is not found then it is an Object with the ID set.

Type:

List[Union[Role, Object]]

exempt_channels

The list of channels that are exempt from an auto moderation rule being changed.

If a channel is not found then it is an Object with the ID set.

Type:

List[Union[abc.GuildChannel, Object]]

Webhook Support

nextcord 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 nextcord.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 nextcord import Webhook
import aiohttp

async def foo():
    async with aiohttp.ClientSession() as session:
        webhook = Webhook.from_url('url-here', session=session)
        await webhook.send('Hello World', username='Foo')

For a synchronous counterpart, see SyncWebhook.

x == y

Checks if two webhooks are equal.

x != y

Checks if two webhooks are not equal.

hash(x)

Returns the webhooks’s hash.

Changed in version 1.4: Webhooks are now comparable and hashable.

id

The webhook’s ID

Type:

int

type

The type of the webhook.

Added in version 1.3.

Type:

WebhookType

token

The authentication token of the webhook. If this is None then the webhook cannot be used to make requests.

Type:

Optional[str]

guild_id

The guild ID this webhook 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.

Added in version 2.0.

Type:

Optional[PartialWebhookGuild]

source_channel

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

Added in version 2.0.

Type:

Optional[PartialWebhookChannel]

property url

Returns the webhook’s url.

Type:

str

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

Creates a partial Webhook.

Parameters:

• id (int) – The 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.

  Added in version 2.0.

• bot_token (Optional[str]) –

  The bot authentication token for authenticated requests involving the webhook.

  Added in version 2.0.

Returns:

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

Return type:

Webhook

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

Creates a partial Webhook from a webhook URL.

Parameters:

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

  Added in version 2.0.

• bot_token (Optional[str]) –

  The bot authentication token for authenticated requests involving the webhook.

  Added in version 2.0.

Raises:

InvalidArgument – The URL is invalid.

Returns:

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

Return type:

Webhook

await fetch(*, prefer_auth=True)

This function is a coroutine.

Fetches the current webhook.

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

Added in version 2.0.

Note

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

Parameters:

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

Raises:

• HTTPException – Could not fetch the webhook

• NotFound – Could not find the webhook by this ID

• InvalidArgument – This webhook does not have a token associated with it.

Returns:

The fetched webhook.

Return type:

Webhook

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

This function is a coroutine.

Deletes this Webhook.

Parameters:

• reason (Optional[str]) –

  The reason for deleting this webhook. Shows up on the audit log.

  Added in version 1.4.

• prefer_auth (bool) –

  Whether to use the bot token over the webhook token if available. Defaults to True.

  Added in version 2.0.

Raises:

• HTTPException – Deleting the webhook failed.

• NotFound – This webhook does not exist.

• Forbidden – You do not have permissions to delete this webhook.

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

Changed in version 2.1: The avatar parameter now accepts File, Attachment, and Asset.

Parameters:

• name (Optional[str]) – The webhook’s new default name.

• avatar (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset representing the webhook’s new default avatar.

• channel (Optional[abc.Snowflake]) –

  The webhook’s new channel. This requires an authenticated webhook.

  Added in version 2.0.

• reason (Optional[str]) –

  The reason for editing this webhook. Shows up on the audit log.

  Added in version 1.4.

• prefer_auth (bool) –

  Whether to use the bot token over the webhook token if available. Defaults to True.

  Added in version 2.0.

Raises:

• 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

Returns an Asset for the avatar the webhook has.

If the webhook does not have a traditional avatar, an asset for the default avatar is returned instead.

Type:

Asset

property channel

The text channel this webhook belongs to.

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

Type:

Optional[TextChannel]

property created_at

Returns the webhook’s creation time in UTC.

Type:

datetime.datetime

property guild

The guild this webhook belongs to.

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

Type:

Optional[Guild]

is_authenticated()

bool: Whether the webhook is authenticated with a bot token.

Added in version 2.0.

is_partial()

bool: Whether the webhook is a “partial” webhook.

Added in version 2.0.

await send(content=..., *, username=..., avatar_url=..., tts=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., view=..., thread=..., wait=False, delete_after=None, ephemeral=None, flags=None, suppress_embeds=None, thread_name=None, components=None)

This function is a coroutine.

Sends a message using the webhook.

The content must be a type that can convert to a string through str(content).

To upload a single file, the file parameter should be used with a single File object.

If the embed parameter is provided, it must be of type Embed and it must be a rich embed type. You cannot mix the embed parameter with the embeds parameter, which must be a list of Embed objects to send.

Changed in version 2.4: ephemeral can now accept None to indicate that flags should be used.

Parameters:

• content (str) – The content of the message to send.

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

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

• delete_after (Optional[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.

  Added in version 2.0.

• file (File) – The file to upload. This cannot be mixed with files parameter.

• files (List[File]) – A list of files to send with the content. 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. Maximum of 10. This cannot be mixed with the embed parameter.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message.

  Added in version 1.4.

• view (nextcord.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.

  Added in version 2.0.

• thread (Snowflake) –

  Send a message to the specified thread. The thread will automatically be unarchived.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

• thread_name –

  Name of thread to create (requires the webhook channel to be a forum or media channel).

  Added in version 3.0.

Raises:

• HTTPException – Sending the message failed.

• NotFound – This webhook was not found or has expired.

• Forbidden – The authorization token for the webhook is incorrect.

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

Returns:

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

Return type:

Optional[WebhookMessage]

await fetch_message(id)

This function is a coroutine.

Retrieves a single WebhookMessage owned by this webhook.

Added in version 2.0.

Parameters:

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

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

• InvalidArgument – There was no token associated with this webhook.

Returns:

The message asked for.

Return type:

WebhookMessage

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

Added in version 1.6.

Changed in version 2.0: The edit is no longer in-place, instead the newly edited message is returned.

Parameters:

• message_id (int) – The message ID to edit.

• content (Optional[str]) – The content to edit the message with or None to clear it.

• embeds (List[Embed]) – A list of embeds to edit the message with.

• embed (Optional[Embed]) – The embed to edit the message with. None suppresses the embeds. This should not be mixed with the embeds parameter.

• file (File) –

  The file to upload. This cannot be mixed with files parameter.

  Added in version 2.0.

• files (List[File]) –

  A list of files to send with the content. This cannot be mixed with the file parameter.

  Added in version 2.0.

• attachments (List[Attachment]) –

  A list of attachments to keep in the message.

  Added in version 2.0.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

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

  Added in version 2.0.

• thread (Snowflake) –

  The thread that the message to be edited is in.

  Added in version 3.0.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

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

Returns:

The newly edited webhook message.

Return type:

WebhookMessage

await delete_message(message_id, /)

This function is a coroutine.

Deletes a message owned by this webhook.

This is a lower level interface to WebhookMessage.delete() in case you only have an ID.

Added in version 1.6.

Parameters:

message_id (int) – The message ID to delete.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

WebhookMessage

Methods

• asyncdelete
• asyncedit

class nextcord.WebhookMessage

Represents a message sent from your webhook.

This allows you to edit or delete a message sent by your webhook.

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

Added in version 1.6.

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

This function is a coroutine.

Edits the message.

Added in version 1.6.

Changed in version 2.0: The edit is no longer in-place, instead the newly edited message is returned.

Parameters:

• content (Optional[str]) – The content to edit the message with or None to clear it.

• embeds (List[Embed]) – A list of embeds to edit the message with.

• embed (Optional[Embed]) – The embed to edit the message with. None suppresses the embeds. This should not be mixed with the embeds parameter.

• file (File) –

  The file to upload. This cannot be mixed with files parameter.

  Added in version 2.0.

• files (List[File]) –

  A list of files to send with the content. This cannot be mixed with the file parameter.

  Added in version 2.0.

• attachments (List[Attachment]) –

  A list of attachments to keep in the message. To keep all existing attachments, pass message.attachments.

  Added in version 2.0.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• view (Optional[View]) –

  The updated view to update this message with. If None is passed then the view is removed.

  Added in version 2.0.

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

  Added in version 2.0.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

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

Returns:

The newly edited message.

Return type:

WebhookMessage

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message. The waiting is done in the background and deletion failures are ignored.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already.

• HTTPException – Deleting the message failed.

SyncWebhook

Attributes

• 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 nextcord.SyncWebhook

Represents a synchronous Discord webhook.

For an asynchronous counterpart, see Webhook.

x == y

Checks if two webhooks are equal.

x != y

Checks if two webhooks are not equal.

hash(x)

Returns the webhooks’s hash.

Changed in version 1.4: Webhooks are now comparable and hashable.

id

The webhook’s ID

Type:

int

type

The type of the webhook.

Added in version 1.3.

Type:

WebhookType

token

The authentication token of the webhook. If this is None then the webhook cannot be used to make requests.

Type:

Optional[str]

guild_id

The guild ID this webhook 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.

Added in version 2.0.

Type:

Optional[PartialWebhookGuild]

source_channel

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

Added in version 2.0.

Type:

Optional[PartialWebhookChannel]

property url

Returns the webhook’s url.

Type:

str

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

Creates a partial Webhook.

Parameters:

• id (int) – The 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.

Returns:

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

Return type:

Webhook

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

Creates a partial Webhook from a webhook URL.

Parameters:

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

Raises:

InvalidArgument – The URL is invalid.

Returns:

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

Return type:

Webhook

fetch(*, prefer_auth=True)

Fetches the current webhook.

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

Note

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

Parameters:

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

Raises:

• HTTPException – Could not fetch the webhook

• NotFound – Could not find the webhook by this ID

• InvalidArgument – This webhook does not have a token associated with it.

Returns:

The fetched webhook.

Return type:

SyncWebhook

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

Deletes this Webhook.

Parameters:

• reason (Optional[str]) –

  The reason for deleting this webhook. Shows up on the audit log.

  Added in version 1.4.

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

Raises:

• HTTPException – Deleting the webhook failed.

• NotFound – This webhook does not exist.

• Forbidden – You do not have permissions to delete this webhook.

• InvalidArgument – This webhook does not have a token associated with it.

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

Edits this Webhook.

Changed in version 2.1: The avatar parameter now accepts File.

Parameters:

• name (Optional[str]) – The webhook’s new default name.

• avatar (Optional[Union[bytes, File]]) – A bytes-like object, File 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.

  Added in version 1.4.

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

Raises:

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

Returns:

The newly edited webhook.

Return type:

SyncWebhook

send(content=..., *, username=..., avatar_url=..., tts=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., thread=..., wait=False, thread_name=None)

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.

Parameters:

• content (str) – The content of the message to send.

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

• 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 send with the content. 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. Maximum of 10. This cannot be mixed with the embed parameter.

• allowed_mentions (AllowedMentions) –

  Controls the mentions being processed in this message.

  Added in version 1.4.

• thread (Snowflake) –

  The thread to send this message to.

  Added in version 2.0.

• thread_name –

  Name of thread to create (requires the webhook channel to be a forum or media channel).

  Added in version 3.0.

Raises:

• HTTPException – Sending the message failed.

• NotFound – This webhook was not found.

• Forbidden – The authorization token for the webhook is incorrect.

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

Returns:

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

Return type:

Optional[SyncWebhookMessage]

fetch_message(id, /)

Retrieves a single SyncWebhookMessage owned by this webhook.

Added in version 2.0.

Parameters:

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

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

• InvalidArgument – There was no token associated with this webhook.

Returns:

The message asked for.

Return type:

SyncWebhookMessage

property avatar

Returns an Asset for the avatar the webhook has.

If the webhook does not have a traditional avatar, an asset for the default avatar is returned instead.

Type:

Asset

property channel

The text channel this webhook belongs to.

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

Type:

Optional[TextChannel]

property created_at

Returns the webhook’s creation time in UTC.

Type:

datetime.datetime

edit_message(message_id, *, content=..., embeds=..., embed=..., file=..., files=..., attachments=..., allowed_mentions=None, thread=...)

Edits a message owned by this webhook.

This is a lower level interface to WebhookMessage.edit() in case you only have an ID.

Added in version 1.6.

Parameters:

• message_id (int) – The message ID to edit.

• content (Optional[str]) – The content to edit the message with or None to clear it.

• embeds (List[Embed]) – A list of embeds to edit the message with.

• embed (Optional[Embed]) – The embed to edit the message with. None suppresses the embeds. This should not be mixed with the embeds parameter.

• file (File) – The file to upload. This cannot be mixed with files parameter.

• files (List[File]) – A list of files to send with the content. This cannot be mixed with the file parameter.

• attachments (List[Attachment]) – A list of attachments to keep in the message.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• thread (Snowflake) –

  The thread that the message to be edited is in.

  Added in version 3.0.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

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

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.

Added in version 2.0.

is_partial()

bool: Whether the webhook is a “partial” webhook.

Added in version 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.

Added in version 1.6.

Parameters:

message_id (int) – The message ID to delete.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

SyncWebhookMessage

Methods

• defdelete
• defedit

class nextcord.SyncWebhookMessage

Represents a message sent from your webhook.

This allows you to edit or delete a message sent by your webhook.

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

Added in version 2.0.

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

Edits the message.

Parameters:

• content (Optional[str]) – The content to edit the message with or None to clear it.

• embeds (List[Embed]) – A list of embeds to edit the message with.

• embed (Optional[Embed]) – The embed to edit the message with. None suppresses the embeds. This should not be mixed with the embeds parameter.

• file (File) – The file to upload. This cannot be mixed with files parameter.

• files (List[File]) – A list of files to send with the content. This cannot be mixed with the file parameter.

• attachments (List[Attachment]) – A list of attachments to keep in the message. To keep all existing attachments, pass message.attachments.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

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

Returns:

The newly edited message.

Return type:

SyncWebhookMessage

delete(*, delay=None)

Deletes the message.

Parameters:

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

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already.

• HTTPException – Deleting the message failed.

Abstract Base Classes

An abstract base class (also known as an abc) is a class that models can inherit to get their behaviour. Abstract base classes should not be instantiated. They are mainly there for usage with isinstance() and issubclass().

This library has a module related to abstract base classes, in which all the ABCs are subclasses of typing.Protocol.

Snowflake

Attributes

• id

class nextcord.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
• global_name
• mention
• name

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

global_name

The user’s global name. This is represented in the UI as “Display Name”

Added in version 2.6.

Type:

str

discriminator

The user’s discriminator.

Warning

This field is deprecated, and will only return if the user has not yet migrated to the new username update.

Deprecated since version 2.6.

Type:

str

avatar

The avatar asset the user has.

Type:

Asset

bot

If the user is a bot account.

Type:

bool

property display_name

Returns the user’s display name.

Type:

str

property mention

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

Type:

str

PrivateChannel

Attributes

• jump_url
• me

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

property jump_url

Returns a URL that allows the client to jump to the referenced messageable.

Added in version 2.0.

Type:

str

GuildChannel

Attributes

• category
• changed_roles
• created_at
• guild
• jump_url
• mention
• name
• overwrites
• permissions_synced
• position

Methods

• asyncclone
• asynccreate_invite
• asyncdelete
• asyncinvites
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncset_permissions

class nextcord.abc.GuildChannel

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

The following implement this ABC:

• TextChannel

• VoiceChannel

• CategoryChannel

• StageChannel

• ForumChannel

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.

Note

Due to API inconsistencies, the position may not mirror the correct UI ordering

Type:

int

property changed_roles

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

Type:

List[Role]

property mention

The string that allows you to mention the channel.

Type:

str

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

property overwrites

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Added in version 1.3.

Type:

bool

property jump_url

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

Added in version 2.0.

Type:

str

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

• Timed-out members

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.3: Only view_channel and read_message_history can be returned for timed-out members

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameters:

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

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await set_permissions(target, *, reason=None, **kwargs)

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.

Note

This method replaces the old overwrites with the ones given.

Examples

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)

Using PermissionOverwrite

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

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

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

Added in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

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

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

await move(*, beginning=None, end=None, before=None, after=None, offset=0, category=..., sync_permissions=False, reason=None)

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.

Note

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

Added in version 1.7.

Changed in version 2.4: beginning, end, before, after and reason now accept None.

Parameters:

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

• after (Optional[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 (Optional[str]) – The reason for the move.

Raises:

• 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_id=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.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – 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.

  Added in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is InviteTarget.stream. The user must be streaming in the channel.

  Added in version 2.0.

• target_application_id: –

  Optional[int]: The id of the embedded application for the invite, required if target_type is InviteTarget.embedded_application.

  Added in version 2.0.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The invite that was created.

Return type:

Invite

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.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

Messageable

Methods

• asyncfetch_message
• asyncforward
• defhistory
• asyncsend
• asynctrigger_typing
• deftyping

class nextcord.abc.Messageable

An ABC that details the common operations on a model that can send messages.

The following implement this ABC:

• TextChannel

• DMChannel

• GroupChannel

• VoiceChannel

• StageChannel

• User

• Member

• Context

• Thread

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

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

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

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

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

Connectable

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

Note

This ABC is not decorated with typing.runtime_checkable(), so will fail isinstance()/issubclass() checks.

Discord Models

Models are classes that are received from Discord and are not meant to be created by the user of the library.

Danger

The classes listed below are not intended to be created by users and are also read-only.

For example, this means that you should not make your own User instances nor should you modify the User instance yourself.

If you want to get one of these model classes instances they’d have to be through the cache, and a common way of doing so is through the utils.find() function or attributes of model classes that you receive from the events specified in the Event Reference.

Note

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

ClientUser

Attributes

• accent_color
• accent_colour
• avatar
• avatar_decoration
• banner
• bot
• color
• colour
• created_at
• default_avatar
• discriminator
• display_avatar
• display_name
• global_name
• id
• locale
• mention
• mfa_enabled
• name
• public_flags
• system
• verified

Methods

• asyncedit
• defmentioned_in

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

global_name

The user’s display name, if any.

Type:

Optional[str]

discriminator

The user’s discriminator.

Warning

This field is deprecated, and will only return if the user has not yet migrated to the new username update.

Deprecated since version 2.6.

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

Added in version 1.3.

Type:

bool

verified

Specifies if the user’s email is verified.

Type:

bool

locale

The IETF language tag used to identify the language the user is using.

Type:

Optional[str]

mfa_enabled

Specifies if the user has MFA turned on and working.

Type:

bool

await edit(*, username=..., avatar=..., banner=...)

This function is a coroutine.

Edits the current profile of the client.

Note

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.

Changed in version 2.0: The edit is no longer in-place, instead the newly edited client user is returned.

Changed in version 2.1: The avatar parameter now accepts File, Attachment, and Asset.

Added in version 3.0: The banner field has been added.

Parameters:

• username (str) – The new username you wish to change to.

• avatar (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset representing the image to upload. Could be None to denote no avatar.

• banner (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset representing the image to upload. Could be None to denote no banner.

Raises:

• HTTPException – Editing your profile failed.

• InvalidArgument – Wrong image format passed for avatar and/or banner.

Returns:

The newly edited client user.

Return type:

ClientUser

property accent_color

Returns the user’s accent color, if applicable.

There is an alias for this named accent_colour.

Added in version 2.0.

Note

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

Type:

Optional[Colour]

property accent_colour

Returns the user’s accent colour, if applicable.

There is an alias for this named accent_color.

Added in version 2.0.

Note

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

Type:

Optional[Colour]

property avatar

Returns an Asset for the avatar the user has.

If the user does not have a traditional avatar, None is returned. If you want the avatar that a user has displayed, consider display_avatar.

Type:

Optional[Asset]

property avatar_decoration

Returns the user’s avatar decoration, if applicable.

You can get the asset of the avatar decoration via AvatarDecoration.asset.

Added in version 3.2.

Type:

Optional[AvatarDecoration]

property banner

Returns the user’s banner asset, if available.

Added in version 2.0.

Note

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

Type:

Optional[Asset]

property color

A property that returns a color denoting the rendered color for the user. This always returns Colour.default().

There is an alias for this named colour.

Type:

Colour

property colour

A property that returns a colour denoting the rendered colour for the user. This always returns Colour.default().

There is an alias for this named color.

Type:

Colour

property created_at

Returns the user’s creation time in UTC.

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

Type:

datetime.datetime

property default_avatar

Returns the default avatar for a given user.

This is calculated by the user’s discriminator.

..versionchanged:: 2.6

Added handling for the new username system for users without a discriminator.

Type:

Asset

property display_avatar

Returns the user’s display avatar.

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

Added in version 2.0.

Type:

Asset

property display_name

Returns the user’s display name.

This will return the name using the following hierachy:

1. Global Name (also known as ‘Display Name’ in the Discord UI)

2. Unique username

Type:

str

property mention

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

Type:

str

mentioned_in(message)

Checks if the user is mentioned in the specified message.

Parameters:

message (Message) – The message to check if you’re mentioned in.

Returns:

Indicates if the user is mentioned in the message.

Return type:

bool

property public_flags

The publicly available flags the user has.

Type:

PublicUserFlags

User

Attributes

• accent_color
• accent_colour
• avatar
• avatar_decoration
• banner
• bot
• color
• colour
• created_at
• default_avatar
• discriminator
• display_avatar
• display_name
• dm_channel
• global_name
• id
• mention
• mutual_guilds
• name
• public_flags
• system

Methods

• asynccreate_dm
• asyncfetch_message
• asyncforward
• defhistory
• defmentioned_in
• asyncsend
• asynctrigger_typing
• deftyping

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

global_name

The user’s default name, if any.

..versionadded: 2.6

Type:

Optional[str]

discriminator

The user’s discriminator.

Warning

This field is deprecated, and will only return if the user has not yet migrated to the new username update.

Deprecated since version 2.6.

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)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property dm_channel

Returns the channel associated with this user if it exists.

If this returns None, you can create a DM channel by calling the create_dm() coroutine function.

Type:

Optional[DMChannel]

property mutual_guilds

The guilds that the user shares with the client.

Note

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

Added in version 1.7.

Type:

List[Guild]

property accent_color

Returns the user’s accent color, if applicable.

There is an alias for this named accent_colour.

Added in version 2.0.

Note

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

Type:

Optional[Colour]

property accent_colour

Returns the user’s accent colour, if applicable.

There is an alias for this named accent_color.

Added in version 2.0.

Note

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

Type:

Optional[Colour]

property avatar

Returns an Asset for the avatar the user has.

If the user does not have a traditional avatar, None is returned. If you want the avatar that a user has displayed, consider display_avatar.

Type:

Optional[Asset]

property avatar_decoration

Returns the user’s avatar decoration, if applicable.

You can get the asset of the avatar decoration via AvatarDecoration.asset.

Added in version 3.2.

Type:

Optional[AvatarDecoration]

property banner

Returns the user’s banner asset, if available.

Added in version 2.0.

Note

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

Type:

Optional[Asset]

property color

A property that returns a color denoting the rendered color for the user. This always returns Colour.default().

There is an alias for this named colour.

Type:

Colour

property colour

A property that returns a colour denoting the rendered colour for the user. This always returns Colour.default().

There is an alias for this named color.

Type:

Colour

await create_dm()

This function is a coroutine.

Creates a DMChannel with this user.

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

Returns:

The channel that was created.

Return type:

DMChannel

property created_at

Returns the user’s creation time in UTC.

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

Type:

datetime.datetime

property default_avatar

Returns the default avatar for a given user.

This is calculated by the user’s discriminator.

..versionchanged:: 2.6

Added handling for the new username system for users without a discriminator.

Type:

Asset

property display_avatar

Returns the user’s display avatar.

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

Added in version 2.0.

Type:

Asset

property display_name

Returns the user’s display name.

This will return the name using the following hierachy:

1. Global Name (also known as ‘Display Name’ in the Discord UI)

2. Unique username

Type:

str

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

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

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

property mention

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

Type:

str

mentioned_in(message)

Checks if the user is mentioned in the specified message.

Parameters:

message (Message) – The message to check if you’re mentioned in.

Returns:

Indicates if the user is mentioned in the message.

Return type:

bool

property public_flags

The publicly available flags the user has.

Type:

PublicUserFlags

await send(content=None, *, tts=False, 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, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

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

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

AvatarDecoration

Attributes

• asset
• sku_id
• user

class nextcord.AvatarDecoration

Represents an avatar decoration. This is a cosmetic item that can be applied to a user’s avatar.

You can get this object via User.avatar_decoration().

Added in version 3.2.

user

The user this avatar decoration belongs to.

Type:

BaseUser

sku_id

The sku id of the avatar decoration.

Type:

str

asset

The asset of the avatar decoration.

Type:

Asset

Attachment

Attributes

• content_type
• description
• duration_secs
• filename
• height
• id
• proxy_url
• size
• url
• waveform
• width

Methods

• defflags
• defis_remix
• defis_spoiler
• asyncread
• asyncsave
• asyncto_file

class nextcord.Attachment

Represents an attachment from Discord.

str(x)

Returns the URL of the attachment.

x == y

Checks if the attachment is equal to another attachment.

x != y

Checks if the attachment is not equal to another attachment.

hash(x)

Returns the hash of the attachment.

Changed in version 1.7: Attachment can now be casted to str and is hashable.

id

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

Added in version 1.7.

Type:

Optional[str]

description

The attachment’s description. This is used for alternative text in the Discord client.

Added in version 2.0.

Type:

Optional[str]

duration_secs

The duration of the audio file (currently for voice messages).

Added in version 3.0.

Type:

Optional[float]

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.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike, str]) – The file-like object to save this attachment to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

• use_cached (bool) – Whether to use proxy_url rather than url when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.

Raises:

• HTTPException – Saving the attachment failed.

• NotFound – The attachment was deleted.

Returns:

The number of bytes written.

Return type:

int

await read(*, use_cached=False)

This function is a coroutine.

Retrieves the content of this attachment as a bytes object.

Added in version 1.1.

Parameters:

use_cached (bool) – Whether to use proxy_url rather than url when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.

Raises:

• HTTPException – Downloading the attachment failed.

• Forbidden – You do not have permissions to access this attachment

• NotFound – The attachment was deleted.

Returns:

The contents of the attachment.

Return type:

bytes

await to_file(*, filename=..., description=..., use_cached=False, spoiler=False, force_close=True)

This function is a coroutine.

Converts the attachment into a File suitable for sending via abc.Messageable.send().

Added in version 1.3.

Parameters:

• filename (Optional[str]) –

  The filename to use for the file. If not specified then the filename of the attachment is used instead.

  Added in version 2.0.

• description (Optional[str]) –

  The description to use for the file. If not specified then the description of the attachment is used instead.

  Added in version 2.0.

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

  Added in version 1.4.

• spoiler (bool) –

  Whether the file is a spoiler.

  Added in version 1.4.

• force_close (bool) –

  Whether to forcibly close the bytes used to create the file

  when .close() is called. This will also make the file bytes unusable by flushing it from memory after it is sent or used once. Keep this enabled if you don’t wish to reuse the same bytes.

  Added in version 2.2.

Raises:

• HTTPException – Downloading the attachment failed.

• Forbidden – You do not have permissions to access this attachment

• NotFound – The attachment was deleted.

Returns:

The attachment as a file suitable for sending.

Return type:

File

waveform

The base64 decoded data representing a sampled waveform (currently for voice messages).

Added in version 3.0.

Type:

Optional[array[int]]

flags()

Optional[AttachmentFlags]: The avaliable flags that the attachment has.

Added in version 2.6.

is_remix()

bool: Whether the attachment is remixed.

Asset

Attributes

• key
• url

Methods

• defis_animated
• asyncread
• defreplace
• asyncsave
• asyncto_file
• defwith_format
• defwith_size
• defwith_static_format

class nextcord.Asset

Represents a CDN asset on Discord.

str(x)

Returns the URL of the CDN asset.

len(x)

Returns the length of the CDN asset’s URL.

x == y

Checks if the asset is equal to another asset.

x != y

Checks if the asset is not equal to another asset.

hash(x)

Returns the hash of the asset.

property url

Returns the underlying URL of the asset.

Type:

str

property key

Returns the identifying key of the asset.

Type:

str

is_animated()

bool: Returns whether the asset is animated.

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

Returns a new asset with the passed components replaced.

Parameters:

• size (int) – The new size of the asset.

• format (str) – The new format to change it to. Must be either ‘webp’, ‘jpeg’, ‘jpg’, ‘png’, or ‘gif’ if it’s animated.

• static_format (str) – The new format to change it to if the asset isn’t animated. Must be either ‘webp’, ‘jpeg’, ‘jpg’, or ‘png’.

Raises:

InvalidArgument – An invalid size or format was passed.

Returns:

The newly updated asset.

Return type:

Asset

with_size(size, /)

Returns a new asset with the specified size.

Parameters:

size (int) – The new size of the asset.

Raises:

InvalidArgument – The asset had an invalid size.

Returns:

The new updated asset.

Return type:

Asset

with_format(format, /)

Returns a new asset with the specified format.

Parameters:

format (str) – The new format of the asset.

Raises:

InvalidArgument – The asset had an invalid format.

Returns:

The new updated asset.

Return type:

Asset

with_static_format(format, /)

Returns a new asset with the specified static format.

This only changes the format if the underlying asset is not animated. Otherwise, the asset is not changed.

Parameters:

format (str) – The new static format of the asset.

Raises:

InvalidArgument – The asset had an invalid format.

Returns:

The new updated asset.

Return type:

Asset

await read()

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, filename=..., description=None, spoiler=False, force_close=True)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

Added in version 2.0.

Parameters:

• filename (Optional[str]) – The filename of the file. If not provided, then the filename from the asset’s URL is used.

• description (Optional[str]) – The description for the file.

• spoiler (bool) – Whether the file is a spoiler.

• force_close (bool) –

  Whether to forcibly close the bytes used to create the file when .close() is called. This will also make the file bytes unusable by flushing it from memory after it is sent or used once. Keep this enabled if you don’t wish to reuse the same bytes.

  Added in version 2.2.

Raises:

• DiscordException – The asset does not have an associated state.

• InvalidArgument – The asset is a unicode emoji.

• TypeError – The asset is a sticker with lottie type.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The asset as a file suitable for sending.

Return type:

File

Message

Attributes

• activity
• application
• attachments
• author
• channel
• channel_mentions
• clean_content
• components
• content
• created_at
• edited_at
• embeds
• flags
• guild
• id
• interaction
• interaction_metadata
• jump_url
• mention_everyone
• mentions
• nonce
• pinned
• raw_channel_mentions
• raw_mentions
• raw_role_mentions
• reactions
• reference
• role_mentions
• role_subscription
• snapshots
• stickers
• system_content
• thread
• tts
• type
• webhook_id

Methods

• asyncadd_reaction
• asyncclear_reaction
• asyncclear_reactions
• asynccreate_thread
• asyncdelete
• asyncedit
• asyncforward
• defis_system
• asyncpin
• asyncpublish
• asyncremove_reaction
• asyncreply
• defto_reference
• asyncunpin

class nextcord.Message

Represents a message from Discord.

x == y

Checks if two messages are equal.

x != y

Checks if two messages are not equal.

hash(x)

Returns the message’s hash.

tts

Specifies if the message was done with text-to-speech. This can only be accurately received in on_message() due to a discord limitation.

Type:

bool

type

The type of message. In most cases this should not be checked, but it is helpful in cases where it might be a system message for system_content.

Type:

MessageType

author

A Member that sent the message. If channel is a private channel or the user has the left the guild, then it is a User instead.

Type:

Union[Member, abc.User]

content

The actual contents of the message.

Type:

str

nonce

The value used by the discord guild and the client to verify that the message is successfully sent. This is not stored long term within Discord’s servers and is only used ephemerally.

Type:

Optional[Union[str, int]]

embeds

A list of embeds the message has.

Type:

List[Embed]

channel

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

Added in version 1.5.

Type:

Optional[MessageReference]

mention_everyone

Specifies if the message mentions everyone.

Note

This does not check if the @everyone or the @here text is in the message itself. Rather this boolean indicates if either the @everyone or the @here text is in the message and it did end up mentioning.

Type:

bool

mentions

A list of Member that were mentioned. If the message is in a private message then the list will be of User instead. For messages that are not of type MessageType.default, this array can be used to aid in system messages. For more information, see system_content.

Warning

The order of the mentions list is not in any particular order so you should not rely on it. This is a Discord limitation, not one with the library.

Type:

List[abc.User]

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.

Added in version 1.3.

Type:

MessageFlags

reactions

Reactions to a message. Reactions can be either custom emoji or standard unicode emoji.

Type:

List[Reaction]

activity

The activity associated with this message. Sent with Rich-Presence related messages that for example, request joining, spectating, or listening to or with another member.

It is a dictionary with the following optional keys:

• type: An integer denoting the type of message activity being requested.

• party_id: The party ID associated with the party.

Type:

Optional[dict]

application

The rich presence enabled application associated with this message.

It is a dictionary with the following keys:

• id: A string representing the application’s ID.

• name: A string representing the application’s name.

• description: A string representing the application’s description.

• icon: A string representing the icon ID of the application.

• cover_image: A string representing the embed’s image asset ID.

Type:

Optional[dict]

stickers

A list of sticker items given to the message.

Added in version 1.6.

Type:

List[StickerItem]

components

A list of components in the message.

Added in version 2.0.

Type:

List[Component]

guild

The guild that the message belongs to, if applicable.

Type:

Optional[Guild]

interaction

The interaction data of a message, if applicable.

Warning

This field is deprecated, use interaction_metadata instead.

Deprecated since version 3.0.

Type:

Optional[MessageInteraction]

interaction_metadata

The interaction metadata of a message. Present if the message is sent as a result of an interaction.

Added in version 3.0.

Type:

Optional[MessageInteractionMetadata]

snapshots

A list of message snapshots that the message contains.

Added in version 3.0.

Type:

List[MessageSnapshot]

role_subscription

The role subscription data of a message, if applicable.

Added in version 3.2.

Type:

Optional[MessageRoleSubscription]

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.

Note

This does not affect markdown. If you want to escape or remove markdown then use utils.escape_markdown() or utils.remove_markdown() respectively, along with this function.

Type:

str

property created_at

The message’s creation time in UTC.

Type:

datetime.datetime

property edited_at

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

Type:

Optional[datetime.datetime]

property jump_url

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

Type:

str

property thread

The thread started from this message. None if no thread was started.

Type:

Optional[Thread]

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.

Added in version 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.

Changed in version 1.1: Added the new delay keyword-only parameter.

Parameters:

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

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already

• HTTPException – Deleting the message failed.

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

This function is a coroutine.

Edits the message.

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

Changed in version 1.3: The suppress keyword-only parameter was added.

Parameters:

• content (Optional[str]) – The new content to replace the message with. Could be None to remove the content.

• embed (Optional[Embed]) – The new embed to replace the original with. Could be None to remove the embed.

• embeds (List[Embed]) –

  The new embeds to replace the original with. Must be a maximum of 10. To remove all embeds [] should be passed.

  Added in version 2.0.

• attachments (List[Attachment]) – A list of attachments to keep in the message. To keep all existing attachments, pass message.attachments.

• 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 1.4.

• view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.

• file (Optional[File]) –

  If provided, a new file to add to the message.

  Added in version 2.0.

• files (Optional[List[File]]) –

  If provided, a list of new files to add to the message.

  Added in version 2.0.

Raises:

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

Returns:

The edited message.

Return type:

Message

await publish()

This function is a coroutine.

Publishes this message to your announcement channel.

You must have the send_messages permission to do this.

If the message is not your own then the manage_messages permission is also needed.

Raises:

• Forbidden – You do not have the proper permissions to publish this message.

• HTTPException – Publishing the message failed.

await pin(*, reason=None)

This function is a coroutine.

Pins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

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

Added in version 1.4.

Raises:

• Forbidden – You do not have permissions to pin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Pinning the message failed, probably due to the channel having more than 50 pinned messages.

await unpin(*, reason=None)

This function is a coroutine.

Unpins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

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

Added in version 1.4.

Raises:

• Forbidden – You do not have permissions to unpin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Unpinning the message failed.

await add_reaction(emoji)

This function is a coroutine.

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.

Parameters:

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

Raises:

• HTTPException – Adding the reaction failed.

• Forbidden – You do not have the proper permissions to react to the message.

• NotFound – The emoji you specified was not found.

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

Parameters:

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

• member (abc.Snowflake) – The member for which to remove the reaction.

Raises:

• HTTPException – Removing the reaction failed.

• Forbidden – You do not have the proper permissions to remove the reaction.

• NotFound – The member or emoji you specified was not found.

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

Added in version 1.3.

Parameters:

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

Raises:

• HTTPException – Clearing the reaction failed.

• Forbidden – You do not have the proper permissions to clear the reaction.

• NotFound – The emoji you specified was not found.

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

Raises:

• HTTPException – Removing the reactions failed.

• Forbidden – You do not have the proper permissions to remove all the reactions.

await create_thread(*, name, auto_archive_duration=...)

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.

Added in version 2.0.

Parameters:

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

Raises:

• Forbidden – You do not have permissions to create a thread.

• HTTPException – Creating the thread failed.

• InvalidArgument – This message does not have guild info attached.

Returns:

The created thread.

Return type:

Thread

await reply(content=None, **kwargs)

This function is a coroutine.

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

Added in version 1.6.

Raises:

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

Returns:

The message that was sent.

Return type:

Message

await forward(channel)

Forward this message to a channel.

Note

It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Parameters:

channel (Messageable) – The channel to forward this message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

to_reference(*, fail_if_not_exists=True)

Creates a MessageReference from the current message.

Added in version 1.6.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

Added in version 1.7.

Returns:

The reference to this message.

Return type:

MessageReference

DeletedReferencedMessage

Attributes

• channel_id
• guild_id
• id

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

Added in version 1.6.

property id

The message ID of the deleted referenced message.

Type:

int

property channel_id

The channel ID of the deleted referenced message.

Type:

int

property guild_id

The guild ID of the deleted referenced message.

Type:

Optional[int]

Reaction

Attributes

• count
• emoji
• me
• message

Methods

• asyncclear
• defis_custom_emoji
• asyncremove
• defusers

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

This function returns an async iterator.

Returns an async iterator representing the users that have reacted to the message.

The after parameter must represent a member and meet the abc.Snowflake abc.

Examples

Usage

# I do not actually recommend doing this.
async for user in reaction.users():
    await channel.send(f'{user} has reacted with {reaction.emoji}!')

Parameters:

• limit (Optional[int]) – The maximum number of results to return. If not provided, returns all the users who reacted to the message.

• after (Optional[abc.Snowflake]) – For pagination, reactions are sorted by member.

Raises:

HTTPException – Getting the users for the reaction failed.

Yields:

Union[User, Member] – The member (if retrievable) or the user that has reacted to this message. The case where it can be a Member is in a guild message context. Sometimes it can be a User if the member has left the guild.

is_custom_emoji()

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.

Parameters:

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

Raises:

• HTTPException – Removing the reaction failed.

• Forbidden – You do not have the proper permissions to remove the reaction.

• NotFound – The user you specified, or the reaction’s message was not found.

await clear()

This function is a coroutine.

Clears this reaction from the message.

You need the manage_messages permission to use this.

Added in version 1.3.

Raises:

• HTTPException – Clearing the reaction failed.

• Forbidden – You do not have the proper permissions to clear the reaction.

• NotFound – The emoji you specified was not found.

• InvalidArgument – The emoji parameter is invalid.

Guild

Attributes

• afk_channel
• afk_timeout
• approximate_member_count
• approximate_presence_count
• banner
• bitrate_limit
• bots
• categories
• channels
• chunked
• created_at
• default_notifications
• default_role
• description
• discovery_splash
• emoji_limit
• emojis
• explicit_content_filter
• features
• filesize_limit
• forum_channels
• humans
• icon
• id
• invites_disabled
• large
• max_members
• max_presences
• max_stage_video_channel_users
• max_video_channel_users
• me
• member_count
• members
• mfa_level
• name
• nsfw_level
• owner
• owner_id
• preferred_locale
• premium_progress_bar_enabled
• premium_subscriber_role
• premium_subscribers
• premium_subscription_count
• premium_tier
• public_updates_channel
• region
• roles
• rules_channel
• safety_alerts_channel
• scheduled_events
• self_role
• shard_id
• splash
• stage_channels
• stage_instances
• sticker_limit
• stickers
• system_channel
• system_channel_flags
• text_channels
• threads
• unavailable
• verification_level
• voice_channels
• voice_client

Methods

• asyncactive_threads
• defaudit_logs
• asyncauto_moderation_rules
• asyncban
• defbans
• asyncbulk_ban
• defby_category
• asyncchange_voice_state
• asyncchunk
• asynccreate_auto_moderation_rule
• asynccreate_category
• asynccreate_category_channel
• asynccreate_custom_emoji
• asynccreate_forum_channel
• asynccreate_integration
• asynccreate_role
• asynccreate_scheduled_event
• asynccreate_stage_channel
• asynccreate_sticker
• asynccreate_template
• asynccreate_text_channel
• asynccreate_voice_channel
• asyncdelete
• asyncdelete_emoji
• asyncdelete_sticker
• asyncedit
• asyncedit_role_positions
• asyncedit_widget
• asyncestimate_pruned_members
• asyncfetch_auto_moderation_rule
• asyncfetch_ban
• asyncfetch_channel
• asyncfetch_channels
• asyncfetch_emoji
• asyncfetch_emojis
• asyncfetch_member
• deffetch_members
• asyncfetch_role
• asyncfetch_roles
• asyncfetch_scheduled_event
• deffetch_scheduled_events
• asyncfetch_sticker
• asyncfetch_stickers
• defget_application_commands
• defget_channel
• defget_channel_or_thread
• defget_member
• defget_member_named
• defget_role
• defget_scheduled_event
• defget_stage_instance
• defget_thread
• asyncintegrations
• asyncinvites
• asynckick
• asyncleave
• defparse_channel_mentions
• defparse_mentions
• defparse_role_mentions
• asyncprune_members
• asyncquery_members
• asyncrollout_application_commands
• asyncsync_application_commands
• asynctemplates
• asyncunban
• asyncvanity_invite
• asyncwebhooks
• asyncwidget

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

Added in version 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.

Note

This attribute is only available via Client.fetch_guild().

Type:

Optional[int]

max_video_channel_users

The maximum amount of users in a video channel.

Added in version 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.

• AUTO_MODERATION: Guild has set up auto moderation rules.

• APPLICATION_COMMAND_PERMISSIONS_V2: Guild is using the old permissions configuration behavior.

• BANNER: Guild can upload and use a banner. (i.e. banner)

• COMMUNITY: Guild is a community server.

• DEVELOPER_SUPPORT_SERVER: Guild has been set as a support server on the App Directory.

• DISCOVERABLE: Guild shows up in Server Discovery.

• ENHANCED_ROLE_COLORS: Guild has enhanced role colors enabled (gradients, holographic).

• FEATURABLE: Guild is able to be featured in Server Discovery.

• INVITES_DISABLED: Guild has paused invites, preventing new users from joining.

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

• RAID_ALERTS_DISABLED: Guild disabled alerts for join raids in the configured safety alerts channel.

• ROLE_ICONS: Guild is able to set role icons.

• TICKETED_EVENTS_ENABLED: Guild has enabled ticketed events.

• VANITY_URL: Guild can have a vanity invite URL (e.g. discord.gg/discord-api).

• VERIFIED: Guild is a verified server.

• VIP_REGIONS: Guild has VIP voice regions.

• WELCOME_SCREEN_ENABLED: Guild has enabled the welcome screen.

• ROLE_SUBSCRIPTIONS_ENABLED: Guild has enabled role subscriptions.

• ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE: Guild has role subscriptions that can be purchased.

Type:

List[str]

premium_tier

The premium tier for this guild. Corresponds to “Boost Level” 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.

Added in version 2.0.

Type:

NSFWLevel

approximate_member_count

The approximate number of members in the guild. This is None unless the guild is obtained using Client.fetch_guild() with with_counts=True.

Added in version 2.0.

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. This is None unless the guild is obtained using Client.fetch_guild() with with_counts=True.

Added in version 2.0.

Type:

Optional[int]

max_stage_video_channel_users

The maximum amount of users in a stage channel when video is being broadcasted.

Added in version 2.6.

Type:

Optional[int]

async for ... in fetch_members(*, limit=1000, after=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the guild’s members. In order to use this, Intents.members() must be enabled.

Note

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

Added in version 1.3.

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of members to retrieve. Defaults to 1000. Pass None to fetch all members. Note that this is potentially slow.

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

Raises:

• ClientException – The members intent is not enabled.

• HTTPException – Getting the members failed.

Yields:

Member – The member with the member data parsed.

Examples

Usage

async for member in guild.fetch_members(limit=150):
    print(member.name)

async for ... in audit_logs(*, limit=100, before=None, after=None, oldest_first=None, user=None, action=None)

This function returns an async iterator.

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

You must have the view_audit_log permission to use this.

Examples

Getting the first 100 entries:

async for entry in guild.audit_logs(limit=100):
    print(f'{entry.user} did {entry.action} to {entry.target}')

Getting entries for a specific action:

async for entry in guild.audit_logs(action=nextcord.AuditLogAction.ban):
    print(f'{entry.user} banned {entry.target}')

Getting entries made by a specific user:

entries = [entry async for entry in guild.audit_logs(limit=None, user=guild.me)]
await channel.send(f'I made {len(entries)} moderation actions.')

Parameters:

• limit (Optional[int]) – The number of entries to retrieve. If None retrieve all entries.

• before (Optional[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 (Optional[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 (Optional[bool]) – If set to True, return entries in oldest->newest order. Defaults to True if after is specified, otherwise False.

• user (Optional[abc.Snowflake]) – The moderator to filter entries from.

• action (Optional[AuditLogAction]) – The action to filter with.

Raises:

• Forbidden – You are not allowed to fetch audit logs

• HTTPException – An error occurred while fetching the audit logs.

Yields:

AuditLogEntry – The audit log entry.

property channels

A list of channels that belong to this guild.

Type:

List[abc.GuildChannel]

property threads

A list of threads that you have permission to view.

Added in version 2.0.

Type:

List[Thread]

property large

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 invites_disabled

Indicates if the guild’s invites are paused.

Added in version 2.4.

Type:

bool

property voice_channels

A list of voice channels that belong to this guild.

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

Type:

List[VoiceChannel]

property stage_channels

A list of stage channels that belong to this guild.

Added in version 1.7.

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

Type:

List[StageChannel]

property me

Similar to Client.user except an instance of Member. This is essentially used to get the member version of yourself.

Type:

Member

property voice_client

Returns the VoiceProtocol associated with this guild, if any.

Type:

Optional[VoiceProtocol]

property text_channels

A list of text channels that belong to this guild.

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

Type:

List[TextChannel]

property categories

A list of categories that belong to this guild.

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

Type:

List[CategoryChannel]

property forum_channels

A list of forum channels that belong to this guild.

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

Type:

List[ForumChannel]

property scheduled_events

A list of scheduled events in this guild.

Added in version 2.0.

Type:

List[ScheduledEvent]

property premium_progress_bar_enabled

] Whether the premium boost progress bar is enabled.

Added in version 2.6.

Type:

Optional[bool

by_category()

Returns every CategoryChannel and their associated channels.

These channels and categories are sorted in the official Discord UI order.

If the channels do not have a category, then the first element of the tuple is None.

Returns:

The categories and their associated channels.

Return type:

List[Tuple[Optional[CategoryChannel], List[abc.GuildChannel]]]

get_channel_or_thread(channel_id, /)

Returns a channel or thread with the given ID.

Added in version 2.0.

Parameters:

channel_id (int) – The ID to search for.

Returns:

The returned channel or thread or None if not found.

Return type:

Optional[Union[Thread, abc.GuildChannel]]

get_channel(channel_id, /)

Returns a channel with the given ID.

Note

This does not search for threads.

Parameters:

channel_id (int) – The ID to search for.

Returns:

The returned channel or None if not found.

Return type:

Optional[abc.GuildChannel]

get_thread(thread_id, /)

Returns a thread with the given ID.

Added in version 2.0.

Parameters:

thread_id (int) – The ID to search for.

Returns:

The returned thread or None if not found.

Return type:

Optional[Thread]

property system_channel

Returns the guild’s channel used for system messages.

If no channel is set, then this returns None.

Type:

Optional[TextChannel]

property system_channel_flags

Returns the guild’s system channel settings.

Type:

SystemChannelFlags

property rules_channel

Return’s the guild’s channel used for the rules. The guild must be a Community guild.

If no channel is set, then this returns None.

Added in version 1.3.

Type:

Optional[TextChannel]

property public_updates_channel

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.

Added in version 1.4.

Type:

Optional[TextChannel]

property safety_alerts_channel

Returns the guild’s channel where admins and moderators of the guild receive safety alerts from Discord. The guild must be a Community guild.

If no channel is set then this returns None.

Added in version 2.6.

Type:

Optional[TextChannel]

property emoji_limit

The maximum number of emoji slots this guild has.

Type:

int

property sticker_limit

The maximum number of sticker slots this guild has.

Added in version 2.0.

Type:

int

property bitrate_limit

The maximum bitrate for voice channels this guild can have.

Type:

float

property filesize_limit

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

Type:

int

property members

A list of members that belong to this guild.

Type:

List[Member]

property bots

A list of bots that belong to this guild.

Warning

Due to a Discord limitation, in order for this attribute to remain up-to-date and accurate, it requires Intents.members to be specified.

Added in version 2.0.

Type:

List[Member]

property humans

A list of user accounts that belong to this guild.

Warning

Due to a Discord limitation, in order for this attribute to remain up-to-date and accurate, it requires Intents.members to be specified.

Added in version 2.0.

Type:

List[Member]

get_member(user_id, /)

Returns a member with the given ID.

Parameters:

user_id (int) – The ID to search for.

Returns:

The member or None if not found.

Return type:

Optional[Member]

property premium_subscribers

A list of members who have “boosted” this guild.

Type:

List[Member]

property roles

Returns a list of the guild’s roles in hierarchy order.

The first element of this list will be the lowest role in the hierarchy.

Type:

List[Role]

get_role(role_id, /)

Returns a role with the given ID.

Parameters:

role_id (int) – The ID to search for.

Returns:

The role or None if not found.

Return type:

Optional[Role]

property default_role

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

Type:

Role

property premium_subscriber_role

Gets the premium subscriber role, AKA “boost” role, in this guild.

Added in version 1.6.

Type:

Optional[Role]

property self_role

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

Added in version 1.6.

Type:

Optional[Role]

property stage_instances

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

Added in version 2.0.

Type:

List[StageInstance]

get_stage_instance(stage_instance_id, /)

Returns a stage instance with the given ID.

Added in version 2.0.

Parameters:

stage_instance_id (int) – The ID to search for.

Returns:

The stage instance or None if not found.

Return type:

Optional[StageInstance]

property owner

The member that owns the guild.

Type:

Optional[Member]

property icon

Returns the guild’s icon asset, if available.

Type:

Optional[Asset]

property banner

Returns the guild’s banner asset, if available.

Type:

Optional[Asset]

property splash

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

Type:

Optional[Asset]

property discovery_splash

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

Type:

Optional[Asset]

property member_count

Returns the true member count, if available.

Warning

Due to a Discord limitation, in order for this attribute to remain up-to-date and accurate, it requires Intents.members to be specified.

Type:

Optional[int]

property chunked

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

Returns the shard ID for this guild if applicable.

Type:

int

property created_at

Returns the guild’s creation time in UTC.

Type:

datetime.datetime

get_member_named(name, /)

Returns the first member found that matches the name provided.

The name can have an optional discriminator argument, e.g. “Jake#0001” or “Jake” will both do the lookup. However the former will give a more precise result. Note that the discriminator must have all 4 digits for this to work.

If a nickname is passed, then it is looked up via the nickname. Note however, that a nickname + discriminator combo will not lookup the nickname but rather the username + discriminator combo due to nickname + discriminator not being unique.

If no member is found, None is returned.

Parameters:

name (str) – The name of the member to lookup with an optional discriminator.

Returns:

The member in this guild with the associated name. If not found then None is returned.

Return type:

Optional[Member]

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

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.

Note

Creating a channel of a specified position will not update the position of other channels to follow suit. A follow-up call to edit() will be required to update the position of the channel in the channel list.

Examples

Creating a basic channel:

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

Creating a “secret” channel:

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

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

Parameters:

• name (str) – The channel’s name.

• overwrites (Dict[Union[Role, Member], PermissionOverwrite]) – A dict of target (either a role or a member) to PermissionOverwrite to apply upon creation of a channel. Useful for creating secret channels.

• category (Optional[CategoryChannel]) – The category to place the newly created channel under. The permissions will be automatically synced to category if no overwrites are provided.

• position (int) – The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

• topic (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.

Raises:

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

Returns:

The channel that was just created.

Return type:

TextChannel

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

This function is a coroutine.

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

Parameters:

• name (str) – The channel’s name.

• overwrites (Dict[Union[Role, Member], PermissionOverwrite]) – A dict of target (either a role or a member) to PermissionOverwrite to apply upon creation of a channel. Useful for creating secret channels.

• category (Optional[CategoryChannel]) – The category to place the newly created channel under. The permissions will be automatically synced to category if no overwrites are provided.

• position (int) – The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

• bitrate (int) – The channel’s preferred audio bitrate in bits per second.

• user_limit (int) – The channel’s limit for number of members that can be in a voice channel.

• rtc_region (Optional[VoiceRegion]) –

  The region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

  Added in version 1.7.

• video_quality_mode (VideoQualityMode) –

  The camera video quality for the voice channel’s participants.

  Added in version 2.0.

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

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

• InvalidArgument – The permission overwrite information is not in proper form.

Returns:

The channel that was just created.

Return type:

VoiceChannel

await create_stage_channel(name, *, topic, position=..., overwrites=..., category=None, bitrate=None, user_limit=None, nsfw=None, rtc_region=..., video_quality_mode=None, reason=None)

This function is a coroutine.

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

Added in version 1.7.

Parameters:

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

• bitrate (Optional[int]) –

  The channel’s preferred audio bitrate in bits per second.

  Added in version 2.6.

• user_limit (int) –

  The channel’s limit for number of members that can be in a voice channel.

  Added in version 2.6.

• rtc_region (Optional[VoiceRegion]) –

  The region for the voice channel’s voice communication. A value of None indicates automatic voice region detection.

  Added in version 2.6.

• nsfw (bool) –

  To mark the channel as NSFW or not.

  Added in version 2.6.

• video_quality_mode (VideoQualityMode) –

  The camera video quality for the voice channel’s participants.

  Added in version 2.6.

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

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

• InvalidArgument – The permission overwrite information is not in proper form.

Returns:

The channel that was just created.

Return type:

StageChannel

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

This function is a coroutine.

Same as create_text_channel() except makes a CategoryChannel instead.

Note

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

Raises:

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

Returns:

The channel that was just created.

Return type:

CategoryChannel

await create_forum_channel(name, *, topic, position=..., overwrites=..., category=None, default_thread_slowmode_delay=..., default_reaction=..., available_tags=..., reason=None, default_sort_order=..., default_forum_layout=None)

This function is a coroutine.

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

Added in version 2.1.

Changed in version 2.5: Added the default_forum_layout parameter.

Parameters:

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

• default_sort_order (Optional[SortOrderType]) –

  The default sort order used to sort posts in this channel.

  Added in version 2.3.

• default_thread_slowmode_delay (int) –

  The default slowmode delay for threads created in this channel. Must be between 0 and 21600.

  Added in version 2.4.

• default_reaction (Optional[Union[Emoji, PartialEmoji, str]]) –

  The default reaction for threads created in this channel.

  Added in version 2.4.

• available_tags (List[ForumTag]) –

  The available tags for threads created in this channel.

  Added in version 2.4.

• default_forum_layout (Optional[ForumLayoutType]) – The default layout type used to display posts in this forum.

Raises:

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

Returns:

The channel that was just created.

Return type:

ForumChannel

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

This function is a coroutine.

Same as create_text_channel() except makes a CategoryChannel instead.

Note

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

Raises:

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

Returns:

The channel that was just created.

Return type:

CategoryChannel

await leave()

This function is a coroutine.

Leaves the guild.

Note

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

Raises:

HTTPException – Leaving the guild failed.

await delete()

This function is a coroutine.

Deletes the guild. You must be the guild owner to delete the guild.

Raises:

• HTTPException – Deleting the guild failed.

• Forbidden – You do not have permissions to delete the guild.

await edit(*, reason=..., name=..., description=..., icon=..., banner=..., splash=..., discovery_splash=..., community=..., 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=..., invites_disabled=..., premium_progress_bar_enabled=...)

This function is a coroutine.

Edits the guild.

You must have the manage_guild permission to edit the guild.

Changed in version 1.4: The rules_channel and public_updates_channel keyword-only parameters were added.

Changed in version 2.0: The discovery_splash and community keyword-only parameters were added.

Changed in version 2.0: The newly updated guild is returned.

Changed in version 2.1: The icon, banner, splash, discovery_splash parameters now accept File, Attachment, and Asset.

Changed in version 2.4: The invites_disabled parameter has been added.

Changed in version 2.6: The premium_progress_bar_enabled parameter has been added.

Parameters:

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

• description (Optional[str]) – The new description of the guild. Could be None for no description. This is only available to guilds that contain PUBLIC in Guild.features.

• icon (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset 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 (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset representing the banner. Could be None to denote removal of the banner. This is only available to guilds that contain BANNER in Guild.features.

• splash (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset 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 (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset 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.

• invites_disabled (bool) – Whether the invites should be paused for the guild. This will prevent new users from joining said guild.

• premium_progress_bar_enabled (bool) – Whether the premium guild boost progress bar is enabled.

• reason (Optional[str]) – The reason for editing this guild. Shows up on the audit log.

Raises:

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

Returns:

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

Return type:

Guild

await fetch_channels()

This function is a coroutine.

Retrieves all abc.GuildChannel that the guild has.

Note

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

Added in version 1.2.

Raises:

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

• HTTPException – Retrieving the channels failed.

Returns:

All channels in the guild.

Return type:

Sequence[abc.GuildChannel]

await active_threads()

This function is a coroutine.

Returns a list of active Thread that the client can access.

This includes both private and public threads.

Added in version 2.0.

Raises:

HTTPException – The request to get the active threads failed.

Returns:

The active threads

Return type:

List[Thread]

await fetch_member(member_id, /)

This function is a coroutine.

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

Note

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

Parameters:

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

Raises:

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

• HTTPException – Fetching the member failed.

Returns:

The member from the member ID.

Return type:

Member

await fetch_ban(user)

This function is a coroutine.

Retrieves the BanEntry for a user.

You must have the ban_members permission to get this information.

Parameters:

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

Raises:

• Forbidden – You do not have proper permissions to get the information.

• NotFound – This user is not banned.

• HTTPException – An error occurred while fetching the information.

Returns:

The BanEntry object for the specified user.

Return type:

BanEntry

await fetch_channel(channel_id, /)

This function is a coroutine.

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

Note

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

Added in version 2.0.

Raises:

• .InvalidData – An unknown channel type was received from Discord or the guild the channel belongs to is not the same as the one in this object points to.

• .HTTPException – Retrieving the channel failed.

• .NotFound – Invalid Channel ID.

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

Returns:

The channel from the ID.

Return type:

Union[abc.GuildChannel, Thread]

bans(*, limit=1000, before=None, after=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s bans.

You must have the ban_members permission to get this information.

Changed in version 2.0: Due to a breaking change in Discord’s API, this now returns an AsyncIterator instead of a list.

Examples

Usage

counter = 0
async for ban in guild.bans(limit=200):
    if not ban.user.bot:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of bans to retrieve. If None, it retrieves every ban in the guild. Note, however, that this would make a slow operation. Defaults to 1000.

• before (Optional[Snowflake]) – Retrieve bans before this user.

• after (Optional[Snowflake]) – Retrieve bans after this user.

Raises:

• Forbidden – You do not have permissions to get the bans.

• HTTPException – An error occurred while fetching the bans.

Yields:

BanEntry – The ban with the ban data parsed.

await prune_members(*, days, compute_prune_count=True, roles=..., reason=None)

This function is a coroutine.

Prunes the guild from its inactive members.

The inactive members are denoted if they have not logged on in days number of days and they have no roles.

You must have the manage_guild and kick_members permissions to use this.

To check how many members you would prune without actually pruning, see the estimate_pruned_members() function.

To prune members that have specific roles see the roles parameter.

Changed in version 1.4: The roles keyword-only parameter was added.

Parameters:

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

Raises:

• Forbidden – You do not have permissions to prune members.

• HTTPException – An error occurred while pruning members.

• InvalidArgument – An integer was not passed for days.

Returns:

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

Return type:

Optional[int]

await templates()

This function is a coroutine.

Gets the list of templates from this guild.

Requires manage_guild permissions.

Added in version 1.7.

Raises:

Forbidden – You don’t have permissions to get the templates.

Returns:

The templates for this guild.

Return type:

List[Template]

await webhooks()

This function is a coroutine.

Gets the list of webhooks from this guild.

Requires manage_webhooks permissions.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The webhooks for this guild.

Return type:

List[Webhook]

await estimate_pruned_members(*, days, roles=...)

This function is a coroutine.

Similar to prune_members() except instead of actually pruning members, it returns how many members it would prune from the guild had it been called.

Parameters:

• days (int) – The number of days before counting as inactive.

• roles (List[abc.Snowflake]) –

  A list of abc.Snowflake that represent roles to include in the estimate. If a member has a role that is not specified, they’ll be excluded.

  Added in version 1.7.

Raises:

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

Returns:

The number of members estimated to be pruned.

Return type:

int

await invites()

This function is a coroutine.

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

You must have the manage_guild permission to get this information.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

Note

This method does not include the Guild’s vanity URL. To get the vanity URL Invite, refer to Guild.vanity_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.

Added in version 1.7.

Parameters:

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

Added in version 1.4.

Parameters:

• type (str) – The integration type (e.g. Twitch).

• id (int) – The integration ID.

Raises:

• Forbidden – You do not have permission to create the integration.

• HTTPException – The account could not be found.

await integrations()

This function is a coroutine.

Returns a list of all integrations attached to the guild.

You must have the manage_guild permission to do this.

Added in version 1.4.

Raises:

• Forbidden – You do not have permission to create the integration.

• HTTPException – Fetching the integrations failed.

Returns:

The list of integrations that are attached to the guild.

Return type:

List[Integration]

await fetch_stickers()

This function is a coroutine.

Retrieves a list of all Stickers for the guild.

Added in version 2.0.

Note

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

Raises:

HTTPException – An error occurred fetching the stickers.

Returns:

The retrieved stickers.

Return type:

List[GuildSticker]

await fetch_sticker(sticker_id, /)

This function is a coroutine.

Retrieves a custom Sticker from the guild.

Added in version 2.0.

Note

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

Parameters:

sticker_id (int) – The sticker’s ID.

Raises:

• NotFound – The sticker requested could not be found.

• HTTPException – An error occurred fetching the sticker.

Returns:

The retrieved sticker.

Return type:

GuildSticker

await create_sticker(*, name, description=None, emoji, file, reason=None)

This function is a coroutine.

Creates a Sticker for the guild.

You must have manage_emojis_and_stickers permission to do this.

Added in version 2.0.

Parameters:

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

Raises:

• Forbidden – You are not allowed to create stickers.

• HTTPException – An error occurred creating a sticker.

Returns:

The created sticker.

Return type:

GuildSticker

await delete_sticker(sticker, *, reason=None)

This function is a coroutine.

Deletes the custom Sticker from the guild.

You must have manage_emojis_and_stickers permission to do this.

Added in version 2.0.

Parameters:

• sticker (abc.Snowflake) – The sticker you are deleting.

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

Raises:

• Forbidden – You are not allowed to delete stickers.

• HTTPException – An error occurred deleting the sticker.

await fetch_emojis()

This function is a coroutine.

Retrieves all custom Emojis from the guild.

Note

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

Raises:

HTTPException – An error occurred fetching the emojis.

Returns:

The retrieved emojis.

Return type:

List[Emoji]

await fetch_emoji(emoji_id, /)

This function is a coroutine.

Retrieves a custom Emoji from the guild.

Note

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

Parameters:

emoji_id (int) – The emoji’s ID.

Raises:

• NotFound – The emoji requested could not be found.

• HTTPException – An error occurred fetching the emoji.

Returns:

The retrieved emoji.

Return type:

Emoji

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

This function is a coroutine.

Creates a custom Emoji for the guild.

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.

Changed in version 2.1: The image parameter now accepts File, Attachment, and Asset.

Parameters:

• name (str) – The emoji name. Must be at least 2 characters.

• image (Union[bytes, Asset, Attachment, File]) – The bytes-like object, File, Attachment, or Asset 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.

Raises:

• Forbidden – You are not allowed to create emojis.

• HTTPException – An error occurred creating an emoji.

Returns:

The created emoji.

Return type:

Emoji

await delete_emoji(emoji, *, reason=None)

This function is a coroutine.

Deletes the custom Emoji from the guild.

You must have manage_emojis permission to do this.

Parameters:

• emoji (abc.Snowflake) – The emoji you are deleting.

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

Raises:

• Forbidden – You are not allowed to delete emojis.

• HTTPException – An error occurred deleting the emoji.

await fetch_roles(*, cache=False)

This function is a coroutine.

Retrieves all Role that the guild has.

Note

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

Parameters:

cache (bool) – Whether or not to also update this guilds role cache. Defaults to False.

Raises:

HTTPException – Retrieving the roles failed.

Returns:

All roles in the guild.

Return type:

List[Role]

await fetch_role(role_id, /)

This function is a coroutine.

Retrieve a Role from this guild by its ID.

Added in version 3.0.

Parameters:

role_id (int) – The ID of the role to fetch.

Raises:

• HTTPException – Retrieving the role failed.

• NotFound – The role was not found.

Returns:

The role in the guild.

Return type:

Role

await create_role(*, name=..., permissions=..., color=..., colour=..., colors=..., colours=..., hoist=..., mentionable=..., icon=..., 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.

Changed in version 1.6: Can now pass int to colour keyword-only parameter.

Changed in version 2.1: The icon parameter now accepts File, Attachment, and Asset.

Parameters:

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

• mentionable (bool) – Indicates if the role should be mentionable by others. Defaults to False.

• icon (Optional[Union[str, bytes, Asset, Attachment, File]]) – The icon of the role. Supports unicode emojis and images

• reason (Optional[str]) – The reason for creating this role. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to create the role.

• HTTPException – Creating the role failed.

• InvalidArgument – An invalid keyword argument was given.

Returns:

The newly created role.

Return type:

Role

await edit_role_positions(positions, *, reason=None)

This function is a coroutine.

Bulk edits a list of Role in the guild.

You must have the manage_roles permission to do this.

Added in version 1.4.

Example:

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

await guild.edit_role_positions(positions=positions)

Parameters:

• positions – A dict of Role to int to change the positions of each given role.

• reason (Optional[str]) – The reason for editing the role positions. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to move the roles.

• HTTPException – Moving the roles failed.

• InvalidArgument – An invalid keyword argument was given.

Returns:

A list of all the roles in the guild.

Return type:

List[Role]

await kick(user, *, reason=None)

This function is a coroutine.

Kicks a user from the guild.

The user must meet the abc.Snowflake abc.

You must have the kick_members permission to do this.

Parameters:

• user (abc.Snowflake) – The user to kick from their guild.

• reason (Optional[str]) – The reason the user got kicked.

Raises:

• Forbidden – You do not have the proper permissions to kick.

• HTTPException – Kicking failed.

await ban(user, *, reason=None, delete_message_seconds=None)

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.

For backwards compatibility reasons, by default one day worth of messages will be deleted.

Changed in version 3.0: delete_message_days has been removed in favor of delete_message_seconds.

Parameters:

• user (abc.Snowflake) – The user to ban from their guild.

• delete_message_seconds (Optional[int]) –

  The number of seconds worth of messages to delete from the user in the guild. The minimum is 0 and the maximum is 604800 (7 days).

  Added in version 2.3.

• reason (Optional[str]) – The reason the user got banned.

Raises:

• Forbidden – You do not have the proper permissions to ban.

• HTTPException – Banning failed.

await bulk_ban(users, *, delete_message_seconds=None, reason=None)

This function is a coroutine.

Bans a list of users. This is similar to Guild.ban() except it bulk bans multiple users.

You must have the ban_members and manage_guild permissions to do this.

Added in version 3.0.

Parameters:

• users (List[abc.Snowflake]) – The users to ban from a guild.

• delete_message_seconds (Optional[int]) –

  The number of seconds worth of messages to delete from these users. Can range from 0 to 604800 seconds (7 days).

  Defaults to 0.

• reason (Optional[str]) – The reason these users got banned.

Raises:

• Forbidden – You do not have the proper permissions to bulk ban.

• HTTPException – Bulk banning failed. This may occur if all provided users failed to be banned due to the following reasons: - The users are already banned - You do not have the proper permissions to ban a user

Returns:

The failed and banned users in the form of Object.

Return type:

BulkBan

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.

Parameters:

• user (abc.Snowflake) – The user to unban.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

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

Raises:

• Forbidden – You do not have the proper permissions to get this.

• HTTPException – Retrieving the vanity invite failed.

Returns:

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

Return type:

Optional[Invite]

await widget()

This function is a coroutine.

Returns the widget of the guild.

Note

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

Raises:

• Forbidden – The widget for this guild is disabled.

• HTTPException – Retrieving the widget failed.

Returns:

The guild’s widget.

Return type:

Widget

await 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

Added in version 2.0.

Parameters:

• enabled (bool) – Whether to enable the widget for the guild.

• channel (Optional[Snowflake]) – The new widget channel. None removes the widget channel.

Raises:

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

Added in version 1.5.

Parameters:

cache (bool) – Whether to cache the members as well.

Raises:

ClientException – The members intent is not enabled.

Returns:

Returns a list of all the members in the guild.

Return type:

Optional[List[Member]]

await query_members(query=None, *, limit=5, user_ids=None, presences=False, cache=True)

This function is a coroutine.

Request members that belong to this guild whose username starts with the query given.

This is a websocket operation and can be slow.

Added in version 1.3.

Parameters:

• query (Optional[str]) – The string that the username’s start with.

• limit (int) – The maximum number of members to send back. This must be a number between 5 and 100.

• presences (bool) –

  Whether to request for presences to be provided. This defaults to False.

  Added in version 1.6.

• cache (bool) – Whether to cache the members internally. This makes operations such as get_member() work for those that matched.

• user_ids (Optional[List[int]]) –

  List of user IDs to search for. If the user ID is not in the guild then it won’t be returned.

  Added in version 1.4.

Raises:

• asyncio.TimeoutError – The query timed out waiting for the members.

• ValueError – Invalid parameters were passed to the function

• ClientException – The presences intent is not enabled.

Returns:

The list of members that have matched the query.

Return type:

List[Member]

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

This function is a coroutine.

Changes client’s voice state in the guild.

Added in version 1.4.

Parameters:

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

fetch_scheduled_events(*, with_users=False)

This function returns an async iterator.

Returns an async iterator that enables receiving scheduled events on this guild.

Note

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

Added in version 2.0.

Parameters:

with_users (Optional[bool]) – If the event should be received with ScheduledEvent.users This defaults to False - the events’ users will be empty.

Raises:

HTTPException – Getting the events failed.

Yields:

ScheduledEvent – The event with users if applicable

Examples

Usage

async for event in guild.fetch_scheduled_events():
    print(event.name)

get_scheduled_event(event_id)

Get a scheduled event from cache by id.

Note

This may not return the updated users, use fetch_scheduled_event() if that is desired.

Parameters:

event_id (int) – The scheduled event id to fetch.

Returns:

The event object, if found.

Return type:

Optional[ScheduledEvent]

await fetch_scheduled_event(event_id, *, with_users=False)

This function is a coroutine.

Fetch a scheduled event object.

Note

This is an api call, if updated users is not needed, consisder get_scheduled_event()

Parameters:

• event_id (int) – The event id to fetch

• with_users (bool) – If the users should be received and cached too, by default False

Returns:

The received event object

Return type:

ScheduledEvent

await create_scheduled_event(*, name, entity_type, start_time, channel=..., metadata=..., privacy_level=ScheduledEventPrivacyLevel.guild_only, end_time=..., description=..., image=None, reason=None)

This function is a coroutine.

Create a new scheduled event object.

Changed in version 2.1: The image parameter now accepts File, Attachment, and Asset.

Parameters:

• channel (abc.GuildChannel) – The channel the event will happen in, if any

• metadata (EntityMetadata) – The metadata for the event

• name (str) – The name of the event

• privacy_level (ScheduledEventPrivacyLevel) – The privacy level for the event

• start_time (datetime.datetime) – The scheduled start time

• end_time (datetime.datetime) – The scheduled end time

• description (str) – The description for the event

• entity_type (ScheduledEventEntityType) – The type of event

• image (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset representing the cover image.

• reason (Optional[str]) – The reason for creating this scheduled event. Shows up in the audit logs.

Returns:

The created event object.

Return type:

ScheduledEvent

get_application_commands(rollout=False)

Gets all application commands registered for this guild.

Parameters:

rollout (bool)

await sync_application_commands(data=None, *, associate_known=True, delete_unknown=True, update_known=True, register_new=True)

This function is a coroutine. Syncs the locally added application commands with this Guild.

Parameters:

• data (Optional[List[dict]]) – Data to use when comparing local application commands to what Discord has. Should be a list of application command data from Discord. If left as None, it will be fetched if needed. Defaults to None.

• associate_known (bool) – If local commands that match a command already on Discord should be associated with each other. Defaults to True.

• delete_unknown (bool) – If commands on Discord that don’t match a local command should be deleted. Defaults to True.

• update_known (bool) – If commands on Discord have a basic match with a local command, but don’t fully match, should be updated. Defaults to True.

• register_new (bool) – If a local command that doesn’t have a basic match on Discord should be added to Discord. Defaults to True.

await rollout_application_commands(associate_known=True, delete_unknown=True, update_known=True, register_new=True)

This function is a coroutine. Rolls out application commands to the guild, associating, deleting, updating, and/or newly registering as needed.

Parameters:

• associate_known (bool) – Whether commands on Discord that match a locally added command should be associated with each other. Defaults to True

• delete_unknown

• update_known

• register_new

await auto_moderation_rules()

This function is a coroutine.

Get the list of auto moderation rules from this guild.

Requires the manage_guild permission.

Added in version 2.1.

Raises:

Forbidden – You do not have permission to fetch the auto moderation rules.

Returns:

The auto moderation rules of this guild.

Return type:

List[AutoModerationRule]

await fetch_auto_moderation_rule(rule_id, /)

This function is a coroutine.

Retrieves a AutoModerationRule from this guild by its ID

Requires the manage_guild permission.

Added in version 2.1.

Parameters:

rule_id (int) – The ID of the auto moderation rule to fetch.

Raises:

• NotFound – The requested rule could not be found.

• Forbidden – You do not have permission to fetch auto moderation rules.

• HTTPException – Fetching the rule failed.

Returns:

The found auto moderation rule.

Return type:

AutoModerationRule

await create_auto_moderation_rule(*, name, event_type, trigger_type, actions, trigger_metadata=None, enabled=None, exempt_roles=None, exempt_channels=None, reason=None)

This function is a coroutine.

Create a new auto moderation rule.

Requires the manage_guild permission.

Added in version 2.1.

Parameters:

• name (str) – The name to use for this rule.

• event_type (AutoModerationEventType) – The type of event conteto listen to for this rule.

• actions (List[AutoModerationAction]) – The actions to execute when this rule is triggered.

• trigger_type (AutoModerationTriggerType) – The type of content that triggers this rule.

• trigger_metadata (Optional[AutoModerationTriggerMetadata]) – The additional data to use to determine if this rule has been triggered.

• enabled (Optional[bool]) – If this rule should be enabled.

• exempt_roles (Optional[List[abc.Snowflake]]) – Roles that should be exempt from this rule.

• exempt_channels (Optional[List[abc.Snowflake]]) – Channels that should be exempt from this rule.

• reason (Optional[str]) – The reason for creating this rule. Shows in the audit log.

Raises:

• Forbidden – You do not have permission to create auto moderation rules.

• HTTPException – Creating the rule failed.

• InvalidArgument – An invalid type was passed for an argument.

Returns:

The newly created auto moderation rule.

Return type:

AutoModerationRule

parse_mentions(text)

Parses user mentions in a string and returns a list of Member objects. If the member is not in the guild, a User object is returned for that member instead.

Note

This does not include role or channel mentions. See parse_role_mentions() for Role objects and parse_channel_mentions() for GuildChannel objects.

Note

Only members or users found in the cache will be returned. To get the IDs of all users mentioned, use parse_raw_mentions() instead.

Added in version 2.2.

Parameters:

text (str) – String to parse mentions in.

Returns:

List of Member or User objects that were mentioned in the string.

Return type:

List[Union[Member, User]]

parse_role_mentions(text)

Parses role mentions in a string and returns a list of Role objects.

Note

Only cached roles found in the Guild will be returned. To get the IDs of all roles mentioned, use parse_raw_role_mentions() instead.

Added in version 2.2.

Parameters:

text (str) – String to parse mentions in.

Returns:

List of Role objects that were mentioned in the string.

Return type:

List[Role]

parse_channel_mentions(text)

Parses channel mentions in a string and returns a list of GuildChannel objects.

Note

Only cached channels found in the Guild will be returned. To get the IDs of all channels mentioned, use parse_raw_channel_mentions() instead.

Added in version 2.2.

Parameters:

text (str) – String to parse mentions in.

Returns:

List of GuildChannel objects that were mentioned in the string.

Return type:

List[GuildChannel]

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

class nextcord.BulkBan

A namedtuple which represents a ban returned from bulk_ban().

Added in version 3.0.

banned_users

The list of successfully banned user IDs.

Type:

List[Object]

failed_users

The list of unsuccessfully banned user IDs.

Type:

List[Object]

GuildPreview

class nextcord.GuildPreview

Represents a Discord guild preview.

id

The guild’s ID

Type:

int

name

The guild name.

Type:

str

features

The features the guild has access to.

Type:

List[str]

approximate_member_count

The approximate amount of members in the guild.

Type:

int

approximate_presence_count

The approximate amount of presences for the guild.

Type:

int

description

The guild’s description.

Type:

Optional[str]

emojis

All the emojis that the guild owns, if any.

Type:

List[Emoji]

stickers

All the stickers that the guild owns, if any.

Type:

List[GuildSticker]

.. versionadded :: 2.6

property icon

Returns the guild’s icon asset, if avaliable.

Type:

Optional[Asset]

property splash

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

Type:

Optional[Asset]

property discovery_splash

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

Type:

Optional[Asset]

Integration

class nextcord.Integration

Represents a guild integration.

Added in version 1.4.

id

The integration ID.

Type:

int

name

The integration name.

Type:

str

guild

The guild of the integration.

Type:

Guild

type

The integration type (i.e. Twitch).

Type:

str

enabled

Whether the integration is currently enabled.

Type:

bool

account

The account linked to this integration.

Type:

IntegrationAccount

user

The user that added this integration.

Type:

User

await delete(*, reason=None)

This function is a coroutine.

Deletes the integration.

You must have the manage_guild permission to do this.

Parameters:

reason (str) –

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

Added in version 2.0.

Raises:

• Forbidden – You do not have permission to delete the integration.

• HTTPException – Deleting the integration failed.

class nextcord.IntegrationAccount

Represents an integration account.

Added in version 1.4.

id

The account ID.

Type:

str

name

The account name.

Type:

str

class nextcord.BotIntegration

Represents a bot integration on discord.

Added in version 2.0.

id

The integration ID.

Type:

int

name

The integration name.

Type:

str

guild

The guild of the integration.

Type:

Guild

type

The integration type (i.e. Twitch).

Type:

str

enabled

Whether the integration is currently enabled.

Type:

bool

user

The user that added this integration.

Type:

User

account

The integration account information.

Type:

IntegrationAccount

application

The application tied to this integration.

Type:

IntegrationApplication

class nextcord.IntegrationApplication

Represents an application for a bot integration.

Added in version 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 nextcord.StreamIntegration

Represents a stream integration for Twitch or YouTube.

Added in version 2.0.

id

The integration ID.

Type:

int

name

The integration name.

Type:

str

guild

The guild of the integration.

Type:

Guild

type

The integration type (i.e. Twitch).

Type:

str

enabled

Whether the integration is currently enabled.

Type:

bool

syncing

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

An alias for expire_behaviour.

Type:

ExpireBehaviour

property role

Optional[Role] The role which the integration uses for subscribers.

await edit(*, expire_behaviour=..., expire_grace_period=..., enable_emoticons=...)

This function is a coroutine.

Edits the integration.

You must have the manage_guild permission to do this.

Parameters:

• expire_behaviour (ExpireBehaviour) – The behaviour when an integration subscription lapses. Aliased to expire_behavior as well.

• expire_grace_period (int) – The period (in days) where the integration will ignore lapsed subscriptions.

• enable_emoticons (bool) – Where emoticons should be synced for this integration (currently twitch only).

Raises:

• Forbidden – You do not have permission to edit the integration.

• HTTPException – Editing the guild failed.

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

Raises:

• Forbidden – You do not have permission to sync the integration.

• HTTPException – Syncing the integration failed.

Interaction

Attributes

• app_permissions
• application_command
• application_id
• attached
• authorizing_integration_owners
• channel
• channel_id
• client
• context
• created_at
• data
• expires_at
• followup
• guild
• guild_id
• guild_locale
• id
• locale
• message
• permissions
• response
• token
• type
• user

Methods

• asyncdelete_original_message
• asyncedit
• asyncedit_original_message
• defis_expired
• asyncoriginal_message
• asyncsend

class nextcord.Interaction

Represents a Discord interaction.

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

x == y

Checks if two interactions are equal.

x != y

Checks if two interactions are not equal.

hash(x)

Returns the interaction’s hash.

Added in version 2.0.

Changed in version 2.1: Interaction is now hashable.

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]

locale

The users locale.

Type:

Optional[str]

guild_locale

The guilds preferred locale, if invoked in a guild.

Type:

Optional[str]

application_id

The application ID that the interaction was for.

Type:

int

user

The user or member that sent the interaction.

Type:

Optional[Union[User, Member]]

message

The message that sent this interaction.

Type:

Optional[Message]

token

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

Type:

str

data

The raw interaction data.

Type:

dict

attached

The attached data of the interaction. This is used to store any data you may need inside the interaction for convenience. This data will stay on the interaction, even after a Interaction.application_command_before_invoke().

Type:

InteractionAttached

application_command

The application command that handled the interaction.

Type:

Optional[ApplicationCommand]

authorizing_integration_owners

Mapping of installation contexts that the interaction was authorized for to related user or guild IDs. You can find out about this field in the official Discord documentation.

Added in version 3.0.

Type:

Optional[Dict[IntegrationType, int]]

context

Context where the interaction was triggered from.

Added in version 3.0.

Type:

Optional[InteractionContextType]

property client

The client that handled the interaction.

Type:

Client

property guild

The guild the interaction was sent from.

Type:

Optional[Guild]

property created_at

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

Type:

datetime.datetime

property expires_at

An aware datetime in UTC representing the time when the interaction will expire.

Type:

datetime.datetime

is_expired()

bool A boolean whether the interaction token is invalid or not.

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

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

property app_permissions

The resolved permissions of the bot 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.

Raises:

• HTTPException – Fetching the original response message failed.

• ClientException – The channel for the message could not be resolved.

Returns:

The original interaction response message.

Return type:

InteractionMessage

await edit_original_message(*, content=..., embeds=..., embed=..., file=..., files=..., attachments=..., view=..., allowed_mentions=None, components=None)

This function is a coroutine.

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

Parameters:

• content (Optional[str]) – The content to edit the message with or None to clear it.

• embeds (List[Embed]) – A list of embeds to edit the message with.

• embed (Optional[Embed]) – The embed to edit the message with. None suppresses the embeds. This should not be mixed with the embeds parameter.

• file (File) – The file to upload. This cannot be mixed with files parameter.

• files (List[File]) – A list of files to send with the content. This cannot be mixed with the file parameter.

• attachments (List[Attachment]) – A list of attachments to keep in the message. To keep existing attachments, you must fetch the message with original_message() and pass message.attachments to this parameter.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• InvalidArgument – You specified both embed and embeds or file and files.

• ValueError – The length of embeds was invalid.

Returns:

The newly edited message.

Return type:

InteractionMessage

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

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message. The waiting is done in the background and deletion failures are ignored.

Raises:

• HTTPException – Deleting the message failed.

• Forbidden – Deleted a message that is not yours.

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

This function is a coroutine.

This is a shorthand function for helping in sending messages in response to an interaction. If the interaction has not been responded to, InteractionResponse.send_message() is used. If the response is_done() then the message is sent via Interaction.followup using Webhook.send instead.

Raises:

• HTTPException – Sending the message failed.

• NotFound – The interaction has expired or the interaction has been responded to but the followup webhook is expired.

• Forbidden – The authorization token for the webhook is incorrect.

• InvalidArgument – You specified both embed and embeds or file and files.

• ValueError – The length of embeds was invalid.

Returns:

If the interaction has not been responded to, returns a PartialInteractionMessage supporting only the edit() and delete() operations. To fetch the InteractionMessage you may use fetch() or Interaction.original_message(). If the interaction has been responded to, returns the WebhookMessage.

Return type:

Union[PartialInteractionMessage, WebhookMessage]

await edit(*args, **kwargs)

This function is a coroutine.

This is a shorthand function for helping in editing messages in response to a component or modal submit interaction. If the interaction has not been responded to, InteractionResponse.edit_message() is used. If the response is_done() then the message is edited via the Interaction.message using Message.edit() instead.

Raises:

• HTTPException – Editing the message failed.

• InvalidArgument – You specified both embed and embeds or file and files.

• TypeError – An object not of type File was passed to file or files.

• HTTPException – Editing the message failed.

• InvalidArgument – Interaction.message was None, this may occur in a Thread or when the interaction is not a component or modal submit interaction.

Returns:

The edited message. If the interaction has not yet been responded to, InteractionResponse.edit_message() is used which returns a Message or None corresponding to Interaction.message. Otherwise, the Message is returned via Message.edit().

Return type:

Optional[Message]

InteractionResponse

Methods

• asyncdefer
• asyncedit_message
• defis_done
• asyncpong
• asyncsend_autocomplete
• asyncsend_message
• asyncsend_modal

class nextcord.InteractionResponse

Represents a Discord interaction response.

This type can be accessed through Interaction.response.

Added in version 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, with_message=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.

Parameters:

• ephemeral (bool) – Indicates whether the deferred message will eventually be ephemeral. This only applies for interactions of type InteractionType.application_command or when with_message is True

• with_message (bool) –

  Indicates whether the response will be a message with thinking state (bot is thinking…). This is always True for interactions of type InteractionType.application_command. For interactions of type InteractionType.component this defaults to False.

  Added in version 2.0.

Raises:

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

Raises:

• HTTPException – Ponging the interaction failed.

• InteractionResponded – This interaction has already been responded to before.

await send_autocomplete(choices)

This function is a coroutine.

Responds to this interaction by sending an autocomplete payload.

Parameters:

choices (Union[dict, list]) – The choices to send the user. If a dict is given, each key-value pair is turned into a name-value pair. Name is what Discord shows the user, value is what Discord sends to the bot. If something not a dict, such as a list, is given, each value is turned into a duplicate name-value pair, where the display name and the value Discord sends back are the same.

Raises:

• HTTPException – Sending the message failed.

• InteractionResponded – This interaction has already been responded to before.

await send_message(content=None, *, embed=..., embeds=..., file=..., files=..., view=..., tts=False, delete_after=None, allowed_mentions=..., flags=None, ephemeral=None, suppress_embeds=None, components=None)

This function is a coroutine.

Responds to this interaction by sending a message.

Changed in version 2.4: ephemeral can now accept None to indicate that flags should be used.

Parameters:

• content (Optional[str]) – The content of the message to send.

• embeds (List[Embed]) – A list of embeds to send with the content. Maximum of 10. This cannot be mixed with the embed parameter.

• embed (Embed) – The rich embed for the content to send. This cannot be mixed with embeds parameter.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Maximum of 10. This cannot be mixed with the file parameter.

• tts (bool) – Indicates if the message should be sent using text-to-speech.

• view (nextcord.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 (Optional[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. See abc.Messageable.send() for more information.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• HTTPException – Sending the message failed.

• NotFound – The interaction has expired. InteractionResponse.defer() and Interaction.followup should be used if the interaction will take a while to respond.

• InvalidArgument – You specified both embed and embeds or file and files.

• TypeError – An object not of type File was passed to file or files.

• ValueError – The length of embeds was invalid.

• InteractionResponded – This interaction has already been responded to before.

Returns:

An object supporting only the edit() and delete() operations. To fetch the InteractionMessage you may use PartialInteractionMessage.fetch() or Interaction.original_message().

Return type:

PartialInteractionMessage

await send_modal(modal)

This function is a coroutine.

Respond to this interaction by sending a modal.

Parameters:

modal (nextcord.ui.Modal) – The modal to be sent in response to the interaction and which will be displayed on the user’s screen.

Raises:

• HTTPException – Sending the modal failed.

• InteractionResponded – This interaction has already been responded to before.

await edit_message(*, content=..., embed=..., embeds=..., file=..., files=..., attachments=..., view=..., delete_after=None, components=None)

This function is a coroutine.

Responds to this interaction by editing the message that the component or modal submit interaction originated from.

Parameters:

• content (Optional[str]) – The new content to replace the message with. None removes the content.

• embeds (List[Embed]) – A list of embeds to edit the message with.

• embed (Optional[Embed]) – The embed to edit the message with. None suppresses the embeds. This should not be mixed with the embeds parameter.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Maximum of 10. This cannot be mixed with the file parameter.

• attachments (List[Attachment]) – A list of attachments to keep in the message. To keep all existing attachments, pass interaction.message.attachments.

• view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.

• delete_after (Optional[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.

Raises:

• HTTPException – Editing the message failed.

• InvalidArgument – You specified both embed and embeds or file and files.

• TypeError – An object not of type File was passed to file or files.

• InteractionResponded – This interaction has already been responded to before.

Returns:

The message that was edited, or None if the Interaction.message is not found (this may happen if the interaction occurred in a Thread).

Return type:

Optional[Message]

InteractionMessage

Attributes

• clean_content
• created_at
• edited_at
• jump_url
• raw_channel_mentions
• raw_mentions
• raw_role_mentions
• system_content
• thread

Methods

• asyncadd_reaction
• asyncclear_reaction
• asyncclear_reactions
• asynccreate_thread
• asyncdelete
• asyncedit
• asyncforward
• defis_system
• asyncpin
• asyncpublish
• asyncremove_reaction
• asyncreply
• defto_reference
• asyncunpin

class nextcord.InteractionMessage

Represents the original interaction response message.

To retrieve this object see PartialInteractionMessage.fetch() or Interaction.original_message().

This inherits from nextcord.Message with changes to edit() and delete() to work with the interaction response.

Added in version 2.0.

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.

Parameters:

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

Raises:

• HTTPException – Adding the reaction failed.

• Forbidden – You do not have the proper permissions to react to the message.

• NotFound – The emoji you specified was not found.

• InvalidArgument – The emoji parameter is invalid.

clean_content

A property that returns the content in a “cleaned up” manner. This basically means that mentions are transformed into the way the client shows it. e.g. <#id> will transform into #name.

This will also transform @everyone and @here mentions into non-mentions.

Note

This does not affect markdown. If you want to escape or remove markdown then use utils.escape_markdown() or utils.remove_markdown() respectively, along with this function.

Type:

str

await clear_reaction(emoji)

This function is a coroutine.

Clears a specific reaction from the message.

The emoji may be a unicode emoji or a custom guild Emoji.

You need the manage_messages permission to use this.

Added in version 1.3.

Parameters:

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

Raises:

• HTTPException – Clearing the reaction failed.

• Forbidden – You do not have the proper permissions to clear the reaction.

• NotFound – The emoji you specified was not found.

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

Raises:

• HTTPException – Removing the reactions failed.

• Forbidden – You do not have the proper permissions to remove all the reactions.

await create_thread(*, name, auto_archive_duration=...)

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.

Added in version 2.0.

Parameters:

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

Raises:

• Forbidden – You do not have permissions to create a thread.

• HTTPException – Creating the thread failed.

• InvalidArgument – This message does not have guild info attached.

Returns:

The created thread.

Return type:

Thread

property created_at

The message’s creation time in UTC.

Type:

datetime.datetime

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message. The waiting is done in the background and deletion failures are ignored.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already.

• HTTPException – Deleting the message failed.

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

This function is a coroutine.

Edits the message.

Parameters:

• content (Optional[str]) – The content to edit the message with or None to clear it.

• embeds (List[Embed]) – A list of embeds to edit the message with.

• embed (Optional[Embed]) – The embed to edit the message with. None suppresses the embeds. This should not be mixed with the embeds parameter.

• file (File) – The file to upload. This cannot be mixed with files parameter.

• files (List[File]) – A list of files to send with the content. This cannot be mixed with the file parameter.

• attachments (List[Attachment]) – A list of attachments to keep in the message. To keep existing attachments, you must fetch the message with original_message() and pass message.attachments to this parameter.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.

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

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• InvalidArgument – You specified both embed and embeds or file and files.

• ValueError – The length of embeds was invalid.

Returns:

The newly edited message.

Return type:

InteractionMessage

property edited_at

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

Type:

Optional[datetime.datetime]

await forward(channel)

Forward this message to a channel.

Note

It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Parameters:

channel (Messageable) – The channel to forward this message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

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.

Added in version 1.3.

property jump_url

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

Type:

str

await pin(*, reason=None)

This function is a coroutine.

Pins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

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

Added in version 1.4.

Raises:

• Forbidden – You do not have permissions to pin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Pinning the message failed, probably due to the channel having more than 50 pinned messages.

await publish()

This function is a coroutine.

Publishes this message to your announcement channel.

You must have the send_messages permission to do this.

If the message is not your own then the manage_messages permission is also needed.

Raises:

• Forbidden – You do not have the proper permissions to publish this message.

• HTTPException – Publishing the message failed.

raw_channel_mentions

A property that returns an array of channel IDs matched with the syntax of <#channel_id> in the message content.

Type:

List[int]

raw_mentions

A property that returns an array of user IDs matched with the syntax of <@user_id> in the message content.

This allows you to receive the user IDs of mentioned users even in a private message context.

Type:

List[int]

raw_role_mentions

A property that returns an array of role IDs matched with the syntax of <@&role_id> in the message content.

Type:

List[int]

await remove_reaction(emoji, member)

This function is a coroutine.

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.

Parameters:

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

• member (abc.Snowflake) – The member for which to remove the reaction.

Raises:

• HTTPException – Removing the reaction failed.

• Forbidden – You do not have the proper permissions to remove the reaction.

• NotFound – The member or emoji you specified was not found.

• InvalidArgument – The emoji parameter is invalid.

await reply(content=None, **kwargs)

This function is a coroutine.

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

Added in version 1.6.

Raises:

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

Returns:

The message that was sent.

Return type:

Message

system_content

A property that returns the content that is rendered regardless of the Message.type.

In the case of MessageType.default and MessageType.reply, this just returns the regular Message.content. Otherwise this returns an English message denoting the contents of the system message.

Type:

str

property thread

The thread started from this message. None if no thread was started.

Type:

Optional[Thread]

to_reference(*, fail_if_not_exists=True)

Creates a MessageReference from the current message.

Added in version 1.6.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

Added in version 1.7.

Returns:

The reference to this message.

Return type:

MessageReference

await unpin(*, reason=None)

This function is a coroutine.

Unpins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

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

Added in version 1.4.

Raises:

• Forbidden – You do not have permissions to unpin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Unpinning the message failed.

PartialInteractionMessage

Attributes

• author
• channel
• guild

Methods

• asyncdelete
• asyncedit
• asyncfetch

class nextcord.PartialInteractionMessage

Represents the original interaction response message when only the application state and interaction token are available.

This allows you to edit or delete the message associated with the interaction response. This object is returned when responding to an interaction with InteractionResponse.send_message().

This does not support most attributes and methods of nextcord.Message. The fetch() method can be used to retrieve the full InteractionMessage object.

x == y

Checks if two partial interaction messages are equal.

x != y

Checks if two partial interaction messages are not equal.

hash(x)

Returns the partial interaction message’s hash.

Added in version 2.0.

Changed in version 2.1: PartialInteractionMessage is now hashable by Interaction.id.

Note

The hash of a PartialInteractionMessage is the same as the hash of the Interaction that it is associated with but not that of the full InteractionMessage.

await fetch()

This function is a coroutine.

Fetches the original interaction response message associated with the interaction.

Repeated calls to this will return a cached value.

Raises:

• HTTPException – Fetching the original response message failed.

• ClientException – The channel for the message could not be resolved.

Returns:

The original interaction response message.

Return type:

InteractionMessage

property author

The client that responded to the interaction.

If the interaction was in a guild, this is a Member representing the client. Otherwise, this is a ClientUser.

Type:

Optional[Union[Member, ClientUser]]

property 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 guild

The guild the interaction was sent from.

Type:

Optional[Guild]

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait before deleting the message. The waiting is done in the background and deletion failures are ignored.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already.

• HTTPException – Deleting the message failed.

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

This function is a coroutine.

Edits the message.

Parameters:

• content (Optional[str]) – The content to edit the message with or None to clear it.

• embeds (List[Embed]) – A list of embeds to edit the message with.

• embed (Optional[Embed]) – The embed to edit the message with. None suppresses the embeds. This should not be mixed with the embeds parameter.

• file (File) – The file to upload. This cannot be mixed with files parameter.

• files (List[File]) – A list of files to send with the content. This cannot be mixed with the file parameter.

• attachments (List[Attachment]) – A list of attachments to keep in the message. To keep existing attachments, you must fetch the message with original_message() and pass message.attachments to this parameter.

• allowed_mentions (AllowedMentions) – Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

• view (Optional[View]) – The updated view to update this message with. If None is passed then the view is removed.

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

Raises:

• HTTPException – Editing the message failed.

• Forbidden – Edited a message that is not yours.

• InvalidArgument – You specified both embed and embeds or file and files.

• ValueError – The length of embeds was invalid.

Returns:

The newly edited message.

Return type:

InteractionMessage

MessageInteraction

Attributes

• created_at
• data
• id
• name
• type
• user

class nextcord.MessageInteraction

Represents a message’s interaction data.

A message’s interaction data is a property of a message when the message is a response to an interaction from any bot.

Added in version 2.1.

x == y

Checks if two message interactions are equal.

x != y

Checks if two interaction messages are not equal.

hash(x)

Returns the message interaction’s hash.

data

The raw data from the interaction.

Type:

Dict[str, Any]

id

The interaction’s ID.

Type:

int

type

The interaction type.

Type:

InteractionType

name

The name of the application command.

Type:

str

user

The User who invoked the interaction or Member if the interaction occurred in a guild.

Type:

Union[User, Member]

.. warning::

This class is deprecated, use Message.interaction_metadata instead.

.. deprecated:: 3.0

property created_at

The interaction’s creation time in UTC.

Type:

datetime.datetime

MessageInteractionMetadata

Attributes

• authorizing_integration_owners
• cached_interacted_message
• cached_original_response_message
• created_at
• data
• id
• interacted_message_id
• name
• original_response_message_id
• triggering_interaction_metadata
• type
• user

class nextcord.MessageInteractionMetadata

Represents a message’s interaction metadata.

A message’s interaction metadata is a property of a message when the message is a response to an interaction from any bot.

Added in version 3.0.

x == y

Checks if two message interactions are equal.

x != y

Checks if two interaction messages are not equal.

hash(x)

Returns the message interaction’s hash.

data

The raw data from the interaction metadata.

Type:

Dict[str, Any]

id

The interaction’s ID.

Type:

int

type

The interaction type.

Type:

InteractionType

user

The User who invoked the interaction or Member if the interaction occurred in a guild and that member is cached.

Type:

Union[User, Member]

authorizing_integration_owners

Mapping of installation contexts that the interaction was authorized for to related user or guild IDs. You can find out about this field in the official Discord documentation.

Added in version 3.0.

Type:

Dict[IntegrationType, str]

name

The name of the application command.

Type:

Optional[str]

original_response_message_id

The ID of the original response message, present only on follow-up messages.

Type:

Optional[int]

interacted_message_id

The ID of the message that contained the interactive component, present only on messages created from component interactions.

Type:

Optional[int]

triggering_interaction_metadata

Metadata for the interaction that was used to open the modal, present only on modal submit interactions.

Type:

Optional[MessageInteractionMetadata]

property created_at

The interaction’s creation time in UTC.

Type:

datetime.datetime

property cached_original_response_message

The original response message, if found in the internal message cache.

Type:

Optional[Message]

property cached_interacted_message

The interacted message, if found in the internal message cache.

Type:

Optional[Message]

Member

Attributes

• accent_color
• accent_colour
• activities
• activity
• avatar
• avatar_decoration
• banner
• bot
• color
• colour
• communication_disabled_until
• created_at
• default_avatar
• desktop_status
• discriminator
• display_avatar
• display_banner
• display_name
• dm_channel
• flags
• global_name
• guild
• guild_avatar
• guild_banner
• guild_permissions
• id
• joined_at
• mention
• mobile_status
• mutual_guilds
• name
• nick
• pending
• premium_since
• public_flags
• raw_status
• roles
• status
• system
• top_role
• voice
• web_status

Methods

• asyncadd_roles
• asyncban
• asynccreate_dm
• asyncdisconnect
• asyncedit
• asyncfetch_message
• asyncforward
• defget_role
• defhistory
• defis_on_mobile
• asynckick
• defmentioned_in
• asyncmove_to
• asyncremove_roles
• asyncrequest_to_speak
• asyncsend
• asynctimeout
• asynctrigger_typing
• deftyping
• asyncunban

class nextcord.Member

Represents a Discord member to a Guild.

This implements a lot of the functionality of User.

x == y

Checks if two members are equal. Note that this works with User instances too.

x != y

Checks if two members are not equal. Note that this works with User instances too.

hash(x)

Returns the member’s hash.

str(x)

Returns the member’s name with the discriminator.

joined_at

An aware datetime object that specifies the date and time in UTC that the member joined the guild. If the member left and rejoined the guild, this will be the latest date. In certain cases, this can be None.

Type:

Optional[datetime.datetime]

activities

The activities that the user is currently doing.

Note

Due to a Discord API limitation, a user’s Spotify activity may not appear if they are listening to a song with a title longer than 128 characters. See 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.

Added in version 1.6.

Type:

bool

premium_since

An aware datetime object that specifies the date and time in UTC when the member used their “Nitro boost” on the guild, if available. This could be None.

Type:

Optional[datetime.datetime]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property name

Equivalent to User.name

property id

Equivalent to User.id

property global_name

Equivalent to User.global_name

property discriminator

Equivalent to User.discriminator

property bot

Equivalent to User.bot

property system

Equivalent to User.system

property created_at

Equivalent to User.created_at

property default_avatar

Equivalent to User.default_avatar

property avatar

Equivalent to User.avatar

property dm_channel

Equivalent to User.dm_channel

await create_dm()

This function is a coroutine.

Creates a DMChannel with this user.

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

Returns:

The channel that was created.

Return type:

DMChannel

property mutual_guilds

Equivalent to User.mutual_guilds

property public_flags

Equivalent to User.public_flags

property banner

Equivalent to User.banner

property accent_color

Equivalent to User.accent_color

property accent_colour

Equivalent to User.accent_colour

property avatar_decoration

Equivalent to User.avatar_decoration

property raw_status

The member’s overall status as a string value.

Added in version 1.5.

Type:

str

property status

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

Type:

Union[Status, str]

property mobile_status

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

Type:

Status

property desktop_status

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

Type:

Status

property web_status

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

Type:

Status

is_on_mobile()

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

property colour

A property that returns a colour denoting the rendered colour for the member. If the default colour is the one rendered then an instance of Colour.default() is returned.

There is an alias for this named color.

Type:

Colour

property color

A property that returns a color denoting the rendered color for the member. If the default color is the one rendered then an instance of Colour.default() is returned.

There is an alias for this named colour.

Type:

Colour

property roles

A list of Role that the member belongs to. Note that the first element of this list is always the default ‘@everyone’ role.

These roles are sorted by their position in the role hierarchy.

Type:

List[Role]

property mention

Returns a string that allows you to mention the member.

Changed in version 2.2: The nickname mention syntax is no longer returned as it is deprecated by Discord.

Type:

str

property display_name

Returns the user’s display name.

This will return the name using the following hierachy:

1. Guild specific nickname

2. Global Name (also known as ‘Display Name’ in the Discord UI)

3. Unique username

Type:

str

property display_avatar

Returns the member’s display avatar.

For regular members this is just their avatar, but if they have a guild specific avatar then that is returned instead.

Added in version 2.0.

Type:

Asset

property guild_avatar

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

Added in version 2.0.

Type:

Optional[Asset]

property guild_banner

Returns an Asset for the guild member’s banner. If unavailable, None is returned.

Added in version 3.0.

Type:

Optional[Asset]

property display_banner

Returns the member’s display banner. If unavailable, None is returned

For regular members this is just their banner, if any, but if they have a guild specific banner then that is returned instead.

Added in version 3.0.

Type:

Optional[Asset]

property activity

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

Note

Due to a Discord API limitation, this may be None if the user is listening to a song on Spotify with a title longer than 128 characters. See GH-1738 for more information.

Note

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

Type:

Optional[Union[BaseActivity, Spotify]]

property flags

Returns the member’s flags.

Added in version 2.6.

Type:

MemberFlags

mentioned_in(message)

Checks if the member is mentioned in the specified message.

Parameters:

message (Message) – The message to check if you’re mentioned in.

Returns:

Indicates if the member is mentioned in the message.

Return type:

bool

property top_role

Returns the member’s highest role.

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

Type:

Role

property guild_permissions

Returns the member’s guild permissions.

This only takes into consideration the guild permissions and not most of the implied permissions or any of the channel permission overwrites. For 100% accurate permission calculation, please use abc.GuildChannel.permissions_for().

This does take into consideration guild ownership and the administrator implication.

Type:

Permissions

property voice

Returns the member’s current voice state.

Type:

Optional[VoiceState]

property communication_disabled_until

A datetime object that represents the time in which the member will be able to interact again.

Note

This is None if the user has no timeout.

Added in version 2.0.

Type:

Optional[datetime.datetime]

await ban(*, delete_message_seconds=None, 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 timeout(timeout, *, reason=None)

This function is a coroutine.

Times out this member.

Note

This is a more direct method of timing out a member. You can also time out members using Member.edit().

Added in version 2.0.

Parameters:

• timeout (Optional[Union[datetime, timedelta]]) – The time until the member should not be timed out. Set this to None to disable their timeout.

• reason (Optional[str]) – The reason for editing this member. Shows up on the audit log.

await edit(*, nick=..., mute=..., deafen=..., suppress=..., roles=..., voice_channel=..., reason=None, timeout=..., flags=..., bypass_verification=...)

This function is a coroutine.

Edits the member’s data.

Depending on the parameter passed, this requires different permissions listed below:

Parameter	Permission
nick	Permissions.manage_nicknames
mute	Permissions.mute_members
deafen	Permissions.deafen_members
roles	Permissions.manage_roles
voice_channel	Permissions.move_members
timeout	Permissions.moderate_members
bypass_verification	Permissions.moderate_members

All parameters are optional.

Changed in version 1.1: Can now pass None to voice_channel to kick a member from voice.

Changed in version 2.0: The newly member is now optionally returned, if applicable.

Parameters:

• nick (Optional[str]) – The member’s new nickname. Use None to remove the nickname.

• mute (bool) – 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.

  Added in version 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.

• timeout (Optional[Union[datetime, timedelta]) –

  The time until the member should not be timed out. Set this to None to disable their timeout.

  Added in version 2.0.

• flags (MemberFlags) –

  The flags to set for this member. Currently only bypasses_verification is able to be set.

  Added in version 2.6.

• bypass_verification (bool) –

  Indicates if the member should be allowed to bypass the guild verification requirements.

  Added in version 2.6.

Raises:

• Forbidden – You do not have the proper permissions to the action requested.

• HTTPException – The operation failed.

Returns:

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

Return type:

Optional[Member]

await request_to_speak()

This function is a coroutine.

Request to speak in the connected channel.

Only applies to stage channels.

Note

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

Added in version 1.7.

Raises:

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

Changed in version 1.1: Can now pass None to kick a member from voice.

Parameters:

• channel (Optional[VoiceChannel]) – The new voice channel to move the member to. Pass None to kick them from voice.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

await disconnect(*, reason=None)

This function is a coroutine.

Disconnects a member from the voice channel they are connected to.

You must have the move_members permission to use this.

This raises the same exceptions as edit().

Parameters:

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.

Parameters:

• *roles (abc.Snowflake) – An argument list of abc.Snowflake representing a Role to give to the member.

• reason (Optional[str]) – The reason for adding these roles. Shows up on the audit log.

• atomic (bool) – Whether to atomically add roles. This will ensure that multiple operations will always be applied regardless of the current state of the cache.

Raises:

• Forbidden – You do not have permissions to add these roles.

• HTTPException – Adding roles failed.

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

This function is a coroutine.

Removes Roles from this member.

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

Parameters:

• *roles (abc.Snowflake) – An argument list of abc.Snowflake representing a Role to remove from the member.

• reason (Optional[str]) – The reason for removing these roles. Shows up on the audit log.

• atomic (bool) – Whether to atomically remove roles. This will ensure that multiple operations will always be applied regardless of the current state of the cache.

Raises:

• Forbidden – You do not have permissions to remove these roles.

• HTTPException – Removing the roles failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

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

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

get_role(role_id, /)

Returns a role with the given ID from roles which the member has.

Added in version 2.0.

Parameters:

role_id (int) – The ID to search for.

Returns:

The role or None if not found in the member’s roles.

Return type:

Optional[Role]

await send(content=None, *, tts=False, 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, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

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

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

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

Returns the activity’s type. This is for compatibility with Activity.

It always returns ActivityType.listening.

Type:

ActivityType

property created_at

When the user started listening in UTC.

Added in version 1.3.

Type:

Optional[datetime.datetime]

property colour

Returns the Spotify integration colour, as a Colour.

There is an alias for this named color

Type:

Colour

property color

Returns the Spotify integration colour, as a Colour.

There is an alias for this named colour

Type:

Colour

property name

The activity’s name. This will always return “Spotify”.

Type:

str

property title

The title of the song being played.

Type:

str

property artists

The artists of the song being played.

Type:

List[str]

property artist

The artist of the song being played.

This does not attempt to split the artist information into multiple artists. Useful if there’s only a single artist.

Type:

str

property album

The album that the song being played belongs to.

Type:

str

property album_cover_url

The album cover image URL from Spotify’s CDN.

Type:

str

property track_id

The track ID used by Spotify to identify this song.

Type:

str

property track_url

The track URL to listen on Spotify.

Added in version 2.0.

Type:

str

property start

When the user started playing this song in UTC.

Type:

datetime.datetime

property end

When the user will stop playing this song in UTC.

Type:

datetime.datetime

property duration

The duration of the song being played.

Type:

datetime.timedelta

property party_id

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

Added in version 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.

Added in version 1.7.

Type:

bool

requested_to_speak_at

An aware datetime object that specifies the date and time in UTC that the member requested to speak. It will be None if they are not requesting to speak anymore or have been accepted to speak.

Only applicable to stage channels.

Added in version 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
• application_id
• available
• created_at
• guild
• guild_id
• id
• managed
• name
• require_colons
• roles
• url
• user

Methods

• asyncdelete
• asyncedit
• defis_application_emoji
• defis_guild_emoji
• defis_usable
• asyncread
• asyncsave
• asyncto_file

class nextcord.Emoji

Represents a custom emoji.

Depending on the way this object was created, some of the attributes can have a value of None.

x == y

Checks if two emoji are the same.

x != y

Checks if two emoji are not the same.

hash(x)

Return the emoji’s hash.

iter(x)

Returns an iterator of (field, value) pairs. This allows this class to be used as an iterable in list/dict/etc constructions.

str(x)

Returns the emoji rendered for discord.

name

The 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, if applicable. This is `None for application emojis.

Changed in version 3.1: This attribute is now optional to account for application emojis.

Type:

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

application_id

The ID of the application that this emoji belongs to, if applicable. This is `None for guild emojis.

Added in version 3.1.

Type:

Optional[int]

property created_at

Returns the emoji’s creation time in UTC.

Type:

datetime.datetime

property url

Returns the URL of the emoji.

Type:

str

property roles

A list of roles that is allowed to use this emoji.

If roles is empty, the emoji is unrestricted.

Type:

List[Role]

property guild

The guild this emoji belongs to, if applicable.

Type:

Guild

is_usable()

bool: Whether the bot can use this emoji.

Added in version 1.3.

Changed in version 3.1: This now accounts for application emojis as well by comparing the application ID.

await delete(*, reason=None)

This function is a coroutine.

Deletes the custom emoji.

You must have manage_emojis permission to do this.

Parameters:

reason (Optional[str]) –

The reason for deleting this emoji. Shows up on the audit log.

This is only available when deleting an emoji in a guild.

Raises:

• Forbidden – You are not allowed to delete emojis.

• HTTPException – An error occurred deleting the emoji.

• ValueError – The emoji does not belong to a guild or application.

await edit(*, name=..., roles=..., reason=None)

This function is a coroutine.

Edits the custom emoji.

You must have manage_emojis permission to do this.

Changed in version 2.0: The newly updated emoji is returned.

Parameters:

• name (str) – The new emoji name.

• roles (Optional[List[Snowflake]]) –

  A list of roles that can use this emoji. An empty list can be passed to make it available to everyone.

  This is only available when editing an emoji in a guild.

• reason (Optional[str]) –

  The reason for editing this emoji. Shows up on the audit log.

  This is only available when editing an emoji in a guild.

Raises:

• Forbidden – You are not allowed to edit emojis.

• HTTPException – An error occurred editing the emoji.

• ValueError – The emoji does not belong to a guild or application

Returns:

The newly updated emoji.

Return type:

Emoji

is_application_emoji()

bool: Whether the emoji is an application emoji.

is_guild_emoji()

bool: Whether the emoji is a guild emoji.

await read()

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, filename=..., description=None, spoiler=False, force_close=True)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

Added in version 2.0.

Parameters:

• filename (Optional[str]) – The filename of the file. If not provided, then the filename from the asset’s URL is used.

• description (Optional[str]) – The description for the file.

• spoiler (bool) – Whether the file is a spoiler.

• force_close (bool) –

  Whether to forcibly close the bytes used to create the file when .close() is called. This will also make the file bytes unusable by flushing it from memory after it is sent or used once. Keep this enabled if you don’t wish to reuse the same bytes.

  Added in version 2.2.

Raises:

• DiscordException – The asset does not have an associated state.

• InvalidArgument – The asset is a unicode emoji.

• TypeError – The asset is a sticker with lottie type.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The asset as a file suitable for sending.

Return type:

File

PartialEmoji

Attributes

• animated
• created_at
• id
• name
• url

Methods

• clsPartialEmoji.from_str
• defis_custom_emoji
• defis_unicode_emoji
• asyncread
• asyncsave
• asyncto_file

class nextcord.PartialEmoji

Represents a “partial” emoji.

This model will be given in two scenarios:

• “Raw” data events such as on_raw_reaction_add()

• Custom emoji that the bot cannot see from e.g. Message.reactions

x == y

Checks if two emoji are the same.

x != y

Checks if two emoji are not the same.

hash(x)

Return the emoji’s hash.

str(x)

Returns the emoji rendered for discord.

name

The custom emoji name, if applicable, or the unicode codepoint of the non-custom emoji. This can be None if the emoji got deleted (e.g. removing a reaction with a deleted emoji).

Type:

Optional[str]

animated

Whether the emoji is animated or not.

Type:

bool

id

The ID of the custom emoji, if applicable.

Type:

Optional[int]

classmethod from_str(value)

Converts a Discord string representation of an emoji to a PartialEmoji.

The formats accepted are:

• a:name:id

• <a:name:id>

• name:id

• <:name:id>

If the format does not match then it is assumed to be a unicode emoji.

Added in version 2.0.

Parameters:

value (str) – The string representation of an emoji.

Returns:

The partial emoji from this string.

Return type:

PartialEmoji

is_custom_emoji()

bool: Checks if this is a custom non-Unicode emoji.

is_unicode_emoji()

bool: Checks if this is a Unicode emoji.

property created_at

Returns the emoji’s creation time in UTC, or None if Unicode emoji.

Added in version 1.6.

Type:

Optional[datetime.datetime]

property url

Returns the URL of the emoji, if it is custom.

If this isn’t a custom emoji then an empty string is returned

Type:

str

await read()

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The content of the asset.

Return type:

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameters:

• fp (Union[io.BufferedIOBase, os.PathLike]) – The file-like object to save this asset to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

• seek_begin (bool) – Whether to seek to the beginning of the file after saving is successfully done.

Raises:

• DiscordException – There was no internal connection state.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The number of bytes written.

Return type:

int

await to_file(*, filename=..., description=None, spoiler=False, force_close=True)

This function is a coroutine.

Converts the asset into a File suitable for sending via abc.Messageable.send().

Added in version 2.0.

Parameters:

• filename (Optional[str]) – The filename of the file. If not provided, then the filename from the asset’s URL is used.

• description (Optional[str]) – The description for the file.

• spoiler (bool) – Whether the file is a spoiler.

• force_close (bool) –

  Whether to forcibly close the bytes used to create the file when .close() is called. This will also make the file bytes unusable by flushing it from memory after it is sent or used once. Keep this enabled if you don’t wish to reuse the same bytes.

  Added in version 2.2.

Raises:

• DiscordException – The asset does not have an associated state.

• InvalidArgument – The asset is a unicode emoji.

• TypeError – The asset is a sticker with lottie type.

• HTTPException – Downloading the asset failed.

• NotFound – The asset was deleted.

Returns:

The asset as a file suitable for sending.

Return type:

File

Role

Attributes

• color
• colors
• colour
• colours
• created_at
• flags
• guild
• hoist
• icon
• id
• managed
• members
• mention
• mentionable
• name
• permissions
• position
• tags

Methods

• asyncdelete
• asyncedit
• defis_assignable
• defis_bot_managed
• defis_default
• defis_in_prompt
• defis_integration
• defis_premium_subscriber

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

Warning

Multiple roles can have the same position number. As a consequence of this, comparing via role position is prone to subtle bugs if checking for role hierarchy. The recommended and correct way to compare for roles in the hierarchy is using the comparison operators on the role objects themselves.

Type:

int

managed

Indicates if the role is managed by the guild through some form of integrations such as Twitch.

Type:

bool

mentionable

Indicates if the role can be mentioned by users.

Type:

bool

tags

The role tags associated with this role.

Type:

Optional[RoleTags]

is_default()

bool: Checks if the role is the default role.

is_bot_managed()

bool: Whether the role is associated with a bot.

Added in version 1.6.

is_premium_subscriber()

bool: Whether the role is the premium subscriber, AKA “boost”, role for the guild.

Added in version 1.6.

is_integration()

bool: Whether the role is managed by an integration.

Added in version 1.6.

is_assignable()

bool: Whether the role is able to be assigned or removed by the bot.

Added in version 2.0.

is_in_prompt()

bool: Whether the role can be selected in an onboarding prompt.

Added in version 2.6.

property permissions

Returns the role’s permissions.

Type:

Permissions

property colour

Returns the role colour. An alias exists under color.

Type:

Colour

property color

Returns the role color. An alias exists under colour.

Type:

Colour

property colours

Returns the role colours. An alias exists under colors.

Added in version 3.2.

Type:

RoleColours

property colors

Returns the role colors. An alias exists under colours.

Added in version 3.2.

Type:

RoleColours

property created_at

Returns the role’s creation time in UTC.

Type:

datetime.datetime

property mention

Returns a string that allows you to mention a role.

Type:

str

property members

Returns all the members with this role.

Type:

List[Member]

property icon

Returns the role’s icon asset or its unicode emoji, if available.

Type:

Optional[Union[Asset, str]]

await edit(*, name=..., permissions=..., colour=..., color=..., colours=..., colors=..., hoist=..., mentionable=..., position=..., reason=..., icon=...)

This function is a coroutine.

Edits the role.

You must have the manage_roles permission to use this.

All fields are optional.

Changed in version 1.4: Can now pass int to colour keyword-only parameter.

Changed in version 2.0: Edits are no longer in-place, the newly edited role is returned instead.

Changed in version 2.1: The icon parameter now accepts Attachment, and Asset.

Changed in version 3.2: Added the colours and colors parameters.

Parameters:

• name (str) – The new role name to change to.

• permissions (Permissions) – The new permissions to change to.

• colour (Union[Colour, int]) – The new colour to change to. (aliased to color as well)

• colours (RoleColours) – The new colours to change to. (aliased to colors as well)

• hoist (bool) – Indicates if the role should be shown separately in the member list.

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

• icon (Optional[Union[str, bytes, File, Asset, Attachment]]) – The role’s icon image

• reason (Optional[str]) – The reason for editing this role. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to change the role.

• HTTPException – Editing the role failed.

• InvalidArgument – An invalid position was given, the default role was asked to be moved, or multiple colour parameters were passed.

Returns:

The newly edited role.

Return type:

Role

await delete(*, reason=None)

This function is a coroutine.

Deletes the role.

You must have the manage_roles permission to use this.

Parameters:

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

Raises:

• Forbidden – You do not have permissions to delete the role.

• HTTPException – Deleting the role failed.

property flags

The avaliable flags the role has.

Added in version 2.6.

Type:

RoleFlags

RoleTags

Attributes

• available_for_purchase
• bot_id
• guild_connections
• integration_id
• premium_subscriber
• subscription_listing_id

Methods

• defhas_guild_connections
• defis_available_for_purchase
• defis_bot_managed
• defis_integration
• defis_premium_subscriber

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

Added in version 1.6.

bot_id

The bot’s user ID that manages this role.

Type:

Optional[int]

integration_id

The integration ID that manages the role.

Type:

Optional[int]

subscription_listing_id

The ID of the subscription listing that manages the role.

Added in version 2.4.

Type:

Optional[int]

premium_subscriber

Whether the role is the premium subscriber, AKA “boost”, role for the guild.

versionadded:: 3.2

Type:

bool

available_for_purchase

Whether the role is available for purchase.

Added in version 3.2.

Type:

bool

guild_connections

Whether the role is a guild’s linked role.

Added in version 3.2.

Type:

bool

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.

is_available_for_purchase()

bool: Whether the role is available for purchase.

Added in version 2.4.

has_guild_connections()

bool: Whether the role is a guild’s linked role.

Added in version 2.4.

RoleColours

Attributes

• primary
• secondary
• tertiary

Methods

• clsRoleColours.holographic

class nextcord.RoleColours

Represents the colours of a role.

There is an alias for this called RoleColors.

secondary and tertiary can only be set if the guild has the ENHANCED_ROLE_COLORS feature enabled.

Added in version 3.2.

primary

The primary colour of the role.

Type:

Colour

secondary

The secondary colour of the role, if available.

This creates a gradient between the primary and secondary colours.

Type:

Optional[Colour]

tertiary

The tertiary colour of the role, if available.

This creates a holographic effect with the three colours. Currently, there is only one holographic style, which can be accessed with holographic().

Type:

Optional[Colour]

classmethod holographic()

Returns a RoleColours with a ‘holographic style’.

This is the only known holographic style, with preset colour values.

PartialMessageable

Attributes

• id
• type

Methods

• asyncfetch_message
• asyncforward
• defget_partial_message
• defhistory
• asyncsend
• asynctrigger_typing
• deftyping

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

Added in version 2.0.

x == y

Checks if two partial messageables are equal.

x != y

Checks if two partial messageables are not equal.

hash(x)

Returns the partial messageable’s hash.

id

The channel ID associated with this partial messageable.

Type:

int

type

The channel type associated with this partial messageable, if given.

Type:

Optional[ChannelType]

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.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message.

Return type:

PartialMessage

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

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

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

await send(content=None, *, tts=False, 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, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

• 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.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

TextChannel

Attributes

• category
• category_id
• changed_roles
• created_at
• default_auto_archive_duration
• default_thread_slowmode_delay
• flags
• guild
• id
• jump_url
• last_message
• last_message_id
• members
• mention
• name
• nsfw
• overwrites
• permissions_synced
• position
• slowmode_delay
• threads
• topic
• type

Methods

• defarchived_threads
• asyncclone
• asynccreate_invite
• asynccreate_thread
• asynccreate_webhook
• asyncdelete
• asyncdelete_messages
• asyncedit
• asyncfetch_message
• asyncfollow
• asyncforward
• 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 nextcord.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

flags

Extra features of the channel.

..versionadded:: 2.1

Type:

ChannelFlags

nsfw

If the channel is marked as “not safe for work”.

Note

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Type:

bool

default_auto_archive_duration

The default auto archive duration in minutes for threads created in this channel.

Added in version 2.0.

Type:

int

default_thread_slowmode_delay

The default amount of seconds a user has to wait before creating another thread in this channel. This is set on every new thread in this channel.

Added in version 2.4.

Type:

int

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property type

The channel’s Discord type.

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

• Timed-out members

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.3: Only view_channel and read_message_history can be returned for timed-out members

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

property members

Returns all members that can see this channel.

Type:

List[Member]

property threads

Returns all the threads that you can see.

Added in version 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

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.

Returns:

The last message in this channel or None if not found.

Return type:

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.

Changed in version 1.3: The overwrites keyword-only parameter was added.

Changed in version 1.4: The type keyword-only parameter was added.

Changed in version 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameters:

• 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.

• default_thread_slowmode_delay (int) –

  The new default rate limit per user for threads created in this channel. This sets a new default but does not change the rate limits of existing threads.

  Added in version 2.4.

Raises:

• 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.

Returns:

The newly edited text channel. If the edit was only positional then None is returned instead.

Return type:

Optional[TextChannel]

await clone(*, name=None, reason=None)

This function is a coroutine.

Clones this channel. This creates a channel with the same properties as this channel.

You must have the manage_channels permission to do this.

Added in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

await delete_messages(messages)

This function is a coroutine.

Deletes a list of messages. This is similar to Message.delete() except it bulk deletes multiple messages.

As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then single message delete is done. If it’s more than two, then bulk delete is used.

You cannot bulk delete more than 100 messages or messages that are older than 14 days old.

You must have the manage_messages permission to use this.

Parameters:

messages (Iterable[abc.Snowflake]) – An iterable of messages denoting which ones to bulk delete.

Raises:

• ClientException – The number of messages to delete was more than 100.

• Forbidden – You do not have proper permissions to delete the messages.

• NotFound – If single delete, then the message was already deleted.

• HTTPException – Deleting the messages failed.

await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=False, bulk=True)

This function is a coroutine.

Purges a list of messages that meet the criteria given by the predicate check. If a check is not provided then all messages are deleted without discrimination.

You must have 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.

Examples

Deleting bot’s messages

def is_me(m):
    return m.author == client.user

deleted = await channel.purge(limit=100, check=is_me)
await channel.send(f'Deleted {len(deleted)} message(s)')

Parameters:

• limit (Optional[int]) – The number of messages to search through. This is not the number of messages that will be deleted, though it can be.

• check (Callable[[Message], bool]) – The function used to check if a message should be deleted. It must take a Message as its sole parameter.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as before in history().

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as after in history().

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as around in history().

• oldest_first (Optional[bool]) – Same as oldest_first in history().

• bulk (bool) – If True, use bulk delete. Setting this to False is useful for mass-deleting a bot’s own messages without Permissions.manage_messages. When True, will fall back to single delete if messages are older than two weeks.

Raises:

• Forbidden – You do not have proper permissions to do the actions required.

• HTTPException – Purging the messages failed.

Returns:

The list of messages that were deleted.

Return type:

List[Message]

await webhooks()

This function is a coroutine.

Gets the list of webhooks from this channel.

Requires manage_webhooks permissions.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The webhooks for this channel.

Return type:

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.

Changed in version 1.1: Added the reason keyword-only parameter.

Changed in version 2.1: The avatar parameter now accepts File, Attachment, and Asset.

Parameters:

• name (str) – The webhook’s name.

• avatar (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset 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.

Raises:

• HTTPException – Creating the webhook failed.

• Forbidden – You do not have permissions to create a webhook.

Returns:

The created webhook.

Return type:

Webhook

await follow(*, destination, reason=None)

Follows a channel using a webhook.

Only news channels can be followed.

Note

The webhook returned will not provide a token to do webhook actions, as Discord does not provide it.

Added in version 1.3.

Parameters:

• destination (TextChannel) – The channel you would like to follow from.

• reason (Optional[str]) –

  The reason for following the channel. Shows up on the destination guild’s audit log.

  Added in version 1.4.

Raises:

• HTTPException – Following the channel failed.

• Forbidden – You do not have the permissions to create a webhook.

Returns:

The created webhook.

Return type:

Webhook

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.

Added in version 1.6.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message.

Return type:

PartialMessage

get_thread(thread_id, /)

Returns a thread with the given ID.

Added in version 2.0.

Parameters:

thread_id (int) – The ID to search for.

Returns:

The returned thread or None if not found.

Return type:

Optional[Thread]

await create_thread(*, name, message=None, auto_archive_duration=..., type=None, invitable=True, 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.

Added in version 2.0.

Parameters:

• 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.

• invitable (bool) – Whether non-moderators can add other non-moderators to this thread. Only available for private threads and threads created without a message.

• reason (str) – The reason for creating a new thread. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to create a thread.

• HTTPException – Starting the thread failed.

Returns:

The created thread

Return type:

Thread

archived_threads(*, private=False, joined=False, limit=50, before=None)

This function returns an async iterator.

Returns an async iterator 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.

Added in version 2.0.

Parameters:

• limit (Optional[int]) – The number of threads to retrieve. If None, retrieves every archived thread in the channel. Note, however, that this would make it a slow operation. This defaults to 50.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Retrieve archived channels before the given date or ID.

• private (bool) – Whether to retrieve private archived threads. This defaults to False.

• joined (bool) –

  Whether to retrieve private archived threads that you’ve joined. This defaults to False.

  Warning

  You cannot set joined to True and private to False.

Raises:

• Forbidden – You do not have permissions to get archived threads.

• HTTPException – The request to get the archived threads failed.

Yields:

Thread – The archived threads.

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the 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_id=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.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – 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.

  Added in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is InviteTarget.stream. The user must be streaming in the channel.

  Added in version 2.0.

• target_application_id: –

  Optional[int]: The id of the embedded application for the invite, required if target_type is InviteTarget.embedded_application.

  Added in version 2.0.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The invite that was created.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

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.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

property jump_url

Returns a URL that allows the client to jump to this channel.

Added in version 2.0.

Type:

str

property mention

The string that allows you to mention the channel.

Type:

str

await move(*, beginning=None, end=None, before=None, after=None, offset=0, category=..., sync_permissions=False, reason=None)

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.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

Added in version 1.7.

Changed in version 2.4: beginning, end, before, after and reason now accept None.

Parameters:

• beginning (Optional[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 (Optional[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 (Optional[Snowflake]) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (Optional[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 (Optional[str]) – The reason for the move.

Raises:

• 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

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Added in version 1.3.

Type:

bool

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

• 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.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await set_permissions(target, *, reason=None, **kwargs)

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.

Note

This method replaces the old overwrites with the ones given.

Examples

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)

Using PermissionOverwrite

overwrite = nextcord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• 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

Attributes

• applied_tag_ids
• applied_tags
• archive_timestamp
• archived
• archiver_id
• auto_archive_duration
• category
• category_id
• create_timestamp
• created_at
• guild
• id
• invitable
• jump_url
• last_message
• last_message_id
• locked
• me
• member_count
• members
• mention
• message_count
• name
• owner
• owner_id
• parent
• parent_id
• slowmode_delay
• type

Methods

• asyncadd_user
• asyncdelete
• asyncdelete_messages
• asyncedit
• asyncfetch_members
• asyncfetch_message
• asyncforward
• defget_partial_message
• defhistory
• defis_news
• defis_nsfw
• defis_private
• asyncjoin
• asyncleave
• defpermissions_for
• asyncpins
• asyncpurge
• asyncremove_user
• asyncsend
• asynctrigger_typing
• deftyping

class nextcord.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.

Added in version 2.0.

name

The thread name.

Type:

str

guild

The guild the thread belongs to.

Type:

Guild

id

The thread ID.

Type:

int

parent_id

The parent TextChannel ID this thread belongs to.

Type:

int

owner_id

The user’s ID that created this thread.

Type:

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:

int

member_count

An approximate number of members in this thread. This caps at 50.

Type:

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

create_timestamp

Returns the threads’s creation time in UTC. This is None if the thread was created before January 9th, 2021.

Added in version 2.0.

Type:

Optional[datetime.datetime]

applied_tag_ids

A list of tag IDs that have been applied to this thread.

Added in version 2.4.

Type:

List[int]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property created_at

Returns the threads’s creation time in UTC. This is None if the thread was created before January 9th, 2021.

Added in version 2.0.

Type:

Optional[datetime.datetime]

property type

The channel’s Discord type.

Type:

ChannelType

property parent

The parent channel this thread belongs to.

Type:

Optional[Union[TextChannel, ForumChannel]]

property owner

The member this thread belongs to.

Type:

Optional[Member]

property mention

The string that allows you to mention the thread.

Type:

str

property members

A list of thread members in this thread.

This requires Intents.members to be properly filled. Most of the time however, this data is not provided by the gateway and a call to fetch_members() is needed.

Type:

List[ThreadMember]

property last_message

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.

Returns:

The last message in this channel or None if not found.

Return type:

Optional[Message]

property category

The category channel the parent channel belongs to, if applicable.

Raises:

ClientException – The parent channel was not cached and returned None.

Returns:

The parent channel’s category.

Return type:

Optional[CategoryChannel]

property category_id

The category channel ID the parent channel belongs to, if applicable.

Raises:

ClientException – The parent channel was not cached and returned None.

Returns:

The parent channel’s category ID.

Return type:

Optional[int]

property jump_url

Returns a URL that allows the client to jump to this channel.

Added in version 2.0.

Type:

str

property applied_tags

A list of tags applied to this thread.

This is None if the parent channel was not found in cache.

Added in version 2.4.

Type:

Optional[List[ForumTag]]

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.

Parameters:

obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

Raises:

ClientException – The parent channel was not cached and returned None

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

await delete_messages(messages)

This function is a coroutine.

Deletes a list of messages. This is similar to Message.delete() except it bulk deletes multiple messages.

As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then single message delete is done. If it’s more than two, then bulk delete is used.

You cannot bulk delete more than 100 messages or messages that are older than 14 days old.

You must have the manage_messages permission to use this.

Usable only by bot accounts.

Parameters:

messages (Iterable[abc.Snowflake]) – An iterable of messages denoting which ones to bulk delete.

Raises:

• ClientException – The number of messages to delete was more than 100.

• Forbidden – You do not have proper permissions to delete the messages or you’re not using a bot account.

• NotFound – If single delete, then the message was already deleted.

• HTTPException – Deleting the messages failed.

await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=False, bulk=True)

This function is a coroutine.

Purges a list of messages that meet the criteria given by the predicate check. If a check is not provided then all messages are deleted without discrimination.

You must have the manage_messages permission to delete messages even if they are your own (unless you are a user account). The read_message_history permission is also needed to retrieve message history.

Examples

Deleting bot’s messages

def is_me(m):
    return m.author == client.user

deleted = await thread.purge(limit=100, check=is_me)
await thread.send(f'Deleted {len(deleted)} message(s)')

Parameters:

• limit (Optional[int]) – The number of messages to search through. This is not the number of messages that will be deleted, though it can be.

• check (Callable[[Message], bool]) – The function used to check if a message should be deleted. It must take a Message as its sole parameter.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as before in history().

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as after in history().

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as around in history().

• oldest_first (Optional[bool]) – Same as oldest_first in history().

• bulk (bool) – If True, use bulk delete. Setting this to False is useful for mass-deleting a bot’s own messages without Permissions.manage_messages. When True, will fall back to single delete if messages are older than two weeks.

Raises:

• Forbidden – You do not have proper permissions to do the actions required.

• HTTPException – Purging the messages failed.

Returns:

The list of messages that were deleted.

Return type:

List[Message]

await edit(*, name=..., archived=..., locked=..., invitable=..., slowmode_delay=..., auto_archive_duration=..., flags=..., applied_tags=...)

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.

Parameters:

• name (str) – The new name of the thread.

• archived (bool) – Whether to archive the thread or not.

• locked (bool) – Whether to lock the thread or not.

• invitable (bool) – Whether non-moderators can add other non-moderators to this thread. Only available for private threads.

• auto_archive_duration (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.

• flags (ChannelFlags) –

  The new channel flags to use for this thread.

  Added in version 2.1.

• applied_tags (List[ForumTag]) –

  The new tags to apply to this thread.

  Added in version 2.4.

Raises:

• Forbidden – You do not have permissions to edit the thread.

• HTTPException – Editing the thread failed.

Returns:

The newly edited thread.

Return type:

Thread

await join()

This function is a coroutine.

Joins this thread.

You must have send_messages_in_threads to join a thread. If the thread is private, manage_threads is also needed.

Raises:

• Forbidden – You do not have permissions to join the thread.

• HTTPException – Joining the thread failed.

await leave()

This function is a coroutine.

Leaves this thread.

Raises:

HTTPException – Leaving the thread failed.

await add_user(user)

This function is a coroutine.

Adds a user to this thread.

You must have send_messages 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.

Parameters:

user (abc.Snowflake) – The user to add to the thread.

Raises:

• Forbidden – You do not have permissions to add the user to the thread.

• HTTPException – Adding the user to the thread failed.

await remove_user(user)

This function is a coroutine.

Removes a user from this thread.

You must have manage_threads or be the creator of the thread to remove a user.

Parameters:

user (abc.Snowflake) – The user to add to the thread.

Raises:

• Forbidden – You do not have permissions to remove the user from the thread.

• HTTPException – Removing the user from the thread failed.

await fetch_members()

This function is a coroutine.

Retrieves all ThreadMember that are in this thread.

This requires Intents.members to get information about members other than yourself.

Raises:

HTTPException – Retrieving the members failed.

Returns:

All thread members in the thread.

Return type:

List[ThreadMember]

await delete()

This function is a coroutine.

Deletes this thread.

You must have manage_threads to delete threads.

Raises:

• 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.

Added in version 2.0.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message.

Return type:

PartialMessage

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

• 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.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

ThreadMember

Attributes

• id
• joined_at
• member
• thread
• thread_id

Methods

• asyncfetch_member

class nextcord.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.

Added in version 2.0.

id

The thread member’s ID.

Type:

int

thread_id

The thread’s ID.

Type:

int

joined_at

The time the member joined the thread in UTC.

Type:

datetime.datetime

property thread

The thread this member belongs to.

Type:

Thread

property member

The Member of this thread member.

Type:

Optional[Member]

await fetch_member()

Member: Retrieves the Member of this thread member.

Note

This method is an API call. If you have Intents.members and members cache enabled, consider member instead.

VoiceChannel

Attributes

• bitrate
• category
• category_id
• changed_roles
• created_at
• flags
• guild
• id
• jump_url
• last_message
• last_message_id
• members
• mention
• name
• nsfw
• overwrites
• permissions_synced
• position
• rtc_region
• type
• user_limit
• video_quality_mode
• voice_states

Methods

• asyncclone
• asyncconnect
• asynccreate_invite
• asynccreate_webhook
• asyncdelete
• asyncdelete_messages
• asyncedit
• asyncfetch_message
• asyncforward
• defhistory
• asyncinvites
• defis_nsfw
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncpurge
• asyncsend
• asyncset_permissions
• asynctrigger_typing
• deftyping
• asyncwebhooks

class nextcord.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.

Added in version 1.7.

Type:

Optional[VoiceRegion]

video_quality_mode

The camera video quality for the voice channel’s participants.

Added in version 2.0.

Type:

VideoQualityMode

last_message_id

The last message ID of the message sent to this channel. It may not point to an existing or valid message.

Added in version 2.1.

Type:

Optional[int]

nsfw

If the channel is marked as “not safe for work”.

Note

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Added in version 2.1.

Type:

bool

flags

Extra features of the channel.

..versionadded:: 2.1

Type:

ChannelFlags

property type

The channel’s Discord type.

Type:

ChannelType

property last_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.

Added in version 2.1.

Returns:

The last message in this channel or None if not found.

Return type:

Optional[Message]

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.

Added in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

await edit(*, reason=None, **options)

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Changed in version 1.3: The overwrites keyword-only parameter was added.

Changed in version 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameters:

• name (str) – The new channel’s name.

• bitrate (int) – The new channel’s bitrate.

• user_limit (int) –

  The new channel’s user limit.

  This must be a number between 0 and 99. 0 indicates no 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.

  Added in version 1.7.

• video_quality_mode (VideoQualityMode) –

  The camera video quality for the voice channel’s participants.

  Added in version 2.0.

Raises:

• 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.

Returns:

The newly edited voice channel. If the edit was only positional then None is returned instead.

Return type:

Optional[VoiceChannel]

await delete_messages(messages)

This function is a coroutine.

Deletes a list of messages. This is similar to Message.delete() except it bulk deletes multiple messages.

As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then single message delete is done. If it’s more than two, then bulk delete is used.

You cannot bulk delete more than 100 messages or messages that are older than 14 days old.

You must have the manage_messages permission to use this.

Added in version 2.1.

Parameters:

messages (Iterable[abc.Snowflake]) – An iterable of messages denoting which ones to bulk delete.

Raises:

• ClientException – The number of messages to delete was more than 100.

• Forbidden – You do not have proper permissions to delete the messages.

• NotFound – If single delete, then the message was already deleted.

• HTTPException – Deleting the messages failed.

await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=False, bulk=True)

This function is a coroutine.

Purges a list of messages that meet the criteria given by the predicate check. If a check is not provided then all messages are deleted without discrimination.

You must have 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.

Added in version 2.1.

Examples

Deleting bot’s messages

def is_me(m):
    return m.author == client.user

deleted = await channel.purge(limit=100, check=is_me)
await channel.send(f'Deleted {len(deleted)} message(s)')

Parameters:

• limit (Optional[int]) – The number of messages to search through. This is not the number of messages that will be deleted, though it can be.

• check (Callable[[Message], bool]) – The function used to check if a message should be deleted. It must take a Message as its sole parameter.

• before (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as before in history().

• after (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as after in history().

• around (Optional[Union[abc.Snowflake, datetime.datetime]]) – Same as around in history().

• oldest_first (Optional[bool]) – Same as oldest_first in history().

• bulk (bool) – If True, use bulk delete. Setting this to False is useful for mass-deleting a bot’s own messages without Permissions.manage_messages. When True, will fall back to single delete if messages are older than two weeks.

Raises:

• Forbidden – You do not have proper permissions to do the actions required.

• HTTPException – Purging the messages failed.

Returns:

The list of messages that were deleted.

Return type:

List[Message]

await create_webhook(*, name, avatar=None, reason=None)

This function is a coroutine.

Creates a webhook for this channel.

Requires manage_webhooks permissions.

Added in version 2.4.

Parameters:

• name (str) – The webhook’s name.

• avatar (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset 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.

Raises:

• HTTPException – Creating the webhook failed.

• Forbidden – You do not have permissions to create a webhook.

Returns:

The created webhook.

Return type:

Webhook

await webhooks()

This function is a coroutine.

Gets the list of webhooks from this channel.

Requires manage_webhooks permissions.

Added in version 3.0.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The webhooks for this channel.

Return type:

List[Webhook]

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the roles attribute.

Type:

List[Role]

await connect(*, timeout=60.0, reconnect=True, cls=<class 'nextcord.voice_client.VoiceClient'>)

This function is a coroutine.

Connects to voice and creates a VoiceClient to establish your connection to the voice server.

This requires Intents.voice_states.

Parameters:

• timeout (float) – The timeout in seconds to wait for the voice endpoint.

• reconnect (bool) – Whether the bot should automatically attempt a reconnect if a part of the handshake fails or the gateway goes down.

• cls (Type[VoiceProtocol]) – A type that subclasses VoiceProtocol to connect with. Defaults to VoiceClient.

Raises:

• asyncio.TimeoutError – Could not connect to the voice channel in time.

• ClientException – You are already connected to a voice channel.

• OpusNotLoaded – The opus library has not been loaded.

Returns:

A voice client that is fully connected to the voice server.

Return type:

VoiceProtocol

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=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.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – 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.

  Added in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is InviteTarget.stream. The user must be streaming in the channel.

  Added in version 2.0.

• target_application_id: –

  Optional[int]: The id of the embedded application for the invite, required if target_type is InviteTarget.embedded_application.

  Added in version 2.0.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The invite that was created.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

await invites()

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have manage_channels to get this information.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

is_nsfw()

bool: Checks if the channel is NSFW.

property jump_url

Returns a URL that allows the client to jump to this channel.

Added in version 2.0.

Type:

str

property members

Returns all members that are currently inside this voice channel.

Type:

List[Member]

property mention

The string that allows you to mention the channel.

Type:

str

await move(*, beginning=None, end=None, before=None, after=None, offset=0, category=..., sync_permissions=False, reason=None)

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.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

Added in version 1.7.

Changed in version 2.4: beginning, end, before, after and reason now accept None.

Parameters:

• beginning (Optional[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 (Optional[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 (Optional[Snowflake]) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (Optional[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 (Optional[str]) – The reason for the move.

Raises:

• 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

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

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

• Timed-out members

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.3: Only view_channel and read_message_history can be returned for timed-out members

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Added in version 1.3.

Type:

bool

await send(content=None, *, tts=False, 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, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

• 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.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await set_permissions(target, *, reason=None, **kwargs)

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.

Note

This method replaces the old overwrites with the ones given.

Examples

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)

Using PermissionOverwrite

overwrite = nextcord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• 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.

typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property voice_states

Returns a mapping of member IDs who have voice states in this channel.

Added in version 1.3.

Note

This function is intentionally low level to replace members when the member cache is unavailable.

Returns:

The mapping of member ID to a voice state.

Return type:

Mapping[int, VoiceState]

StageChannel

Attributes

• bitrate
• category
• category_id
• changed_roles
• created_at
• flags
• guild
• id
• instance
• jump_url
• listeners
• members
• mention
• moderators
• name
• nsfw
• overwrites
• permissions_synced
• position
• requesting_to_speak
• rtc_region
• speakers
• topic
• type
• user_limit
• video_quality_mode
• voice_states

Methods

• asyncclone
• asyncconnect
• asynccreate_instance
• asynccreate_invite
• asyncdelete
• asyncedit
• asyncfetch_instance
• asyncfetch_message
• asyncforward
• defhistory
• asyncinvites
• defis_nsfw
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncsend
• asyncset_permissions
• asynctrigger_typing
• deftyping
• asyncwebhooks

class nextcord.StageChannel

Represents a Discord guild stage channel.

Added in version 1.7.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel’s hash.

str(x)

Returns the channel’s name.

name

The channel 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.

Added in version 2.0.

Type:

VideoQualityMode

flags

Extra features of the channel.

..versionadded:: 2.1

Type:

ChannelFlags

nsfw

If the channel is marked as “not safe for work”.

Added in version 2.6.

Note

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Type:

bool

property requesting_to_speak

A list of members who are requesting to speak in the stage channel.

Type:

List[Member]

property speakers

A list of members who have been permitted to speak in the stage channel.

Added in version 2.0.

Type:

List[Member]

property listeners

A list of members who are listening in the stage channel.

Added in version 2.0.

Type:

List[Member]

property moderators

A list of members who are moderating the stage channel.

Added in version 2.0.

Type:

List[Member]

property type

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.

Added in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

property instance

The running stage instance of the stage channel.

Added in version 2.0.

Type:

Optional[StageInstance]

await create_instance(*, topic, privacy_level=..., send_start_notification=False, scheduled_event=..., reason=None)

This function is a coroutine.

Create a stage instance.

You must have the manage_channels permission to use this.

Added in version 2.0.

Parameters:

• topic (str) – The stage instance’s topic.

• privacy_level (StagePrivacyLevel) – The stage instance’s privacy level. Defaults to StagePrivacyLevel.guild_only.

• send_start_notification (bool) –

  Whether to notify @everyone that the stage instance has started. Defaults to False.

  Added in version 3.0.

• scheduled_event (abc.Snowflake) –

  The scheduled event associated with this stage instance.

  Added in version 3.0.

• reason (str) – The reason the stage instance was created. Shows up on the audit log.

Raises:

• 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.

Returns:

The newly created stage instance.

Return type:

StageInstance

await fetch_instance()

This function is a coroutine.

Gets the running StageInstance.

Added in version 2.0.

Raises:

• .NotFound – The stage instance or channel could not be found.

• .HTTPException – Getting the stage instance failed.

Returns:

The stage instance.

Return type:

StageInstance

await edit(*, reason=None, **options)

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Changed in version 2.0: The topic parameter must now be set via create_instance.

Changed in version 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameters:

• name (str) – The new channel’s name.

• position (int) – The new channel’s position.

• sync_permissions (bool) – Whether to sync permissions with the channel’s new or pre-existing category. Defaults to False.

• category (Optional[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.

  Added in version 2.0.

• user_limit (int) –

  The maximum number of users allowed in the stage channel.

  This must be between 0 and 10,000. A value of 0 indicates no limit.

  Added in version 2.6.

Raises:

• 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.

Returns:

The newly edited stage channel. If the edit was only positional then None is returned instead.

Return type:

Optional[StageChannel]

await webhooks()

This function is a coroutine.

Gets the list of webhooks from this channel.

Requires manage_webhooks permissions.

Added in version 3.0.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The webhooks for this channel.

Return type:

List[Webhook]

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the roles attribute.

Type:

List[Role]

await connect(*, timeout=60.0, reconnect=True, cls=<class 'nextcord.voice_client.VoiceClient'>)

This function is a coroutine.

Connects to voice and creates a VoiceClient to establish your connection to the voice server.

This requires Intents.voice_states.

Parameters:

• timeout (float) – The timeout in seconds to wait for the voice endpoint.

• reconnect (bool) – Whether the bot should automatically attempt a reconnect if a part of the handshake fails or the gateway goes down.

• cls (Type[VoiceProtocol]) – A type that subclasses VoiceProtocol to connect with. Defaults to VoiceClient.

Raises:

• asyncio.TimeoutError – Could not connect to the voice channel in time.

• ClientException – You are already connected to a voice channel.

• OpusNotLoaded – The opus library has not been loaded.

Returns:

A voice client that is fully connected to the voice server.

Return type:

VoiceProtocol

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=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.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – 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.

  Added in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is InviteTarget.stream. The user must be streaming in the channel.

  Added in version 2.0.

• target_application_id: –

  Optional[int]: The id of the embedded application for the invite, required if target_type is InviteTarget.embedded_application.

  Added in version 2.0.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The invite that was created.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

await invites()

This function is a coroutine.

Returns a list of all active instant invites from this channel.

You must have manage_channels to get this information.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

is_nsfw()

bool: Checks if the channel is NSFW.

property jump_url

Returns a URL that allows the client to jump to this channel.

Added in version 2.0.

Type:

str

property members

Returns all members that are currently inside this voice channel.

Type:

List[Member]

property mention

The string that allows you to mention the channel.

Type:

str

await move(*, beginning=None, end=None, before=None, after=None, offset=0, category=..., sync_permissions=False, reason=None)

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.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

Added in version 1.7.

Changed in version 2.4: beginning, end, before, after and reason now accept None.

Parameters:

• beginning (Optional[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 (Optional[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 (Optional[Snowflake]) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (Optional[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 (Optional[str]) – The reason for the move.

Raises:

• 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

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

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

• Timed-out members

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.3: Only view_channel and read_message_history can be returned for timed-out members

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Added in version 1.3.

Type:

bool

await send(content=None, *, tts=False, 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, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

• 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.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await set_permissions(target, *, reason=None, **kwargs)

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.

Note

This method replaces the old overwrites with the ones given.

Examples

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)

Using PermissionOverwrite

overwrite = nextcord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• 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.

typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property voice_states

Returns a mapping of member IDs who have voice states in this channel.

Added in version 1.3.

Note

This function is intentionally low level to replace members when the member cache is unavailable.

Returns:

The mapping of member ID to a voice state.

Return type:

Mapping[int, VoiceState]

StageInstance

Attributes

• channel
• channel_id
• discoverable_disabled
• guild
• id
• privacy_level
• scheduled_event
• scheduled_event_id
• topic

Methods

• asyncdelete
• asyncedit

class nextcord.StageInstance

Represents a stage instance of a stage channel in a guild.

Added in version 2.0.

x == y

Checks if two stage instances are equal.

x != y

Checks if two stage instances are not equal.

hash(x)

Returns the stage instance’s hash.

id

The stage instance’s ID.

Type:

int

guild

The guild that the stage instance is running in.

Type:

Guild

channel_id

The ID of the channel that the stage instance is running in.

Type:

int

topic

The topic of the stage instance.

Type:

str

privacy_level

The privacy level of the stage instance.

Type:

StagePrivacyLevel

scheduled_event_id

The ID of the scheduled event for this stage instance.

Added in version 3.0.

Type:

Optional[int]

discoverable_disabled

Whether discoverability for the stage instance is disabled.

Type:

bool

channel

The channel that stage instance is running in.

Type:

Optional[StageChannel]

scheduled_event

The scheduled event for this stage instance.

Added in version 3.0.

Type:

Optional[ScheduledEvent]

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.

Parameters:

• 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.

Raises:

• 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.

Parameters:

reason (str) – The reason the stage instance was deleted. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to delete the stage instance.

• HTTPException – Deleting the stage instance failed.

CategoryChannel

Attributes

• category
• changed_roles
• channels
• created_at
• flags
• guild
• id
• jump_url
• mention
• name
• nsfw
• overwrites
• permissions_synced
• position
• stage_channels
• text_channels
• type
• voice_channels

Methods

• asyncclone
• asynccreate_forum_channel
• asynccreate_invite
• asynccreate_stage_channel
• asynccreate_text_channel
• asynccreate_voice_channel
• asyncdelete
• asyncedit
• asyncinvites
• defis_nsfw
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncset_permissions

class nextcord.CategoryChannel

Represents a Discord channel category.

These are useful to group channels to logical compartments.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the category’s hash.

str(x)

Returns the category’s name.

name

The category name.

Type:

str

guild

The guild the category belongs to.

Type:

Guild

id

The category channel ID.

Type:

int

position

The position in the category list. This is a number that starts at 0. e.g. the top category is position 0.

Type:

int

nsfw

If the channel is marked as “not safe for work”.

Note

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

Type:

bool

flags

Extra features of the channel.

..versionadded:: 2.1

Type:

ChannelFlags

property type

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.

Added in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

await edit(*, reason=None, **options)

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Changed in version 1.3: The overwrites keyword-only parameter was added.

Changed in version 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameters:

• 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.

Raises:

• 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.

Returns:

The newly edited category channel. If the edit was only positional then None is returned instead.

Return type:

Optional[CategoryChannel]

await move(*, beginning=None, end=None, before=None, after=None, offset=0, category=..., sync_permissions=False, reason=None)

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.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

Added in version 1.7.

Changed in version 2.4: beginning, end, before, after and reason now accept None.

Parameters:

• beginning (Optional[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 (Optional[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 (Optional[Snowflake]) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (Optional[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 (Optional[str]) – The reason for the move.

Raises:

• 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

Returns the channels that are under this category.

These are sorted by the official Discord UI, which places voice channels below the text channels.

Type:

List[abc.GuildChannel]

property text_channels

Returns the text channels that are under this category.

Type:

List[TextChannel]

property voice_channels

Returns the voice channels that are under this category.

Type:

List[VoiceChannel]

property stage_channels

Returns the stage channels that are under this category.

Added in version 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.

Returns:

The channel that was just created.

Return type:

TextChannel

await create_voice_channel(name, **options)

This function is a coroutine.

A shortcut method to Guild.create_voice_channel() to create a VoiceChannel in the category.

Returns:

The channel that was just created.

Return type:

VoiceChannel

await create_stage_channel(name, **options)

This function is a coroutine.

A shortcut method to Guild.create_stage_channel() to create a StageChannel in the category.

Added in version 1.7.

Returns:

The channel that was just created.

Return type:

StageChannel

await create_forum_channel(name, **options)

This function is a coroutine.

A shortcut method to Guild.create_forum_channel() to create a ForumChannel in the category.

Added in version 2.1.

Returns:

The channel that was just created.

Return type:

ForumChannel

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the 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_id=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.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – 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.

  Added in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is InviteTarget.stream. The user must be streaming in the channel.

  Added in version 2.0.

• target_application_id: –

  Optional[int]: The id of the embedded application for the invite, required if target_type is InviteTarget.embedded_application.

  Added in version 2.0.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The invite that was created.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await 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.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

property jump_url

Returns a URL that allows the client to jump to this channel.

Added in version 2.0.

Type:

str

property mention

The string that allows you to mention the channel.

Type:

str

property overwrites

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

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

• Timed-out members

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.3: Only view_channel and read_message_history can be returned for timed-out members

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Added in version 1.3.

Type:

bool

await set_permissions(target, *, reason=None, **kwargs)

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.

Note

This method replaces the old overwrites with the ones given.

Examples

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)

Using PermissionOverwrite

overwrite = nextcord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• InvalidArgument – The overwrite parameter invalid or the target type was not Role or Member.

DMChannel

Attributes

• created_at
• id
• jump_url
• me
• recipient
• type

Methods

• asyncfetch_message
• asyncforward
• defget_partial_message
• defhistory
• defpermissions_for
• asyncpins
• asyncsend
• asynctrigger_typing
• deftyping

class nextcord.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)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property type

The channel’s Discord type.

Type:

ChannelType

property created_at

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.

Parameters:

obj (User) – The user to check permissions for. This parameter is ignored but kept for compatibility with other permissions_for methods.

Returns:

The resolved permissions.

Return type:

Permissions

get_partial_message(message_id, /)

Creates a PartialMessage from the message ID.

This is useful if you want to work with a message and only have its ID without doing an unnecessary API call.

Added in version 1.6.

Parameters:

message_id (int) – The message ID to create a partial message for.

Returns:

The partial message.

Return type:

PartialMessage

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

property jump_url

Returns a URL that allows the client to jump to the referenced messageable.

Added in version 2.0.

Type:

str

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

• 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.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

GroupChannel

Attributes

• created_at
• icon
• id
• jump_url
• me
• name
• owner
• owner_id
• recipients
• type

Methods

• asyncfetch_message
• asyncforward
• defhistory
• asyncleave
• defpermissions_for
• asyncpins
• asyncsend
• asynctrigger_typing
• deftyping

class nextcord.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.

Added in version 2.0.

Type:

int

name

The group channel’s name if provided.

Type:

Optional[str]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

This function returns an async iterator.

Returns an async iterator that enables receiving the destination’s message history.

You must have read_message_history permissions to use this.

Examples

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

All parameters are optional.

Parameters:

• limit (Optional[int]) – The number of messages to retrieve. If None, retrieves every message in the channel. Note, however, that this would make it a slow operation.

• before (Optional[Union[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.

Raises:

• Forbidden – You do not have permissions to get channel message history.

• HTTPException – The request to get message history failed.

Yields:

Message – The message with the message data parsed.

async with typing()

Returns a context manager that allows you to type for an indefinite period of time.

This is useful for denoting long computations in your bot.

Note

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')

property type

The channel’s Discord type.

Type:

ChannelType

property icon

Returns the channel’s icon asset if available.

Type:

Optional[Asset]

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

permissions_for(obj, /)

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.

Parameters:

obj (Snowflake) – The user to check permissions for.

Returns:

The resolved permissions for the user.

Return type:

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.

Raises:

HTTPException – Leaving the group failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameters:

id (int) – The message ID to look for.

Raises:

• NotFound – The specified message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The message asked for.

Return type:

Message

await forward(message)

Forward a message to this channel.

Parameters:

• message (Message) – The message to forward.

• note:: (..) – It is not possible to forward messages through interactions. It is only possible to forward a message to a channel as a message.

Raises:

• HTTPException – Forwarding/sending the message failed.

• Forbidden – You do not have the proper permissions to send the message.

• .. versionadded: – 3.0:

property jump_url

Returns a URL that allows the client to jump to the referenced messageable.

Added in version 2.0.

Type:

str

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Note

Due to a limitation with the Discord API, the Message objects returned by this method do not contain complete Message.reactions data.

Raises:

HTTPException – Retrieving the pinned messages failed.

Returns:

The messages that are currently pinned.

Return type:

List[Message]

await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, flags=None, suppress_embeds=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 or embeds 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.

Parameters:

• 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.

• file (File) – The file to upload.

• files (List[File]) – A list of files to upload. Must be a maximum of 10.

• nonce (Union[int, str]) – 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  Added in version 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.

  Added in version 1.6.

• mention_author (Optional[bool]) –

  If set, overrides the replied_user attribute of allowed_mentions.

  Added in version 1.6.

• view (nextcord.ui.View) – A Discord UI View to add to the message.

• embeds (List[Embed]) –

  A list of embeds to upload. Must be a maximum of 10.

  Added in version 2.0.

• stickers (Sequence[Union[GuildSticker, StickerItem]]) –

  A list of stickers to upload. Must be a maximum of 3.

  Added in version 2.0.

• flags (Optional[MessageFlags]) –

  The message flags being set for this message. Currently only suppress_embeds is able to be set.

  Added in version 2.4.

• suppress_embeds (Optional[bool]) –

  Whether to suppress embeds on this message.

  Added in version 2.4.

Raises:

• 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

Returns:

The message that was sent.

Return type:

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

ForumChannel

Attributes

• available_tags
• category
• category_id
• changed_roles
• created_at
• default_auto_archive_duration
• default_forum_layout
• default_reaction
• default_sort_order
• default_thread_slowmode_delay
• flags
• guild
• id
• jump_url
• last_message
• last_message_id
• members
• mention
• name
• nsfw
• overwrites
• permissions_synced
• position
• slowmode_delay
• threads
• topic
• type

Methods

• defarchived_threads
• asyncclone
• asynccreate_invite
• asynccreate_thread
• asynccreate_webhook
• asyncdelete
• asyncedit
• defget_tag
• defget_thread
• asyncinvites
• defis_nsfw
• asyncmove
• defoverwrites_for
• defpermissions_for
• asyncset_permissions
• asyncwebhooks

class nextcord.ForumChannel

Represents a Discord guild forum channel.

Added in version 2.1.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel’s hash.

str(x)

Returns the channel’s name.

id

The snowflake ID of this channel.

Type:

int

guild

The guild this channel belongs to.

Type:

Guild

name

The name of this channel.

Type:

str

category_id

The ID of the CategoryChannel this channel belongs to, if any.

Type:

Optional[int]

topic

The topic of this channel, if any. This is what is shown in the “Guidelines” section visually.

Type:

str

position

The position in the channel list, where the first channel is 0.

Type:

int

nsfw

If this channel is marked as NSFW.

Type:

bool

slowmode_delay

The delay in seconds which members must wait between sending messages.

Type:

int

flags

The flags that detail features of this channel.

Type:

ChannelFlags

default_auto_archive_duration

The archive duration which threads from this channel inherit by default.

Type:

int

last_message_id

The snowflake ID of the message starting the last thread in this channel.

Type:

int

default_sort_order

The default sort order type used to sort posts in forum channels.

Added in version 2.3.

Type:

SortOrderType

default_forum_layout

The default layout type used to display posts in this forum.

Added in version 2.4.

Type:

ForumLayoutType

default_thread_slowmode_delay

The default amount of seconds a user has to wait before creating another thread in this channel. This is set on every new thread in this channel.

Added in version 2.4.

Type:

int

default_reaction

The emoji that is used to add a reaction to every post in this forum.

Added in version 2.4.

Type:

Optional[PartialEmoji]

property type

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

• Timed-out members

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

• The default role permissions

• The permissions of the role used as a parameter

• The default role permission overwrites

• The permission overwrites of the role used as a parameter

Changed in version 2.3: Only view_channel and read_message_history can be returned for timed-out members

Changed in version 2.0: The object passed in can now be a role object.

Parameters:

obj (Union[Member, Role]) – The object to resolve permissions for. This could be either a member or a role. If it’s a role then member overwrites are not computed.

Returns:

The resolved permissions for the member or role.

Return type:

Permissions

property members

Returns all members that can see this channel.

Type:

List[Member]

property threads

Returns all the threads of this channel.

Type:

List[Thread]

is_nsfw()

bool: Checks if the channel is NSFW.

property last_message

Fetches the message that started the last thread 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.

Returns:

The message that started the last thread in this channel or None if not found.

Return type:

Optional[Message]

property available_tags

Returns all the tags available in this channel.

Added in version 2.4.

Type:

List[ForumTag]

get_tag(id, /)

Returns a tag from this channel by its ID.

Added in version 2.4.

Parameters:

id (int) – The ID of the tag to get from cache.

Returns:

The tag with the given ID or None if not found.

Return type:

Optional[ForumTag]

await edit(*, reason=None, **options)

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Parameters:

• 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.

• 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.

• flags (ChannelFlags) –

  The new channel flags.

  Added in version 2.1.

• default_sort_order (SortOrderType) –

  The default sort order type used to sort posts in forum channels.

  Added in version 2.3.

• default_forum_layout (ForumLayoutType) –

  The default layout type used to display posts in.

  Added in version 2.4.

• default_thread_slowmode_delay (int) –

  The new default slowmode delay for threads created in this channel. This is not retroactively applied to old posts. Must be between 0 and 21600.

  Added in version 2.4.

• available_tags (List[ForumTag]) –

  The new list of tags available in this channel.

  Added in version 2.4.

• default_reaction (Optional[Union[Emoji, PartialEmoji, str]]) –

  The new default reaction for threads created in this channel.

  Added in version 2.4.

Raises:

• 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.

Returns:

The newly edited forum channel.

Return type:

ForumChannel

get_thread(thread_id, /)

Returns a thread with the given ID.

Parameters:

thread_id (int) – The ID to search for.

Returns:

The returned thread or None if not found.

Return type:

Optional[Thread]

await create_thread(*, name, auto_archive_duration=..., slowmode_delay=0, content=None, embed=None, embeds=None, file=None, files=None, stickers=None, nonce=None, allowed_mentions=None, mention_author=None, view=None, reason=None, applied_tags=None, flags=None, suppress_embeds=None)

This function is a coroutine.

Creates a thread in this forum channel.

To create a public thread, you must have create_public_threads. For a private thread, create_private_threads is needed instead.

Parameters:

• 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.

• reason (str) – The reason for creating a new thread. Shows up on the audit log.

• content (Optional[str]) – The content of the message to send.

• embed (Optional[Embed]) – The rich embed for the content.

• embeds (Optional[List[Embed]]) – A list of rich embeds for the content.

• file (File) – The file to upload.

• files (Optional[List[File]]) – A list of files to upload. Must be a maximum of 10.

• nonce (Optional[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.

• allowed_mentions (Optional[AllowedMentions]) – Controls the mentions being processed in this message. If this is passed, then the object is merged with allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

• mention_author (Optional[bool]) – Whether to mention the author of the message being replied to. Defaults to True.

• view (Optional[View]) – The view to send with the message.

• stickers (Optional[Sequence[Union[GuildSticker, StickerItem]]]) – A list of stickers to send with the message.

• applied_tags (Optional[List[ForumTag]]) –

  A list of tags to apply to the thread.

  Added in version 2.4.

• flags (Optional[MessageFlags]) – The message flags being set for this message. Currently only suppress_embeds is able to be set. .. versionadded:: 2.4

• suppress_embeds (Optional[bool]) – Whether to suppress embeds on this message. .. versionadded:: 2.4

Raises:

• Forbidden – You do not have permissions to create a thread.

• HTTPException – Starting the thread failed.

• InvalidArgument – You cannot pass both embed and embeds parameters.

Returns:

The created thread.

Return type:

Thread

archived_threads(*, private=False, joined=False, limit=50, before=None)

This function returns an async iterator.

Returns an async iterator 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.

Parameters:

• 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. This defaults to False.

• note:: (..) – You cannot set joined to True and private to False.

Raises:

• Forbidden – You do not have permissions to get archived threads.

• HTTPException – The request to get the archived threads failed.

Yields:

Thread – The archived threads.

await create_webhook(*, name, avatar=None, reason=None)

This function is a coroutine.

Creates a webhook for this channel.

Requires manage_webhooks permissions.

Added in version 2.4.

Parameters:

• name (str) – The webhook’s name.

• avatar (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset 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.

Raises:

• HTTPException – Creating the webhook failed.

• Forbidden – You do not have permissions to create a webhook.

Returns:

The created webhook.

Return type:

Webhook

await webhooks()

This function is a coroutine.

Gets the list of webhooks from this channel.

Requires manage_webhooks permissions.

Added in version 3.0.

Raises:

Forbidden – You don’t have permissions to get the webhooks.

Returns:

The webhooks for this channel.

Return type:

List[Webhook]

property category

The category this channel belongs to.

If there is no category then this is None.

Type:

Optional[CategoryChannel]

property changed_roles

Returns a list of roles that have been overridden from their default values in the roles attribute.

Type:

List[Role]

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.

Added in version 1.1.

Parameters:

• name (Optional[str]) – The name of the new channel. If not provided, defaults to this channel name.

• reason (Optional[str]) – The reason for cloning this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have the proper permissions to create this channel.

• HTTPException – Creating the channel failed.

Returns:

The channel that was created.

Return type:

abc.GuildChannel

await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=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.

Parameters:

• max_age (int) – How long the invite should last in seconds. If it’s 0 then the invite doesn’t expire. Defaults to 0.

• max_uses (int) – How many uses the invite could be used for. If it’s 0 then there are unlimited uses. Defaults to 0.

• temporary (bool) – 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.

  Added in version 2.0.

• target_user (Optional[User]) –

  The user whose stream to display for this invite, required if target_type is InviteTarget.stream. The user must be streaming in the channel.

  Added in version 2.0.

• target_application_id: –

  Optional[int]: The id of the embedded application for the invite, required if target_type is InviteTarget.embedded_application.

  Added in version 2.0.

Raises:

• HTTPException – Invite creation failed.

• NotFound – The channel that was passed is a category or an invalid channel.

Returns:

The invite that was created.

Return type:

Invite

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameters:

reason (Optional[str]) – The reason for deleting this channel. Shows up on the audit log.

Raises:

• Forbidden – You do not have proper permissions to delete the channel.

• NotFound – The channel was not found or was already deleted.

• HTTPException – Deleting the channel failed.

await 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.

Raises:

• Forbidden – You do not have proper permissions to get the information.

• HTTPException – An error occurred while fetching the information.

Returns:

The list of invites that are currently active.

Return type:

List[Invite]

property jump_url

Returns a URL that allows the client to jump to this channel.

Added in version 2.0.

Type:

str

property mention

The string that allows you to mention the channel.

Type:

str

await move(*, beginning=None, end=None, before=None, after=None, offset=0, category=..., sync_permissions=False, reason=None)

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.

Note

Voice channels will always be sorted below text channels. This is a Discord limitation.

Added in version 1.7.

Changed in version 2.4: beginning, end, before, after and reason now accept None.

Parameters:

• beginning (Optional[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 (Optional[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 (Optional[Snowflake]) – The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

• after (Optional[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 (Optional[str]) – The reason for the move.

Raises:

• 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

Returns all of the channel’s overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Returns:

The channel’s permission overwrites.

Return type:

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameters:

obj (Union[Role, User]) – The role or user denoting whose overwrite to get.

Returns:

The permission overwrites for this object.

Return type:

PermissionOverwrite

property permissions_synced

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Added in version 1.3.

Type:

bool

await set_permissions(target, *, reason=None, **kwargs)

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.

Note

This method replaces the old overwrites with the ones given.

Examples

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)

Using PermissionOverwrite

overwrite = nextcord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)

Parameters:

• target (Union[Member, Role]) – The member or role to overwrite permissions for.

• overwrite (Optional[PermissionOverwrite]) – The permissions to allow and deny to the target, or None to delete the overwrite.

• **permissions – A keyword argument list of permissions to set for ease of use. Cannot be mixed with overwrite.

• reason (Optional[str]) – The reason for doing this action. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to edit channel specific permissions.

• HTTPException – Editing channel specific permissions failed.

• NotFound – The role or member being edited is not part of the guild.

• InvalidArgument – The overwrite parameter invalid or the target type was not Role or Member.

PartialInviteGuild

Attributes

• banner
• created_at
• description
• features
• icon
• id
• name
• splash
• verification_level

class nextcord.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

Returns the guild’s creation time in UTC.

Type:

datetime.datetime

property icon

Returns the guild’s icon asset, if available.

Type:

Optional[Asset]

property banner

Returns the guild’s banner asset, if available.

Type:

Optional[Asset]

property splash

Returns the guild’s invite splash asset, if available.

Type:

Optional[Asset]

PartialInviteChannel

Attributes

• created_at
• id
• mention
• name
• type

class nextcord.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

The string that allows you to mention the channel.

Type:

str

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

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
• type
• url
• uses

Methods

• asyncdelete

class nextcord.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.

Added in version 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.

Added in version 2.0.

Type:

InviteTarget

target_user

The user whose stream to display for this invite, if any.

Added in version 2.0.

Type:

Optional[User]

target_application

The embedded application the invite targets, if any.

Added in version 2.0.

Type:

Optional[PartialAppInfo]

type

The type of invite.

Added in version 3.0.

Type:

InviteType

property id

Returns the proper code portion of the invite.

Note

This may be None if it is the vanity invite the code is not set.

Type:

Optional[str]

property url

A property that retrieves the invite URL.

Note

This may be an empty string if it is the vanity URL and the code is not set

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.

Parameters:

reason (Optional[str]) – The reason for deleting this invite. Shows up on the audit log.

Raises:

• Forbidden – You do not have permissions to revoke invites.

• NotFound – The invite is invalid or expired.

• HTTPException – Revoking the invite failed.

Template

Attributes

• code
• created_at
• creator
• description
• is_dirty
• name
• source_guild
• updated_at
• url
• uses

Methods

• asynccreate_guild
• asyncdelete
• asyncedit
• asyncsync

class nextcord.Template

Represents a Discord template.

Added in version 1.4.

code

The template code.

Type:

str

uses

How many times the template has been used.

Type:

int

name

The name of the template.

Type:

str

description

The description of the template.

Type:

str

creator

The creator of the template.

Type:

User

created_at

An aware datetime in UTC representing when the template was created.

Type:

datetime.datetime

updated_at

An aware datetime in UTC representing when the template was last updated. This is referred to as “last synced” in the official Discord client.

Type:

datetime.datetime

source_guild

The source guild.

Type:

Guild

is_dirty

Whether the template has unsynced changes.

Added in version 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.

Changed in version 2.1: The icon parameter now accepts File, Attachment, and Asset.

Parameters:

• name (str) – The name of the guild.

• region (VoiceRegion) – The region for the voice communication server. Defaults to VoiceRegion.us_west.

• icon (Optional[Union[bytes, Asset, Attachment, File]]) – The bytes-like object, File, Attachment, or Asset representing the icon. See ClientUser.edit() for more details on what is expected.

Raises:

• HTTPException – Guild creation failed.

• InvalidArgument – Invalid icon image format given. Must be PNG or JPG.

Returns:

The guild created. This is not the same guild that is added to cache.

Return type:

Guild

await sync()

This function is a coroutine.

Sync the template to the guild’s current state.

You must have the manage_guild permission in the source guild to do this.

Added in version 1.7.

Changed in version 2.0: The template is no longer edited in-place, instead it is returned.

Raises:

• HTTPException – Editing the template failed.

• Forbidden – You don’t have permissions to edit the template.

• NotFound – This template does not exist.

Returns:

The newly edited template.

Return type:

Template

await edit(*, name=..., description=...)

This function is a coroutine.

Edit the template metadata.

You must have the manage_guild permission in the source guild to do this.

Added in version 1.7.

Changed in version 2.0: The template is no longer edited in-place, instead it is returned.

Parameters:

• name (str) – The template’s new name.

• description (Optional[str]) – The template’s new description.

Raises:

• HTTPException – Editing the template failed.

• Forbidden – You don’t have permissions to edit the template.

• NotFound – This template does not exist.

Returns:

The newly edited template.

Return type:

Template

await delete()

This function is a coroutine.

Delete the template.

You must have the manage_guild permission in the source guild to do this.

Added in version 1.7.

Raises:

• HTTPException – Editing the template failed.

• Forbidden – You don’t have permissions to edit the template.

• NotFound – This template does not exist.

property url

The template url.

Added in version 2.0.

Type:

str

WidgetChannel

Attributes

• created_at
• id
• mention
• name
• position

class nextcord.WidgetChannel

Represents a “partial” widget channel.

x == y

Checks if two partial channels are the same.

x != y

Checks if two partial channels are not the same.

hash(x)

Return the partial channel’s hash.

str(x)

Returns the partial channel’s name.

id

The channel’s ID.

Type:

int

name

The channel’s name.

Type:

str

position

The channel’s position

Type:

int

property mention

The string that allows you to mention the channel.

Type:

str

property created_at

Returns the channel’s creation time in UTC.

Type:

datetime.datetime

WidgetMember

Attributes

• accent_color
• accent_colour
• activity
• avatar
• avatar_decoration
• banner
• bot
• color
• colour
• connected_channel
• created_at
• deafened
• default_avatar
• discriminator
• display_avatar
• display_name
• id
• mention
• muted
• name
• nick
• public_flags
• status
• suppress

Methods

• defmentioned_in

class nextcord.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

Returns the user’s display name.

This will return the name using the following hierarchy:

1. Guild specific nickname

2. Global Name (also known as ‘Display Name’ in the Discord UI)

3. Unique username

Type:

str

property accent_color

Returns the user’s accent color, if applicable.

There is an alias for this named accent_colour.

Added in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Colour]

property accent_colour

Returns the user’s accent colour, if applicable.

There is an alias for this named accent_color.

Added in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Colour]

property avatar_decoration

Returns the user’s avatar decoration, if applicable.

You can get the asset of the avatar decoration via AvatarDecoration.asset.

Added in version 3.2.

Type:

Optional[AvatarDecoration]

property banner

Returns the user’s banner asset, if available.

Added in version 2.0.

Note

This information is only available via Client.fetch_user().

Type:

Optional[Asset]

property color

A property that returns a color denoting the rendered color for the user. This always returns Colour.default().

There is an alias for this named colour.

Type:

Colour

property colour

A property that returns a colour denoting the rendered colour for the user. This always returns Colour.default().

There is an alias for this named color.

Type:

Colour

property created_at

Returns the user’s creation time in UTC.

This is when the user’s Discord account was created.

Type:

datetime.datetime

property default_avatar

Returns the default avatar for a given user.

This is calculated by the user’s discriminator.

..versionchanged:: 2.6

Added handling for the new username system for users without a discriminator.

Type:

Asset

property display_avatar

Returns the user’s display avatar.

For regular users this is just their default avatar or uploaded avatar.

Added in version 2.0.

Type:

Asset

property mention

Returns a string that allows you to mention the given user.

Type:

str

mentioned_in(message)

Checks if the user is mentioned in the specified message.

Parameters:

message (Message) – The message to check if you’re mentioned in.

Returns:

Indicates if the user is mentioned in the message.

Return type:

bool

property public_flags

The publicly available flags the user has.

Type:

PublicUserFlags

Widget

Attributes

• channels
• created_at
• id
• invite_url
• json_url
• members
• name

Methods

• asyncfetch_invite

class nextcord.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.

Note

Due to a Discord limitation, if this data is available the users will be “anonymized” with linear IDs and discriminator information being incorrect. Likewise, the number of members retrieved is capped.

Type:

List[Member]

property created_at

Returns the member’s creation time in UTC.

Type:

datetime.datetime

property json_url

The JSON URL of the widget.

Type:

str

property invite_url

The invite URL for the guild, if available.

Type:

Optional[str]

await fetch_invite(*, with_counts=True)

This function is a coroutine.

Retrieves an Invite from the widget’s invite URL. This is the same as Client.fetch_invite(); the invite code is abstracted away.

Parameters:

with_counts (bool) – Whether to include count information in the invite. This fills the Invite.approximate_member_count and Invite.approximate_presence_count fields.

Returns:

The invite from the widget’s invite URL.

Return type:

Invite

StickerPack

Attributes

• banner
• cover_sticker
• cover_sticker_id
• description
• id
• name
• sku_id
• stickers

class nextcord.StickerPack

Represents a sticker pack.

Added in version 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

The banner asset of the sticker pack.

Type:

Asset

StickerItem

Attributes

• format
• id
• name
• url

Methods

• asyncfetch

class nextcord.StickerItem

Represents a sticker item.

Added in version 2.0.

str(x)

Returns the name of the sticker item.

x == y

Checks if the sticker item is equal to another sticker item.

x != y

Checks if the sticker item is not equal to another sticker item.

name

The sticker’s name.

Type:

str

id

The id of the sticker.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

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.

Raises:

HTTPException – Retrieving the sticker failed.

Returns:

The retrieved sticker.

Return type:

Union[StandardSticker, GuildSticker]

Sticker

Attributes

• created_at
• description
• format
• id
• name
• pack_id
• url

class nextcord.Sticker

Represents a sticker.

Added in version 1.6.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The id of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

pack_id

The id of the sticker’s pack.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

url

The URL for the sticker’s image.

Type:

str

property created_at

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 nextcord.StandardSticker

Represents a sticker that is found in a standard sticker pack.

Added in version 2.0.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The id of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

pack_id

The id of the sticker’s pack.

Type:

int

format

The format for the sticker’s image.

Type:

StickerFormatType

tags

A list of tags for the sticker.

Type:

List[str]

sort_value

The sticker’s sort order within its pack.

Type:

int

await pack()

This function is a coroutine.

Retrieves the sticker pack that this sticker belongs to.

Raises:

• InvalidData – The corresponding sticker pack was not found.

• HTTPException – Retrieving the sticker pack failed.

Returns:

The retrieved sticker pack.

Return type:

StickerPack

GuildSticker

Attributes

• available
• description
• emoji
• format
• guild
• guild_id
• id
• name
• user

Methods

• asyncdelete
• asyncedit

class nextcord.GuildSticker

Represents a sticker that belongs to a guild.

Added in version 2.0.

str(x)

Returns the name of the sticker.

x == y

Checks if the sticker is equal to another sticker.

x != y

Checks if the sticker is not equal to another sticker.

name

The sticker’s name.

Type:

str

id

The id of the sticker.

Type:

int

description

The description of the sticker.

Type:

str

format

The format for the sticker’s image.

Type:

StickerFormatType

available

Whether this sticker is available for use.

Type:

bool

guild_id

The ID of the guild that this sticker is from.

Type:

int

user

The user that created this sticker. This can only be retrieved using Guild.fetch_sticker() 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.

Added in version 2.0.

Type:

Optional[Guild]

await edit(*, name=..., description=..., emoji=..., reason=None)

This function is a coroutine.

Edits a GuildSticker for the guild.

Parameters:

• name (str) – The sticker’s new name. Must be at least 2 characters.

• description (Optional[str]) – The sticker’s new description. Can be None.

• emoji (str) – The name of a unicode emoji that represents the sticker’s expression.

• reason (str) – The reason for editing this sticker. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to edit stickers.

• HTTPException – An error occurred editing the sticker.

Returns:

The newly modified sticker.

Return type:

GuildSticker

await delete(*, reason=None)

This function is a coroutine.

Deletes the custom Sticker from the guild.

You must have manage_emojis_and_stickers permission to do this.

Parameters:

reason (Optional[str]) – The reason for deleting this sticker. Shows up on the audit log.

Raises:

• Forbidden – You are not allowed to delete stickers.

• HTTPException – An error occurred deleting the sticker.

RawTypingEvent

Attributes

• channel_id
• guild_id
• member
• user_id
• when

class nextcord.RawTypingEvent

Represents the payload for a on_raw_typing() event.

Added in version 2.0.

channel_id

The channel ID where the typing originated from.

Type:

int

user_id

The ID of the user that started typing.

Type:

int

when

When the typing started as an aware datetime in UTC.

Type:

datetime.datetime

guild_id

The guild ID where the typing originated from, if applicable.

Type:

Optional[int]

member

The member who started typing. Only available if the member started typing in a guild.

Type:

Optional[Member]

RawMessageDeleteEvent

Attributes

• cached_message
• channel_id
• guild_id
• message_id

class nextcord.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 nextcord.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 nextcord.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.

Added in version 1.3.

Type:

int

guild_id

The guild ID where the message got updated, if applicable.

Added in version 1.7.

Type:

Optional[int]

data

The raw data given by the gateway

Type:

dict

cached_message

The cached message, if found in the internal message cache. Represents the message before it is modified by the data in RawMessageUpdateEvent.data.

Type:

Optional[Message]

RawReactionActionEvent

Attributes

• channel_id
• emoji
• event_type
• guild_id
• member
• message_id
• user_id

class nextcord.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.

Added in version 1.3.

Type:

Optional[Member]

event_type

The event type that triggered this action. Can be REACTION_ADD for reaction addition or REACTION_REMOVE for reaction removal.

Added in version 1.3.

Type:

str

RawReactionClearEvent

Attributes

• channel_id
• guild_id
• message_id

class nextcord.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 nextcord.RawReactionClearEmojiEvent

Represents the payload for a on_raw_reaction_clear_emoji() event.

Added in version 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

RawIntegrationDeleteEvent

Attributes

• application_id
• guild_id
• integration_id

class nextcord.RawIntegrationDeleteEvent

Represents the payload for a on_raw_integration_delete() event.

Added in version 2.0.

integration_id

The ID of the integration that got deleted.

Type:

int

application_id

The ID of the bot/OAuth2 application for this deleted integration.

Type:

Optional[int]

guild_id

The guild ID where the integration got deleted.

Type:

int

PartialWebhookGuild

Attributes

• icon
• id
• name

class nextcord.PartialWebhookGuild

Represents a partial guild for webhooks.

These are typically given for channel follower webhooks.

Added in version 2.0.

id

The partial guild’s ID.

Type:

int

name

The partial guild’s name.

Type:

str

property icon

Returns the guild’s icon asset, if available.

Type:

Optional[Asset]

PartialWebhookChannel

Attributes

• id
• name

class nextcord.PartialWebhookChannel

Represents a partial channel for webhooks.

These are typically given for channel follower webhooks.

Added in version 2.0.

id

The partial channel’s ID.

Type:

int

name

The partial channel’s name.

Type:

str

ScheduledEvent

Attributes

• channel
• channel_id
• creator
• description
• end_time
• guild
• id
• image
• location
• metadata
• name
• privacy_level
• start_time
• user_count
• users

Methods

• asyncdelete
• asyncedit
• deffetch_users
• defget_user

class nextcord.ScheduledEvent

Represents a Discord scheduled event

Added in version 2.0.

x == y

Checks if two events are equal.

x != y

Checks if two events are not equal.

hash(x)

Returns the event’s hash.

str(x)

Returns the event’s name.

channel

The channel the event will take place, if any.

Type:

Optional[abc.GuildChannel]

channel_id

The channel id where the event will take place, if any.

Type:

Optional[int]

creator

The user who created the event, if cached.

Type:

Optional[User]

description

The description of the event.

Type:

str

end_time

The scheduled end time for the event, if set.

Type:

datetime.datetime

guild

The guild the event will be in.

Type:

Guild

id

The snowflake id for the event.

Type:

int

metadata

The metadata for the event, if any.

Type:

Optional[EntityMetadata]

name

The name of the event.

Type:

str

privacy_level

The privacy level for the event.

Type:

ScheduledEventPrivacyLevel

start_time

The scheduled start time for the event.

Type:

datetime.datetime

user_count

An approximate count of the ‘interested’ users.

Type:

int

image

The event cover image.

Type:

Asset

property location

The location of the event, if any.

Type:

Optional[str]

property users

The users who are interested in the event.

Note

This may not be accurate or populated until fetch_users() is called

Type:

List[ScheduledEventUser]

await delete()

This function is a coroutine.

Delete the scheduled event.

await edit(*, channel=..., metadata=..., name=..., privacy_level=..., start_time=..., end_time=..., description=..., type=..., status=..., reason=None, image=...)

This function is a coroutine.

Edit the scheduled event.

Changed in version 2.1: The image parameter now accepts File, Attachment, and Asset.

Parameters:

• channel (abc.GuildChannel) – The new channel for the event.

• metadata (EntityMetadata) – The new metadata for the event.

• name (str) – The new name for the event.

• privacy_level (ScheduledEventPrivacyLevel) – The new privacy level for the event.

• start_time (datetime.datetime) – The new scheduled start time.

• end_time (datetime.datetime) – The new scheduled end time.

• description (str) – The new description for the event.

• type (ScheduledEventEntityType) – The new type for the event.

• status (ScheduledEventStatus) – The new status for the event.

• reason (Optional[str]) –

  The reason for editing this scheduled event. Shows up in the audit logs.

  Note

  Only the following edits to an event’s status are permitted: scheduled -> active ; active -> completed ; scheduled -> canceled

• image (Optional[Union[bytes, Asset, Attachment, File]]) – A bytes-like object, File, Attachment, or Asset representing the cover image. Could be None to denote removal of the cover image.

Returns:

The updated event object.

Return type:

ScheduledEvent

get_user(user_id)

Get a user that is interested.

Note

This may not be accurate or populated until ScheduledEvent.fetch_users() is called.

Parameters:

user_id (int) – The user id to get from cache.

Returns:

The user object, if found.

Return type:

Optional[ScheduledEventUser]

fetch_users(*, limit=100, with_member=False, before=None, after=None)

This function returns an async iterator.

Fetch the users that are interested, returns an async iterator.

Parameters:

• limit (int) – Amount of users to fetch, by default 100

• with_member (bool) – If the user objects should contain members too, by default False

• before (Optional[int]) – A snowflake id to start with, useful for chunks of users, by default None

• after (Optional[int]) – A snowflake id to end with, useful for chunks of usersby default None

Yields:

ScheduledEventUser – A full event user object

Attributes

• event
• member
• user
• user_id

class nextcord.ScheduledEventUser

Represents a user in a scheduled event

event

The event the user is interested in.

Type:

ScheduledEvent

user

The related user object. Blank if no member intents

Type:

Optional[User]

member

The related member object, if requested with ScheduledEvent.fetch_users().

Type:

Optional[Member]

user_id

The id of the interested user

Type:

int

Warning

user or member may be None, this may occur if you don’t have Intents.members enabled.

class nextcord.EntityMetadata(*, location=None, **kwargs)

Represents the metadata for an event

Parameters:

location (Optional[str]) – The location of the event, defaults to None

AutoModerationRule

Attributes

• actions
• creator
• creator_id
• enabled
• event_type
• exempt_channel_ids
• exempt_channels
• exempt_role_ids
• exempt_roles
• guild
• guild_id
• id
• name
• trigger_metadata
• trigger_type

Methods

• asyncdelete
• asyncedit

class nextcord.AutoModerationRule

Represents a Discord auto moderation rule.

Added in version 2.1.

x == y

Checks if two rules are equal.

x != y

Checks if two rules are not equal.

hash(x)

Returns the rules’s hash.

str(x)

Returns the rules’s name.

id

The rule’s unique ID.

Type:

int

guild_id

The guild’s unique ID which this rule belongs to.

Type:

int

guild

The guild which this rule belongs to, if found in cache.

Type:

Optional[Guild]

name

The rule’s name.

Type:

str

creator_id

The user’s unique ID which first created this rule.

Type:

int

creator

The member which first created this rule, if found in cache.

Type:

Optional[Member]

event_type

The event context in which this rule is checked.

Type:

AutoModerationEventType

trigger_type

The type of content that can trigger this rule.

Type:

AutoModerationTriggerType

trigger_metadata

Additional data that is used when checking if this rule is triggered.

Type:

AutoModerationTriggerMetadata

actions

The actions which will execute when the rule is triggered.

Type:

List[AutoModerationAction]

enabled

Whether the rule is enabled.

Type:

bool

exempt_role_ids

The role ids that should not be affected by the rule.

Type:

List[int]

exempt_channel_ids

The channel ids that should not be affected by the rule.

Type:

List[int]

exempt_roles

The roles that should not be affected by the rule, if found in cache.

Type:

List[Role]

exempt_channels

The channels that should not be affected by the rule, if found in cache.

Type:

List[abc.GuildChannel]

await delete(*, reason=None)

This function is a coroutine.

Delete the current rule from its guild.

Requires the manage_guild permission.

Parameters:

reason (Optional[str]) – The reason for deleting this rule. Shows up on the audit log.

Raises:

• Forbidden – You do not have permission to delete this rule.

• HTTPException – Deleting the rule failed.

await edit(*, name=..., event_type=..., trigger_metadata=..., actions=..., enabled=..., exempt_roles=..., exempt_channels=..., reason=None)

Modify the current auto moderation rule.

Requires the manage_guild permission.

Parameters:

• name (str) – The new name for this rule.

• event_type (AutoModerationEventType) – The new event context in which this rule is checked.

• trigger_metadata (AutoModerationTriggerMetadata) – The new additional data that is used when checking if this rule is triggered.

• actions (List[AutoModerationAction]) – The new actions which will execute when the rule is triggered.

• enabled (bool) – Whether the rule is enabled.

• exempt_roles (List[abc.Snowflake]) – The new roles that should not be affected by the rule.

• exempt_channels (List[abc.Snowflake]) – The new channels that should not be affected by the rule.

• reason (Optional[str]) – The reason for editing this rule. Shows in the audit log.

Raises:

• Forbidden – You do not have permission to edit this rule.

• HTTPException – Editing the rule failed.

• InvalidArgument – An incorrect type was passed.

Returns:

The newly edited auto moderation rule.

Return type:

AutoModerationRule

AutoModerationActionExecution

Attributes

• action
• alert_system_message
• alert_system_message_id
• channel
• channel_id
• content
• guild
• guild_id
• matched_content
• matched_keyword
• member
• member_id
• message
• message_id
• rule_id
• rule_trigger_type

class nextcord.AutoModerationActionExecution

Represents the execution of an auto moderation action

Added in version 2.1.

guild_id

The guild ID where this action was executed.

Type:

int

guild

The guild where this action was executed, if it was found in cache.

Type:

Optional[Guild]

channel_id

The channel ID where this action was executed, if applicable.

Type:

Optional[int]

channel

The channel where this action was executed, if applicable and found in cache.

Type:

Optional[abc.GuildChannel]

message_id

The message ID that executed this action, if it was not blocked.

Type:

Optional[int]

message

The message that executed this action, if it was not blocked and found in cache.

Type:

Optional[Message]

alert_system_message_id

The ID of the system alert message, if sent.

Type:

Optional[int]

alert_system_message

The system alert message, if sent and found in cache.

Type:

Optional[Message]

action

The action that was executed.

Type:

AutoModerationAction

rule_id

The id of the rule that was executed.

Type:

int

rule_trigger_type

The type of rule that was executed.

Type:

AutoModerationTriggerType

member_id

The ID of the user that triggered this action.

Type:

int

member

The member that triggered this action, if found in cache.

Type:

Optional[Member]

content

The content the user sent in the message

Note

This requires Intents.message_content to not be empty.

Type:

str

matched_keyword

The keyword configured in the rule that matched this message, if applicable.

Type:

Optional[str]

matched_content

The content in the message that matched the keyword, if applicable.

Note

This requires Intents.message_content to not be empty.

Type:

Optional[str]

MessageRoleSubscription

Attributes

• is_renewal
• role_subscription_listing_id
• tier_name
• total_months_subscribed

class nextcord.MessageRoleSubscription

Represents a message’s role subscription information.

This is accessed through the Message.role_subscription attribute if the Message.type is MessageType.role_subscription_purchase.

Added in version 3.2.

role_subscription_listing_id

The ID of the SKU and listing that the user is subscribed to.

Type:

int

tier_name

The name of the tier that the user is subscribed to.

Type:

str

total_months_subscribed

The cumulative number of months that the user has been subscribed for.

Type:

int

is_renewal

Whether this notification is for a renewal rather than a new purchase.

Type:

bool

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 nextcord.Object(id)

Represents a generic Discord object.

The purpose of this class is to allow you to create ‘miniature’ versions of data classes if you want to pass in just an ID. Most functions that take in a specific data class with an ID can also take in this class as a substitute instead. Note that even though this is the case, not all objects (if any) actually inherit from this class.

There are also some cases where some websocket events are received in strange order and when such events happened you would receive this class rather than the actual data class. These cases are extremely rare.

x == y

Checks if two objects are equal.

x != y

Checks if two objects are not equal.

hash(x)

Returns the object’s hash.

id

The ID of the object.

Type:

int

property created_at

Returns the snowflake’s creation time in UTC.

Type:

datetime.datetime

Embed

Attributes

• author
• colour
• description
• fields
• footer
• image
• provider
• thumbnail
• timestamp
• title
• type
• url
• video

Methods

• clsEmbed.from_dict
• 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 nextcord.Embed(*, colour=None, color=None, title=None, type='rich', url=None, description=None, 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.

Added in version 2.0.

Certain properties return an EmbedProxy, a type that acts similar to a regular dict except using dotted access, e.g. embed.author.icon_url. If the attribute is invalid or empty, then None is returned.

For ease of use, all parameters that expect a str are implicitly casted to str for you.

Changed in version 2.2: Embed.Empty is now an alias for None for a non-breaking change, every field uses None and is typed as Optional[...] over Embed.Empty. This also means that you can no longer use len() on an empty field.

Changed in version 3.0: Embed.Empty has been removed in favor of None.

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 discord’s api docs

Type:

str

description

The description of the embed. This can be set during initialisation.

Type:

str

url

The hyperlink of the embed title. This can be set during initialisation. This makes no effect if there is no title field.

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]

classmethod from_dict(data)

Converts a dict to a Embed provided it is in the format that Discord expects it to be in.

You can find out about this format in the official Discord documentation.

Parameters:

data (dict) – The dictionary to convert into an embed.

copy()

Returns a shallow copy of the embed.

property footer

Returns an EmbedProxy denoting the footer contents.

See set_footer() for possible values you can access.

If the attribute has no value then None is returned.

set_footer(*, text=None, icon_url=None)

Sets the footer for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

• text (Optional[str]) – The footer text.

• icon_url (Optional[str]) – The URL of the footer icon. Only HTTP(S) is supported.

remove_footer()

Clears embed’s footer information.

This function returns the class instance to allow for fluent-style chaining.

Added in version 2.0.

property image

Returns an EmbedProxy denoting the image contents.

Possible attributes you can access are:

• url

• proxy_url

• width

• height

If the attribute has no value then None is returned.

set_image(url)

Sets the image for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Changed in version 1.4: Passing None removes the image.

Parameters:

url (Optional[str]) – The source URL for the image. Only HTTP(S) is supported.

property thumbnail

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 None is returned.

set_thumbnail(url)

Sets the thumbnail for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Changed in version 1.4: Passing None removes the thumbnail.

Parameters:

url (Optional[str]) – The source URL for the thumbnail. Only HTTP(S) is supported.

property video

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 None is returned.

property provider

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 None is returned.

property author

Returns an EmbedProxy denoting the author contents.

See set_author() for possible values you can access.

If the attribute has no value then None is returned.

set_author(*, name, url=None, icon_url=None)

Sets the author for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

• name (Optional[str]) – The name of the author.

• url (Optional[str]) – The URL for the author.

• icon_url (Optional[str]) – The URL of the author icon. Only HTTP(S) is supported.

remove_author()

Clears embed’s author information.

This function returns the class instance to allow for fluent-style chaining.

Added in version 1.4.

property fields

Returns a list of EmbedProxy denoting the field contents.

See add_field() for possible values you can access.

If the attribute has no value then None is returned.

Type:

List[Optional[EmbedProxy]]

add_field(*, name, value, inline=True)

Adds a field to the embed object.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

• name (str) – The name of the field.

• value (str) – The value of the field.

• inline (bool) – Whether the field should be displayed inline. Defaults to True.

insert_field_at(index, *, name, value, inline=True)

Inserts a field before a specified index to the embed.

This function returns the class instance to allow for fluent-style chaining.

Added in version 1.2.

Parameters:

• index (int) – The index of where to insert the field.

• name (str) – The name of the field.

• value (str) – The value of the field.

• inline (bool) – Whether the field should be displayed inline. Defaults to True.

clear_fields()

Removes all fields from this embed.

This function returns the class instance to allow for fluent-style chaining.

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.

This function returns the class instance to allow for fluent-style chaining.

Note

When deleting a field by index, the index of the other fields shift to fill the gap just like a regular list.

Parameters:

index (int) – The index of the field to remove.

set_field_at(index, *, name, value, inline=True)

Modifies a field to the embed object.

The index must point to a valid pre-existing field.

This function returns the class instance to allow for fluent-style chaining.

Parameters:

• index (int) – The index of the field to modify.

• name (str) – The name of the field.

• value (str) – The value of the field.

• inline (bool) – Whether the field should be displayed inline.

Raises:

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 nextcord.AllowedMentions(*, everyone=None, users=None, roles=None, replied_user=None)

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.

Added in version 1.6.

Type:

bool

classmethod all()

A factory method that returns a AllowedMentions with all fields explicitly set to True

Added in version 1.5.

classmethod none()

A factory method that returns a AllowedMentions with all fields set to False

Added in version 1.5.

MessageReference

Attributes

• cached_message
• channel_id
• fail_if_not_exists
• guild_id
• jump_url
• message_id
• resolved
• type

Methods

• clsMessageReference.from_message

class nextcord.MessageReference(*, message_id, channel_id, type=MessageReferenceType.default, guild_id=None, fail_if_not_exists=True)

Represents a reference to a Message.

Added in version 1.5.

Changed in version 1.6: This class can now be constructed by users.

message_id

The id of the message referenced.

Type:

Optional[int]

channel_id

The channel id of the message referenced.

Type:

int

guild_id

The guild id of the message referenced.

Type:

Optional[int]

fail_if_not_exists

Whether replying to the referenced message should raise HTTPException if the message no longer exists or Discord could not fetch the message.

Added in version 1.7.

Type:

bool

resolved

The message that this reference resolved to. If this is None then the original message was not fetched either due to the Discord API not attempting to resolve it or it not being available at the time of creation. If the message was resolved at a prior point but has since been deleted then this will be of type DeletedReferencedMessage.

Currently, this is mainly the replied to message when a user replies to a message.

Added in version 1.6.

Type:

Optional[Union[Message, DeletedReferencedMessage]]

type

The type of reference that the message is. Defaults to a reply.

Added in version 3.0.

Type:

MessageReferenceType

classmethod from_message(message, *, type=MessageReferenceType.default, fail_if_not_exists=True)

Creates a MessageReference from an existing Message.

Added in version 1.6.

Parameters:

• message (Message) – The message to be converted into a reference.

• type (MessageReferenceType) –

  The type of reference that the message is. Defaults to the reply type if not provided.

  Added in version 3.0.

• 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.

  Added in version 1.7.

Returns:

A reference to the message.

Return type:

MessageReference

property cached_message

The cached message, if found in the internal message cache.

Type:

Optional[Message]

property jump_url

Returns a URL that allows the client to jump to the referenced message.

Added in version 1.7.

Type:

str

MessageSnapshot

Attributes

• attachments
• components
• content
• edited_timestamp
• embeds
• flags
• mention_roles
• mentions
• sticker_items
• timestamp
• type

class nextcord.MessageSnapshot(*, data, state)

Represents a message reference snapshot.

Added in version 3.0.

type

The type of message.

Type:

MessageType

content

The message’s content.

Type:

str

embeds

The embeds the message contains.

Type:

List[Embed]

attachments

The attachments the message contains.

Type:

List[Attachment]

timestamp

The timestamp when the message was sent.

Type:

datetime.datetime

edited_timestamp

The timestamp when the message was last edited. Returns None if it has not been edited.

Type:

Optional[datetime.datetime]

flags

The message’s flags.

Type:

MessageFlags

mentions

A list of users that the message has mentioned.

Type:

List[User]

mention_roles

A list of role IDs that the message has mentioned.

Type:

List[Object]

sticker_items

A list of stickers packs that the message contains.

Type:

List[StickerItem]

components

A list of components that the message contains.

Type:

List[Component]

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 nextcord.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.

Added in version 1.6.

x == y

Checks if two partial messages are equal.

x != y

Checks if two partial messages are not equal.

hash(x)

Returns the partial message’s hash.

channel

The channel associated with this partial message.

Type:

Union[TextChannel, Thread, DMChannel]

id

The message ID.

Type:

int

property jump_url

Returns a URL that allows the client to jump to this message.

Type:

str

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Your own messages could be deleted without any proper permissions. However to delete other people’s messages, you need the manage_messages permission.

Changed in version 1.1: Added the new delay keyword-only parameter.

Parameters:

delay (Optional[float]) – If provided, the number of seconds to wait in the background before deleting the message. If the deletion fails then it is silently ignored.

Raises:

• Forbidden – You do not have proper permissions to delete the message.

• NotFound – The message was deleted already

• HTTPException – Deleting the message failed.

await publish()

This function is a coroutine.

Publishes this message to your announcement channel.

You must have the send_messages permission to do this.

If the message is not your own then the manage_messages permission is also needed.

Raises:

• Forbidden – You do not have the proper permissions to publish this message.

• HTTPException – Publishing the message failed.

await pin(*, reason=None)

This function is a coroutine.

Pins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

The reason for pinning the message. Shows up on the audit log.

Added in version 1.4.

Raises:

• Forbidden – You do not have permissions to pin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Pinning the message failed, probably due to the channel having more than 50 pinned messages.

await unpin(*, reason=None)

This function is a coroutine.

Unpins the message.

You must have the manage_messages permission to do this in a non-private channel context.

Parameters:

reason (Optional[str]) –

The reason for unpinning the message. Shows up on the audit log.

Added in version 1.4.

Raises:

• Forbidden – You do not have permissions to unpin the message.

• NotFound – The message or channel was not found or deleted.

• HTTPException – Unpinning the message failed.

await add_reaction(emoji)

This function is a coroutine.

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.

Parameters:

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to react with.

Raises:

• HTTPException – Adding the reaction failed.

• Forbidden – You do not have the proper permissions to react to the message.

• NotFound – The emoji you specified was not found.

• 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.

Parameters:

• emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to remove.

• member (abc.Snowflake) – The member for which to remove the reaction.

Raises:

• HTTPException – Removing the reaction failed.

• Forbidden – You do not have the proper permissions to remove the reaction.

• NotFound – The member or emoji you specified was not found.

• 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.

Added in version 1.3.

Parameters:

emoji (Union[Emoji, Reaction, PartialEmoji, str]) – The emoji to clear.

Raises:

• HTTPException – Clearing the reaction failed.

• Forbidden – You do not have the proper permissions to clear the reaction.

• NotFound – The emoji you specified was not found.

• 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.

Raises:

• 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.

Added in version 1.6.

Raises:

• 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.

Returns:

The message that was sent.

Return type:

Message

to_reference(*, fail_if_not_exists=True)

Creates a MessageReference from the current message.

Added in version 1.6.

Parameters:

fail_if_not_exists (bool) –

Whether replying using the message reference should raise HTTPException if the message no longer exists or Discord could not fetch the message.

Added in version 1.7.

Returns:

The reference to this message.

Return type:

MessageReference

property created_at

The partial message’s creation time in UTC.

Type:

datetime.datetime

guild

The guild that the partial message belongs to, if applicable.

Type:

Optional[Guild]

await fetch()

This function is a coroutine.

Fetches the partial message to a full Message.

Raises:

• NotFound – The message was not found.

• Forbidden – You do not have the permissions required to get a message.

• HTTPException – Retrieving the message failed.

Returns:

The full message.

Return type:

Message

await edit(**fields)

This function is a coroutine.

Edits the message.

The content must be able to be transformed into a string via str(content).

Changed in version 1.7: nextcord.Message is returned instead of None if an edit took place.

Parameters:

• content (Optional[str]) – The new content to replace the message with. Could be None to remove the content.

• embed (Optional[Embed]) – The new embed to replace the original with. Could be None to remove the embed.

• embeds (List[Embed]) –

  The new embeds to replace the original with. Must be a maximum of 10. To remove all embeds [] should be passed.

  Added in version 2.0.

• 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 allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

• view (Optional[View]) –

  The updated view to update this message with. If None is passed then the view is removed.

  Added in version 2.0.

Raises:

• 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.

Returns:

The message that was edited.

Return type:

Optional[Message]

Intents

Attributes

• auto_moderation
• auto_moderation_configuration
• auto_moderation_execution
• bans
• dm_messages
• dm_reactions
• dm_typing
• emojis
• emojis_and_stickers
• guild_messages
• guild_reactions
• guild_typing
• guilds
• integrations
• invites
• members
• message_content
• messages
• moderation
• presences
• reactions
• scheduled_events
• typing
• value
• voice_states
• webhooks

Methods

• clsIntents.all
• clsIntents.default
• clsIntents.none

class nextcord.Intents(**kwargs)

Wraps up a Discord gateway intent flag.

Similar to Permissions, the properties provided are two way. You can set and retrieve individual bits using the properties as if they were regular bools.

To construct an object you can pass keyword arguments denoting the flags to enable or disable.

This is used to disable certain gateway features that are unnecessary to run your bot. To make use of this, it is passed to the intents keyword argument of Client.

Added in version 1.5.

x == y

Checks if two flags are equal.

x != y

Checks if two flags are not equal.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

classmethod all()

A factory method that creates a Intents with everything enabled.

classmethod none()

A factory method that creates a Intents with everything disabled.

classmethod default()

A factory method that creates a Intents with everything enabled except presences, members, and message_content.

guilds

Whether guild related events are enabled.

This corresponds to the following events:

• on_guild_join()

• on_guild_remove()

• on_guild_available()

• on_guild_unavailable()

• on_guild_channel_update()

• on_guild_channel_create()

• on_guild_channel_delete()

• on_guild_channel_pins_update()

This also corresponds to the following attributes and classes in terms of cache:

• Client.guilds

• Guild and all its attributes.

• Client.get_channel()

• Client.get_all_channels()

It is highly advisable to leave this intent enabled for your bot to function.

Type:

bool

members

Whether guild member related events are enabled.

This corresponds to the following events:

• on_member_join()

• on_member_remove()

• on_member_update()

• on_user_update()

This also corresponds to the following attributes and classes in terms of cache:

• Client.get_all_members()

• Client.get_user()

• Guild.chunk()

• Guild.fetch_members()

• Guild.get_member()

• Guild.members

• Member.roles

• Member.nick

• Member.premium_since

• User.name

• User.avatar

• User.discriminator

For more information go to the member intent documentation.

Note

Currently, this requires opting in explicitly via the developer portal as well. Bots in over 100 guilds will need to apply to Discord for verification.

Type:

bool

moderation

Whether guild moderation related events are enabled.

This corresponds to the following events:

• on_member_ban()

• on_member_unban()

• on_audit_log_entry_create()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

bans

Alias of moderation.

Changed in version 2.4: Changed to an alias.

Type:

bool

emojis

Alias of emojis_and_stickers.

Changed in version 2.0: Changed to an alias.

Type:

bool

emojis_and_stickers

Whether guild emoji and sticker related events are enabled.

Added in version 2.0.

This corresponds to the following events:

• on_guild_emojis_update()

• on_guild_stickers_update()

This also corresponds to the following attributes and classes in terms of cache:

• Emoji

• GuildSticker

• Client.get_emoji()

• Client.get_sticker()

• Client.emojis()

• Client.stickers()

• Guild.emojis

• Guild.stickers

Type:

bool

integrations

Whether guild integration related events are enabled.

This corresponds to the following events:

• on_guild_integrations_update()

• on_integration_create()

• on_integration_update()

• on_raw_integration_delete()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

webhooks

Whether guild webhook related events are enabled.

This corresponds to the following events:

• on_webhooks_update()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

invites

Whether guild invite related events are enabled.

This corresponds to the following events:

• on_invite_create()

• on_invite_delete()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

voice_states

Whether guild voice state related events are enabled.

This corresponds to the following events:

• on_voice_state_update()

This also corresponds to the following attributes and classes in terms of cache:

• VoiceChannel.members

• VoiceChannel.voice_states

• Member.voice

Note

This intent is required to connect to voice.

Type:

bool

presences

Whether guild presence related events are enabled.

This corresponds to the following events:

• on_presence_update()

This also corresponds to the following attributes and classes in terms of cache:

• Member.activities

• Member.status

• Member.raw_status

For more information go to the presence intent documentation.

Note

Currently, this requires opting in explicitly via the developer portal as well. Bots in over 100 guilds will need to apply to Discord for verification.

Type:

bool

messages

Whether guild and direct message related events are enabled.

This is a shortcut to set or get both guild_messages and dm_messages.

This corresponds to the following events:

• on_message() (both guilds and DMs)

• on_message_edit() (both guilds and DMs)

• on_message_delete() (both guilds and DMs)

• on_raw_message_delete() (both guilds and DMs)

• on_raw_message_edit() (both guilds and DMs)

This also corresponds to the following attributes and classes in terms of cache:

• Message

• Client.cached_messages

Note that due to an implicit relationship this also corresponds to the following events:

• on_reaction_add() (both guilds and DMs)

• on_reaction_remove() (both guilds and DMs)

• on_reaction_clear() (both guilds and DMs)

Type:

bool

guild_messages

Whether guild message related events are enabled.

See also dm_messages for DMs or messages for both.

This corresponds to the following events:

• on_message() (only for guilds)

• on_message_edit() (only for guilds)

• on_message_delete() (only for guilds)

• on_raw_message_delete() (only for guilds)

• on_raw_message_edit() (only for guilds)

This also corresponds to the following attributes and classes in terms of cache:

• Message

• Client.cached_messages (only for guilds)

Note that due to an implicit relationship this also corresponds to the following events:

• on_reaction_add() (only for guilds)

• on_reaction_remove() (only for guilds)

• on_reaction_clear() (only for guilds)

Type:

bool

dm_messages

Whether direct message related events are enabled.

See also guild_messages for guilds or messages for both.

This corresponds to the following events:

• on_message() (only for DMs)

• on_message_edit() (only for DMs)

• on_message_delete() (only for DMs)

• on_raw_message_delete() (only for DMs)

• on_raw_message_edit() (only for DMs)

This also corresponds to the following attributes and classes in terms of cache:

• Message

• Client.cached_messages (only for DMs)

Note that due to an implicit relationship this also corresponds to the following events:

• on_reaction_add() (only for DMs)

• on_reaction_remove() (only for DMs)

• on_reaction_clear() (only for DMs)

Type:

bool

reactions

Whether guild and direct message reaction related events are enabled.

This is a shortcut to set or get both guild_reactions and dm_reactions.

This corresponds to the following events:

• on_reaction_add() (both guilds and DMs)

• on_reaction_remove() (both guilds and DMs)

• on_reaction_clear() (both guilds and DMs)

• on_raw_reaction_add() (both guilds and DMs)

• on_raw_reaction_remove() (both guilds and DMs)

• on_raw_reaction_clear() (both guilds and DMs)

This also corresponds to the following attributes and classes in terms of cache:

• Message.reactions (both guild and DM messages)

Type:

bool

guild_reactions

Whether guild message reaction related events are enabled.

See also dm_reactions for DMs or reactions for both.

This corresponds to the following events:

• on_reaction_add() (only for guilds)

• on_reaction_remove() (only for guilds)

• on_reaction_clear() (only for guilds)

• on_raw_reaction_add() (only for guilds)

• on_raw_reaction_remove() (only for guilds)

• on_raw_reaction_clear() (only for guilds)

This also corresponds to the following attributes and classes in terms of cache:

• Message.reactions (only for guild messages)

Type:

bool

dm_reactions

Whether direct message reaction related events are enabled.

See also guild_reactions for guilds or reactions for both.

This corresponds to the following events:

• on_reaction_add() (only for DMs)

• on_reaction_remove() (only for DMs)

• on_reaction_clear() (only for DMs)

• on_raw_reaction_add() (only for DMs)

• on_raw_reaction_remove() (only for DMs)

• on_raw_reaction_clear() (only for DMs)

This also corresponds to the following attributes and classes in terms of cache:

• Message.reactions (only for DM messages)

Type:

bool

typing

Whether guild and direct message typing related events are enabled.

This is a shortcut to set or get both guild_typing and dm_typing.

This corresponds to the following events:

• on_typing() (both guilds and DMs)

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

guild_typing

Whether guild and direct message typing related events are enabled.

See also dm_typing for DMs or typing for both.

This corresponds to the following events:

• on_typing() (only for guilds)

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

dm_typing

Whether guild and direct message typing related events are enabled.

See also guild_typing for guilds or typing for both.

This corresponds to the following events:

• on_typing() (only for DMs)

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

message_content

Whether most message content can be accessed.

Without this intent, the following attributes may appear empty - either an empty string or empty array depending on the data type:

• Message.content

• Message.embeds

• Message.attachments

• Message.components

A bot will always be able to get these attributes from:

• Messages the bot sends

• Messages the bot receives in DMs

• Messages in which the bot is mentioned

For more information go to the message content intent documentation.

Note

As of September 1, 2022, this requires opting in explicitly via the developer portal as well. Bots in over 100 guilds will need to apply to Discord for verification.

Type:

bool

scheduled_events

Whether scheduled events related events are enabled.

This corresponds to the following events:

• on_guild_scheduled_event_create()

• on_guild_scheduled_event_delete()

• on_guild_scheduled_event_update()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

auto_moderation_configuration

Whether auto moderation configuration related events are enabled.

This corresponds to the following events:

• on_auto_moderation_rule_create()

• on_auto_moderation_rule_update()

• on_auto_moderation_rule_delete()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

auto_moderation_execution

Whether auto moderation execution related events are enabled.

This corresponds to the following events:

• on_auto_moderation_action_execution()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

auto_moderation

Whether auto moderation related events are enabled.

This is a shortcut to set or get both auto_moderation_configuration and auto_moderation_execution.

This corresponds to the following events:

• on_auto_moderation_rule_create()

• on_auto_moderation_rule_update()

• on_auto_moderation_rule_delete()

• on_auto_moderation_action_execution()

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

MemberCacheFlags

Attributes

• joined
• value
• voice

Methods

• clsMemberCacheFlags.all
• clsMemberCacheFlags.from_intents
• clsMemberCacheFlags.none

class nextcord.MemberCacheFlags(**kwargs)

Controls the library’s cache policy when it comes to members.

This allows for finer grained control over what members are cached. Note that the bot’s own member is always cached. This class is passed to the member_cache_flags parameter in Client.

Due to a quirk in how Discord works, in order to ensure proper cleanup of cache resources it is recommended to have Intents.members enabled. Otherwise the library cannot know when a member leaves a guild and is thus unable to cleanup after itself.

To construct an object you can pass keyword arguments denoting the flags to enable or disable.

The default value is all flags enabled.

Added in version 1.5.

x == y

Checks if two flags are equal.

x != y

Checks if two flags are not equal.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

classmethod all()

A factory method that creates a MemberCacheFlags with everything enabled.

classmethod none()

A factory method that creates a MemberCacheFlags with everything disabled.

voice

Whether to cache members that are in voice.

This requires Intents.voice_states.

Members that leave voice are no longer cached.

Type:

bool

joined

Whether to cache members that joined the guild or are chunked as part of the initial log in flow.

This requires Intents.members.

Members that leave the guild are no longer cached.

Type:

bool

classmethod from_intents(intents)

A factory method that creates a MemberCacheFlags based on the currently selected Intents.

Parameters:

intents (Intents) – The intents to select from.

Returns:

The resulting member cache flags.

Return type:

MemberCacheFlags

ApplicationFlags

Attributes

• application_auto_moderation_rule_create
• application_command_badge
• embedded
• gateway_guild_members
• gateway_guild_members_limited
• gateway_message_content
• gateway_message_content_limited
• gateway_presence
• gateway_presence_limited
• value
• verification_pending_guild_limit

class nextcord.ApplicationFlags(**kwargs)

Wraps up the Discord Application flags.

x == y

Checks if two ApplicationFlags are equal.

x != y

Checks if two ApplicationFlags are not equal.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Added in version 2.0.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

application_auto_moderation_rule_create

Returns True if the application uses the Auto Moderation API.

Added in version 2.6.

Type:

bool

gateway_presence

Returns True if the application is verified and is allowed to receive presence information over the gateway.

Type:

bool

gateway_presence_limited

Returns True if the application is allowed to receive limited presence information over the gateway.

Type:

bool

gateway_guild_members

Returns True if the application is verified and is allowed to receive guild members information over the gateway.

Type:

bool

gateway_guild_members_limited

Returns True if the application is allowed to receive limited guild members information over the gateway.

Type:

bool

verification_pending_guild_limit

Returns True if the application is currently pending verification and has hit the guild limit.

Type:

bool

embedded

Returns True if the application is embedded within the Discord client.

Type:

bool

gateway_message_content

Returns True if the application is allowed to receive message content over the gateway.

Type:

bool

gateway_message_content_limited

Returns True if the application is allowed to receive limited message content over the gateway.

Type:

bool

application_command_badge

Returns True if the application has registered global application commands.

Type:

bool

RoleFlags

Attributes

• in_prompt
• value

class nextcord.RoleFlags(**kwargs)

Wraps up the Discord Guild Role Flags.

x == y

Checks if two RoleFlags are equal.

x != y

Checks if two RoleFlags are not equal.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Added in version 2.6.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

in_prompt

Returns True if the role can be selected in an onboarding prompt.

Type:

bool

File

Attributes

• description
• filename
• force_close
• fp
• spoiler

class nextcord.File(fp, filename=None, *, description=None, spoiler=False, force_close=None)

A parameter object used for abc.Messageable.send() for sending file objects.

Changed in version 2.5: You can now use nextcord.File as a context manager. This will automatically call close() when the context manager exits scope. When using the context manager, force_close will default to True.

Note

File objects are single use and are not meant to be reused in multiple abc.Messageable.send()s.

Parameters:

• fp (Union[str, bytes, os.PathLike, io.BufferedIOBase]) –

  A file-like object opened in binary mode and read mode or a filename representing a file in the hard drive to open.

  Note

  If the file-like object passed is opened via open then the modes ‘rb’ should be used.

  To pass binary data, consider usage of io.BytesIO.

• filename (Optional[str]) – The filename to display when uploading to Discord. If this is not given then it defaults to fp.name or if fp is a string then the filename will default to the string given.

• description (Optional[str]) – The description for the file. This is used to display alternative text in the Discord client.

• spoiler (bool) – Whether the attachment is a spoiler.

• force_close (bool) –

  Whether to forcibly close the bytes used to create the file when .close() is called. This will also make the file bytes unusable by flushing it from memory after it is sent once. Enable this if you don’t wish to reuse the same bytes. Defaults to True when using context manager.

  Added in version 2.2.

fp

A file-like object opened in binary mode and read mode. This will be a io.BufferedIOBase if an object of type io.IOBase was passed, or a io.BufferedReader if a filename was passed.

Type:

Union[io.BufferedReader, io.BufferedIOBase]

filename

The filename to display when uploading to Discord.

Type:

Optional[str]

description

The description for the file. This is used to display alternative text in the Discord client.

Type:

Optional[str]

spoiler

Whether the attachment is a spoiler.

Type:

bool

force_close

Whether to forcibly close the bytes used to create the file when .close() is called. This will also make the file bytes unusable by flushing it from memory after it is sent or used once. Enable this if you don’t wish to reuse the same bytes.

Added in version 2.2.

Type:

bool

Colour

Attributes

• b
• g
• r
• value

Methods

• clsColour.blue
• clsColour.blurple
• clsColour.brand_green
• clsColour.brand_red
• clsColour.dark_blue
• clsColour.dark_gold
• clsColour.dark_gray
• clsColour.dark_green
• clsColour.dark_grey
• clsColour.dark_magenta
• clsColour.dark_orange
• clsColour.dark_purple
• clsColour.dark_red
• clsColour.dark_teal
• clsColour.dark_theme
• clsColour.darker_gray
• clsColour.darker_grey
• clsColour.default
• clsColour.from_hsv
• clsColour.from_rgb
• clsColour.fuchsia
• clsColour.gold
• clsColour.green
• clsColour.greyple
• clsColour.light_gray
• clsColour.light_grey
• clsColour.lighter_gray
• clsColour.lighter_grey
• clsColour.magenta
• clsColour.og_blurple
• clsColour.orange
• clsColour.purple
• clsColour.random
• clsColour.red
• clsColour.teal
• clsColour.yellow
• defto_rgb

class nextcord.Colour(value)

Represents a Discord role colour. This class is similar to a (red, green, blue) tuple.

There is an alias for this called Color.

x == y

Checks if two colours are equal.

x != y

Checks if two colours are not equal.

hash(x)

Return the colour’s hash.

str(x)

Returns the hex format for the colour.

int(x)

Returns the raw colour value.

value

The raw integer colour value.

Type:

int

property r

Returns the red component of the colour.

Type:

int

property g

Returns the green component of the colour.

Type:

int

property b

Returns the blue component of the colour.

Type:

int

to_rgb()

Tuple[int, int, int]: Returns an (r, g, b) tuple representing the colour.

classmethod from_rgb(r, g, b)

Constructs a Colour from an RGB tuple.

classmethod from_hsv(h, s, v)

Constructs a Colour from an HSV tuple.

classmethod default()

A factory method that returns a Colour with a value of 0.

classmethod random(*, seed=None)

A factory method that returns a Colour with a random hue.

Note

The random algorithm works by choosing a colour with a random hue but with maxed out saturation and value.

Added in version 1.6.

Parameters:

seed (Optional[Union[int, str, float, bytes, bytearray]]) –

The seed to initialize the RNG with. If None is passed the default RNG is used.

Added in version 1.7.

classmethod teal()

A factory method that returns a Colour with a value of 0x1abc9c.

classmethod dark_teal()

A factory method that returns a Colour with a value of 0x11806a.

classmethod brand_green()

A factory method that returns a Colour with a value of 0x57F287.

Added in version 2.0.

classmethod green()

A factory method that returns a Colour with a value of 0x2ecc71.

classmethod dark_green()

A factory method that returns a Colour with a value of 0x1f8b4c.

classmethod blue()

A factory method that returns a Colour with a value of 0x3498db.

classmethod dark_blue()

A factory method that returns a Colour with a value of 0x206694.

classmethod purple()

A factory method that returns a Colour with a value of 0x9b59b6.

classmethod dark_purple()

A factory method that returns a Colour with a value of 0x71368a.

classmethod magenta()

A factory method that returns a Colour with a value of 0xe91e63.

classmethod dark_magenta()

A factory method that returns a Colour with a value of 0xad1457.

classmethod gold()

A factory method that returns a Colour with a value of 0xf1c40f.

classmethod dark_gold()

A factory method that returns a Colour with a value of 0xc27c0e.

classmethod orange()

A factory method that returns a Colour with a value of 0xe67e22.

classmethod dark_orange()

A factory method that returns a Colour with a value of 0xa84300.

classmethod brand_red()

A factory method that returns a Colour with a value of 0xED4245.

Added in version 2.0.

classmethod red()

A factory method that returns a Colour with a value of 0xe74c3c.

classmethod dark_red()

A factory method that returns a Colour with a value of 0x992d22.

classmethod lighter_grey()

A factory method that returns a Colour with a value of 0x95a5a6.

classmethod lighter_gray()

A factory method that returns a Colour with a value of 0x95a5a6.

classmethod dark_grey()

A factory method that returns a Colour with a value of 0x607d8b.

classmethod dark_gray()

A factory method that returns a Colour with a value of 0x607d8b.

classmethod light_grey()

A factory method that returns a Colour with a value of 0x979c9f.

classmethod light_gray()

A factory method that returns a Colour with a value of 0x979c9f.

classmethod darker_grey()

A factory method that returns a Colour with a value of 0x546e7a.

classmethod darker_gray()

A factory method that returns a Colour with a value of 0x546e7a.

classmethod og_blurple()

A factory method that returns a Colour with a value of 0x7289da.

classmethod blurple()

A factory method that returns a Colour with a value of 0x5865F2.

classmethod greyple()

A factory method that returns a Colour with a value of 0x99aab5.

classmethod dark_theme()

A factory method that returns a Colour with a value of 0x313338. This will appear transparent on Discord’s dark theme.

Added in version 1.5.

Changed in version 2.5: Colour was replaced by the new dark theme colour on the UI.

classmethod fuchsia()

A factory method that returns a Colour with a value of 0xEB459E.

Added in version 2.0.

classmethod yellow()

A factory method that returns a Colour with a value of 0xFEE75C.

Added in version 2.0.

BaseActivity

Attributes

• created_at

class nextcord.BaseActivity(**kwargs)

The base activity that all user-settable activities inherit from. A user-settable activity is one that can be used in Client.change_presence().

The following types currently count as user-settable:

• Activity

• Game

• Streaming

• CustomActivity

Note that although these types are considered user-settable by the library, Discord typically ignores certain combinations of activity depending on what is currently set. This behaviour may change in the future so there are no guarantees on whether Discord will actually let you set these types.

Added in version 1.3.

property created_at

When the user started doing this activity in UTC.

Added in version 1.3.

Type:

Optional[datetime.datetime]

Activity

Attributes

• application_id
• assets
• buttons
• details
• emoji
• end
• large_image_text
• large_image_url
• name
• party
• small_image_text
• small_image_url
• start
• state
• timestamps
• type
• url

class nextcord.Activity(**kwargs)

Represents an activity in Discord.

This could be an activity such as streaming, playing, listening or watching.

For memory optimisation purposes, some activities are offered in slimmed down versions:

• Game

• Streaming

application_id

The application ID of the game.

Type:

Optional[int]

name

The name of the activity.

Type:

Optional[str]

url

A stream URL that the activity could be doing.

Type:

Optional[str]

type

The type of activity currently being done.

Type:

ActivityType

state

The user’s current state. For example, “In Game”.

Type:

Optional[str]

details

The detail of the user’s current activity.

Type:

Optional[str]

timestamps

A dictionary of timestamps. It contains the following optional keys:

• start: Corresponds to when the user started doing the activity in milliseconds since Unix epoch.

• end: Corresponds to when the user will finish doing the activity in milliseconds since Unix epoch.

Type:

dict

assets

A dictionary representing the images and their hover text of an activity. It contains the following optional keys:

• large_image: A string representing the ID for the large image asset.

• large_text: A string representing the text when hovering over the large image asset.

• small_image: A string representing the ID for the small image asset.

• small_text: A string representing the text when hovering over the small image asset.

Type:

dict

party

A dictionary representing the activity party. It contains the following optional keys:

• id: A string representing the party ID.

• size: A list of up to two integer elements denoting (current_size, maximum_size).

Type:

dict

buttons

A list of dictionaries representing custom buttons shown in a rich presence. Each dictionary contains the following keys:

• label: A string representing the text shown on the button.

• url: A string representing the URL opened upon clicking the button.

Added in version 2.0.

Type:

List[dict]

emoji

The emoji that belongs to this activity.

Type:

Optional[PartialEmoji]

property start

When the user started doing this activity in UTC, if applicable.

Type:

Optional[datetime.datetime]

property end

When the user will stop doing this activity in UTC, if applicable.

Type:

Optional[datetime.datetime]

property large_image_url

Returns a URL pointing to the large image asset of this activity if applicable.

Type:

Optional[str]

property small_image_url

Returns a URL pointing to the small image asset of this activity if applicable.

Type:

Optional[str]

property large_image_text

Returns the large image asset hover text of this activity if applicable.

Type:

Optional[str]

property small_image_text

Returns the small image asset hover text of this activity if applicable.

Type:

Optional[str]

Game

Attributes

• end
• name
• start
• type

class nextcord.Game(name, **extra)

A slimmed down version of Activity that represents a Discord game.

This is typically displayed via Playing on the official Discord client.

x == y

Checks if two games are equal.

x != y

Checks if two games are not equal.

hash(x)

Returns the game’s hash.

str(x)

Returns the game’s name.

Parameters:

name (str) – The game’s name.

name

The game’s name.

Type:

str

property type

Returns the game’s type. This is for compatibility with Activity.

It always returns ActivityType.playing.

Type:

ActivityType

property start

When the user started playing this game in UTC, if applicable.

Type:

Optional[datetime.datetime]

property end

When the user will stop playing this game in UTC, if applicable.

Type:

Optional[datetime.datetime]

Streaming

Attributes

• assets
• details
• game
• name
• platform
• twitch_name
• type
• url

class nextcord.Streaming(*, name, url, **extra)

A slimmed down version of Activity that represents a Discord streaming status.

This is typically displayed via Streaming on the official Discord client.

x == y

Checks if two streams are equal.

x != y

Checks if two streams are not equal.

hash(x)

Returns the stream’s hash.

str(x)

Returns the stream’s name.

platform

Where the user is streaming from (ie. YouTube, Twitch).

Added in version 1.3.

Type:

Optional[str]

name

The stream’s name.

Type:

Optional[str]

details

An alias for name

Type:

Optional[str]

game

The game being streamed.

Added in version 1.3.

Type:

Optional[str]

url

The stream’s URL.

Type:

str

assets

A dictionary comprising of similar keys than those in Activity.assets.

Type:

dict

property type

Returns the game’s type. This is for compatibility with Activity.

It always returns ActivityType.streaming.

Type:

ActivityType

property twitch_name

If provided, the twitch name of the user streaming.

This corresponds to the large_image key of the Streaming.assets dictionary if it starts with twitch:. Typically set by the Discord client.

Type:

Optional[str]

CustomActivity

Attributes

• emoji
• name
• state
• type

class nextcord.CustomActivity(name, *, _connection_state=None, emoji=None, **extra)

Represents a Custom activity from Discord.

x == y

Checks if two activities are equal.

x != y

Checks if two activities are not equal.

hash(x)

Returns the activity’s hash.

str(x)

Returns the custom status text.

Added in version 1.3.

name

The custom activity’s name.

Type:

Optional[str]

emoji

The emoji to pass to the activity, if any.

Type:

Optional[PartialEmoji]

state

The custom status text. name must equal “Custom Status” for this to work.

Changed in version 2.6: This falls back to name if not provided.

Type:

Optional[str]

property type

Returns the activity’s type. This is for compatibility with Activity.

It always returns ActivityType.custom.

Type:

ActivityType

Permissions

Attributes

• add_reactions
• administrator
• attach_files
• ban_members
• change_nickname
• connect
• create_events
• create_expressions
• create_instant_invite
• create_private_threads
• create_public_threads
• deafen_members
• embed_links
• external_emojis
• external_stickers
• kick_members
• manage_channels
• manage_emojis
• manage_emojis_and_stickers
• manage_events
• manage_guild
• manage_messages
• manage_nicknames
• manage_permissions
• manage_roles
• manage_threads
• manage_webhooks
• mention_everyone
• moderate_members
• move_members
• mute_members
• priority_speaker
• read_message_history
• read_messages
• request_to_speak
• send_messages
• send_messages_in_threads
• send_tts_messages
• send_voice_messages
• speak
• start_embedded_activities
• stream
• use_external_emojis
• use_external_stickers
• use_slash_commands
• use_voice_activation
• value
• view_audit_log
• view_channel
• view_guild_insights

Methods

• clsPermissions.advanced
• clsPermissions.all
• clsPermissions.all_channel
• clsPermissions.general
• clsPermissions.membership
• clsPermissions.none
• clsPermissions.stage
• clsPermissions.stage_moderator
• clsPermissions.text
• clsPermissions.voice
• defis_strict_subset
• defis_strict_superset
• defis_subset
• defis_superset
• defupdate

class nextcord.Permissions(permissions=0, **kwargs)

Wraps up the Discord permission value.

The properties provided are two way. You can set and retrieve individual bits using the properties as if they were regular bools. This allows you to edit permissions.

Changed in version 1.3: You can now use keyword arguments to initialize Permissions similar to update().

x == y

Checks if two permissions are equal.

x != y

Checks if two permissions are not equal.

x <= y

Checks if a permission is a subset of another permission.

x >= y

Checks if a permission is a superset of another permission.

x < y

Checks if a permission is a strict subset of another permission.

x > y

Checks if a permission is a strict superset of another permission.

hash(x)

Return the permission’s hash.

iter(x)

Returns an iterator of (perm, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available permissions. You should query permissions via the properties rather than using this raw value.

Type:

int

is_subset(other)

Returns True if self has the same or fewer permissions as other.

is_superset(other)

Returns True if self has the same or more permissions as other.

is_strict_subset(other)

Returns True if the permissions on other are a strict subset of those on self.

is_strict_superset(other)

Returns True if the permissions on other are a strict superset of those on self.

classmethod none()

A factory method that creates a Permissions with all permissions set to False.

classmethod all()

A factory method that creates a Permissions with all permissions set to True.

classmethod all_channel()

A Permissions with all channel-specific permissions set to True and the guild-specific ones set to False. The guild-specific permissions are currently:

• manage_emojis_and_stickers

• view_audit_log

• view_guild_insights

• manage_guild

• change_nickname

• manage_nicknames

• kick_members

• ban_members

• administrator

• create_expressions

• moderate_members

• create_events

• manage_events

Changed in version 1.7: Added stream, priority_speaker and use_slash_commands permissions.

Changed in version 2.0: Added create_public_threads, create_private_threads, manage_threads, use_external_stickers, send_messages_in_threads and request_to_speak permissions.

Changed in version 3.0: Added start_embedded_activities, create_expressions permissions.

classmethod general()

A factory method that creates a Permissions with all “General” permissions from the official Discord UI set to True.

Changed in version 1.7: Permission read_messages is now included in the general permissions, but permissions administrator, create_instant_invite, kick_members, ban_members, change_nickname and manage_nicknames are no longer part of the general permissions.

Changed in version 3.0: Added create_expressions permission.

classmethod membership()

A factory method that creates a Permissions with all “Membership” permissions from the official Discord UI set to True.

Added in version 1.7.

classmethod text()

A factory method that creates a Permissions with all “Text” permissions from the official Discord UI set to True.

Changed in version 1.7: Permission read_messages is no longer part of the text permissions. Added use_slash_commands permission.

Changed in version 2.0: Added create_public_threads, create_private_threads, manage_threads, send_messages_in_threads and use_external_stickers permissions.

classmethod voice()

A factory method that creates a Permissions with all “Voice” permissions from the official Discord UI set to True.

classmethod stage()

A factory method that creates a Permissions with all “Stage Channel” permissions from the official Discord UI set to True.

Added in version 1.7.

classmethod stage_moderator()

A factory method that creates a Permissions with all “Stage Moderator” permissions from the official Discord UI set to True.

Added in version 1.7.

classmethod advanced()

A factory method that creates a Permissions with all “Advanced” permissions from the official Discord UI set to True.

Added in version 1.7.

update(**kwargs)

Bulk updates this permission object.

Allows you to set multiple attributes by using keyword arguments. The names must be equivalent to the properties listed. Extraneous key/value pairs will be silently ignored.

Parameters:

**kwargs – A list of key/value pairs to bulk update permissions with.

create_instant_invite

Returns True if the user can create instant invites.

Type:

bool

kick_members

Returns True if the user can kick users from the guild.

Type:

bool

ban_members

Returns True if a user can ban users from the guild.

Type:

bool

administrator

Returns True if a user is an administrator. This role overrides all other permissions.

This also bypasses all channel-specific overrides.

Type:

bool

manage_channels

Returns True if a user can edit, delete, or create channels in the guild.

This also corresponds to the “Manage Channel” channel-specific override.

Type:

bool

manage_guild

Returns True if a user can edit guild properties.

Type:

bool

add_reactions

Returns True if a user can add reactions to messages.

Type:

bool

view_audit_log

Returns True if a user can view the guild’s audit log.

Type:

bool

priority_speaker

Returns True if a user can be more easily heard while talking.

Type:

bool

stream

Returns True if a user can stream in a voice channel.

Type:

bool

read_messages

Returns True if a user can read messages from all or specific text channels.

Type:

bool

view_channel

An alias for read_messages.

Added in version 1.3.

Type:

bool

send_messages

Returns True if a user can send messages from all or specific text channels.

This falls under Create Posts on the UI specifically for Forum Channels.

Type:

bool

send_tts_messages

Returns True if a user can send TTS messages from all or specific text channels.

Type:

bool

manage_messages

Returns True if a user can delete or pin messages in a text channel.

Note

Note that there are currently no ways to edit other people’s messages.

Type:

bool

embed_links

Returns True if a user’s messages will automatically be embedded by Discord.

Type:

bool

attach_files

Returns True if a user can send files in their messages.

Type:

bool

read_message_history

Returns True if a user can read a text channel’s previous messages.

Type:

bool

mention_everyone

Returns True if a user’s @everyone or @here will mention everyone in the text channel.

Type:

bool

external_emojis

Returns True if a user can use emojis from other guilds.

Type:

bool

use_external_emojis

An alias for external_emojis.

Added in version 1.3.

Type:

bool

view_guild_insights

Returns True if a user can view the guild’s insights.

Added in version 1.3.

Type:

bool

connect

Returns True if a user can connect to a voice channel.

Type:

bool

speak

Returns True if a user can speak in a voice channel.

Type:

bool

mute_members

Returns True if a user can mute other users.

Type:

bool

deafen_members

Returns True if a user can deafen other users.

Type:

bool

move_members

Returns True if a user can move users between other voice channels.

Type:

bool

use_voice_activation

Returns True if a user can use voice activation in voice channels.

Type:

bool

change_nickname

Returns True if a user can change their nickname in the guild.

Type:

bool

manage_nicknames

Returns True if a user can change other user’s nickname in the guild.

Type:

bool

manage_roles

Returns True if a user can create or edit roles less than their role’s position.

This also corresponds to the “Manage Permissions” channel-specific override.

Type:

bool

manage_permissions

An alias for manage_roles.

Added in version 1.3.

Type:

bool

manage_webhooks

Returns True if a user can create, edit, or delete webhooks.

Type:

bool

manage_emojis

Returns True if a user can create, edit, or delete emojis.

Type:

bool

manage_emojis_and_stickers

An alias for manage_emojis.

Added in version 2.0.

Type:

bool

use_slash_commands

Returns True if a user can use slash commands.

Added in version 1.7.

Type:

bool

request_to_speak

Returns True if a user can request to speak in a stage channel.

Added in version 1.7.

Type:

bool

manage_events

Returns True if a user can manage guild events.

Added in version 2.0.

Type:

bool

manage_threads

Returns True if a user can manage threads.

Added in version 2.0.

Type:

bool

create_public_threads

Returns True if a user can create public threads.

Added in version 2.0.

Type:

bool

create_private_threads

Returns True if a user can create private threads.

Added in version 2.0.

Type:

bool

external_stickers

Returns True if a user can use stickers from other guilds.

Added in version 2.0.

Type:

bool

use_external_stickers

An alias for external_stickers.

Added in version 2.0.

Type:

bool

send_messages_in_threads

Returns True if a user can send messages in threads.

This falls under Send Messages in Posts on the UI specifically for Forum channels.

Added in version 2.0.

Type:

bool

start_embedded_activities

Returns True if a user can launch activities in a voice channel.

Added in version 2.0.

Type:

bool

moderate_members

Returns True if a user can moderate members (add timeouts).

Referred to as Timeout Members in the discord client.

Added in version 2.0.

Type:

bool

create_expressions

Returns True if a user can create expressions.

This includes creating emojis, stickers, and soundboard sounds.

Added in version 3.0.

Type:

bool

create_events

Returns True if a user can create scheduled events.

Added in version 3.0.

Type:

bool

send_voice_messages

Returns True if a user can send voice messages.

Added in version 3.0.

Type:

bool

PermissionOverwrite

Methods

• clsPermissionOverwrite.from_pair
• defis_empty
• defpair
• defupdate

class nextcord.PermissionOverwrite(**kwargs)

A type that is used to represent a channel specific permission.

Unlike a regular Permissions, the default value of a permission is equivalent to None and not False. Setting a value to False is explicitly denying that permission, while setting a value to True is explicitly allowing that permission.

The values supported by this are the same as Permissions with the added possibility of it being set to None.

x == y

Checks if two overwrites are equal.

x != y

Checks if two overwrites are not equal.

iter(x)

Returns an iterator of (perm, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Parameters:

**kwargs – Set the value of permissions by their name.

pair()

Tuple[Permissions, Permissions]: Returns the (allow, deny) pair from this overwrite.

classmethod from_pair(allow, deny)

Creates an overwrite from an allow/deny pair of Permissions.

is_empty()

Checks if the permission overwrite is currently empty.

An empty permission overwrite is one that has no overwrites set to True or False.

Returns:

Indicates if the overwrite is empty.

Return type:

bool

update(**kwargs)

Bulk updates this permission overwrite object.

Allows you to set multiple attributes by using keyword arguments. The names must be equivalent to the properties listed. Extraneous key/value pairs will be silently ignored.

Parameters:

**kwargs – A list of key/value pairs to bulk update with.

ShardInfo

Attributes

• id
• latency
• shard_count

Methods

• asyncconnect
• asyncdisconnect
• defis_closed
• defis_ws_ratelimited
• asyncreconnect

class nextcord.ShardInfo

A class that gives information and control over a specific shard.

You can retrieve this object via AutoShardedClient.get_shard() or AutoShardedClient.shards.

Added in version 1.4.

id

The shard ID for this shard.

Type:

int

shard_count

The shard count for this cluster. If this is None then the bot has not started yet.

Type:

Optional[int]

is_closed()

bool: Whether the shard connection is currently closed.

await disconnect()

This function is a coroutine.

Disconnects a shard. When this is called, the shard connection will no longer be open.

If the shard is already disconnected this does nothing.

await reconnect()

This function is a coroutine.

Disconnects and then connects the shard again.

await connect()

This function is a coroutine.

Connects a shard. If the shard is already connected this does nothing.

property latency

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds for this shard.

Type:

float

is_ws_ratelimited()

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.

Added in version 1.6.

SystemChannelFlags

Attributes

• guild_reminder_notifications
• join_notification_replies
• join_notifications
• premium_subscriptions
• role_subscription_purchase_notification_replies
• role_subscription_purchase_notifications
• value

class nextcord.SystemChannelFlags

Wraps up a Discord system channel flag value.

Similar to Permissions, the properties provided are two way. You can set and retrieve individual bits using the properties as if they were regular bools. This allows you to edit the system flags easily.

To construct an object you can pass keyword arguments denoting the flags to enable or disable.

x == y

Checks if two flags are equal.

x != y

Checks if two flags are not equal.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

join_notifications

Returns True if the system channel is used for member join notifications.

Type:

bool

premium_subscriptions

Returns True if the system channel is used for “Nitro boosting” notifications.

Type:

bool

guild_reminder_notifications

Returns True if the system channel is used for server setup helpful tips notifications.

Added in version 2.0.

Type:

bool

join_notification_replies

Returns True if the button to reply with a sticker to member join notifications is shown.

Added in version 2.0.

Type:

bool

role_subscription_purchase_notifications

Returns True if the system channel is used for role subscription purchase notifications.

Added in version 3.2.

Type:

bool

role_subscription_purchase_notification_replies

Returns True if the button to reply with a sticker to role subscription purchase notifications is shown.

Added in version 3.2.

Type:

bool

MessageFlags

Attributes

• crossposted
• ephemeral
• failed_to_mention_roles
• has_thread
• is_crossposted
• is_voice_message
• loading
• source_message_deleted
• suppress_embeds
• suppress_notifications
• urgent
• value

class nextcord.MessageFlags

Wraps up a Discord Message flag value.

See SystemChannelFlags.

x == y

Checks if two flags are equal.

x != y

Checks if two flags are not equal.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

Added in version 1.3.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

crossposted

Returns True if the message is the original crossposted message.

Type:

bool

is_crossposted

Returns True if the message was crossposted from another channel.

Type:

bool

suppress_embeds

Returns True if the message’s embeds have been suppressed.

Type:

bool

source_message_deleted

Returns True if the source message for this crosspost has been deleted.

Type:

bool

urgent

Returns True if the source message is an urgent message.

An urgent message is one sent by Discord Trust and Safety.

Type:

bool

has_thread

Returns True if the source message is associated with a thread.

Added in version 2.0.

Type:

bool

ephemeral

Returns True if the source message is ephemeral.

Added in version 2.0.

Type:

bool

loading

Returns True if the source message is loading.

This is represented in the UI as “bot is thinking…”.

Added in version 2.6.

Type:

bool

failed_to_mention_roles

Returns True if the message failed to mention some roles in a thread.

This means that those members were not added.

Added in version 2.6.

Type:

bool

suppress_notifications

Returns True if the message does not trigger notifications.

These are sent via @silent message prefixes in the UI.

Added in version 2.6.

Type:

bool

is_voice_message

Returns True if the message is a voice message.

Added in version 3.0.

Type:

bool

PublicUserFlags

Attributes

• active_developer
• bug_hunter
• bug_hunter_level_2
• discord_certified_moderator
• early_supporter
• early_verified_bot_developer
• hypesquad
• hypesquad_balance
• hypesquad_bravery
• hypesquad_brilliance
• known_spammer
• partner
• staff
• system
• team_user
• value
• verified_bot
• verified_bot_developer

Methods

• defall

class nextcord.PublicUserFlags

Wraps up the Discord User Public flags.

x == y

Checks if two PublicUserFlags are equal.

x != y

Checks if two PublicUserFlags are not equal.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Added in version 1.4.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

staff

Returns True if the user is a Discord Employee.

Type:

bool

partner

Returns True if the user is a Discord Partner.

Type:

bool

hypesquad

Returns True if the user is a HypeSquad Events member.

Type:

bool

bug_hunter

Returns True if the user is a Bug Hunter

Type:

bool

hypesquad_bravery

Returns True if the user is a HypeSquad Bravery member.

Type:

bool

hypesquad_brilliance

Returns True if the user is a HypeSquad Brilliance member.

Type:

bool

hypesquad_balance

Returns True if the user is a HypeSquad Balance member.

Type:

bool

early_supporter

Returns True if the user is an Early Supporter.

Type:

bool

team_user

Returns True if the user is a Team User.

Type:

bool

system

Returns True if the user is a system user (i.e. represents Discord officially).

Type:

bool

bug_hunter_level_2

Returns True if the user is a Bug Hunter Level 2

Type:

bool

verified_bot

Returns True if the user is a Verified Bot.

Type:

bool

verified_bot_developer

Returns True if the user is an Early Verified Bot Developer.

Type:

bool

early_verified_bot_developer

An alias for verified_bot_developer.

Added in version 1.5.

Type:

bool

discord_certified_moderator

Returns True if the user is a Discord Moderator Programs Alumni.

Formally known as Discord Certified Moderator.

Added in version 2.0.

Type:

bool

known_spammer

Returns True if the user is a Known Spammer.

Added in version 2.0.

Type:

bool

active_developer

Returns True if the user is an Active Developer.

Added in version 2.4.

Type:

bool

all()

List[UserFlags]: Returns all public flags the user has.

MemberFlags

Attributes

• bypasses_verification
• completed_onboarding
• did_rejoin
• started_onboarding
• value

class nextcord.MemberFlags

Wraps up the Discord Guild Member flags

Added in version 2.6.

x == y

Checks if two MemberFlags are equal.

x != y

Checks if two MemberFlags are not equal.

hash(x)

Returns the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

did_rejoin

Returns True if the member left and rejoined the Guild.

Type:

bool

completed_onboarding

Returns True if the member has completed onboarding.

Type:

bool

bypasses_verification

Returns True if the member can bypass the guild verification requirements.

Type:

bool

started_onboarding

Returns True if the member has started onboarding.

Type:

bool

ChannelFlags

Attributes

• pinned
• require_tag
• value

class nextcord.ChannelFlags

Wraps up a Discord channel flag value.

Similar to Permissions, the properties provided are two way. You can set and retrieve individual bits using the properties as if they were regular bools. This allows you to edit the channel flags easily.

To construct an object you can pass keyword arguments denoting the flags to enable or disable.

Added in version 2.1.

x == y

Checks if two flags are equal.

x != y

Checks if two flags are not equal.

hash(x)

Return the flag’s hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

pinned

Returns True if the thread is pinned in its parent forum.

Type:

bool

require_tag

Returns True if the forum channel requires tags for posts.

Type:

bool

AutoModerationTriggerMetadata

Attributes

• allow_list
• keyword_filter
• mention_raid_protection_enabled
• mention_total_limit
• presets
• regex_patterns

class nextcord.AutoModerationTriggerMetadata(*, keyword_filter=None, regex_patterns=None, presets=None, allow_list=None, mention_total_limit=None, mention_raid_protection_enabled=None)

Represents data about an auto moderation trigger rule.

Added in version 2.1.

keyword_filter

A list of substrings which will be searched for in content.

Note

This is None and cannot be provided if the trigger type of the rule is not AutoModerationTriggerType.keyword or AutoModerationTriggerType.member_profile.

Type:

List[str]

regex_patterns

A list of regex patterns which will be matched with content. Can only be up to 10 patterns.

Added in version 2.4.

Note

This is None and cannot be provided if the trigger type of the rule is not AutoModerationTriggerType.keyword or AutoModerationTriggerType.member_profile.

Warning

The flavor of regex used is Rust flavor and has no guarantees of working with the re module. Each regex pattern must be 75 characters or less.

Type:

Optional[List[str]]

presets

A list of Discord pre-defined wordsets which will be searched for in content.

Note

This is None and cannot be provided if the trigger type of the rule is not AutoModerationTriggerType.keyword_preset.

Type:

List[KeywordPresetType]

allow_list

A list of exempt strings that will not trigger the preset type.

Note

This is None and cannot be provided if the trigger type of the rule is not AutoModerationTriggerType.keyword_preset or AutoModerationTriggerType.member_profile.

Warning

Wildcard syntax (*) is not supported here.

Type:

List[str]

mention_total_limit

The maximum amount of mentions allowed in a messsage.

Added in version 2.3.

Note

This is None and cannot be provided if the trigger type of this rule is not AutoModerationTriggerType.mention_spam.

Type:

Optional[int]

mention_raid_protection_enabled

Whether to automatically detect mention raids.

Added in version 2.6.

Note

This is None and cannot be provided if the trigger type of this rule is not AutoModerationTriggerType.mention_spam.

Type:

Optional[bool]

AutoModerationActionMetadata

Attributes

• channel
• custom_message
• duration_seconds

class nextcord.AutoModerationActionMetadata(*, channel=None, duration_seconds=None, custom_message=None)

Represents additional data that is used when an action is executed.

Added in version 2.1.

channel

The channel to which message content should be logged.

Note

This is None and cannot be provided if the action type of the rule is not AutoModerationActionType.send_alert_message.

Type:

Optional[abc.Snowflake]

duration_seconds

The duration of the timeout in seconds.

Note

This is None and cannot be provided if the action type of the rule is not AutoModerationActionType.timeout.

Note

The maximum value that can be used is 2419200 seconds (4 weeks)

Type:

Optional[int]

custom_message

The message explaining why the message has been blocked.

Added in version 3.0.

Note

This is None and cannot be provided if the action type of the rule is not AutoModerationActionType.block_message.

Note

This message cannot exceed 150 characters.

Type:

Optional[str]

AutoModerationAction

Attributes

• metadata
• type

class nextcord.AutoModerationAction(*, type, metadata=None)

Represents an auto moderation action that will execute whenever a rule is triggered.

Added in version 2.1.

Parameters:

• type (AutoModerationActionType) – The type to use for this action.

• metadata (AutoModerationActionMetadata) – The additional data to use during execution of this action.

type

The type of this action.

Type:

AutoModerationActionType

metadata

The additional metadata needed during execution for this specific action type.

Type:

AutoModerationActionMetadata

ForumTag

Attributes

• emoji
• id
• moderated
• name

class nextcord.ForumTag(*, id=None, name, moderated=False, emoji=None)

Represents a tag in a forum channel that can be used to filter posts.

Added in version 2.4.

id

The ID of the tag.

Type:

int

name

The name of the tag.

Type:

str

moderated

Whether this tag can only be added to or removed from threads by a member with the manage_threads permission.

Type:

bool

emoji

The emoji that represents this tag.

Type:

Optional[PartialEmoji]

Parameters:

• id (int) –

  The ID of the tag.

  Warning

  This should not really be passed when constructing this manually. This is only documented here for the sake of completeness.

• name (str) – The name of the tag.

• moderated (bool) – Whether this tag can only be added to or removed from threads by a member with the manage_threads permission.

• emoji (Optional[PartialEmoji]) – The emoji that represents this tag.

RoleConnectionMetadata

Attributes

• description
• description_localizations
• key
• name
• name_localizations
• type

class nextcord.RoleConnectionMetadata(*, type, key, name, name_localizations, description, description_localizations)

Represents a role connection metadata object.

Added in version 2.4.

type

The type of metadata value.

Type:

RoleConnectionMetadataType

key

The dictionary key for the metadata field.

Type:

str

name

The name of the metadata field.

Type:

str

name_localizations

The translations of the name.

Type:

Optional[dict]

description

The description of the metadata field.

Type:

str

description_localizations

The translations of the description.

Type:

Optional[dict]

Bot UI Kit

The library has helpers to help create component-based UIs.

View

Attributes

• auto_defer
• children
• prevent_update
• timeout

Methods

• clsView.from_message
• defadd_item
• defclear_items
• asyncinteraction_check
• defis_dispatching
• defis_finished
• defis_persistent
• asyncon_error
• asyncon_timeout
• defremove_item
• defstop
• asyncwait

class nextcord.ui.View(*, timeout=180.0, auto_defer=True, prevent_update=True)

Represents a UI view.

This object must be inherited to create a UI within Discord.

Added in version 2.0.

Parameters:

• timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

• auto_defer (bool = True) – Whether or not to automatically defer the component interaction when the callback completes without responding to the interaction. Set this to False if you want to handle view interactions outside of the callback.

timeout

Timeout from last interaction with the UI before no longer accepting input. If None then there is no timeout.

Type:

Optional[float]

children

The list of children attached to this view.

Type:

List[Item]

auto_defer

Whether or not to automatically defer the component interaction when the callback completes without responding to the interaction. Set this to False if you want to handle view interactions outside of the callback.

Type:

bool = True

prevent_update

This option only affects persistent views. Whether or not to store the view separately for each message. The stored views are not automatically cleared, and can cause issues if you run the bot continously for long periods of time if views are not properly stopped. Setting this to False will force the client to find a persistent view added with Bot.add_view and not store the view separately.

Type:

bool = True

classmethod from_message(message, /, *, timeout=180.0)

Converts a message’s components into a View.

The Message.components of a message are read-only and separate types from those in the nextcord.ui namespace. In order to modify and edit message components they must be converted into a View first.

Parameters:

• message (nextcord.Message) – The message with components to convert into a view.

• timeout (Optional[float]) – The timeout of the converted view.

Returns:

The converted view. This always returns a View and not one of its subclasses.

Return type:

View

add_item(item)

Adds an item to the view.

Parameters:

item (Item) – The item to add to the view.

Raises:

• TypeError – An Item was not passed.

• ValueError – Maximum number of children has been exceeded (25) or the row the item is trying to be added to is full.

remove_item(item)

Removes an item from the view.

Parameters:

item (Item) – The item to remove from the view.

clear_items()

Removes all items from the view.

await interaction_check(interaction)

This function is a coroutine.

A callback that is called when an interaction happens within the view that checks whether the view should process item callbacks for the interaction.

This is useful to override if, for example, you want to ensure that the interaction author is a given user.

The default implementation of this returns True.

Note

If an exception occurs within the body then the check is considered a failure and on_error() is called.

Parameters:

interaction (Interaction) – The interaction that occurred.

Returns:

Whether the view children’s callbacks should be called.

Return type:

bool

await on_timeout()

This function is a coroutine.

A callback that is called when a view’s timeout elapses without being explicitly stopped.

await on_error(error, item, interaction)

This function is a coroutine.

A callback that is called when an item’s callback or interaction_check() fails with an error.

The default implementation prints the traceback to stderr.

Parameters:

• error (Exception) – The exception that was raised.

• item (Item) – The item that failed the dispatch.

• interaction (Interaction) – The interaction that led to the failure.

stop()

Stops listening to interaction events from this view.

This operation cannot be undone.

is_finished()

bool: Whether the view has finished interacting.

is_dispatching()

bool: Whether the view has been added for dispatching purposes.

is_persistent()

bool: Whether the view is set up as persistent.

A persistent view has all their components with a set custom_id and a timeout set to None.

await wait()

Waits until the view has finished interacting.

A view is considered finished when stop() is called or it times out.

Returns:

If True, then the view timed out. If False then the view finished normally.

Return type:

bool

Modal

Attributes

• auto_defer
• children
• custom_id
• timeout
• title

Methods

• defadd_item
• asynccallback
• defclear_items
• defis_dispatching
• defis_finished
• defis_persistent
• asyncon_error
• asyncon_timeout
• defremove_item
• defstop
• asyncwait

class nextcord.ui.Modal(title, *, timeout=None, custom_id=..., auto_defer=True)

Represents a Discord modal popup.

This object must be inherited to create a modal within Discord.

Added in version 2.0.

Parameters:

• title (str) – The title of the modal.

• timeout (Optional[float] = None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

• custom_id (str = MISSING) – The ID of the modal that gets received during an interaction. If the custom_id is MISSING, then a random custom_id is set.

• auto_defer (bool = True) – Whether or not to automatically defer the modal when the callback completes without responding to the interaction. Set this to False if you want to handle the modal interaction outside of the callback.

title

The title of the modal.

Type:

str

timeout

Timeout from last interaction with the UI before no longer accepting input. If None then there is no timeout.

Type:

Optional[float]

children

The list of children attached to this modal.

Type:

List[Item]

custom_id

The ID of the modal that gets received during an interaction.

Type:

str

auto_defer

Whether or not to automatically defer the modal when the callback completes without responding to the interaction. Set this to False if you want to handle the modal interaction outside of the callback.

Type:

bool = True

add_item(item)

Adds an item to the modal.

Parameters:

item (Item) –

The item to add to the modal.

Note

The only items that are currently supported are TextInputs.

Raises:

• TypeError – An Item was not passed.

• ValueError – The row the item is trying to be added to is full.

remove_item(item)

Removes an item from the modal.

Parameters:

item (Item) – The item to remove from the modal.

clear_items()

Removes all items from the modal.

await callback(interaction)

This function is a coroutine.

The callback that is called when the user press the submit button.

The default implementation does nothing and the user sees an error message on their screen, so you need to overwrite this function.

Parameters:

interaction (Interaction) – The interaction fired by the user.

await on_timeout()

This function is a coroutine.

A callback that is called when a modal’s timeout elapses without being explicitly stopped.

await on_error(error, interaction)

This function is a coroutine.

A callback that is called when an item’s callback or interaction_check() fails with an error.

The default implementation prints the traceback to stderr.

Parameters:

• error (Exception) – The exception that was raised.

• item (Item) – The item that failed the dispatch.

• interaction (Interaction) – The interaction that led to the failure.

stop()

Stops listening to interaction events from this modal.

This operation cannot be undone.

is_finished()

bool: Whether the modal has finished interacting.

is_dispatching()

bool: Whether the modal has been added for dispatching purposes.

is_persistent()

bool: Whether the modal is set up as persistent.

A persistent modal has a set custom_id and all their components with a set custom_id and a timeout set to None.

await wait()

Waits until the modal has finished interacting.

A modal is considered finished when stop() is called or it times out.

Returns:

If True, then the modal timed out. If False then the modal finished normally.

Return type:

bool

Item

Attributes

• view

Methods

• asynccallback

class nextcord.ui.Item

Represents the base UI item that all UI components inherit from.

The current UI items supported are:

• nextcord.ui.Button

• nextcord.ui.StringSelect

• nextcord.ui.TextInput

• nextcord.ui.UserSelect

• nextcord.ui.ChannelSelect

• nextcord.ui.RoleSelect

• nextcord.ui.MentionableSelect

Added in version 2.0.

property view

The underlying view for this item.

Type:

Optional[View]

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overridden by subclasses.

Parameters:

interaction (Interaction) – The interaction that triggered this UI item.

Button

Attributes

• custom_id
• disabled
• emoji
• label
• style
• url
• view

Methods

• asynccallback

class nextcord.ui.Button(*, style=ButtonStyle.secondary, label=None, disabled=False, custom_id=None, url=None, emoji=None, row=None)

Represents a UI button.

Added in version 2.0.

Parameters:

• style (nextcord.ButtonStyle) – The style of the button.

• custom_id (Optional[str]) – The ID of the button that gets received during an interaction. If this button is for a URL, it does not have a custom ID.

• url (Optional[str]) – The URL this button sends you to.

• disabled (bool) – Whether the button is disabled or not.

• label (Optional[str]) – The label of the button, if any.

• emoji (Optional[Union[PartialEmoji, Emoji, str]]) – The emoji of the button, if available.

• row (Optional[int]) – The relative row this button belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

property style

The style of the button.

Type:

nextcord.ButtonStyle

property custom_id

The ID of the button that gets received during an interaction.

If this button is for a URL, it does not have a custom ID.

Type:

Optional[str]

property url

The URL this button sends you to.

Type:

Optional[str]

property disabled

Whether the button is disabled or not.

Type:

bool

property label

The label of the button, if available.

Type:

Optional[str]

property emoji

The emoji of the button, if available.

Type:

Optional[PartialEmoji]

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overridden by subclasses.

Parameters:

interaction (Interaction) – The interaction that triggered this UI item.

property view

The underlying view for this item.

Type:

Optional[View]

nextcord.ui.button(*, label=None, custom_id=None, disabled=False, style=ButtonStyle.secondary, emoji=None, row=None)

A decorator that attaches a button to a component.

The function being decorated should have three parameters, self representing the nextcord.ui.View, the nextcord.ui.Button being pressed and the nextcord.Interaction you receive.

Note

Buttons with a URL cannot be created with this function. Consider creating a Button manually instead. This is because buttons with a URL do not have a callback associated with them since Discord does not do any processing with it.

Parameters:

• label (Optional[str]) – The label of the button, if any.

• custom_id (Optional[str]) – The ID of the button that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• style (ButtonStyle) – The style of the button. Defaults to ButtonStyle.grey.

• disabled (bool) – Whether the button is disabled or not. Defaults to False.

• emoji (Optional[Union[str, Emoji, PartialEmoji]]) – The emoji of the button. This can be in string form or a PartialEmoji or a full Emoji.

• row (Optional[int]) – The relative row this button belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

TextInput

Attributes

• custom_id
• default_value
• label
• max_length
• min_length
• placeholder
• required
• style
• value
• view

Methods

• asynccallback

class nextcord.ui.TextInput(label, *, style=TextInputStyle.short, custom_id=..., row=None, min_length=0, max_length=4000, required=None, default_value=None, placeholder=None)

Represent a UI text input.

Added in version 2.0.

Parameters:

• label (str) – The label of the text input

• style (TextInputStyle) – The style of the text input. By default, the style is TextInputStyle.short, a one line input, but you can use TextInputStyle.paragraph, a multi line input.

• custom_id (Optional[str]) – The ID of the text input that get received during an interaction.

• row (Optional[int]) – The relative row this text input belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_length (Optional[int]) – The minimal length of the user’s input

• max_length (Optional[int]) – The maximal length of the user’s input

• required (Optional[bool]) – If True, the user cannot send the form without filling this field.

• default_value (Optional[str]) – The value already in the input when the user open the form.

• placeholder (Optional[str]) – The text shown to the user when the text input is empty.

property style

The style of the text input.

Type:

nextcord.TextInputStyle

property custom_id

The ID of the text input that gets received during an interaction.

Type:

Optional[str]

property label

The label of the text input.

Type:

str

property min_length

The minimum input length for a text input

Type:

int

property max_length

The maximum input length for a text input

Type:

int

property required

Whether this component is required to be filled

Type:

bool

property default_value

The value already in the text input when the user open the form.

Type:

Optional[str]

property value

The value sent by the user. This field is updated when an interaction is received. TextInput.value is None when no interaction where received.

Type:

Optional[str]

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overridden by subclasses.

Parameters:

interaction (Interaction) – The interaction that triggered this UI item.

property placeholder

The text shown to the user when the text input is empty.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

StringSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• options
• placeholder
• values
• view

Methods

• defadd_option
• defappend_option
• asynccallback

class nextcord.ui.StringSelect(*, custom_id=..., placeholder=None, min_values=1, max_values=1, options=..., disabled=False, row=None)

Represents a UI string select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use StringSelect.values.

There is an alias for this class called Select.

Added in version 2.0.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• options (List[SelectOption]) – A list of options that can be selected in this menu.

• disabled (bool) – Whether the select is disabled or not.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

property options

A list of options that can be selected in this menu.

Type:

List[SelectOption]

add_option(*, label, value=..., description=None, emoji=None, default=False)

Adds an option to the select menu.

To append a pre-existing SelectOption use the append_option() method instead.

Parameters:

• label (str) – The label of the option. This is displayed to users. Can only be up to 100 characters.

• value (str) – The value of the option. This is not displayed to users. If not given, defaults to the label. Can only be up to 100 characters.

• description (Optional[str]) – An additional description of the option, if any. Can only be up to 100 characters.

• emoji (Optional[Union[str, Emoji, PartialEmoji]]) – The emoji of the option, if available. This can either be a string representing the custom or unicode emoji or an instance of PartialEmoji or Emoji.

• default (bool) – Whether this option is selected by default.

Raises:

ValueError – The number of options exceeds 25.

append_option(option)

Appends an option to the select menu.

Parameters:

option (SelectOption) – The option to append to the select menu.

Raises:

ValueError – The number of options exceeds 25.

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overridden by subclasses.

Parameters:

interaction (Interaction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select is disabled or not.

Type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property values

A list of values that have been selected by the user.

Type:

List[str]

property view

The underlying view for this item.

Type:

Optional[View]

nextcord.ui.string_select(*, placeholder=None, custom_id=..., min_values=1, max_values=1, options=..., disabled=False, row=None)

A decorator that attaches a string select menu to a component.

There is an alias for this function called select.

The function being decorated should have three parameters, self representing the ui.View, the ui.StringSelect being pressed and the Interaction you receive.

In order to get the selected items that the user has chosen within the callback use StringSelect.values.

Parameters:

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• options (List[SelectOption]) – A list of options that can be selected in this menu.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

nextcord.ui.Select

alias of StringSelect

nextcord.ui.select(*, placeholder=None, custom_id=..., min_values=1, max_values=1, options=..., disabled=False, row=None)

alias of string_select()

UserSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder
• values
• view

Methods

• asynccallback

class nextcord.ui.UserSelect(*, custom_id=None, placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

Represents a UI user select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use UserSelect.values.

Added in version 2.3.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

property values

A list of Union[Member, nextcord.User] that have been selected by the user.

Type:

ui.UserSelectValues

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overridden by subclasses.

Parameters:

interaction (Interaction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select is disabled or not.

Type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

nextcord.ui.user_select(*, placeholder=None, custom_id=..., min_values=1, max_values=1, disabled=False, row=None)

A decorator that attaches a user select menu to a component.

The function being decorated should have three parameters, self representing the ui.View, the ui.UserSelect being pressed and the Interaction you receive.

In order to get the selected items that the user has chosen within the callback use UserSelect.values.

Added in version 2.3.

Parameters:

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

class nextcord.ui.UserSelectValues

Represents the values of a ui.UserSelect.

property members

A list of members that were selected.

Type:

List[Member]

property users

A list of users that were selected.

Type:

List[nextcord.User]

RoleSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder
• values
• view

Methods

• asynccallback

class nextcord.ui.RoleSelect(*, custom_id=None, placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

Represents a UI role select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use RoleSelect.values.

Added in version 2.3.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

property values

A list of Role that have been selected by the user.

Type:

ui.RoleSelectValues

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overridden by subclasses.

Parameters:

interaction (Interaction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select is disabled or not.

Type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

nextcord.ui.role_select(*, placeholder=None, custom_id=..., min_values=1, max_values=1, disabled=False, row=None)

A decorator that attaches a role select menu to a component.

The function being decorated should have three parameters, self representing the ui.View, the ui.RoleSelect being pressed and the Interaction you receive.

In order to get the selected items that the user has chosen within the callback use RoleSelect.values.

Added in version 2.3.

Parameters:

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

class nextcord.ui.RoleSelectValues

Represents the values of a ui.RoleSelect.

property roles

The roles that were selected.

Type:

List[Role]

MentionableSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder
• values
• view

Methods

• asynccallback

class nextcord.ui.MentionableSelect(*, custom_id=None, placeholder=None, min_values=1, max_values=1, disabled=False, row=None)

Represents a UI mentionable select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use MentionableSelect.values.

Added in version 2.3.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

property values

A list of Union[Member, nextcord.User, Role] that have been selected by the user.

Type:

ui.MentionableSelectValues

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overridden by subclasses.

Parameters:

interaction (Interaction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select is disabled or not.

Type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

nextcord.ui.mentionable_select(*, placeholder=None, custom_id=..., min_values=1, max_values=1, disabled=False, row=None)

A decorator that attaches a mentionable select menu to a component.

The function being decorated should have three parameters, self representing the ui.View, the ui.MentionableSelect being pressed and the Interaction you receive.

In order to get the selected items that the user has chosen within the callback use MentionableSelect.values.

Added in version 2.3.

Parameters:

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

class nextcord.ui.MentionableSelectValues

Represents the values of a ui.MentionableSelect.

property members

A list of members that were selected.

Type:

List[Member]

property users

A list of users that were selected.

Type:

List[nextcord.User]

property roles

A list of roles that were selected.

Type:

List[Role]

ChannelSelect

Attributes

• custom_id
• disabled
• max_values
• min_values
• placeholder
• values
• view

Methods

• asynccallback

class nextcord.ui.ChannelSelect(*, custom_id=None, placeholder=None, min_values=1, max_values=1, disabled=False, row=None, channel_types=...)

Represents a UI channel select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use ChannelSelect.values.

Added in version 2.3.

Parameters:

• custom_id (str) – The ID of the select menu that gets received during an interaction. If not given then one is generated for you.

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• channel_types (List[ChannelType]) – The types of channels that can be selected. If not given, all channel types are allowed.

property values

A list of resolved abc.GuildChannel that have been selected by the user.

Type:

ui.ChannelSelectValues

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overridden by subclasses.

Parameters:

interaction (Interaction) – The interaction that triggered this UI item.

property custom_id

The ID of the select menu that gets received during an interaction.

Type:

str

property disabled

Whether the select is disabled or not.

Type:

bool

property max_values

The maximum number of items that must be chosen for this select menu.

Type:

int

property min_values

The minimum number of items that must be chosen for this select menu.

Type:

int

property placeholder

The placeholder text that is shown if nothing is selected, if any.

Type:

Optional[str]

property view

The underlying view for this item.

Type:

Optional[View]

nextcord.ui.channel_select(*, placeholder=None, custom_id=..., min_values=1, max_values=1, disabled=False, row=None, channel_types=...)

A decorator that attaches a channel select menu to a component.

The function being decorated should have three parameters, self representing the ui.View, the ui.ChannelSelect being pressed and the Interaction you receive.

In order to get the selected items that the user has chosen within the callback use ChannelSelect.values.

Added in version 2.3.

Parameters:

• placeholder (Optional[str]) – The placeholder text that is shown if nothing is selected, if any.

• custom_id (str) – The ID of the select menu that gets received during an interaction. It is recommended not to set this parameter to prevent conflicts.

• row (Optional[int]) – The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).

• min_values (int) – The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• max_values (int) – The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

• disabled (bool) – Whether the select is disabled or not. Defaults to False.

• channel_types (List[ChannelType]) – A list of channel types that can be selected in this menu.

class nextcord.ui.ChannelSelectValues

Represents the values of a ui.ChannelSelect.

property channels

The resolved channels.

Type:

List[abc.GuildChannel]

Low Level UI Components

These are relatively simple representations of Discord’s Component objects, able to be directly instantiated and sent with messages. While there are helper functions to aid with usage, they are intended to be rather bare and thus there are almost no safe guards nor data validation checks when creating or sending them. Higher level/friendlier UI Component objects can be found in the Bot UI Kit section.

Base Components

Base component classes. Not intended to be instantiated by users, but can be used for isinstance() checks.

Attributes

• id
• type

class nextcord.Component(*, component_type, component_id=...)

Represents a basic component object.

Base class for all components. Intended to be abstract and not instantiated by users, but will be used internally if no other component class is available.

Added in version 2.0.

Changed in version 3.2:

• Component is now user init-able.

• Added id attribute.

Parameters:

• component_type – Type of the component.

• component_id – Per-message unique ID of the component. If not provided, it will be generated by Discord when sent.

type

The type of component.

id

ID of the component. Can be MISSING.

Attributes

• custom_id
• id
• type

Methods

• asyncwait_for_interaction

class nextcord.InteractiveComponent(custom_id=..., *, component_type, component_id=...)

Bases: Component

Base class for components with the custom_id attribute and should have callback-related helper methods.

This class is intended to be abstract and not instantiated by users.

Added in version 3.2.

custom_id

Custom ID of the component, received in Interaction data. Can be MISSING

await wait_for_interaction(bot, callback, timeout=180.0)

This function is a coroutine.

Helper method, waits for an interaction with the matching custom_id to be received by the given bot/Client.

Parameters:

• bot – Bot/Client object to listen for received interactions.

• callback – Awaitable callback to execute when the custom ID is found.

• timeout – Time in seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns the return value of the given callback.

Return type:

Any

type

The type of component.

id

ID of the component. Can be MISSING.

Attributes

• components
• id
• type

class nextcord.HolderComponent(components, *, component_type, component_id=...)

Bases: Component

Base class for components with the components attribute that are designed to hold other components.

This class is intended to be abstract and not instantiated by users.

Added in version 3.2.

components

List of child components.

type

The type of component.

id

ID of the component. Can be MISSING.

Action Row

Attributes

• children
• components
• id
• type

class nextcord.ActionRow(components, *, component_id=...)

Bases: HolderComponent

Represents an Action Row component object.

This is a component that holds up to 5 children components in a row.

Added in version 2.0.

Changed in version 3.2: ActionRow is now user init-able.

property children

The children components that this holds, if any. Alias for components.

components

List of child components.

type

The type of component.

id

ID of the component. Can be MISSING.

Button

Attributes

• custom_id
• disabled
• emoji
• id
• label
• sku_id
• style
• type
• url

Methods

• clsButton.as_danger
• clsButton.as_link
• clsButton.as_premium
• clsButton.as_primary
• clsButton.as_secondary
• clsButton.as_success
• asyncwait_for_interaction

class nextcord.Button(style, *, label=..., emoji=..., custom_id=..., sku_id=..., url=..., disabled=..., component_id=...)

Bases: InteractiveComponent

Represents a Button component object.

Note

Due to the conflicting options present in __init__, it is recommended to use the various classmethods such as as_primary(), as_secondary(), etc.

Added in version 2.0.

Changed in version 3.2: Button is now user init-able.

style

The style of the button.

label

The label of the button. Can be MISSING.

emoji

The emoji of the button. Can be MISSING.

sku_id

ID of a purchasable SKU, only for premium-style buttons. Can be MISSING.

url

The URL this button sends you to, only for link-style buttons. Can be MISSING.

disabled

Whether the button is disabled or not. Can be MISSING.

await wait_for_interaction(bot, callback, timeout=180.0)

This function is a coroutine.

Helper method, waits for an interaction with the matching custom_id to be received by the given bot/Client.

Parameters:

• bot – Bot/Client object to listen for received interactions.

• callback – Awaitable callback to execute when the custom ID is found.

• timeout – Time in seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns the return value of the given callback.

Return type:

Any

classmethod as_primary(custom_id=None, *, label=..., emoji=..., disabled=..., component_id=...)

Creates a primary-styled button.

Unspecified parameters will use Discord defaults.

Parameters:

• custom_id – Optionally supplied custom ID for the button.

• label – Text to display on the button. Required unless emoji is specified.

• emoji – Emoji to display on the button. Required unless label is specified.

• disabled – Whether the button should be disabled or not.

• component_id – ID of the component.

Returns:

Button with the primary style.

Return type:

Button

classmethod as_secondary(custom_id=None, *, label=..., emoji=..., disabled=..., component_id=...)

Creates a secondary-styled button.

Unspecified parameters will use Discord defaults.

Parameters:

• custom_id – Optionally supplied custom ID for the button.

• label – Text to display on the button. Required unless emoji is specified.

• emoji – Emoji to display on the button. Required unless label is specified.

• disabled – Whether the button should be disabled or not.

• component_id – ID of the component.

Returns:

Button with the secondary style.

Return type:

Button

classmethod as_success(custom_id=None, *, label=..., emoji=..., disabled=..., component_id=...)

Creates a success-styled button.

Unspecified parameters will use Discord defaults.

Parameters:

• custom_id – Optionally supplied custom ID for the button.

• label – Text to display on the button. Required unless emoji is specified.

• emoji – Emoji to display on the button. Required unless label is specified.

• disabled – Whether the button should be disabled or not.

• component_id – ID of the component.

Returns:

Button with the success style.

Return type:

Button

classmethod as_danger(custom_id=None, *, label=..., emoji=..., disabled=..., component_id=...)

Creates a danger-styled button.

Unspecified parameters will use Discord defaults.

Parameters:

• custom_id – Optionally supplied custom ID for the button.

• label – Text to display on the button. Required unless emoji is specified.

• emoji – Emoji to display on the button. Required unless label is specified.

• disabled – Whether the button should be disabled or not.

• component_id – ID of the component.

Returns:

Button with the danger style.

Return type:

Button

classmethod as_link(url, *, label=..., emoji=..., disabled=..., component_id=...)

Creates a link-styled button.

Unspecified non-required parameters will use Discord defaults.

Parameters:

• url – The URL the button should send you to.

• label – Text to display on the button. Required unless emoji is specified.

• emoji – Emoji to display on the button. Required unless label is specified.

• disabled – Whether the button should be disabled or not.

• component_id – ID of the component.

Returns:

Button with the link style.

Return type:

Button

classmethod as_premium(sku_id, *, disabled=..., component_id=...)

Creates a premium-styled button.

Unspecified non-required parameters will use Discord defaults.

Parameters:

• sku_id – ID of a purchasable SKU.

• disabled – Whether the button should be disabled or not.

• component_id – ID of the component.

Returns:

Button with the premium style.

Return type:

Button

custom_id

Custom ID of the component, received in Interaction data. Can be MISSING

type

The type of component.

id

ID of the component. Can be MISSING.

String Select

Attributes

• custom_id
• disabled
• id
• max_values
• min_values
• options
• placeholder
• type

Methods

• defadd_option
• asyncwait_for_interaction

class nextcord.StringSelect(custom_id=None, options=None, *, placeholder=..., min_values=..., max_values=..., disabled=..., component_id=...)

Bases: InteractiveComponent

Represents a String Select component object.

A select menu is functionally the same as a dropdown, however on mobile it renders a bit differently.

There are 2 aliases for this class. StringSelectMenu for compatibility purposes and SelectMenu.

Added in version 2.0.

Changed in version 3.2:

• StringSelect is now user init-able.

• Renamed from StringSelectMenu to StringSelect to match Discord’s name, and an alias for the old name added.

options

A list of options that can be selected in this menu.

placeholder

The placeholder text that is shown if nothing is selected, if any. Can be MISSING

min_values

The minimum number of items that must be chosen for this select menu. Can be MISSING

max_values

The maximum number of items that must be chosen for this select menu. Can be MISSING

disabled

Whether the select is disabled or not. Can be MISSING

add_option(label, value=..., *, description=..., emoji=..., default=...)

Helper method to add an option to the options list.

Parameters:

• label – User-facing name of the option.

• value – Dev-defined/Bot-facing value of the option. Defaults to the value of label if unspecified.

• description – Description for the option.

• emoji – Emoji to display with the option.

• default – If this option will be selected by default.

Return type:

None

await wait_for_interaction(bot, callback, timeout=180.0)

This function is a coroutine.

Helper method, waits for an interaction with the matching custom_id to be received by the given bot/Client.

Parameters:

• bot – Bot/Client object to listen for received interactions.

• callback – Awaitable callback to execute when the custom ID is found.

• timeout – Time in seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns the return value of the given callback.

Return type:

Any

custom_id

Custom ID of the component, received in Interaction data. Can be MISSING

type

The type of component.

id

ID of the component. Can be MISSING.

Text Input

Attributes

• custom_id
• id
• label
• max_length
• min_length
• placeholder
• required
• style
• type
• value

Methods

• clsTextInput.as_paragraph
• clsTextInput.as_short
• asyncwait_for_interaction

class nextcord.TextInput(style, label, custom_id=None, *, min_length=..., max_length=..., required=..., value=..., placeholder=..., component_id=...)

Bases: InteractiveComponent

Represents a Text Input component object.

Allows for users to enter free-form text responses, and supports both single-line and multi-line inputs. Can only be used within modals.

Added in version 2.0.

Changed in version 3.2: TextInput is now user init-able.

style

Style of the text input.

label

Label of the text input.

min_length

The minimal length of the user’s input. Can be MISSING.

max_length

The maximal length of the user’s input. Can be MISSING.

required

If True, the user cannot send the form without filling this field. Can be MISSING.

value

Pre-filled value for the component. Can be MISSING.

placeholder

The text shown to the user when the text input is empty. Can be MISSING.

classmethod as_short(label, custom_id=None, *, min_length=..., max_length=..., required=..., value=..., placeholder=..., component_id=...)

Creates a short-styled, single-line text input.

Unspecified non-required parameters will use Discord defaults.

Parameters:

• label – Label of the text input.

• custom_id – Optionally supplied custom ID for the text input.

• min_length – The minimal length of the user’s input.

• max_length – The maximal length of the user’s input.

• required – If True, the user cannot send the form without filling this field.

• value – Pre-filled value for the component.

• placeholder – The text shown to the user when the text input is empty.

• component_id – ID of the component.

Returns:

Text input with the short style.

Return type:

TextInput

classmethod as_paragraph(label, custom_id=None, *, min_length=..., max_length=..., required=..., value=..., placeholder=..., component_id=...)

Creates a paragraph-styled, multi-line text input.

Unspecified non-required parameters will use Discord defaults.

Parameters:

• label – Label of the text input.

• custom_id – Optionally supplied custom ID for the text input.

• min_length – The minimal length of the user’s input.

• max_length – The maximal length of the user’s input.

• required – If True, the user cannot send the form without filling this field.

• value – Pre-filled value for the component.

• placeholder – The text shown to the user when the text input is empty.

• component_id – ID of the component.

Returns:

Text input with the paragraph style.

Return type:

TextInput

await wait_for_interaction(bot, callback, timeout=180.0)

This function is a coroutine.

Helper method, waits for an interaction with the matching custom_id to be received by the given bot/Client.

Parameters:

• bot – Bot/Client object to listen for received interactions.

• callback – Awaitable callback to execute when the custom ID is found.

• timeout – Time in seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns the return value of the given callback.

Return type:

Any

custom_id

Custom ID of the component, received in Interaction data. Can be MISSING

type

The type of component.

id

ID of the component. Can be MISSING.

User Select

Attributes

• custom_id
• default_values
• disabled
• id
• max_values
• min_values
• placeholder
• type

Methods

• defadd_default_value
• asyncwait_for_interaction

class nextcord.UserSelect(custom_id=None, *, placeholder=..., default_values=..., min_values=..., max_values=..., disabled=..., component_id=...)

Bases: _SelectComponent

Represents a User Select component object.

A user select menu is functionally the same as a dropdown, however on mobile it renders a bit differently.

Added in version 2.3.

Changed in version 3.2:

• UserSelect is now user init-able.

• Renamed from UserSelectMenu to UserSelect to match Discord’s name, and an alias for the old name added.

• Added default_values attribute.

add_default_value(value_id, value_type=SelectDefaultValueType.user)

Adds a default value to be pre-populated in the Select dropdown of the given ID and type.

await wait_for_interaction(bot, callback, timeout=180.0)

This function is a coroutine.

Helper method, waits for an interaction with the matching custom_id to be received by the given bot/Client.

Parameters:

• bot – Bot/Client object to listen for received interactions.

• callback – Awaitable callback to execute when the custom ID is found.

• timeout – Time in seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns the return value of the given callback.

Return type:

Any

placeholder

Placeholder text if nothing is selected. Can be MISSING.

default_values

List of pre-populated values. Can be MISSING.

min_values

Minimum amount of chosen values. Can be MISSING.

max_values

Maximum amount of chosen values. Can be MISSING.

disabled

If the menu is disabled. Can be MISSING.

custom_id

Custom ID of the component, received in Interaction data. Can be MISSING

type

The type of component.

id

ID of the component. Can be MISSING.

Role Select

Attributes

• custom_id
• default_values
• disabled
• id
• max_values
• min_values
• placeholder
• type

Methods

• defadd_default_value
• asyncwait_for_interaction

class nextcord.RoleSelect(custom_id=None, *, placeholder=..., default_values=..., min_values=..., max_values=..., disabled=..., component_id=...)

Bases: _SelectComponent

Represents a Role Select component object.

A role select menu is functionally the same as a dropdown, however on mobile it renders a bit differently.

Added in version 2.3.

Changed in version 3.2:

• RoleSelect is now user init-able.

• Renamed from RoleSelectMenu to RoleSelect to match Discord’s name, and an alias for the old name added.

• Added default_values attribute.

add_default_value(value_id, value_type=SelectDefaultValueType.role)

Adds a default value to be pre-populated in the Select dropdown of the given ID and type.

await wait_for_interaction(bot, callback, timeout=180.0)

This function is a coroutine.

Helper method, waits for an interaction with the matching custom_id to be received by the given bot/Client.

Parameters:

• bot – Bot/Client object to listen for received interactions.

• callback – Awaitable callback to execute when the custom ID is found.

• timeout – Time in seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns the return value of the given callback.

Return type:

Any

placeholder

Placeholder text if nothing is selected. Can be MISSING.

default_values

List of pre-populated values. Can be MISSING.

min_values

Minimum amount of chosen values. Can be MISSING.

max_values

Maximum amount of chosen values. Can be MISSING.

disabled

If the menu is disabled. Can be MISSING.

custom_id

Custom ID of the component, received in Interaction data. Can be MISSING

type

The type of component.

id

ID of the component. Can be MISSING.

Mentionable Select

Attributes

• custom_id
• default_values
• disabled
• id
• max_values
• min_values
• placeholder
• type

Methods

• defadd_default_value
• asyncwait_for_interaction

class nextcord.MentionableSelect(custom_id=None, *, placeholder=..., default_values=..., min_values=..., max_values=..., disabled=..., component_id=...)

Bases: _SelectComponent

Represents a Mentionable Select componeont object.

A mentionable select menu is functionally the same as a dropdown, however on mobile it renders a bit differently.

Added in version 2.3.

Changed in version 3.2:

• MentionableSelect is now user init-able.

• Renamed from MentionableSelectMenu to MentionableSelect to match Discord’s name, and an alias for the old name added.

• Added default_values attribute.

add_default_value(value_id, value_type)

Adds a default value to be pre-populated in the Select dropdown of the given ID and type.

await wait_for_interaction(bot, callback, timeout=180.0)

This function is a coroutine.

Helper method, waits for an interaction with the matching custom_id to be received by the given bot/Client.

Parameters:

• bot – Bot/Client object to listen for received interactions.

• callback – Awaitable callback to execute when the custom ID is found.

• timeout – Time in seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns the return value of the given callback.

Return type:

Any

placeholder

Placeholder text if nothing is selected. Can be MISSING.

default_values

List of pre-populated values. Can be MISSING.

min_values

Minimum amount of chosen values. Can be MISSING.

max_values

Maximum amount of chosen values. Can be MISSING.

disabled

If the menu is disabled. Can be MISSING.

custom_id

Custom ID of the component, received in Interaction data. Can be MISSING

type

The type of component.

id

ID of the component. Can be MISSING.

Channel Select

Attributes

• channel_types
• custom_id
• default_values
• disabled
• id
• max_values
• min_values
• placeholder
• type

Methods

• defadd_default_value
• asyncwait_for_interaction

class nextcord.ChannelSelect(custom_id=None, *, channel_types=..., placeholder=..., default_values=..., min_values=..., max_values=..., disabled=..., component_id=...)

Bases: _SelectComponent

Represents a Channel Select component object.

A channel select menu is functionally the same as a dropdown, however on mobile it renders a bit differently.

Added in version 2.3.

Changed in version 3.2:

• ChannelSelect is now user init-able.

• Renamed from ChannelSelectMenu to ChannelSelect to match Discord’s name, and an alias for the old name added.

• Added default_values attribute.

channel_types

The types of channels that can be selected. If MISSING, all channel types are allowed.

add_default_value(value_id, value_type=SelectDefaultValueType.channel)

Adds a default value to be pre-populated in the Select dropdown of the given ID and type.

await wait_for_interaction(bot, callback, timeout=180.0)

This function is a coroutine.

Helper method, waits for an interaction with the matching custom_id to be received by the given bot/Client.

Parameters:

• bot – Bot/Client object to listen for received interactions.

• callback – Awaitable callback to execute when the custom ID is found.

• timeout – Time in seconds to wait before timing out and raising asyncio.TimeoutError.

Raises:

asyncio.TimeoutError – If a timeout is provided and it was reached.

Returns:

Returns the return value of the given callback.

Return type:

Any

placeholder

Placeholder text if nothing is selected. Can be MISSING.

default_values

List of pre-populated values. Can be MISSING.

min_values

Minimum amount of chosen values. Can be MISSING.

max_values

Maximum amount of chosen values. Can be MISSING.

disabled

If the menu is disabled. Can be MISSING.

custom_id

Custom ID of the component, received in Interaction data. Can be MISSING

type

The type of component.

id

ID of the component. Can be MISSING.

Section

Attributes

• accessory
• components
• id
• type

class nextcord.Section(accessory, components, *, component_id=...)

Bases: HolderComponent

Represents a Section component object.

Holds up to 3 TextDisplay components, with a single Button or Thumbnail accessory displayed to the side.

Added in version 3.2.

Parameters:

• accessory (nextcord.components.Component) – Component to display on the side. Currently, Discord only supports Button or Thumbnail components to be used as accessories.

• components (list[nextcord.components.TextDisplay | nextcord.components.Component]) – List of components to be primarily displayed. Currently, Discord only supports up to 3 TextDisplay components to be used.

• component_id – Per-message unique ID of the component. If not provided, it will be generated by Discord when sent.

components

List of components to be primarily displayed.

accessory

Component displayed to the side.

type

The type of component.

id

ID of the component. Can be MISSING.

Text Display

Attributes

• content
• id
• type

class nextcord.TextDisplay(content, *, component_id=...)

Bases: Component

Represents a Text Display component object.

Allows you to add text to your component message, supporting markdown and user + role mentions.

Added in version 3.2.

Parameters:

• content (str) – Text to be displayed.

• component_id – Per-message unique ID of the component. If not provided, it will be generated by Discord when sent.

content

Text to be displayed.

type

The type of component.

id

ID of the component. Can be MISSING.

Thumbnail

Attributes

• description
• id
• media
• spoiler
• type

Methods

• clsThumbnail.from_url

class nextcord.Thumbnail(media, *, description=..., spoiler=..., component_id=...)

Bases: Component

Represents a Thumbnail component object.

Displays a small image, currently only usable in a Section component as the accessory.

Added in version 3.2.

Parameters:

• media (nextcord.components.UnfurledMedia) – Media to be displayed.

• description (str) – Alt text for the media.

• spoiler (bool) – Whether the media should be spoilered/blurred out.

• component_id – Per-message unique ID of the component. If not provided, it will be generated by Discord when sent.

type

The type of component.

id

ID of the component. Can be MISSING.

media

Media to be displayed.

description

Alt text for the media. Can be MISSING

spoiler

Whether the media should be spoilered/blurred out. Can be MISSING

classmethod from_url(url, *, description=..., spoiler=..., component_id=...)

Simple helper method, inits this with an UnfurledMedia set to the given url.

Media Gallery

Attributes

• id
• items
• type

class nextcord.MediaGallery(items, *, component_id=...)

Bases: Component

Represents a Media Gallery component object.

Allows displaying between 1 and 10 MediaGalleryItem attachments in an organized gallery format.

Added in version 3.2.

Parameters:

• items (list[nextcord.components.MediaGalleryItem]) – List of items to display in the gallery.

• component_id – Per-message unique ID of the component. If not provided, it will be generated by Discord when sent.

type

The type of component.

id

ID of the component. Can be MISSING.

items

List of MediaGalleryItem objects to display.

File Display

Attributes

• file
• id
• spoiler
• type

Methods

• clsFileDisplay.from_file
• clsFileDisplay.from_url

class nextcord.FileDisplay(file, *, spoiler=..., component_id=...)

Bases: Component

Represents a File component object.

Allows referencing/displaying a file that was uploaded as an attachment to the message.

Added in version 3.2.

Parameters:

• file (nextcord.components.UnfurledMedia) – Attachment/media to be displayed, only supports attachment://<filename> style references.

• spoiler (bool) – Whether the media should be spoilered/blurred out.

• component_id – Per-message unique ID of the component. If not provided, it will be generated by Discord when sent.

type

The type of component.

id

ID of the component. Can be MISSING.

file

Attachment to be displayed.

spoiler

Whether the attachment should be spoilered/blurred out. Can be MISSING

classmethod from_url(url, *, spoiler=..., component_id=...)

Simple helper method, inits this with an UnfurledMedia set to the given url.

Must use the attachment://<filename> syntax

classmethod from_file(file, *, spoiler=..., component_id=...)

Simple helper method. inits this with a DiscordFile.

Separator

Attributes

• divider
• id
• spacing
• type

class nextcord.Separator(divider=..., spacing=..., *, component_id=...)

Bases: Component

Represents a Separator component object.

Adds vertical padding and optionally a visual divider between components.

Added in version 3.2.

Parameters:

• divider (bool) – Whether a visual divider should be displayed.

• spacing (nextcord.enums.SeparatorSpacingSize) – Size of the separator padding.

• component_id – Per-message unique ID of the component. If not provided, it will be generated by Discord when sent.

type

The type of component.

id

ID of the component. Can be MISSING.

divider

Whether a visual divider should be displayed. Can be MISSING

spacing

Size of the separator padding. Can be MISSING

Container

Attributes

• accent_color
• components
• id
• spoiler
• type

class nextcord.Container(components, accent_color=..., spoiler=..., *, component_id=...)

Bases: HolderComponent

Represents a Container component object.

Holds other components with a visually distinct background and can have an accent color on the side, similar to Embed objects.

Added in version 3.2.

Parameters:

• components (list[nextcord.components.Component]) – List of components to display.

• accent_color (int | None) – Accent color to display on the side.

• spoiler (bool) – Whether the container should be spoilered/blurred out.

• component_id – Per-message unique ID of the component. If not provided, it will be generated by Discord when sent.

components

List of child components.

type

The type of component.

id

ID of the component. Can be MISSING.

accent_color

Accent color displayed on the side. Can be MISSING

spoiler

Whether the container should be spoilered/blurred out. Can be MISSING

Component Data Objects

While these are not components, they are required to create/populate certain components. Components for components, if you will.

Attributes

• default
• description
• emoji
• label
• value

class nextcord.SelectOption(label, value=..., *, description=..., emoji=..., default=...)

Represents an option for the selects that use it.

Currently only used by StringSelect.

Added in version 2.0.

Parameters:

• label (str) – The label of the option. This is displayed to users. Can only be up to 100 characters.

• value (str) – The value of the option. This is not displayed to users. If not provided when constructed then it defaults to the label. Can only be up to 100 characters.

• description (str) – An additional description of the option, if any. Can only be up to 100 characters.

• emoji (nextcord.partial_emoji.PartialEmoji) – The emoji of the option, if available.

• default (bool) – Whether this option is selected by default.

label

User-facing name of the option.

value

Dev-defined/Bot-facing value of the option.

description

Description of the option. Can be MISSING

emoji

The emoji of the option. Can be MISSING

default

Whether this option is selected by default. Can be MISSING

Attributes

• id
• type

class nextcord.SelectDefaultValue(value_id, value_type)

Represents a default value for the selects that use it.

Used in UserSelect, RoleSelect, MentionableSelect, and ChannelSelect.

Added in version 3.2.

Parameters:

• value_id – ID/Snowflake of the default value.

• value_type – Type of object the value_id corresponds to.

id

ID/Snowflake

type

Type of object that id refers to.

Attributes

• attachment_id
• content_type
• height
• proxy_url
• url
• width

class nextcord.UnfurledMedia(url, *, proxy_url=..., height=..., width=..., content_type=..., attachment_id=...)

Represents a reference to some media.

The referenced media can either be an external link or an attachment included in the message.

Added in version 3.2.

Parameters:

url (str) – Source of the media. Can either be an arbitrary URL, or use the attachment://<filename> syntax to reference an included attachment.

url

Source of the media.

proxy_url

Proxy URL of the media, provided by Discord. Can be MISSING

height

Height of the media, provided by Discord. Can be MISSING

width

Width of the media, provided by Discord. Can be MISSING

content_type

Type of the media, provided by Discord. Can be MISSING

attachment_id

ID of the referenced attachment, provided by Discord if the media references an attachment. Can be MISSING

Attributes

• description
• media
• spoiler

Methods

• clsMediaGalleryItem.from_url

class nextcord.MediaGalleryItem(media, *, description=..., spoiler=...)

Represents an item in a MediaGallery component.

Essentially acts as a wrapper around UnfurledMedia with the ability to add a description and/or spoiler it.

Added in version 3.2.

Parameters:

• media (nextcord.components.UnfurledMedia) – Media to be displayed.

• description (str) – Alt text for the media.

• spoiler (bool) – Whether the media should be spoilered/blurred out.

media

Media to be displayed.

description

Alt text for the media. Can be MISSING

spoiler

Whether the media should be spoilered/blurred out. Can be MISSING

classmethod from_url(url, *, description=..., spoiler=...)

Simple helper method, inits this with an UnfurledMedia set to the given url.

Application Commands

The library has helpers to easily create and manipulate application commands.

Base Commands

Attributes

• checks
• cog_after_invoke
• cog_before_invoke
• command_ids
• contexts
• description
• error_name
• guild_ids
• integration_types
• is_global
• is_guild
• qualified_name
• required_bot_guild_permissions
• required_bot_permissions
• required_guild_permissions
• required_permissions

Methods

• defadd_check
• defadd_guild_rollout
• defafter_invoke
• defbefore_invoke
• asynccall
• asynccall_from_interaction
• asynccan_run
• deferror
• deffrom_callback
• defget_payload
• defget_rollout_signatures
• defget_signature
• defget_signatures
• defhas_error_handler
• asyncinvoke_callback
• asyncinvoke_callback_with_hooks
• asyncinvoke_error
• defis_interaction_valid
• defis_payload_valid
• defparse_discord_response
• defremove_check

class nextcord.BaseApplicationCommand(name=None, description=None, *, cmd_type, name_localizations=None, description_localizations=None, callback=None, guild_ids=..., default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, parent_cog=None, force_global=False)

Base class for all application commands.

checks

A list of predicates that verifies if the command could be executed with the given Interaction as the sole parameter. If an exception is necessary to be thrown to signal failure, then one inherited from ApplicationError should be used. Note that if the checks fail then ApplicationCheckFailure exception is raised to the on_application_command_error() event.

Type:

List[Union[Callable[[ClientCog, Interaction], MaybeCoro[bool]], Callable[[Interaction], MaybeCoro[bool]]]]

integration_types

Where the command is available, only for globally-scoped commands.

Added in version 3.0.

Type:

Optional[Iterable[Union[IntegrationType, int]]]

contexts

Where the command can be used, only for globally-scoped commands.

Added in version 3.0.

Type:

Optional[Iterable[Union[InteractionContextType, int]]]

command_ids

Dict[Optional[int], int]: Command IDs that this application command currently has. Schema: {Guild ID (None for global): command ID}

property required_permissions

Returns the permissions required to run this command.

Note

This returns the permissions set with ext.application_checks.has_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_bot_permissions

Returns the permissions the bot needs to run this command.

Note

This returns the permissions set with ext.application_checks.bot_has_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_guild_permissions

Returns the guild permissions needed to run this command.

Note

This returns the permissions set with ext.application_checks.has_guild_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_bot_guild_permissions

Returns the permissions the bot needs to have in this guild in order to run this command.

Note

This returns the permissions set with ext.application_checks.bot_has_guild_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property qualified_name

Retrieves the fully qualified command name.

Added in version 2.1.

Type:

str

property description

The description the command should have in Discord. Should be 1-100 characters long.

property is_guild

Returns True if this command is or should be registered to any guilds.

Type:

bool

property guild_ids

Returns a set containing all guild ID’s this command is registered to.

add_guild_rollout(guild)

Adds a Guild to the command to be rolled out to when the rollout is run.

Parameters:

guild (Union[int, Guild]) – Guild or Guild ID to add this command to roll out to.

property is_global

Returns True if this command is or should be a global command.

Type:

bool

get_signature(guild_id=None)

Returns a command signature with the given guild ID.

Parameters:

guild_id (Optional[None]) – Guild ID to make the signature for. If set to None, it acts as a global command signature.

Returns:

A tuple that acts as a signature made up of the name, type, and guild ID.

Return type:

Tuple[str, int, Optional[int]]

get_rollout_signatures()

Returns all signatures that this command wants to roll out to.

Command signatures are made up of the command name, command type, and Guild ID (None for global).

Returns:

A set of tuples that act as signatures.

Return type:

Set[Tuple[str, int, Optional[int]]]

get_signatures()

Returns all the signatures that this command has.

Command signatures are made up of the command name, command type, and Guild ID (None for global).

Returns:

A set of tuples that act as signatures.

Return type:

Set[Tuple[str, int, Optional[int]]]

get_payload(guild_id)

Makes an Application Command payload for this command to upsert to Discord with the given Guild ID.

Parameters:

guild_id (Optional[int]) – Guild ID that this payload is for. If set to None, it will be a global command payload instead.

Returns:

Dictionary payload to upsert to Discord.

Return type:

dict

parse_discord_response(state, data)

Parses the application command creation/update response from Discord.

Parameters:

• state (ConnectionState) – Connection state to use internally in the command.

• data (Union[ApplicationCommandInteractionData, ApplicationCommand]) – Raw dictionary data from Discord.

is_payload_valid(raw_payload, guild_id=None)

Checks if the given raw application command interaction payload from Discord is possibly valid for this command. Note that while this may return True for a given payload, that doesn’t mean that the payload is fully correct for this command. Discord doesn’t send data for parameters that are optional and aren’t supplied by the user.

Parameters:

• raw_payload (dict) – Application command interaction payload from Discord.

• guild_id (Optional[int]) – Guild ID that the payload is from. If it’s from a global command, this should be None

Returns:

True if the given payload is possibly valid for this command. False otherwise.

Return type:

bool

is_interaction_valid(interaction)

Checks if the interaction given is possibly valid for this command. If the command has more parameters (especially optionals) than the interaction coming in, this may cause a desync between your bot and Discord.

Parameters:

interaction (Interaction) – Interaction to validate.

Returns:

True If the interaction could possibly be for this command, False otherwise.

Return type:

bool

from_callback(callback=None, option_class=<class 'nextcord.application_command.BaseCommandOption'>)

Creates objects of type option_class with the parameters of the function, and stores them in the options attribute.

Parameters:

• callback (Optional[Callable]) – Callback to create options from. Must be a coroutine function.

• option_class (Optional[Type[BaseCommandOption]]) – Class to create the options using. Should either be or subclass BaseCommandOption. Defaults to BaseCommandOption.

Returns:

Self for possible chaining.

Return type:

CallbackMixin

await call_from_interaction(interaction)

This function is a coroutine. Calls the callback via the given Interaction, relying on the locally stored ConnectionState object.

Parameters:

interaction (Interaction) – Interaction corresponding to the use of the command.

await call(state, interaction)

This function is a coroutine. Calls the callback via the given Interaction, using the given ConnectionState to get resolved objects if needed and available.

Parameters:

• state (ConnectionState) – State object to get resolved objects from.

• interaction (Interaction) – Interaction corresponding to the use of the command.

add_check(func)

Adds a check to the application command. Returns the application command for method chaining.

Parameters:

func (ApplicationCheck) – The function that will be used as a check.

after_invoke(coro)

Sets the callback that should be run after the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the after_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

before_invoke(coro)

Sets the callback that should be run before the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the before_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

await can_run(interaction)

This function is a coroutine.

Checks if the command can be executed by checking all the predicates inside the checks attribute, as well as all global and cog checks.

Parameters:

interaction (Interaction) – The interaction of the command currently being invoked.

Raises:

ApplicationError – Any application command error that was raised during a check call will be propagated by this function.

Returns:

A boolean indicating if the command can be invoked.

Return type:

bool

property cog_after_invoke

Returns the cog_application_command_after_invoke method for the cog that this command is in.

Returns:

after_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

property cog_before_invoke

Returns the cog_application_command_before_invoke method for the cog that this command is in. Returns None if not the method is not found.

Returns:

before_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

error(callback)

Decorates a function, setting it as a callback to be called when a ApplicationError or any of its subclasses is raised inside the ApplicationCommand.

Parameters:

callback (Callable[[Interaction, ApplicationError], asyncio.Awaitable[Any]]) – The callback to call when an error occurs.

property error_name

Returns a string containing the class name, command name, and the callback to use in raising exceptions.

Examples

>>> print(app_cmd.error_name)
SlashApplicationCommand reloadme <function TinyTest.reloadme at 0x7f4b3b563e20>

Returns:

String containing the class name, command name, and callback object.

Return type:

str

has_error_handler()

bool: Checks whether the command has an error handler registered.

await invoke_callback(interaction, *args, **kwargs)

This function is a coroutine. Invokes the callback, injecting self if available.

await invoke_callback_with_hooks(state, interaction, args=None, kwargs=None)

This function is a coroutine. Invokes the callback with all hooks and checks.

await invoke_error(interaction, error)

This function is a coroutine. Invokes the error handler if available.

remove_check(func)

Removes a check from the ApplicationCommand. Returns the application command for method chaining.

This function is idempotent and will not raise an exception if the function is not in the command’s checks.

Parameters:

func (ApplicationCheck) – The function to remove from the checks.

Attributes

• functional_name

class nextcord.BaseCommandOption(parameter, command, parent_cog=None)

Represents an application command option, but takes a Parameter and ClientCog as an argument.

Parameters:

• parameter (Parameter) – Function parameter to construct the command option with.

• command (Union[BaseApplicationCommand, SlashApplicationSubcommand]) – Application Command this option is for.

• parent_cog (ClientCog) – Class that the function the option is for resides in.

functional_name

Name of the kwarg in the function/method

Slash Commands

Attributes

• children
• cog_after_invoke
• cog_before_invoke
• command_ids
• description
• error_name
• guild_ids
• is_global
• is_guild
• options
• qualified_name
• required_bot_guild_permissions
• required_bot_permissions
• required_guild_permissions
• required_permissions

Methods

• defadd_check
• defadd_guild_rollout
• defafter_invoke
• defbefore_invoke
• asynccall
• asynccall_autocomplete
• asynccall_autocomplete_from_interaction
• asynccall_from_interaction
• asynccan_run
• deferror
• deffrom_autocomplete
• deffrom_callback
• defget_mention
• defget_payload
• defget_rollout_signatures
• defget_signature
• defget_signatures
• defhas_error_handler
• asyncinvoke_callback
• asyncinvoke_callback_with_hooks
• asyncinvoke_error
• defis_interaction_valid
• defis_payload_valid
• defon_autocomplete
• defparse_discord_response
• defremove_check
• defsubcommand

class nextcord.SlashApplicationCommand(name=None, description=None, *, name_localizations=None, description_localizations=None, callback=None, guild_ids=None, default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, parent_cog=None, force_global=False)

Class representing a slash command.

property description

The description the command should have in Discord. Should be 1-100 characters long.

get_payload(guild_id)

Makes an Application Command payload for this command to upsert to Discord with the given Guild ID.

Parameters:

guild_id (Optional[int]) – Guild ID that this payload is for. If set to None, it will be a global command payload instead.

Returns:

Dictionary payload to upsert to Discord.

Return type:

dict

await call(state, interaction)

This function is a coroutine. Calls the callback via the given Interaction, using the given ConnectionState to get resolved objects if needed and available.

Parameters:

• state (ConnectionState) – State object to get resolved objects from.

• interaction (Interaction) – Interaction corresponding to the use of the command.

from_callback(callback=None, option_class=<class 'nextcord.application_command.SlashCommandOption'>, call_children=True)

Creates objects of type option_class with the parameters of the function, and stores them in the options attribute.

Parameters:

• callback (Optional[Callable]) – Callback to create options from. Must be a coroutine function.

• option_class (Optional[Type[BaseCommandOption]]) – Class to create the options using. Should either be or subclass BaseCommandOption. Defaults to BaseCommandOption.

Returns:

Self for possible chaining.

Return type:

CallbackMixin

subcommand(name=None, description=None, *, name_localizations=None, description_localizations=None, inherit_hooks=False)

Takes the decorated callback and turns it into a SlashApplicationSubcommand added as a subcommand.

Parameters:

• name (str) – Name of the command that users will see. If not set, it defaults to the name of the callback.

• description (str) – Description of the command that users will see. If not specified, the docstring will be used. If no docstring is found for the command callback, it defaults to “No description provided”.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the command for users of specific locales. The locale code should be the key, with the localized name as the value.

• description_localizations (Dict[Union[Locale, str], str]) – Description(s) of the subcommand for users of specific locales. The locale code should be the key, with the localized description as the value.

• inherit_hooks (bool) – If the subcommand should inherit the parent commands before_invoke and after_invoke callbacks. Defaults to False.

add_check(func)

Adds a check to the application command. Returns the application command for method chaining.

Parameters:

func (ApplicationCheck) – The function that will be used as a check.

add_guild_rollout(guild)

Adds a Guild to the command to be rolled out to when the rollout is run.

Parameters:

guild (Union[int, Guild]) – Guild or Guild ID to add this command to roll out to.

after_invoke(coro)

Sets the callback that should be run after the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the after_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

before_invoke(coro)

Sets the callback that should be run before the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the before_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

await call_autocomplete(state, interaction, option_data=None)

This function is a coroutine. Calls the autocomplete callback with the given interaction and option data.

await call_autocomplete_from_interaction(interaction)

This function is a coroutine. Calls the autocomplete callback with the given interaction.

await call_from_interaction(interaction)

This function is a coroutine. Calls the callback via the given Interaction, relying on the locally stored ConnectionState object.

Parameters:

interaction (Interaction) – Interaction corresponding to the use of the command.

await can_run(interaction)

This function is a coroutine.

Checks if the command can be executed by checking all the predicates inside the checks attribute, as well as all global and cog checks.

Parameters:

interaction (Interaction) – The interaction of the command currently being invoked.

Raises:

ApplicationError – Any application command error that was raised during a check call will be propagated by this function.

Returns:

A boolean indicating if the command can be invoked.

Return type:

bool

property children

Returns the sub-commands and sub-command groups of the command.

Changed in version 2.3: .children is now a read-only property.

property cog_after_invoke

Returns the cog_application_command_after_invoke method for the cog that this command is in.

Returns:

after_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

property cog_before_invoke

Returns the cog_application_command_before_invoke method for the cog that this command is in. Returns None if not the method is not found.

Returns:

before_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

error(callback)

Decorates a function, setting it as a callback to be called when a ApplicationError or any of its subclasses is raised inside the ApplicationCommand.

Parameters:

callback (Callable[[Interaction, ApplicationError], asyncio.Awaitable[Any]]) – The callback to call when an error occurs.

property error_name

Returns a string containing the class name, command name, and the callback to use in raising exceptions.

Examples

>>> print(app_cmd.error_name)
SlashApplicationCommand reloadme <function TinyTest.reloadme at 0x7f4b3b563e20>

Returns:

String containing the class name, command name, and callback object.

Return type:

str

from_autocomplete()

Processes the found autocomplete callbacks and associates them to their corresponding options.

Raises:

ValueError – If a found arg name doesn’t correspond to an autocomplete function.

get_mention(guild=None)

Returns a string that allows you to mention the slash command.

Added in version 2.2.

Parameters:

guild (Optional[Snowflake]) – The Guild of the command to mention. If None, then the global command will be mentioned.

Returns:

The string that allows you to mention the slash command.

Return type:

str

Raises:

ValueError – If no guild was provided and the command is not registered globally, or the command is not registered in the guild provided.

get_rollout_signatures()

Returns all signatures that this command wants to roll out to.

Command signatures are made up of the command name, command type, and Guild ID (None for global).

Returns:

A set of tuples that act as signatures.

Return type:

Set[Tuple[str, int, Optional[int]]]

get_signature(guild_id=None)

Returns a command signature with the given guild ID.

Parameters:

guild_id (Optional[None]) – Guild ID to make the signature for. If set to None, it acts as a global command signature.

Returns:

A tuple that acts as a signature made up of the name, type, and guild ID.

Return type:

Tuple[str, int, Optional[int]]

get_signatures()

Returns all the signatures that this command has.

Command signatures are made up of the command name, command type, and Guild ID (None for global).

Returns:

A set of tuples that act as signatures.

Return type:

Set[Tuple[str, int, Optional[int]]]

property guild_ids

Returns a set containing all guild ID’s this command is registered to.

has_error_handler()

bool: Checks whether the command has an error handler registered.

await invoke_callback(interaction, *args, **kwargs)

This function is a coroutine. Invokes the callback, injecting self if available.

await invoke_callback_with_hooks(state, interaction, args=None, kwargs=None)

This function is a coroutine. Invokes the callback with all hooks and checks.

await invoke_error(interaction, error)

This function is a coroutine. Invokes the error handler if available.

property is_global

Returns True if this command is or should be a global command.

Type:

bool

property is_guild

Returns True if this command is or should be registered to any guilds.

Type:

bool

is_interaction_valid(interaction)

Checks if the interaction given is possibly valid for this command. If the command has more parameters (especially optionals) than the interaction coming in, this may cause a desync between your bot and Discord.

Parameters:

interaction (Interaction) – Interaction to validate.

Returns:

True If the interaction could possibly be for this command, False otherwise.

Return type:

bool

is_payload_valid(raw_payload, guild_id=None)

Checks if the given raw application command interaction payload from Discord is possibly valid for this command. Note that while this may return True for a given payload, that doesn’t mean that the payload is fully correct for this command. Discord doesn’t send data for parameters that are optional and aren’t supplied by the user.

Parameters:

• raw_payload (dict) – Application command interaction payload from Discord.

• guild_id (Optional[int]) – Guild ID that the payload is from. If it’s from a global command, this should be None

Returns:

True if the given payload is possibly valid for this command. False otherwise.

Return type:

bool

on_autocomplete(on_kwarg)

Decorator that adds an autocomplete callback to the given kwarg.

@bot.slash_command()
async def your_favorite_dog(interaction: Interaction, dog: str):
    await interaction.response.send_message(f"Your favorite dog is {dog}!")

@your_favorite_dog.on_autocomplete("dog")
async def favorite_dog(interaction: Interaction, dog: str):
    if not dog:
        # send the full autocomplete list
        await interaction.response.send_autocomplete(list_of_dog_breeds)
        return
    # send a list of nearest matches from the list of dog breeds
    get_near_dog = [breed for breed in list_of_dog_breeds if breed.lower().startswith(dog.lower())]
    await interaction.response.send_autocomplete(get_near_dog)

Note

To use inputs from other options inputted in the command, you can add them as arguments to the autocomplete callback. The order of the arguments does not matter, but the names do.

If you are using nextcord.Member or nextcord.User typehints in your autocompletes then just note that the objects provided can be both None and nextcord.Object depending on the data Discord sends.

Parameters:

on_kwarg (str) – The slash command option to add the autocomplete callback to.

property options

Returns the options of the command.

Changed in version 2.5: This is now a property.

Type:

Dict[str, SlashCommandOption]

parse_discord_response(state, data)

Parses the application command creation/update response from Discord.

Parameters:

• state (ConnectionState) – Connection state to use internally in the command.

• data (Union[ApplicationCommandInteractionData, ApplicationCommand]) – Raw dictionary data from Discord.

property qualified_name

Retrieves the fully qualified command name.

Added in version 2.1.

Type:

str

remove_check(func)

Removes a check from the ApplicationCommand. Returns the application command for method chaining.

This function is idempotent and will not raise an exception if the function is not in the command’s checks.

Parameters:

func (ApplicationCheck) – The function to remove from the checks.

property required_bot_guild_permissions

Returns the permissions the bot needs to have in this guild in order to run this command.

Note

This returns the permissions set with ext.application_checks.bot_has_guild_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_bot_permissions

Returns the permissions the bot needs to run this command.

Note

This returns the permissions set with ext.application_checks.bot_has_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_guild_permissions

Returns the guild permissions needed to run this command.

Note

This returns the permissions set with ext.application_checks.has_guild_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_permissions

Returns the permissions required to run this command.

Note

This returns the permissions set with ext.application_checks.has_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

command_ids

Dict[Optional[int], int]: Command IDs that this application command currently has. Schema: {Guild ID (None for global): command ID}

Attributes

• children
• cog_after_invoke
• cog_before_invoke
• command_ids
• error_name
• options
• payload
• qualified_name

Methods

• defadd_check
• defafter_invoke
• defbefore_invoke
• asynccall
• asynccall_autocomplete
• asynccall_autocomplete_from_interaction
• asynccan_run
• deferror
• deffrom_autocomplete
• deffrom_callback
• defget_mention
• defhas_error_handler
• asyncinvoke_callback
• asyncinvoke_callback_with_hooks
• asyncinvoke_error
• defon_autocomplete
• defremove_check
• defsubcommand

class nextcord.SlashApplicationSubcommand(name=None, description=None, *, cmd_type, name_localizations=None, description_localizations=None, callback=None, parent_cmd=None, parent_cog=None, inherit_hooks=False)

Class representing a subcommand or subcommand group of a slash command.

property options

Returns the options of the command.

Changed in version 2.5: This is now a property.

Type:

Dict[str, SlashCommandOption]

property qualified_name

Retrieve the command name including all parents space separated.

An example of the output would be parent group subcommand.

Added in version 2.1.

Type:

str

await call(state, interaction, option_data)

This function is a coroutine. Calls the callback via the given Interaction, using the given ConnectionState to get resolved objects if needed and available and the given option data.

Parameters:

• state (ConnectionState) – State object to get resolved objects from.

• interaction (Interaction) – Interaction corresponding to the use of the subcommand.

• option_data (List[dict]) – List of raw option data from Discord.

property payload

Returns a dict payload made of the attributes of the subcommand (group) to be sent to Discord.

from_callback(callback=None, option_class=<class 'nextcord.application_command.SlashCommandOption'>, call_children=True)

Creates objects of type option_class with the parameters of the function, and stores them in the options attribute.

Parameters:

• callback (Optional[Callable]) – Callback to create options from. Must be a coroutine function.

• option_class (Optional[Type[BaseCommandOption]]) – Class to create the options using. Should either be or subclass BaseCommandOption. Defaults to BaseCommandOption.

Returns:

Self for possible chaining.

Return type:

CallbackMixin

subcommand(name=None, description=None, *, name_localizations=None, description_localizations=None, inherit_hooks=False)

Takes the decorated callback and turns it into a SlashApplicationSubcommand added as a subcommand.

Parameters:

• name (str) – Name of the command that users will see. If not set, it defaults to the name of the callback.

• description (str) – Description of the command that users will see. If not specified, the docstring will be used. If no docstring is found for the command callback, it defaults to “No description provided”.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the command for users of specific locales. The locale code should be the key, with the localized name as the value.

• description_localizations (Dict[Union[Locale, str], str]) – Description(s) of the subcommand for users of specific locales. The locale code should be the key, with the localized description as the value.

• inherit_hooks (bool) – If the subcommand should inherit the parent subcommands before_invoke and after_invoke callbacks. Defaults to False.

property command_ids

Command IDs the parent command of this subcommand currently has. Schema: {Guild ID (None for global): command ID}

Added in version 2.2.

Type:

Dict[Optional[int], int]

add_check(func)

Adds a check to the application command. Returns the application command for method chaining.

Parameters:

func (ApplicationCheck) – The function that will be used as a check.

after_invoke(coro)

Sets the callback that should be run after the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the after_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

before_invoke(coro)

Sets the callback that should be run before the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the before_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

await call_autocomplete(state, interaction, option_data=None)

This function is a coroutine. Calls the autocomplete callback with the given interaction and option data.

await call_autocomplete_from_interaction(interaction)

This function is a coroutine. Calls the autocomplete callback with the given interaction.

await can_run(interaction)

This function is a coroutine.

Checks if the command can be executed by checking all the predicates inside the checks attribute, as well as all global and cog checks.

Parameters:

interaction (Interaction) – The interaction of the command currently being invoked.

Raises:

ApplicationError – Any application command error that was raised during a check call will be propagated by this function.

Returns:

A boolean indicating if the command can be invoked.

Return type:

bool

property children

Returns the sub-commands and sub-command groups of the command.

Changed in version 2.3: .children is now a read-only property.

property cog_after_invoke

Returns the cog_application_command_after_invoke method for the cog that this command is in.

Returns:

after_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

property cog_before_invoke

Returns the cog_application_command_before_invoke method for the cog that this command is in. Returns None if not the method is not found.

Returns:

before_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

error(callback)

Decorates a function, setting it as a callback to be called when a ApplicationError or any of its subclasses is raised inside the ApplicationCommand.

Parameters:

callback (Callable[[Interaction, ApplicationError], asyncio.Awaitable[Any]]) – The callback to call when an error occurs.

property error_name

Returns a string containing the class name, command name, and the callback to use in raising exceptions.

Examples

>>> print(app_cmd.error_name)
SlashApplicationCommand reloadme <function TinyTest.reloadme at 0x7f4b3b563e20>

Returns:

String containing the class name, command name, and callback object.

Return type:

str

from_autocomplete()

Processes the found autocomplete callbacks and associates them to their corresponding options.

Raises:

ValueError – If a found arg name doesn’t correspond to an autocomplete function.

get_mention(guild=None)

Returns a string that allows you to mention the slash command.

Added in version 2.2.

Parameters:

guild (Optional[Snowflake]) – The Guild of the command to mention. If None, then the global command will be mentioned.

Returns:

The string that allows you to mention the slash command.

Return type:

str

Raises:

ValueError – If no guild was provided and the command is not registered globally, or the command is not registered in the guild provided.

has_error_handler()

bool: Checks whether the command has an error handler registered.

await invoke_callback(interaction, *args, **kwargs)

This function is a coroutine. Invokes the callback, injecting self if available.

await invoke_callback_with_hooks(state, interaction, args=None, kwargs=None)

This function is a coroutine. Invokes the callback with all hooks and checks.

await invoke_error(interaction, error)

This function is a coroutine. Invokes the error handler if available.

on_autocomplete(on_kwarg)

Decorator that adds an autocomplete callback to the given kwarg.

@bot.slash_command()
async def your_favorite_dog(interaction: Interaction, dog: str):
    await interaction.response.send_message(f"Your favorite dog is {dog}!")

@your_favorite_dog.on_autocomplete("dog")
async def favorite_dog(interaction: Interaction, dog: str):
    if not dog:
        # send the full autocomplete list
        await interaction.response.send_autocomplete(list_of_dog_breeds)
        return
    # send a list of nearest matches from the list of dog breeds
    get_near_dog = [breed for breed in list_of_dog_breeds if breed.lower().startswith(dog.lower())]
    await interaction.response.send_autocomplete(get_near_dog)

Note

To use inputs from other options inputted in the command, you can add them as arguments to the autocomplete callback. The order of the arguments does not matter, but the names do.

If you are using nextcord.Member or nextcord.User typehints in your autocompletes then just note that the objects provided can be both None and nextcord.Object depending on the data Discord sends.

Parameters:

on_kwarg (str) – The slash command option to add the autocomplete callback to.

remove_check(func)

Removes a check from the ApplicationCommand. Returns the application command for method chaining.

This function is idempotent and will not raise an exception if the function is not in the command’s checks.

Parameters:

func (ApplicationCheck) – The function to remove from the checks.

Slash Options

Accepted Default Option Types/Annotations

Typehint	Discord Type	Notes
<blank>	String	When no typehint is given, it defaults to string.
str	String
int	Integer	Any integer between -2^53 and 2^53
float	Number	Any double between -2^53 and 2^53
bool	Boolean
User	User
Member	User	Identical to typehinting with User
abc.GuildChannel	Channel	Includes all channel types + categories. Use SlashOption to configure which channel types to allow.
CategoryChannel	Channel	Restricts the accepted channel types to Guild Category channels.
DMChannel	Channel	Restricts the accepted channel types to DM channels.
ForumChannel	Channel	Restricts the accepted channel types to Forum Channels.
GroupChannel	Channel	Restricts the accepted channel types to Group DM channels.
StageChannel	Channel	Restricts the accepted channel types to Stage Voice channels.
TextChannel	Channel	Restricts the accepted channel types to Text and News channels.
VoiceChannel	Channel	Restricts the accepted channel types to Voice channels.
Thread	Channel	Restricts the accepted “channel” types to News, Public, and Private threads.
Role	Role
Mentionable	Mentionable	Includes Users and Roles.
Attachment	Attachment

Advanced Annotations

Typing Annotation	Notes
Optional [<type>]	Makes the slash option not required with the type of the given <type>.
Literal [<choice1>, <choice2>, …]	Makes the slash option into a choice of the given type. All choices have to be the same data type.
Union [<type1>, <type2>, …]	Allows compatible annotations to be typehinted together. Channel types in a union will allow the slash option to be any of them.
Annotated [<type1>, <type2>, …, <typeN>]	Makes your IDE see <type1> as the expected type, but Nextcord will attempt to use <typeN> as the option type. If <typeN> isn’t a valid option type, Nextcord will work backwards towards <type2> until it finds a type that can be used as a valid option type.
Range [[type1 | ...], <type2 | ...>]	Makes a range of values set in SlashOption.min_value and SlashOption.max_value. If type1 is not set or is an ellipsis, min_value is None. If type2 is an ellipsis (...), max_value is None.
String [[type1 | ...], <type2 | ...>]	Makes a range of string length set in SlashOption.min_length and SlashOption.max_length. If type1 is not set or is an ellipsis, min_length is None. If type2 is an ellipsis (...), max_length is None.

Attributes

• payload

class nextcord.SlashOption(name=None, description=None, required=None, *, name_localizations=None, description_localizations=None, choices=None, choice_localizations=None, channel_types=None, min_value=None, max_value=None, min_length=None, max_length=None, autocomplete=None, autocomplete_callback=None, default=..., verify=True)

Provides Discord with information about an option in a command.

When this class is set as the default argument of a parameter in an Application Command, additional information about the parameter is sent to Discord for the user to see.

Parameters:

• name (str) – The name of the Option on Discords side. If left as None, it defaults to the parameter name.

• description (str) – The description of the Option on Discords side. If left as None, it defaults to “”.

• required (bool) – If a user is required to provide this argument before sending the command.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the subcommand for users of specific locales. The locale code should be the key, with the localized name as the value

• description_localizations (Dict[Union[Locale, str], str]) – Description(s) of the subcommand for users of specific locales. The locale code should be the key, with the localized description as the value

• choices (Union[Dict[str, Union[str, int, float]],) – Iterable[Union[str, int, float]]] A list of choices that a user must choose. If a dict is given, the keys are what the users are able to see, the values are what is sent back to the bot. Otherwise, it is treated as an Iterable where what the user sees and is sent back to the bot are the same.

• choice_localizations (Dict[str, Dict[Union[Locale, str], str]]) – A dictionary of choice display names as the keys, and dictionaries of locale: localized name as the values.

• channel_types (List[ChannelType]) – List of ChannelType enums, limiting the users choice to only those channel types. The parameter must be typed as GuildChannel for this to function.

• min_value (Union[int, float]) – Minimum integer or floating point value the user is allowed to input. The parameter must be typed as an int or float for this to function.

• max_value (Union[int, float]) – Maximum integer or floating point value the user is allowed to input. The parameter must be typed as an int or float for this to function.

• min_length (int) –

  Minimum length for a string value the user is allowed to input. The parameter must be typed as a str for this to function.

  Added in version 2.1.

• max_length (int) –

  Maximum length for a string value the user is allowed to input. The parameter must be typed as a str for this to function.

  Added in version 2.1.

• autocomplete (bool) – If this parameter has an autocomplete function decorated for it. If unset, it will automatically be True if an autocomplete function for it is found.

• autocomplete_callback (Optional[Callable]) – The function that will be used to autocomplete this parameter. If not specified, it will be looked for using the on_autocomplete() decorator.

• default (Any) – When required is not True and the user doesn’t provide a value for this Option, this value is given instead.

• verify (bool) – If True, the given values will be checked to ensure that the payload to Discord is valid.

property payload

Returns a dict payload made of the attributes of the option to be sent to Discord.

Type:

dict

Attributes

• channel_mapping
• description
• functional_name
• payload

Methods

• deffrom_autocomplete_callback
• asyncinvoke_autocomplete_callback
• defverify

class nextcord.SlashCommandOption(parameter, command, parent_cog=None)

channel_mapping = {<class 'nextcord.channel.CategoryChannel'>: (ChannelType.category,), <class 'nextcord.channel.DMChannel'>: (ChannelType.private,), <class 'nextcord.channel.ForumChannel'>: (ChannelType.forum,), <class 'nextcord.channel.GroupChannel'>: (ChannelType.group,), <class 'nextcord.channel.StageChannel'>: (ChannelType.stage_voice,), <class 'nextcord.channel.TextChannel'>: (ChannelType.text, ChannelType.news), <class 'nextcord.channel.VoiceChannel'>: (ChannelType.voice,), <class 'nextcord.threads.Thread'>: (ChannelType.news_thread, ChannelType.public_thread, ChannelType.private_thread)}

Maps Python channel annotations/typehints to Discord ChannelType values.

property description

If no description is set, it returns “No description provided”

Type:

str

verify()

This should run through SlashOption variables and raise errors when conflicting data is given.

from_autocomplete_callback(callback)

Parses a callback meant to be the autocomplete function.

await invoke_autocomplete_callback(interaction, option_value, **kwargs)

This function is a coroutine. Invokes the autocomplete callback, injecting self if available.

property payload

Returns a dict payload made of the attributes of the option to be sent to Discord.

Type:

dict

functional_name

Name of the kwarg in the function/method

class nextcord.Range

An annotation helper for defining slash command min_value and max_value parameters.

Added in version 2.2.

Range[x, y]

Creates a range from x to y.

Range[x] | Range[..., x]

Create a range up to x.

Range[x, ...]

Create a range from x.

class nextcord.String

An annotation helper for defining slash command min_length and max_length parameters.

Added in version 2.2.

String[x, y]

Creates a range of string length from x to y.

String[x] | String[..., x]

Create a range of string length up to x.

String[x, ...]

Create a range of string length from x.

User Commands

Attributes

• cog_after_invoke
• cog_before_invoke
• command_ids
• description
• error_name
• guild_ids
• is_global
• is_guild
• qualified_name
• required_bot_guild_permissions
• required_bot_permissions
• required_guild_permissions
• required_permissions

Methods

• defadd_check
• defadd_guild_rollout
• defafter_invoke
• defbefore_invoke
• asynccall
• asynccall_from_interaction
• asynccan_run
• deferror
• deffrom_callback
• defget_payload
• defget_rollout_signatures
• defget_signature
• defget_signatures
• defhas_error_handler
• asyncinvoke_callback
• asyncinvoke_callback_with_hooks
• asyncinvoke_error
• defis_interaction_valid
• defis_payload_valid
• defparse_discord_response
• defremove_check

class nextcord.UserApplicationCommand(name=None, *, name_localizations=None, callback=None, guild_ids=None, default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, parent_cog=None, force_global=False)

Class representing a user context menu command.

add_check(func)

Adds a check to the application command. Returns the application command for method chaining.

Parameters:

func (ApplicationCheck) – The function that will be used as a check.

add_guild_rollout(guild)

Adds a Guild to the command to be rolled out to when the rollout is run.

Parameters:

guild (Union[int, Guild]) – Guild or Guild ID to add this command to roll out to.

after_invoke(coro)

Sets the callback that should be run after the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the after_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

before_invoke(coro)

Sets the callback that should be run before the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the before_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

await call_from_interaction(interaction)

This function is a coroutine. Calls the callback via the given Interaction, relying on the locally stored ConnectionState object.

Parameters:

interaction (Interaction) – Interaction corresponding to the use of the command.

await can_run(interaction)

This function is a coroutine.

Checks if the command can be executed by checking all the predicates inside the checks attribute, as well as all global and cog checks.

Parameters:

interaction (Interaction) – The interaction of the command currently being invoked.

Raises:

ApplicationError – Any application command error that was raised during a check call will be propagated by this function.

Returns:

A boolean indicating if the command can be invoked.

Return type:

bool

property cog_after_invoke

Returns the cog_application_command_after_invoke method for the cog that this command is in.

Returns:

after_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

property cog_before_invoke

Returns the cog_application_command_before_invoke method for the cog that this command is in. Returns None if not the method is not found.

Returns:

before_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

error(callback)

Decorates a function, setting it as a callback to be called when a ApplicationError or any of its subclasses is raised inside the ApplicationCommand.

Parameters:

callback (Callable[[Interaction, ApplicationError], asyncio.Awaitable[Any]]) – The callback to call when an error occurs.

property error_name

Returns a string containing the class name, command name, and the callback to use in raising exceptions.

Examples

>>> print(app_cmd.error_name)
SlashApplicationCommand reloadme <function TinyTest.reloadme at 0x7f4b3b563e20>

Returns:

String containing the class name, command name, and callback object.

Return type:

str

get_payload(guild_id)

Makes an Application Command payload for this command to upsert to Discord with the given Guild ID.

Parameters:

guild_id (Optional[int]) – Guild ID that this payload is for. If set to None, it will be a global command payload instead.

Returns:

Dictionary payload to upsert to Discord.

Return type:

dict

get_rollout_signatures()

Returns all signatures that this command wants to roll out to.

Command signatures are made up of the command name, command type, and Guild ID (None for global).

Returns:

A set of tuples that act as signatures.

Return type:

Set[Tuple[str, int, Optional[int]]]

get_signature(guild_id=None)

Returns a command signature with the given guild ID.

Parameters:

guild_id (Optional[None]) – Guild ID to make the signature for. If set to None, it acts as a global command signature.

Returns:

A tuple that acts as a signature made up of the name, type, and guild ID.

Return type:

Tuple[str, int, Optional[int]]

get_signatures()

Returns all the signatures that this command has.

Command signatures are made up of the command name, command type, and Guild ID (None for global).

Returns:

A set of tuples that act as signatures.

Return type:

Set[Tuple[str, int, Optional[int]]]

property guild_ids

Returns a set containing all guild ID’s this command is registered to.

has_error_handler()

bool: Checks whether the command has an error handler registered.

await invoke_callback(interaction, *args, **kwargs)

This function is a coroutine. Invokes the callback, injecting self if available.

await invoke_callback_with_hooks(state, interaction, args=None, kwargs=None)

This function is a coroutine. Invokes the callback with all hooks and checks.

await invoke_error(interaction, error)

This function is a coroutine. Invokes the error handler if available.

property is_global

Returns True if this command is or should be a global command.

Type:

bool

property is_guild

Returns True if this command is or should be registered to any guilds.

Type:

bool

is_interaction_valid(interaction)

Checks if the interaction given is possibly valid for this command. If the command has more parameters (especially optionals) than the interaction coming in, this may cause a desync between your bot and Discord.

Parameters:

interaction (Interaction) – Interaction to validate.

Returns:

True If the interaction could possibly be for this command, False otherwise.

Return type:

bool

is_payload_valid(raw_payload, guild_id=None)

Checks if the given raw application command interaction payload from Discord is possibly valid for this command. Note that while this may return True for a given payload, that doesn’t mean that the payload is fully correct for this command. Discord doesn’t send data for parameters that are optional and aren’t supplied by the user.

Parameters:

• raw_payload (dict) – Application command interaction payload from Discord.

• guild_id (Optional[int]) – Guild ID that the payload is from. If it’s from a global command, this should be None

Returns:

True if the given payload is possibly valid for this command. False otherwise.

Return type:

bool

parse_discord_response(state, data)

Parses the application command creation/update response from Discord.

Parameters:

• state (ConnectionState) – Connection state to use internally in the command.

• data (Union[ApplicationCommandInteractionData, ApplicationCommand]) – Raw dictionary data from Discord.

property qualified_name

Retrieves the fully qualified command name.

Added in version 2.1.

Type:

str

remove_check(func)

Removes a check from the ApplicationCommand. Returns the application command for method chaining.

This function is idempotent and will not raise an exception if the function is not in the command’s checks.

Parameters:

func (ApplicationCheck) – The function to remove from the checks.

property required_bot_guild_permissions

Returns the permissions the bot needs to have in this guild in order to run this command.

Note

This returns the permissions set with ext.application_checks.bot_has_guild_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_bot_permissions

Returns the permissions the bot needs to run this command.

Note

This returns the permissions set with ext.application_checks.bot_has_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_guild_permissions

Returns the guild permissions needed to run this command.

Note

This returns the permissions set with ext.application_checks.has_guild_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_permissions

Returns the permissions required to run this command.

Note

This returns the permissions set with ext.application_checks.has_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

command_ids

Dict[Optional[int], int]: Command IDs that this application command currently has. Schema: {Guild ID (None for global): command ID}

property description

The description the command should have in Discord. Should be 1-100 characters long.

await call(state, interaction)

This function is a coroutine. Calls the callback via the given Interaction, using the given ConnectionState to get resolved objects if needed and available.

Parameters:

• state (ConnectionState) – State object to get resolved objects from.

• interaction (Interaction) – Interaction corresponding to the use of the command.

from_callback(callback=None, option_class=None)

Creates objects of type option_class with the parameters of the function, and stores them in the options attribute.

Parameters:

• callback (Optional[Callable]) – Callback to create options from. Must be a coroutine function.

• option_class (Optional[Type[BaseCommandOption]]) – Class to create the options using. Should either be or subclass BaseCommandOption. Defaults to BaseCommandOption.

Returns:

Self for possible chaining.

Return type:

CallbackMixin

Message Commands

Attributes

• cog_after_invoke
• cog_before_invoke
• command_ids
• description
• error_name
• guild_ids
• is_global
• is_guild
• qualified_name
• required_bot_guild_permissions
• required_bot_permissions
• required_guild_permissions
• required_permissions

Methods

• defadd_check
• defadd_guild_rollout
• defafter_invoke
• defbefore_invoke
• asynccall
• asynccall_from_interaction
• asynccan_run
• deferror
• deffrom_callback
• defget_payload
• defget_rollout_signatures
• defget_signature
• defget_signatures
• defhas_error_handler
• asyncinvoke_callback
• asyncinvoke_callback_with_hooks
• asyncinvoke_error
• defis_interaction_valid
• defis_payload_valid
• defparse_discord_response
• defremove_check

class nextcord.MessageApplicationCommand(name=None, *, name_localizations=None, callback=None, guild_ids=None, default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, parent_cog=None, force_global=False)

Class representing a message context menu command.

add_check(func)

Adds a check to the application command. Returns the application command for method chaining.

Parameters:

func (ApplicationCheck) – The function that will be used as a check.

add_guild_rollout(guild)

Adds a Guild to the command to be rolled out to when the rollout is run.

Parameters:

guild (Union[int, Guild]) – Guild or Guild ID to add this command to roll out to.

after_invoke(coro)

Sets the callback that should be run after the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the after_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

before_invoke(coro)

Sets the callback that should be run before the command callback is invoked.

Parameters:

coro (Callable[[Interaction], Coroutine]) – Coroutine to set as the before_invoke hook.

Returns:

The coroutine to allow multiple commands to share the function.

Return type:

Callable[[Interaction], Coroutine]

await call_from_interaction(interaction)

This function is a coroutine. Calls the callback via the given Interaction, relying on the locally stored ConnectionState object.

Parameters:

interaction (Interaction) – Interaction corresponding to the use of the command.

await can_run(interaction)

This function is a coroutine.

Checks if the command can be executed by checking all the predicates inside the checks attribute, as well as all global and cog checks.

Parameters:

interaction (Interaction) – The interaction of the command currently being invoked.

Raises:

ApplicationError – Any application command error that was raised during a check call will be propagated by this function.

Returns:

A boolean indicating if the command can be invoked.

Return type:

bool

property cog_after_invoke

Returns the cog_application_command_after_invoke method for the cog that this command is in.

Returns:

after_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

property cog_before_invoke

Returns the cog_application_command_before_invoke method for the cog that this command is in. Returns None if not the method is not found.

Returns:

before_invoke method from the parent cog. None if not the method is not found.

Return type:

Optional[ApplicationHook]

error(callback)

Decorates a function, setting it as a callback to be called when a ApplicationError or any of its subclasses is raised inside the ApplicationCommand.

Parameters:

callback (Callable[[Interaction, ApplicationError], asyncio.Awaitable[Any]]) – The callback to call when an error occurs.

property error_name

Returns a string containing the class name, command name, and the callback to use in raising exceptions.

Examples

>>> print(app_cmd.error_name)
SlashApplicationCommand reloadme <function TinyTest.reloadme at 0x7f4b3b563e20>

Returns:

String containing the class name, command name, and callback object.

Return type:

str

get_payload(guild_id)

Makes an Application Command payload for this command to upsert to Discord with the given Guild ID.

Parameters:

guild_id (Optional[int]) – Guild ID that this payload is for. If set to None, it will be a global command payload instead.

Returns:

Dictionary payload to upsert to Discord.

Return type:

dict

get_rollout_signatures()

Returns all signatures that this command wants to roll out to.

Command signatures are made up of the command name, command type, and Guild ID (None for global).

Returns:

A set of tuples that act as signatures.

Return type:

Set[Tuple[str, int, Optional[int]]]

get_signature(guild_id=None)

Returns a command signature with the given guild ID.

Parameters:

guild_id (Optional[None]) – Guild ID to make the signature for. If set to None, it acts as a global command signature.

Returns:

A tuple that acts as a signature made up of the name, type, and guild ID.

Return type:

Tuple[str, int, Optional[int]]

get_signatures()

Returns all the signatures that this command has.

Command signatures are made up of the command name, command type, and Guild ID (None for global).

Returns:

A set of tuples that act as signatures.

Return type:

Set[Tuple[str, int, Optional[int]]]

property guild_ids

Returns a set containing all guild ID’s this command is registered to.

has_error_handler()

bool: Checks whether the command has an error handler registered.

await invoke_callback(interaction, *args, **kwargs)

This function is a coroutine. Invokes the callback, injecting self if available.

await invoke_callback_with_hooks(state, interaction, args=None, kwargs=None)

This function is a coroutine. Invokes the callback with all hooks and checks.

await invoke_error(interaction, error)

This function is a coroutine. Invokes the error handler if available.

property is_global

Returns True if this command is or should be a global command.

Type:

bool

property is_guild

Returns True if this command is or should be registered to any guilds.

Type:

bool

is_interaction_valid(interaction)

Checks if the interaction given is possibly valid for this command. If the command has more parameters (especially optionals) than the interaction coming in, this may cause a desync between your bot and Discord.

Parameters:

interaction (Interaction) – Interaction to validate.

Returns:

True If the interaction could possibly be for this command, False otherwise.

Return type:

bool

is_payload_valid(raw_payload, guild_id=None)

Checks if the given raw application command interaction payload from Discord is possibly valid for this command. Note that while this may return True for a given payload, that doesn’t mean that the payload is fully correct for this command. Discord doesn’t send data for parameters that are optional and aren’t supplied by the user.

Parameters:

• raw_payload (dict) – Application command interaction payload from Discord.

• guild_id (Optional[int]) – Guild ID that the payload is from. If it’s from a global command, this should be None

Returns:

True if the given payload is possibly valid for this command. False otherwise.

Return type:

bool

parse_discord_response(state, data)

Parses the application command creation/update response from Discord.

Parameters:

• state (ConnectionState) – Connection state to use internally in the command.

• data (Union[ApplicationCommandInteractionData, ApplicationCommand]) – Raw dictionary data from Discord.

property qualified_name

Retrieves the fully qualified command name.

Added in version 2.1.

Type:

str

remove_check(func)

Removes a check from the ApplicationCommand. Returns the application command for method chaining.

This function is idempotent and will not raise an exception if the function is not in the command’s checks.

Parameters:

func (ApplicationCheck) – The function to remove from the checks.

property required_bot_guild_permissions

Returns the permissions the bot needs to have in this guild in order to run this command.

Note

This returns the permissions set with ext.application_checks.bot_has_guild_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_bot_permissions

Returns the permissions the bot needs to run this command.

Note

This returns the permissions set with ext.application_checks.bot_has_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_guild_permissions

Returns the guild permissions needed to run this command.

Note

This returns the permissions set with ext.application_checks.has_guild_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

property required_permissions

Returns the permissions required to run this command.

Note

This returns the permissions set with ext.application_checks.has_permissions().

Added in version 2.6.

Returns:

A dictionary of the required permissions for this command.

Return type:

Dict[str, bool]

command_ids

Dict[Optional[int], int]: Command IDs that this application command currently has. Schema: {Guild ID (None for global): command ID}

property description

The description the command should have in Discord. Should be 1-100 characters long.

await call(state, interaction)

This function is a coroutine. Calls the callback via the given Interaction, using the given ConnectionState to get resolved objects if needed and available.

Parameters:

• state (ConnectionState) – State object to get resolved objects from.

• interaction (Interaction) – Interaction corresponding to the use of the command.

from_callback(callback=None, option_class=None)

Creates objects of type option_class with the parameters of the function, and stores them in the options attribute.

Parameters:

• callback (Optional[Callable]) – Callback to create options from. Must be a coroutine function.

• option_class (Optional[Type[BaseCommandOption]]) – Class to create the options using. Should either be or subclass BaseCommandOption. Defaults to BaseCommandOption.

Returns:

Self for possible chaining.

Return type:

CallbackMixin

Command Helpers

class nextcord.CallbackWrapper(callback, *args, **kwargs)

A class used to wrap a callback in a sane way to modify aspects of application commands.

By creating a decorator that makes this class wrap a function or an application command, you can easily modify attributes of the command regardless if this wraps the callback or the application command, and without needing to make the application command object interpret arbitrarily set function attributes.

The modify method must be overridden.

This handles both multiple layers of wrappers, or if it wraps around a BaseApplicationCommand

Parameters:

callback (Union[Callable, CallbackWrapper, BaseApplicationCommand]) – Callback, other callback wrapper, or application command to wrap and/or modify.

Examples

Creating a decorator that makes the description of the command uppercase, and offers an “override” argument:

def upper_description(description_override: str = None):
    class UpperDescription(CallbackWrapper):
        def modify(self, app_cmd):
            if description_override is not None:
                app_cmd.description = description_override.upper()
            elif app_cmd.description:
                app_cmd.description = app_cmd.description.upper()

    def wrapper(func):
        return UpperDescription(func)

    return wrapper

@client.slash_command(description="This will be made uppercase.")
@upper_description()
async def test(interaction):
    await interaction.send("The description of this command should be in all uppercase!")

Methods

• asyncconvert
• defmodify

class nextcord.OptionConverter(option_type=<class 'str'>)

Based on, in basic functionality, the ext.commands Converter. Users subclass this and use convert to provide custom “typings” for slash commands.

The convert method MUST be overridden to convert the value from Discord to the desired value. The modify method MAY be overridden to modify the BaseCommandOption.

await convert(interaction, value)

This function is a coroutine. Called to convert a value received from Discord to the desired value.

If you do not wish to do any conversion, simply return the value

Parameters:

• interaction (Interaction) – Interaction associated with the usage of the application command.

• value (Any) – Value received from Discord.

Returns:

Converted value to forward to the callback.

Return type:

Any

modify(option)

Called when the command is being parsed to allow for option modification.

Parameters:

option (BaseCommandOption) – Command option that’s being created.

Methods

• asyncconvert

class nextcord.Mentionable

When a parameter is typehinted with this, it allows users to select both roles and members.

await convert(interaction, value)

This function is a coroutine. Called to convert a value received from Discord to the desired value.

If you do not wish to do any conversion, simply return the value

Parameters:

• interaction (Interaction) – Interaction associated with the usage of the application command.

• value (Any) – Value received from Discord.

Returns:

Converted value to forward to the callback.

Return type:

Any

Decorators

class nextcord.message_command(name=None, *, name_localizations=None, guild_ids=..., default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, force_global=False)

Creates a Message context command from the decorated function. Used inside ClientCog’s or something that subclasses it.

Parameters:

• name (str) – Name of the command that users will see. If not set, it defaults to the name of the callback.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the command for users of specific locales. The locale code should be the key, with the localized name as the value

• guild_ids (Optional[Iterable[int]]) – IDs of Guild’s to add this command to. If not passed and Client.default_guild_ids is set, then those default guild ids will be used instead. If both of those are unset, then the command will be a global command.

• default_member_permissions (Optional[Union[Permissions, int]]) – Permission(s) required to use the command. Inputting 8 or Permissions(administrator=True) for example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by default. Server owners CAN override the permission requirements.

• nsfw (bool) –

  Whether the command can only be used in age-restricted channels. Defaults to False.

  Added in version 2.4.

• integration_types (Optional[Iterable[Union[IntegrationType, int]]]) –

  Where the command is available, only for globally-scoped commands. Defaults to guild_install.

  Added in version 3.0.

• contexts (Optional[Iterable[Union[InteractionContextType, int]]]) –

  Where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands.

  Added in version 3.0.

• force_global (bool) – If True, will force this command to register as a global command, even if guild_ids is set. Will still register to guilds. Has no effect if guild_ids are never set or added to.

class nextcord.slash_command(name=None, description=None, *, name_localizations=None, description_localizations=None, guild_ids=..., default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, force_global=False)

Creates a Slash application command from the decorated function. Used inside ClientCog’s or something that subclasses it.

Parameters:

• name (str) – Name of the command that users will see. If not set, it defaults to the name of the callback.

• description (str) – Description of the command that users will see. If not specified, the docstring will be used. If no docstring is found for the command callback, it defaults to “No description provided”.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the command for users of specific locales. The locale code should be the key, with the localized name as the value.

• description_localizations (Dict[Union[Locale, str], str]) – Description(s) of the subcommand for users of specific locales. The locale code should be the key, with the localized description as the value.

• guild_ids (Optional[Iterable[int]]) – IDs of Guild’s to add this command to. If not passed and Client.default_guild_ids is set, then those default guild ids will be used instead. If both of those are unset, then the command will be a global command.

• default_member_permissions (Optional[Union[Permissions, int]]) – Permission(s) required to use the command. Inputting 8 or Permissions(administrator=True) for example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by default. Server owners CAN override the permission requirements.

• nsfw (bool) –

  Whether the command can only be used in age-restricted channels. Defaults to False.

  Note

  Due to a discord limitation, this can only be set for the parent command in case of a subcommand.

  Added in version 2.4.

• integration_types (Optional[Iterable[Union[IntegrationType, int]]]) –

  Where the command is available, only for globally-scoped commands. Defaults to guild_install.

  Added in version 3.0.

• contexts (Optional[Iterable[Union[InteractionContextType, int]]]) –

  Where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands.

  Added in version 3.0.

• force_global (bool) – If True, will force this command to register as a global command, even if guild_ids is set. Will still register to guilds. Has no effect if guild_ids are never set or added to.

class nextcord.user_command(name=None, *, name_localizations=None, guild_ids=..., default_member_permissions=None, nsfw=False, integration_types=None, contexts=None, force_global=False)

Creates a User context command from the decorated function. Used inside ClientCog’s or something that subclasses it.

Parameters:

• name (str) – Name of the command that users will see. If not set, it defaults to the name of the callback.

• name_localizations (Dict[Union[Locale, str], str]) – Name(s) of the command for users of specific locales. The locale code should be the key, with the localized name as the value

• guild_ids (Optional[Iterable[int]]) – IDs of Guild’s to add this command to. If not passed and Client.default_guild_ids is set, then those default guild ids will be used instead. If both of those are unset, then the command will be a global command.

• default_member_permissions (Optional[Union[Permissions, int]]) – Permission(s) required to use the command. Inputting 8 or Permissions(administrator=True) for example will only allow Administrators to use the command. If set to 0, nobody will be able to use it by default. Server owners CAN override the permission requirements.

• nsfw (bool) –

  Whether the command can only be used in age-restricted channels. Defaults to False.

  Added in version 2.4.

• integration_types (Optional[Iterable[Union[IntegrationType, int]]]) –

  Where the command is available, only for globally-scoped commands. Defaults to guild_install.

  Added in version 3.0.

• contexts (Optional[Iterable[Union[InteractionContextType, int]]]) –

  Where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands.

  Added in version 3.0.

• force_global (bool) – If True, will force this command to register as a global command, even if guild_ids is set. Will still register to guilds. Has no effect if guild_ids are never set or added to.

Cogs

class nextcord.ClientCog(*_args, **_kwargs)

has_application_command_error_handler()

bool: Checks whether the cog has an error handler for application commands.

Added in version 3.0.

property application_commands

Provides the list of application commands in this cog. Subcommands are not included.

process_app_cmds()

Formats all added application commands with their callback.

cog_application_command_check(interaction)

A special method that registers as a ext.application_checks.check() for every application command and subcommand in this cog.

This function can be a coroutine and must take a sole parameter, interaction, to represent the Interaction.

await cog_application_command_error(interaction, error)

A special method that is called whenever an error is dispatched inside this cog.

This is similar to on_application_command_error() except only applying to the commands inside this cog.

This must be a coroutine.

Added in version 3.0.

Parameters:

• interaction (Interaction) – The Interaction where the error happened.

• error (ApplicationError) – The error that happened.

await cog_application_command_before_invoke(interaction)

A special method that acts as a cog local pre-invoke hook.

This is similar to ApplicationCommand.before_invoke().

This must be a coroutine.

Parameters:

interaction (Interaction) – The invocation interaction.

await cog_application_command_after_invoke(interaction)

A special method that acts as a cog local post-invoke hook.

This is similar to Command.after_invoke().

This must be a coroutine.

Parameters:

interaction (Interaction) – The invocation interaction.

Warnings

class nextcord.MissingApplicationCommandParametersWarning

Warning category raised when creating a slash command from a callback when it appears the self and/or interaction parameter is missing based on the given type annotations.

This warning can be silenced using warnings.simplefilter().

import warnings
from nextcord import MissingApplicationCommandParametersWarning

warnings.simplefilter("ignore", MissingApplicationCommandParametersWarning)

Exceptions

The following exceptions are thrown by the library.

exception nextcord.DiscordException

Base exception class for nextcord

Ideally speaking, this could be caught to handle any exceptions raised from this library.

exception nextcord.ClientException

Exception that’s raised when an operation in the Client fails.

These are usually for exceptions that happened due to user input.

exception nextcord.LoginFailure

Exception that’s raised when the Client.login() function fails to log you in from improper credentials or some other misc. failure.

exception nextcord.NoMoreItems

Exception that is raised when an async iteration operation has no more items.

exception nextcord.HTTPException(response, message)

Exception that’s raised when an HTTP request operation fails.

response

The response of the failed HTTP request. This is an instance of aiohttp.ClientResponse. In some cases this could also be a requests.Response.

Type:

aiohttp.ClientResponse

text

The text of the error. Could be an empty string.

Type:

str

status

The status code of the HTTP request.

Type:

int

code

The Discord specific error code for the failure.

Type:

int

exception nextcord.Forbidden(response, message)

Exception that’s raised for when status code 403 occurs.

Subclass of HTTPException

exception nextcord.NotFound(response, message)

Exception that’s raised for when status code 404 occurs.

Subclass of HTTPException

exception nextcord.DiscordServerError(response, message)

Exception that’s raised for when a 500 range status code occurs.

Subclass of HTTPException.

Added in version 1.5.

exception nextcord.InvalidData

Exception that’s raised when the library encounters unknown or invalid data from Discord.

exception nextcord.InvalidArgument

Exception that’s raised when an argument to a function is invalid some way (e.g. wrong value or wrong type).

This could be considered the analogous of ValueError and TypeError except inherited from ClientException and thus DiscordException.

exception nextcord.GatewayNotFound

An exception that is raised when the gateway for Discord could not be found

exception nextcord.ConnectionClosed(socket, *, shard_id, code=None)

Exception that’s raised when the gateway connection is closed for reasons that could not be handled internally.

code

The close code of the websocket.

Type:

int

reason

The reason provided for the closure.

Type:

str

shard_id

The shard ID that got closed if applicable.

Type:

Optional[int]

exception nextcord.PrivilegedIntentsRequired(shard_id)

Exception that’s raised when the gateway is requesting privileged intents but they’re not ticked in the developer page yet.

Go to https://discord.com/developers/applications/ and enable the intents that are required. Currently these are as follows:

• Intents.members

• Intents.presences

shard_id

The shard ID that got closed if applicable.

Type:

Optional[int]

exception nextcord.InteractionResponded(interaction)

Exception that’s raised when sending another interaction response using InteractionResponse when one has already been done before.

An interaction can only respond once.

Added in version 2.0.

interaction

The interaction that’s already been responded to.

Type:

Interaction

exception nextcord.opus.OpusError(code)

An exception that is thrown for libopus related errors.

code

The error code returned.

Type:

int

exception nextcord.opus.OpusNotLoaded

An exception that is thrown for when libopus is not loaded.

exception nextcord.HTTPInternalCancelled

Exception that’s raised when an HTTP request is internally cancelled before the actual request is made.

exception nextcord.HTTPInternalRatelimitLocked

Exception that’s raised when an internally tracked ratelimit, global or route, would be exceeded by the request.

Subclass of HTTPInternalCancelled

exception nextcord.ApplicationError(message=None, *args)

The base exception type for all command related errors.

This inherits from nextcord.DiscordException.

This exception and exceptions inherited from it are handled in a special way as they are caught and passed into a special event from Bot, on_command_error().

exception nextcord.ApplicationInvokeError(e)

Exception raised when the command being invoked raised an exception.

This inherits from ApplicationError

original

The original exception that was raised. You can also get this via the __cause__ attribute.

Type:

Exception

exception nextcord.ApplicationCheckFailure(message=None, *args)

Exception raised when the predicates in BaseApplicationCommand.checks have failed.

This inherits from ApplicationError

exception nextcord.ApplicationCommandOptionMissing(message=None, *args)

Raised when an option that’s supposed to be part of an application command is missing on our end.

Exception Hierarchy

• Exception

  • DiscordException

    • ClientException

      • InvaildCommandType

      • InvalidData

      • InvalidArgument

      • LoginFailure

      • ConnectionClosed

      • PrivilegedIntentsRequired

      • InteractionResponded

    • NoMoreItems

    • GatewayNotFound

    • HTTPException

      • Unauthorized

      • Forbidden

      • NotFound

      • DiscordServerError

    • HTTPInternalCancelled

      • HTTPInternalRatelimitLocked

  • ApplicationError

    • ApplicationInvokeError

    • ApplicationCheckFailure

    • ApplicationCommandOptionMissing