Constructor
new Enqueue(fileName)
Parameters:
| Name | Type | Description |
|---|---|---|
fileName |
* | The filename in which the command is defined, stripped by the extension. |
- Version:
-
- 1.0
- Source:
Extends
Methods
execute(message, args)
Add user to the queue if not already existent
Parameters:
| Name | Type | Description |
|---|---|---|
message |
* | |
args |
* |
- Overrides:
- Source:
createUser(message) → {Object}
Assembles the data to be saved inside the queue for each member.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object | The received discord.js message object. |
- Source:
isListening(guildId) → {boolean}
Check if the bot is currently listening for some admin to new enqueues.
Parameters:
| Name | Type | Description |
|---|---|---|
guildId |
number | The unique idenitifer of the guild. |
- Source:
hintAdmin(message, userId, guildId)
Inform the next waiting admin about the enqueue.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object | The discord.js received message object. |
userId |
number | The unique identifer of the user sending the message. |
guildId |
number | The unique idenitifer of the guild. |
- Source:
getCommand() → {Object}
Creates and returns a object representation of the command. Used to init discord.js commands.
- Overrides:
- Source:
getResponse(name) → {string}
Returns a command specific response for a user, additionally supplied arguments besides name are used to replace template sequeuence of the string.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The key of the response. Used to access the responses for the calling command. |
- Overrides:
- Source: