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.

Attributes
class discord.Object(id, type=...)[源代码]

Represents a generic Discord object.

The purpose of this class is to allow you to create 'miniature' versions of data classes if you want to pass in just an ID. Most functions that take in a specific data class with an ID can also take in this class as a substitute instead. Note that even though this is the case, not all objects (if any) actually inherit from this class.

There are also some cases where some WebSocket events are received in strange order and when such events happened you would receive this class rather than the actual data class. These cases are extremely rare.

x == y

Checks if two objects are equal.

x != y

Checks if two objects are not equal.

hash(x)

Returns the object's hash.

id

The ID of the object.

Type:

int

type

The model this object's ID is based off.

Type:

type[abc.Snowflake]

参数:
property created_at: datetime

Returns the snowflake's creation time in UTC.

property worker_id: int

Returns the worker id that made the snowflake.

property process_id: int

Returns the process id that made the snowflake.

property increment_id: int

Returns the increment id that made the snowflake.

Attributes
class discord.SelectOption(*, label, value=..., description=None, emoji=None, default=False)[源代码]

Represents a discord.SelectMenu's option.

These can be created by users.

在 2.0 版本加入.

label

The label of the option. This is displayed to users. Can only be up to 100 characters.

Type:

str

value

The value of the option. This is not displayed to users. If not provided when constructed then it defaults to the label. Can only be up to 100 characters.

Type:

str

description

An additional description of the option, if any. Can only be up to 100 characters.

Type:

Optional[str]

default

Whether this option is selected by default.

Type:

bool

参数:
property emoji: str | GuildEmoji | AppEmoji | PartialEmoji | None

The emoji of the option, if available.

class discord.SelectDefaultValue(object=..., /, *, id=..., type=...)[源代码]

Represents a discord.SelectMenus default value.

This is only applicable to selects of type other than ComponentType.string_select.

在 2.7 版本加入.

参数:
抛出:

TypeError -- You did not provide any parameter, you provided all parameters, or you provided id but not type.

Attributes
class discord.MediaGalleryItem(url, *, description=None, spoiler=False)[源代码]

Represents an item used in the MediaGallery component.

This is used as an underlying component for other media-based components such as Thumbnail, FileComponent, and MediaGalleryItem.

在 2.7 版本加入.

url

The URL of this gallery item. This can either be an arbitrary URL or an attachment:// URL to work with local files.

Type:

str

description

The gallery item's description, up to 1024 characters.

Type:

Optional[str]

spoiler

Whether the gallery item is a spoiler.

Type:

Optional[bool]

Attributes
class discord.UnfurledMediaItem(url)[源代码]

Represents an Unfurled Media Item used in Components V2.

This is used as an underlying component for other media-based components such as Thumbnail, FileComponent, and MediaGalleryItem.

在 2.7 版本加入.

url

The URL of this media item. This can either be an arbitrary URL or an attachment:// URL to work with local files.

Type:

str

参数:

url (str)

Attributes
class discord.RadioGroupOption(*, label, value=..., description=None, default=False)[源代码]

Represents a discord.RadioGroup's option.

These can be created by users.

在 2.8 版本加入.

label

The label of the option. This is displayed to users. Can only be up to 100 characters.

Type:

str

value

The value of the option. This is not displayed to users. If not provided when constructed then it defaults to the label. Can only be up to 100 characters.

Type:

str

description

An additional description of the option, if any. Can only be up to 100 characters.

Type:

Optional[str]

default

Whether this option is selected by default. Only 1 option should be set to default within a discord.RadioGroup.

Type:

bool

参数:
Attributes
class discord.CheckboxGroupOption(*, label, value=..., description=None, default=False)[源代码]

Represents a discord.CheckboxGroup's option.

These can be created by users.

在 2.8 版本加入.

label

The label of the option. This is displayed to users. Can only be up to 100 characters.

Type:

str

value

The value of the option. This is not displayed to users. If not provided when constructed then it defaults to the label. Can only be up to 100 characters.

Type:

str

description

An additional description of the option, if any. Can only be up to 100 characters.

Type:

Optional[str]

default

Whether this option is selected by default.

Type:

bool

参数:
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.

在 1.5 版本加入.

x == y

Checks if two flags are equal.

x != y

Checks if two flags are not equal.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

hash(x)

Return the flag's hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

classmethod all()[源代码]

A factory method that creates a Intents with everything enabled.

返回类型:

Intents

classmethod none()[源代码]

A factory method that creates a Intents with everything disabled.

返回类型:

Intents

classmethod default()[源代码]

A factory method that creates a Intents with everything enabled except presences, members, and message_content.

返回类型:

Intents

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.

Type:

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.

备注

This intent is privileged, meaning that bots in over 100 guilds that require this intent would need to request this intent on the Developer Portal.

Type:

bool

bans[源代码]

Alias of moderation.

在 2.5 版本发生变更: Changed to an alias.

Type:

bool

moderation[源代码]

Whether guild moderation 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.

Type:

bool

emojis[源代码]

Alias of emojis_and_stickers.

在 2.0 版本发生变更: Changed to an alias.

Type:

bool

emojis_and_stickers[源代码]

Whether guild emoji and sticker related events are enabled.

在 2.0 版本加入.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Type:

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.

Type:

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.

Type:

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.

Type:

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:

备注

This intent is required to connect to voice.

Type:

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.

备注

This intent is privileged, meaning that bots in over 100 guilds that require this intent would need to request this intent on the Developer Portal.

Type:

bool

messages[源代码]

Whether guild and direct message related events are enabled.

This is a shortcut to set or get both guild_messages and dm_messages.

This corresponds to the following events:

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:

备注

message_content is required to receive the actual content of guild messages.

Type:

bool

guild_messages[源代码]

Whether guild message related events are enabled.

See also dm_messages for DMs or messages for both.

This corresponds to the following events:

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:

Without the message_content intent enabled, the following fields are either an empty string or empty array:

For more information go to the message content intent documentation.

Type:

bool

dm_messages[源代码]

Whether direct message related events are enabled.

See also guild_messages for guilds or messages for both.

This corresponds to the following events:

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:

Type:

bool

reactions[源代码]

Whether guild and direct message reaction related events are enabled.

This is a shortcut to set or get both guild_reactions and dm_reactions.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Type:

bool

guild_reactions[源代码]

Whether guild message reaction related events are enabled.

See also dm_reactions for DMs or reactions for both.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Type:

bool

dm_reactions[源代码]

Whether direct message reaction related events are enabled.

See also guild_reactions for guilds or reactions for both.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Type:

bool

typing[源代码]

Whether guild and direct message typing related events are enabled.

This is a shortcut to set or get both guild_typing and dm_typing.

This corresponds to the following events:

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

guild_typing[源代码]

Whether guild and direct message typing related events are enabled.

See also dm_typing for DMs or typing for both.

This corresponds to the following events:

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

dm_typing[源代码]

Whether guild and direct message typing related events are enabled.

See also guild_typing for guilds or typing for both.

This corresponds to the following events:

This does not correspond to any attributes or classes in the library in terms of cache.

Type:

bool

message_content[源代码]

Whether the bot will receive message content in guild messages.

This corresponds to the following attributes:

These attributes will still be available for messages received from interactions, the bot's own messages, messages the bot was mentioned in, and DMs.

在 2.0 版本加入.

备注

As of September 2022 using this intent requires opting in explicitly via the Developer Portal to receive the actual content of the guild messages. This intent is privileged, meaning that bots in over 100 guilds that require this intent would need to request this intent on the Developer Portal. See https://support-dev.discord.com/hc/en-us/articles/4404772028055 for more information.

Type:

bool

scheduled_events[源代码]

Whether "scheduled event" related events are enabled.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Type:

bool

auto_moderation_configuration[源代码]

Whether guild auto moderation configuration events are enabled.

This corresponds to the following events:

Type:

bool

auto_moderation_execution[源代码]

Whether guild auto moderation execution events are enabled.

