hikari.commands#
Models and enums used for application commands on Discord.
Represents the choices set for an application command's argument.
class-attribute instance-attribute #
The choice's name (inclusively between 1-100 characters).
Represents an application command's argument.
class-attribute instance-attribute #
Whether this option has autocomplete.
class-attribute instance-attribute #
The channel types that this option will accept.
If None, then all channel types will be accepted.
class-attribute instance-attribute #
choices: Optional[Sequence[CommandChoice]] = field(default=None, repr=False)
A sequence of up to (and including) 25 choices for this command.
This will be None if the input values for this option aren't limited to specific values or if it's a subcommand or subcommand-group type option.
class-attribute instance-attribute #
The command option's description.
Note
This will be inclusively between 1-100 characters in length.
class-attribute instance-attribute #
description_localizations: Mapping[Union[Locale, str], str] = field(eq=False, factory=dict, hash=False, repr=False)
A mapping of description localizations for this option.
class-attribute instance-attribute #
Whether this command option is required.
class-attribute instance-attribute #
The maximum length permitted (inclusive).
This is only valid for hikari.commands.OptionType.STRING, otherwise it will be None.
class-attribute instance-attribute #
The maximum value permitted (inclusive).
This will be int if the type of the option is hikari.commands.OptionType.INTEGER and float if the type is hikari.commands.OptionType.FLOAT.
class-attribute instance-attribute #
The minimum length permitted (inclusive).
This is only valid for hikari.commands.OptionType.STRING, otherwise it will be None.
class-attribute instance-attribute #
The minimum value permitted (inclusive).
This will be int if the type of the option is hikari.commands.OptionType.INTEGER and float if the type is hikari.commands.OptionType.FLOAT.
class-attribute instance-attribute #
The command option's name.
Note
This will match the regex ^[-_\p{L}\p{N}\p{sc=Deva}\p{sc=Thai}]{1,32}$ in Unicode mode and will be lowercase.
class-attribute instance-attribute #
name_localizations: Mapping[Union[Locale, str], str] = field(eq=False, factory=dict, hash=False, repr=False)
A mapping of name localizations for this option.
class-attribute instance-attribute #
options: Optional[Sequence[CommandOption]] = field(default=None, repr=False)
Sequence of up to (and including) 25 of the options for this command option.
class-attribute instance-attribute #
type: Union[OptionType, int] = field(repr=True)
The type of command option this is.
Representation of a permission which enables or disables a command for a user or role.
class-attribute instance-attribute #
Whether this permission marks the target entity as having access to the command.
class-attribute instance-attribute #
ID of the role or user this permission changes the permission's state for.
There are some special constants for this field:
- If equals to
guild_id, then it applies to all members in a guild. - If equals to (
guild_id- 1), then it applies to all channels in a guild.
class-attribute instance-attribute #
type: Union[CommandPermissionType, int] = field(converter=CommandPermissionType)
The entity this permission overrides the command's state for.
Bases: int, Enum
The type of entity a command permission targets.
class-attribute instance-attribute #
CHANNEL = 3
A command permission which toggles access in a specific channel.
class-attribute instance-attribute #
ROLE = 1
A command permission which toggles access for a specific role.
class-attribute instance-attribute #
USER = 2
A command permission which toggles access for a specific user.
Representation of the permissions set for a command within a guild.
class-attribute instance-attribute #
ID of the application the relevant command belongs to.
class-attribute instance-attribute #
ID of the command these permissions are for.
class-attribute instance-attribute #
ID of the guild these permissions are in.
class-attribute instance-attribute #
ID of the entity these permissions apply to.
This may be the ID of a specific command or the application ID. When this is equal to application_id, the permissions apply to all commands that do not contain explicit overwrites.
class-attribute instance-attribute #
permissions: Sequence[CommandPermission] = field()
Sequence of up to (and including) 100 of the command permissions set in this guild.
Bases: int, Enum
The type of a command option.
class-attribute instance-attribute #
ATTACHMENT = 11
Denotes a command option where the value will be an attachment.
class-attribute instance-attribute #
BOOLEAN = 5
Denotes a command option where the value will be a bool.
class-attribute instance-attribute #
CHANNEL = 7
Denotes a command option where the value will be resolved to a channel.
class-attribute instance-attribute #
FLOAT = 10
Denotes a command option where the value will be a float.
This is range limited between -2^53 and 2^53.
class-attribute instance-attribute #
INTEGER = 4
Denotes a command option where the value will be a int.
This is range limited between -2^53 and 2^53.
class-attribute instance-attribute #
MENTIONABLE = 9
Denotes a command option where the value will be a snowflake ID.
class-attribute instance-attribute #
ROLE = 8
Denotes a command option where the value will be resolved to a role.
class-attribute instance-attribute #
STRING = 3
Denotes a command option where the value will be a string.
class-attribute instance-attribute #
SUB_COMMAND = 1
Denotes a command option where the value will be a sub command.
class-attribute instance-attribute #
SUB_COMMAND_GROUP = 2
Denotes a command option where the value will be a sub command group.
class-attribute instance-attribute #
USER = 6
Denotes a command option where the value will be resolved to a user.
Bases: Unique
Represents any application command on Discord.
class-attribute instance-attribute #
Client application that models may use for procedures.
class-attribute instance-attribute #
ID of the application this command belongs to.
class-attribute instance-attribute #
default_member_permissions: Permissions = field(eq=False, hash=False, repr=True)
Member permissions necessary to utilize this command by default.
This excludes administrators of the guild and overwrites.
class-attribute instance-attribute #
ID of the guild this command is in.
This will be None if this is a global command.
class-attribute instance-attribute #
ID of this entity.
class-attribute instance-attribute #
Whether this command is enabled in DMs with the bot.
class-attribute instance-attribute #
Whether this command is age-restricted.
class-attribute instance-attribute #
The command's name.
Note
This will match the regex ^[-_\p{L}\p{N}\p{sc=Deva}\p{sc=Thai}]{1,32}$ in Unicode mode and will be lowercase.
class-attribute instance-attribute #
A mapping of name localizations for this command.
class-attribute instance-attribute #
type: CommandType = field(hash=True, repr=True)
The type of a command.
class-attribute instance-attribute #
Auto-incrementing version identifier updated during substantial record changes.
async #
delete() -> None
Delete this command.
| RAISES | DESCRIPTION |
|---|---|
ForbiddenError | If you cannot access the application's commands. |
NotFoundError | If the application or command isn't found. |
UnauthorizedError | If you are unauthorized to make the request (invalid/missing token). |
RateLimitTooLongError | Raised in the event that a rate limit occurs that is longer than |
InternalServerError | If an internal error occurs on Discord while handling the request. |
async #
edit(*, name: UndefinedOr[str] = undefined.UNDEFINED, description: UndefinedOr[str] = undefined.UNDEFINED, options: UndefinedOr[Sequence[CommandOption]] = undefined.UNDEFINED) -> PartialCommand
Edit this command.
| PARAMETER | DESCRIPTION |
|---|---|
name | The name to set for the command. Leave as TYPE: |
description | The description to set for the command. Leave as TYPE: |
options | A sequence of up to 10 options to set for this command. Leave this as TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
PartialCommand | The edited command object. |
| RAISES | DESCRIPTION |
|---|---|
ForbiddenError | If you cannot access the application's commands. |
NotFoundError | If the application or command isn't found. |
BadRequestError | If any of the fields that are passed have an invalid value. |
UnauthorizedError | If you are unauthorized to make the request (invalid/missing token). |
RateLimitTooLongError | Raised in the event that a rate limit occurs that is longer than |
InternalServerError | If an internal error occurs on Discord while handling the request. |
async #
fetch_guild_permissions(guild: SnowflakeishOr[PartialGuild]) -> GuildCommandPermissions
Fetch the permissions registered for this command in a specific guild.
| PARAMETER | DESCRIPTION |
|---|---|
guild | Object or ID of the guild to fetch the command permissions for. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
GuildCommandPermissions | Object of the command permissions set for the specified command. |
| RAISES | DESCRIPTION |
|---|---|
ForbiddenError | If you cannot access the provided application's commands or guild. |
NotFoundError | If the provided application or command isn't found. |
UnauthorizedError | If you are unauthorized to make the request (invalid/missing token). |
RateLimitTooLongError | Raised in the event that a rate limit occurs that is longer than |
InternalServerError | If an internal error occurs on Discord while handling the request. |
async #
fetch_self() -> PartialCommand
Fetch an up-to-date version of this command object.
| RETURNS | DESCRIPTION |
|---|---|
PartialCommand | Object of the fetched command. |
| RAISES | DESCRIPTION |
|---|---|
ForbiddenError | If you cannot access the target command. |
NotFoundError | If the command isn't found. |
UnauthorizedError | If you are unauthorized to make the request (invalid/missing token). |
RateLimitTooLongError | Raised in the event that a rate limit occurs that is longer than |
InternalServerError | If an internal error occurs on Discord while handling the request. |
async #
set_guild_permissions(guild: SnowflakeishOr[PartialGuild], permissions: Sequence[CommandPermission]) -> GuildCommandPermissions
Set permissions for this command in a specific guild.
Note
This overwrites any previously set permissions.
| PARAMETER | DESCRIPTION |
|---|---|
guild | Object or ID of the guild to set the command permissions in. TYPE: |
permissions | Sequence of up to 10 of the permission objects to set. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
GuildCommandPermissions | Object of the set permissions. |
| RAISES | DESCRIPTION |
|---|---|
ForbiddenError | If you cannot access the provided application's commands or guild. |
NotFoundError | If the provided application or command isn't found. |
UnauthorizedError | If you are unauthorized to make the request (invalid/missing token). |
RateLimitTooLongError | Raised in the event that a rate limit occurs that is longer than |
InternalServerError | If an internal error occurs on Discord while handling the request. |
Bases: PartialCommand
Represents a slash command on Discord.
class-attribute instance-attribute #
The command's description.
None if this command is not a slash command.
Note
This will be inclusively between 1-100 characters in length.
class-attribute instance-attribute #
description_localizations: Mapping[Union[Locale, str], str] = field(eq=False, hash=False, repr=False)
A set of description localizations for this command.
class-attribute instance-attribute #
options: Optional[Sequence[CommandOption]] = field(eq=False, hash=False, repr=False)
Sequence of up to (and including) 25 of the options for this command.