nyxx_interactions library
Classes
- ArgChoiceBuilder
- A specified choice for a slash command argument.
- ButtonBuilder
- Button which will generate event when clicked.
- ChannelMultiSelectBuilder
-
Builder to create select menu with
IChannels inside of it. - CommandOptionBuilder
- An argument for a SlashCommandBuilder.
- CommandOptionType
- The type that a user should input for a CommandOptionBuilder
- CommandPermissionBuilderAbstract
- Used to define permissions for a particular command.
- ComponentMessageBuilder
-
Extended
MessageBuilderwith support for buttons - ComponentRowBuilder
- Helper builder to provide fluid api for building component rows
- IArgChoice
- IAutocompleteInteractionEvent
- IButtonInteraction
- IButtonInteractionEvent
- IChannelMultiSelectInteraction
- IChannelMultiSelectInteractionEvent
- ICommandOption
- ICommandsSync
- Used to make multiple methods of checking if the slash commands have been edited since last update
- IComponentInteraction
-
IComponentInteractionEvent<
T extends IComponentInteraction> - IEventController
- IInteraction
- IInteractionDataResolved
-
IInteractionEvent<
T extends IInteraction> -
IInteractionEventWithAcknowledge<
T extends IInteraction> - IInteractionOption
- IInteractions
- IInteractionsEndpoints
- IInteractionSlashDataResolved
- IMentionableMultiSelectInteraction
- IMentionableMultiSelectInteractionEvent
- IModalInteraction
- IModalInteractionEvent
- IMultiselectInteraction
- IMultiselectInteractionEvent
- InteractionBackend
-
InteractionEventAbstract<
T extends IInteraction> -
InteractionEventWithAcknowledge<
T extends IInteraction> - IPartialChannel
- IResolvedSelectInteraction
- IRoleMultiSelectInteraction
- IRoleMultiSelectInteractionEvent
- ISlashCommand
- ISlashCommandInteraction
- ISlashCommandInteractionEvent
- ISlashCommandPermissionOverride
- A single permission override for a command.
- ISlashCommandPermissionOverrides
- A collection of permission overrides attached to a slash command.
- IUserMultiSelectInteraction
- IUserMultiSelectInteractionEvent
- LinkButtonBuilder
- Allows to create a button with link
- LockFileCommandSync
- Manually define command syncing rules
- ManualCommandSync
- Manually define command syncing rules
- MentionableMultiSelectBuilder
-
Builder to create select menu with mentionables (
IRoles &IUsers) inside of it. - ModalBuilder
- MultiselectBuilder
- Allows to create multi select interactive components.
- MultiselectOptionBuilder
- Allows to create multi select options for MultiselectBuilder.
- RoleCommandPermissionBuilder
- A permission for a single role that can be used in SlashCommandBuilder
- RoleMultiSelectBuilder
-
Builder to create select menu with
IRoles inside of it. - SlashCommandBuilder
- A slash command, can only be instantiated through a method on IInteractions
- SlashCommandPermissionType
- The type of entiity that a command permission override is targeting.
- SlashCommandType
- Type of the slash command. Since context menus reuses slash commands backed, slash commands cna have different types based on context.
- TextInputBuilder
- TextInputStyle
- UserCommandPermissionBuilder
- A permission for a single user that can be used in SlashCommandBuilder
- UserMultiSelectBuilder
-
Builder to create select menu with
IUsers inside of it. - WebsocketInteractionBackend
Enums
Mixins
Extensions
- InteractionRouteParts on IHttpRoute
Properties
- slashCommandNameRegex → RegExp
-
Slash command names and subcommands names have to match this regex
final
Typedefs
-
AutocompleteInteractionHandler
= FutureOr<
void> Function(IAutocompleteInteractionEvent) - Function that will handle execution of button interaction event
-
ButtonInteractionHandler
= FutureOr<
void> Function(IButtonInteractionEvent) - Function that will handle execution of button interaction event
-
MultiselectInteractionHandler
= FutureOr<
void> Function(IMultiselectInteractionEvent) - Function that will handle execution of dropdown event
-
SlashCommandHandler
= FutureOr<
void> Function(ISlashCommandInteractionEvent) - Function that will handle execution of slash command interaction event
Exceptions / Errors
- AlreadyRespondedError
- Thrown when you have already responded to an interaction
- CommandNotFoundException
- An error thrown when an interaction is received but nyxx_interactions cannot find a matching command model.
- InteractionExpiredError
- Thrown when 15 minutes has passed since an interaction was called.
- ResponseRequiredError
- Thrown when you haven't sent a response yet