SpikeyBot-Discord

Class: Poll

Polling~ Poll

Stores data related to a single poll.

<private> new Poll(author, message, options)

Parameters:
Name Type Description
author string ID of the user who started this poll.
message Discord~Message The message to watch for the results.
options Polling~PollOptions The settings for this current poll.
Properties:
Name Type Argument Description
author string ID of the user who started this poll.
message Discord~Message Reference to the Message object with the reaction listener.
title string The user defined text associated with this poll.
endTime number <nullable>
 The timestamp at which this poll is scheduled to end.
emojis Array.<string> The emojis to add as reactions to use as buttons.
choices Array.<string> The full string that came with the emoji if the user specified custom response options.
timeout Array.<string> The scheduled timeout when this poll will end.
Source:

Members

author :string

ID of the user who started this poll.
Type:
  • string
Source:

choices :Array.<string>

The full string that came with the emoji if the user specified custom response options.
Type:
  • Array.<string>
Source:

emojis :Array.<string>

The emojis to add as reactions to use as buttons.
Type:
  • Array.<string>
Source:

<nullable> endTime :number

The timestamp at which this poll is scheduled to end.
Type:
  • number
Source:

message :Discord~Message

Reference to the Message object with the reaction listener.
Type:
  • Discord~Message
Source:

<nullable> timeout :Timeout

The scheduled timeout when this poll will end.
Type:
  • Timeout
Source:

title :string

The user defined text associated with this poll.
Type:
  • string
Source: