SpikeyBot-Discord

Class: Polling

Polling

Controlls poll and vote commands.

new Polling()

Source:
Listens to Events:
  • Command#event:poll
  • Command#event:vote
  • Command#event:endpoll
  • Command#event:endvote

Extends

Classes

Poll

Members

<nullable> bot :SpikeyBot

The parent SpikeyBot instance. Defaults to required cache value for autocompletion, updates to current reference at init.
Type:
Inherited From:
Source:

client :Discord~Client

The current bot client. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
  • Discord~Client
Inherited From:
Source:

command :Command

The command object for registering command listeners. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
Inherited From:
Source:

<constant> commit :string

The commit at HEAD at the time this module was loaded. Essentially the version of this submodule.
Type:
  • string
Inherited From:
Source:

common :Common

The common object. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
Inherited From:
Source:

Discord :Discord

The current Discord object instance of the bot. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
  • Discord
Inherited From:
Source:

helpMessage :undefined|string|Discord~EmbedBuilder

The help message to show the user in the main help message.
Type:
  • undefined | string | Discord~EmbedBuilder
Inherited From:
Overrides:
Source:

<protected, readonly> initialized :boolean

Has this subModule been initialized yet (Has begin() been called).
Type:
  • boolean
Inherited From:
Source:

<constant> loadTime :number

The time at which this module was loaded for use in checking if the module needs to be reloaded because the file has been modified since loading.
Type:
  • number
Inherited From:
Source:

<protected> myName :string

The name of this submodule. Used for differentiating in the log. Should be defined before begin().
Type:
  • string
Inherited From:
Overrides:
Source:

<abstract> postPrefix :string

The postfix for the global prefix for this subModule. Must be defined before begin(), otherwise it is ignored.
Type:
  • string
Inherited From:
Source:

<private, inner, constant> currentPolls :object.<Polling~Poll>

Stores the currently cached data about all active polls. Organized by message id that is collecting the poll data.
Type:
Source:

<private, inner, constant> defaultEmojis

The default reaction emojis to use for a poll.
Default Value:
  • ["👍","👎","🤷"]
Source:

<private, inner, constant> guildSubDir

The subdirectory in the guild to store all member polls.
Default Value:
  • /polls/
Source:

<private, inner, constant> saveFilename

The filename in the member's subdirectory, in the guild's subdirectory, to save a poll's state.
Default Value:
  • save.json
Source:

Methods

begin(Discord, client, command, common, bot)

Initialize this submodule.
Parameters:
Name Type Description
Discord Discord The Discord object for the API library.
client Discord~Client The client that represents this bot.
command Command The command instance in which to register command listeners.
common Common Class storing common functions.
bot SpikeyBot The parent SpikeyBot instance.
Inherited From:
Source:

<protected> debug(msg)

Log using common.logDebug, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Source:

end()

Trigger subModule to shutdown and get ready for process terminating.
Inherited From:
Source:

<protected> error(msg)

Log using common.error, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Source:

<protected> initialize()

The function called at the end of begin() for further initialization specific to the subModule. Must be defined before begin() is called.
Inherited From:
Overrides:
Source:

<protected> log(msg)

Log using common.log, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Source:

<abstract> reloadable()

Check if this module is in a state that is ready to be reloaded. If false is returned, this module should not be unloaded and doing such may risk putting the module into an uncontrollable state. This is different from unloadable, which checks if this module can be stopped completely, this checks if the module can be stopped and restarted.
Inherited From:
Source:
See:
  • SubModule~unloadable
Returns:
True if can be reloaded, false if cannot.
Type
boolean

save( [opt])

Saves all data to files necessary for saving current state.
Parameters:
Name Type Argument Default Description
opt string <optional>
 'sync' Can be 'async', otherwise defaults to synchronous.
Inherited From:
Overrides:
Source:

<protected> shutdown()

Shutdown and disable this submodule. Removes all event listeners.
Inherited From:
Overrides:
Source:

<abstract> unloadable()

Check if this module is in a state that is ready to be unloaded. If false is returned, this module should not be unloaded and doing such may risk putting the module into an uncontrollable state.
Inherited From:
Source:
See:
  • SubModule~reloadable
Returns:
True if can be unloaded, false if cannot.
Type
boolean

<protected> warn(msg)

Log using common.logWarning, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Source:

<private, inner> addListenersToPoll(poll, key)

Add timeout and possibly other listeners to a poll.
Parameters:
Name Type Description
poll Polling~Poll The poll to register.
key string The Polling~currentPolls key to remove the poll from once the poll has ended.
Source:

<private, inner> addNextReaction(poll [, index])

Create a callback for adding all reactions to a message.
Parameters:
Name Type Argument Default Description
poll Polling~Poll The poll object for adding reactions.
index number <optional>
 0 The index of the emoji to add first.
Source:
Returns:
The callback to run on Promise completion.
Type
function

<private, inner> commandEndPoll(msg)

Ends a poll.
Parameters:
Name Type Description
msg Discord~Message Message that triggered command.
Source:
Listens to Events:
  • Command#event:endpoll
  • Command#event:endvote

<private, inner> commandPoll(msg)

Starts a poll.
Parameters:
Name Type Description
msg Discord~Message Message that triggered command.
Source:
Listens to Events:
  • Command#event:poll
  • Command#event:vote

<private, inner> endPoll(poll)

End a poll. Does not remove it from Polling~currentPolls.
Parameters:
Name Type Description
poll Polling~Poll The poll to end.
Source:
Returns:
Was the poll successfully ended.
Type
boolean

<private, inner> parsePollString(string)

Parse the saved poll data that has been read from file in JSON format.
Parameters:
Name Type Description
string string The file data.
Source: