Package dev.sympho.modular_commands.api.command.context

Interface MessageCommandContext

All Superinterfaces:

AccessValidator, CommandContext

All Known Implementing Classes:

MessageContextImpl

public interface MessageCommandContext
extends CommandContext

The execution context of an command invoked through a message.

Since:

1.0

Version:

1.0

Method Summary

Modifier and Type	Method	Description
MessageCreateEvent	getEvent()	Retrieves the event that triggered the command.
default Message	getMessage()	Retrieves the message that invoked the command.
default Snowflake	getMessageId()	Retrieves the ID of the message that invoked the command.

Methods inherited from interface dev.sympho.modular_commands.api.permission.AccessValidator

hasAccess, validate

Methods inherited from interface dev.sympho.modular_commands.api.command.context.CommandContext

belongs, belongs, getArgument, getArgument, getArgument, getCaller, getCallerMember, getChannel, getChannelId, getClient, getCommandInvocation, getContext, getGuild, getGuildId, getInvocation, isPrivate, replies, reply, reply, reply, reply, reply, reply, requireArgument, requireArgument, requireArgument, requireContext, setContext, setContext

Method Details

getEvent

MessageCreateEvent getEvent()

Description copied from interface: CommandContext

Retrieves the event that triggered the command.

Specified by:

getEvent in interface CommandContext

Returns:

The trigger event.

getMessage

@Pure
default Message getMessage()

Retrieves the message that invoked the command.

Returns:

The invoking message.

getMessageId

@Pure
default Snowflake getMessageId()

Retrieves the ID of the message that invoked the command.

Returns:

The invoking message ID.