Application Commands¶

Command Permission Decorators¶

@discord.commands.default_permissions(**perms)[source]¶

A decorator that limits the usage of an application command to members with certain permissions.

The permissions passed in must be exactly like the properties shown under discord.Permissions.

Note

These permissions can be updated by server administrators per-guild. As such, these are only “defaults”, as the name suggests. If you want to make sure that a user always has the specified permissions regardless, you should use an internal check such as has_permissions().

Parameters:: **perms (Dict[str, bool]) – An argument list of permissions to check for.
Return type:: Callable

Example

from discord import default_permissions

@bot.slash_command()
@default_permissions(manage_messages=True)
async def test(ctx):
    await ctx.respond("You can manage messages.")

@discord.commands.guild_only[source]¶

A decorator that limits the usage of an application command to guild contexts. The command won’t be able to be used in private message channels.

Return type:: Callable

Example

from discord import guild_only

@bot.slash_command()
@guild_only()
async def test(ctx):
    await ctx.respond("You're in a guild.")

@discord.commands.is_nsfw[source]¶

A decorator that limits the usage of an application command to 18+ channels and users. In guilds, the command will only be able to be used in channels marked as NSFW. In DMs, users must have opted into age-restricted commands via privacy settings.

Note that apps intending to be listed in the App Directory cannot have NSFW commands.

Return type:: Callable

Example

from discord import is_nsfw

@bot.slash_command()
@is_nsfw()
async def test(ctx):
    await ctx.respond("This command is age restricted.")

Commands¶

Shortcut Decorators¶

@discord.commands.application_command(cls=<class 'discord.commands.core.SlashCommand'>, **attrs)[source]¶

A decorator that transforms a function into an ApplicationCommand. More specifically, usually one of SlashCommand, UserCommand, or MessageCommand. The exact class depends on the cls parameter. By default, the description attribute is received automatically from the docstring of the function and is cleaned up with the use of inspect.cleandoc. If the docstring is bytes, then it is decoded into str using utf-8 encoding. The name attribute also defaults to the function name unchanged.

Added in version 2.0.

Parameters:

cls (ApplicationCommand) – The class to construct with. By default, this is SlashCommand. You usually do not change this.
attrs – Keyword arguments to pass into the construction of the class denoted by cls.

Returns:

A decorator that converts the provided method into an ApplicationCommand, or subclass of it.

Return type:

Callable[…, ApplicationCommand]

Raises:

TypeError – If the function is not a coroutine or is already a command.

@discord.commands.command(**kwargs)[source]¶

An alias for application_command().

Note

This decorator is overridden by ext.commands.command().

Added in version 2.0.

Returns:: A decorator that converts the provided method into an ApplicationCommand.
Return type:: Callable[…, ApplicationCommand]

@discord.commands.slash_command(**kwargs)[source]¶

Decorator for slash commands that invokes application_command().

Added in version 2.0.

Returns:: A decorator that converts the provided method into a SlashCommand.
Return type:: Callable[…, SlashCommand]

@discord.commands.user_command(**kwargs)[source]¶

Decorator for user commands that invokes application_command().

Added in version 2.0.

Returns:: A decorator that converts the provided method into a UserCommand.
Return type:: Callable[…, UserCommand]

@discord.commands.message_command(**kwargs)[source]¶

Decorator for message commands that invokes application_command().

Added in version 2.0.

Returns:: A decorator that converts the provided method into a MessageCommand.
Return type:: Callable[…, MessageCommand]

Objects¶

Attributes

full_parent_name
qualified_id
qualified_name

Methods

@after_invoke
@before_invoke
@error
defget_cooldown_retry_after
defhas_error_handler
defis_on_cooldown
defreset_cooldown

class discord.ApplicationCommand(func, **kwargs)[source]¶

Parameters:: func (Callable)

is_on_cooldown(ctx)[source]¶

Checks whether the command is currently on cooldown.

Note

This uses the current time instead of the interaction time.

Parameters:: ctx (ApplicationContext) – The invocation context to use when checking the command’s cooldown status.
Returns:: A boolean indicating if the command is on cooldown.
Return type:: bool

reset_cooldown(ctx)[source]¶

Resets the cooldown on this command.

Parameters:: ctx (ApplicationContext) – The invocation context to reset the cooldown under.
Return type:: None

get_cooldown_retry_after(ctx)[source]¶

Retrieves the amount of seconds before this command can be tried again.

Note

This uses the current time instead of the interaction time.

Parameters:: ctx (ApplicationContext) – The invocation context to retrieve the cooldown from.
Returns:: The amount of time left on this command’s cooldown in seconds. If this is 0.0 then the command isn’t on cooldown.
Return type:: float

error(coro)[source]¶

A decorator that registers a coroutine as a local error handler.

A local error handler is an on_command_error() event limited to a single command. However, the on_command_error() is still invoked afterwards as the catch-all.

Parameters:: coro (coroutine) – The coroutine to register as the local error handler.
Raises:: TypeError – The coroutine passed is not actually a coroutine.

has_error_handler()[source]¶

Checks whether the command has an error handler registered.

Return type:: bool

before_invoke(coro)[source]¶

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

This pre-invoke hook takes a sole parameter, an ApplicationContext. See Bot.before_invoke() for more info.

Parameters:: coro (coroutine) – The coroutine to register as the pre-invoke hook.
Raises:: TypeError – The coroutine passed is not actually a coroutine.

after_invoke(coro)[source]¶

A decorator that registers a coroutine as a post-invoke hook. A post-invoke hook is called directly after the command is called. This makes it a useful function to clean-up database connections or any type of clean up required.

This post-invoke hook takes a sole parameter, an ApplicationContext. See Bot.after_invoke() for more info.

Parameters:: coro (coroutine) – The coroutine to register as the post-invoke hook.
Raises:: TypeError – The coroutine passed is not actually a coroutine.

property full_parent_name: str¶

Retrieves the fully qualified parent command name.

This the base command name required to execute it. For example, in /one two three the parent name would be one two.

property qualified_name: str¶

Retrieves the fully qualified command name.

This is the full parent name with the command name as well. For example, in /one two three the qualified name would be one two three.

property qualified_id: int¶

Retrieves the fully qualified command ID.

This is the root parent ID. For example, in /one two three the qualified ID would return one.id.

Attributes

callback
checks
cog
contexts
cooldown
default_member_permissions
description
description_localizations
guild_ids
guild_only
integration_types
mention
name
name_localizations
nsfw
options
parent

Methods

defcopy

class discord.SlashCommand(func, *args, **kwargs)[source]¶

A class that implements the protocol for a slash command.

These are not created manually, instead they are created via the decorator or functional interface.

Added in version 2.0.

name¶

The name of the command.

Type:: str

callback¶

The coroutine that is executed when the command is called.

Type:: coroutine

description¶

The description for the command.

Type:: Optional[str]

guild_ids¶

The ids of the guilds where this command will be registered.

Type:: Optional[List[int]]

options¶

The parameters for this command.

Type:: List[Option]

parent¶

The parent group that this command belongs to. None if there isn’t one.

Type:: Optional[SlashCommandGroup]

mention¶

Returns a string that allows you to mention the slash command.

Type:: str

guild_only¶

Whether the command should only be usable inside a guild.

Deprecated since version 2.6: Use the contexts parameter instead.

Type:: bool

nsfw¶

Whether the command should be restricted to 18+ channels and users. Apps intending to be listed in the App Directory cannot have NSFW commands.

Type:: bool

default_member_permissions¶

The default permissions a member needs to be able to run the command.

Type:: Permissions

cog¶

The cog that this command belongs to. None if there isn’t one.

Type:: Optional[Cog]

checks¶

A list of predicates that verifies if the command could be executed with the given ApplicationContext as the sole parameter. If an exception is necessary to be thrown to signal failure, then one inherited from ApplicationCommandError should be used. Note that if the checks fail then CheckFailure exception is raised to the on_application_command_error() event.

Type:: List[Callable[[ApplicationContext], bool]]

cooldown¶

The cooldown applied when the command is invoked. None if the command doesn’t have a cooldown.

Type:: Optional[Cooldown]

name_localizations¶

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

Type:: Dict[str, str]

description_localizations¶

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

Type:: Dict[str, str]

integration_types¶

The type of installation this command should be available to. For instance, if set to IntegrationType.user_install, the command will only be available to users with the application installed on their account. Unapplicable for guild commands.

Type:: Set[IntegrationType]

contexts¶

The location where this command can be used. Cannot be set if this is a guild command.

Type:: Set[InteractionContextType]

Parameters:: func (Callable)

copy()[source]¶

Creates a copy of this command.

Returns:: A new instance of this command.
Return type:: SlashCommand

Attributes

checks
contexts
default_member_permissions
description
description_localizations
guild_ids
guild_only
integration_types
name
name_localizations
nsfw
parent

Methods

defcopy
defcreate_subgroup
@subgroup
defwalk_commands

class discord.SlashCommandGroup(name, description=None, guild_ids=None, parent=None, cooldown=None, max_concurrency=None, **kwargs)[source]¶

A class that implements the protocol for a slash command group.

These can be created manually, but they should be created via the decorator or functional interface.

name¶

The name of the command.

Type:: str

description¶

The description for the command.

Type:: Optional[str]

guild_ids¶

The ids of the guilds where this command will be registered.

Type:: Optional[List[int]]

parent¶

The parent group that this group belongs to. None if there isn’t one.

Type:: Optional[SlashCommandGroup]

guild_only¶

Whether the command should only be usable inside a guild.

Deprecated since version 2.6: Use the contexts parameter instead.

Type:: bool

nsfw¶

Whether the command should be restricted to 18+ channels and users. Apps intending to be listed in the App Directory cannot have NSFW commands.

Type:: bool

default_member_permissions¶

The default permissions a member needs to be able to run the command.

Type:: Permissions

checks¶

Type:: List[Callable[[ApplicationContext], bool]]

name_localizations¶

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

Type:: Dict[str, str]

description_localizations¶

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

Type:: Dict[str, str]

integration_types¶

Type:: Set[IntegrationType]

contexts¶

The location where this command can be used. Unapplicable for guild commands.

Type:: Set[InteractionContextType]

Parameters:

name (str)
description (str | None)
guild_ids (list[int] | None)
parent (SlashCommandGroup | None)
cooldown (CooldownMapping | None)
max_concurrency (MaxConcurrency | None)

create_subgroup(name, description=None, guild_ids=None, **kwargs)[source]¶

Creates a new subgroup for this SlashCommandGroup.

Parameters:

name (str) – The name of the group to create.
description (Optional[str]) – The description of the group to create.
guild_ids (Optional[List[int]]) – A list of the IDs of each guild this group should be added to, making it a guild command. This will be a global command if None is passed.
guild_only (bool) – Whether the command should only be usable inside a guild.
nsfw (bool) – Whether the command should be restricted to 18+ channels and users. Apps intending to be listed in the App Directory cannot have NSFW commands.
default_member_permissions (Permissions) – The default permissions a member needs to be able to run the command.
checks (List[Callable[[ApplicationContext], bool]]) – A list of predicates that verifies if the command could be executed with the given ApplicationContext as the sole parameter. If an exception is necessary to be thrown to signal failure, then one inherited from ApplicationCommandError should be used. Note that if the checks fail then CheckFailure exception is raised to the on_application_command_error() event.
name_localizations (Dict[str, str]) –
The name localizations for this command. 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 command. The values of this should be "locale": "description". See here for a list of valid locales.

Returns:

The slash command group that was created.

Return type:

SlashCommandGroup

subgroup(name=None, description=None, guild_ids=None)[source]¶

A shortcut decorator that initializes the provided subclass of SlashCommandGroup as a subgroup.

Added in version 2.0.

Parameters:

name (Optional[str]) – The name of the group to create. This will resolve to the name of the decorated class if None is passed.
description (Optional[str]) – The description of the group to create.
guild_ids (Optional[List[int]]) – A list of the IDs of each guild this group should be added to, making it a guild command. This will be a global command if None is passed.

Returns:

The slash command group that was created.

Return type:

Callable[[Type[SlashCommandGroup]], SlashCommandGroup]

for ... in walk_commands()[source]¶

An iterator that recursively walks through all slash commands and groups in this group.

Yields:: SlashCommand | SlashCommandGroup – A nested slash command or slash command group from the group.
Return type:: Generator[SlashCommand | SlashCommandGroup, None, None]

copy()[source]¶

Creates a copy of this command group.

Returns:: A new instance of this command group.
Return type:: SlashCommandGroup

Attributes

callback
checks
cog
contexts
cooldown
default_member_permissions
guild_ids
guild_only
integration_types
name
name_localizations
nsfw

Methods

defcopy

class discord.UserCommand(func, *args, **kwargs)[source]¶

A class that implements the protocol for user context menu commands.

These are not created manually, instead they are created via the decorator or functional interface.

name¶

The name of the command.

Type:: str

callback¶

The coroutine that is executed when the command is called.

Type:: coroutine

guild_ids¶

The ids of the guilds where this command will be registered.

Type:: Optional[List[int]]

guild_only¶

Whether the command should only be usable inside a guild.

Deprecated since version 2.6: Use the contexts parameter instead.

Type:: bool

nsfw¶

Whether the command should be restricted to 18+ channels and users. Apps intending to be listed in the App Directory cannot have NSFW commands.

Type:: bool

default_member_permissions¶

The default permissions a member needs to be able to run the command.

Type:: Permissions

cog¶

The cog that this command belongs to. None if there isn’t one.

Type:: Optional[Cog]

checks¶

Type:: List[Callable[[ApplicationContext], bool]]

cooldown¶

The cooldown applied when the command is invoked. None if the command doesn’t have a cooldown.

Type:: Optional[Cooldown]

name_localizations¶

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

Type:: Dict[str, str]

integration_types¶

The installation contexts where this command is available. Unapplicable for guild commands.

Type:: Set[IntegrationType]

contexts¶

The interaction contexts where this command is available. Unapplicable for guild commands.

Type:: Set[InteractionContextType]

Parameters:: func (Callable)

copy()[source]¶

Creates a copy of this command.

Returns:: A new instance of this command.
Return type:: UserCommand

Attributes

callback
checks
cog
contexts
cooldown
default_member_permissions
guild_ids
guild_only
integration_types
name
name_localizations
nsfw

Methods

defcopy

class discord.MessageCommand(func, *args, **kwargs)[source]¶

A class that implements the protocol for message context menu commands.

These are not created manually, instead they are created via the decorator or functional interface.

name¶

The name of the command.

Type:: str

callback¶

The coroutine that is executed when the command is called.

Type:: coroutine

guild_ids¶

The ids of the guilds where this command will be registered.

Type:: Optional[List[int]]

guild_only¶

Whether the command should only be usable inside a guild.

Deprecated since version 2.6: Use the contexts parameter instead.

Type:: bool

nsfw¶

Whether the command should be restricted to 18+ channels and users. Apps intending to be listed in the App Directory cannot have NSFW commands.

Type:: bool

default_member_permissions¶

The default permissions a member needs to be able to run the command.

Type:: Permissions

cog¶

The cog that this command belongs to. None if there isn’t one.

Type:: Optional[Cog]

checks¶

Type:: List[Callable[[ApplicationContext], bool]]

cooldown¶

The cooldown applied when the command is invoked. None if the command doesn’t have a cooldown.

Type:: Optional[Cooldown]

name_localizations¶

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

Type:: Dict[str, str]

integration_types¶

The installation contexts where this command is available. Unapplicable for guild commands.

Type:: Set[IntegrationType]

contexts¶

The interaction contexts where this command is available. Unapplicable for guild commands.

Type:: Set[InteractionContextType]

Parameters:: func (Callable)

copy()[source]¶

Creates a copy of this command.

Returns:: A new instance of this command.
Return type:: MessageCommand

Options¶

Objects¶

Attributes

channel_types
choices
default
description
description_localizations
input_type
max_length
max_value
min_length
min_value
name
name_localizations
required

class discord.Option(name: str, input_type: type[T] = str, *, choices: Sequence[OptionChoice[T]], description: str | None = None, channel_types: None = None, required: bool = ..., default: Any | Undefined = ..., min_value: None = None, max_value: None = None, min_length: None = None, max_length: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)[source]¶

class discord.Option(name: str, input_type: type[GuildChannel | Thread] | Literal[SlashCommandOptionType.channel] = SlashCommandOptionType.channel, *, choices: None = None, description: str | None = None, channel_types: Sequence[ChannelType] | None = None, required: bool = ..., default: Any | Undefined = ..., min_value: None = None, max_value: None = None, min_length: None = None, max_length: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

class discord.Option(name: str, input_type: type[str] | Literal[SlashCommandOptionType.string] = str, *, description: str | None = None, choices: None = None, channel_types: None = None, required: Literal[True], default: Undefined = MISSING, min_length: int | None = None, max_length: int | None = None, min_value: None = None, max_value: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

class discord.Option(name: str, input_type: type[str] | Literal[SlashCommandOptionType.string] = str, *, description: str | None = None, choices: None = None, channel_types: None = None, required: bool = False, default: Any, min_length: int | None = None, max_length: int | None = None, min_value: None = None, max_value: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

class discord.Option(name: str, input_type: type[int] | Literal[SlashCommandOptionType.integer], *, description: str | None = None, choices: None = None, channel_types: None = None, required: Literal[True], default: Undefined = MISSING, min_value: int | None = None, max_value: int | None = None, min_length: None = None, max_length: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

class discord.Option(name: str, input_type: type[int] | Literal[SlashCommandOptionType.integer], *, description: str | None = None, choices: None = None, channel_types: None = None, required: bool = False, default: Any, min_value: int | None = None, max_value: int | None = None, min_length: None = None, max_length: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

class discord.Option(name: str, input_type: type[float] | Literal[SlashCommandOptionType.number], *, description: str | None = None, choices: None = None, channel_types: None = None, required: Literal[True], default: Undefined = MISSING, min_value: int | float | None = None, max_value: int | float | None = None, min_length: None = None, max_length: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

class discord.Option(name: str, input_type: type[float] | Literal[SlashCommandOptionType.number], *, description: str | None = None, choices: None = None, channel_types: None = None, required: bool = False, default: Any, min_value: int | float | None = None, max_value: int | float | None = None, min_length: None = None, max_length: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

class discord.Option(name: str, input_type: type[str | int | float] = str, *, description: str | None = None, choices: None = None, channel_types: None = None, required: Literal[True], default: Undefined = MISSING, min_value: None = None, max_value: None = None, min_length: None = None, max_length: None = None, autocomplete: ApplicationCommandOptionAutocomplete, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None)

class discord.Option(name: str, input_type: type[str | int | float] = str, *, description: str | None = None, choices: None = None, channel_types: None = None, required: bool = False, default: Any, min_value: None = None, max_value: None = None, min_length: None = None, max_length: None = None, autocomplete: ApplicationCommandOptionAutocomplete, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None)

class discord.Option(name: str, input_type: type[T] = str, *, description: str | None = None, choices: None = None, channel_types: None = None, required: Literal[True], default: Undefined = MISSING, min_value: None = None, max_value: None = None, min_length: None = None, max_length: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

class discord.Option(name: str, input_type: type[T] = str, *, description: str | None = None, choices: None = None, channel_types: None = None, required: bool = False, default: Any, min_value: None = None, max_value: None = None, min_length: None = None, max_length: None = None, name_localizations: dict[str, str] | None = None, description_localizations: dict[str, str] | None = None, autocomplete: None = None)

Represents a selectable option for a slash command.

input_type¶

The type of input that is expected for this option. This can be a SlashCommandOptionType, an associated class, a channel type, a Converter, a converter class or an enum.Enum. If a enum.Enum is used and it has up to 25 values, choices will be automatically filled. If the enum.Enum has more than 25 values, autocomplete will be implemented with discord.utils.basic_autocomplete() instead.

Type:: Union[Type[str], Type[bool], Type[int], Type[float], Type[abc.GuildChannel], Type[Thread], Type[Member], Type[User], Type[Attachment], Type[Role], Type[abc.Mentionable], SlashCommandOptionType, Type[ext.commands.Converter], Type[enums.Enum], Type[Enum]]

name¶

The name of this option visible in the UI. Inherits from the variable name if not provided as a parameter.

Type:: str

description¶

The description of this option. Must be 100 characters or fewer. If input_type is a enum.Enum and description is not specified, input_type’s docstring will be used.

Type:: Optional[str]

choices¶

The list of available choices for this option. Can be a list of values or OptionChoice objects (which represent a name:value pair). If provided, the input from the user must match one of the choices in the list.

Type:: Optional[List[Union[Any, OptionChoice]]]

required¶

Whether this option is required.

Type:: Optional[bool]

default¶

The default value for this option. If provided, required will be considered False.

Type:: Optional[Any]

min_value¶

The minimum value that can be entered. Only applies to Options with an input_type of int or float.

Type:: Optional[int]

max_value¶

The maximum value that can be entered. Only applies to Options with an input_type of int or float.

Type:: Optional[int]

min_length¶

The minimum length of the string that can be entered. Must be between 0 and 6000 (inclusive). Only applies to Options with an input_type of str.

Type:: Optional[int]

max_length¶

The maximum length of the string that can be entered. Must be between 1 and 6000 (inclusive). Only applies to Options with an input_type of str.

Type:: Optional[int]

channel_types¶

A list of channel types that can be selected in this option. Only applies to Options with an input_type of discord.SlashCommandOptionType.channel. If this argument is used, input_type will be ignored.

Type:: list[discord.ChannelType] | None

name_localizations¶

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

Type:: Dict[str, str]

description_localizations¶

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

Type:: Dict[str, str]

Examples

Basic usage:

@bot.slash_command(guild_ids=[...])
async def hello(
    ctx: discord.ApplicationContext,
    name: Option(str, "Enter your name"),
    age: Option(int, "Enter your age", min_value=1, max_value=99, default=18),
    # passing the default value makes an argument optional
    # you also can create optional argument using:
    # age: Option(int, "Enter your age") = 18
):
    await ctx.respond(f"Hello! Your name is {name} and you are {age} years old.")

Added in version 2.0.

Parameters:

name (str)
input_type (type[str | bool | int | float | GuildChannel | Thread | Member | User | Attachment | Role | Mentionable] | SlashCommandOptionType | type[TypeVar(T, bound= str | int | float)])
description (str | None)
choices (Optional[Sequence[OptionChoice[TypeVar(T, bound= str | int | float)]]])
channel_types (Optional[Sequence[ChannelType]])
required (bool)
default (Any | Undefined)
min_value (int | float | None)
max_value (int | float | None)
min_length (int | None)
max_length (int | None)
name_localizations (dict[str, str] | None)
description_localizations (dict[str, str] | None)
autocomplete (ApplicationCommandOptionAutocomplete | None)

class discord.ThreadOption(thread_type)[source]¶

Represents a class that can be passed as the input_type for an Option class.

Added in version 2.0.

Parameters:: thread_type (Literal["public", "private", "news"]) – The thread type to expect for this options input.

Attributes

name
name_localizations
value

class discord.OptionChoice(name, value=None, name_localizations=None)[source]¶

Represents a name:value pairing for a selected Option.

Added in version 2.0.

name¶

The name of the choice. Shown in the UI when selecting an option.

Type:: str

value¶

The value of the choice. If not provided, will use the value of name.

Type:: str | int | float

name_localizations¶

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

Type:: dict[str, str]

Parameters:

name (str)
value (Optional[TypeVar(T, bound= str | int | float)])
name_localizations (dict[str, str] | None)