UserContext class Null safety

Represents a context in which a UserCommand was executed.

Implemented types

Constructors

UserContext({required IMember? targetMember, required IUser targetUser, required ITextChannel channel, required INyxx client, required UserCommand command, required CommandsPlugin commands, required IGuild? guild, required IMember? member, required IUser user, required ISlashCommandInteraction interaction, required ISlashCommandInteractionEvent interactionEvent})

Properties

channel ITextChannel
The channel in which the context was created.
final
client INyxx
The client that emitted the event triggering this context's creation.
final
command UserCommand
The command that was executed or is being processed.
final
commands CommandsPlugin
The instance of CommandsPlugin which created this context.
final
guild IGuild?
The guild in which the context was created, or null if created outside of a guild.
final
hashCode int
The hash code for this object.
read-only, inherited
interaction ISlashCommandInteraction
The interaction that triggered this context's creation.
final
interactionEvent ISlashCommandInteractionEvent
The interaction event that triggered this context's creation.
final
member IMember?
The member that triggered this context's created, or null if created outside of a guild.
final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
targetMember IMember?
The member that was selected by the user when running the command if the command was invoked in a guild, null otherwise.
final
targetUser IUser
The user that was selected by the user when running the command.
final
user IUser
The user that triggered this context's creation.
final

Methods

acknowledge({bool? hidden}) Future<void>
Acknowledge the underlying interaction without yet sending a response.
inherited
getButtonPress(Iterable<ButtonBuilder> buttons, {bool authorOnly = true, Duration? timeout = const Duration(minutes: 12)}) Future<IButtonInteractionEvent>
Wait for a user to press on a button, then return the result of that interaction.
inherited
getConfirmation(MessageBuilder message, {bool authorOnly = true, Duration? timeout = const Duration(minutes: 12), String confirmMessage = 'Yes', String denyMessage = 'No'}) Future<bool>
Send a message prompting a user for confirmation, then return whether the user accepted the choice.
inherited
getSelection(MultiselectBuilder selectionMenu, {bool authorOnly = true, Duration? timeout = const Duration(minutes: 12)}) Future<IMultiselectInteractionEvent>
Wait for a user to make a selection from a multiselect menu, then return the result of that interaction.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
respond(MessageBuilder builder, {bool private = false, bool? hidden}) Future<IMessage>
Send a response to the command.
inherited
toString() String
A string representation of this object.
override

Operators

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