Package dev.sympho.modular_commands.api.command

Interface MessageCommand

All Superinterfaces:

Command

All Known Subinterfaces:

TextCommand

All Known Implementing Classes:

MessageCommandImpl, TextCommandImpl

public non-sealed interface MessageCommand
extends Command

A message-based command.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface dev.sympho.modular_commands.api.command.Command

Command.Scope

Method Summary

Modifier and Type	Method	Description
Set<String>	aliases()	The aliases that may also invoke the command.
default Set<Invocation>	aliasInvocations()	The alias invocations that may also invoke the command.
MessageInvocationHandler	invocationHandler()	The handler to use for processing an invocation of the command.
default List<? extends MessageResultHandler>	resultHandlers()	The handlers to use for processing the result, in order.

Methods inherited from interface dev.sympho.modular_commands.api.command.Command

botOwnerOnly, callable, description, displayName, inheritSettings, invocation, invokeParent, name, nsfw, parameters, parent, privateReply, requiredDiscordPermissions, requireParentPermissions, scope, serverOwnerOnly

Method Details

aliases

@Pure
Set<String> aliases()

The aliases that may also invoke the command.

These aliases are only relevant to handling invocations. They may not be used to specify the command as a parent.

Aliases must satisfy the same restrictions as the name.

Returns:

The command aliases.

aliasInvocations

@Pure
default Set<Invocation> aliasInvocations()

The alias invocations that may also invoke the command.

Returns:

The command aliases as invocations.

See Also:

• aliases()

Implementation Requirements:

The invocation is determined by appending each alias to the parent.

invocationHandler

MessageInvocationHandler invocationHandler()

Description copied from interface: Command

The handler to use for processing an invocation of the command.

Specified by:

invocationHandler in interface Command

Returns:

The handler.

resultHandlers

default List<? extends MessageResultHandler> resultHandlers()

Description copied from interface: Command

The handlers to use for processing the result, in order.

They are given priority over any handlers defined at the registry or global level.

Specified by:

resultHandlers in interface Command

Returns:

The result handlers for this command.