Interface ErrorMessageFactory

All Known Implementing Classes:

DefaultErrorMessageFactory

public interface ErrorMessageFactory

Generic interface for factory classes that provide MessageCreateData that should be sent for common errors that happen during an interaction execution, such as missing permissions or failing constraints.

See Also:

• DefaultErrorMessageFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ErrorMessageFactory.ErrorContext	Holds the respective GenericInteractionCreateEvent and InteractionDefinition of an error.

Method Summary

Modifier and Type	Method	Description
MessageCreateData	getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext context, Throwable exception)	Gets a MessageCreateData to send when the command execution failed.
MessageCreateData	getConstraintFailedMessage(ErrorMessageFactory.ErrorContext context, String message)	Gets a MessageCreateData to send when a parameter constraint fails.
MessageCreateData	getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext context)	Gets a MessageCreateData to send when a user is missing permissions.
MessageCreateData	getTimedOutComponentMessage(GenericInteractionCreateEvent event)	Gets a MessageCreateData to send when an incoming component interaction already timed out.
MessageCreateData	getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext context, io.github.kaktushose.proteus.conversion.ConversionResult.Failure<?> failure)	Gets a MessageCreateData to send when type adapting of the user input failed.

Method Details

getTypeAdaptingFailedMessage

MessageCreateData getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext context,
 io.github.kaktushose.proteus.conversion.ConversionResult.Failure<?> failure)

Gets a MessageCreateData to send when type adapting of the user input failed.

Parameters:

context - the ErrorMessageFactory.ErrorContext

failure - the ConversionResult.Failure

Returns:

a MessageCreateData to send when type adapting failed

getInsufficientPermissionsMessage

MessageCreateData getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext context)

Gets a MessageCreateData to send when a user is missing permissions.

Parameters:

context - the ErrorMessageFactory.ErrorContext

Returns:

a MessageCreateData to send when a user is missing permissions

getConstraintFailedMessage

MessageCreateData getConstraintFailedMessage(ErrorMessageFactory.ErrorContext context,
 String message)

Gets a MessageCreateData to send when a parameter constraint fails.

Parameters:

context - the ErrorMessageFactory.ErrorContext

Returns:

a MessageCreateData to send when a parameter constraint fails

getCommandExecutionFailedMessage

MessageCreateData getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext context,
 Throwable exception)

Gets a MessageCreateData to send when the command execution failed.

Parameters:

context - the ErrorMessageFactory.ErrorContext

exception - the Throwable that made the command execution fail

Returns:

a MessageCreateData to send when the command execution failed

getTimedOutComponentMessage

MessageCreateData getTimedOutComponentMessage(GenericInteractionCreateEvent event)

Gets a MessageCreateData to send when an incoming component interaction already timed out.

Parameters:

event - the GenericInteractionCreateEvent mo runtime was found for

Returns:

a MessageCreateData to send when an incoming component interaction already timed out