CommandContext class abstract interface

A context in which a command was executed.

Contains data about how and where the command was executed, and provides a simple interfaces for responding to commands.

You might also be interested in:

Implemented types
Implementers

Constructors

CommandContext()

Properties

channel → TextChannel
The channel in which the context was created.
no setterinherited
client → NyxxGateway
The client that emitted the event triggering this context's creation.
no setterinherited
command → Command<CommandContext>
The command that was executed or is being processed.
no setterinherited
commands → CommandsPlugin
The instance of CommandsPlugin which created this context.
no setterinherited
delegate → InteractiveContext?
The delegate of this context.
no setterinherited
guild → Guild?
The guild in which the context was created, or null if created outside of a guild.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
latestContext → InteractiveContext
The youngest context that handles all interactions.
no setterinherited
member → Member?
The member that triggered this context's created, or null if created outside of a guild.
no setterinherited
parent → InteractiveContext?
The parent of this context.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
user → User
The user that triggered this context's creation.
no setterinherited

Methods

awaitButtonPress(ComponentId componentId) → Future<ButtonComponentContext>
Wait for a user to press a button and return a context representing that button press.
inherited
awaitMultiSelection<T>(ComponentId componentId, {Converter<T>? converterOverride}) → Future<SelectMenuContext<List<T>>>
Wait for a user to select options from a multi-select menu and return a context representing that selection.
inherited
awaitSelection<T>(ComponentId componentId, {Converter<T>? converterOverride}) → Future<SelectMenuContext<T>>
Wait for a user to select a single option from a multi-select menu and return a context representing that selection.
inherited
getButtonPress(Message message) → Future<ButtonComponentContext>
Wait for a user to press on any button on a given message and return a context representing the button press.
inherited
getButtonSelection<T>(List<T> values, MessageBuilder builder, {Map<T, ButtonStyle>? styles, bool authorOnly = true, ResponseLevel? level, Duration? timeout, FutureOr<ButtonBuilder> toButton(T)?, Converter<T>? converterOverride}) → Future<T>
Get a selection from a user, presenting the options as an array of buttons.
inherited
getConfirmation(MessageBuilder builder, {Map<bool, String> values = const {true : 'Yes', false : 'No'}, Map<bool, ButtonStyle> styles = const {true : ButtonStyle.success, false : ButtonStyle.danger}, bool authorOnly = true, ResponseLevel? level, Duration? timeout}) → Future<bool>
Present the user with two options and return whether the positive one was clicked.
inherited
getMultiSelection<T>(List<T> choices, MessageBuilder builder, {ResponseLevel? level, Duration? timeout, bool authorOnly = true, FutureOr<SelectMenuOptionBuilder> toSelectMenuOption(T)?, Converter<T>? converterOverride}) → Future<List<T>>
Present the user with a drop-down menu of choices and return the selected choices.
inherited
getSelection<T>(List<T> choices, MessageBuilder builder, {ResponseLevel? level, Duration? timeout, bool authorOnly = true, FutureOr<SelectMenuOptionBuilder> toSelectMenuOption(T)?, Converter<T>? converterOverride}) → Future<T>
Present the user with a drop-down menu of choices and return the selected choice.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
respond(MessageBuilder builder, {ResponseLevel? level}) → Future<Message>
Send a response to the command.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited