Members

private _options : Object

modules/reaction-handler/index.js, line 50

The options for the reaction handler

Properties:

Name	Type	Description
maxInterfaces	Number	The maximum amount of interfaces cached before they start getting deleted. MINIMUM: 3

private _reactCommands : Map<String, ReactCommand>

modules/reaction-handler/index.js, line 35

Map of the reaction commands

private _reactInterfaces : Map<String, ReactInterface>

modules/reaction-handler/index.js, line 42

Map of the interfaces bound to messages

Methods

private _commandCleanup(command, data)

modules/reaction-handler/index.js, line 95

Tidy up after a react command has finished executing

Parameters:

Name	Type	Description
command	ReactCommand	The react command object
data	Object	Situational data

Properties:

Name	Type	Description
data.msg	Eris.Message	The message that was reacted on
data.user	Eris.User	The user that reacted

private _getInterfaceButton(msg, emoji) → {ReactInterface|undefined}

modules/reaction-handler/index.js, line 130

Get a bound interface button of a message

Parameters:

Name	Type	Description
msg	Eris.Message	The message
emoji	Object	The emoji reacted with

Returns:

ReactInterface | undefined -

The bound interface button

async, private _implementResponse(data, options) → {Promise<Eris.Message>}

modules/reaction-handler/index.js, line 279

Tidy up after a successful response from a react command

Parameters:

Name	Type	Description
data	Object	Situational data
options	Object	The options for the response

Returns:

Promise<Eris.Message> -

Overall results from the react command

Properties:

Name	Type	Description
data.msg	Eris.Message	The message that was reacted on
data.user	Eris.User	The user that reacted
options.channel	String	The ID of the channel the response was sent to
options.awaits	Array<Await> | Await	An action or list of actions that are awaited after the results are processed
options.reactInterface	ReactInterface	A react interface that is bound to the resulting message
options.deleteAfter	Number	How long until the response is deleted
response	Eris.Message | Error	The response that was sent to Discord

private _loadReactCommand(reactCommand)

modules/reaction-handler/index.js, line 248

Load a reaction command

Parameters:

Name	Type	Description
reactCommand	ReactCommand	The reaction command to load

async bindInterface(msg, reactInterface, _defaultDesignated) → {Promise<ReactInterface>}

modules/reaction-handler/index.js, line 65

Bind an interface to a command

Parameters:

Name	Type	Description
msg	Eris.Message	The message to bind to
reactInterface	ReactInterface	The interface to bind
_defaultDesignated	String	The default designated user (generally the command initiator)

Returns:

Promise<ReactInterface> -

The resulting interface data

async detachInterface(msg, removeButtons : opt) → {Promise<ReactInterface>}

modules/reaction-handler/index.js, line 107

Parameters:

Name	Type	Attributes	Default	Description
msg	Eris.Message			The message to detach the interface from
removeButtons	Boolean	<optional>	true	Whether the buttons from the message are removed

Returns:

Promise<ReactInterface> -

The detached interface

getReactCommand(emoji) → {ReactCommand|undefined}

modules/reaction-handler/index.js, line 149

Get a react command

Parameters:

Name	Type	Description
emoji	String	The emoji that triggers the react command

Returns:

ReactCommand | undefined -

The found react command

async handle(msg, emoji, user) → {Promise<ReactionHandlerResultList>}

modules/reaction-handler/index.js, line 161

Handle an incoming Discord reaction

Parameters:

Name	Type	Description
msg	Eris.Message	The message reacted on
emoji	Object	The data of the emoji reacted with
user	Eris.User	The user who reacted

Returns:

Promise<ReactionHandlerResultList> -

The overall results of the react command

loadReactCommands(reactCommands)

modules/reaction-handler/index.js, line 258

Load reaction commands

Parameters:

Name	Type	Description
reactCommands	Array<ReactCommand> | ReactCommand	The reaction command(s) to load