This corresponds to the following events:

Type:

bool

guild_polls[源代码]

Whether poll-related events in guilds are enabled.

See also dm_polls for DMs or polls for both.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Type:

bool

dm_polls[源代码]

Whether poll-related events in direct messages are enabled.

See also guild_polls for guilds or polls for both.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Type:

bool

polls[源代码]

Whether poll-related events in guilds and direct messages are enabled.

This is a shortcut to set or get both guild_polls and dm_polls.

This corresponds to the following events:

This also corresponds to the following attributes and classes in terms of cache:

Type:

bool

Attributes
Methods
class discord.ShardInfo(parent, shard_count)[源代码]

A class that gives information and control over a specific shard.

You can retrieve this object via AutoShardedClient.get_shard() or AutoShardedClient.shards.

在 1.4 版本加入.

id

The shard ID for this shard.

Type:

int

shard_count

The shard count for this cluster. If this is None then the bot has not started yet.

Type:

Optional[int]

参数:

  • parent (Shard)

  • shard_count (int | None)

is_closed()[源代码]

Whether the shard connection is currently closed.

返回类型:

bool

await disconnect()[源代码]

This function is a coroutine.

Disconnects a shard. When this is called, the shard connection will no longer be open.

If the shard is already disconnected this does nothing.

返回类型:

None

await reconnect()[源代码]

This function is a coroutine.

Disconnects and then connects the shard again.

返回类型:

None

await connect()[源代码]

This function is a coroutine.

Connects a shard. If the shard is already connected this does nothing.

返回类型:

None

property latency: float

Measures latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds for this shard. If no heartbeat has been received yet this returns float('inf').

is_ws_ratelimited()[源代码]

Whether the websocket is currently rate limited.

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

在 1.6 版本加入.

返回类型:

bool

Message

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.

Type:

bool

users

Controls the users being mentioned. If True (the default) then users are mentioned based on the message content. If False then users are not mentioned at all. If a list of abc.Snowflake is given then only the users provided will be mentioned, provided those users are in the message content.

Type:

Union[bool, List[abc.Snowflake]]

roles

Controls the roles being mentioned. If True (the default) then roles are mentioned based on the message content. If False then roles are not mentioned at all. If a list of abc.Snowflake is given then only the roles provided will be mentioned, provided those roles are in the message content.

Type:

Union[bool, List[abc.Snowflake]]

replied_user

Whether to mention the author of the message being replied to. Defaults to True.

在 1.6 版本加入.

Type:

bool

参数:
classmethod all()[源代码]

A factory method that returns a AllowedMentions with all fields explicitly set to True

在 1.5 版本加入.

返回类型:

TypeVar(A, bound= AllowedMentions)

classmethod none()[源代码]

A factory method that returns a AllowedMentions with all fields set to False

在 1.5 版本加入.

返回类型:

TypeVar(A, bound= AllowedMentions)

Attributes
Methods
class discord.MessageReference(*, message_id, channel_id, guild_id=None, fail_if_not_exists=True, type=('default', 0))[源代码]

Represents a reference to a Message.

在 1.5 版本加入.

在 1.6 版本发生变更: This class can now be constructed by users.

type

The type of message reference. If this is not provided, assume the default behavior (i.e., reply).

在 2.7 版本加入.

Type:

Optional[MessageReferenceType]

message_id

The id of the message referenced.

Type:

Optional[int]

channel_id

The channel id of the message referenced.

Type:

int

guild_id

The guild id of the message referenced.

Type:

Optional[int]

fail_if_not_exists

Whether replying to the referenced message should raise HTTPException if the message no longer exists or Discord could not fetch the message.

在 1.7 版本加入.

Type:

bool

resolved

The message that this reference resolved to. If this is None then the original message was not fetched either due to the Discord API not attempting to resolve it or it not being available at the time of creation. If the message was resolved at a prior point but has since been deleted then this will be of type DeletedReferencedMessage.

Currently, this is mainly the replied to message when a user replies to a message.

在 1.6 版本加入.

Type:

Optional[Union[Message, DeletedReferencedMessage]]

参数:

  • message_id (int)

  • channel_id (int)

  • guild_id (int | None)

  • fail_if_not_exists (bool)

  • type (MessageReferenceType)

classmethod from_message(message, *, fail_if_not_exists=True, type=('default', 0))[源代码]

Creates a MessageReference from an existing Message.

在 1.6 版本加入.

参数:

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

    在 1.7 版本加入.

  • type (MessageReferenceType) --

    The type of reference to create. Defaults to MessageReferenceType.default (reply).

    在 2.7 版本加入.

返回:

A reference to the message.

返回类型:

TypeVar(MR, bound= MessageReference)

property cached_message: Message | None

The cached message, if found in the internal message cache.

property jump_url: str

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

在 1.7 版本加入.

Attributes
class discord.MessageCall(state, data)[源代码]

Represents information about a call in a private channel.

在 2.6 版本加入.

参数:

  • state (ConnectionState)

  • data (MessageCall)

property participants: list[User | Object]

A list of User that participated in this call.

If a user is not found in the client's cache, then it will be returned as an Object.

property ended_at: datetime | None

An aware timestamp of when the call ended.

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.

在 1.6 版本加入.

x == y

Checks if two partial messages are equal.

x != y

Checks if two partial messages are not equal.

hash(x)

Returns the partial message's hash.

channel

The channel associated with this partial message.

Type:

Union[TextChannel, Thread, DMChannel, VoiceChannel, StageChannel, PartialMessageable]

id

The message ID.

Type:

int

参数:
property jump_url: str

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

