Referensi API

Laman ini akan memberikan garis besar untuk API ndiscord.py.

Catatan

Modul ini menggunakan modul logging Python untuk mensimpan diagnosa dan error tanpa membuat output utama berantakan. Jika modul logging tidak diatur, maka anda tidak dapat melihat hal-hal tersebut di manapun. Mohon kunjungi Menyiapkan Logging untuk info lebih lanjut untuk menyiapkan sistem logging dan menggunakannya dengan ndiscord.py.

Clients

Client

Attributes
Methods
class discord.Client(*args, **kwargs)

Merepresentasikan koneksi klien dengan Discord. Kelas ini dipakai untuk berinteraksi dengan WebSocket dan API Discord.

Berbagai macam opsi dapat diberikan ke Client.

Parameter

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

    Berubah pada versi 1.3: Allow disabling the message cache and change the default size to 1000.

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

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

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

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

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

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

  • application_id (int) -- The client's application ID.

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

    Baru pada versi 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.

    Baru pada versi 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.

    Baru pada versi 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.

    Baru pada versi 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.

    Baru pada versi 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.

    Baru pada versi 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.

    Baru pada versi 2.0.

ws

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

loop

The event loop that the client uses for asynchronous operations.

tipe

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.

Contoh

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

TypeError -- The coroutine passed is not actually a coroutine.

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

Retrieves an AsyncIterator that enables receiving your guilds.

Catatan

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

Catatan

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

Contoh-contoh

Usage

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

Flattening into a list

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

All parameters are optional.

Parameter

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

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

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

Menimbulkan

HTTPException -- Getting the guilds failed.

Hasil

Guild -- The guild with the guild data parsed.

@application_command(*args, **kwargs)

A shortcut decorator that invokes command() and adds it to the internal command list via add_application().

Baru pada versi 2.0.

Kembali

A decorator that converts the provided method into an ApplicationCommand, adds it to the bot, then returns it.

Tipe pengembalian

Callable[..., ApplicationCommand]

@slash_command(*args, **kwargs)

A shortcut decorator that invokes command() and adds it to the internal command list via add_application(). This shortcut is made specifically for SlashCommand.

Baru pada versi 2.0.

Parameter

  • name (Optional[str]) -- The name of the command. Defaults to the name of the method.

  • description (Optional[str]) -- A short description of the command.

  • guild_ids (Optional[List[int]]) -- Guild IDs where the command can be run on. Setting this will make the command only usable from this guild.

  • checks (Optional[List[Callable[[ApplicationContext], bool]]]) -- A list of predicates that must be true for the command to be invoked.

Kembali

A decorator that converts the provided method into a SlashCommand, adds it to the bot, then returns it.

Tipe pengembalian

Callable[..., SlashCommand]

@user_command(*args, **kwargs)

A shortcut decorator that invokes command() and adds it to the internal command list via add_application(). This shortcut is made specifically for UserCommand.

Baru pada versi 2.0.

Parameter

  • name (Optional[str]) -- The name of the command. Defaults to the name of the method.

  • guild_ids (Optional[List[int]]) -- Guild IDs where the command can be run on. Setting this will make the command only usable from this guild.

  • checks (Optional[List[Callable[[ApplicationContext], bool]]]) -- A list of predicates that must be true for the command to be invoked.

Kembali

A decorator that converts the provided method into a UserCommand, adds it to the bot, then returns it.

Tipe pengembalian

Callable[..., UserCommand]

@message_command(*args, **kwargs)

A shortcut decorator that invokes command() and adds it to the internal command list via add_application(). This shortcut is made specifically for MessageCommand.

Baru pada versi 2.0.

Parameter

  • name (Optional[str]) -- The name of the command. Defaults to the name of the method.

  • guild_ids (Optional[List[int]]) -- Guild IDs where the command can be run on. Setting this will make the command only usable from this guild.

  • checks (Optional[List[Callable[[ApplicationContext], bool]]]) -- A list of predicates that must be true for the command to be invoked.

Kembali

A decorator that converts the provided method into a MessageCommand, adds it to the bot, then returns it.

Tipe pengembalian

Callable[..., MessageCommand]

property latency: float

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

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

tipe

float

is_ws_ratelimited()

bool: Apakah websocket terkena rate limit apa tidak.

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

Baru pada versi 1.6.

property user: Optional[discord.user.ClientUser]

Represents the connected client. None if not logged in.

tipe

Optional[ClientUser]

property guilds: List[discord.guild.Guild]

The guilds that the connected client is a member of.

tipe

List[Guild]

property emojis: List[discord.emoji.Emoji]

The emojis that the connected client has.

tipe

List[Emoji]

property stickers: List[discord.sticker.GuildSticker]

The stickers that the connected client has.

Baru pada versi 2.0.

tipe

List[GuildSticker]

property cached_messages: Sequence[Message]

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

Baru pada versi 1.1.

tipe

Sequence[Message]

property private_channels: List[PrivateChannel]

The private channels that the connected client is participating on.

Catatan

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

tipe

List[abc.PrivateChannel]

property voice_clients: List[VoiceProtocol]

Represents a list of voice connections.

These are usually VoiceClient instances.

tipe

List[VoiceProtocol]

property application_id: Optional[int]

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.

Baru pada versi 2.0.

tipe

Optional[int]

property application_flags: discord.flags.ApplicationFlags

The client's application flags.

Baru pada versi 2.0.

tipe

ApplicationFlags

is_ready()

bool: Menandakan apabila cache internal klien sudah siap dipakai apa tidak.

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

This function is a coroutine.

The default error handler provided by the client.

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

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

Baru pada versi 1.4.

Parameter

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

Parameter

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

Menimbulkan

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

Parameter

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

Menimbulkan

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

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

Menimbulkan

TypeError -- An unexpected keyword argument was received.

run(*args, **kwargs)

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

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

Roughly Equivalent to:

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

Peringatan

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.

await on_connect()

This function is a coroutine.

Initialize application registration. If you decide to override this, you need to make sure that you call register_application_commands() at some point to make sure application commands works.

Or you can do super().on_connect() too.

await register_application_commands()

This function is a coroutine.

Method to start registering and unregistering commands.

is_closed()

bool: Indicates if the websocket connection is closed.

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

The activity being used upon logging in.

tipe

Optional[BaseActivity]

property status

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

property allowed_mentions: Optional[discord.mentions.AllowedMentions]

The allowed mention configuration.

Baru pada versi 1.4.

tipe

Optional[AllowedMentions]

property intents: discord.flags.Intents

The intents configured for this connection.

Baru pada versi 1.5.

tipe

Intents

property users: List[discord.user.User]

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

tipe

List[User]

get_channel(id, /)

Returns a channel or thread with the given ID.

Parameter

id (int) -- The ID to search for.

Kembali

The returned channel or None if not found.

Tipe pengembalian

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.

Baru pada versi 2.0.

Parameter

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

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

Kembali

The partial messageable

Tipe pengembalian

PartialMessageable

get_stage_instance(id, /)

Returns a stage instance with the given stage channel ID.

Baru pada versi 2.0.

Parameter

id (int) -- The ID to search for.

Kembali

The returns stage instance of None if not found.

Tipe pengembalian

Optional[StageInstance]

get_guild(id, /)

Returns a guild with the given ID.

Parameter

id (int) -- The ID to search for.

Kembali

The guild or None if not found.

Tipe pengembalian

Optional[Guild]

get_guild_event(id, /)

Returns a scheduled event with the given ID.

Baru pada versi 2.0.

Parameter

id (int) -- The ID to search for.

Kembali

The event or None if not found.

Tipe pengembalian

Optional[GuildScheduledEvent]

get_user(id, /)

Returns a user with the given ID.

Parameter

id (int) -- The ID to search for.

Kembali

The user or None if not found.

Tipe pengembalian

Optional[User]

get_emoji(id, /)

Returns an emoji with the given ID.

Parameter

id (int) -- The ID to search for.

Kembali

The custom emoji or None if not found.

Tipe pengembalian

Optional[Emoji]

get_sticker(id, /)

Returns a guild sticker with the given ID.

Baru pada versi 2.0.

Catatan

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

Kembali

The sticker or None if not found.

Tipe pengembalian

Optional[GuildSticker]

for ... in get_all_channels()

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

Ini setara dengan:

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

Catatan

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.

Hasil

abc.GuildChannel -- A channel the client can 'access'.

for ... in get_all_members()

Returns a generator with every Member the client can see.

Ini setara dengan:

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

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.

Contoh-contoh

Menunggu jawaban pengguna:

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

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

Menimbulkan

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

Kembali

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

Tipe pengembalian

Any

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

This function is a coroutine.

Changes the client's presence.

Contoh

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

Berubah pada versi 2.0: Removed the afk keyword-only parameter.

Parameter

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

Menimbulkan

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.

Parameter

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

Menimbulkan
Kembali

The template from the URL/code.

Tipe pengembalian

Template

await fetch_guild(guild_id, /)

This function is a coroutine.

Retrieves a Guild from an ID.

Catatan

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

Catatan

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

Parameter

guild_id (int) -- The guild's ID to fetch from.

Menimbulkan
Kembali

The guild from the ID.

Tipe pengembalian

Guild

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

This function is a coroutine.

Creates a Guild.

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

Parameter
Menimbulkan
Kembali

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

Tipe pengembalian

Guild

await fetch_stage_instance(channel_id, /)

This function is a coroutine.

Gets a StageInstance for a stage channel id.

Baru pada versi 2.0.

Parameter

channel_id (int) -- The stage channel ID.

Menimbulkan

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

  • HTTPException -- Getting the stage instance failed.

Kembali

The stage instance from the stage channel ID.

Tipe pengembalian

StageInstance

await fetch_guild_event(guild_id, event_id, /)

This function is a coroutine.

Gets a GuildScheduledEvent for a guild event id.

Baru pada versi 2.0.

Parameter

event_id (int) -- The event ID.

Menimbulkan
Kembali

The event from the event ID.

Tipe pengembalian

GuildScheduledEvent

await fetch_guild_events(guild_id, /)

This function is a coroutine.

Gets a list of GuildScheduledEvent for a guild.

Baru pada versi 2.0.

Parameter

guild_id (int) -- The guild ID to get the events for.

Menimbulkan

HTTPException -- Getting the guild events failed.

Kembali

The list of scheduled events for the guild.

Tipe pengembalian

List[GuildScheduledEvent]

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

This function is a coroutine.

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

Catatan

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.

Parameter
Menimbulkan
Kembali

The invite from the URL/ID.

Tipe pengembalian

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.

Parameter

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

Menimbulkan

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

Catatan

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

Parameter

guild_id (int) -- The ID of the guild.

Menimbulkan
Kembali

The guild's widget.

Tipe pengembalian

Widget

await application_info()

This function is a coroutine.

Retrieves the bot's application information.

Menimbulkan

HTTPException -- Retrieving the information failed somehow.

Kembali

The bot's application information.

Tipe pengembalian

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.

Catatan

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

Parameter

user_id (int) -- The user's ID to fetch from.

Menimbulkan
Kembali

The user you requested.

Tipe pengembalian

User

await fetch_channel(channel_id, /)

This function is a coroutine.

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

Catatan

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

Baru pada versi 1.2.

Menimbulkan

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

Kembali

The channel from the ID.

Tipe pengembalian

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

await fetch_webhook(webhook_id, /)

This function is a coroutine.

Retrieves a Webhook with the specified ID.

Menimbulkan
Kembali

The webhook you requested.

Tipe pengembalian

Webhook

await fetch_sticker(sticker_id, /)

This function is a coroutine.

Retrieves a Sticker with the specified ID.

Baru pada versi 2.0.

Menimbulkan
Kembali

The sticker you requested.

Tipe pengembalian

Union[StandardSticker, GuildSticker]

await fetch_premium_sticker_packs()

This function is a coroutine.

Retrieves all available premium sticker packs.

Baru pada versi 2.0.

Menimbulkan

HTTPException -- Retrieving the sticker packs failed.

Kembali

All available premium sticker packs.

Tipe pengembalian

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.

Baru pada versi 2.0.

Parameter

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

Kembali

The channel that was created.

Tipe pengembalian

DMChannel

add_view(view, *, message_id=None)

Registers a View for persistent listening.

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

Baru pada versi 2.0.

Parameter

  • view (discord.ui.View) -- The view to register for dispatching.

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

Menimbulkan

  • TypeError -- A view was not passed.

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

property persistent_views: Sequence[discord.ui.view.View]

A sequence of persistent views added to the client.

Baru pada versi 2.0.

tipe

Sequence[View]

get_applications()

A list of application that are registered.

Baru pada versi 2.0.

Kembali

List of registered global applications.

Tipe pengembalian

List[ApplicationCommand]

add_application(command)

Register a new application command.

Parameter

command (ApplicationCommand) -- The command to register.

get_application(id)

Get an application by its ID.

Baru pada versi 2.0.

Parameter

id (int) -- The application ID.

Kembali

The application command or None if not found.

Tipe pengembalian

Optional[ApplicationCommand]

await get_application_context(interaction, cls=None)

This function is a coroutine.

Returns the invocation context from the interaction. This is a more low-level counter-part for process_application_commands() to allow users more fine grained control over the processing.

Parameter

  • interaction (discord.Interaction) -- The interaction to get the invocation context from.

  • cls -- The factory class that will be used to create the context. By default, this is ApplicationContext. Should a custom class be provided, it must be similar enough to ApplicationContext's interface.

Kembali

The invocation context. The type of this can change via the cls parameter.

Tipe pengembalian

ApplicationContext

await on_application_error(context, exception)

This function is a coroutine.

The default command error handler provided by the bot.

By default this prints to sys.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 on_interaction(interaction)

This function is a coroutine.

This event handle should handle all interaction coming from Discord. This would pass the information into process_application_commands()

If you're overriding this, please dont forget to call the process_application_commands() or the application wont work.

Parameter

interaction (discord.Interaction) -- The interaction to process

await process_application_commands(interaction)

This function is a coroutine.

This function processes the commands that have been registered to the bot and other groups. Without this coroutine, none of the commands will be triggered.

By default, this coroutine is called inside the on_interaction() event. If you choose to override the on_interaction() event, then you should invoke this coroutine as well.

This function finds a registered command matching the interaction id from ApplicationCommandMixin.application_command() and runs ApplicationCommand.invoke() on it. If no matching command was found, it replies to the interaction with a default message.

Baru pada versi 2.0.

Parameter

interaction (discord.Interaction) -- The interaction to process

register_application(command, *, force=False)

Register the command to the factories and remove from pending section. Please make sure the app already been registered to Discord.

Parameter

  • command (ApplicationCommand) -- The command to register.

  • force (bool) -- If True, the command will be registered even if it's not registered to Discord.

remove_application(command)

Remove command from the list of registered commands.

Parameter

command (ApplicationCommand) -- The command to register.

get_guild_applications(guild_id)

A list of application that are registered for a guild.

Baru pada versi 2.0.

Parameter

guild_id (int) -- The guild ID.

Kembali

List of registered applications for a guild.

Tipe pengembalian

List[ApplicationCommand]

get_guild_application(id, app_id)

A list of application that are registered for a guild.

Baru pada versi 2.0.

Parameter

  • id (int) -- The guild ID.

  • app_id (int) -- The application ID.

Kembali

The application command or None if not found.

Tipe pengembalian

Optional[ApplicationCommand]

await fetch_global_applications()

This function is a coroutine.

Get all registered global commands on Discord.

Baru pada versi 2.0.

Catatan

This method is an API call. For general usage use get_applications().

Menimbulkan

HTTPException -- Retrieving the global application commands failed.

Kembali

The collection of global command that registred on Discord.

Tipe pengembalian

List[Union[ApplicationCommand, RawApplicationCommand]]

await fetch_guild_applications(guild_id)

This function is a coroutine.

Get all registered guild commands on Discord.

Baru pada versi 2.0.

Catatan

This method is an API call. For general usage use get_guild_applications().

Parameter

guild_id (int) -- The guild ID to be fetched.

Menimbulkan

HTTPException -- Retrieving the guild application commands failed.

Kembali

The collection of guild command that registred on Discord.

Tipe pengembalian

List[Union[ApplicationCommand, RawApplicationCommand]]

await is_owner(user)

This function is a coroutine.

Checks if a User or Member is the owner of this bot.

Parameter

user (abc.User) -- The user to check for.

Kembali

Whether the user is the owner.

Tipe pengembalian

bool

AutoShardedClient

Attributes
Methods
class discord.AutoShardedClient(*args, **kwargs)

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

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

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

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

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

shard_ids

An optional list of shard_ids to launch the shards with.

tipe

Optional[List[int]]

property latency: float

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

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

tipe

float

property latencies: List[Tuple[int, float]]

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

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

tipe

List[Tuple[int, float]]

get_shard(shard_id)

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

property shards: Dict[int, discord.shard.ShardInfo]

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

tipe

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.

Parameter

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

Menimbulkan

  • 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 on_shard_connect(shard_id)

This function is a coroutine.

Initialize application registration to first shard.

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

This function is a coroutine.

Changes the client's presence.

Contoh:

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

Berubah pada versi 2.0: Removed the afk keyword-only parameter.

Parameter

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

Menimbulkan

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

is_ws_ratelimited()

bool: Apakah websocket terkena rate limit apa tidak.

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

Baru pada versi 1.6.

Application Info

AppInfo

Attributes
class discord.AppInfo

Represents the application info for the bot provided by Discord.

id

The application ID.

tipe

int

name

The application name.

tipe

str

owner

The application owner.

tipe

User

team

The application's team.

Baru pada versi 1.3.

tipe

Optional[Team]

description

The application description.

tipe

str

bot_public

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

tipe

bool

bot_require_code_grant

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

tipe

bool

rpc_origins

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

tipe

Optional[List[str]]

summary

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

Baru pada versi 1.3.

tipe

str

verify_key

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

Baru pada versi 1.3.

tipe

str

guild_id

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

Baru pada versi 1.3.

tipe

Optional[int]

primary_sku_id

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

Baru pada versi 1.3.

tipe

Optional[int]

slug

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

Baru pada versi 1.3.

tipe

Optional[str]

terms_of_service_url

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

Baru pada versi 2.0.

tipe

Optional[str]

privacy_policy_url

The application's privacy policy URL, if set.

Baru pada versi 2.0.

tipe

Optional[str]

property icon: Optional[discord.asset.Asset]

Retrieves the application's icon asset, if any.

tipe

Optional[Asset]

property cover_image: Optional[discord.asset.Asset]

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

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

tipe

Optional[Asset]

property guild: Optional[Guild]

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

Baru pada versi 1.3.

tipe

Optional[Guild]

PartialAppInfo

Attributes
class discord.PartialAppInfo

Represents a partial AppInfo given by create_invite()

Baru pada versi 2.0.

id

The application ID.

tipe

int

name

The application name.

tipe

str

description

The application description.

tipe

str

rpc_origins

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

tipe

Optional[List[str]]

summary

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

tipe

str

verify_key

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

tipe

str

terms_of_service_url

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

tipe

Optional[str]

privacy_policy_url

The application's privacy policy URL, if set.

tipe

Optional[str]

property icon: Optional[discord.asset.Asset]

Retrieves the application's icon asset, if any.

tipe

Optional[Asset]

Team

Attributes
class discord.Team

Represents an application team for a bot provided by Discord.

id

The team ID.

tipe

int

name

The team name

tipe

str

owner_id

The team's owner ID.

tipe

int

members

A list of the members in the team

Baru pada versi 1.3.

tipe

List[TeamMember]

property icon: Optional[discord.asset.Asset]

Retrieves the team's icon asset, if any.

tipe

Optional[Asset]

property owner: Optional[discord.team.TeamMember]

The team's owner.

tipe

Optional[TeamMember]

TeamMember

Attributes
class discord.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.

Baru pada versi 1.3.

name

The team member's username.

tipe

str

id

The team member's unique ID.

tipe

int

discriminator

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

tipe

str

avatar

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

tipe

Optional[str]

bot

Specifies if the user is a bot account.

tipe

bool

team

The team that the member is from.

tipe

Team

membership_state

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

tipe

TeamMembershipState

Event Reference

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

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

import discord

class MyClient(discord.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.

Peringatan

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

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

discord.on_shard_connect(shard_id)

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

Baru pada versi 1.4.

Parameter

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

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

discord.on_shard_disconnect(shard_id)

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

Baru pada versi 1.4.

Parameter

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

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

Peringatan

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.

discord.on_shard_ready(shard_id)

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

Parameter

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

discord.on_resumed()

Called when the client has resumed a session.

discord.on_shard_resumed(shard_id)

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

Baru pada versi 1.4.

Parameter

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

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

Catatan

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

Parameter

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

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

Baru pada versi 2.0.

Parameter

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

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

Catatan

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

Parameter

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

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

Catatan

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

Parameter

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.

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

Parameter

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

discord.on_message(message)

Called when a Message is created and sent.

This requires Intents.messages to be enabled.

Peringatan

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.

Parameter

message (Message) -- The current message.

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

Parameter

message (Message) -- The deleted message.

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

Parameter

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

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

Parameter

payload (RawMessageDeleteEvent) -- The raw event payload data.

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

Parameter

payload (RawBulkMessageDeleteEvent) -- The raw event payload data.

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

Parameter

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

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

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

Parameter

payload (RawMessageUpdateEvent) -- The raw event payload data.

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

Catatan

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

This requires Intents.reactions to be enabled.

Catatan

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.

Parameter

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

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

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

Parameter

payload (RawReactionActionEvent) -- The raw event payload data.

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

Catatan

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

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

Catatan

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

Parameter

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

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

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

Parameter

payload (RawReactionActionEvent) -- The raw event payload data.

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

Parameter

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

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

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

Parameter

payload (RawReactionClearEvent) -- The raw event payload data.

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

Baru pada versi 1.3.

Parameter

reaction (Reaction) -- The reaction that got cleared.

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

Baru pada versi 1.3.

Parameter

payload (RawReactionClearEmojiEvent) -- The raw event payload data.

discord.on_interaction(interaction)

Called when an interaction happened.

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

Peringatan

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.

Baru pada versi 2.0.

Parameter

interaction (Interaction) -- The interaction data.

discord.on_application_registered()

Called after the bot has registered every application commands with Discord.

Baru pada versi 2.0.

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

Parameter

  • before (GroupChannel) -- The updated group channel's old info.

  • after (GroupChannel) -- The updated group channel's new info.

discord.on_private_channel_pins_update(channel, last_pin)

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

Parameter

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

discord.on_guild_channel_delete(channel)
discord.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.

Parameter

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

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

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

Parameter

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

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

discord.on_guild_scheduled_event_create(event)

Called whenever a scheduled event is created from a guild.

This requires Intents.guild_scheduled_events to be enabled.

Baru pada versi 2.0.

Parameter

event (GuildScheduledEvent) -- The scheduled event that got created.

discord.on_guild_scheduled_event_remove(event)

Called whenever a scheduled event is removed from a guild.

This requires Intents.guild_scheduled_events to be enabled.

Baru pada versi 2.0.

Parameter

event (GuildScheduledEvent) -- The scheduled event that got removed.

discord.on_guild_scheduled_event_update(before, after)

Called whenever a scheduled event is updated from a guild.

This requires Intents.guild_scheduled_events to be enabled.

Baru pada versi 2.0.

Parameter
discord.on_guild_scheduled_event_member_join(event, member)
discord.on_guild_scheduled_event_member_remove(event, member)

Called whenever a Member or an User leaves or joins a GuildScheduledEvent

You can later access the member via GuildScheduledEvent.get_member() or GuildScheduledEvent.members.

This requires Intents.guild_scheduled_events to be enabled.

Baru pada versi 2.0.

Parameter
discord.on_thread_join(thread)

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

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

This requires Intents.guilds to be enabled.

Baru pada versi 2.0.

Parameter

thread (Thread) -- The thread that got joined.

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

Peringatan

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.

Baru pada versi 2.0.

Parameter

thread (Thread) -- The thread that got removed.

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

Baru pada versi 2.0.

Parameter

thread (Thread) -- The thread that got deleted.

discord.on_thread_member_join(member)
discord.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.

Baru pada versi 2.0.

Parameter

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

discord.on_thread_update(before, after)

Called whenever a thread is updated.

This requires Intents.guilds to be enabled.

Baru pada versi 2.0.

Parameter

  • before (Thread) -- The updated thread's old info.

  • after (Thread) -- The updated thread's new info.

discord.on_guild_integrations_update(guild)

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

This requires Intents.integrations to be enabled.

Baru pada versi 1.4.

Parameter

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

discord.on_integration_create(integration)

Called when an integration is created.

This requires Intents.integrations to be enabled.

Baru pada versi 2.0.

Parameter

integration (Integration) -- The integration that was created.

discord.on_integration_update(integration)

Called when an integration is updated.

This requires Intents.integrations to be enabled.

Baru pada versi 2.0.

Parameter

integration (Integration) -- The integration that was created.

discord.on_raw_integration_delete(payload)

Called when an integration is deleted.

This requires Intents.integrations to be enabled.

Baru pada versi 2.0.

Parameter

payload (RawIntegrationDeleteEvent) -- The raw event payload data.

discord.on_raw_thread_delete(payload)

Called whenever a thread is deleted. Unlike on_thread_delete() this is called regardless of the thread being in the internal thread cache or not.

This requires Intents.guilds to be enabled.

Baru pada versi 2.0.

Parameter

payload (RawThreadDeleteEvent) -- The raw event payload data.

discord.on_webhooks_update(channel)

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

This requires Intents.webhooks to be enabled.

Parameter

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

discord.on_member_join(member)
discord.on_member_remove(member)

Called when a Member leaves or joins a Guild.

This requires Intents.members to be enabled.

Parameter

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

discord.on_member_update(before, after)

Called when a Member updates their profile.

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

  • nickname

  • roles

  • pending

This requires Intents.members to be enabled.

Parameter

  • before (Member) -- The updated member's old info.

  • after (Member) -- The updated member's updated info.

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

Baru pada versi 2.0.

Parameter

  • before (Member) -- The updated member's old info.

  • after (Member) -- The updated member's updated info.

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

Parameter

  • before (User) -- The updated user's old info.

  • after (User) -- The updated user's updated info.

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

Parameter

guild (Guild) -- The guild that was joined.

discord.on_guild_remove(guild)

Called when a Guild is removed from the Client.

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

  • The client got banned.

  • The client got kicked.

  • The client left the guild.

  • The client or the guild owner deleted the guild.

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

This requires Intents.guilds to be enabled.

Parameter

guild (Guild) -- The guild that got removed.

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

Parameter

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

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

discord.on_guild_role_create(role)
discord.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.

Parameter

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

discord.on_guild_role_update(before, after)

Called when a Role is changed guild-wide.

This requires Intents.guilds to be enabled.

Parameter

  • before (Role) -- The updated role's old info.

  • after (Role) -- The updated role's updated info.

discord.on_guild_emojis_update(guild, before, after)

Called when a Guild adds or removes Emoji.

This requires Intents.emojis_and_stickers to be enabled.

Parameter

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

discord.on_guild_stickers_update(guild, before, after)

Called when a Guild updates its stickers.

This requires Intents.emojis_and_stickers to be enabled.

Baru pada versi 2.0.

Parameter

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

discord.on_guild_available(guild)
discord.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.

Parameter

guild -- The Guild that has changed availability.

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

Parameter

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

discord.on_stage_instance_create(stage_instance)
discord.on_stage_instance_delete(stage_instance)

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

Baru pada versi 2.0.

Parameter

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

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

Baru pada versi 2.0.

Parameter
discord.on_member_ban(guild, user)

Called when user gets banned from a Guild.

This requires Intents.bans to be enabled.

Parameter

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

discord.on_member_unban(guild, user)

Called when a User gets unbanned from a Guild.

This requires Intents.bans to be enabled.

Parameter

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

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

discord.on_invite_create(invite)

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

Baru pada versi 1.3.

Catatan

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.

Parameter

invite (Invite) -- The invite that was created.

discord.on_invite_delete(invite)

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

Baru pada versi 1.3.

Catatan

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.

Parameter

invite (Invite) -- The invite that was deleted.

discord.on_group_join(channel, user)
discord.on_group_remove(channel, user)

Called when someone joins or leaves a GroupChannel.

Parameter

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

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

Utility Functions

discord.utils.find(predicate, seq)

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

member = discord.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.

Parameter

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

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

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

Contoh-contoh

Basic usage:

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

Multiple attribute matching:

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

Nested attribute matching:

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

  • iterable -- An iterable to search through.

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

discord.utils.snowflake_time(id)
Parameter

id (int) -- The snowflake ID.

Kembali

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

Tipe pengembalian

datetime.datetime

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

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

Parameter

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

    Baru pada versi 1.7.

  • disable_guild_select (bool) --

    Whether to disallow the user from changing the guild dropdown.

    Baru pada versi 2.0.

Kembali

The OAuth2 URL for inviting the bot into guilds.

Tipe pengembalian

str

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

A helper function that removes markdown characters.

Baru pada versi 1.7.

Catatan

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.

Parameter

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

Kembali

The text with the markdown special characters removed.

Tipe pengembalian

str

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

A helper function that escapes Discord's markdown.

Parameter

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

Kembali

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

Tipe pengembalian

str

discord.utils.escape_mentions(text)

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

Catatan

This does not include channel mentions.

Catatan

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

Parameter

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

Kembali

The text with the mentions removed.

Tipe pengembalian

str

discord.utils.resolve_invite(invite)

Resolves an invite from a Invite, URL or code.

Parameter

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

Kembali

The invite code.

Tipe pengembalian

str

discord.utils.resolve_template(code)

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

Baru pada versi 1.4.

Parameter

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

Kembali

The template code.

Tipe pengembalian

str

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

Baru pada versi 1.3.

Parameter

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

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

Baru pada versi 2.0.

Kembali

The current aware datetime in UTC.

Tipe pengembalian

datetime.datetime

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

Baru pada versi 2.0.

Parameter

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

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

Kembali

The formatted string.

Tipe pengembalian

str

discord.utils.as_chunks(iterator, max_size)

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

Baru pada versi 2.0.

Parameter

Peringatan

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

Kembali

A new iterator which yields chunks of a given size.

Tipe pengembalian

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

Specifies the type of channel.

text

A text channel.

voice

A voice channel.

private

A private text channel. Also called a direct message.

group

A private group text channel.

category

A category channel.

news

A guild news channel.

store

A guild store channel.

stage_voice

A guild stage voice channel.

Baru pada versi 1.7.

news_thread

A news thread

Baru pada versi 2.0.

public_thread

A public thread

Baru pada versi 2.0.

private_thread

A private thread

Baru pada versi 2.0.

class discord.MessageType

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

x == y

Checks if two messages are equal.

x != y

Checks if two messages are not equal.

default

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

recipient_add

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

recipient_remove

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

call

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

channel_name_change

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

channel_icon_change

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

pins_add

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

new_member

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

premium_guild_subscription

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

premium_guild_tier_1

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

premium_guild_tier_2

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

premium_guild_tier_3

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

channel_follow_add

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

Baru pada versi 1.3.

guild_stream

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

Baru pada versi 1.7.

guild_discovery_disqualified

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

Baru pada versi 1.7.

guild_discovery_requalified

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

Baru pada versi 1.7.

guild_discovery_grace_period_initial_warning

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

Baru pada versi 1.7.

guild_discovery_grace_period_final_warning

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

Baru pada versi 1.7.

thread_created

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

Baru pada versi 2.0.

reply

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

Baru pada versi 2.0.

chat_input_command

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

Baru pada versi 2.0.

Catatan

Originally this was application_command, but changed following Discord changes.

guild_invite_reminder

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

Baru pada versi 2.0.

thread_starter_message

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

Baru pada versi 2.0.

context_menu_command

The system message denoting that an context menu ("user" or "message") command was executed.

Baru pada versi 2.0.

class discord.UserFlags

Represents Discord User flags.

staff

The user is a Discord Employee.

partner

The user is a Discord Partner.

hypesquad

The user is a HypeSquad Events member.

bug_hunter

The user is a Bug Hunter.

mfa_sms

The user has SMS recovery for Multi Factor Authentication enabled.

premium_promo_dismissed

The user has dismissed the Discord Nitro promotion.

hypesquad_bravery

The user is a HypeSquad Bravery member.

hypesquad_brilliance

The user is a HypeSquad Brilliance member.

hypesquad_balance

The user is a HypeSquad Balance member.

early_supporter

The user is an Early Supporter.

team_user

The user is a Team User.

system

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

has_unread_urgent_messages

The user has an unread system message.

bug_hunter_level_2

The user is a Bug Hunter Level 2.

verified_bot

The user is a Verified Bot.

verified_bot_developer

The user is an Early Verified Bot Developer.

discord_certified_moderator

The user is a Discord Certified Moderator.

class discord.ActivityType

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

unknown

An unknown activity type. This should generally not happen.

playing

A "Playing" activity type.

streaming

A "Streaming" activity type.

listening

A "Listening" activity type.

watching

A "Watching" activity type.

custom

A custom activity type.

competing

A competing activity type.

Baru pada versi 1.5.

class discord.InteractionType

Specifies the type of Interaction.

Baru pada versi 2.0.

ping

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

application_command

Represents a slash command interaction.

component

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

class discord.InteractionResponseType

Specifies the response type for the interaction.

Baru pada versi 2.0.

pong

Pongs the interaction when given a ping.

See also InteractionResponse.pong()

channel_message

Respond to the interaction with a message.

See also InteractionResponse.send_message()

deferred_channel_message

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

See also InteractionResponse.defer()

deferred_message_update

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

See also InteractionResponse.defer()

message_update

Responds to the interaction by editing the message.

See also InteractionResponse.edit_message()

class discord.ApplicationCommandType

Represents the application type that Discord have.

Baru pada versi 2.0.

slash

Represents a slash command.

user

Represents a user context command.

message

Represents a message context command.

class discord.SlashCommandOptionType

Represents the slash command option type.

Baru pada versi 2.0.

sub_command

Represents a slash subcommand.

sub_command_group

Represents a slash subcommand group.

string

Represents that the option is a string.

integer

Represents that the option is a integer.

boolean

Represents that the option is a boolean (true/false).

user

Represents that the option is a User or Member.

channel

Represents that the option is a GuildChannel.

role

Represents that the option is a Role.

mentionable

Represents that the option is a mentionable type.

Should be one of:

number

Represents that the option is a number.

It support both float and int.

custom

Represents a custom type.

You should provide a way to parse this custom format later.

class discord.ComponentType

Represents the component type of a component.

Baru pada versi 2.0.

action_row

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

button

Represents a button component.

select

Represents a select component.

class discord.ButtonStyle

Represents the style of the button component.

Baru pada versi 2.0.

primary

Represents a blurple button for the primary action.

secondary

Represents a grey button for the secondary action.

success

Represents a green button for a successful action.

danger

Represents a red button for a dangerous action.

Represents a link button.

blurple

An alias for primary.

grey

An alias for secondary.

gray

An alias for secondary.

green

An alias for success.

red

An alias for danger.

url

An alias for link.

class discord.VoiceRegion

Specifies the region a voice server belongs to.

amsterdam

The Amsterdam region.

brazil

The Brazil region.

dubai

The Dubai region.

Baru pada versi 1.3.

eu_central

The EU Central region.

eu_west

The EU West region.

europe

The Europe region.

Baru pada versi 1.3.

frankfurt

The Frankfurt region.

hongkong

The Hong Kong region.

india

The India region.

Baru pada versi 1.2.

japan

The Japan region.

london

The London region.

russia

The Russia region.

singapore

The Singapore region.

southafrica

The South Africa region.

south_korea

The South Korea region.

sydney

The Sydney region.

us_central

The US Central region.

us_east

The US East region.

us_south

The US South region.

us_west

The US West region.

vip_amsterdam

The Amsterdam region for VIP guilds.

vip_us_east

The US East region for VIP guilds.

vip_us_west

The US West region for VIP guilds.

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

Baru pada versi 2.0.

x == y

Checks if two verification levels are equal.

x != y

Checks if two verification levels are not equal.

x > y

Checks if a verification level is higher than another.

x < y

Checks if a verification level is lower than another.

x >= y

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

x <= y

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

none

No criteria set.

low

Member must have a verified email on their Discord account.

medium

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

high

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

highest

Member must have a verified phone on their Discord account.

class discord.NotificationLevel

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

Baru pada versi 2.0.

x == y

Checks if two notification levels are equal.

x != y

Checks if two notification levels are not equal.

x > y

Checks if a notification level is higher than another.

x < y

Checks if a notification level is lower than another.

x >= y

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

x <= y

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

all_messages

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

only_mentions

Members receive notifications for messages they are mentioned in.

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

Baru pada versi 2.0.

x == y

Checks if two content filter levels are equal.

x != y

Checks if two content filter levels are not equal.

x > y

Checks if a content filter level is higher than another.

x < y

Checks if a content filter level is lower than another.

x >= y

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

x <= y

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

disabled

The guild does not have the content filter enabled.

no_role

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

all_members

The guild has the content filter enabled for every member.

class discord.Status

Specifies a Member 's status.

online

The member is online.

offline

The member is offline.

idle

The member is idle.

dnd

The member is "Do Not Disturb".

do_not_disturb

An alias for dnd.

invisible

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

class discord.AuditLogAction

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

guild_update

The guild has updated. Things that trigger this include:

  • Changing the guild vanity URL

  • Changing the guild invite splash

  • Changing the guild AFK channel or timeout

  • Changing the guild voice server region

  • Changing the guild icon, banner, or discovery splash

  • Changing the guild moderation settings

  • Changing things related to the guild widget

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

Possible attributes for AuditLogDiff:

channel_create

A new channel was created.

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

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

Possible attributes for AuditLogDiff:

channel_update

A channel was updated. Things that trigger this include:

  • The channel name or topic was changed

  • The channel bitrate was changed

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

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

Possible attributes for AuditLogDiff:

channel_delete

A channel was deleted.

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

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

Possible attributes for AuditLogDiff:

overwrite_create

A channel permission overwrite was created.

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

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

Possible attributes for AuditLogDiff:

overwrite_update

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

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

Possible attributes for AuditLogDiff:

overwrite_delete

A channel permission overwrite was deleted.

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

Possible attributes for AuditLogDiff:

kick

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

A member prune was triggered.

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

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

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

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

When this is the action, changes is empty.

ban

A member was banned.

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

When this is the action, changes is empty.

unban

A member was unbanned.

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

When this is the action, changes is empty.

member_update

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

  • A nickname was changed

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

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

Possible attributes for AuditLogDiff:

member_role_update

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

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

Possible attributes for AuditLogDiff:

member_move

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

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

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

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

Baru pada versi 1.3.

member_disconnect

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

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

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

Baru pada versi 1.3.

bot_add

A bot was added to the guild.

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

Baru pada versi 1.3.

role_create

A new role was created.

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

Berubah pada versi 2.0: Added icon and unicode_emoji.

Possible attributes for AuditLogDiff:

role_update

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

  • The name has changed

  • The permissions have changed

  • The colour has changed

  • Its hoist/mentionable state has changed

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

Berubah pada versi 2.0: Added icon and unicode_emoji.

Possible attributes for AuditLogDiff:

role_delete

A role was deleted.

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

Berubah pada versi 2.0: Added icon and unicode_emoji.

Possible attributes for AuditLogDiff:

invite_create

An invite was created.

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

Possible attributes for AuditLogDiff:

invite_update

An invite was updated.

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

invite_delete

An invite was deleted.

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

Possible attributes for AuditLogDiff:

webhook_create

A webhook was created.

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

Possible attributes for AuditLogDiff:

webhook_update

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

  • The webhook name changed

  • The webhook channel changed

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

Possible attributes for AuditLogDiff:

webhook_delete

A webhook was deleted.

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

Possible attributes for AuditLogDiff:

emoji_create

An emoji was created.

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

Possible attributes for AuditLogDiff:

emoji_update

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

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

Possible attributes for AuditLogDiff:

emoji_delete

An emoji was deleted.

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

Possible attributes for AuditLogDiff:

message_delete

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

When this is the action, the type of target is the Member or User who had their message deleted.

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

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

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

message_bulk_delete

Messages were bulk deleted by a moderator.

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

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

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

Baru pada versi 1.3.

message_pin

A message was pinned in a channel.

When this is the action, the type of target is the Member or User who had their message pinned.

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.

Baru pada versi 1.3.

message_unpin

A message was unpinned in a channel.

When this is the action, the type of target is the Member or User who had their message unpinned.

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.

Baru pada versi 1.3.

integration_create

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.

Baru pada versi 1.3.

integration_update

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.

Baru pada versi 1.3.

integration_delete

A guild integration was deleted.

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

Baru pada versi 1.3.

stage_instance_create

A stage instance was started.

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

Possible attributes for AuditLogDiff:

Baru pada versi 2.0.

stage_instance_update

A stage instance was updated.

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

Possible attributes for AuditLogDiff:

Baru pada versi 2.0.

stage_instance_delete

A stage instance was ended.

Baru pada versi 2.0.

sticker_create

A sticker was created.

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

Possible attributes for AuditLogDiff:

Baru pada versi 2.0.

sticker_update

A sticker was updated.

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

Possible attributes for AuditLogDiff:

Baru pada versi 2.0.

sticker_delete

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 AuditLogDiff:

Baru pada versi 2.0.

guild_scheduled_event_create

A guild scheduled event was created.

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

Possible attribute for AuditLogDiff:

Baru pada versi 2.0.

guild_scheduled_event_update

A guild scheduled event was updated.

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

Possible attribute for AuditLogDiff:

Baru pada versi 2.0.

guild_scheduled_event_delete

A guild scheduled event was deleted.

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

Possible attribute for AuditLogDiff:

Baru pada versi 2.0.

thread_create

A thread was created.

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

Possible attributes for AuditLogDiff:

Baru pada versi 2.0.

thread_update

A thread was updated.

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

Possible attributes for AuditLogDiff:

Baru pada versi 2.0.

thread_delete

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 AuditLogDiff:

Baru pada versi 2.0.

class discord.AuditLogActionCategory

Represents the category that the AuditLogAction belongs to.

This can be retrieved via AuditLogEntry.category.

create

The action is the creation of something.

delete

The action is the deletion of something.

update

The action is the update of something.

class discord.TeamMembershipState

Represents the membership state of a team member retrieved through Client.application_info().

Baru pada versi 1.3.

invited

Represents an invited member.

accepted

Represents a member currently in the team.

class discord.WebhookType

Represents the type of webhook that can be received.

Baru pada versi 1.3.

incoming

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

channel_follower

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

application

Represents a webhook that is used for interactions or applications.

Baru pada versi 2.0.

class discord.ExpireBehaviour

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

There is an alias for this called ExpireBehavior.

Baru pada versi 1.4.

remove_role

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

kick

This will kick the user when their subscription is finished.

class discord.DefaultAvatar

Represents the default avatar of a Discord User

blurple

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

grey

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

gray

An alias for grey.

green

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

orange

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

red

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

class discord.StickerType

Represents the type of sticker.

Baru pada versi 2.0.

standard

Represents a standard sticker that all Nitro users can use.

guild

Represents a custom sticker created in a guild.

class discord.StickerFormatType

Represents the type of sticker images.

Baru pada versi 1.6.

png

Represents a sticker with a png image.

apng

Represents a sticker with an apng image.

lottie

Represents a sticker with a lottie image.

class discord.InviteTarget

Represents the invite type for voice channel invites.

Baru pada versi 2.0.

unknown

The invite doesn't target anyone or anything.

stream

A stream invite that targets a user.

embedded_application

A stream invite that targets an embedded application.

class discord.VideoQualityMode

Represents the camera video quality mode for voice channel participants.

Baru pada versi 2.0.

auto

Represents auto camera video quality.

full

Represents full camera video quality.

class discord.StagePrivacyLevel

Represents a stage instance's privacy level.

Baru pada versi 2.0.

public

The stage instance can be joined by external users.

closed

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

guild_only

Alias for closed

class discord.NSFWLevel

Represents the NSFW level of a guild.

Baru pada versi 2.0.

x == y

Checks if two NSFW levels are equal.

x != y

Checks if two NSFW levels are not equal.

x > y

Checks if a NSFW level is higher than another.

x < y

Checks if a NSFW level is lower than another.

x >= y

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

x <= y

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

default

The guild has not been categorised yet.

explicit

The guild contains NSFW content.

safe

The guild does not contain any NSFW content.

age_restricted

The guild may contain NSFW content.

class discord.GuildScheduledEventType

Represents the type of a guild scheduled event.

Baru pada versi 2.0.

none

The guild event has not been categorised yet.

stage_instance

The guild event is a stage instance.

voice

The guild event is a voice event.

location

The guild event is a location based event.

class discord.GuildScheduledEventStatus

Represents the status of a guild scheduled event.

Baru pada versi 2.0.

scheduled

The guild event is scheduled/upcoming.

active

The guild event is currently ongoing.

completed

The guild event is already finished.

canceled

The guild event is canceled.

class discord.GuildScheduledEventPrivacyLevel

Represents the privacy level of a guild scheduled event. Almost the same as StagePrivacyLevel.

Baru pada versi 2.0.

public

The guild event is public and can be seen from discovery.

members_only

The guild event is only visible and can only be joined by the members of the guild

Async Iterator

Some API functions return an "async iterator". An async iterator is something that is capable of being used in an async for statement.

These async iterators can be used as follows:

async for elem in channel.history():
    # do stuff with elem here

Certain utilities make working with async iterators easier, detailed below.

class discord.AsyncIterator

Represents the "AsyncIterator" concept. Note that no such class exists, it is purely abstract.

async for x in y

Iterates over the contents of the async iterator.

await next()

This function is a coroutine.

Advances the iterator by one, if possible. If no more items are found then this raises NoMoreItems.

await get(**attrs)

This function is a coroutine.

Similar to utils.get() except run over the async iterator.

Getting the last message by a user named 'Dave' or None:

msg = await channel.history().get(author__name='Dave')
await find(predicate)

This function is a coroutine.

Similar to utils.find() except run over the async iterator.

Unlike utils.find(), the predicate provided can be a coroutine.

Getting the last audit log with a reason or None:

def predicate(event):
    return event.reason is not None

event = await guild.audit_logs().find(predicate)
Parameter

predicate -- The predicate to use. Could be a coroutine.

Kembali

The first element that returns True for the predicate or None.

await flatten()

This function is a coroutine.

Flattens the async iterator into a list with all the elements.

Kembali

A list of every element in the async iterator.

Tipe pengembalian

list

chunk(max_size)

Collects items into chunks of up to a given maximum size. Another AsyncIterator is returned which collects items into lists of a given size. The maximum chunk size must be a positive integer.

Baru pada versi 1.6.

Collecting groups of users:

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

Peringatan

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

Parameter

max_size -- The size of individual chunks.

Tipe pengembalian

AsyncIterator

map(func)

This is similar to the built-in map function. Another AsyncIterator is returned that executes the function on every element it is iterating over. This function can either be a regular function or a coroutine.

Creating a content iterator:

def transform(message):
    return message.content

async for content in channel.history().map(transform):
    message_length = len(content)
Parameter

func -- The function to call on every element. Could be a coroutine.

Tipe pengembalian

AsyncIterator

filter(predicate)

This is similar to the built-in filter function. Another AsyncIterator is returned that filters over the original async iterator. This predicate can be a regular function or a coroutine.

Getting messages by non-bot accounts:

def predicate(message):
    return not message.author.bot

async for elem in channel.history().filter(predicate):
    ...
Parameter

predicate -- The predicate to call on every element. Could be a coroutine.

Tipe pengembalian

AsyncIterator

Audit Log Data

Working with Guild.audit_logs() is a complicated process with a lot of machinery involved. The library attempts to make it easy to use and friendly. In order to accomplish this goal, it must make use of a couple of data classes that aid in this goal.

AuditLogEntry

Attributes
class discord.AuditLogEntry(*, users, data, guild)

Represents an Audit Log entry.

You retrieve these via Guild.audit_logs().

x == y

Checks if two entries are equal.

x != y

Checks if two entries are not equal.

hash(x)

Returns the entry's hash.

Berubah pada versi 1.7: Audit log entries are now comparable and hashable.

action

The action that was done.

tipe

AuditLogAction

user

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

tipe

abc.User

id

The entry ID.

tipe

int

target

The target that got changed. The exact type of this depends on the action being done.

tipe

Any

reason

The reason this action was done.

tipe

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.

tipe

Any

created_at

Returns the entry's creation time in UTC.

tipe

datetime.datetime

category

The category of the action, if applicable.

tipe

Optional[AuditLogActionCategory]

changes

The list of changes this entry has.

tipe

AuditLogChanges

before

The target's prior state.

tipe

AuditLogDiff

after

The target's subsequent state.

tipe

AuditLogDiff

AuditLogChanges

Attributes
class discord.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
class discord.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.

tipe

str

icon

Depending on the action type, this may be a guild's icon or a role's icon.

See also Guild.icon or Role.icon.

tipe

Asset

splash

The guild's invite splash. See also Guild.splash.

tipe

Asset

discovery_splash

The guild's discovery splash. See also Guild.discovery_splash.

tipe

Asset

banner

The guild's banner. See also Guild.banner.

tipe

Asset

owner

The guild's owner. See also Guild.owner

tipe

Union[Member, User]

region

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

tipe

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.

tipe

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.

tipe

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.

tipe

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.

tipe

Union[TextChannel, Object]

afk_timeout

The guild's AFK timeout. See Guild.afk_timeout.

tipe

int

mfa_level

The guild's MFA level. See Guild.mfa_level.

tipe

int

widget_enabled

The guild's widget has been enabled or disabled.

tipe

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.

tipe

Union[TextChannel, Object]

verification_level

The guild's verification level.

See also Guild.verification_level.

tipe

VerificationLevel

default_notifications

The guild's default notification level.

See also Guild.default_notifications.

tipe

NotificationLevel

explicit_content_filter

The guild's content filter.

See also Guild.explicit_content_filter.

tipe

ContentFilter

default_message_notifications

The guild's default message notification setting.

tipe

int

vanity_url_code

The guild's vanity URL.

See also Guild.vanity_invite() and Guild.edit().

tipe

str

position

The position of a Role or abc.GuildChannel.

tipe

int

type

The type of channel or sticker.

tipe

Union[ChannelType, StickerType]

topic

The topic of a TextChannel or StageChannel.

See also TextChannel.topic or StageChannel.topic.

tipe

str

bitrate

The bitrate of a VoiceChannel.

See also VoiceChannel.bitrate.

tipe

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.

tipe

List[Tuple[target, PermissionOverwrite]]

privacy_level

The privacy level of the stage instance or guild events.

tipe

Union[StagePrivacyLevel, GuildScheduledEventStatus]

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.

tipe

List[Union[Role, Object]]

nick

The nickname of a member.

See also Member.nick

tipe

Optional[str]

deaf

Whether the member is being server deafened.

See also VoiceState.deaf.

tipe

bool

mute

Whether the member is being server muted.

See also VoiceState.mute.

tipe

bool

permissions

The permissions of a role.

See also Role.permissions.

tipe

Permissions

colour
color

The colour of a role.

See also Role.colour

tipe

Colour

hoist

Whether the role is being hoisted or not.

See also Role.hoist

tipe

bool

mentionable

Whether the role is mentionable or not.

See also Role.mentionable

tipe

bool

code

The invite's code.

See also Invite.code

tipe

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.

tipe

Union[abc.GuildChannel, Object]

inviter

The user who created the invite.

See also Invite.inviter.

tipe

Optional[User]

max_uses

The invite's max uses.

See also Invite.max_uses.

tipe

int

uses

The invite's current uses.

See also Invite.uses.

tipe

int

max_age

The invite's max age in seconds.

See also Invite.max_age.

tipe

int

temporary

If the invite is a temporary invite.

See also Invite.temporary.

tipe

bool

allow
deny

The permissions being allowed or denied.

tipe

Permissions

id

The ID of the object being changed.

tipe

int

avatar

The avatar of a member.

See also User.avatar.

tipe

Asset

slowmode_delay

The number of seconds members have to wait before sending another message in the channel.

See also TextChannel.slowmode_delay.

tipe

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.

tipe

VoiceRegion

video_quality_mode

The camera video quality for the voice channel's participants.

See also VoiceChannel.video_quality_mode.

tipe

VideoQualityMode

format_type

The format type of a sticker being changed.

See also GuildSticker.format

tipe

StickerFormatType

emoji

The name of the emoji that represents a sticker being changed.

See also GuildSticker.emoji

tipe

str

description

The description of a sticker or guild events being changed.

See also GuildSticker.description and GuildScheduledEvent.description.

tipe

str

available

The availability of a sticker being changed.

See also GuildSticker.available

tipe

bool

archived

The thread is now archived.

tipe

bool

locked

The thread is being locked or unlocked.

tipe

bool

auto_archive_duration

The thread's auto archive duration being changed.

See also Thread.auto_archive_duration

tipe

int

default_auto_archive_duration

The default auto archive duration for newly created threads being changed.

tipe

int

entity_type

The type for scheduled guild event being changed.

tipe

GuildScheduledEventType

status

The status for scheduled guild event being changed.

tipe

GuildScheduledEventStatus

location

The location for scheduled guild event being changed.

tipe

str

unicode_emoji

The unicode emoji that represents when role got changed.

tipe

str

Webhook Support

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

Webhook

Attributes
Methods
class discord.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 discord 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.

Berubah pada versi 1.4: Webhooks are now comparable and hashable.

id

The webhook's ID

tipe

int

type

The type of the webhook.

Baru pada versi 1.3.

tipe

WebhookType

token

The authentication token of the webhook. If this is None then the webhook cannot be used to make requests.

tipe

Optional[str]

guild_id

The guild ID this webhook is for.

tipe

Optional[int]

channel_id

The channel ID this webhook is for.

tipe

Optional[int]

user

The user this webhook was created by. If the webhook was received without authentication then this will be None.

tipe

Optional[abc.User]

name

The default name of the webhook.

tipe

Optional[str]

source_guild

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

Baru pada versi 2.0.

tipe

Optional[PartialWebhookGuild]

source_channel

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

Baru pada versi 2.0.

tipe

Optional[PartialWebhookChannel]

property url: str

Returns the webhook's url.

tipe

str

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

Creates a partial Webhook.

Parameter

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

    Baru pada versi 2.0.

  • bot_token (Optional[str]) --

    The bot authentication token for authenticated requests involving the webhook.

    Baru pada versi 2.0.

Kembali

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

Tipe pengembalian

Webhook

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

Creates a partial Webhook from a webhook URL.

Parameter

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

    Baru pada versi 2.0.

  • bot_token (Optional[str]) --

    The bot authentication token for authenticated requests involving the webhook.

    Baru pada versi 2.0.

Menimbulkan

InvalidArgument -- The URL is invalid.

Kembali

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

Tipe pengembalian

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.

Baru pada versi 2.0.

Catatan

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

Parameter

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

Menimbulkan
Kembali

The fetched webhook.

Tipe pengembalian

Webhook

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

This function is a coroutine.

Deletes this Webhook.

Parameter

  • reason (Optional[str]) --

    The reason for deleting this webhook. Shows up on the audit log.

    Baru pada versi 1.4.

  • prefer_auth (bool) --

    Whether to use the bot token over the webhook token if available. Defaults to True.

    Baru pada versi 2.0.

Menimbulkan

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

Parameter

  • name (Optional[str]) -- The webhook's new default name.

  • avatar (Optional[bytes]) -- A bytes-like object representing the webhook's new default avatar.

  • channel (Optional[abc.Snowflake]) --

    The webhook's new channel. This requires an authenticated webhook.

    Baru pada versi 2.0.

  • reason (Optional[str]) --

    The reason for editing this webhook. Shows up on the audit log.

    Baru pada versi 1.4.

  • prefer_auth (bool) --

    Whether to use the bot token over the webhook token if available. Defaults to True.

    Baru pada versi 2.0.

Menimbulkan

  • 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: discord.asset.Asset

Returns an Asset for the avatar the webhook has.

If the webhook does not have a traditional avatar, an asset for the default avatar is returned instead.

tipe

Asset

property channel: Optional[TextChannel]

The text channel this webhook belongs to.

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

tipe

Optional[TextChannel]

property created_at: datetime.datetime

Returns the webhook's creation time in UTC.

tipe

datetime.datetime

property guild: Optional[Guild]

The guild this webhook belongs to.

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

tipe

Optional[Guild]

is_authenticated()

bool: Whether the webhook is authenticated with a bot token.

Baru pada versi 2.0.

is_partial()

bool: Whether the webhook is a "partial" webhook.

Baru pada versi 2.0.

await send(content=..., *, username=..., avatar_url=..., tts=False, ephemeral=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., view=..., thread=..., wait=False)

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.

Parameter

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

    Baru pada versi 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.

    Baru pada versi 1.4.

  • view (discord.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.

    Baru pada versi 2.0.

  • thread (Snowflake) --

    The thread to send this webhook to.

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Sending the message failed.

  • NotFound -- This webhook was not found.

  • Forbidden -- The authorization token for the webhook is incorrect.

  • TypeError -- You specified both embed and embeds or file and files.

  • ValueError -- The length of embeds was invalid.

  • InvalidArgument -- There was no token associated with this webhook or ephemeral was passed with the improper webhook type or there was no state attached with this webhook when giving it a view.

Kembali

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

Tipe pengembalian

Optional[WebhookMessage]

await fetch_message(id)

This function is a coroutine.

Retrieves a single WebhookMessage owned by this webhook.

Baru pada versi 2.0.

Parameter

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

Menimbulkan

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

Kembali

The message asked for.

Tipe pengembalian

WebhookMessage

await edit_message(message_id, *, content=..., embeds=..., embed=..., file=..., files=..., view=..., allowed_mentions=None)

This function is a coroutine.

Edits a message owned by this webhook.

This is a lower level interface to WebhookMessage.edit() in case you only have an ID.

Baru pada versi 1.6.

Berubah pada versi 2.0: The edit is no longer in-place, instead the newly edited message is returned.

Parameter

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

    Baru pada versi 2.0.

  • files (List[File]) --

    A list of files to send with the content. This cannot be mixed with the file parameter.

    Baru pada versi 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().

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Editing the message failed.

  • Forbidden -- Edited a message that is not yours.

  • TypeError -- You specified both embed and embeds or file and files

  • ValueError -- The length of embeds was invalid

  • InvalidArgument -- There was no token associated with this webhook or the webhook had no state.

Kembali

The newly edited webhook message.

Tipe pengembalian

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.

Baru pada versi 1.6.

Parameter

message_id (int) -- The message ID to delete.

Menimbulkan

WebhookMessage

Methods
class discord.WebhookMessage

Represents a message sent from your webhook.

This allows you to edit or delete a message sent by your webhook.

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

Baru pada versi 1.6.

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

This function is a coroutine.

Edits the message.

Baru pada versi 1.6.

Berubah pada versi 2.0: The edit is no longer in-place, instead the newly edited message is returned.

Parameter

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

    Baru pada versi 2.0.

  • files (List[File]) --

    A list of files to send with the content. This cannot be mixed with the file parameter.

    Baru pada versi 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.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The newly edited message.

Tipe pengembalian

WebhookMessage

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Parameter

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.

Menimbulkan

  • Forbidden -- You do not have proper permissions to delete the message.

  • NotFound -- The message was deleted already.

  • HTTPException -- Deleting the message failed.

SyncWebhook

Attributes
Methods
class discord.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.

Berubah pada versi 1.4: Webhooks are now comparable and hashable.

id

The webhook's ID

tipe

int

type

The type of the webhook.

Baru pada versi 1.3.

tipe

WebhookType

token

The authentication token of the webhook. If this is None then the webhook cannot be used to make requests.

tipe

Optional[str]

guild_id

The guild ID this webhook is for.

tipe

Optional[int]

channel_id

The channel ID this webhook is for.

tipe

Optional[int]

user

The user this webhook was created by. If the webhook was received without authentication then this will be None.

tipe

Optional[abc.User]

name

The default name of the webhook.

tipe

Optional[str]

source_guild

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

Baru pada versi 2.0.

tipe

Optional[PartialWebhookGuild]

source_channel

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

Baru pada versi 2.0.

tipe

Optional[PartialWebhookChannel]

property url: str

Returns the webhook's url.

tipe

str

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

Creates a partial Webhook.

Parameter

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

Kembali

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

Tipe pengembalian

Webhook

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

Creates a partial Webhook from a webhook URL.

Parameter

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

Menimbulkan

InvalidArgument -- The URL is invalid.

Kembali

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

Tipe pengembalian

Webhook

fetch(*, prefer_auth=True)

Fetches the current webhook.

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

Catatan

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

Parameter

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

Menimbulkan
Kembali

The fetched webhook.

Tipe pengembalian

SyncWebhook

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

Deletes this Webhook.

Parameter

  • reason (Optional[str]) --

    The reason for deleting this webhook. Shows up on the audit log.

    Baru pada versi 1.4.

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

Menimbulkan

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

Parameter

  • name (Optional[str]) -- The webhook's new default name.

  • avatar (Optional[bytes]) -- A bytes-like object representing the webhook's new default avatar.

  • channel (Optional[abc.Snowflake]) -- The webhook's new channel. This requires an authenticated webhook.

  • reason (Optional[str]) --

    The reason for editing this webhook. Shows up on the audit log.

    Baru pada versi 1.4.

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

Menimbulkan

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

Kembali

The newly edited webhook.

Tipe pengembalian

SyncWebhook

send(content=..., *, username=..., avatar_url=..., tts=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., thread=..., wait=False)

Sends a message using the webhook.

The content must be a type that can convert to a string through str(content).

To upload a single file, the file parameter should be used with a single File object.

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.

Parameter

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

    Baru pada versi 1.4.

  • thread (Snowflake) --

    The thread to send this message to.

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Sending the message failed.

  • NotFound -- This webhook was not found.

  • Forbidden -- The authorization token for the webhook is incorrect.

  • TypeError -- You specified both embed and embeds or file and files

  • ValueError -- The length of embeds was invalid

  • InvalidArgument -- There was no token associated with this webhook.

Kembali

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

Tipe pengembalian

Optional[SyncWebhookMessage]

fetch_message(id, /)

Retrieves a single SyncWebhookMessage owned by this webhook.

Baru pada versi 2.0.

Parameter

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

Menimbulkan

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

Kembali

The message asked for.

Tipe pengembalian

SyncWebhookMessage

property avatar: discord.asset.Asset

Returns an Asset for the avatar the webhook has.

If the webhook does not have a traditional avatar, an asset for the default avatar is returned instead.

tipe

Asset

property channel: Optional[TextChannel]

The text channel this webhook belongs to.

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

tipe

Optional[TextChannel]

property created_at: datetime.datetime

Returns the webhook's creation time in UTC.

tipe

datetime.datetime

edit_message(message_id, *, content=..., embeds=..., embed=..., file=..., files=..., allowed_mentions=None)

Edits a message owned by this webhook.

This is a lower level interface to WebhookMessage.edit() in case you only have an ID.

Baru pada versi 1.6.

Parameter

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

  • allowed_mentions (AllowedMentions) -- Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Menimbulkan
property guild: Optional[Guild]

The guild this webhook belongs to.

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

tipe

Optional[Guild]

is_authenticated()

bool: Whether the webhook is authenticated with a bot token.

Baru pada versi 2.0.

is_partial()

bool: Whether the webhook is a "partial" webhook.

Baru pada versi 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.

Baru pada versi 1.6.

Parameter

message_id (int) -- The message ID to delete.

Menimbulkan

SyncWebhookMessage

Methods
class discord.SyncWebhookMessage

Represents a message sent from your webhook.

This allows you to edit or delete a message sent by your webhook.

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

Baru pada versi 2.0.

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

Edits the message.

Parameter

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

  • allowed_mentions (AllowedMentions) -- Controls the mentions being processed in this message. See abc.Messageable.send() for more information.

Menimbulkan
Kembali

The newly edited message.

Tipe pengembalian

SyncWebhookMessage

delete(*, delay=None)

Deletes the message.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have proper permissions to delete the message.

  • NotFound -- The message was deleted already.

  • HTTPException -- Deleting the message failed.

Abstract Base Classes

An abstract base class (also known as an abc) is a class that models can inherit to get their behaviour. Abstract base classes should not be instantiated. They are mainly there for usage with isinstance() and issubclass().

This library has a module related to abstract base classes, in which all the ABCs are subclasses of typing.Protocol.

Snowflake

Attributes
class discord.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.

tipe

int

User

Attributes
class discord.abc.User

An ABC that details the common operations on a Discord user.

The following implement this ABC:

This ABC must also implement Snowflake.

name

The user's username.

tipe

str

discriminator

The user's discriminator.

tipe

str

avatar

The avatar asset the user has.

tipe

Asset

bot

If the user is a bot account.

tipe

bool

property display_name: str

Returns the user's display name.

tipe

str

property mention: str

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

tipe

str

PrivateChannel

Attributes
class discord.abc.PrivateChannel

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

The following implement this ABC:

This ABC must also implement Snowflake.

me

The user presenting yourself.

tipe

ClientUser

GuildChannel

Attributes
Methods
class discord.abc.GuildChannel

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

The following implement this ABC:

This ABC must also implement Snowflake.

name

The channel name.

tipe

str

guild

The guild the channel belongs to.

tipe

Guild

position

The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

tipe

int

property changed_roles: List[discord.role.Role]

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

tipe

List[Role]

property mention: str

The string that allows you to mention the channel.

tipe

str

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

datetime.datetime

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameter

obj (Union[Role, User]) -- The role or user denoting whose overwrite to get.

Kembali

The permission overwrites for this object.

Tipe pengembalian

PermissionOverwrite

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

Returns all of the channel's overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Kembali

The channel's permission overwrites.

Tipe pengembalian

Dict[Union[Role, Member], PermissionOverwrite]

property category: Optional[CategoryChannel]

The category this channel belongs to.

If there is no category then this is None.

tipe

Optional[CategoryChannel]

property permissions_synced: bool

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Baru pada versi 1.3.

tipe

bool

permissions_for(obj, /)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

  • Guild owner

  • Guild roles

  • Channel overrides

  • Member overrides

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

  • The default role permissions

  • The permissions of the role used as a parameter

  • The default role permission overwrites

  • The permission overwrites of the role used as a parameter

Berubah pada versi 2.0: The object passed in can now be a role object.

Parameter

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.

Kembali

The resolved permissions for the member or role.

Tipe pengembalian

Permissions

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have proper permissions to delete the channel.

  • NotFound -- The channel was not found or was already deleted.

  • HTTPException -- Deleting the channel failed.

await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

The overwrite parameter, if given, must either be None or PermissionOverwrite. For convenience, you can pass in keyword arguments denoting Permissions attributes. If this is done, then you cannot mix the keyword arguments with the overwrite parameter.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have the manage_roles permission to use this.

Catatan

This method replaces the old overwrites with the ones given.

Contoh-contoh

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 = discord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)
Parameter

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

Menimbulkan

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

Baru pada versi 1.1.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have the proper permissions to create this channel.

  • HTTPException -- Creating the channel failed.

Kembali

The channel that was created.

Tipe pengembalian

abc.GuildChannel

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have the manage_channels permission to do this.

Catatan

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

Baru pada versi 1.7.

Parameter

  • beginning (bool) -- Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

  • end (bool) -- Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

  • before (Snowflake) -- The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

  • after (Snowflake) -- The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

  • offset (int) -- The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

  • category (Optional[Snowflake]) -- The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

  • sync_permissions (bool) -- Whether to sync the permissions with the category (if given).

  • reason (str) -- The reason for the move.

Menimbulkan

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

Parameter

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

    Baru pada versi 2.0.

  • target_user (Optional[User]) --

    The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

    Baru pada versi 2.0.

  • target_application_id: --

    Optional[int]: The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Invite creation failed.

  • NotFound -- The channel that was passed is a category or an invalid channel.

Kembali

The invite that was created.

Tipe pengembalian

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.

Menimbulkan

  • Forbidden -- You do not have proper permissions to get the information.

  • HTTPException -- An error occurred while fetching the information.

Kembali

The list of invites that are currently active.

Tipe pengembalian

List[Invite]

await create_event(name, scheduled_start_time, *, description=..., privacy_level=..., entity_type=...)

This function is a coroutine.

Create a new guild event with this channel.

You must have the manage_events permission to create a guild event.

Catatan

Another extra permissions is required for different type of entity_type.

If your entity type is GuildScheduledEventType.stage_instance, you must have the following extra permissions:

  • manage_channels

  • mute_members

  • move_members

If your entity type is GuildScheduledEventType.voice, you must have the following extra permissions:

  • view_channel for channel associated with the event.

  • connect for channel associated with the event.

If your entity type is GuildScheduledEventType.external, you dont need any extra permissions.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the event.

  • description (Optional[str]) -- The description of the event. Could be None for no description.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level, same thing as StageInstance PrivacyLevel

  • scheduled_start_time (datetime.datetime) -- The scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • entity_type (Optional[GuildScheduledEventType]) -- The entity_type or type for the event. If you don't provide this, it will automatically check from the channel type.

Menimbulkan

  • Forbidden -- You do not have permissions to create the guild event.

  • HTTPException -- Creating the guild event failed.

  • ValueError -- Validation error occurred.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

Messageable

Methods
class discord.abc.Messageable

An ABC that details the common operations on a model that can send messages.

The following implement this ABC:

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

Contoh-contoh

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

Hasil

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.

Catatan

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')
await send(content=None, *, tts=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Parameter

  • 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 (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with 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.

    Baru pada versi 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.

    Baru pada versi 1.6.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    Baru pada versi 1.6.

  • view (discord.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.

    Baru pada versi 2.0.

  • stickers (Sequence[Union[GuildSticker, StickerItem]]) --

    A list of stickers to upload. Must be a maximum of 3.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The message that was sent.

Tipe pengembalian

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameter

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

Menimbulkan

  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The message asked for.

Tipe pengembalian

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Catatan

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

Menimbulkan

HTTPException -- Retrieving the pinned messages failed.

Kembali

The messages that are currently pinned.

Tipe pengembalian

List[Message]

Connectable

class discord.abc.Connectable

An ABC that details the common operations on a channel that can connect to a voice server.

The following implement this ABC:

Catatan

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.

Bahaya

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.

Catatan

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

ClientUser

Attributes
Methods
class discord.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.

tipe

str

id

The user's unique ID.

tipe

int

discriminator

The user's discriminator. This is given when the username has conflicts.

tipe

str

bot

Specifies if the user is a bot account.

tipe

bool

system

Specifies if the user is a system user (i.e. represents Discord officially).

Baru pada versi 1.3.

tipe

bool

verified

Specifies if the user's email is verified.

tipe

bool

locale

The IETF language tag used to identify the language the user is using.

tipe

Optional[str]

mfa_enabled

Specifies if the user has MFA turned on and working.

tipe

bool

await edit(*, username=..., avatar=...)

This function is a coroutine.

Edits the current profile of the client.

Catatan

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.

Berubah pada versi 2.0: The edit is no longer in-place, instead the newly edited client user is returned.

Parameter

  • username (str) -- The new username you wish to change to.

  • avatar (bytes) -- A bytes-like object representing the image to upload. Could be None to denote no avatar.

Menimbulkan
Kembali

The newly edited client user.

Tipe pengembalian

ClientUser

property accent_color: Optional[discord.colour.Colour]

Returns the user's accent color, if applicable.

There is an alias for this named accent_colour.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Colour]

property accent_colour: Optional[discord.colour.Colour]

Returns the user's accent colour, if applicable.

There is an alias for this named accent_color.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Colour]

property avatar: Optional[discord.asset.Asset]

Returns an Asset for the avatar the user has.

If the user does not have a traditional avatar, None is returned. If you want the avatar that a user has displayed, consider display_avatar.

tipe

Optional[Asset]

property banner: Optional[discord.asset.Asset]

Returns the user's banner asset, if available.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Asset]

property color: discord.colour.Colour

A property that returns a color denoting the rendered color for the user. This always returns Colour.default().

There is an alias for this named colour.

tipe

Colour

property colour: discord.colour.Colour

A property that returns a colour denoting the rendered colour for the user. This always returns Colour.default().

There is an alias for this named color.

tipe

Colour

property created_at: datetime

Returns the user's creation time in UTC.

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

tipe

datetime.datetime

property default_avatar: discord.asset.Asset

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

tipe

Asset

property display_avatar: discord.asset.Asset

Returns the user's display avatar.

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

Baru pada versi 2.0.

tipe

Asset

property display_name: str

Returns the user's display name.

For regular users this is just their username, but if they have a guild specific nickname then that is returned instead.

tipe

str

property mention: str

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

tipe

str

mentioned_in(message)

Checks if the user is mentioned in the specified message.

Parameter

message (Message) -- The message to check if you're mentioned in.

Kembali

Indicates if the user is mentioned in the message.

Tipe pengembalian

bool

property public_flags: discord.flags.PublicUserFlags

The publicly available flags the user has.

tipe

PublicUserFlags

User

Attributes
Methods
class discord.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.

tipe

str

id

The user's unique ID.

tipe

int

discriminator

The user's discriminator. This is given when the username has conflicts.

tipe

str

bot

Specifies if the user is a bot account.

tipe

bool

system

Specifies if the user is a system user (i.e. represents Discord officially).

tipe

bool

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

Contoh-contoh

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

Hasil

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.

Catatan

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')
property dm_channel: Optional[DMChannel]

Returns the channel associated with this user if it exists.

If this returns None, you can create a DM channel by calling the create_dm() coroutine function.

tipe

Optional[DMChannel]

property mutual_guilds: List[Guild]

The guilds that the user shares with the client.

Catatan

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

Baru pada versi 1.7.

tipe

List[Guild]

property accent_color: Optional[discord.colour.Colour]

Returns the user's accent color, if applicable.

There is an alias for this named accent_colour.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Colour]

property accent_colour: Optional[discord.colour.Colour]

Returns the user's accent colour, if applicable.

There is an alias for this named accent_color.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Colour]

property avatar: Optional[discord.asset.Asset]

Returns an Asset for the avatar the user has.

If the user does not have a traditional avatar, None is returned. If you want the avatar that a user has displayed, consider display_avatar.

tipe

Optional[Asset]

property banner: Optional[discord.asset.Asset]

Returns the user's banner asset, if available.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Asset]

property color: discord.colour.Colour

A property that returns a color denoting the rendered color for the user. This always returns Colour.default().

There is an alias for this named colour.

tipe

Colour

property colour: discord.colour.Colour

A property that returns a colour denoting the rendered colour for the user. This always returns Colour.default().

There is an alias for this named color.

tipe

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.

Kembali

The channel that was created.

Tipe pengembalian

DMChannel

property created_at: datetime

Returns the user's creation time in UTC.

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

tipe

datetime.datetime

property default_avatar: discord.asset.Asset

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

tipe

Asset

property display_avatar: discord.asset.Asset

Returns the user's display avatar.

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

Baru pada versi 2.0.

tipe

Asset

property display_name: str

Returns the user's display name.

For regular users this is just their username, but if they have a guild specific nickname then that is returned instead.

tipe

str

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameter

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

Menimbulkan

  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The message asked for.

Tipe pengembalian

Message

property mention: str

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

tipe

str

mentioned_in(message)

Checks if the user is mentioned in the specified message.

Parameter

message (Message) -- The message to check if you're mentioned in.

Kembali

Indicates if the user is mentioned in the message.

Tipe pengembalian

bool

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Catatan

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

Menimbulkan

HTTPException -- Retrieving the pinned messages failed.

Kembali

The messages that are currently pinned.

Tipe pengembalian

List[Message]

property public_flags: discord.flags.PublicUserFlags

The publicly available flags the user has.

tipe

PublicUserFlags

await send(content=None, *, tts=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Parameter

  • 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 (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with 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.

    Baru pada versi 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.

    Baru pada versi 1.6.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    Baru pada versi 1.6.

  • view (discord.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.

    Baru pada versi 2.0.

  • stickers (Sequence[Union[GuildSticker, StickerItem]]) --

    A list of stickers to upload. Must be a maximum of 3.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The message that was sent.

Tipe pengembalian

Message

await trigger_typing()

This function is a coroutine.

Triggers a typing indicator to the destination.

Typing indicator will go away after 10 seconds, or after a message is sent.

Attachment

Attributes
Methods
class discord.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.

Berubah pada versi 1.7: Attachment can now be casted to str and is hashable.

id

The attachment ID.

tipe

int

description

The attachment description.

Baru pada versi 2.0.

tipe

Optional[str]

size

The attachment size in bytes.

tipe

int

height

The attachment's height, in pixels. Only applicable to images and videos.

tipe

Optional[int]

width

The attachment's width, in pixels. Only applicable to images and videos.

tipe

Optional[int]

filename

The attachment's filename.

tipe

str

url

The attachment URL. If the message this attachment was attached to is deleted, then this will 404.

tipe

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.

tipe

str

content_type

The attachment's media type

Baru pada versi 1.7.

tipe

Optional[str]

ephermal

Whether this attachment is ephermal. Ephemeral attachments will automatically be removed after a set period of time. Ephemeral attachments on messages are guaranteed to be available as long as the message itself exists.

Baru pada versi 2.0.

tipe

bool

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.

Parameter

  • fp (Union[io.BufferedIOBase, os.PathLike]) -- The file-like object to save this attachment to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

  • seek_begin (bool) -- Whether to seek to the beginning of the file after saving is successfully done.

  • use_cached (bool) -- Whether to use proxy_url rather than url when downloading the attachment. This will allow attachments to be saved after deletion more often, compared to the regular URL which is generally deleted right after the message is deleted. Note that this can still fail to download deleted attachments if too much time has passed and it does not work on some types of attachments.

Menimbulkan
Kembali

The number of bytes written.

Tipe pengembalian

int

await read(*, use_cached=False)

This function is a coroutine.

Retrieves the content of this attachment as a bytes object.

Baru pada versi 1.1.

Parameter

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.

Menimbulkan

  • HTTPException -- Downloading the attachment failed.

  • Forbidden -- You do not have permissions to access this attachment

  • NotFound -- The attachment was deleted.

Kembali

The contents of the attachment.

Tipe pengembalian

bytes

await to_file(*, use_cached=False, spoiler=False)

This function is a coroutine.

Converts the attachment into a File suitable for sending via abc.Messageable.send().

Baru pada versi 1.3.

Parameter

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

    Baru pada versi 1.4.

  • spoiler (bool) --

    Whether the file is a spoiler.

    Baru pada versi 1.4.

Menimbulkan

  • HTTPException -- Downloading the attachment failed.

  • Forbidden -- You do not have permissions to access this attachment

  • NotFound -- The attachment was deleted.

Kembali

The attachment as a file suitable for sending.

Tipe pengembalian

File

Asset

Attributes
Methods
class discord.Asset

Represents a CDN asset on Discord.

str(x)

Returns the URL of the CDN asset.

len(x)

Returns the length of the CDN asset's URL.

x == y

Checks if the asset is equal to another asset.

x != y

Checks if the asset is not equal to another asset.

hash(x)

Returns the hash of the asset.

property url: str

Returns the underlying URL of the asset.

tipe

str

property key: str

Returns the identifying key of the asset.

tipe

str

is_animated()

bool: Returns whether the asset is animated.

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

Returns a new asset with the passed components replaced.

Parameter

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

Menimbulkan

InvalidArgument -- An invalid size or format was passed.

Kembali

The newly updated asset.

Tipe pengembalian

Asset

with_size(size, /)

Returns a new asset with the specified size.

Parameter

size (int) -- The new size of the asset.

Menimbulkan

InvalidArgument -- The asset had an invalid size.

Kembali

The new updated asset.

Tipe pengembalian

Asset

with_format(format, /)

Returns a new asset with the specified format.

Parameter

format (str) -- The new format of the asset.

Menimbulkan

InvalidArgument -- The asset had an invalid format.

Kembali

The new updated asset.

Tipe pengembalian

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.

Parameter

format (str) -- The new static format of the asset.

Menimbulkan

InvalidArgument -- The asset had an invalid format.

Kembali

The new updated asset.

Tipe pengembalian

Asset

await read()

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Menimbulkan
Kembali

The content of the asset.

Tipe pengembalian

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameter

  • fp (Union[io.BufferedIOBase, os.PathLike]) -- The file-like object to save this attachment to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

  • seek_begin (bool) -- Whether to seek to the beginning of the file after saving is successfully done.

Menimbulkan
Kembali

The number of bytes written.

Tipe pengembalian

int

Message

Attributes
Methods
class discord.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.

tipe

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.

tipe

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.

tipe

Union[Member, abc.User]

content

The actual contents of the message.

tipe

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.

tipe

Optional[Union[str, int]]

embeds

A list of embeds the message has.

tipe

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.

tipe

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.

Baru pada versi 1.5.

tipe

Optional[MessageReference]

mention_everyone

Specifies if the message mentions everyone.

Catatan

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.

tipe

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.

Peringatan

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.

tipe

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.

tipe

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.

tipe

List[Role]

id

The message ID.

tipe

int

webhook_id

If this message was sent by a webhook, then this is the webhook ID's that sent this message.

tipe

Optional[int]

attachments

A list of attachments given to a message.

tipe

List[Attachment]

pinned

Specifies if the message is currently pinned.

tipe

bool

flags

Extra features of the message.

Baru pada versi 1.3.

tipe

MessageFlags

reactions

Reactions to a message. Reactions can be either custom emoji or standard unicode emoji.

tipe

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.

tipe

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.

tipe

Optional[dict]

stickers

A list of sticker items given to the message.

Baru pada versi 1.6.

tipe

List[StickerItem]

components

A list of components in the message.

Baru pada versi 2.0.

tipe

List[Component]

guild

The guild that the message belongs to, if applicable.

tipe

Optional[Guild]

raw_mentions

A property that returns an array of user IDs matched with the syntax of <@user_id> in the message content.

This allows you to receive the user IDs of mentioned users even in a private message context.

tipe

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.

tipe

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.

tipe

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.

Catatan

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.

tipe

str

property created_at: datetime.datetime

The message's creation time in UTC.

tipe

datetime.datetime

property edited_at: Optional[datetime.datetime]

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

tipe

Optional[datetime.datetime]

property jump_url: str

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

tipe

str

is_system()

bool: Whether the message is a system message.

A system message is a message that is constructed entirely by the Discord API in response to something.

Baru pada versi 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.

tipe

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.

Berubah pada versi 1.1: Added the new delay keyword-only parameter.

Parameter

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.

Menimbulkan

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

This function is a coroutine.

Edits the message.

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

Berubah pada versi 1.3: The suppress keyword-only parameter was added.

Parameter

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

    Baru pada versi 2.0.

  • attachments (List[Attachment]) -- A list of attachments to keep in the message. If [] is passed then all attachments are removed.

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

    Baru pada versi 1.4.

  • view (Optional[View]) -- The updated view to update this message with. If None is passed then the view is removed.

Menimbulkan

  • 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

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.

Menimbulkan

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

Parameter

reason (Optional[str]) --

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

Baru pada versi 1.4.

Menimbulkan

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

Parameter

reason (Optional[str]) --

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

Baru pada versi 1.4.

Menimbulkan

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

Parameter

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

Menimbulkan

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

Parameter
Menimbulkan

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

Baru pada versi 1.3.

Parameter

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

Menimbulkan

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

Menimbulkan

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

Baru pada versi 2.0.

Parameter

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

Menimbulkan
Kembali

The created thread.

Tipe pengembalian

Thread

await reply(content=None, **kwargs)

This function is a coroutine.

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

Baru pada versi 1.6.

Menimbulkan

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

Kembali

The message that was sent.

Tipe pengembalian

Message

to_reference(*, fail_if_not_exists=True)

Creates a MessageReference from the current message.

Baru pada versi 1.6.

Parameter

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.

Baru pada versi 1.7.

Kembali

The reference to this message.

Tipe pengembalian

MessageReference

Component

Attributes
class discord.Component

Represents a Discord Bot UI Kit Component.

Currently, the only components supported by Discord are:

This class is abstract and cannot be instantiated.

Baru pada versi 2.0.

type

The type of component.

tipe

ComponentType

ActionRow

Attributes
class discord.ActionRow

Represents a Discord Bot UI Kit Action Row.

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

This inherits from Component.

Baru pada versi 2.0.

type

The type of component.

tipe

ComponentType

children

The children components that this holds, if any.

tipe

List[Component]

Button

Attributes
class discord.Button

Represents a button from the Discord Bot UI Kit.

This inherits from Component.

Catatan

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

Baru pada versi 2.0.

style

The style of the button.

tipe

ButtonStyle

custom_id

The ID of the button that gets received during an interaction. If this button is for a URL, it does not have a custom ID.

tipe

Optional[str]

url

The URL this button sends you to.

tipe

Optional[str]

disabled

Whether the button is disabled or not.

tipe

bool

label

The label of the button, if any.

tipe

Optional[str]

emoji

The emoji of the button, if available.

tipe

Optional[PartialEmoji]

SelectMenu

Attributes
class discord.SelectMenu

Represents a select menu from the Discord Bot UI Kit.

A select menu is functionally the same as a dropdown, however on mobile it renders a bit differently.

Catatan

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

Baru pada versi 2.0.

custom_id

The ID of the select menu that gets received during an interaction.

tipe

Optional[str]

placeholder

The placeholder text that is shown if nothing is selected, if any.

tipe

Optional[str]

min_values

The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

tipe

int

max_values

The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.

tipe

int

options

A list of options that can be selected in this menu.

tipe

List[SelectOption]

disabled

Whether the select is disabled or not.

tipe

bool

DeletedReferencedMessage

Attributes
class discord.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.

Baru pada versi 1.6.

property id: int

The message ID of the deleted referenced message.

tipe

int

property channel_id: int

The channel ID of the deleted referenced message.

tipe

int

property guild_id: Optional[int]

The guild ID of the deleted referenced message.

tipe

Optional[int]

Reaction

Attributes
Methods
class discord.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.

tipe

Union[Emoji, PartialEmoji, str]

count

Number of times this reaction was made

tipe

int

me

If the user sent this reaction.

tipe

bool

message

Message this reaction is for.

tipe

Message

async for ... in users(*, limit=None, after=None)

Returns an AsyncIterator representing the users that have reacted to the message.

The after parameter must represent a member and meet the abc.Snowflake abc.

Contoh-contoh

Usage

# I do not actually recommend doing this.
async for user in reaction.users():
    await channel.send(f'{user} has reacted with {reaction.emoji}!')

Flattening into a list:

users = await reaction.users().flatten()
# users is now a list of User...
winner = random.choice(users)
await channel.send(f'{winner} has won the raffle.')
Parameter

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

Menimbulkan

HTTPException -- Getting the users for the reaction failed.

Hasil

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.

Parameter

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

Menimbulkan

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

Baru pada versi 1.3.

Menimbulkan

  • 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
Methods
class discord.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.

tipe

str

emojis

All emojis that the guild owns.

tipe

Tuple[Emoji, ...]

stickers

All stickers that the guild owns.

Baru pada versi 2.0.

tipe

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.

tipe

VoiceRegion

afk_timeout

The timeout to get sent to the AFK channel.

tipe

int

afk_channel

The channel that denotes the AFK channel. None if it doesn't exist.

tipe

Optional[VoiceChannel]

id

The guild's ID.

tipe

int

owner_id

The guild owner's ID. Use Guild.owner instead.

tipe

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.

tipe

bool

max_presences

The maximum amount of presences for the guild.

tipe

Optional[int]

max_members

The maximum amount of members for the guild.

Catatan

This attribute is only available via Client.fetch_guild().

tipe

Optional[int]

max_video_channel_users

The maximum amount of users in a video channel.

Baru pada versi 1.4.

tipe

Optional[int]

description

The guild's description.

tipe

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.

tipe

int

verification_level

The guild's verification level.

tipe

VerificationLevel

explicit_content_filter

The guild's explicit content filter.

tipe

ContentFilter

default_notifications

The guild's notification settings.

tipe

NotificationLevel

features

A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord.

They are currently as follows:

  • ANIMATED_BANNER: Guild can upload an animated banner.

  • ANIMATED_ICON: Guild can upload an animated icon.

  • BANNER: Guild can upload and use a banner. (i.e. banner)

  • COMMERCE: Guild can sell things using store channels.

  • COMMUNITY: Guild is a community server.

  • DISCOVERABLE: Guild shows up in Server Discovery.

  • FEATURABLE: Guild is able to be featured in Server Discovery.

  • INVITE_SPLASH: Guild's invite page can have a special splash.

  • MEMBER_VERIFICATION_GATE_ENABLED: Guild has Membership Screening enabled.

  • MONETIZATION_ENABLED: Guild has enabled monetization.

  • MORE_EMOJI: Guild has increased custom emoji slots.

  • MORE_STICKERS: Guild has increased custom sticker slots.

  • NEWS: Guild can create news channels.

  • PARTNERED: Guild is a partnered server.

  • PREVIEW_ENABLED: Guild can be viewed before being accepted via Membership Screening.

  • PRIVATE_THREADS: Guild has access to create private threads.

  • ROLE_ICONS: Guild has access to set icon for roles.

  • SEVEN_DAY_THREAD_ARCHIVE: Guild has access to the seven day archive time for threads.

  • THREE_DAY_THREAD_ARCHIVE: Guild has access to the three day archive time for threads.

  • TICKETED_EVENTS_ENABLED: Guild has enabled ticketed events.

  • VANITY_URL: Guild can have a vanity invite URL (e.g. discord.gg/discord-api).

  • VERIFIED: Guild is a verified server.

  • VIP_REGIONS: Guild has VIP voice regions.

  • WELCOME_SCREEN_ENABLED: Guild has enabled the welcome screen.

tipe

List[str]

premium_tier

The premium tier for this guild. Corresponds to "Nitro Server" in the official UI. The number goes from 0 to 3 inclusive.

tipe

int

premium_subscription_count

The number of "boosts" this guild currently has.

tipe

int

preferred_locale

The preferred locale for the guild. Used when filtering Server Discovery results to a specific language.

tipe

Optional[str]

nsfw_level

The guild's NSFW level.

Baru pada versi 2.0.

tipe

NSFWLevel

async for ... in fetch_members(*, limit=1000, after=None)

Retrieves an AsyncIterator that enables receiving the guild's members. In order to use this, Intents.members() must be enabled.

Catatan

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

Baru pada versi 1.3.

All parameters are optional.

Parameter

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

Menimbulkan
Hasil

Member -- The member with the member data parsed.

Contoh-contoh

Usage

async for member in guild.fetch_members(limit=150):
    print(member.name)

Flattening into a list

members = await guild.fetch_members(limit=150).flatten()
# members is now a list of Member...
async for ... in audit_logs(*, limit=100, before=None, after=None, oldest_first=None, user=None, action=None)

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

You must have the view_audit_log permission to use this.

Contoh-contoh

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=discord.AuditLogAction.ban):
    print(f'{entry.user} banned {entry.target}')

Getting entries made by a specific user:

entries = await guild.audit_logs(limit=None, user=guild.me).flatten()
await channel.send(f'I made {len(entries)} moderation actions.')
Parameter

  • limit (Optional[int]) -- The number of entries to retrieve. If None retrieve all entries.

  • before (Union[abc.Snowflake, datetime.datetime]) -- Retrieve entries before this date or entry. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.

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

  • oldest_first (bool) -- If set to True, return entries in oldest->newest order. Defaults to True if after is specified, otherwise False.

  • user (abc.Snowflake) -- The moderator to filter entries from.

  • action (AuditLogAction) -- The action to filter with.

Menimbulkan

  • Forbidden -- You are not allowed to fetch audit logs

  • HTTPException -- An error occurred while fetching the audit logs.

Hasil

AuditLogEntry -- The audit log entry.

property channels: List[GuildChannel]

A list of channels that belongs to this guild.

tipe

List[abc.GuildChannel]

property events: List[discord.guild_events.GuildScheduledEvent]

A list of guild events that belong to this guild.

tipe

List[GuildScheduledEvent]

property threads: List[discord.threads.Thread]

A list of threads that you have permission to view.

Baru pada versi 2.0.

tipe

List[Thread]

property large: bool

Indicates if the guild is a 'large' guild.

A large guild is defined as having more than large_threshold count members, which for this library is set to the maximum of 250.

tipe

bool

property voice_channels: List[discord.channel.VoiceChannel]

A list of voice channels that belongs to this guild.

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

tipe

List[VoiceChannel]

property stage_channels: List[discord.channel.StageChannel]

A list of stage channels that belongs to this guild.

Baru pada versi 1.7.

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

tipe

List[StageChannel]

property me: discord.member.Member

Similar to Client.user except an instance of Member. This is essentially used to get the member version of yourself.

tipe

Member

property voice_client: Optional[VoiceProtocol]

Returns the VoiceProtocol associated with this guild, if any.

tipe

Optional[VoiceProtocol]

property text_channels: List[discord.channel.TextChannel]

A list of text channels that belongs to this guild.

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

tipe

List[TextChannel]

property categories: List[discord.channel.CategoryChannel]

A list of categories that belongs to this guild.

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

tipe

List[CategoryChannel]

by_category()

Returns every CategoryChannel and their associated channels.

These channels and categories are sorted in the official Discord UI order.

If the channels do not have a category, then the first element of the tuple is None.

Kembali

The categories and their associated channels.

Tipe pengembalian

List[Tuple[Optional[CategoryChannel], List[abc.GuildChannel]]]

get_channel_or_thread(channel_id, /)

Returns a channel or thread with the given ID.

Baru pada versi 2.0.

Parameter

channel_id (int) -- The ID to search for.

Kembali

The returned channel or thread or None if not found.

Tipe pengembalian

Optional[Union[Thread, abc.GuildChannel]]

get_channel(channel_id, /)

Returns a channel with the given ID.

Catatan

This does not search for threads.

Parameter

channel_id (int) -- The ID to search for.

Kembali

The returned channel or None if not found.

Tipe pengembalian

Optional[abc.GuildChannel]

get_event(event_id, /)

Returns a event with the given ID.

Baru pada versi 2.0.

Parameter

event_id (int) -- The ID to search for.

Kembali

The returned event or None if not found.

Tipe pengembalian

Optional[GuildScheduledEvent]

get_thread(thread_id, /)

Returns a thread with the given ID.

Baru pada versi 2.0.

Parameter

thread_id (int) -- The ID to search for.

Kembali

The returned thread or None if not found.

Tipe pengembalian

Optional[Thread]

await fetch_event(event_id, /)

This function is a coroutine.

Returns a event with the given ID.

This function will request to the API directly, you might want to use get_event() instead.

Baru pada versi 2.0.

Parameter

event_id (int) -- The ID to search for.

Kembali

The requested scheduled event.

Tipe pengembalian

GuildScheduledEvent

Menimbulkan

  • Forbidden -- You do not have the proper permissions to get the event.

  • HTTPException -- An error occurred while fetching the event.

property system_channel: Optional[discord.channel.TextChannel]

Returns the guild's channel used for system messages.

If no channel is set, then this returns None.

tipe

Optional[TextChannel]

property system_channel_flags: discord.flags.SystemChannelFlags

Returns the guild's system channel settings.

tipe

SystemChannelFlags

property rules_channel: Optional[discord.channel.TextChannel]

Return's the guild's channel used for the rules. The guild must be a Community guild.

If no channel is set, then this returns None.

Baru pada versi 1.3.

tipe

Optional[TextChannel]

property public_updates_channel: Optional[discord.channel.TextChannel]

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

If no channel is set, then this returns None.

Baru pada versi 1.4.

tipe

Optional[TextChannel]

property emoji_limit: int

The maximum number of emoji slots this guild has.

tipe

int

property sticker_limit: int

The maximum number of sticker slots this guild has.

Baru pada versi 2.0.

tipe

int

property bitrate_limit: float

The maximum bitrate for voice channels this guild can have.

tipe

float

property filesize_limit: int

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

tipe

int

property members: List[discord.member.Member]

A list of members that belong to this guild.

tipe

List[Member]

get_member(user_id, /)

Returns a member with the given ID.

Parameter

user_id (int) -- The ID to search for.

Kembali

The member or None if not found.

Tipe pengembalian

Optional[Member]

property premium_subscribers: List[discord.member.Member]

A list of members who have "boosted" this guild.

tipe

List[Member]

property roles: List[discord.role.Role]

Returns a list of the guild's roles in hierarchy order.

The first element of this list will be the lowest role in the hierarchy.

tipe

List[Role]

get_role(role_id, /)

Returns a role with the given ID.

Parameter

role_id (int) -- The ID to search for.

Kembali

The role or None if not found.

Tipe pengembalian

Optional[Role]

property default_role: discord.role.Role

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

tipe

Role

property premium_subscriber_role: Optional[discord.role.Role]

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

Baru pada versi 1.6.

tipe

Optional[Role]

property self_role: Optional[discord.role.Role]

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

Baru pada versi 1.6.

tipe

Optional[Role]

property stage_instances: List[discord.stage_instance.StageInstance]

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

Baru pada versi 2.0.

tipe

List[StageInstance]

get_stage_instance(stage_instance_id, /)

Returns a stage instance with the given ID.

Baru pada versi 2.0.

Parameter

stage_instance_id (int) -- The ID to search for.

Kembali

The stage instance or None if not found.

Tipe pengembalian

Optional[StageInstance]

property owner: Optional[discord.member.Member]

The member that owns the guild.

tipe

Optional[Member]

property icon: Optional[discord.asset.Asset]

Returns the guild's icon asset, if available.

tipe

Optional[Asset]

property banner: Optional[discord.asset.Asset]

Returns the guild's banner asset, if available.

tipe

Optional[Asset]

property splash: Optional[discord.asset.Asset]

Returns the guild's banner asset, if available.

Berubah pada versi 2.0: Can be animated if the guild have ANIMATED_BANNER feature.

tipe

Optional[Asset]

property discovery_splash: Optional[discord.asset.Asset]

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

tipe

Optional[Asset]

property member_count: int

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

Peringatan

Due to a Discord limitation, in order for this attribute to remain up-to-date and accurate, it requires Intents.members to be specified.

tipe

int

property chunked: bool

Returns a boolean indicating if the guild is "chunked".

A chunked guild means that member_count is equal to the number of members stored in the internal members cache.

If this value returns False, then you should request for offline members.

tipe

bool

property shard_id: int

Returns the shard ID for this guild if applicable.

tipe

int

property created_at: datetime.datetime

Returns the guild's creation time in UTC.

tipe

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.

Parameter

name (str) -- The name of the member to lookup with an optional discriminator.

Kembali

The member in this guild with the associated name. If not found then None is returned.

Tipe pengembalian

Optional[Member]

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

This function is a coroutine.

Creates a TextChannel for the guild.

Note that you need the manage_channels permission to create the channel.

The overwrites parameter can be used to create a 'secret' channel upon creation. This parameter expects a dict of overwrites with the target (either a Member or a Role) as the key and a PermissionOverwrite as the value.

Catatan

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.

Contoh-contoh

Creating a basic channel:

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

Creating a "secret" channel:

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

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

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

Menimbulkan

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

Kembali

The channel that was just created.

Tipe pengembalian

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.

Parameter

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

    Baru pada versi 1.7.

  • video_quality_mode (VideoQualityMode) --

    The camera video quality for the voice channel's participants.

    Baru pada versi 2.0.

  • reason (Optional[str]) -- The reason for creating this channel. Shows up on the audit log.

Menimbulkan

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

Kembali

The channel that was just created.

Tipe pengembalian

VoiceChannel

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

This function is a coroutine.

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

Baru pada versi 1.7.

Parameter

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

Menimbulkan

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

Kembali

The channel that was just created.

Tipe pengembalian

StageChannel

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

This function is a coroutine.

Same as create_text_channel() except makes a CategoryChannel instead.

Catatan

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

Menimbulkan

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

Kembali

The channel that was just created.

Tipe pengembalian

CategoryChannel

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

This function is a coroutine.

Same as create_text_channel() except makes a CategoryChannel instead.

Catatan

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

Menimbulkan

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

Kembali

The channel that was just created.

Tipe pengembalian

CategoryChannel

await create_event(name, scheduled_start_time, *, description=..., scheduled_end_time=..., privacy_level=..., channel=..., entity_type=..., location=...)

This function is a coroutine.

Create a new guild event.

You must have the manage_events permission to create a guild event.

Catatan

Another extra permissions is required for different type of entity_type.

If your entity type is GuildScheduledEventType.stage_instance, you must have the following extra permissions:

If your entity type is GuildScheduledEventType.voice, you must have the following extra permissions:

  • view_channel for channel associated with the event.

  • connect for channel associated with the event.

If your entity type is GuildScheduledEventType.external, you dont need any extra permissions.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the event.

  • description (Optional[str]) -- The description of the event. Could be None for no description.

  • channel (Optional[abc.GuildChannel]) -- The channel where the event will be conducted.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level, same thing as StageInstance PrivacyLevel

  • scheduled_start_time (datetime.datetime) -- The scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • scheduled_end_time (Optional[datetime.datetime]) -- The scheduled end time, timezone must be UTC. If not it will be converted automatically. It would be used if the event is a GuildScheduledEventType.location event.

  • entity_type (Optional[GuildScheduledEventType]) -- The entity_type or type for the event.

  • location (Optional[str]) -- The location for the event. It would be used if the event is a GuildScheduledEventType.location event.

Menimbulkan

  • Forbidden -- You do not have permissions to create the guild event.

  • HTTPException -- Creating the guild event failed.

  • ValueError -- Validation error occurred.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

await create_scheduled_event(name, scheduled_start_time, *, description=..., scheduled_end_time=..., privacy_level=..., channel=..., entity_type=..., location=...)

This function is a coroutine.

Create a new guild event.

You must have the manage_events permission to create a guild event.

Catatan

Another extra permissions is required for different type of entity_type.

If your entity type is GuildScheduledEventType.stage_instance, you must have the following extra permissions:

If your entity type is GuildScheduledEventType.voice, you must have the following extra permissions:

  • view_channel for channel associated with the event.

  • connect for channel associated with the event.

If your entity type is GuildScheduledEventType.external, you dont need any extra permissions.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the event.

  • description (Optional[str]) -- The description of the event. Could be None for no description.

  • channel (Optional[abc.GuildChannel]) -- The channel where the event will be conducted.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level, same thing as StageInstance PrivacyLevel

  • scheduled_start_time (datetime.datetime) -- The scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • scheduled_end_time (Optional[datetime.datetime]) -- The scheduled end time, timezone must be UTC. If not it will be converted automatically. It would be used if the event is a GuildScheduledEventType.location event.

  • entity_type (Optional[GuildScheduledEventType]) -- The entity_type or type for the event.

  • location (Optional[str]) -- The location for the event. It would be used if the event is a GuildScheduledEventType.location event.

Menimbulkan

  • Forbidden -- You do not have permissions to create the guild event.

  • HTTPException -- Creating the guild event failed.

  • ValueError -- Validation error occurred.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

await leave()

This function is a coroutine.

Leaves the guild.

Catatan

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

Menimbulkan

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.

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

This function is a coroutine.

Edits the guild.

You must have the manage_guild permission to edit the guild.

Berubah pada versi 1.4: The rules_channel and public_updates_channel keyword-only parameters were added.

Berubah pada versi 2.0: The discovery_splash and community keyword-only parameters were added.

Berubah pada versi 2.0: The newly updated guild is returned.

Parameter

  • name (str) -- The new name of the guild.

  • description (Optional[str]) -- The new description of the guild. Could be None for no description. This is only available to guilds that contain PUBLIC in Guild.features.

  • icon (bytes) -- A bytes-like object representing the icon. Only PNG/JPEG is supported. GIF is only available to guilds that contain ANIMATED_ICON in Guild.features. Could be None to denote removal of the icon.

  • banner (bytes) -- A bytes-like object representing the banner. Could be None to denote removal of the banner. This is only available to guilds that contain BANNER in Guild.features.

  • splash (bytes) -- A bytes-like object representing the invite splash. Only PNG/JPEG supported. Could be None to denote removing the splash. This is only available to guilds that contain INVITE_SPLASH in Guild.features.

  • discovery_splash (bytes) -- A bytes-like object representing the discovery splash. Only PNG/JPEG supported. Could be None to denote removing the splash. This is only available to guilds that contain DISCOVERABLE in Guild.features.

  • community (bool) -- Whether the guild should be a Community guild. If set to True, both rules_channel and public_updates_channel parameters are required.

  • region (Union[str, VoiceRegion]) -- The new region for the guild's voice communication.

  • afk_channel (Optional[VoiceChannel]) -- The new channel that is the AFK channel. Could be None for no AFK channel.

  • afk_timeout (int) -- The number of seconds until someone is moved to the AFK channel.

  • owner (Member) -- The new owner of the guild to transfer ownership to. Note that you must be owner of the guild to do this.

  • verification_level (VerificationLevel) -- The new verification level for the guild.

  • default_notifications (NotificationLevel) -- The new default notification level for the guild.

  • explicit_content_filter (ContentFilter) -- The new explicit content filter for the guild.

  • vanity_code (str) -- The new vanity code for the guild.

  • system_channel (Optional[TextChannel]) -- The new channel that is used for the system channel. Could be None for no system channel.

  • system_channel_flags (SystemChannelFlags) -- The new system channel settings to use with the new system channel.

  • preferred_locale (str) -- The new preferred locale for the guild. Used as the primary language in the guild. If set, this must be an ISO 639 code, e.g. en-US or ja or zh-CN.

  • rules_channel (Optional[TextChannel]) -- The new channel that is used for rules. This is only available to guilds that contain PUBLIC in Guild.features. Could be None for no rules channel.

  • public_updates_channel (Optional[TextChannel]) -- The new channel that is used for public updates from Discord. This is only available to guilds that contain PUBLIC in Guild.features. Could be None for no public updates channel.

  • reason (Optional[str]) -- The reason for editing this guild. Shows up on the audit log.

Menimbulkan

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

Kembali

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

Tipe pengembalian

Guild

await fetch_channels()

This function is a coroutine.

Retrieves all abc.GuildChannel that the guild has.

Catatan

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

Baru pada versi 1.2.

Menimbulkan
Kembali

All channels in the guild.

Tipe pengembalian

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.

Baru pada versi 2.0.

Menimbulkan

HTTPException -- The request to get the active threads failed.

Kembali

The active threads

Tipe pengembalian

List[Thread]

await fetch_member(member_id, /)

This function is a coroutine.

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

Catatan

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

Parameter

member_id (int) -- The member's ID to fetch from.

Menimbulkan
Kembali

The member from the member ID.

Tipe pengembalian

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.

Parameter

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

Menimbulkan

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

Kembali

The BanEntry object for the specified user.

Tipe pengembalian

BanEntry

await fetch_channel(channel_id, /)

This function is a coroutine.

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

Catatan

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

Baru pada versi 2.0.

Menimbulkan

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

Kembali

The channel from the ID.

Tipe pengembalian

Union[abc.GuildChannel, Thread]

await fetch_events()

This function is a coroutine.

Retrieves all the events that are scheduled or ongoing from the guild as a list of GuildScheduledEvent.

Baru pada versi 2.0.

Menimbulkan

HTTPException -- Retrieving the events failed.

Kembali

A list of GuildScheduledEvent objects.

Tipe pengembalian

List[GuildScheduledEvent]

await bans()

This function is a coroutine.

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

You must have the ban_members permission to get this information.

Menimbulkan

  • Forbidden -- You do not have proper permissions to get the information.

  • HTTPException -- An error occurred while fetching the information.

Kembali

A list of BanEntry objects.

Tipe pengembalian

List[BanEntry]

await prune_members(*, days, compute_prune_count=True, roles=..., reason=None)

This function is a coroutine.

Prunes the guild from its inactive members.

The inactive members are denoted if they have not logged on in days number of days and they have no roles.

You must have the kick_members permission to use this.

To check how many members you would prune without actually pruning, see the estimate_pruned_members() function.

To prune members that have specific roles see the roles parameter.

Berubah pada versi 1.4: The roles keyword-only parameter was added.

Parameter

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

Menimbulkan
Kembali

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

Tipe pengembalian

Optional[int]

await templates()

This function is a coroutine.

Gets the list of templates from this guild.

Requires manage_guild permissions.

Baru pada versi 1.7.

Menimbulkan

Forbidden -- You don't have permissions to get the templates.

Kembali

The templates for this guild.

Tipe pengembalian

List[Template]

await webhooks()

This function is a coroutine.

Gets the list of webhooks from this guild.

Requires manage_webhooks permissions.

Menimbulkan

Forbidden -- You don't have permissions to get the webhooks.

Kembali

The webhooks for this guild.

Tipe pengembalian

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.

Parameter

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

    Baru pada versi 1.7.

Menimbulkan

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

Kembali

The number of members estimated to be pruned.

Tipe pengembalian

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.

Menimbulkan

  • Forbidden -- You do not have proper permissions to get the information.

  • HTTPException -- An error occurred while fetching the information.

Kembali

The list of invites that are currently active.

Tipe pengembalian

List[Invite]

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

This function is a coroutine.

Creates a template for the guild.

You must have the manage_guild permission to do this.

Baru pada versi 1.7.

Parameter

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

Baru pada versi 1.4.

Parameter

  • type (str) -- The integration type (e.g. Twitch).

  • id (int) -- The integration ID.

Menimbulkan

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

Baru pada versi 1.4.

Menimbulkan

  • Forbidden -- You do not have permission to create the integration.

  • HTTPException -- Fetching the integrations failed.

Kembali

The list of integrations that are attached to the guild.

Tipe pengembalian

List[Integration]

await fetch_stickers()

This function is a coroutine.

Retrieves a list of all Stickers for the guild.

Baru pada versi 2.0.

Catatan

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

Menimbulkan

HTTPException -- An error occurred fetching the stickers.

Kembali

The retrieved stickers.

Tipe pengembalian

List[GuildSticker]

await fetch_sticker(sticker_id, /)

This function is a coroutine.

Retrieves a custom Sticker from the guild.

Baru pada versi 2.0.

Catatan

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

Parameter

sticker_id (int) -- The sticker's ID.

Menimbulkan

  • NotFound -- The sticker requested could not be found.

  • HTTPException -- An error occurred fetching the sticker.

Kembali

The retrieved sticker.

Tipe pengembalian

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.

Baru pada versi 2.0.

Parameter

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

Menimbulkan
Kembali

The created sticker.

Tipe pengembalian

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.

Baru pada versi 2.0.

Parameter

  • sticker (abc.Snowflake) -- The sticker you are deleting.

  • reason (Optional[str]) -- The reason for deleting this sticker. Shows up on the audit log.

Menimbulkan

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

Catatan

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

Menimbulkan

HTTPException -- An error occurred fetching the emojis.

Kembali

The retrieved emojis.

Tipe pengembalian

List[Emoji]

await fetch_emoji(emoji_id, /)

This function is a coroutine.

Retrieves a custom Emoji from the guild.

Catatan

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

Parameter

emoji_id (int) -- The emoji's ID.

Menimbulkan

  • NotFound -- The emoji requested could not be found.

  • HTTPException -- An error occurred fetching the emoji.

Kembali

The retrieved emoji.

Tipe pengembalian

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.

Parameter

  • name (str) -- The emoji name. Must be at least 2 characters.

  • image (bytes) -- The bytes-like object representing the image data to use. Only JPG, PNG and GIF images are supported.

  • roles (List[Role]) -- A list of Roles that can use this emoji. Leave empty to make it available to everyone.

  • reason (Optional[str]) -- The reason for creating this emoji. Shows up on the audit log.

Menimbulkan
Kembali

The created emoji.

Tipe pengembalian

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.

Parameter

  • emoji (abc.Snowflake) -- The emoji you are deleting.

  • reason (Optional[str]) -- The reason for deleting this emoji. Shows up on the audit log.

Menimbulkan
await fetch_roles()

This function is a coroutine.

Retrieves all Role that the guild has.

Catatan

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

Baru pada versi 1.3.

Menimbulkan

HTTPException -- Retrieving the roles failed.

Kembali

All roles in the guild.

Tipe pengembalian

List[Role]

await create_role(*, name=..., permissions=..., color=..., colour=..., icon=..., emoji_unicode=..., hoist=..., mentionable=..., reason=None)

This function is a coroutine.

Creates a Role for the guild.

All fields are optional.

You must have the manage_roles permission to do this.

Berubah pada versi 1.6: Can now pass int to colour keyword-only parameter.

Berubah pada versi 2.0: Added icon and emoji_unicode parameter.

Parameter

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

  • icon (Optional[bytes]) --

    A bytes object representing the role icon.

    Baru pada versi 2.0.

  • emoji_unicode (Optional[str]) --

    The unicode value of the new role to change to.

    Baru pada versi 2.0.

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

  • reason (Optional[str]) -- The reason for creating this role. Shows up on the audit log.

Menimbulkan
Kembali

The newly created role.

Tipe pengembalian

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.

Baru pada versi 1.4.

Example:

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

await guild.edit_role_positions(positions=positions)
Parameter

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

Menimbulkan
Kembali

A list of all the roles in the guild.

Tipe pengembalian

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.

Parameter

  • user (abc.Snowflake) -- The user to kick from their guild.

  • reason (Optional[str]) -- The reason the user got kicked.

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

This function is a coroutine.

Bans a user from the guild.

The user must meet the abc.Snowflake abc.

You must have the ban_members permission to do this.

Parameter

  • user (abc.Snowflake) -- The user to ban from their guild.

  • delete_message_days (int) -- The number of days worth of messages to delete from the user in the guild. The minimum is 0 and the maximum is 7.

  • reason (Optional[str]) -- The reason the user got banned.

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

Parameter

  • user (abc.Snowflake) -- The user to unban.

  • reason (Optional[str]) -- The reason for doing this action. Shows up on the audit log.

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

Menimbulkan

  • Forbidden -- You do not have the proper permissions to get this.

  • HTTPException -- Retrieving the vanity invite failed.

Kembali

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

Tipe pengembalian

Optional[Invite]

await welcome_screen()

This function is a coroutine.

Returns the guild's welcome screen.

The guild must have COMMUNITY in features.

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

Baru pada versi 2.0.

Menimbulkan

  • Forbidden -- You do not have the proper permissions to get this.

  • HTTPException -- Retrieving the vanity invite failed.

Kembali

The welcome screen.

Tipe pengembalian

WelcomeScreen

await edit_welcome_screen(**kwargs)

This function is a coroutine.

A shorthand method of WelcomeScreen.edit without needing to fetch the welcome screen beforehand.

You must have the manage_guild permission in the guild to do this.

Catatan

Welcome channels can only accept custom emojis if premium_tier is level 2 or above.

Parameter

  • enabled (bool) -- Should we enable the welcome screen of not.

  • channels (List[WelcomeChannel]) -- The channels to use for the welcome screen.

  • description (str) -- The description of the welcome screen.

  • reason (Optional[str]) -- The reason for editing the welcome screen. Shows up on the audit log.

Menimbulkan
await widget()

This function is a coroutine.

Returns the widget of the guild.

Catatan

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

Menimbulkan
Kembali

The guild's widget.

Tipe pengembalian

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

Baru pada versi 2.0.

Parameter

  • enabled (bool) -- Whether to enable the widget for the guild.

  • channel (Optional[Snowflake]) -- The new widget channel. None removes the widget channel.

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

Baru pada versi 1.5.

Parameter

cache (bool) -- Whether to cache the members as well.

Menimbulkan

ClientException -- The members intent is not enabled.

await query_members(query=None, *, limit=5, user_ids=None, presences=False, cache=True)

This function is a coroutine.

Request members that belong to this guild whose username starts with the query given.

This is a websocket operation and can be slow.

Baru pada versi 1.3.

Parameter

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

    Baru pada versi 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.

    Baru pada versi 1.4.

Menimbulkan
Kembali

The list of members that have matched the query.

Tipe pengembalian

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.

Baru pada versi 1.4.

Parameter

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

class discord.BanEntry

A namedtuple which represents a ban returned from bans().

reason

The reason this user was banned.

tipe

Optional[str]

user

The User that was banned.

tipe

User

GuildScheduledEvent

Peringatan

Event is not fetched on startup, you need to fetch it manually for your guild via Client.fetch_guild_events().

Attributes
Methods
class discord.GuildScheduledEvent

Represents a Discord guild event.

Baru pada versi 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.

id

The event's ID.

tipe

int

name

The event's name.

tipe

str

description

The event's description.

tipe

Optional[str]

type

The guild event type.

tipe

GuildScheduledEventType

start_time

The event's scheduled start time.

tipe

datetime.datetime

end_time

The event's scheduled end time.

tipe

Optional[datetime.datetime]

status

The event's current status.

tipe

GuildScheduledEventStatus

privacy_level

The event's privacy level.

tipe

GuildScheduledEventPrivacyLevel

guild

The guild the event belongs to.

tipe

Guild

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

Retrieves an AsyncIterator that enables receiving your guild event members.

Catatan

If the member joining the event is not in the guild, it will return User instead of Member.

Catatan

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

Contoh-contoh

Usage

async for member in event.fetch_members(limit=100):
    print(member.name)

Flattening into a list

members = await event.fetch_members(limit=100).flatten()
# members is now a list of User or Member...

All parameters are optional.

Parameter

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

  • before (Union[abc.Snowflake, datetime.datetime]) -- Retrieves members before this date or object (user id). 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 members after this date or object (user id). 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.

Menimbulkan

  • Forbidden -- You do not have permissions to fetch the members.

  • HTTPException -- Fetching the members failed.

Hasil

Union[Member, User] -- The member or user that are attending the event.

property channel: Optional[GuildChannel]

The channel associated with this event, can be None.

tipe

Optional[abc.GuildChannel]

property image: Optional[discord.asset.Asset]

The image associated with the event, can be None.

tipe

Optional[Asset]

property members: List[Union[Member, User]]

List of user that subscribed to the event.

tipe

List[Union[Member, User]]

get_member(user_id, /)

Returns a member with the given ID.

Parameter

user_id (int) -- The ID to search for.

Kembali

The member or None if not found.

Tipe pengembalian

Optional[Union[Member, User]]

property member_count: Optional[int]

Total member that are subscribed to the event

tipe

Optional[int]

property location: Optional[str]

Location of the event

tipe

Optional[str]

property metadata: discord.guild_events.GuildEventEntityMetadata

Get the entity metadata of the event.

This attribute or class will contains:

Not all of the fields will be filled, it will depends on what the event type is.

tipe

GuildEventEntityMetadata

property creator: Optional[Union[Member, User]]

The user that created the event

tipe

Optional[Union[Member, User]]

await edit(*, name=..., description=..., channel=..., privacy_level=..., scheduled_start_time=..., scheduled_end_time=..., entity_type=..., location=...)

This function is a coroutine.

Edits the guild event.

You must have the manage_events permission to edit the guild event.

Parameter

  • name (str) -- The new name of the event.

  • description (Optional[str]) -- The new description of the event. Could be None for no description.

  • channel (Optional[abc.GuildChannel]) -- The channel where the event will be conducted.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level.

  • scheduled_start_time (Optional[datetime.datetime]) -- The new scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • scheduled_end_time (Optional[datetime.datetime]) -- The new scheduled end time, timezone must be UTC. If not it will be converted automatically. It would be used if the event is a GuildScheduledEventType.location event.

  • entity_type (Optional[GuildScheduledEventType]) -- The new entity type or type for the event.

  • location (Optional[str]) -- The new location for the event. It would be used if the event is a GuildScheduledEventType.location event.

Menimbulkan

  • Forbidden -- You do not have permissions to edit the guild event.

  • HTTPException -- Editing the guild event failed.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

await delete()

This function is a coroutine.

Deletes the guild event.

You must have the manage_events permission to be able to delete the guild event.

Menimbulkan

  • Forbidden -- You do not have permissions to delete the guild event.

  • HTTPException -- Deleting the guild event failed.

Attributes
class discord.GuildEventEntityMetadata

Represents metadata about a guild event.

location

The location of the event, this will be filled if the event type is GuildScheduledEventType.location event.

tipe

Optional[str]

Integration

class discord.Integration

Represents a guild integration.

Baru pada versi 1.4.

id

The integration ID.

tipe

int

name

The integration name.

tipe

str

guild

The guild of the integration.

tipe

Guild

type

The integration type (i.e. Twitch).

tipe

str

enabled

Whether the integration is currently enabled.

tipe

bool

account

The account linked to this integration.

tipe

IntegrationAccount

user

The user that added this integration.

tipe

User

await delete(*, reason=None)

This function is a coroutine.

Deletes the integration.

You must have the manage_guild permission to do this.

Parameter

reason (str) --

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

Baru pada versi 2.0.

Menimbulkan

  • Forbidden -- You do not have permission to delete the integration.

  • HTTPException -- Deleting the integration failed.

class discord.IntegrationAccount

Represents an integration account.

Baru pada versi 1.4.

id

The account ID.

tipe

str

name

The account name.

tipe

str

class discord.BotIntegration

Represents a bot integration on discord.

Baru pada versi 2.0.

id

The integration ID.

tipe

int

name

The integration name.

tipe

str

guild

The guild of the integration.

tipe

Guild

type

The integration type (i.e. Twitch).

tipe

str

enabled

Whether the integration is currently enabled.

tipe

bool

user

The user that added this integration.

tipe

User

account

The integration account information.

tipe

IntegrationAccount

application

The application tied to this integration.

tipe

IntegrationApplication

class discord.IntegrationApplication

Represents an application for a bot integration.

Baru pada versi 2.0.

id

The ID for this application.

tipe

int

name

The application's name.

tipe

str

icon

The application's icon hash.

tipe

Optional[str]

description

The application's description. Can be an empty string.

tipe

str

summary

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

tipe

str

user

The bot user on this application.

tipe

Optional[User]

class discord.StreamIntegration

Represents a stream integration for Twitch or YouTube.

Baru pada versi 2.0.

id

The integration ID.

tipe

int

name

The integration name.

tipe

str

guild

The guild of the integration.

tipe

Guild

type

The integration type (i.e. Twitch).

tipe

str

enabled

Whether the integration is currently enabled.

tipe

bool

syncing

Where the integration is currently syncing.

tipe

bool

enable_emoticons

Whether emoticons should be synced for this integration (currently twitch only).

tipe

Optional[bool]

expire_behaviour

The behaviour of expiring subscribers. Aliased to expire_behavior as well.

tipe

ExpireBehaviour

expire_grace_period

The grace period (in days) for expiring subscribers.

tipe

int

user

The user for the integration.

tipe

User

account

The integration account information.

tipe

IntegrationAccount

synced_at

An aware UTC datetime representing when the integration was last synced.

tipe

datetime.datetime

property expire_behavior: discord.enums.ExpireBehaviour

An alias for expire_behaviour.

tipe

ExpireBehaviour

property role: Optional[Role]

Optional[Role] The role which the integration uses for subscribers.

await edit(*, expire_behaviour=..., expire_grace_period=..., enable_emoticons=...)

This function is a coroutine.

Edits the integration.

You must have the manage_guild permission to do this.

Parameter

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

Menimbulkan
await sync()

This function is a coroutine.

Syncs the integration.

You must have the manage_guild permission to do this.

Menimbulkan

  • Forbidden -- You do not have permission to sync the integration.

  • HTTPException -- Syncing the integration failed.

Interaction

Attributes
Methods
class discord.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.

Baru pada versi 2.0.

id

The interaction's ID.

tipe

int

type

The interaction type.

tipe

InteractionType

guild_id

The guild ID the interaction was sent from.

tipe

Optional[int]

channel_id

The channel ID the interaction was sent from.

tipe

Optional[int]

application_id

The application ID that the interaction was for.

tipe

int

user

The user or member that sent the interaction.

tipe

Optional[Union[User, Member]]

message

The message that sent this interaction.

tipe

Optional[Message]

token

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

tipe

str

data

The raw interaction data.

tipe

dict

property guild: Optional[Guild]

The guild the interaction was sent from.

tipe

Optional[Guild]

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.

tipe

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

property permissions: discord.permissions.Permissions

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

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

tipe

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.

tipe

InteractionResponse

followup

Returns the follow up webhook for follow up interactions.

tipe

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.

Menimbulkan
Kembali

The original interaction response message.

Tipe pengembalian

InteractionMessage

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

Parameter

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

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

Menimbulkan

  • HTTPException -- Editing the message failed.

  • Forbidden -- Edited a message that is not yours.

  • TypeError -- You specified both embed and embeds or file and files

  • ValueError -- The length of embeds was invalid.

Kembali

The newly edited message.

Tipe pengembalian

InteractionMessage

await delete_original_message()

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.

Menimbulkan

InteractionResponse

Methods
class discord.InteractionResponse

Represents a Discord interaction response.

This type can be accessed through Interaction.response.

Baru pada versi 2.0.

is_done()

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

An interaction can only be responded to once.

await defer(*, ephemeral=False)

This function is a coroutine.

Defers the interaction response.

This is typically used when the interaction is acknowledged and a secondary action will be done later.

Parameter

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

Menimbulkan
await pong()

This function is a coroutine.

Pongs the ping interaction.

This should rarely be used.

Menimbulkan
await send_message(content=None, *, embed=..., embeds=..., view=..., tts=False, ephemeral=False)

This function is a coroutine.

Responds to this interaction by sending a message.

Parameter

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

  • tts (bool) -- Indicates if the message should be sent using text-to-speech.

  • view (discord.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.

Menimbulkan
await edit_message(*, content=..., embed=..., embeds=..., attachments=..., view=...)

This function is a coroutine.

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

Parameter

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

  • attachments (List[Attachment]) -- A list of attachments to keep in the message. If [] is passed then all attachments are removed.

  • view (Optional[View]) -- The updated view to update this message with. If None is passed then the view is removed.

Menimbulkan

InteractionMessage

Methods
class discord.InteractionMessage

Represents the original interaction response message.

This allows you to edit or delete the message associated with the interaction response. To retrieve this object see Interaction.original_message().

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

Baru pada versi 2.0.

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

This function is a coroutine.

Edits the message.

Parameter

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

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

Menimbulkan

  • HTTPException -- Editing the message failed.

  • Forbidden -- Edited a message that is not yours.

  • TypeError -- You specified both embed and embeds or file and files

  • ValueError -- The length of embeds was invalid.

Kembali

The newly edited message.

Tipe pengembalian

InteractionMessage

await delete(*, delay=None)

This function is a coroutine.

Deletes the message.

Parameter

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.

Menimbulkan

  • Forbidden -- You do not have proper permissions to delete the message.

  • NotFound -- The message was deleted already.

  • HTTPException -- Deleting the message failed.

Member

Attributes
Methods
class discord.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.

tipe

Optional[datetime.datetime]

activities

The activities that the user is currently doing.

Catatan

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.

tipe

Tuple[Union[BaseActivity, Spotify]]

guild

The guild that the member belongs to.

tipe

Guild

nick

The guild specific nickname of the user.

tipe

Optional[str]

pending

Whether the member is pending member verification.

Baru pada versi 1.6.

tipe

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.

tipe

Optional[datetime.datetime]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

Contoh-contoh

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

Hasil

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.

Catatan

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

Kembali

The channel that was created.

Tipe pengembalian

DMChannel

property mutual_guilds

Equivalent to User.mutual_guilds

property public_flags

Equivalent to User.public_flags

property banner

Equivalent to User.banner

property accent_color

Equivalent to User.accent_color

property accent_colour

Equivalent to User.accent_colour

property raw_status: str

The member's overall status as a string value.

Baru pada versi 1.5.

tipe

str

property status: discord.enums.Status

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

tipe

Status

property mobile_status: discord.enums.Status

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

tipe

Status

property desktop_status: discord.enums.Status

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

tipe

Status

property web_status: discord.enums.Status

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

tipe

Status

is_on_mobile()

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

property colour: discord.colour.Colour

A property that returns a colour denoting the rendered colour for the member. If the default colour is the one rendered then an instance of Colour.default() is returned.

There is an alias for this named color.

tipe

Colour

property color: discord.colour.Colour

A property that returns a color denoting the rendered color for the member. If the default color is the one rendered then an instance of Colour.default() is returned.

There is an alias for this named colour.

tipe

Colour

property roles: List[Role]

A list of Role that the member belongs to. Note that the first element of this list is always the default '@everyone' role.

These roles are sorted by their position in the role hierarchy.

tipe

List[Role]

property mention: str

Returns a string that allows you to mention the member.

tipe

str

property display_name: str

Returns the user's display name.

For regular users this is just their username, but if they have a guild specific nickname then that is returned instead.

tipe

str

property display_avatar: discord.asset.Asset

Returns the member's display avatar.

For regular members this is just their avatar, but if they have a guild specific avatar then that is returned instead.

Baru pada versi 2.0.

tipe

Asset

property guild_avatar: Optional[discord.asset.Asset]

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

Baru pada versi 2.0.

tipe

Optional[Asset]

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

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

Catatan

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.

Catatan

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

tipe

Optional[Union[BaseActivity, Spotify]]

mentioned_in(message)

Checks if the member is mentioned in the specified message.

Parameter

message (Message) -- The message to check if you're mentioned in.

Kembali

Indicates if the member is mentioned in the message.

Tipe pengembalian

bool

property top_role: Role

Returns the member's highest role.

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

tipe

Role

property guild_permissions: discord.permissions.Permissions

Returns the member's guild permissions.

This only takes into consideration the guild permissions and not most of the implied permissions or any of the channel permission overwrites. For 100% accurate permission calculation, please use abc.GuildChannel.permissions_for().

This does take into consideration guild ownership and the administrator implication.

tipe

Permissions

property voice: Optional[discord.member.VoiceState]

Returns the member's current voice state.

tipe

Optional[VoiceState]

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

This function is a coroutine.

Bans this member. Equivalent to Guild.ban().

await unban(*, reason=None)

This function is a coroutine.

Unbans this member. Equivalent to Guild.unban().

await kick(*, reason=None)

This function is a coroutine.

Kicks this member. Equivalent to Guild.kick().

await edit(*, nick=..., mute=..., deafen=..., suppress=..., roles=..., voice_channel=..., reason=None)

This function is a coroutine.

Edits the member's data.

Depending on the parameter passed, this requires different permissions listed below:

Parameter

Permission

nick

Permissions.manage_nicknames

mute

Permissions.mute_members

deafen

Permissions.deafen_members

roles

Permissions.manage_roles

voice_channel

Permissions.move_members

All parameters are optional.

Berubah pada versi 1.1: Can now pass None to voice_channel to kick a member from voice.

Berubah pada versi 2.0: The newly member is now optionally returned, if applicable.

Parameter

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

    Baru pada versi 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.

Menimbulkan

  • Forbidden -- You do not have the proper permissions to the action requested.

  • HTTPException -- The operation failed.

Kembali

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

Tipe pengembalian

Optional[Member]

await request_to_speak()

This function is a coroutine.

Request to speak in the connected channel.

Only applies to stage channels.

Catatan

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

Baru pada versi 1.7.

Menimbulkan

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

Berubah pada versi 1.1: Can now pass None to kick a member from voice.

Parameter

  • channel (Optional[VoiceChannel]) -- The new voice channel to move the member to. Pass None to kick them from voice.

  • reason (Optional[str]) -- The reason for doing this action. Shows up on the audit log.

await add_roles(*roles, reason=None, atomic=True)

This function is a coroutine.

Gives the member a number of Roles.

You must have the manage_roles permission to use this, and the added Roles must appear lower in the list of roles than the highest role of the member.

Parameter

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

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

Parameter

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

Menimbulkan
await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameter

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

Menimbulkan

  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The message asked for.

Tipe pengembalian

Message

get_role(role_id, /)

Returns a role with the given ID from roles which the member has.

Baru pada versi 2.0.

Parameter

role_id (int) -- The ID to search for.

Kembali

The role or None if not found in the member's roles.

Tipe pengembalian

Optional[Role]

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Catatan

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

Menimbulkan

HTTPException -- Retrieving the pinned messages failed.

Kembali

The messages that are currently pinned.

Tipe pengembalian

List[Message]

await send(content=None, *, tts=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Parameter

  • 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 (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with 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.

    Baru pada versi 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.

    Baru pada versi 1.6.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    Baru pada versi 1.6.

  • view (discord.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.

    Baru pada versi 2.0.

  • stickers (Sequence[Union[GuildSticker, StickerItem]]) --

    A list of stickers to upload. Must be a maximum of 3.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The message that was sent.

Tipe pengembalian

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
class discord.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: discord.enums.ActivityType

Returns the activity's type. This is for compatibility with Activity.

It always returns ActivityType.listening.

tipe

ActivityType

property created_at: Optional[datetime.datetime]

When the user started listening in UTC.

Baru pada versi 1.3.

tipe

Optional[datetime.datetime]

property colour: discord.colour.Colour

Returns the Spotify integration colour, as a Colour.

There is an alias for this named color

tipe

Colour

property color: discord.colour.Colour

Returns the Spotify integration colour, as a Colour.

There is an alias for this named colour

tipe

Colour

property name: str

The activity's name. This will always return "Spotify".

tipe

str

property title: str

The title of the song being played.

tipe

str

property artists: List[str]

The artists of the song being played.

tipe

List[str]

property artist: str

The artist of the song being played.

This does not attempt to split the artist information into multiple artists. Useful if there's only a single artist.

tipe

str

property album: str

The album that the song being played belongs to.

tipe

str

property album_cover_url: str

The album cover image URL from Spotify's CDN.

tipe

str

property track_id: str

The track ID used by Spotify to identify this song.

tipe

str

property track_url: str

The track URL to listen on Spotify.

Baru pada versi 2.0.

tipe

str

property start: datetime.datetime

When the user started playing this song in UTC.

tipe

datetime.datetime

property end: datetime.datetime

When the user will stop playing this song in UTC.

tipe

datetime.datetime

property duration: datetime.timedelta

The duration of the song being played.

tipe

datetime.timedelta

property party_id: str

The party ID of the listening party.

tipe

str

VoiceState

Attributes
class discord.VoiceState

Represents a Discord user's voice state.

deaf

Indicates if the user is currently deafened by the guild.

tipe

bool

mute

Indicates if the user is currently muted by the guild.

tipe

bool

self_mute

Indicates if the user is currently muted by their own accord.

tipe

bool

self_deaf

Indicates if the user is currently deafened by their own accord.

tipe

bool

self_stream

Indicates if the user is currently streaming via 'Go Live' feature.

Baru pada versi 1.3.

tipe

bool

self_video

Indicates if the user is currently broadcasting video.

tipe

bool

suppress

Indicates if the user is suppressed from speaking.

Only applies to stage channels.

Baru pada versi 1.7.

tipe

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.

Baru pada versi 1.7.

tipe

Optional[datetime.datetime]

afk

Indicates if the user is currently in the AFK channel in the guild.

tipe

bool

channel

The voice channel that the user is currently connected to. None if the user is not currently in a voice channel.

tipe

Optional[Union[VoiceChannel, StageChannel]]

Emoji

Attributes
Methods
class discord.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.

tipe

str

id

The emoji's ID.

tipe

int

require_colons

If colons are required to use this emoji in the client (:PJSalt: vs PJSalt).

tipe

bool

animated

Whether an emoji is animated or not.

tipe

bool

managed

If this emoji is managed by a Twitch integration.

tipe

bool

guild_id

The guild ID the emoji belongs to.

tipe

int

available

Whether the emoji is available for use.

tipe

bool

user

The user that created the emoji. This can only be retrieved using Guild.fetch_emoji() and having the manage_emojis permission.

tipe

Optional[User]

property created_at: datetime

Returns the emoji's creation time in UTC.

tipe

datetime.datetime

property url: str

Returns the URL of the emoji.

tipe

str

property roles: List[Role]

A list of roles that is allowed to use this emoji.

If roles is empty, the emoji is unrestricted.

tipe

List[Role]

property guild: Guild

The guild this emoji belongs to.

tipe

Guild

is_usable()

bool: Whether the bot can use this emoji.

Baru pada versi 1.3.

await delete(*, reason=None)

This function is a coroutine.

Deletes the custom emoji.

You must have manage_emojis permission to do this.

Parameter

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

Menimbulkan
await edit(*, name=..., roles=..., reason=None)

This function is a coroutine.

Edits the custom emoji.

You must have manage_emojis permission to do this.

Berubah pada versi 2.0: The newly updated emoji is returned.

Parameter

  • name (str) -- The new emoji name.

  • roles (Optional[List[Snowflake]]) -- A list of roles that can use this emoji. An empty list can be passed to make it available to everyone.

  • reason (Optional[str]) -- The reason for editing this emoji. Shows up on the audit log.

Menimbulkan
Kembali

The newly updated emoji.

Tipe pengembalian

Emoji

await read()

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Menimbulkan
Kembali

The content of the asset.

Tipe pengembalian

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameter

  • fp (Union[io.BufferedIOBase, os.PathLike]) -- The file-like object to save this attachment to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

  • seek_begin (bool) -- Whether to seek to the beginning of the file after saving is successfully done.

Menimbulkan
Kembali

The number of bytes written.

Tipe pengembalian

int

PartialEmoji

Attributes
Methods
class discord.PartialEmoji

Represents a "partial" emoji.

This model will be given in two scenarios:

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

tipe

Optional[str]

animated

Whether the emoji is animated or not.

tipe

bool

id

The ID of the custom emoji, if applicable.

tipe

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.

Baru pada versi 2.0.

Parameter

value (str) -- The string representation of an emoji.

Kembali

The partial emoji from this string.

Tipe pengembalian

PartialEmoji

is_custom_emoji()

bool: Checks if this is a custom non-Unicode emoji.

is_unicode_emoji()

bool: Checks if this is a Unicode emoji.

property created_at: Optional[datetime]

Returns the emoji's creation time in UTC, or None if Unicode emoji.

Baru pada versi 1.6.

tipe

Optional[datetime.datetime]

property url: str

Returns the URL of the emoji, if it is custom.

If this isn't a custom emoji then an empty string is returned

tipe

str

await read()

This function is a coroutine.

Retrieves the content of this asset as a bytes object.

Menimbulkan
Kembali

The content of the asset.

Tipe pengembalian

bytes

await save(fp, *, seek_begin=True)

This function is a coroutine.

Saves this asset into a file-like object.

Parameter

  • fp (Union[io.BufferedIOBase, os.PathLike]) -- The file-like object to save this attachment to or the filename to use. If a filename is passed then a file is created with that filename and used instead.

  • seek_begin (bool) -- Whether to seek to the beginning of the file after saving is successfully done.

Menimbulkan
Kembali

The number of bytes written.

Tipe pengembalian

int

Role

Attributes
Methods
class discord.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.

tipe

int

name

The name of the role.

tipe

str

guild

The guild the role belongs to.

tipe

Guild

hoist

Indicates if the role will be displayed separately from other members.

tipe

bool

position

The position of the role. This number is usually positive. The bottom role has a position of 0.

Peringatan

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.

tipe

int

managed

Indicates if the role is managed by the guild through some form of integrations such as Twitch.

tipe

bool

mentionable

Indicates if the role can be mentioned by users.

tipe

bool

tags

The role tags associated with this role.

tipe

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.

Baru pada versi 1.6.

is_premium_subscriber()

bool: Whether the role is the premium subscriber, AKA "boost", role for the guild.

Baru pada versi 1.6.

is_integration()

bool: Whether the role is managed by an integration.

Baru pada versi 1.6.

is_assignable()

bool: Whether the role is able to be assigned or removed by the bot.

Baru pada versi 2.0.

property permissions: discord.permissions.Permissions

Returns the role's permissions.

tipe

Permissions

property colour: discord.colour.Colour

Returns the role colour. An alias exists under color.

tipe

Colour

property color: discord.colour.Colour

Returns the role color. An alias exists under colour.

tipe

Colour

property created_at: datetime.datetime

Returns the role's creation time in UTC.

tipe

datetime.datetime

property mention: str

Returns a string that allows you to mention a role.

tipe

str

property members: List[Member]

Returns all the members with this role.

tipe

List[Member]

property icon: Optional[discord.asset.Asset]

Returns the icon asset associated with this role, can be None.

Baru pada versi 2.0.

Catatan

The guild needs to have the ROLE_ICONS features to have this enabled.

tipe

Optional[Asset]

property emoji: Optional[discord.partial_emoji.PartialEmoji]

Returns the emoji that associated with this role, can be None.

Baru pada versi 2.0.

Catatan

The guild needs to have the ROLE_ICONS features to have this enabled.

tipe

Optional[PartialEmoji]

await edit(*, name=..., permissions=..., colour=..., color=..., icon=..., emoji_unicode=..., hoist=..., mentionable=..., position=..., reason=...)

This function is a coroutine.

Edits the role.

You must have the manage_roles permission to use this.

All fields are optional.

Berubah pada versi 1.4: Can now pass int to colour keyword-only parameter.

Berubah pada versi 2.0: Edits are no longer in-place, the newly edited role is returned instead. Also added a new icon and emoji_unicode parameter to change role icons.

Parameter

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

  • icon (bytes) --

    A bytes object representing the role icon.

    Baru pada versi 2.0.

  • emoji_unicode (str) --

    The unicode value of the new role to change to.

    Baru pada versi 2.0.

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

  • reason (Optional[str]) -- The reason for editing this role. Shows up on the audit log.

Menimbulkan

  • Forbidden -- You do not have permissions to change the role.

  • HTTPException -- Editing the role failed.

  • InvalidArgument -- An invalid position was given or the default role was asked to be moved.

Kembali

The newly edited role.

Tipe pengembalian

Role

await delete(*, reason=None)

This function is a coroutine.

Deletes the role.

You must have the manage_roles permission to use this.

Parameter

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

Menimbulkan

RoleTags

Attributes
Methods
class discord.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.

Baru pada versi 1.6.

bot_id

The bot's user ID that manages this role.

tipe

Optional[int]

integration_id

The integration ID that manages the role.

tipe

Optional[int]

is_bot_managed()

bool: Whether the role is associated with a bot.

is_premium_subscriber()

bool: Whether the role is the premium subscriber, AKA "boost", role for the guild.

is_integration()

bool: Whether the role is managed by an integration.

PartialMessageable

Attributes
Methods
class discord.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.

Baru pada versi 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.

tipe

int

type

The channel type associated with this partial messageable, if given.

tipe

Optional[ChannelType]

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameter

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

Menimbulkan

  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The message asked for.

Tipe pengembalian

Message

history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

Contoh-contoh

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

Hasil

Message -- The message with the message data parsed.

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Catatan

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

Menimbulkan

HTTPException -- Retrieving the pinned messages failed.

Kembali

The messages that are currently pinned.

Tipe pengembalian

List[Message]

await send(content=None, *, tts=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Parameter

  • 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 (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with 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.

    Baru pada versi 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.

    Baru pada versi 1.6.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    Baru pada versi 1.6.

  • view (discord.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.

    Baru pada versi 2.0.

  • stickers (Sequence[Union[GuildSticker, StickerItem]]) --

    A list of stickers to upload. Must be a maximum of 3.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The message that was sent.

Tipe pengembalian

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.

Catatan

This is both a regular context manager and an async context manager. This means that both with and async with work with this.

Example Usage:

async with channel.typing():
    # simulate something heavy
    await asyncio.sleep(10)

await channel.send('done!')
get_partial_message(message_id, /)

Creates a PartialMessage from the message ID.

This is useful if you want to work with a message and only have its ID without doing an unnecessary API call.

Parameter

message_id (int) -- The message ID to create a partial message for.

Kembali

The partial message.

Tipe pengembalian

PartialMessage

TextChannel

Attributes
Methods
class discord.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.

tipe

str

guild

The guild the channel belongs to.

tipe

Guild

id

The channel ID.

tipe

int

category_id

The category channel ID this channel belongs to, if applicable.

tipe

Optional[int]

topic

The channel's topic. None if it doesn't exist.

tipe

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.

tipe

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.

tipe

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.

tipe

int

nsfw

If the channel is marked as "not safe for work".

Catatan

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

tipe

bool

default_auto_archive_duration

The default auto archive duration in minutes for threads created in this channel.

Baru pada versi 2.0.

tipe

int

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

Contoh-contoh

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

Hasil

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.

Catatan

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: discord.enums.ChannelType

The channel's Discord type.

tipe

ChannelType

permissions_for(obj, /)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

  • Guild owner

  • Guild roles

  • Channel overrides

  • Member overrides

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

  • The default role permissions

  • The permissions of the role used as a parameter

  • The default role permission overwrites

  • The permission overwrites of the role used as a parameter

Berubah pada versi 2.0: The object passed in can now be a role object.

Parameter

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.

Kembali

The resolved permissions for the member or role.

Tipe pengembalian

Permissions

property members: List[Member]

Returns all members that can see this channel.

tipe

List[Member]

property threads: List[discord.threads.Thread]

Returns all the threads that you can see.

Baru pada versi 2.0.

tipe

List[Thread]

is_nsfw()

bool: Checks if the channel is NSFW.

is_news()

bool: Checks if the channel is a news channel.

property last_message: Optional[Message]

Fetches the last message from this channel in cache.

The message might not be valid or point to an existing message.

Reliable Fetching

For a slightly more reliable method of fetching the last message, consider using either history() or fetch_message() with the last_message_id attribute.

Kembali

The last message in this channel or None if not found.

Tipe pengembalian

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.

Berubah pada versi 1.3: The overwrites keyword-only parameter was added.

Berubah pada versi 1.4: The type keyword-only parameter was added.

Berubah pada versi 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameter

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

Menimbulkan

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

Kembali

The newly edited text channel. If the edit was only positional then None is returned instead.

Tipe pengembalian

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.

Baru pada versi 1.1.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have the proper permissions to create this channel.

  • HTTPException -- Creating the channel failed.

Kembali

The channel that was created.

Tipe pengembalian

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.

Parameter

messages (Iterable[abc.Snowflake]) -- An iterable of messages denoting which ones to bulk delete.

Menimbulkan

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

Contoh-contoh

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

  • Forbidden -- You do not have proper permissions to do the actions required.

  • HTTPException -- Purging the messages failed.

Kembali

The list of messages that were deleted.

Tipe pengembalian

List[Message]

await webhooks()

This function is a coroutine.

Gets the list of webhooks from this channel.

Requires manage_webhooks permissions.

Menimbulkan

Forbidden -- You don't have permissions to get the webhooks.

Kembali

The webhooks for this channel.

Tipe pengembalian

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.

Berubah pada versi 1.1: Added the reason keyword-only parameter.

Parameter

  • name (str) -- The webhook's name.

  • avatar (Optional[bytes]) -- A bytes-like object representing the webhook's default avatar. This operates similarly to edit().

  • reason (Optional[str]) -- The reason for creating this webhook. Shows up in the audit logs.

Menimbulkan
Kembali

The created webhook.

Tipe pengembalian

Webhook

await follow(*, destination, reason=None)

Follows a channel using a webhook.

Only news channels can be followed.

Catatan

The webhook returned will not provide a token to do webhook actions, as Discord does not provide it.

Baru pada versi 1.3.

Parameter

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

    Baru pada versi 1.4.

Menimbulkan

  • HTTPException -- Following the channel failed.

  • Forbidden -- You do not have the permissions to create a webhook.

Kembali

The created webhook.

Tipe pengembalian

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.

Baru pada versi 1.6.

Parameter

message_id (int) -- The message ID to create a partial message for.

Kembali

The partial message.

Tipe pengembalian

PartialMessage

get_thread(thread_id, /)

Returns a thread with the given ID.

Baru pada versi 2.0.

Parameter

thread_id (int) -- The ID to search for.

Kembali

The returned thread or None if not found.

Tipe pengembalian

Optional[Thread]

await create_thread(*, name, message=None, auto_archive_duration=..., type=None, reason=None)

This function is a coroutine.

Creates a thread in this text channel.

To create a public thread, you must have create_public_threads. For a private thread, create_private_threads is needed instead.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the thread.

  • message (Optional[abc.Snowflake]) -- A snowflake representing the message to create the thread with. If None is passed then a private thread is created. Defaults to None.

  • auto_archive_duration (int) -- The duration in minutes before a thread is automatically archived for inactivity. If not provided, the channel's default auto archive duration is used.

  • type (Optional[ChannelType]) -- The type of thread to create. If a message is passed then this parameter is ignored, as a thread created with a message is always a public thread. By default this creates a private thread if this is None.

  • reason (str) -- The reason for creating a new thread. Shows up on the audit log.

Menimbulkan
Kembali

The created thread

Tipe pengembalian

Thread

archived_threads(*, private=False, joined=False, limit=50, before=None)

Returns an AsyncIterator that iterates over all archived threads in the guild.

You must have read_message_history to use this. If iterating over private threads then manage_threads is also required.

Baru pada versi 2.0.

Parameter

  • limit (Optional[bool]) -- The number of threads to retrieve. If None, retrieves every archived thread in the channel. Note, however, that this would make it a slow operation.

  • before (Optional[Union[abc.Snowflake, datetime.datetime]]) -- Retrieve archived channels before the given date or ID.

  • private (bool) -- Whether to retrieve private archived threads.

  • joined (bool) -- Whether to retrieve private archived threads that you've joined. You cannot set joined to True and private to False.

Menimbulkan

  • Forbidden -- You do not have permissions to get archived threads.

  • HTTPException -- The request to get the archived threads failed.

Hasil

Thread -- The archived threads.

property category: Optional[CategoryChannel]

The category this channel belongs to.

If there is no category then this is None.

tipe

Optional[CategoryChannel]

property changed_roles: List[discord.role.Role]

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

tipe

List[Role]

await create_event(name, scheduled_start_time, *, description=..., privacy_level=..., entity_type=...)

This function is a coroutine.

Create a new guild event with this channel.

You must have the manage_events permission to create a guild event.

Catatan

Another extra permissions is required for different type of entity_type.

If your entity type is GuildScheduledEventType.stage_instance, you must have the following extra permissions:

If your entity type is GuildScheduledEventType.voice, you must have the following extra permissions:

  • view_channel for channel associated with the event.

  • connect for channel associated with the event.

If your entity type is GuildScheduledEventType.external, you dont need any extra permissions.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the event.

  • description (Optional[str]) -- The description of the event. Could be None for no description.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level, same thing as StageInstance PrivacyLevel

  • scheduled_start_time (datetime.datetime) -- The scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • entity_type (Optional[GuildScheduledEventType]) -- The entity_type or type for the event. If you don't provide this, it will automatically check from the channel type.

Menimbulkan

  • Forbidden -- You do not have permissions to create the guild event.

  • HTTPException -- Creating the guild event failed.

  • ValueError -- Validation error occurred.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

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.

Parameter

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

    Baru pada versi 2.0.

  • target_user (Optional[User]) --

    The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

    Baru pada versi 2.0.

  • target_application_id: --

    Optional[int]: The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Invite creation failed.

  • NotFound -- The channel that was passed is a category or an invalid channel.

Kembali

The invite that was created.

Tipe pengembalian

Invite

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameter

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

Menimbulkan

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

Parameter

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

Menimbulkan

  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The message asked for.

Tipe pengembalian

Message

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.

Menimbulkan

  • Forbidden -- You do not have proper permissions to get the information.

  • HTTPException -- An error occurred while fetching the information.

Kembali

The list of invites that are currently active.

Tipe pengembalian

List[Invite]

property mention: str

The string that allows you to mention the channel.

tipe

str

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have the manage_channels permission to do this.

Catatan

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

Baru pada versi 1.7.

Parameter

  • beginning (bool) -- Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

  • end (bool) -- Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

  • before (Snowflake) -- The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

  • after (Snowflake) -- The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

  • offset (int) -- The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

  • category (Optional[Snowflake]) -- The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

  • sync_permissions (bool) -- Whether to sync the permissions with the category (if given).

  • reason (str) -- The reason for the move.

Menimbulkan

  • InvalidArgument -- An invalid position was given or a bad mix of arguments were passed.

  • Forbidden -- You do not have permissions to move the channel.

  • HTTPException -- Moving the channel failed.

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

Returns all of the channel's overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Kembali

The channel's permission overwrites.

Tipe pengembalian

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameter

obj (Union[Role, User]) -- The role or user denoting whose overwrite to get.

Kembali

The permission overwrites for this object.

Tipe pengembalian

PermissionOverwrite

property permissions_synced: bool

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Baru pada versi 1.3.

tipe

bool

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Catatan

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

Menimbulkan

HTTPException -- Retrieving the pinned messages failed.

Kembali

The messages that are currently pinned.

Tipe pengembalian

List[Message]

await send(content=None, *, tts=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Parameter

  • 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 (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with 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.

    Baru pada versi 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.

    Baru pada versi 1.6.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    Baru pada versi 1.6.

  • view (discord.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.

    Baru pada versi 2.0.

  • stickers (Sequence[Union[GuildSticker, StickerItem]]) --

    A list of stickers to upload. Must be a maximum of 3.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The message that was sent.

Tipe pengembalian

Message

await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

The overwrite parameter, if given, must either be None or PermissionOverwrite. For convenience, you can pass in keyword arguments denoting Permissions attributes. If this is done, then you cannot mix the keyword arguments with the overwrite parameter.

If the overwrite parameter is None, then the permission overwrites are deleted.

You must have the manage_roles permission to use this.

Catatan

This method replaces the old overwrites with the ones given.

Contoh-contoh

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 = discord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)
Parameter

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

Menimbulkan

  • 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
Methods
class discord.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.

Baru pada versi 2.0.

name

The thread name.

tipe

str

guild

The guild the thread belongs to.

tipe

Guild

id

The thread ID.

tipe

int

parent_id

The parent TextChannel ID this thread belongs to.

tipe

int

owner_id

The user's ID that created this thread.

tipe

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.

tipe

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.

tipe

int

message_count

An approximate number of messages in this thread. This caps at 50.

tipe

int

member_count

An approximate number of members in this thread. This caps at 50.

tipe

int

me

A thread member representing yourself, if you've joined the thread. This could not be available.

tipe

Optional[ThreadMember]

archived

Whether the thread is archived.

tipe

bool

locked

Whether the thread is locked.

tipe

bool

invitable

Whether non-moderators can add other non-moderators to this thread. This is always True for public threads.

tipe

bool

archiver_id

The user's ID that archived this thread.

tipe

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.

tipe

int

archive_timestamp

An aware timestamp of when the thread's archived status was last updated in UTC.

tipe

datetime.datetime

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

Contoh-contoh

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

Hasil

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.

Catatan

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: discord.enums.ChannelType

The channel's Discord type.

tipe

ChannelType

property parent: Optional[TextChannel]

The parent channel this thread belongs to.

tipe

Optional[TextChannel]

property owner: Optional[Member]

The member this thread belongs to.

tipe

Optional[Member]

property mention: str

The string that allows you to mention the thread.

tipe

str

property members: List[discord.threads.ThreadMember]

A list of thread members in this thread.

This requires Intents.members to be properly filled. Most of the time however, this data is not provided by the gateway and a call to fetch_members() is needed.

tipe

List[ThreadMember]

property last_message: Optional[Message]

Fetches the last message from this channel in cache.

The message might not be valid or point to an existing message.

Reliable Fetching

For a slightly more reliable method of fetching the last message, consider using either history() or fetch_message() with the last_message_id attribute.

Kembali

The last message in this channel or None if not found.

Tipe pengembalian

Optional[Message]

property category: Optional[CategoryChannel]

The category channel the parent channel belongs to, if applicable.

Menimbulkan

ClientException -- The parent channel was not cached and returned None.

Kembali

The parent channel's category.

Tipe pengembalian

Optional[CategoryChannel]

property category_id: Optional[int]

The category channel ID the parent channel belongs to, if applicable.

Menimbulkan

ClientException -- The parent channel was not cached and returned None.

Kembali

The parent channel's category ID.

Tipe pengembalian

Optional[int]

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.

Parameter

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.

Menimbulkan

ClientException -- The parent channel was not cached and returned None

Kembali

The resolved permissions for the member or role.

Tipe pengembalian

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.

Parameter

messages (Iterable[abc.Snowflake]) -- An iterable of messages denoting which ones to bulk delete.

Menimbulkan

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

Contoh-contoh

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

  • Forbidden -- You do not have proper permissions to do the actions required.

  • HTTPException -- Purging the messages failed.

Kembali

The list of messages that were deleted.

Tipe pengembalian

List[Message]

await edit(*, name=..., archived=..., locked=..., invitable=..., slowmode_delay=..., auto_archive_duration=...)

This function is a coroutine.

Edits the thread.

Editing the thread requires Permissions.manage_threads. The thread creator can also edit name, archived or auto_archive_duration. Note that if the thread is locked then only those with Permissions.manage_threads can unarchive a thread.

The thread must be unarchived to be edited.

Parameter

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

Menimbulkan
Kembali

The newly edited thread.

Tipe pengembalian

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.

Menimbulkan
await leave()

This function is a coroutine.

Leaves this thread.

Menimbulkan

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.

Parameter

user (abc.Snowflake) -- The user to add to the thread.

Menimbulkan

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

Parameter

user (abc.Snowflake) -- The user to add to the thread.

Menimbulkan

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

Menimbulkan

HTTPException -- Retrieving the members failed.

Kembali

All thread members in the thread.

Tipe pengembalian

List[ThreadMember]

await delete()

This function is a coroutine.

Deletes this thread.

You must have manage_threads to delete threads.

Menimbulkan

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

Baru pada versi 2.0.

Parameter

message_id (int) -- The message ID to create a partial message for.

Kembali

The partial message.

Tipe pengembalian

PartialMessage

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameter

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

Menimbulkan

  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The message asked for.

Tipe pengembalian

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Catatan

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

Menimbulkan

HTTPException -- Retrieving the pinned messages failed.

Kembali

The messages that are currently pinned.

Tipe pengembalian

List[Message]

await send(content=None, *, tts=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Parameter

  • 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 (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with 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.

    Baru pada versi 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.

    Baru pada versi 1.6.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    Baru pada versi 1.6.

  • view (discord.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.

    Baru pada versi 2.0.

  • stickers (Sequence[Union[GuildSticker, StickerItem]]) --

    A list of stickers to upload. Must be a maximum of 3.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The message that was sent.

Tipe pengembalian

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

Baru pada versi 2.0.

id

The thread member's ID.

tipe

int

thread_id

The thread's ID.

tipe

int

joined_at

The time the member joined the thread in UTC.

tipe

datetime.datetime

property thread: discord.threads.Thread

The thread this member belongs to.

tipe

Thread

StoreChannel

Attributes
Methods
class discord.StoreChannel

Represents a Discord guild store channel.

x == y

Checks if two channels are equal.

x != y

Checks if two channels are not equal.

hash(x)

Returns the channel's hash.

str(x)

Returns the channel's name.

name

The channel name.

tipe

str

guild

The guild the channel belongs to.

tipe

Guild

id

The channel ID.

tipe

int

category_id

The category channel ID this channel belongs to.

tipe

int

position

The position in the channel list. This is a number that starts at 0. e.g. the top channel is position 0.

tipe

int

nsfw

If the channel is marked as "not safe for work".

Catatan

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

tipe

bool

property type: discord.enums.ChannelType

The channel's Discord type.

tipe

ChannelType

permissions_for(obj, /)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

  • Guild owner

  • Guild roles

  • Channel overrides

  • Member overrides

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

  • The default role permissions

  • The permissions of the role used as a parameter

  • The default role permission overwrites

  • The permission overwrites of the role used as a parameter

Berubah pada versi 2.0: The object passed in can now be a role object.

Parameter

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.

Kembali

The resolved permissions for the member or role.

Tipe pengembalian

Permissions

is_nsfw()

bool: Checks if the channel is NSFW.

await clone(*, name=None, reason=None)

This function is a coroutine.

Clones this channel. This creates a channel with the same properties as this channel.

You must have the manage_channels permission to do this.

Baru pada versi 1.1.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have the proper permissions to create this channel.

  • HTTPException -- Creating the channel failed.

Kembali

The channel that was created.

Tipe pengembalian

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.

Berubah pada versi 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameter

  • name (str) -- The new channel name.

  • position (int) -- The new channel's position.

  • nsfw (bool) -- To mark the channel as NSFW or not.

  • sync_permissions (bool) -- Whether to sync permissions with the channel's new or pre-existing category. Defaults to False.

  • category (Optional[CategoryChannel]) -- The new category for this channel. Can be None to remove the category.

  • reason (Optional[str]) -- The reason for editing this channel. Shows up on the audit log.

  • overwrites (Mapping) --

    A Mapping of target (either a role or a member) to PermissionOverwrite to apply to the channel.

    Baru pada versi 1.3.

Menimbulkan

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

Kembali

The newly edited store channel. If the edit was only positional then None is returned instead.

Tipe pengembalian

Optional[StoreChannel]

property category: Optional[CategoryChannel]

The category this channel belongs to.

If there is no category then this is None.

tipe

Optional[CategoryChannel]

property changed_roles: List[discord.role.Role]

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

tipe

List[Role]

await create_event(name, scheduled_start_time, *, description=..., privacy_level=..., entity_type=...)

This function is a coroutine.

Create a new guild event with this channel.

You must have the manage_events permission to create a guild event.

Catatan

Another extra permissions is required for different type of entity_type.

If your entity type is GuildScheduledEventType.stage_instance, you must have the following extra permissions:

If your entity type is GuildScheduledEventType.voice, you must have the following extra permissions:

  • view_channel for channel associated with the event.

  • connect for channel associated with the event.

If your entity type is GuildScheduledEventType.external, you dont need any extra permissions.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the event.

  • description (Optional[str]) -- The description of the event. Could be None for no description.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level, same thing as StageInstance PrivacyLevel

  • scheduled_start_time (datetime.datetime) -- The scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • entity_type (Optional[GuildScheduledEventType]) -- The entity_type or type for the event. If you don't provide this, it will automatically check from the channel type.

Menimbulkan

  • Forbidden -- You do not have permissions to create the guild event.

  • HTTPException -- Creating the guild event failed.

  • ValueError -- Validation error occurred.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

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.

Parameter

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

    Baru pada versi 2.0.

  • target_user (Optional[User]) --

    The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

    Baru pada versi 2.0.

  • target_application_id: --

    Optional[int]: The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Invite creation failed.

  • NotFound -- The channel that was passed is a category or an invalid channel.

Kembali

The invite that was created.

Tipe pengembalian

Invite

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameter

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

Menimbulkan

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

Menimbulkan

  • Forbidden -- You do not have proper permissions to get the information.

  • HTTPException -- An error occurred while fetching the information.

Kembali

The list of invites that are currently active.

Tipe pengembalian

List[Invite]

property mention: str

The string that allows you to mention the channel.

tipe

str

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have the manage_channels permission to do this.

Catatan

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

Baru pada versi 1.7.

Parameter

  • beginning (bool) -- Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

  • end (bool) -- Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

  • before (Snowflake) -- The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

  • after (Snowflake) -- The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

  • offset (int) -- The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

  • category (Optional[Snowflake]) -- The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

  • sync_permissions (bool) -- Whether to sync the permissions with the category (if given).

  • reason (str) -- The reason for the move.

Menimbulkan

  • InvalidArgument -- An invalid position was given or a bad mix of arguments were passed.

  • Forbidden -- You do not have permissions to move the channel.

  • HTTPException -- Moving the channel failed.

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

Returns all of the channel's overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Kembali

The channel's permission overwrites.

Tipe pengembalian

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameter

obj (Union[Role, User]) -- The role or user denoting whose overwrite to get.

Kembali

The permission overwrites for this object.

Tipe pengembalian

PermissionOverwrite

property permissions_synced: bool

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Baru pada versi 1.3.

tipe

bool

await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

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.

Catatan

This method replaces the old overwrites with the ones given.

Contoh-contoh

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 = discord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)
Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to edit channel specific permissions.

  • HTTPException -- Editing channel specific permissions failed.

  • NotFound -- The role or member being edited is not part of the guild.

  • InvalidArgument -- The overwrite parameter invalid or the target type was not Role or Member.

VoiceChannel

Attributes
Methods
class discord.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.

tipe

str

guild

The guild the channel belongs to.

tipe

Guild

id

The channel ID.

tipe

int

category_id

The category channel ID this channel belongs to, if applicable.

tipe

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.

tipe

int

bitrate

The channel's preferred audio bitrate in bits per second.

tipe

int

user_limit

The channel's limit for number of members that can be in a voice channel.

tipe

int

rtc_region

The region for the voice channel's voice communication. A value of None indicates automatic voice region detection.

Baru pada versi 1.7.

tipe

Optional[VoiceRegion]

video_quality_mode

The camera video quality for the voice channel's participants.

Baru pada versi 2.0.

tipe

VideoQualityMode

property type: discord.enums.ChannelType

The channel's Discord type.

tipe

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.

Baru pada versi 1.1.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have the proper permissions to create this channel.

  • HTTPException -- Creating the channel failed.

Kembali

The channel that was created.

Tipe pengembalian

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.

Berubah pada versi 1.3: The overwrites keyword-only parameter was added.

Berubah pada versi 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameter

  • name (str) -- The new channel's name.

  • bitrate (int) -- The new channel's bitrate.

  • user_limit (int) -- The new channel's user limit.

  • position (int) -- The new channel's position.

  • sync_permissions (bool) -- Whether to sync permissions with the channel's new or pre-existing category. Defaults to False.

  • category (Optional[CategoryChannel]) -- The new category for this channel. Can be None to remove the category.

  • reason (Optional[str]) -- The reason for editing this channel. Shows up on the audit log.

  • overwrites (Mapping) -- A Mapping of target (either a role or a member) to PermissionOverwrite to apply to the channel.

  • rtc_region (Optional[VoiceRegion]) --

    The new region for the voice channel's voice communication. A value of None indicates automatic voice region detection.

    Baru pada versi 1.7.

  • video_quality_mode (VideoQualityMode) --

    The camera video quality for the voice channel's participants.

    Baru pada versi 2.0.

Menimbulkan

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

Kembali

The newly edited voice channel. If the edit was only positional then None is returned instead.

Tipe pengembalian

Optional[VoiceChannel]

property category: Optional[CategoryChannel]

The category this channel belongs to.

If there is no category then this is None.

tipe

Optional[CategoryChannel]

property changed_roles: List[discord.role.Role]

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

tipe

List[Role]

await connect(*, timeout=60.0, reconnect=True, cls=<class 'discord.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.

Parameter

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

Menimbulkan
Kembali

A voice client that is fully connected to the voice server.

Tipe pengembalian

VoiceProtocol

await create_event(name, scheduled_start_time, *, description=..., privacy_level=..., entity_type=...)

This function is a coroutine.

Create a new guild event with this channel.

You must have the manage_events permission to create a guild event.

Catatan

Another extra permissions is required for different type of entity_type.

If your entity type is GuildScheduledEventType.stage_instance, you must have the following extra permissions:

If your entity type is GuildScheduledEventType.voice, you must have the following extra permissions:

  • view_channel for channel associated with the event.

  • connect for channel associated with the event.

If your entity type is GuildScheduledEventType.external, you dont need any extra permissions.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the event.

  • description (Optional[str]) -- The description of the event. Could be None for no description.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level, same thing as StageInstance PrivacyLevel

  • scheduled_start_time (datetime.datetime) -- The scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • entity_type (Optional[GuildScheduledEventType]) -- The entity_type or type for the event. If you don't provide this, it will automatically check from the channel type.

Menimbulkan

  • Forbidden -- You do not have permissions to create the guild event.

  • HTTPException -- Creating the guild event failed.

  • ValueError -- Validation error occurred.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

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.

Parameter

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

    Baru pada versi 2.0.

  • target_user (Optional[User]) --

    The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

    Baru pada versi 2.0.

  • target_application_id: --

    Optional[int]: The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Invite creation failed.

  • NotFound -- The channel that was passed is a category or an invalid channel.

Kembali

The invite that was created.

Tipe pengembalian

Invite

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameter

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

Menimbulkan

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

Menimbulkan

  • Forbidden -- You do not have proper permissions to get the information.

  • HTTPException -- An error occurred while fetching the information.

Kembali

The list of invites that are currently active.

Tipe pengembalian

List[Invite]

property members: List[Member]

Returns all members that are currently inside this voice channel.

tipe

List[Member]

property mention: str

The string that allows you to mention the channel.

tipe

str

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have the manage_channels permission to do this.

Catatan

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

Baru pada versi 1.7.

Parameter

  • beginning (bool) -- Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

  • end (bool) -- Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

  • before (Snowflake) -- The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

  • after (Snowflake) -- The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

  • offset (int) -- The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

  • category (Optional[Snowflake]) -- The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

  • sync_permissions (bool) -- Whether to sync the permissions with the category (if given).

  • reason (str) -- The reason for the move.

Menimbulkan

  • InvalidArgument -- An invalid position was given or a bad mix of arguments were passed.

  • Forbidden -- You do not have permissions to move the channel.

  • HTTPException -- Moving the channel failed.

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

Returns all of the channel's overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Kembali

The channel's permission overwrites.

Tipe pengembalian

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameter

obj (Union[Role, User]) -- The role or user denoting whose overwrite to get.

Kembali

The permission overwrites for this object.

Tipe pengembalian

PermissionOverwrite

permissions_for(obj, /)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

  • Guild owner

  • Guild roles

  • Channel overrides

  • Member overrides

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

  • The default role permissions

  • The permissions of the role used as a parameter

  • The default role permission overwrites

  • The permission overwrites of the role used as a parameter

Berubah pada versi 2.0: The object passed in can now be a role object.

Parameter

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.

Kembali

The resolved permissions for the member or role.

Tipe pengembalian

Permissions

property permissions_synced: bool

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Baru pada versi 1.3.

tipe

bool

await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

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.

Catatan

This method replaces the old overwrites with the ones given.

Contoh-contoh

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 = discord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)
Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to edit channel specific permissions.

  • HTTPException -- Editing channel specific permissions failed.

  • NotFound -- The role or member being edited is not part of the guild.

  • InvalidArgument -- The overwrite parameter invalid or the target type was not Role or Member.

property voice_states: Dict[int, VoiceState]

Returns a mapping of member IDs who have voice states in this channel.

Baru pada versi 1.3.

Catatan

This function is intentionally low level to replace members when the member cache is unavailable.

Kembali

The mapping of member ID to a voice state.

Tipe pengembalian

Mapping[int, VoiceState]

StageChannel

Attributes
Methods
class discord.StageChannel

Represents a Discord guild stage channel.

Baru pada versi 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.

tipe

str

guild

The guild the channel belongs to.

tipe

Guild

id

The channel ID.

tipe

int

topic

The channel's topic. None if it isn't set.

tipe

Optional[str]

category_id

The category channel ID this channel belongs to, if applicable.

tipe

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.

tipe

int

bitrate

The channel's preferred audio bitrate in bits per second.

tipe

int

user_limit

The channel's limit for number of members that can be in a stage channel.

tipe

int

rtc_region

The region for the stage channel's voice communication. A value of None indicates automatic voice region detection.

tipe

Optional[VoiceRegion]

video_quality_mode

The camera video quality for the stage channel's participants.

Baru pada versi 2.0.

tipe

VideoQualityMode

property requesting_to_speak: List[Member]

A list of members who are requesting to speak in the stage channel.

tipe

List[Member]

property speakers: List[Member]

A list of members who have been permitted to speak in the stage channel.

Baru pada versi 2.0.

tipe

List[Member]

property listeners: List[Member]

A list of members who are listening in the stage channel.

Baru pada versi 2.0.

tipe

List[Member]

property moderators: List[Member]

A list of members who are moderating the stage channel.

Baru pada versi 2.0.

tipe

List[Member]

property type: discord.enums.ChannelType

The channel's Discord type.

tipe

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.

Baru pada versi 1.1.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have the proper permissions to create this channel.

  • HTTPException -- Creating the channel failed.

Kembali

The channel that was created.

Tipe pengembalian

abc.GuildChannel

property instance: Optional[discord.stage_instance.StageInstance]

The running stage instance of the stage channel.

Baru pada versi 2.0.

tipe

Optional[StageInstance]

await create_instance(*, topic, privacy_level=..., reason=None)

This function is a coroutine.

Create a stage instance.

You must have the manage_channels permission to use this.

Baru pada versi 2.0.

Parameter
Menimbulkan

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

Kembali

The newly created stage instance.

Tipe pengembalian

StageInstance

await fetch_instance()

This function is a coroutine.

Gets the running StageInstance.

Baru pada versi 2.0.

Menimbulkan

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

  • HTTPException -- Getting the stage instance failed.

Kembali

The stage instance.

Tipe pengembalian

StageInstance

await edit(*, reason=None, **options)

This function is a coroutine.

Edits the channel.

You must have the manage_channels permission to use this.

Berubah pada versi 2.0: The topic parameter must now be set via create_instance.

Berubah pada versi 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameter

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

    Baru pada versi 2.0.

Menimbulkan

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

Kembali

The newly edited stage channel. If the edit was only positional then None is returned instead.

Tipe pengembalian

Optional[StageChannel]

property category: Optional[CategoryChannel]

The category this channel belongs to.

If there is no category then this is None.

tipe

Optional[CategoryChannel]

property changed_roles: List[discord.role.Role]

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

tipe

List[Role]

await connect(*, timeout=60.0, reconnect=True, cls=<class 'discord.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.

Parameter

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

Menimbulkan
Kembali

A voice client that is fully connected to the voice server.

Tipe pengembalian

VoiceProtocol

await create_event(name, scheduled_start_time, *, description=..., privacy_level=..., entity_type=...)

This function is a coroutine.

Create a new guild event with this channel.

You must have the manage_events permission to create a guild event.

Catatan

Another extra permissions is required for different type of entity_type.

If your entity type is GuildScheduledEventType.stage_instance, you must have the following extra permissions:

If your entity type is GuildScheduledEventType.voice, you must have the following extra permissions:

  • view_channel for channel associated with the event.

  • connect for channel associated with the event.

If your entity type is GuildScheduledEventType.external, you dont need any extra permissions.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the event.

  • description (Optional[str]) -- The description of the event. Could be None for no description.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level, same thing as StageInstance PrivacyLevel

  • scheduled_start_time (datetime.datetime) -- The scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • entity_type (Optional[GuildScheduledEventType]) -- The entity_type or type for the event. If you don't provide this, it will automatically check from the channel type.

Menimbulkan

  • Forbidden -- You do not have permissions to create the guild event.

  • HTTPException -- Creating the guild event failed.

  • ValueError -- Validation error occurred.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

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.

Parameter

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

    Baru pada versi 2.0.

  • target_user (Optional[User]) --

    The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

    Baru pada versi 2.0.

  • target_application_id: --

    Optional[int]: The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Invite creation failed.

  • NotFound -- The channel that was passed is a category or an invalid channel.

Kembali

The invite that was created.

Tipe pengembalian

Invite

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameter

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

Menimbulkan

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

Menimbulkan

  • Forbidden -- You do not have proper permissions to get the information.

  • HTTPException -- An error occurred while fetching the information.

Kembali

The list of invites that are currently active.

Tipe pengembalian

List[Invite]

property members: List[Member]

Returns all members that are currently inside this voice channel.

tipe

List[Member]

property mention: str

The string that allows you to mention the channel.

tipe

str

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have the manage_channels permission to do this.

Catatan

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

Baru pada versi 1.7.

Parameter

  • beginning (bool) -- Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

  • end (bool) -- Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

  • before (Snowflake) -- The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

  • after (Snowflake) -- The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

  • offset (int) -- The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

  • category (Optional[Snowflake]) -- The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

  • sync_permissions (bool) -- Whether to sync the permissions with the category (if given).

  • reason (str) -- The reason for the move.

Menimbulkan

  • InvalidArgument -- An invalid position was given or a bad mix of arguments were passed.

  • Forbidden -- You do not have permissions to move the channel.

  • HTTPException -- Moving the channel failed.

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

Returns all of the channel's overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Kembali

The channel's permission overwrites.

Tipe pengembalian

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameter

obj (Union[Role, User]) -- The role or user denoting whose overwrite to get.

Kembali

The permission overwrites for this object.

Tipe pengembalian

PermissionOverwrite

permissions_for(obj, /)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

  • Guild owner

  • Guild roles

  • Channel overrides

  • Member overrides

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

  • The default role permissions

  • The permissions of the role used as a parameter

  • The default role permission overwrites

  • The permission overwrites of the role used as a parameter

Berubah pada versi 2.0: The object passed in can now be a role object.

Parameter

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.

Kembali

The resolved permissions for the member or role.

Tipe pengembalian

Permissions

property permissions_synced: bool

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Baru pada versi 1.3.

tipe

bool

await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

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.

Catatan

This method replaces the old overwrites with the ones given.

Contoh-contoh

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 = discord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)
Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to edit channel specific permissions.

  • HTTPException -- Editing channel specific permissions failed.

  • NotFound -- The role or member being edited is not part of the guild.

  • InvalidArgument -- The overwrite parameter invalid or the target type was not Role or Member.

property voice_states: Dict[int, VoiceState]

Returns a mapping of member IDs who have voice states in this channel.

Baru pada versi 1.3.

Catatan

This function is intentionally low level to replace members when the member cache is unavailable.

Kembali

The mapping of member ID to a voice state.

Tipe pengembalian

Mapping[int, VoiceState]

StageInstance

Attributes
Methods
class discord.StageInstance

Represents a stage instance of a stage channel in a guild.

Baru pada versi 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.

tipe

int

guild

The guild that the stage instance is running in.

tipe

Guild

channel_id

The ID of the channel that the stage instance is running in.

tipe

int

topic

The topic of the stage instance.

tipe

str

privacy_level

The privacy level of the stage instance.

tipe

StagePrivacyLevel

discoverable_disabled

Whether discoverability for the stage instance is disabled.

tipe

bool

channel

The channel that stage instance is running in.

tipe

Optional[StageChannel]

await edit(*, topic=..., privacy_level=..., reason=None)

This function is a coroutine.

Edits the stage instance.

You must have the manage_channels permission to use this.

Parameter

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

Menimbulkan

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

Parameter

reason (str) -- The reason the stage instance was deleted. Shows up on the audit log.

Menimbulkan

  • Forbidden -- You do not have permissions to delete the stage instance.

  • HTTPException -- Deleting the stage instance failed.

CategoryChannel

Attributes
Methods
class discord.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.

tipe

str

guild

The guild the category belongs to.

tipe

Guild

id

The category channel ID.

tipe

int

position

The position in the category list. This is a number that starts at 0. e.g. the top category is position 0.

tipe

int

nsfw

If the channel is marked as "not safe for work".

Catatan

To check if the channel or the guild of that channel are marked as NSFW, consider is_nsfw() instead.

tipe

bool

property type: discord.enums.ChannelType

The channel's Discord type.

tipe

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.

Baru pada versi 1.1.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have the proper permissions to create this channel.

  • HTTPException -- Creating the channel failed.

Kembali

The channel that was created.

Tipe pengembalian

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.

Berubah pada versi 1.3: The overwrites keyword-only parameter was added.

Berubah pada versi 2.0: Edits are no longer in-place, the newly edited channel is returned instead.

Parameter

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

Menimbulkan

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

Kembali

The newly edited category channel. If the edit was only positional then None is returned instead.

Tipe pengembalian

Optional[CategoryChannel]

await move(**kwargs)

This function is a coroutine.

A rich interface to help move a channel relative to other channels.

If exact position movement is required, edit should be used instead.

You must have the manage_channels permission to do this.

Catatan

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

Baru pada versi 1.7.

Parameter

  • beginning (bool) -- Whether to move the channel to the beginning of the channel list (or category if given). This is mutually exclusive with end, before, and after.

  • end (bool) -- Whether to move the channel to the end of the channel list (or category if given). This is mutually exclusive with beginning, before, and after.

  • before (Snowflake) -- The channel that should be before our current channel. This is mutually exclusive with beginning, end, and after.

  • after (Snowflake) -- The channel that should be after our current channel. This is mutually exclusive with beginning, end, and before.

  • offset (int) -- The number of channels to offset the move by. For example, an offset of 2 with beginning=True would move it 2 after the beginning. A positive number moves it below while a negative number moves it above. Note that this number is relative and computed after the beginning, end, before, and after parameters.

  • category (Optional[Snowflake]) -- The category to move this channel under. If None is given then it moves it out of the category. This parameter is ignored if moving a category channel.

  • sync_permissions (bool) -- Whether to sync the permissions with the category (if given).

  • reason (str) -- The reason for the move.

Menimbulkan

  • InvalidArgument -- An invalid position was given or a bad mix of arguments were passed.

  • Forbidden -- You do not have permissions to move the channel.

  • HTTPException -- Moving the channel failed.

property channels: List[GuildChannelType]

Returns the channels that are under this category.

These are sorted by the official Discord UI, which places voice channels below the text channels.

tipe

List[abc.GuildChannel]

property text_channels: List[discord.channel.TextChannel]

Returns the text channels that are under this category.

tipe

List[TextChannel]

property voice_channels: List[discord.channel.VoiceChannel]

Returns the voice channels that are under this category.

tipe

List[VoiceChannel]

property stage_channels: List[discord.channel.StageChannel]

Returns the stage channels that are under this category.

Baru pada versi 1.7.

tipe

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.

Kembali

The channel that was just created.

Tipe pengembalian

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.

Kembali

The channel that was just created.

Tipe pengembalian

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.

Baru pada versi 1.7.

Kembali

The channel that was just created.

Tipe pengembalian

StageChannel

property category: Optional[CategoryChannel]

The category this channel belongs to.

If there is no category then this is None.

tipe

Optional[CategoryChannel]

property changed_roles: List[discord.role.Role]

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

tipe

List[Role]

await create_event(name, scheduled_start_time, *, description=..., privacy_level=..., entity_type=...)

This function is a coroutine.

Create a new guild event with this channel.

You must have the manage_events permission to create a guild event.

Catatan

Another extra permissions is required for different type of entity_type.

If your entity type is GuildScheduledEventType.stage_instance, you must have the following extra permissions:

If your entity type is GuildScheduledEventType.voice, you must have the following extra permissions:

  • view_channel for channel associated with the event.

  • connect for channel associated with the event.

If your entity type is GuildScheduledEventType.external, you dont need any extra permissions.

Baru pada versi 2.0.

Parameter

  • name (str) -- The name of the event.

  • description (Optional[str]) -- The description of the event. Could be None for no description.

  • privacy_level (Optional[GuildScheduledEventPrivacyLevel]) -- The event privacy level, same thing as StageInstance PrivacyLevel

  • scheduled_start_time (datetime.datetime) -- The scheduled start time, timezone must be UTC. If not it will be converted automatically.

  • entity_type (Optional[GuildScheduledEventType]) -- The entity_type or type for the event. If you don't provide this, it will automatically check from the channel type.

Menimbulkan

  • Forbidden -- You do not have permissions to create the guild event.

  • HTTPException -- Creating the guild event failed.

  • ValueError -- Validation error occurred.

Kembali

The newly updated guild event.

Tipe pengembalian

GuildScheduledEvent

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.

Parameter

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

    Baru pada versi 2.0.

  • target_user (Optional[User]) --

    The user whose stream to display for this invite, required if target_type is TargetType.stream. The user must be streaming in the channel.

    Baru pada versi 2.0.

  • target_application_id: --

    Optional[int]: The id of the embedded application for the invite, required if target_type is TargetType.embedded_application.

    Baru pada versi 2.0.

Menimbulkan

  • HTTPException -- Invite creation failed.

  • NotFound -- The channel that was passed is a category or an invalid channel.

Kembali

The invite that was created.

Tipe pengembalian

Invite

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

datetime.datetime

await delete(*, reason=None)

This function is a coroutine.

Deletes the channel.

You must have manage_channels permission to use this.

Parameter

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

Menimbulkan

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

Menimbulkan

  • Forbidden -- You do not have proper permissions to get the information.

  • HTTPException -- An error occurred while fetching the information.

Kembali

The list of invites that are currently active.

Tipe pengembalian

List[Invite]

property mention: str

The string that allows you to mention the channel.

tipe

str

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

Returns all of the channel's overwrites.

This is returned as a dictionary where the key contains the target which can be either a Role or a Member and the value is the overwrite as a PermissionOverwrite.

Kembali

The channel's permission overwrites.

Tipe pengembalian

Dict[Union[Role, Member], PermissionOverwrite]

overwrites_for(obj)

Returns the channel-specific overwrites for a member or a role.

Parameter

obj (Union[Role, User]) -- The role or user denoting whose overwrite to get.

Kembali

The permission overwrites for this object.

Tipe pengembalian

PermissionOverwrite

permissions_for(obj, /)

Handles permission resolution for the Member or Role.

This function takes into consideration the following cases:

  • Guild owner

  • Guild roles

  • Channel overrides

  • Member overrides

If a Role is passed, then it checks the permissions someone with that role would have, which is essentially:

  • The default role permissions

  • The permissions of the role used as a parameter

  • The default role permission overwrites

  • The permission overwrites of the role used as a parameter

Berubah pada versi 2.0: The object passed in can now be a role object.

Parameter

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.

Kembali

The resolved permissions for the member or role.

Tipe pengembalian

Permissions

property permissions_synced: bool

Whether or not the permissions for this channel are synced with the category it belongs to.

If there is no category then this is False.

Baru pada versi 1.3.

tipe

bool

await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)

This function is a coroutine.

Sets the channel specific permission overwrites for a target in the channel.

The target parameter should either be a Member or a Role that belongs to guild.

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.

Catatan

This method replaces the old overwrites with the ones given.

Contoh-contoh

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 = discord.PermissionOverwrite()
overwrite.send_messages = False
overwrite.read_messages = True
await channel.set_permissions(member, overwrite=overwrite)
Parameter

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

Menimbulkan

  • 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
Methods
class discord.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.

tipe

Optional[User]

me

The user presenting yourself.

tipe

ClientUser

id

The direct message channel ID.

tipe

int

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

Contoh-contoh

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

Hasil

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.

Catatan

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: discord.enums.ChannelType

The channel's Discord type.

tipe

ChannelType

property created_at: datetime.datetime

Returns the direct message channel's creation time in UTC.

tipe

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:

Parameter

obj (User) -- The user to check permissions for. This parameter is ignored but kept for compatibility with other permissions_for methods.

Kembali

The resolved permissions.

Tipe pengembalian

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.

Baru pada versi 1.6.

Parameter

message_id (int) -- The message ID to create a partial message for.

Kembali

The partial message.

Tipe pengembalian

PartialMessage

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameter

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

Menimbulkan

  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The message asked for.

Tipe pengembalian

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Catatan

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

Menimbulkan

HTTPException -- Retrieving the pinned messages failed.

Kembali

The messages that are currently pinned.

Tipe pengembalian

List[Message]

await send(content=None, *, tts=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Parameter

  • 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 (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with 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.

    Baru pada versi 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.

    Baru pada versi 1.6.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    Baru pada versi 1.6.

  • view (discord.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.

    Baru pada versi 2.0.

  • stickers (Sequence[Union[GuildSticker, StickerItem]]) --

    A list of stickers to upload. Must be a maximum of 3.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The message that was sent.

Tipe pengembalian

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
Methods
class discord.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.

tipe

List[User]

me

The user presenting yourself.

tipe

ClientUser

id

The group channel ID.

tipe

int

owner

The user that owns the group channel.

tipe

Optional[User]

owner_id

The owner ID that owns the group channel.

Baru pada versi 2.0.

tipe

int

name

The group channel's name if provided.

tipe

Optional[str]

async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)

Returns an AsyncIterator that enables receiving the destination's message history.

You must have read_message_history permissions to use this.

Contoh-contoh

Usage

counter = 0
async for message in channel.history(limit=200):
    if message.author == client.user:
        counter += 1

Flattening into a list:

messages = await channel.history(limit=123).flatten()
# messages is now a list of Message...

All parameters are optional.

Parameter

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

Menimbulkan

  • Forbidden -- You do not have permissions to get channel message history.

  • HTTPException -- The request to get message history failed.

Hasil

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.

Catatan

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: discord.enums.ChannelType

The channel's Discord type.

tipe

ChannelType

property icon: Optional[discord.asset.Asset]

Returns the channel's icon asset if available.

tipe

Optional[Asset]

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

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:

This also checks the kick_members permission if the user is the owner.

Parameter

obj (Snowflake) -- The user to check permissions for.

Kembali

The resolved permissions for the user.

Tipe pengembalian

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.

Menimbulkan

HTTPException -- Leaving the group failed.

await fetch_message(id, /)

This function is a coroutine.

Retrieves a single Message from the destination.

Parameter

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

Menimbulkan

  • NotFound -- The specified message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The message asked for.

Tipe pengembalian

Message

await pins()

This function is a coroutine.

Retrieves all messages that are currently pinned in the channel.

Catatan

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

Menimbulkan

HTTPException -- Retrieving the pinned messages failed.

Kembali

The messages that are currently pinned.

Tipe pengembalian

List[Message]

await send(content=None, *, tts=None, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None)

This function is a coroutine.

Sends a message to the destination with the content given.

The content must be a type that can convert to a string through str(content). If the content is set to None (the default), then the embed parameter must be provided.

To upload a single file, the file parameter should be used with a single File object. To upload multiple files, the files parameter should be used with a list of File objects. Specifying both parameters will lead to an exception.

To upload a single embed, the embed parameter should be used with a single Embed object. To upload multiple embeds, the embeds parameter should be used with a list of Embed objects. Specifying both parameters will lead to an exception.

Parameter

  • 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 (int) -- The nonce to use for sending this message. If the message was successfully sent, then the message will have a nonce with this value.

  • delete_after (float) -- If provided, the number of seconds to wait in the background before deleting the message we just sent. If the deletion fails, then it is silently ignored.

  • allowed_mentions (AllowedMentions) --

    Controls the mentions being processed in this message. If this is passed, then the object is merged with 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.

    Baru pada versi 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.

    Baru pada versi 1.6.

  • mention_author (Optional[bool]) --

    If set, overrides the replied_user attribute of allowed_mentions.

    Baru pada versi 1.6.

  • view (discord.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.

    Baru pada versi 2.0.

  • stickers (Sequence[Union[GuildSticker, StickerItem]]) --

    A list of stickers to upload. Must be a maximum of 3.

    Baru pada versi 2.0.

Menimbulkan
Kembali

The message that was sent.

Tipe pengembalian

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.

PartialInviteGuild

Attributes
class discord.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.

tipe

str

id

The partial guild's ID.

tipe

int

verification_level

The partial guild's verification level.

tipe

VerificationLevel

features

A list of features the guild has. See Guild.features for more information.

tipe

List[str]

description

The partial guild's description.

tipe

Optional[str]

property created_at: datetime.datetime

Returns the guild's creation time in UTC.

tipe

datetime.datetime

property icon: Optional[discord.asset.Asset]

Returns the guild's icon asset, if available.

tipe

Optional[Asset]

property banner: Optional[discord.asset.Asset]

Returns the guild's banner asset, if available.

tipe

Optional[Asset]

property splash: Optional[discord.asset.Asset]

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

tipe

Optional[Asset]

PartialInviteChannel

Attributes
class discord.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.

tipe

str

id

The partial channel's ID.

tipe

int

type

The partial channel's type.

tipe

ChannelType

property mention: str

The string that allows you to mention the channel.

tipe

str

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

datetime.datetime

Invite

Attributes
Methods
class discord.Invite

Represents a Discord Guild or abc.GuildChannel invite or a User 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

guild_scheduled_event

Client.fetch_invite() with guild_scheduled_event_id passed

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.

tipe

int

code

The URL fragment used for the invite.

tipe

str

guild

The guild the invite is for. Can be None if it's from a group direct message.

tipe

Optional[Union[Guild, Object, PartialInviteGuild]]

revoked

Indicates if the invite has been revoked.

tipe

bool

created_at

An aware UTC datetime object denoting the time the invite was created.

tipe

datetime.datetime

temporary

Indicates that the invite grants temporary membership. If True, members who joined via this invite will be kicked upon disconnect.

tipe

bool

uses

How many times the invite has been used.

tipe

int

max_uses

How many times the invite can be used. A value of 0 indicates that it has unlimited uses.

tipe

int

inviter

The user who created the invite.

tipe

Optional[User]

approximate_member_count

The approximate number of members in the guild.

tipe

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.

tipe

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.

Baru pada versi 2.0.

tipe

Optional[datetime.datetime]

channel

The channel the invite is for.

Berubah pada versi 2.0: The channel is now an optional attribute. If the invite is for a guild channel it will be filled in, but if it's a friend invite it will be empty.

tipe

Optional[Union[abc.GuildChannel, Object, PartialInviteChannel]]

target_type

The type of target for the voice channel invite.

Baru pada versi 2.0.

tipe

InviteTarget

target_user

The user whose stream to display for this invite, if any.

Baru pada versi 2.0.

tipe

Optional[User]

target_application

The embedded application the invite targets, if any.

Baru pada versi 2.0.

tipe

Optional[PartialAppInfo]

guild_scheduled_event

The guild scheduled event the invite targets, if any.

Baru pada versi 2.0.

tipe

Optional[GuildScheduledEvent]

property id: str

Returns the proper code portion of the invite.

tipe

str

property url: str

A property that retrieves the invite URL.

tipe

str

property friend_invite

Check if the Invite is friend invite.

Baru pada versi 2.0.

tipe

bool

await delete(*, reason=None)

This function is a coroutine.

Revokes the instant invite.

You must have the manage_channels permission to do this.

Parameter

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

Menimbulkan

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

  • NotFound -- The invite is invalid or expired.

  • HTTPException -- Revoking the invite failed.

Template

Attributes
Methods
class discord.Template

Represents a Discord template.

Baru pada versi 1.4.

code

The template code.

tipe

str

uses

How many times the template has been used.

tipe

int

name

The name of the template.

tipe

str

description

The description of the template.

tipe

str

creator

The creator of the template.

tipe

User

created_at

An aware datetime in UTC representing when the template was created.

tipe

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.

tipe

datetime.datetime

source_guild

The source guild.

tipe

Guild

is_dirty

Whether the template has unsynced changes.

Baru pada versi 2.0.

tipe

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.

Parameter
Menimbulkan
Kembali

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

Tipe pengembalian

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.

Baru pada versi 1.7.

Berubah pada versi 2.0: The template is no longer edited in-place, instead it is returned.

Menimbulkan

  • HTTPException -- Editing the template failed.

  • Forbidden -- You don't have permissions to edit the template.

  • NotFound -- This template does not exist.

Kembali

The newly edited template.

Tipe pengembalian

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.

Baru pada versi 1.7.

Berubah pada versi 2.0: The template is no longer edited in-place, instead it is returned.

Parameter

  • name (str) -- The template's new name.

  • description (Optional[str]) -- The template's new description.

Menimbulkan

  • HTTPException -- Editing the template failed.

  • Forbidden -- You don't have permissions to edit the template.

  • NotFound -- This template does not exist.

Kembali

The newly edited template.

Tipe pengembalian

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.

Baru pada versi 1.7.

Menimbulkan

  • HTTPException -- Editing the template failed.

  • Forbidden -- You don't have permissions to edit the template.

  • NotFound -- This template does not exist.

property url: str

The template url.

Baru pada versi 2.0.

tipe

str

WelcomeChannel

Attributes
class discord.WelcomeChannel

Represents a WelcomeScreen welcome channel.

Baru pada versi 2.0.

channel

The snowflake of the channel, this can be any channel.

tipe

abc.Snowflake

description

The description of the welcome channel.

tipe

str

emoji

The emoji of the welcome channel if exists.

tipe

Optional[Union[Emoji, PartialEmoji, str]]

WelcomeScreen

Attributes
Methods
class discord.WelcomeScreen

Represents a welcome screen for a Guild.

Baru pada versi 2.0.

guild

The guild the welcome screen belongs to.

tipe

Guild

description

The description of the welcome screen.

tipe

Optional[str]

channels

The list of welcome channels.

tipe

List[WelcomeChannel]

property enabled: bool

Returns if the welcome screen is enabled.

tipe

bool

await edit(*, enabled=..., channels=..., description=..., reason=None)

This function is a coroutine.

Edit the welcome screen of a guild.

You must have the manage_guild permission in the guild to do this.

Catatan

Welcome channels can only accept custom emojis if premium_tier is level 2 or above.

Parameter

  • enabled (bool) -- Should we enable the welcome screen of not.

  • channels (List[WelcomeChannel]) -- The channels to use for the welcome screen.

  • description (str) -- The description of the welcome screen.

  • reason (Optional[str]) -- The reason for editing the welcome screen. Shows up on the audit log.

Menimbulkan

WidgetChannel

Attributes
class discord.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.

tipe

int

name

The channel's name.

tipe

str

position

The channel's position

tipe

int

property mention: str

The string that allows you to mention the channel.

tipe

str

property created_at: datetime.datetime

Returns the channel's creation time in UTC.

tipe

datetime.datetime

WidgetMember

Attributes
Methods
class discord.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.

tipe

int

name

The member's username.

tipe

str

discriminator

The member's discriminator.

tipe

str

bot

Whether the member is a bot.

tipe

bool

status

The member's status.

tipe

Status

nick

The member's nickname.

tipe

Optional[str]

avatar

The member's avatar hash.

tipe

Optional[str]

activity

The member's activity.

tipe

Optional[Union[BaseActivity, Spotify]]

deafened

Whether the member is currently deafened.

tipe

Optional[bool]

muted

Whether the member is currently muted.

tipe

Optional[bool]

suppress

Whether the member is currently being suppressed.

tipe

Optional[bool]

connected_channel

Which channel the member is connected to.

tipe

Optional[WidgetChannel]

property display_name: str

Returns the member's display name.

tipe

str

property accent_color: Optional[discord.colour.Colour]

Returns the user's accent color, if applicable.

There is an alias for this named accent_colour.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Colour]

property accent_colour: Optional[discord.colour.Colour]

Returns the user's accent colour, if applicable.

There is an alias for this named accent_color.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Colour]

property banner: Optional[discord.asset.Asset]

Returns the user's banner asset, if available.

Baru pada versi 2.0.

Catatan

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

tipe

Optional[Asset]

property color: discord.colour.Colour

A property that returns a color denoting the rendered color for the user. This always returns Colour.default().

There is an alias for this named colour.

tipe

Colour

property colour: discord.colour.Colour

A property that returns a colour denoting the rendered colour for the user. This always returns Colour.default().

There is an alias for this named color.

tipe

Colour

property created_at: datetime

Returns the user's creation time in UTC.

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

tipe

datetime.datetime

property default_avatar: discord.asset.Asset

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

tipe

Asset

property display_avatar: discord.asset.Asset

Returns the user's display avatar.

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

Baru pada versi 2.0.

tipe

Asset

property mention: str

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

tipe

str

mentioned_in(message)

Checks if the user is mentioned in the specified message.

Parameter

message (Message) -- The message to check if you're mentioned in.

Kembali

Indicates if the user is mentioned in the message.

Tipe pengembalian

bool

property public_flags: discord.flags.PublicUserFlags

The publicly available flags the user has.

tipe

PublicUserFlags

Widget

Attributes
Methods
class discord.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.

tipe

int

name

The guild's name.

tipe

str

channels

The accessible voice channels in the guild.

tipe

List[WidgetChannel]

members

The online members in the server. Offline members do not appear in the widget.

Catatan

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.

tipe

List[Member]

property created_at: datetime.datetime

Returns the member's creation time in UTC.

tipe

datetime.datetime

property json_url: str

The JSON URL of the widget.

tipe

str

property invite_url: str

The invite URL for the guild, if available.

tipe

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.

Parameter

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

Kembali

The invite from the widget's invite URL.

Tipe pengembalian

Invite

StickerPack

Attributes
class discord.StickerPack

Represents a sticker pack.

Baru pada versi 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.

tipe

str

description

The description of the sticker pack.

tipe

str

id

The id of the sticker pack.

tipe

int

stickers

The stickers of this sticker pack.

tipe

List[StandardSticker]

sku_id

The SKU ID of the sticker pack.

tipe

int

cover_sticker_id

The ID of the sticker used for the cover of the sticker pack.

tipe

int

cover_sticker

The sticker used for the cover of the sticker pack.

tipe

StandardSticker

property banner: discord.asset.Asset

The banner asset of the sticker pack.

tipe

Asset

StickerItem

Attributes
Methods
class discord.StickerItem

Represents a sticker item.

Baru pada versi 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.

tipe

str

id

The id of the sticker.

tipe

int

format

The format for the sticker's image.

tipe

StickerFormatType

url

The URL for the sticker's image.

tipe

str

await fetch()

This function is a coroutine.

Attempts to retrieve the full sticker data of the sticker item.

Menimbulkan

HTTPException -- Retrieving the sticker failed.

Kembali

The retrieved sticker.

Tipe pengembalian

Union[StandardSticker, GuildSticker]

Sticker

Attributes
class discord.Sticker

Represents a sticker.

Baru pada versi 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.

tipe

str

id

The id of the sticker.

tipe

int

description

The description of the sticker.

tipe

str

pack_id

The id of the sticker's pack.

tipe

int

format

The format for the sticker's image.

tipe

StickerFormatType

url

The URL for the sticker's image.

tipe

str

property created_at: datetime.datetime

Returns the sticker's creation time in UTC.

tipe

datetime.datetime

StandardSticker

Attributes
Methods
class discord.StandardSticker

Represents a sticker that is found in a standard sticker pack.

Baru pada versi 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.

tipe

str

id

The id of the sticker.

tipe

int

description

The description of the sticker.

tipe

str

pack_id

The id of the sticker's pack.

tipe

int

format

The format for the sticker's image.

tipe

StickerFormatType

tags

A list of tags for the sticker.

tipe

List[str]

sort_value

The sticker's sort order within its pack.

tipe

int

await pack()

This function is a coroutine.

Retrieves the sticker pack that this sticker belongs to.

Menimbulkan
Kembali

The retrieved sticker pack.

Tipe pengembalian

StickerPack

GuildSticker

Attributes
Methods
class discord.GuildSticker

Represents a sticker that belongs to a guild.

Baru pada versi 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.

tipe

str

id

The id of the sticker.

tipe

int

description

The description of the sticker.

tipe

str

format

The format for the sticker's image.

tipe

StickerFormatType

available

Whether this sticker is available for use.

tipe

bool

guild_id

The ID of the guild that this sticker is from.

tipe

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.

tipe

Optional[User]

emoji

The name of a unicode emoji that represents this sticker.

tipe

str

guild

The guild that this sticker is from. Could be None if the bot is not in the guild.

Baru pada versi 2.0.

tipe

Optional[Guild]

await edit(*, name=..., description=..., emoji=..., reason=None)

This function is a coroutine.

Edits a GuildSticker for the guild.

Parameter

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

Menimbulkan
Kembali

The newly modified sticker.

Tipe pengembalian

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.

Parameter

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

Menimbulkan

  • Forbidden -- You are not allowed to delete stickers.

  • HTTPException -- An error occurred deleting the sticker.

RawMessageDeleteEvent

Attributes
class discord.RawMessageDeleteEvent

Represents the event payload for a on_raw_message_delete() event.

channel_id

The channel ID where the deletion took place.

tipe

int

guild_id

The guild ID where the deletion took place, if applicable.

tipe

Optional[int]

message_id

The message ID that got deleted.

tipe

int

cached_message

The cached message, if found in the internal message cache.

tipe

Optional[Message]

RawBulkMessageDeleteEvent

Attributes
class discord.RawBulkMessageDeleteEvent

Represents the event payload for a on_raw_bulk_message_delete() event.

message_ids

A set of the message IDs that were deleted.

tipe

Set[int]

channel_id

The channel ID where the message got deleted.

tipe

int

guild_id

The guild ID where the message got deleted, if applicable.

tipe

Optional[int]

cached_messages

The cached messages, if found in the internal message cache.

tipe

List[Message]

RawMessageUpdateEvent

Attributes
class discord.RawMessageUpdateEvent

Represents the payload for a on_raw_message_edit() event.

message_id

The message ID that got updated.

tipe

int

channel_id

The channel ID where the update took place.

Baru pada versi 1.3.

tipe

int

guild_id

The guild ID where the message got updated, if applicable.

Baru pada versi 1.7.

tipe

Optional[int]

data

The raw data given by the gateway

tipe

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.

tipe

Optional[Message]

RawReactionActionEvent

Attributes
class discord.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.

tipe

int

user_id

The user ID who added the reaction or whose reaction was removed.

tipe

int

channel_id

The channel ID where the reaction got added or removed.

tipe

int

guild_id

The guild ID where the reaction got added or removed, if applicable.

tipe

Optional[int]

emoji

The custom or unicode emoji being used.

tipe

PartialEmoji

member

The member who added the reaction. Only available if event_type is REACTION_ADD and the reaction is inside a guild.

Baru pada versi 1.3.

tipe

Optional[Member]

event_type

The event type that triggered this action. Can be REACTION_ADD for reaction addition or REACTION_REMOVE for reaction removal.

Baru pada versi 1.3.

tipe

str

RawReactionClearEvent

Attributes
class discord.RawReactionClearEvent

Represents the payload for a on_raw_reaction_clear() event.

message_id

The message ID that got its reactions cleared.

tipe

int

channel_id

The channel ID where the reactions got cleared.

tipe

int

guild_id

The guild ID where the reactions got cleared.

tipe

Optional[int]

RawReactionClearEmojiEvent

Attributes
class discord.RawReactionClearEmojiEvent

Represents the payload for a on_raw_reaction_clear_emoji() event.

Baru pada versi 1.3.

message_id

The message ID that got its reactions cleared.

tipe

int

channel_id

The channel ID where the reactions got cleared.

tipe

int

guild_id

The guild ID where the reactions got cleared.

tipe

Optional[int]

emoji

The custom or unicode emoji being removed.

tipe

PartialEmoji

RawIntegrationDeleteEvent

Attributes
class discord.RawIntegrationDeleteEvent

Represents the payload for a on_raw_integration_delete() event.

Baru pada versi 2.0.

integration_id

The ID of the integration that got deleted.

tipe

int

application_id

The ID of the bot/OAuth2 application for this deleted integration.

tipe

Optional[int]

guild_id

The guild ID where the integration got deleted.

tipe

int

RawThreadDeleteEvent

Attributes
class discord.RawThreadDeleteEvent

Represents the payload for a on_raw_thread_delete() event.

Baru pada versi 2.0.

thread_id

The ID of the thread that got deleted.

tipe

int

thread_type

The channel type of the deleted thread.

tipe

ChannelType

guild_id

The ID of the guild the thread was deleted in.

tipe

int

parent_id

The ID of the channel the thread belonged to.

tipe

int

thread

The thread, if it could be found in the internal cache.

tipe

Optional[Thread]

PartialWebhookGuild

Attributes
class discord.PartialWebhookGuild

Represents a partial guild for webhooks.

These are typically given for channel follower webhooks.

Baru pada versi 2.0.

id

The partial guild's ID.

tipe

int

name

The partial guild's name.

tipe

str

property icon: Optional[discord.asset.Asset]

Returns the guild's icon asset, if available.

tipe

Optional[Asset]

PartialWebhookChannel

Attributes
class discord.PartialWebhookChannel

Represents a partial channel for webhooks.

These are typically given for channel follower webhooks.

Baru pada versi 2.0.

id

The partial channel's ID.

tipe

int

name

The partial channel's name.

tipe

str

Data Classes

Some classes are just there to be data containers, this lists them.

Unlike models you are allowed to create most of these yourself, even if they can also be used to hold attributes.

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

The only exception to this rule is Object, which is made with dynamic attributes in mind.

Object

Attributes
class discord.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.

tipe

int

property created_at: datetime.datetime

Returns the snowflake's creation time in UTC.

tipe

datetime.datetime

Embed

Attributes
Methods
class discord.Embed(*, colour=Embed.Empty, color=Embed.Empty, title=Embed.Empty, type='rich', url=Embed.Empty, description=Embed.Empty, timestamp=None)

Represents a Discord embed.

len(x)

Returns the total size of the embed. Useful for checking if it's within the 6000 character limit.

bool(b)

Returns whether the embed has any data set.

Baru pada versi 2.0.

Certain properties return an EmbedProxy, a type that acts similar to a regular dict except using dotted access, e.g. embed.author.icon_url. If the attribute is invalid or empty, then a special sentinel value is returned, Embed.Empty.

For ease of use, all parameters that expect a str are implicitly casted to str for you.

title

The title of the embed. This can be set during initialisation.

tipe

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

tipe

str

description

The description of the embed. This can be set during initialisation.

tipe

str

url

The URL of the embed. This can be set during initialisation.

tipe

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.

tipe

datetime.datetime

colour

The colour code of the embed. Aliased to color as well. This can be set during initialisation.

tipe

Union[Colour, int]

Empty

A special sentinel value used by EmbedProxy and this class to denote that the value or attribute is empty.

tipe

Final

classmethod from_dict(data)

Converts a dict to a Embed provided it is in the format that Discord expects it to be in.

You can find out about this format in the official Discord documentation.

Parameter

data (dict) -- The dictionary to convert into an embed.

copy()

Returns a shallow copy of the embed.

property footer: _EmbedFooterProxy

Returns an EmbedProxy denoting the footer contents.

See set_footer() for possible values you can access.

If the attribute has no value then Empty is returned.

Sets the footer for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Parameter

  • text (str) -- The footer text.

  • icon_url (str) -- The URL of the footer icon. Only HTTP(S) is supported.

Clears embed's footer information.

This function returns the class instance to allow for fluent-style chaining.

Baru pada versi 2.0.

property image: _EmbedMediaProxy

Returns an EmbedProxy denoting the image contents.

Possible attributes you can access are:

  • url

  • proxy_url

  • width

  • height

If the attribute has no value then Empty is returned.

set_image(*, url)

Sets the image for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Berubah pada versi 1.4: Passing Empty removes the image.

Parameter

url (str) -- The source URL for the image. Only HTTP(S) is supported.

property thumbnail: _EmbedMediaProxy

Returns an EmbedProxy denoting the thumbnail contents.

Possible attributes you can access are:

  • url

  • proxy_url

  • width

  • height

If the attribute has no value then Empty is returned.

set_thumbnail(*, url)

Sets the thumbnail for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Berubah pada versi 1.4: Passing Empty removes the thumbnail.

Parameter

url (str) -- The source URL for the thumbnail. Only HTTP(S) is supported.

property video: _EmbedVideoProxy

Returns an EmbedProxy denoting the video contents.

Possible attributes include:

  • url for the video URL.

  • height for the video height.

  • width for the video width.

If the attribute has no value then Empty is returned.

property provider: _EmbedProviderProxy

Returns an EmbedProxy denoting the provider contents.

The only attributes that might be accessed are name and url.

If the attribute has no value then Empty is returned.

property author: _EmbedAuthorProxy

Returns an EmbedProxy denoting the author contents.

See set_author() for possible values you can access.

If the attribute has no value then Empty is returned.

set_author(*, name, url=Embed.Empty, icon_url=Embed.Empty)

Sets the author for the embed content.

This function returns the class instance to allow for fluent-style chaining.

Parameter

  • name (str) -- The name of the author.

  • url (str) -- The URL for the author.

  • icon_url (str) -- The URL of the author icon. Only HTTP(S) is supported.

remove_author()

Clears embed's author information.

This function returns the class instance to allow for fluent-style chaining.

Baru pada versi 1.4.

property fields: List[_EmbedFieldProxy]

Returns a list of EmbedProxy denoting the field contents.

See add_field() for possible values you can access.

If the attribute has no value then Empty is returned.

tipe

List[Union[EmbedProxy, Empty]]

add_field(*, name, value, inline=True)

Adds a field to the embed object.

This function returns the class instance to allow for fluent-style chaining.

Parameter

  • name (str) -- The name of the field.

  • value (str) -- The value of the field.

  • inline (bool) -- Whether the field should be displayed inline.

insert_field_at(index, *, name, value, inline=True)

Inserts a field before a specified index to the embed.

This function returns the class instance to allow for fluent-style chaining.

Baru pada versi 1.2.

Parameter

  • index (int) -- The index of where to insert the field.

  • name (str) -- The name of the field.

  • value (str) -- The value of the field.

  • inline (bool) -- Whether the field should be displayed inline.

clear_fields()

Removes all fields from this embed.

remove_field(index)

Removes a field at a specified index.

If the index is invalid or out of bounds then the error is silently swallowed.

Catatan

When deleting a field by index, the index of the other fields shift to fill the gap just like a regular list.

Parameter

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.

Parameter

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

Menimbulkan

IndexError -- An invalid index was provided.

to_dict()

Converts this embed object into a dict.

AllowedMentions

Attributes
Methods
class discord.AllowedMentions(*, everyone=True, users=True, roles=True, replied_user=True)

A class that represents what mentions are allowed in a message.

This class can be set during Client initialisation to apply to every message sent. It can also be applied on a per message basis via abc.Messageable.send() for more fine-grained control.

everyone

Whether to allow everyone and here mentions. Defaults to True.

tipe

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.

tipe

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.

tipe

Union[bool, List[abc.Snowflake]]

replied_user

Whether to mention the author of the message being replied to. Defaults to True.

Baru pada versi 1.6.

tipe

bool

classmethod all()

A factory method that returns a AllowedMentions with all fields explicitly set to True

Baru pada versi 1.5.

classmethod none()

A factory method that returns a AllowedMentions with all fields set to False

Baru pada versi 1.5.

MessageReference

Attributes
Methods
class discord.MessageReference(*, message_id, channel_id, guild_id=None, fail_if_not_exists=True)

Represents a reference to a Message.

Baru pada versi 1.5.

Berubah pada versi 1.6: This class can now be constructed by users.

message_id

The id of the message referenced.

tipe

Optional[int]

channel_id

The channel id of the message referenced.

tipe

int

guild_id

The guild id of the message referenced.

tipe

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.

Baru pada versi 1.7.

tipe

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.

Baru pada versi 1.6.

tipe

Optional[Union[Message, DeletedReferencedMessage]]

classmethod from_message(message, *, fail_if_not_exists=True)

Creates a MessageReference from an existing Message.

Baru pada versi 1.6.

Parameter

  • message (Message) -- The message to be converted into a reference.

  • fail_if_not_exists (bool) --

    Whether replying to the referenced message should raise HTTPException if the message no longer exists or Discord could not fetch the message.

    Baru pada versi 1.7.

Kembali

A reference to the message.

Tipe pengembalian

MessageReference

property cached_message: Optional[discord.message.Message]

The cached message, if found in the internal message cache.

tipe

Optional[Message]

property jump_url: str

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

Baru pada versi 1.7.

tipe

str

PartialMessage

Attributes
Methods
class discord.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:

Note that this class is trimmed down and has no rich attributes.

Baru pada versi 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.

tipe

Union[TextChannel, Thread, DMChannel]

id

The message ID.

tipe

int

property jump_url: str

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

tipe

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.

Berubah pada versi 1.1: Added the new delay keyword-only parameter.

Parameter

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.

Menimbulkan

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

Menimbulkan

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

Parameter

reason (Optional[str]) --

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

Baru pada versi 1.4.

Menimbulkan

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

Parameter

reason (Optional[str]) --

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

Baru pada versi 1.4.

Menimbulkan

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

Parameter

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

Menimbulkan

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

Parameter
Menimbulkan

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

Baru pada versi 1.3.

Parameter

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

Menimbulkan

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

Menimbulkan

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

Baru pada versi 1.6.

Menimbulkan

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

Kembali

The message that was sent.

Tipe pengembalian

Message

to_reference(*, fail_if_not_exists=True)

Creates a MessageReference from the current message.

Baru pada versi 1.6.

Parameter

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.

Baru pada versi 1.7.

Kembali

The reference to this message.

Tipe pengembalian

MessageReference

property created_at: datetime.datetime

The partial message's creation time in UTC.

tipe

datetime.datetime

guild

The guild that the partial message belongs to, if applicable.

tipe

Optional[Guild]

await fetch()

This function is a coroutine.

Fetches the partial message to a full Message.

Menimbulkan

  • NotFound -- The message was not found.

  • Forbidden -- You do not have the permissions required to get a message.

  • HTTPException -- Retrieving the message failed.

Kembali

The full message.

Tipe pengembalian

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

Berubah pada versi 1.7: discord.Message is returned instead of None if an edit took place.

Parameter

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

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

    Baru pada versi 2.0.

Menimbulkan

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

Kembali

The message that was edited.

Tipe pengembalian

Optional[Message]

SelectOption

Attributes
class discord.SelectOption(*, label, value=..., description=None, emoji=None, default=False)

Represents a select menu's option.

These can be created by users.

Baru pada versi 2.0.

label

The label of the option. This is displayed to users. Can only be up to 100 characters.

tipe

str

value

The value of the option. This is not displayed to users. If not provided when constructed then it defaults to the label. Can only be up to 100 characters.

tipe

str

description

An additional description of the option, if any. Can only be up to 100 characters.

tipe

Optional[str]

emoji

The emoji of the option, if available.

tipe

Optional[Union[str, Emoji, PartialEmoji]]

default

Whether this option is selected by default.

tipe

bool

Intents

Attributes
Methods
class discord.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.

Baru pada versi 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.

tipe

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

guilds

Whether guild related events are enabled.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

It is highly advisable to leave this intent enabled for your bot to function.

tipe

bool

members

Whether guild member related events are enabled.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

For more information go to the member intent documentation.

Catatan

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.

tipe

bool

bans

Whether guild ban related events are enabled.

This corresponds to the following events:

This does not correspond to any attributes or classes in the library in terms of cache.

tipe

bool

emojis

Alias of emojis_and_stickers.

Berubah pada versi 2.0: Changed to an alias.

tipe

bool

emojis_and_stickers

Whether guild emoji and sticker related events are enabled.

Baru pada versi 2.0.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

tipe

bool

integrations

Whether guild integration related events are enabled.

This corresponds to the following events:

This does not correspond to any attributes or classes in the library in terms of cache.

tipe

bool

webhooks

Whether guild webhook related events are enabled.

This corresponds to the following events:

This does not correspond to any attributes or classes in the library in terms of cache.

tipe

bool

invites

Whether guild invite related events are enabled.

This corresponds to the following events:

This does not correspond to any attributes or classes in the library in terms of cache.

tipe

bool

voice_states

Whether guild voice state related events are enabled.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Catatan

This intent is required to connect to voice.

tipe

bool

presences

Whether guild presence related events are enabled.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

For more information go to the presence intent documentation.

Catatan

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.

tipe

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:

This also corresponds to the following attributes and classes in terms of cache:

Note that due to an implicit relationship this also corresponds to the following events:

tipe

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:

This also corresponds to the following attributes and classes in terms of cache:

Note that due to an implicit relationship this also corresponds to the following events:

tipe

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:

This also corresponds to the following attributes and classes in terms of cache:

Note that due to an implicit relationship this also corresponds to the following events:

tipe

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:

This also corresponds to the following attributes and classes in terms of cache:

tipe

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:

This also corresponds to the following attributes and classes in terms of cache:

tipe

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:

This also corresponds to the following attributes and classes in terms of cache:

tipe

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:

This does not correspond to any attributes or classes in the library in terms of cache.

tipe

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:

This does not correspond to any attributes or classes in the library in terms of cache.

tipe

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:

This does not correspond to any attributes or classes in the library in terms of cache.

tipe

bool

guild_scheduled_events

Whether guild scheduled events related events are enabled.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

tipe

bool

MemberCacheFlags

Attributes
Methods
class discord.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.

Baru pada versi 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.

tipe

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.

tipe

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.

tipe

bool

classmethod from_intents(intents)

A factory method that creates a MemberCacheFlags based on the currently selected Intents.

Parameter

intents (Intents) -- The intents to select from.

Kembali

The resulting member cache flags.

Tipe pengembalian

MemberCacheFlags

ApplicationFlags

Attributes
class discord.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.

Baru pada versi 2.0.

value

The raw value. You should query flags via the properties rather than using this raw value.

tipe

int

gateway_presence

Returns True if the application is verified and is allowed to receive presence information over the gateway.

tipe

bool

gateway_presence_limited

Returns True if the application is allowed to receive limited presence information over the gateway.

tipe

bool

gateway_guild_members

Returns True if the application is verified and is allowed to receive guild members information over the gateway.

tipe

bool

gateway_guild_members_limited

Returns True if the application is allowed to receive limited guild members information over the gateway.

tipe

bool

verification_pending_guild_limit

Returns True if the application is currently pending verification and has hit the guild limit.

tipe

bool

embedded

Returns True if the application is embedded within the Discord client.

tipe

bool

File

Attributes
class discord.File(fp, filename=None, description=None, *, spoiler=False)

A parameter object used for abc.Messageable.send() for sending file objects.

Catatan

File objects are single use and are not meant to be reused in multiple abc.Messageable.send()s.

fp

A file-like object opened in binary mode and read mode or a filename representing a file in the hard drive to open.

Catatan

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.

tipe

Union[os.PathLike, io.BufferedIOBase]

filename

The filename to display when uploading to Discord. If this is not given then it defaults to fp.name or if fp is a string then the filename will default to the string given.

tipe

Optional[str]

description

The description for the file, it will be used when attaching the file.

Baru pada versi 2.0.

tipe

Optional[str]

spoiler

Whether the attachment is a spoiler.

tipe

bool

Colour

Attributes
Methods
class discord.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.

tipe

int

property r: int

Returns the red component of the colour.

tipe

int

property g: int

Returns the green component of the colour.

tipe

int

property b: int

Returns the blue component of the colour.

tipe

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.

Catatan

The random algorithm works by choosing a colour with a random hue but with maxed out saturation and value.

Baru pada versi 1.6.

Parameter

seed (Optional[Union[int, str, float, bytes, bytearray]]) --

The seed to initialize the RNG with. If None is passed the default RNG is used.

Baru pada versi 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.

Baru pada versi 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.

Baru pada versi 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 0x36393F. This will appear transparent on Discord's dark theme.

Baru pada versi 1.5.

classmethod fuchsia()

A factory method that returns a Colour with a value of 0xEB459E.

Baru pada versi 2.0.

classmethod yellow()

A factory method that returns a Colour with a value of 0xFEE75C.

Baru pada versi 2.0.

BaseActivity

Attributes
class discord.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:

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.

Baru pada versi 1.3.

property created_at: Optional[datetime.datetime]

When the user started doing this activity in UTC.

Baru pada versi 1.3.

tipe

Optional[datetime.datetime]

Activity

Attributes
class discord.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:

application_id

The application ID of the game.

tipe

Optional[int]

name

The name of the activity.

tipe

Optional[str]

url

A stream URL that the activity could be doing.

tipe

Optional[str]

type

The type of activity currently being done.

tipe

ActivityType

state

The user's current state. For example, "In Game".

tipe

Optional[str]

details

The detail of the user's current activity.

tipe

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.

tipe

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.

tipe

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

tipe

dict

buttons

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

Baru pada versi 2.0.

tipe

List[dict]

emoji

The emoji that belongs to this activity.

tipe

Optional[PartialEmoji]

property start: Optional[datetime.datetime]

When the user started doing this activity in UTC, if applicable.

tipe

Optional[datetime.datetime]

property end: Optional[datetime.datetime]

When the user will stop doing this activity in UTC, if applicable.

tipe

Optional[datetime.datetime]

property large_image_url: Optional[str]

Returns a URL pointing to the large image asset of this activity if applicable.

tipe

Optional[str]

property small_image_url: Optional[str]

Returns a URL pointing to the small image asset of this activity if applicable.

tipe

Optional[str]

property large_image_text: Optional[str]

Returns the large image asset hover text of this activity if applicable.

tipe

Optional[str]

property small_image_text: Optional[str]

Returns the small image asset hover text of this activity if applicable.

tipe

Optional[str]

Game

Attributes
class discord.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.

Parameter

name (str) -- The game's name.

name

The game's name.

tipe

str

property type: discord.enums.ActivityType

Returns the game's type. This is for compatibility with Activity.

It always returns ActivityType.playing.

tipe

ActivityType

property start: Optional[datetime.datetime]

When the user started playing this game in UTC, if applicable.

tipe

Optional[datetime.datetime]

property end: Optional[datetime.datetime]

When the user will stop playing this game in UTC, if applicable.

tipe

Optional[datetime.datetime]

Streaming

Attributes
class discord.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).

Baru pada versi 1.3.

tipe

Optional[str]

name

The stream's name.

tipe

Optional[str]

details

An alias for name

tipe

Optional[str]

game

The game being streamed.

Baru pada versi 1.3.

tipe

Optional[str]

url

The stream's URL.

tipe

str

assets

A dictionary comprising of similar keys than those in Activity.assets.

tipe

dict

property type: discord.enums.ActivityType

Returns the game's type. This is for compatibility with Activity.

It always returns ActivityType.streaming.

tipe

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.

tipe

Optional[str]

CustomActivity

Attributes
class discord.CustomActivity(name, *, 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.

Baru pada versi 1.3.

name

The custom activity's name.

tipe

Optional[str]

emoji

The emoji to pass to the activity, if any.

tipe

Optional[PartialEmoji]

property type: discord.enums.ActivityType

Returns the activity's type. This is for compatibility with Activity.

It always returns ActivityType.custom.

tipe

ActivityType

Permissions

Attributes
Methods
class discord.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.

Berubah pada versi 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.

tipe

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:

Berubah pada versi 1.7: Added stream, priority_speaker and use_slash_commands permissions.

Berubah pada versi 2.0: Added create_public_threads, create_private_threads, manage_threads, use_external_stickers, send_messages_in_threads and request_to_speak permissions.

classmethod general()

A factory method that creates a Permissions with all "General" permissions from the official Discord UI set to True.

Berubah pada versi 1.7: Permission read_messages is now included in the general permissions, but permissions administrator, create_instant_invite, kick_members, ban_members, change_nickname and manage_nicknames are no longer part of the general permissions.

classmethod membership()

A factory method that creates a Permissions with all "Membership" permissions from the official Discord UI set to True.

Baru pada versi 1.7.

classmethod text()

A factory method that creates a Permissions with all "Text" permissions from the official Discord UI set to True.

Berubah pada versi 1.7: Permission read_messages is no longer part of the text permissions. Added use_slash_commands permission.

Berubah pada versi 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.

Baru pada versi 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.

Baru pada versi 1.7.

classmethod advanced()

A factory method that creates a Permissions with all "Advanced" permissions from the official Discord UI set to True.

Baru pada versi 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.

Parameter

**kwargs -- A list of key/value pairs to bulk update permissions with.

create_instant_invite

Returns True if the user can create instant invites.

tipe

bool

kick_members

Returns True if the user can kick users from the guild.

tipe

bool

ban_members

Returns True if a user can ban users from the guild.

tipe

bool

administrator

Returns True if a user is an administrator. This role overrides all other permissions.

This also bypasses all channel-specific overrides.

tipe

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.

tipe

bool

manage_guild

Returns True if a user can edit guild properties.

tipe

bool

add_reactions

Returns True if a user can add reactions to messages.

tipe

bool

view_audit_log

Returns True if a user can view the guild's audit log.

tipe

bool

priority_speaker

Returns True if a user can be more easily heard while talking.

tipe

bool

stream

Returns True if a user can stream in a voice channel.

tipe

bool

read_messages

Returns True if a user can read messages from all or specific text channels.

tipe

bool

view_channel

An alias for read_messages.

Baru pada versi 1.3.

tipe

bool

send_messages

Returns True if a user can send messages from all or specific text channels.

tipe

bool

send_tts_messages

Returns True if a user can send TTS messages from all or specific text channels.

tipe

bool

manage_messages

Returns True if a user can delete or pin messages in a text channel.

Catatan

Note that there are currently no ways to edit other people's messages.

tipe

bool

Returns True if a user's messages will automatically be embedded by Discord.

tipe

bool

attach_files

Returns True if a user can send files in their messages.

tipe

bool

read_message_history

Returns True if a user can read a text channel's previous messages.

tipe

bool

mention_everyone

Returns True if a user's @everyone or @here will mention everyone in the text channel.

tipe

bool

external_emojis

Returns True if a user can use emojis from other guilds.

tipe

bool

use_external_emojis

An alias for external_emojis.

Baru pada versi 1.3.

tipe

bool

view_guild_insights

Returns True if a user can view the guild's insights.

Baru pada versi 1.3.

tipe

bool

connect

Returns True if a user can connect to a voice channel.

tipe

bool

speak

Returns True if a user can speak in a voice channel.

tipe

bool

mute_members

Returns True if a user can mute other users.

tipe

bool

deafen_members

Returns True if a user can deafen other users.

tipe

bool

move_members

Returns True if a user can move users between other voice channels.

tipe

bool

use_voice_activation

Returns True if a user can use voice activation in voice channels.

tipe

bool

change_nickname

Returns True if a user can change their nickname in the guild.

tipe

bool

manage_nicknames

Returns True if a user can change other user's nickname in the guild.

tipe

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.

tipe

bool

manage_permissions

An alias for manage_roles.

Baru pada versi 1.3.

tipe

bool

manage_webhooks

Returns True if a user can create, edit, or delete webhooks.

tipe

bool

manage_emojis

Returns True if a user can create, edit, or delete emojis.

tipe

bool

manage_emojis_and_stickers

An alias for manage_emojis.

Baru pada versi 2.0.

tipe

bool

use_slash_commands

Returns True if a user can use slash commands.

Baru pada versi 1.7.

tipe

bool

request_to_speak

Returns True if a user can request to speak in a stage channel.

Baru pada versi 1.7.

tipe

bool

manage_events

Returns True if a user can manage guild events.

Baru pada versi 2.0.

tipe

bool

manage_threads

Returns True if a user can manage threads.

Baru pada versi 2.0.

tipe

bool

create_public_threads

Returns True if a user can create public threads.

Baru pada versi 2.0.

tipe

bool

create_private_threads

Returns True if a user can create private threads.

Baru pada versi 2.0.

tipe

bool

external_stickers

Returns True if a user can use stickers from other guilds.

Baru pada versi 2.0.

tipe

bool

use_external_stickers

An alias for external_stickers.

Baru pada versi 2.0.

tipe

bool

send_messages_in_threads

Returns True if a user can send messages in threads.

Baru pada versi 2.0.

tipe

bool

start_embedded_activities

Returns True if a user can launch activities in a voice channel

Baru pada versi 2.0.

tipe

bool

PermissionOverwrite

Methods
class discord.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.

Parameter

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

Kembali

Indicates if the overwrite is empty.

Tipe pengembalian

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.

Parameter

**kwargs -- A list of key/value pairs to bulk update with.

ShardInfo

Attributes
Methods
class discord.ShardInfo

A class that gives information and control over a specific shard.

You can retrieve this object via AutoShardedClient.get_shard() or AutoShardedClient.shards.

Baru pada versi 1.4.

id

The shard ID for this shard.

tipe

int

shard_count

The shard count for this cluster. If this is None then the bot has not started yet.

tipe

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: float

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds for this shard.

tipe

float

is_ws_ratelimited()

bool: Apakah websocket terkena rate limit apa tidak.

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

Baru pada versi 1.6.

SystemChannelFlags

Attributes
class discord.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.

tipe

int

join_notifications

Returns True if the system channel is used for member join notifications.

tipe

bool

premium_subscriptions

Returns True if the system channel is used for "Nitro boosting" notifications.

tipe

bool

guild_reminder_notifications

Returns True if the system channel is used for server setup helpful tips notifications.

Baru pada versi 2.0.

tipe

bool

MessageFlags

Attributes
class discord.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.

Baru pada versi 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.

tipe

int

crossposted

Returns True if the message is the original crossposted message.

tipe

bool

is_crossposted

Returns True if the message was crossposted from another channel.

tipe

bool

suppress_embeds

Returns True if the message's embeds have been suppressed.

tipe

bool

source_message_deleted

Returns True if the source message for this crosspost has been deleted.

tipe

bool

urgent

Returns True if the source message is an urgent message.

An urgent message is one sent by Discord Trust and Safety.

tipe

bool

has_thread

Returns True if the source message is associated with a thread.

Baru pada versi 2.0.

tipe

bool

ephemeral

Returns True if the source message is ephemeral.

Baru pada versi 2.0.

tipe

bool

PublicUserFlags

Attributes
Methods
class discord.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.

Baru pada versi 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.

tipe

int

staff

Returns True if the user is a Discord Employee.

tipe

bool

partner

Returns True if the user is a Discord Partner.

tipe

bool

hypesquad

Returns True if the user is a HypeSquad Events member.

tipe

bool

bug_hunter

Returns True if the user is a Bug Hunter

tipe

bool

hypesquad_bravery

Returns True if the user is a HypeSquad Bravery member.

tipe

bool

hypesquad_brilliance

Returns True if the user is a HypeSquad Brilliance member.

tipe

bool

hypesquad_balance

Returns True if the user is a HypeSquad Balance member.

tipe

bool

early_supporter

Returns True if the user is an Early Supporter.

tipe

bool

team_user

Returns True if the user is a Team User.

tipe

bool

system

Returns True if the user is a system user (i.e. represents Discord officially).

tipe

bool

bug_hunter_level_2

Returns True if the user is a Bug Hunter Level 2

tipe

bool

verified_bot

Returns True if the user is a Verified Bot.

tipe

bool

verified_bot_developer

Returns True if the user is an Early Verified Bot Developer.

tipe

bool

early_verified_bot_developer

An alias for verified_bot_developer.

Baru pada versi 1.5.

tipe

bool

discord_certified_moderator

Returns True if the user is a Discord Certified Moderator.

Baru pada versi 2.0.

tipe

bool

all()

List[UserFlags]: Returns all public flags the user has.

Bot UI Kit

The library has helpers to help create component-based UIs.

View

Attributes
Methods
class discord.ui.View(*, timeout=180.0)

Represents a UI view.

This object must be inherited to create a UI within Discord.

Baru pada versi 2.0.

Parameter

timeout (Optional[float]) -- Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

timeout

Timeout from last interaction with the UI before no longer accepting input. If None then there is no timeout.

tipe

Optional[float]

children

The list of children attached to this view.

tipe

List[Item]

classmethod from_message(message, /, *, timeout=180.0)

Converts a message's components into a View.

The Message.components of a message are read-only and separate types from those in the discord.ui namespace. In order to modify and edit message components they must be converted into a View first.

Parameter

  • message (discord.Message) -- The message with components to convert into a view.

  • timeout (Optional[float]) -- The timeout of the converted view.

Kembali

The converted view. This always returns a View and not one of its subclasses.

Tipe pengembalian

View

add_item(item)

Adds an item to the view.

Parameter

item (Item) -- The item to add to the view.

Menimbulkan

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

Parameter

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.

Catatan

If an exception occurs within the body then the check is considered a failure and on_error() is called.

Parameter

interaction (Interaction) -- The interaction that occurred.

Kembali

Whether the view children's callbacks should be called.

Tipe pengembalian

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.

Parameter

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

Kembali

If True, then the view timed out. If False then the view finished normally.

Tipe pengembalian

bool

Item

Attributes
Methods
class discord.ui.Item

Represents the base UI item that all UI components inherit from.

The current UI items supported are:

Baru pada versi 2.0.

property view: Optional[discord.ui.item.ViewT]

The underlying view for this item.

tipe

Optional[View]

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameter

interaction (Interaction) -- The interaction that triggered this UI item.

Button

Attributes
Methods
class discord.ui.Button(*, style=<ButtonStyle.secondary: 2>, label=None, disabled=False, custom_id=None, url=None, emoji=None, row=None)

Represents a UI button.

Baru pada versi 2.0.

Parameter

  • style (discord.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: discord.enums.ButtonStyle

The style of the button.

tipe

discord.ButtonStyle

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

tipe

Optional[str]

property url: Optional[str]

The URL this button sends you to.

tipe

Optional[str]

property disabled: bool

Whether the button is disabled or not.

tipe

bool

property label: Optional[str]

The label of the button, if available.

tipe

Optional[str]

property emoji: Optional[discord.partial_emoji.PartialEmoji]

The emoji of the button, if available.

tipe

Optional[PartialEmoji]

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameter

interaction (Interaction) -- The interaction that triggered this UI item.

property view: Optional[discord.ui.item.ViewT]

The underlying view for this item.

tipe

Optional[View]

discord.ui.button(*, label=None, custom_id=None, disabled=False, style=<ButtonStyle.secondary: 2>, emoji=None, row=None)

A decorator that attaches a button to a component.

The function being decorated should have three parameters, self representing the discord.ui.View, the discord.ui.Button being pressed and the discord.Interaction you receive.

Catatan

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.

Parameter

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

Select

Attributes
Methods
class discord.ui.Select(*, custom_id=..., placeholder=None, min_values=1, max_values=1, options=..., disabled=False, row=None)

Represents a UI select menu.

This is usually represented as a drop down menu.

In order to get the selected items that the user has chosen, use Select.values.

Baru pada versi 2.0.

Parameter

  • 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[discord.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 custom_id: str

The ID of the select menu that gets received during an interaction.

tipe

str

property placeholder: Optional[str]

The placeholder text that is shown if nothing is selected, if any.

tipe

Optional[str]

property min_values: int

The minimum number of items that must be chosen for this select menu.

tipe

int

property max_values: int

The maximum number of items that must be chosen for this select menu.

tipe

int

property options: List[discord.components.SelectOption]

A list of options that can be selected in this menu.

tipe

List[discord.SelectOption]

add_option(*, label, value=..., description=None, emoji=None, default=False)

Adds an option to the select menu.

To append a pre-existing discord.SelectOption use the append_option() method instead.

Parameter

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

Menimbulkan

ValueError -- The number of options exceeds 25.

append_option(option)

Appends an option to the select menu.

Parameter

option (discord.SelectOption) -- The option to append to the select menu.

Menimbulkan

ValueError -- The number of options exceeds 25.

property disabled: bool

Whether the select is disabled or not.

tipe

bool

property values: List[str]

A list of values that have been selected by the user.

tipe

List[str]

await callback(interaction)

This function is a coroutine.

The callback associated with this UI item.

This can be overriden by subclasses.

Parameter

interaction (Interaction) -- The interaction that triggered this UI item.

property view: Optional[discord.ui.item.ViewT]

The underlying view for this item.

tipe

Optional[View]

discord.ui.select(*, placeholder=None, custom_id=..., min_values=1, max_values=1, options=..., disabled=False, row=None)

A decorator that attaches a select menu to a component.

The function being decorated should have three parameters, self representing the discord.ui.View, the discord.ui.Select being pressed and the discord.Interaction you receive.

In order to get the selected items that the user has chosen within the callback use Select.values.

Parameter

  • 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[discord.SelectOption]) -- A list of options that can be selected in this menu.

  • disabled (bool) -- Whether the select is disabled or not. Defaults to False.

Exceptions

The following exceptions are thrown by the library.

exception discord.DiscordException

Base exception class for discord.py

Ideally speaking, this could be caught to handle any exceptions raised from this library.

exception discord.ClientException

Exception that's raised when an operation in the Client fails.

These are usually for exceptions that happened due to user input.

exception discord.LoginFailure

Exception that's raised when the Client.login() function fails to log you in from improper credentials or some other misc. failure.

exception discord.NoMoreItems

Exception that is raised when an async iteration operation has no more items.

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

tipe

aiohttp.ClientResponse

text

The text of the error. Could be an empty string.

tipe

str

status

The status code of the HTTP request.

tipe

int

code

The Discord specific error code for the failure.

tipe

int

exception discord.Forbidden(response, message)

Exception that's raised for when status code 403 occurs.

Subclass of HTTPException

exception discord.NotFound(response, message)

Exception that's raised for when status code 404 occurs.

Subclass of HTTPException

exception discord.DiscordServerError(response, message)

Exception that's raised for when a 500 range status code occurs.

Subclass of HTTPException.

Baru pada versi 1.5.

exception discord.InvalidData

Exception that's raised when the library encounters unknown or invalid data from Discord.

exception discord.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 discord.GatewayNotFound

An exception that is raised when the gateway for Discord could not be found

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

tipe

int

reason

The reason provided for the closure.

tipe

str

shard_id

The shard ID that got closed if applicable.

tipe

Optional[int]

exception discord.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:

shard_id

The shard ID that got closed if applicable.

tipe

Optional[int]

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

Baru pada versi 2.0.

interaction

The interaction that's already been responded to.

tipe

Interaction

exception discord.opus.OpusError(code)

An exception that is thrown for libopus related errors.

code

The error code returned.

tipe

int

exception discord.opus.OpusNotLoaded

An exception that is thrown for when libopus is not loaded.

Exception Hierarchy