Class Poll

Implements

Poll

Index

Constructors

Accessors

_results allowMultiselect answers expiry guild guildId layoutType question

Methods

[custom] toJSON toString

Constructors

constructor

new Poll(
    client: Client,
    data: PollStorageJSON | PollCacheJSON | APIPoll | PollDiscordJSON,
    options: { guildId: string },
): Poll
Creates the structure for a poll.
Parameters
- client: Client
  The client instance.
- data: PollStorageJSON | PollCacheJSON | APIPoll | PollDiscordJSON
  The raw poll data from Discord.
- options: { guildId: string }
  The additional options for this structure.
  - guildId: string
    The ID of the guild that this poll belongs to.
Returns Poll
- Defined in src/structures/Poll.ts:33

Accessors

_results

get _results(): MessagePollManager
The poll responses.

Returns MessagePollManager
Implementation of PollType._results
- Defined in src/structures/Poll.ts:190

allowMultiselect

get allowMultiselect(): boolean
Whether the poll allows multiselect.

Returns boolean
Implementation of PollType.allowMultiselect
- Defined in src/structures/Poll.ts:170

answers

get answers(): { answer: string; answerId: number; result: string[] }[]
The answers of the poll.

Returns { answer: string; answerId: number; result: string[] }[]
Implementation of PollType.answers
- Defined in src/structures/Poll.ts:143

expiry

get expiry(): null | number
The UNIX timestamp of the expiry time for the poll.

Returns null | number
Implementation of PollType.expiry
- Defined in src/structures/Poll.ts:160

guild

get guild(): null | Guild
The guild that this poll belongs to.

Returns null | Guild
Implementation of PollType.guild
- Defined in src/structures/Poll.ts:123

guildId

get guildId(): string
The ID of the guild that this poll belongs to.

Returns string
Implementation of PollType.guildId
- Defined in src/structures/Poll.ts:113

layoutType

get layoutType(): PollLayoutType
The layout type of the poll.

Returns PollLayoutType
Implementation of PollType.layoutType
- Defined in src/structures/Poll.ts:180

question

get question(): string
The question of the poll.

Returns string
Implementation of PollType.question
- Defined in src/structures/Poll.ts:133

Methods

[custom]

"[custom]"(): string
Returns string
Method
- Defined in src/structures/Poll.ts:206

toJSON

toJSON(format?: JsonTypes): PollStorageJSON | PollCacheJSON | PollDiscordJSON
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns PollStorageJSON | PollCacheJSON | PollDiscordJSON
Method
Implementation of PollType.toJSON
- Defined in src/structures/Poll.ts:217

toString

toString(): string
Returns string
Method
Implementation of PollType.toString
- Defined in src/structures/Poll.ts:198