await delete(*, delay=None, reason=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.

在 1.1 版本发生变更: Added the new delay keyword-only parameter.

参数:

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

  • reason (str | None) -- The reason for deleting the message. Shows up on the audit log.

抛出:

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

  • NotFound -- The message was deleted already

  • HTTPException -- Deleting the message failed.

返回类型:

None

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.

抛出:

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

  • HTTPException -- Publishing the message failed.

返回类型:

None

await pin(*, reason=None)

This function is a coroutine.

Pins the message.

You must have the pin_messages permission to do this in a non-private channel context.

参数:

reason (str | None) --

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

在 1.4 版本加入.

抛出:

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

返回类型:

None

await unpin(*, reason=None)

This function is a coroutine.

Unpins the message.

You must have the pin_messages permission to do this in a non-private channel context.

参数:

reason (str | None) --

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

在 1.4 版本加入.

抛出:

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

返回类型:

None

await add_reaction(emoji)

This function is a coroutine.

Add a reaction to the message.

The emoji may be a unicode emoji, a custom GuildEmoji, or an AppEmoji.

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.

参数:

emoji (GuildEmoji | AppEmoji | PartialEmoji | str) -- The emoji to react with.

抛出:

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

返回类型:

None

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, a custom GuildEmoji, or an AppEmoji.

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.

参数:
抛出:

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

返回类型:

None

await clear_reaction(emoji)

This function is a coroutine.

Clears a specific reaction from the message.

The emoji may be a unicode emoji, a custom GuildEmoji, or an AppEmoji.

You need the manage_messages permission to use this.

在 1.3 版本加入.

参数:

emoji (GuildEmoji | AppEmoji | PartialEmoji | str | Reaction) -- The emoji to clear.

抛出:

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

返回类型:

None

await clear_reactions()

This function is a coroutine.

Removes all the reactions from the message.

You need the manage_messages permission to use this.

抛出:

  • HTTPException -- Removing the reactions failed.

  • Forbidden -- You do not have the proper permissions to remove all the reactions.

返回类型:

None

await reply(content=None, **kwargs)

This function is a coroutine.

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

在 1.6 版本加入.

返回:

The message that was sent.

返回类型:

Message

抛出:

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

参数:

content (str | None)

await forward_to(channel, **kwargs)

This function is a coroutine.

A shortcut method to abc.Messageable.send() to forward the Message to a channel.

在 2.7 版本加入.

参数:

channel (TextChannel | VoiceChannel | StageChannel | Thread | DMChannel | PartialMessageable | GroupChannel) -- The channel to forward this to.

返回:

The message that was sent.

返回类型:

Message

抛出:

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

to_reference(*, fail_if_not_exists=True, type=None)

Creates a MessageReference from the current message.

在 1.6 版本加入.

参数:

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

    在 1.7 版本加入.

  • type (MessageReferenceType) --

    The type of message reference. Defaults to a reply.

    在 2.7 版本加入.

返回:

The reference to this message.

返回类型:

MessageReference

property created_at: datetime

The partial message's creation time in UTC.

guild

The guild that the partial message belongs to, if applicable.

await fetch()[源代码]

This function is a coroutine.

Fetches the partial message to a full Message.

返回:

The full message.

返回类型:

Message

抛出:

  • NotFound -- The message was not found.

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

  • HTTPException -- Retrieving the message failed.

await edit(**fields)[源代码]

This function is a coroutine.

Edits the message.

在 1.7 版本发生变更: discord.Message is returned instead of None if an edit took place.

参数:

  • 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 (Optional[List[Embed]]) --

    A list of embeds to upload. Must be a maximum of 10.

    在 2.0 版本加入.

  • suppress (bool) -- Whether to suppress embeds for the message. This removes all the embeds if set to True. If set to False this brings the embeds back if they were suppressed. Using this parameter requires manage_messages.

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

  • allowed_mentions (Optional[AllowedMentions]) -- Controls the mentions being processed in this message. If this is passed, then the object is merged with allowed_mentions. The merging behaviour only overrides attributes that have been explicitly passed to the object, otherwise it uses the attributes set in allowed_mentions. If no object is passed at all then the defaults given by allowed_mentions are used instead.

  • view (Optional[BaseView]) --

    The updated view to update this message with. If None is passed then the view is removed.

    在 2.0 版本加入.

  • fields (Any)

返回:

The message that was edited.

返回类型:

Message | None

抛出:

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

await end_poll()[源代码]

This function is a coroutine.

Immediately ends the poll associated with this message. Only doable by the poll's owner.

在 2.6 版本加入.

返回:

The updated message.

返回类型:

Message

抛出:
Attributes
class discord.File(fp, filename=None, *, description=None, spoiler=False)[源代码]

A parameter object used for abc.Messageable.send() for sending file objects.

备注

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.

备注

If the file-like object passed is opened via open then the modes 'rb' should be used.

To pass binary data, consider usage of io.BytesIO.

Type:

Union[os.PathLike, io.BufferedIOBase]

filename

The filename to display when uploading to Discord. If this is not given then it defaults to fp.name or if fp is a string then the filename will default to the string given.

Type:

Optional[str]

description

The description of a file, used by Discord to display alternative text on images.

Type:

Optional[str]

spoiler

Whether the attachment is a spoiler.

Type:

bool

参数:

Embed

Attributes
Methods
class discord.Embed(*, colour=None, color=None, title=None, type='rich', url=None, description=None, timestamp=None, fields=None, author=None, footer=None, image=None, thumbnail=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.

在 2.0 版本加入.

For ease of use, all parameters that expect a str are implicitly cast to str for you.

title

The title of the embed. This can be set during initialisation. Must be 256 characters or fewer.

Type:

str

type

The type of embed. Usually "rich". This can be set during initialisation. Possible strings for embed types can be found on discord's api docs

Type:

str

description

The description of the embed. This can be set during initialisation. Must be 4096 characters or fewer.

Type:

str

url

The URL of the embed. This can be set during initialisation.

Type:

str

timestamp

The timestamp of the embed content. This is an aware datetime. If a naive datetime is passed, it is converted to an aware datetime with the local timezone.

Type:

datetime.datetime

colour

The colour code of the embed. Aliased to color as well. This can be set during initialisation.

Type:

Union[Colour, int]

参数:
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.

参数:

data (Mapping[str, Any]) -- The dictionary to convert into an embed.

返回:

The converted embed object.

返回类型:

TypeVar(E, bound= Embed)

copy()[源代码]

Creates a shallow copy of the Embed object.

返回:

The copied embed object.

返回类型:

TypeVar(E, bound= Embed)

参数:

self (TypeVar(E, bound= Embed))

property footer: EmbedFooter | None

Returns an EmbedFooter denoting the footer contents.

See set_footer() for possible values you can access.

If the footer is not set then None is returned.

Sets the footer for the embed content.

This function returns the class instance to allow for fluent-style chaining.

参数:

  • text (Any | None) -- The footer text. Must be 2048 characters or fewer.

  • icon_url (Any | None) -- The URL of the footer icon. Only HTTP(S) is supported.

  • self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

Clears embed's footer information.

This function returns the class instance to allow for fluent-style chaining.

在 2.0 版本加入.

参数:

self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

property image: EmbedMedia | None

Returns an EmbedMedia denoting the image contents.

Attributes you can access are:

  • url

  • proxy_url

  • width

  • height

If the image is not set then None is returned.

set_image(*, url)[源代码]

Sets the image for the embed content.

This function returns the class instance to allow for fluent-style chaining.

在 1.4 版本发生变更: Passing None removes the image.

参数:

  • url (Any | None) -- The source URL for the image. Only HTTP(S) is supported.

  • self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

remove_image()[源代码]

Removes the embed's image.

This function returns the class instance to allow for fluent-style chaining.

在 2.0 版本加入.

参数:

self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

property thumbnail: EmbedMedia | None

Returns an EmbedMedia denoting the thumbnail contents.

Attributes you can access are:

  • url

  • proxy_url

  • width

  • height

If the thumbnail is not set then None is returned.

set_thumbnail(*, url)[源代码]

Sets the thumbnail for the embed content.

This function returns the class instance to allow for fluent-style chaining.

在 1.4 版本发生变更: Passing None removes the thumbnail.

参数:

  • url (Any | None) -- The source URL for the thumbnail. Only HTTP(S) is supported.

  • self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

remove_thumbnail()[源代码]

Removes the embed's thumbnail.

This function returns the class instance to allow for fluent-style chaining.

在 2.0 版本加入.

参数:

self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

property video: EmbedMedia | None

Returns an EmbedMedia denoting the video contents.

Attributes include:

  • url for the video URL.

  • height for the video height.

  • width for the video width.

If the video is not set then None is returned.

property provider: EmbedProvider | None

Returns an EmbedProvider denoting the provider contents.

The only attributes that might be accessed are name and url.

If the provider is not set then None is returned.

property author: EmbedAuthor | None

Returns an EmbedAuthor denoting the author contents.

See set_author() for possible values you can access.

If the author is not set then None is returned.

set_author(*, name, url=None, icon_url=None)[源代码]

Sets the author for the embed content.

This function returns the class instance to allow for fluent-style chaining.

参数:

  • name (Any) -- The name of the author. Must be 256 characters or fewer.

  • url (Any | None) -- The URL for the author.

  • icon_url (Any | None) -- The URL of the author icon. Only HTTP(S) is supported.

  • self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

remove_author()[源代码]

Clears embed's author information.

This function returns the class instance to allow for fluent-style chaining.

在 1.4 版本加入.

参数:

self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

property fields: list[EmbedField]

Returns a list of EmbedField objects denoting the field contents.

See add_field() for possible values you can access.

If the attribute has no value then None is returned.

append_field(field)[源代码]

Appends an EmbedField object to the embed.

在 2.0 版本加入.

参数:

field (EmbedField) -- The field to add.

返回类型:

None

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. There must be 25 fields or fewer.

参数:

  • name (str) -- The name of the field. Must be 256 characters or fewer.

  • value (str) -- The value of the field. Must be 1024 characters or fewer.

  • inline (bool) -- Whether the field should be displayed inline.

  • self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

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. There must be 25 fields or fewer.

在 1.2 版本加入.

参数:

  • index (int) -- The index of where to insert the field.

  • name (Any) -- The name of the field. Must be 256 characters or fewer.

  • value (Any) -- The value of the field. Must be 1024 characters or fewer.

  • inline (bool) -- Whether the field should be displayed inline.

  • self (TypeVar(E, bound= Embed))

返回类型:

TypeVar(E, bound= Embed)

clear_fields()[源代码]

Removes all fields from this embed.

返回类型:

None

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.

备注

When deleting a field by index, the index of the other fields shift to fill the gap just like a regular list.

参数:

index (int) -- The index of the field to remove.

返回类型:

None

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. There must be 25 fields or fewer.

This function returns the class instance to allow for fluent-style chaining.

参数:

  • index (int) -- The index of the field to modify.

  • name (Any) -- The name of the field. Must be 256 characters or fewer.

  • value (Any) -- The value of the field. Must be 1024 characters or fewer.

  • inline (bool) -- Whether the field should be displayed inline.

  • self (TypeVar(E, bound= Embed))

抛出:

IndexError -- An invalid index was provided.

返回类型:

TypeVar(E, bound= Embed)

to_dict()[源代码]

Converts this embed object into a dict.

返回:

A dictionary of str embed keys bound to the respective value.

返回类型:

Embed

Attributes
Methods
class discord.EmbedField(name, value, inline=False)[源代码]

Represents a field on the Embed object.

在 2.0 版本加入.

name

The name of the field.

Type:

str

value

The value of the field.

Type:

str

inline

Whether the field should be displayed inline.

Type:

bool

参数:
classmethod from_dict(data)[源代码]

Converts a dict to a EmbedField 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.

参数:

data (dict[str, str | bool]) -- The dictionary to convert into an EmbedField object.

返回类型:

EmbedField

to_dict()[源代码]

Converts this EmbedField object into a dict.

返回:

A dictionary of str embed field keys bound to the respective value.

返回类型:

dict[str, str | bool | None]

Attributes
class discord.EmbedAuthor(name, url=None, icon_url=None)[源代码]

Represents the author on the Embed object.

在 2.5 版本加入.

name

The name of the author.

Type:

str

url

The URL of the hyperlink created in the author's name.

Type:

str

icon_url

The URL of the author icon image.

Type:

str

proxy_icon_url

The proxied URL of the author icon image. This can't be set directly, it is set by Discord.

Type:

str

参数:
Attributes
class discord.EmbedFooter(text, icon_url=None)[源代码]

Represents the footer on the Embed object.

在 2.5 版本加入.

text

The text inside the footer.

Type:

str

icon_url

The URL of the footer icon image.

Type:

str

proxy_icon_url

The proxied URL of the footer icon image. This can't be set directly, it is set by Discord.

Type:

str

参数:
Attributes
class discord.EmbedMedia(url)[源代码]

Represents a media on the Embed object. This includes thumbnails, images, and videos.

在 2.5 版本加入.

url

The source URL of the media.

Type:

str

proxy_url

The proxied URL of the media.

Type:

str

height

The height of the media.

Type:

int

width

The width of the media.

Type:

int

参数:

url (str)

Attributes
class discord.EmbedProvider[源代码]

Represents a provider on the Embed object.

在 2.5 版本加入.

name

The name of the provider.

Type:

str

url

The URL of the provider.

Type:

str

Poll

Attributes
Methods
class discord.Poll(question, *, answers=None, duration=24, allow_multiselect=False, layout_type=('default', 1))[源代码]

Represents a Poll. Polls are sent in regular messages, and you must have send_polls to send them.

在 2.6 版本加入.

question

The poll's question media, or a str representing the question text. Question text can be up to 300 characters.

Type:

Union[PollMedia, str]

answers

A list of the poll's answers. A maximum of 10 answers can be set.

Type:

Optional[List[PollAnswer]]

duration

The number of hours until this poll expires. Users must specify this when creating a poll, but existing polls return expiry instead. Defaults to 24.

Type:

int

allow_multiselect

Whether multiple answers can be selected. Defaults to False.

Type:

bool

layout_type

The poll's layout type. Only one exists at the moment.

Type:

PollLayoutType

results

The results of this poll recieved from Discord. If None, this should be considered "unknown" rather than "no" results.

Type:

Optional[PollResults]

参数:
property expiry: datetime | None[源代码]

An aware datetime object that specifies the date and time in UTC when the poll will end.

has_ended()[源代码]

Checks if this poll has completely ended. Shortcut for PollResults.is_finalized, if available.

返回:

Returns a boolean if results is available, otherwise None.

返回类型:

bool | None

total_votes()[源代码]

Shortcut for PollResults.total_votes() This may not be precise if is_finalized is False.

返回:

The total number of votes on this poll if results is available, otherwise None.

返回类型:

int | None

get_answer(id)[源代码]

Get a poll answer by ID.

参数:

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

返回:

The returned answer or None if not found.

返回类型:

PollAnswer | None

add_answer(text, *, emoji=None)[源代码]

Add an answer to this poll.

This function returns the class instance to allow for fluent-style chaining.

参数:
抛出:

  • ValueError -- The poll already has 10 answers or text exceeds the character length.

  • RuntimeError -- You cannot add an answer to an existing poll.

返回类型:

Poll

示例

Regular usage

poll = Poll(
    question=PollMedia("What's your favorite color?"),

    answers=[PollAnswer("Red", "❤")]
    duration=24,
    allow_multiselect=False
)
poll.add_answer(text="Green", emoji="💚")
poll.add_answer(text="Blue", emoji="💙")

Chaining style

poll = Poll("What's your favorite color?").add_answer("Red", emoji="❤").add_answer("Green").add_answer("Blue")
await end()[源代码]

Immediately ends this poll, if attached to a message. Only doable by the poll's owner. Shortcut to Message.end_poll()

返回:

The updated message.

返回类型:

Message

抛出:
Attributes
class discord.PollMedia(text, emoji=None)[源代码]

Represents a poll media object that supports both questions and answers.

在 2.6 版本加入.

text

The question/answer text. May have up to 300 characters for questions and 55 characters for answers.

Type:

str

emoji

The answer's emoji.

Type:

Optional[Union[GuildEmoji, AppEmoji, PartialEmoji, str]]

参数:
Attributes
Methods
class discord.PollAnswer(text, emoji=None)[源代码]

Represents a poll answer object.

在 2.6 版本加入.

id

The answer's ID. It currently starts at 1 for the first answer, then goes up sequentially. It may not be reliable to depend on this.

Type:

int

media

The relevant media for this answer.

Type:

PollMedia

参数:
property text: str

The answer's text. Shortcut for PollMedia.text.

property emoji: GuildEmoji | AppEmoji | PartialEmoji | None

The answer's emoji. Shortcut for PollMedia.emoji.

property count: int | None

This answer's vote count, if recieved from Discord.

voters(*, limit=None, after=None)[源代码]

Returns an AsyncIterator representing the users that have voted with this answer. Only works if this poll was recieved from Discord.

The after parameter must represent a member and meet the abc.Snowflake abc.

参数:

  • limit (int | None) -- The maximum number of results to return. If not provided, returns all the users who voted with this answer.

  • after (Snowflake | None) -- For pagination, answers are sorted by member.

生成器:

Union[User, Member] -- The member (if retrievable) or the user that has voted with this answer. 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.

抛出:
返回类型:

VoteIterator

示例

Usage

async for user in answer.users():
    print(f'{user} voted **{answer.text}**!')

Flattening into a list:

users = await answer.users().flatten()
# users is now a list of User...
winner = random.choice(users)
await channel.send(f'{winner} has won the raffle.')
Attributes
class discord.PollAnswerCount(data)[源代码]

Represents a poll answer count object.

在 2.6 版本加入.

id

The answer's ID. It currently starts at 1 for the first answer, then goes up sequentially. It may not be reliable to depend on this.

Type:

int

count

The number of votes for this answer.

Type:

int

me

If the current user voted this answer. This is always False for bots.

Type:

bool

参数:

data (PollAnswerCount)

Attributes
Methods
class discord.PollResults(data)[源代码]

Represents a poll results object.

在 2.6 版本加入.

is_finalized

Whether the poll has ended and all answer counts have been precisely tallied.

Type:

bool

answer_counts

A list of counts for each answer. If an answer isn't included, it has no votes.

Type:

List[PollAnswerCount]

参数:

data (PollResults)

total_votes()[源代码]

Get the total number of votes across all answers. This may not be accurate if is_finalized is False.

返回:

The total number of votes on this poll.

返回类型:

int

Flags

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

在 1.5 版本加入.

x == y

Checks if two flags are equal.

x != y

Checks if two flags are not equal.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

hash(x)

Return the flag's hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

classmethod all()[源代码]

A factory method that creates a MemberCacheFlags with everything enabled.

返回类型:

MemberCacheFlags

classmethod none()[源代码]

A factory method that creates a MemberCacheFlags with everything disabled.

返回类型:

MemberCacheFlags

voice[源代码]

Whether to cache members that are in voice.

This requires Intents.voice_states.

Members that leave voice are no longer cached.

Type:

bool

joined[源代码]

Whether to cache members that joined the guild or are chunked as part of the initial log in flow.

This requires Intents.members.

Members that leave the guild are no longer cached.

Type:

bool

interaction[源代码]

Whether to cache members obtained through interactions.

This includes members received through discord.Interaction and discord.Option.

Type:

bool

classmethod from_intents(intents)[源代码]

A factory method that creates a MemberCacheFlags based on the currently selected Intents.

参数:

intents (Intents) -- The intents to select from.

返回:

The resulting member cache flags.

返回类型:

MemberCacheFlags

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.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

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.

在 2.0 版本加入.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

managed_emoji[源代码]

Returns True if the application is a managed emoji.

Type:

bool

group_dm_create[源代码]

Returns True if the application can create group DMs.

Type:

bool

application_auto_moderation_rule_create_badge[源代码]

Returns True if the application uses the Auto Moderation API.

在 2.5 版本加入.

Type:

bool

rpc_has_connected[源代码]

Returns True if the application has connected to RPC.

Type:

bool

gateway_presence[源代码]

Returns True if the application is verified and is allowed to receive presence information over the gateway.

Type:

bool

gateway_presence_limited[源代码]

Returns True if the application is allowed to receive limited presence information over the gateway.

Type:

bool

gateway_guild_members[源代码]

Returns True if the application is verified and is allowed to receive guild members information over the gateway.

Type:

bool

gateway_guild_members_limited[源代码]

Returns True if the application is allowed to receive limited guild members information over the gateway.

Type:

bool

verification_pending_guild_limit[源代码]

Returns True if the application is currently pending verification and has hit the guild limit.

Type:

bool

embedded[源代码]

Returns True if the application is embedded within the Discord client.

Type:

bool

gateway_message_content[源代码]

Returns True if the application is allowed to read message contents in guilds.

Type:

bool

gateway_message_content_limited[源代码]

Returns True if the application is currently pending verification and has hit the guild limit.

Type:

bool

app_commands_badge[源代码]

Returns True if the application has registered at least one global application command, and by extension has the badge.

在 2.1 版本加入.

Type:

bool

active[源代码]

Returns True if the app is considered active. Applications are considered active if they have had any command executions in the past 30 days.

在 2.3 版本加入.

Type:

bool

Attributes
class discord.SystemChannelFlags(**kwargs)[源代码]

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.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

hash(x)

Return the flag's hash.

iter(x)

Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

join_notifications[源代码]

Returns True if the system channel is used for member join notifications.

Type:

bool

premium_subscriptions[源代码]

Returns True if the system channel is used for "Nitro boosting" notifications.

Type:

bool

guild_reminder_notifications[源代码]

Returns True if the system channel is used for server setup helpful tips notifications.

在 2.0 版本加入.

Type:

bool

join_notification_replies[源代码]

Returns True if the system channel is allowing member join sticker replies.

在 2.0 版本加入.

Type:

bool

Attributes
class discord.MessageFlags(**kwargs)[源代码]

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.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

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.

在 1.3 版本加入.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

crossposted[源代码]

Returns True if the message is the original crossposted message.

Type:

bool

is_crossposted[源代码]

Returns True if the message was crossposted from another channel.

Type:

bool

suppress_embeds[源代码]

Returns True if the message's embeds have been suppressed.

Type:

bool

source_message_deleted[源代码]

Returns True if the source message for this crosspost has been deleted.

Type:

bool

urgent[源代码]

Returns True if the source message is an urgent message.

An urgent message is one sent by Discord Trust and Safety.

Type:

bool

has_thread[源代码]

Returns True if the source message is associated with a thread.

在 2.0 版本加入.

Type:

bool

ephemeral[源代码]

Returns True if the source message is ephemeral.

在 2.0 版本加入.

Type:

bool

loading[源代码]

Returns True if the source message is deferred.

The user sees a 'thinking' state.

在 2.0 版本加入.

Type:

bool

failed_to_mention_some_roles_in_thread[源代码]

Returns True if some roles are failed to mention in a thread.

在 2.0 版本加入.

Type:

bool

suppress_notifications[源代码]

Returns True if the source message does not trigger push and desktop notifications.

Users will still receive mentions.

在 2.4 版本加入.

Type:

bool

is_voice_message[源代码]

Returns True if this message is a voice message.

在 2.5 版本加入.

Type:

bool

is_components_v2[源代码]

Returns True if this message has v2 components. This flag disables sending content, embed, and embeds.

在 2.7 版本加入.

Type:

bool

has_snapshot[源代码]

Returns True if this message has a snapshot from message forwarding.

在 2.7 版本加入.

Type:

bool

Attributes
class discord.AttachmentFlags(**kwargs)[源代码]

Wraps up the Discord Attachment flags.

x == y

Checks if two flags are equal.

x != y

Checks if two flags are not equal.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

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.

在 2.5 版本加入.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

is_clip[源代码]

Returns True if the attachment is a clip.

Type:

bool

is_thumbnail[源代码]

Returns True if the attachment is a thumbnail.

Type:

bool

is_remix[源代码]

Returns True if the attachment has been remixed.

Type:

bool

Attributes
Methods
class discord.PublicUserFlags(**kwargs)[源代码]

Wraps up the Discord User Public flags.

x == y

Checks if two PublicUserFlags are equal.

x != y

Checks if two PublicUserFlags are not equal.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

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.

在 1.4 版本加入.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

staff[源代码]

Returns True if the user is a Discord Employee.

Type:

bool

partner[源代码]

Returns True if the user is a Discord Partner.

Type:

bool

hypesquad[源代码]

Returns True if the user is a HypeSquad Events member.

Type:

bool

bug_hunter[源代码]

Returns True if the user is a Bug Hunter

Type:

bool

premium_promo_dismissed[源代码]

Returns True if the user is marked as dismissed Nitro promotion

Type:

bool

hypesquad_bravery[源代码]

Returns True if the user is a HypeSquad Bravery member.

Type:

bool

hypesquad_brilliance[源代码]

Returns True if the user is a HypeSquad Brilliance member.

Type:

bool

hypesquad_balance[源代码]

Returns True if the user is a HypeSquad Balance member.

Type:

bool

early_supporter[源代码]

Returns True if the user is an Early Supporter.

Type:

bool

team_user[源代码]

Returns True if the user is a Team User.

Type:

bool

system[源代码]

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

Type:

bool

bug_hunter_level_2[源代码]

Returns True if the user is a Bug Hunter Level 2

Type:

bool

verified_bot[源代码]

Returns True if the user is a Verified Bot.

Type:

bool

verified_bot_developer[源代码]

Returns True if the user is an Early Verified Bot Developer.

Type:

bool

early_verified_bot_developer[源代码]

An alias for verified_bot_developer.

在 1.5 版本加入.

Type:

bool

discord_certified_moderator[源代码]

Returns True if the user is a Discord Certified Moderator.

在 2.0 版本加入.

Type:

bool

bot_http_interactions[源代码]

Returns True if the bot has set an interactions endpoint url.

在 2.0 版本加入.

Type:

bool

active_developer[源代码]

Returns True if the user is an Active Developer.

在 2.3 版本加入.

Type:

bool

all()[源代码]

List[UserFlags]: Returns all public flags the user has.

返回类型:

list[UserFlags]

Attributes
class discord.ChannelFlags(**kwargs)[源代码]

Wraps up the Discord Channel flags.

x == y

Checks if two ChannelFlags are equal.

x != y

Checks if two ChannelFlags are not equal.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

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.

在 2.0 版本加入.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

pinned[源代码]

Returns True if the thread is pinned to the top of its parent forum channel.

Type:

bool

require_tag[源代码]

Returns True if a tag is required to be specified when creating a thread in a ForumChannel.

在 2.2 版本加入.

Type:

bool

hide_media_download_options[源代码]

Returns True if the embedded media download options are hidden for the media channel posts.

在 2.7 版本加入.

Type:

bool

Attributes
class discord.SKUFlags(**kwargs)[源代码]

Wraps up the Discord SKU flags.

x == y

Checks if two SKUFlags are equal.

x != y

Checks if two SKUFlags are not equal.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

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.

在 2.5 版本加入.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

available[源代码]

Returns True if the SKU is available for purchase.

Type:

bool

guild_subscription[源代码]

Returns True if the SKU is a guild subscription.

Type:

bool

user_subscription[源代码]

Returns True if the SKU is a user subscription.

Type:

bool

Attributes
class discord.MemberFlags(**kwargs)[源代码]

Wraps up the Discord Member flags.

x == y

Checks if two MemberFlags are equal.

x != y

Checks if two MemberFlags are not equal.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

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.

在 2.6 版本加入.

value

The raw value. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

did_rejoin[源代码]

Returns True if the member left and rejoined the guild.

Type:

bool

completed_onboarding[源代码]

Returns True if the member has completed onboarding.

Type:

bool

bypasses_verification[源代码]

Returns True if the member is exempt from verification requirements.

备注

This can be edited through edit().

Type:

bool

started_onboarding[源代码]

Returns True if the member has started onboarding.

Type:

bool

Attributes
class discord.RoleFlags(**kwargs)[源代码]

Wraps up the Discord Role flags.

x == y

Checks if two RoleFlags are equal.

x != y

Checks if two RoleFlags are not equal.

x + y

Adds two flags together. Equivalent to x | y.

x - y

Subtracts two flags from each other.

x | y

Returns the union of two flags. Equivalent to x + y.

x & y

Returns the intersection of two flags.

~x

Returns the inverse of a flag.

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.

在 2.6 版本加入.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available flags. You should query flags via the properties rather than using this raw value.

Type:

int

参数:

kwargs (bool)

in_prompt[源代码]

Returns True if the role is selectable in one of the guild's OnboardingPrompt.

Type:

bool

Colour

Attributes
Methods
class discord.Colour(value)[源代码]

Represents a Colour. This class is similar to a (red, green, blue) tuple.

There is an alias for this called Color.

x == y

Checks if two colours are equal.

x != y

Checks if two colours are not equal.

hash(x)

Return the colour's hash.

str(x)

Returns the hex format for the colour.

int(x)

Returns the raw colour value.

value

The raw integer colour value.

Type:

int

参数:

value (int)

property r: int

Returns the red component of the colour.

property g: int

Returns the green component of the colour.

property b: int

Returns the blue component of the colour.

to_rgb()[源代码]

Returns an (r, g, b) tuple representing the colour.

返回类型:

tuple[int, int, int]

classmethod from_rgb(r, g, b)[源代码]

Constructs a Colour from an RGB tuple.

参数:
返回类型:

Self

classmethod from_hsv(h, s, v)[源代码]

Constructs a Colour from an HSV tuple.

参数:
返回类型:

Self

classmethod default()[源代码]

A factory method that returns a Colour with a value of 0.

返回类型:

Self

classmethod random(*, seed=None)[源代码]

A factory method that returns a Colour with a random hue.

备注

The random algorithm works by choosing a colour with a random hue but with maxed out saturation and value.

在 1.6 版本加入.

参数:

seed (int | str | float | bytes | bytearray | None) --

The seed to initialize the RNG with. If None is passed the default RNG is used.

在 1.7 版本加入.

返回类型:

Self

classmethod teal()[源代码]

A factory method that returns a Colour with a value of 0x1abc9c.

返回类型:

Self

classmethod dark_teal()[源代码]

A factory method that returns a Colour with a value of 0x11806a.

返回类型:

Self

classmethod brand_green()[源代码]

A factory method that returns a Colour with a value of 0x57F287.

在 2.0 版本加入.

返回类型:

Self

classmethod green()[源代码]

A factory method that returns a Colour with a value of 0x2ecc71.

返回类型:

Self

classmethod dark_green()[源代码]

A factory method that returns a Colour with a value of 0x1f8b4c.

返回类型:

Self

classmethod blue()[源代码]

A factory method that returns a Colour with a value of 0x3498db.

返回类型:

Self

classmethod dark_blue()[源代码]

A factory method that returns a Colour with a value of 0x206694.

返回类型:

Self

classmethod purple()[源代码]

A factory method that returns a Colour with a value of 0x9b59b6.

返回类型:

Self

classmethod dark_purple()[源代码]

A factory method that returns a Colour with a value of 0x71368a.

返回类型:

Self

classmethod magenta()[源代码]

A factory method that returns a Colour with a value of 0xe91e63.

返回类型:

Self

classmethod dark_magenta()[源代码]

A factory method that returns a Colour with a value of 0xad1457.

返回类型:

Self

classmethod gold()[源代码]

A factory method that returns a Colour with a value of 0xf1c40f.

返回类型:

Self

classmethod dark_gold()[源代码]

A factory method that returns a Colour with a value of 0xc27c0e.

返回类型:

Self

classmethod orange()[源代码]

A factory method that returns a Colour with a value of 0xe67e22.

返回类型:

Self

classmethod dark_orange()[源代码]

A factory method that returns a Colour with a value of 0xa84300.

返回类型:

Self

classmethod brand_red()[源代码]

A factory method that returns a Colour with a value of 0xED4245.

在 2.0 版本加入.

返回类型:

Self

classmethod red()[源代码]

A factory method that returns a Colour with a value of 0xe74c3c.

返回类型:

Self

classmethod dark_red()[源代码]

A factory method that returns a Colour with a value of 0x992d22.

返回类型:

Self

classmethod lighter_grey()[源代码]

A factory method that returns a Colour with a value of 0x95a5a6.

返回类型:

Self

classmethod lighter_gray()

A factory method that returns a Colour with a value of 0x95a5a6.

返回类型:

Self

classmethod dark_grey()[源代码]

A factory method that returns a Colour with a value of 0x607d8b.

返回类型:

Self

classmethod dark_gray()

A factory method that returns a Colour with a value of 0x607d8b.

返回类型:

Self

classmethod light_grey()[源代码]

A factory method that returns a Colour with a value of 0x979c9f.

返回类型:

Self

classmethod light_gray()

A factory method that returns a Colour with a value of 0x979c9f.

返回类型:

Self

classmethod darker_grey()[源代码]

A factory method that returns a Colour with a value of 0x546e7a.

返回类型:

Self

classmethod darker_gray()

A factory method that returns a Colour with a value of 0x546e7a.

返回类型:

Self

classmethod og_blurple()[源代码]

A factory method that returns a Colour with a value of 0x7289da.

返回类型:

Self

classmethod blurple()[源代码]

A factory method that returns a Colour with a value of 0x5865F2.

返回类型:

Self

classmethod greyple()[源代码]

A factory method that returns a Colour with a value of 0x99aab5.

返回类型:

Self

classmethod light_theme()[源代码]

A factory method that returns a Colour with a value of 0xfbfbfb. This will appear transparent on Discord's light theme.

在 2.8 版本加入.

返回类型:

Self

classmethod ash_theme()[源代码]

A factory method that returns a Colour with a value of 0x323339. This will appear transparent on Discord's ash theme.

在 2.8 版本加入.

返回类型:

Self

classmethod dark_theme()[源代码]

A factory method that returns a Colour with a value of 0x1a1a1e. This will appear transparent on Discord's dark theme.

在 1.5 版本加入.

在 2.8 版本发生变更: Updated to match Discord's new theme colour.

返回类型:

Self

classmethod onyx_theme()[源代码]

A factory method that returns a Colour with a value of 0x070709. This will appear transparent on Discord's onyx theme.

在 2.8 版本加入.

返回类型:

Self

classmethod fuchsia()[源代码]

A factory method that returns a Colour with a value of 0xEB459E.

在 2.0 版本加入.

返回类型:

Self

classmethod yellow()[源代码]

A factory method that returns a Colour with a value of 0xFEE75C.

在 2.0 版本加入.

返回类型:

Self

classmethod nitro_pink()[源代码]

A factory method that returns a Colour with a value of 0xf47fff.

在 2.0 版本加入.

返回类型:

Self

classmethod embed_background(cls, theme='dark')[源代码]

A factory method that returns a Colour corresponding to the embed colours on discord clients, with a value of:

  • 0x2B2D31 (dark)

  • 0xEEEFF1 (light)

  • 0x000000 (amoled).

在 2.0 版本加入.

参数:

theme (str) -- The theme colour to apply, must be one of "dark", "light", or "amoled".

返回类型:

Self

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.

Type:

Optional[int]

name

The name of the activity.

Type:

Optional[str]

url

A stream URL that the activity could be doing.

Type:

Optional[str]

type

The type of activity currently being done.

Type:

ActivityType

state

The user's current party status or text used for a custom status.

Type:

Optional[str]

details

The detail of the user's current activity.

Type:

Optional[str]

timestamps

A dictionary of timestamps. It contains the following optional keys:

  • start: Corresponds to when the user started doing the activity in milliseconds since Unix epoch.

  • end: Corresponds to when the user will finish doing the activity in milliseconds since Unix epoch.

Type:

Dict[str, int]

assets

A dictionary representing the images and their hover text of an activity. It contains the following optional keys:

  • large_image: A string representing the ID for the large image asset.

  • large_text: A string representing the text when hovering over the large image asset.

  • small_image: A string representing the ID for the small image asset.

  • small_text: A string representing the text when hovering over the small image asset.

Type:

Dict[str, str]

party

A dictionary representing the activity party. It contains the following optional keys:

  • id: A string representing the party ID.

  • size: A list of up to two integer elements denoting (current_size, maximum_size).

Type:

Dict[str, Union[str, List[int]]]

buttons

A list of dictionaries representing custom buttons shown in a rich presence. Each dictionary contains the following keys:

  • label: A string representing the text shown on the button.

  • url: A string representing the URL opened upon clicking the button.

备注

Bots cannot access a user's activity button URLs. Therefore, the type of this attribute will be List[str] when received through the gateway.

在 2.0 版本加入.

Type:

Union[List[Dict[str, str]], List[str]]

emoji

The emoji that belongs to this activity.

Type:

Optional[PartialEmoji]

property start: datetime | None

When the user started doing this activity in UTC, if applicable.

property end: datetime | None

When the user will stop doing this activity in UTC, if applicable.

property large_image_url: str | None

Returns a URL pointing to the large image asset of this activity if applicable.

property small_image_url: str | None

Returns a URL pointing to the small image asset of this activity if applicable.

property large_image_text: str | None

Returns the large image asset hover text of this activity if applicable.

property small_image_text: str | None

Returns the small image asset hover text of this activity if applicable.

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.

在 1.3 版本加入.

property created_at: datetime | None

When the user started doing this activity in UTC.

在 1.3 版本加入.

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.

参数:

name (str) -- The game's name.

name

The game's name.

Type:

str

property type: ActivityType

Returns the game's type. This is for compatibility with Activity.

It always returns ActivityType.playing.

property start: datetime | None

When the user started playing this game in UTC, if applicable.

property end: datetime | None

When the user will stop playing this game in UTC, if applicable.

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

在 1.3 版本加入.

Type:

Optional[str]

name

The stream's name.

Type:

Optional[str]

details

An alias for name

Type:

Optional[str]

game

The game being streamed.

在 1.3 版本加入.

Type:

Optional[str]

url

The stream's URL.

Type:

str

assets

A dictionary comprised of similar keys than those in Activity.assets.

Type:

Dict[str, str]

参数:
property type: ActivityType

Returns the game's type. This is for compatibility with Activity.

It always returns ActivityType.streaming.

property twitch_name: str | None

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 this is set by the Discord client.

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.

在 1.3 版本加入.

name

The custom activity's name.

Type:

Optional[str]

emoji

The emoji to pass to the activity, if any.

Type:

Optional[PartialEmoji]

state

The text used for the custom activity.

Type:

Optional[str]

参数:
property type: ActivityType

Returns the activity's type. This is for compatibility with Activity.

It always returns ActivityType.custom.

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.

在 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
x + y

Adds two permissions together. Equivalent to x | y.

x - y

Subtracts two permissions from each other.

x | y

Returns the union of two permissions. Equivalent to x + y.

x & y

Returns the intersection of two permissions.

~x

Returns the inverse of a permission.

Checks if a permission is a strict superset of another permission.

hash(x)

Return the permission's hash.

iter(x)

Returns an iterator of (perm, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

value

The raw value. This value is a bit array field of a 53-bit integer representing the currently available permissions. You should query permissions via the properties rather than using this raw value.

Type:

int

参数:
is_subset(other)[源代码]

Returns True if self has the same or fewer permissions as other.

参数:

other (Permissions)

返回类型:

bool

is_superset(other)[源代码]

Returns True if self has the same or more permissions as other.

参数:

other (Permissions)

返回类型:

bool

is_strict_subset(other)[源代码]

Returns True if the permissions on other are a strict subset of those on self.

参数:

other (Permissions)

返回类型:

bool

is_strict_superset(other)[源代码]

Returns True if the permissions on other are a strict superset of those on self.

参数:

other (Permissions)

返回类型:

bool

classmethod none()[源代码]

A factory method that creates a Permissions with all permissions set to False.

返回类型:

TypeVar(P, bound= Permissions)

classmethod all()[源代码]

A factory method that creates a Permissions with all permissions set to True.

返回类型:

TypeVar(P, bound= Permissions)

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:

在 1.7 版本发生变更: Added stream, priority_speaker and use_slash_commands permissions.

在 2.0 版本发生变更: Added create_public_threads, create_private_threads, manage_threads, use_external_stickers, send_messages_in_threads and request_to_speak permissions.

返回类型:

TypeVar(P, bound= Permissions)

classmethod general()[源代码]

A factory method that creates a Permissions with all "General" permissions from the official Discord UI set to True.

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

在 2.7 版本发生变更: Added view_creator_monetization_analytics permission.

返回类型:

TypeVar(P, bound= Permissions)

classmethod membership()[源代码]

A factory method that creates a Permissions with all "Membership" permissions from the official Discord UI set to True.

在 1.7 版本加入.

返回类型:

TypeVar(P, bound= Permissions)

classmethod text()[源代码]

A factory method that creates a Permissions with all "Text" permissions from the official Discord UI set to True.

在 1.7 版本发生变更: Permission read_messages is no longer part of the text permissions. Added use_slash_commands permission.

在 2.0 版本发生变更: Added create_public_threads, create_private_threads, manage_threads, send_messages_in_threads and use_external_stickers permissions.

返回类型:

TypeVar(P, bound= Permissions)

classmethod voice()[源代码]

A factory method that creates a Permissions with all "Voice" permissions from the official Discord UI set to True.

返回类型:

TypeVar(P, bound= Permissions)

classmethod stage()[源代码]

A factory method that creates a Permissions with all "Stage Channel" permissions from the official Discord UI set to True.

在 1.7 版本加入.

返回类型:

TypeVar(P, bound= Permissions)

classmethod stage_moderator()[源代码]

A factory method that creates a Permissions with all "Stage Moderator" permissions from the official Discord UI set to True.

在 1.7 版本加入.

返回类型:

TypeVar(P, bound= Permissions)

classmethod advanced()[源代码]

A factory method that creates a Permissions with all "Advanced" permissions from the official Discord UI set to True.

在 1.7 版本加入.

返回类型:

TypeVar(P, bound= Permissions)

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.

参数:

**kwargs (bool) -- A list of key/value pairs to bulk update permissions with.

返回类型:

None

create_instant_invite

Returns True if the user can create instant invites.

Type:

bool

kick_members

Returns True if the user can kick users from the guild.

Type:

bool

ban_members

Returns True if a user can ban users from the guild.

Type:

bool

administrator

Returns True if a user is an administrator. This role overrides all other permissions.

This also bypasses all channel-specific overrides.

Type:

bool

manage_channels

Returns True if a user can edit, delete, or create channels in the guild.

This also corresponds to the "Manage Channel" channel-specific override.

Type:

bool

manage_guild

Returns True if a user can edit guild properties.

Type:

bool

add_reactions

Returns True if a user can add reactions to messages.

Type:

bool

view_audit_log

Returns True if a user can view the guild's audit log.

Type:

bool

priority_speaker

Returns True if a user can be more easily heard while talking.

Type:

bool

stream

Returns True if a user can stream in a voice channel.

Type:

bool

view_channel

Returns True if a user can view all or specific channels.

Type:

bool

read_messages[源代码]

An alias for view_channel.

在 1.3 版本加入.

Type:

bool

send_messages

Returns True if a user can send messages from all or specific text channels.

Type:

bool

send_tts_messages

Returns True if a user can send TTS messages from all or specific text channels.

Type:

bool

manage_messages

Returns True if a user can delete messages in a text channel.

警告

Starting from January 12th 2026, this will no longer grant the ability to pin/unpin messages. Use pin_messages instead.

Type:

bool

Returns True if a user's messages will automatically be embedded by Discord.

Type:

bool

attach_files

Returns True if a user can send files in their messages.

Type:

bool

read_message_history

Returns True if a user can read a text channel's previous messages.

Type:

bool

mention_everyone

Returns True if a user's @everyone, @here or role mentions will mention in the text channel.

Type:

bool

external_emojis

Returns True if a user can use emojis from other guilds.

Type:

bool

use_external_emojis[源代码]

An alias for external_emojis.

在 1.3 版本加入.

Type:

bool

view_guild_insights

Returns True if a user can view the guild's insights.

在 1.3 版本加入.

Type:

bool

connect

Returns True if a user can connect to a voice channel.

Type:

bool

speak

Returns True if a user can speak in a voice channel.

Type:

bool

mute_members

Returns True if a user can mute other users.

Type:

bool

deafen_members

Returns True if a user can deafen other users.

Type:

bool

move_members

Returns True if a user can move users between other voice channels.

Type:

bool

use_voice_activation

Returns True if a user can use voice activation in voice channels.

Type:

bool

change_nickname

Returns True if a user can change their nickname in the guild.

Type:

bool

manage_nicknames

Returns True if a user can change other user's nickname in the guild.

Type:

bool

manage_roles

Returns True if a user can create or edit roles less than their role's position.

This also corresponds to the "Manage Permissions" channel-specific override.

Type:

bool

manage_permissions[源代码]

An alias for manage_roles.

在 1.3 版本加入.

Type:

bool

manage_webhooks

Returns True if a user can create, edit, or delete webhooks.

Type:

bool

manage_emojis

Returns True if a user can create, edit, or delete emojis.

Type:

bool

manage_emojis_and_stickers[源代码]

An alias for manage_emojis.

在 2.0 版本加入.

Type:

bool

use_slash_commands

Returns True if a user can use slash commands.

在 1.7 版本加入.

Type:

bool

use_application_commands[源代码]

An alias for use_slash_commands.

在 2.0 版本加入.

Type:

bool

request_to_speak

Returns True if a user can request to speak in a stage channel.

在 1.7 版本加入.

Type:

bool

manage_events

Returns True if a user can manage guild events.

在 2.0 版本加入.

Type:

bool

manage_threads

Returns True if a user can manage threads.

在 2.0 版本加入.

Type:

bool

create_public_threads

Returns True if a user can create public threads.

在 2.0 版本加入.

Type:

bool

create_private_threads

Returns True if a user can create private threads.

在 2.0 版本加入.

Type:

bool

external_stickers

Returns True if a user can use stickers from other guilds.

在 2.0 版本加入.

Type:

bool

use_external_stickers[源代码]

An alias for external_stickers.

在 2.0 版本加入.

Type:

bool

send_messages_in_threads

Returns True if a user can send messages in threads.

在 2.0 版本加入.

Type:

bool

start_embedded_activities

Returns True if a user can launch an activity flagged 'EMBEDDED' in a voice channel.

在 2.0 版本加入.

Type:

bool

moderate_members

Returns True if a user can moderate members (timeout).

在 2.0 版本加入.

Type:

bool

view_creator_monetization_analytics

Returns True if a user can view creator monetization (role subscription) analytics.

在 2.7 版本加入.

Type:

bool

use_soundboard

Returns True if a user can use the soundboard in a voice channel.

在 2.7 版本加入.

Type:

bool

use_external_sounds

Returns True if a user can use external soundboard sounds in a voice channel.

在 2.7 版本加入.

Type:

bool

send_voice_messages

Returns True if a member can send voice messages.

在 2.5 版本加入.

Type:

bool

set_voice_channel_status

Returns True if a member can set voice channel status.

在 2.5 版本加入.

Type:

bool

send_polls

Returns True if a member can send polls.

在 2.6 版本加入.

Type:

bool

use_external_apps

Returns True if a member's user-installed apps can show public responses. Users will still be able to use user-installed apps, but responses will be ephemeral.

This only applies to apps that are also not installed to the guild.

在 2.6 版本加入.

Type:

bool

pin_messages

Returns True if a member can pin/unpin messages.

在 2.7 版本加入.

Type:

bool

bypass_slowmode

Returns True if a user can bypass slowmode.

在 2.7 版本加入.

Type:

bool

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.

参数:

**kwargs (bool | None) -- Set the value of permissions by their name.

pair()[源代码]

Returns the (allow, deny) pair from this overwrite.

返回类型:

tuple[Permissions, Permissions]

classmethod from_pair(allow, deny)[源代码]

Creates an overwrite from an allow/deny pair of Permissions.

参数:
返回类型:

TypeVar(PO, bound= PermissionOverwrite)

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.

返回:

Indicates if the overwrite is empty.

返回类型:

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.

参数:

**kwargs (bool | None) -- A list of key/value pairs to bulk update with.

返回类型:

None

Application Role Connections

class discord.ApplicationRoleConnectionMetadata(*, type, key, name, description, name_localizations=..., description_localizations=...)[源代码]

Represents role connection metadata for a Discord application.

在 2.4 版本加入.

参数:

  • type (ApplicationRoleConnectionMetadataType) -- The type of metadata value.

  • key (str) -- The key for this metadata field. May only be the a-z, 0-9, or _ characters, with a maximum of 50 characters.

  • name (str) -- The name for this metadata field. Maximum 100 characters.

  • description (str) -- The description for this metadata field. Maximum 200 characters.

  • name_localizations (dict[str, str]) -- The name localizations for this metadata field. The values of this should be "locale": "name". See here for a list of valid locales.

  • description_localizations (dict[str, str]) --

    The description localizations for this metadata field. The values of this should be "locale": "name". See here for a list of valid locales.