sx.blah.discord.modules

Interface IModule

public interface IModule

A Discord4J "module".

When enabled, modules are registered as event listeners, so your module can use EventSubscriber or IListener to listen for events.

Modules MUST have a default constructor.

See Also:

Information about module loading.

Method Summary

Modifier and Type	Method and Description
void	disable() Called to disable the module.
boolean	enable(IDiscordClient client) Called to enable the module.
String	getAuthor() Gets the author(s) of the module.
String	getMinimumDiscord4JVersion() Gets the minimum required version of Discord4J for the module to function.
String	getName() Gets the name of the module.
String	getVersion() Gets the version of the module.

Method Detail

enable

boolean enable(IDiscordClient client)

Called to enable the module. A new instance of the module is created for each call to this method.

Parameters:

client - The client the module instance is being enabled for.

Returns:

Whether the module was successfully enabled.

disable

void disable()

Called to disable the module.

It is important that the module implementation attempt to do any and all cleanup in this method in order for the module to properly unload. The module loader can make no guarantees about the unloading of modules if they do not properly implement this method.

getName

String getName()

Gets the name of the module.

Returns:

The name of the module.

getAuthor

String getAuthor()

Gets the author(s) of the module.

Returns:

The author(s) of the module.

getVersion

String getVersion()

Gets the version of the module.

Returns:

The version of the module.

getMinimumDiscord4JVersion

String getMinimumDiscord4JVersion()

Gets the minimum required version of Discord4J for the module to function.

Returns:

The minimum required version, i.e. "2.8.4".