Class MessagePollManager

Manages a poll for a message.

Implements

MessagePollManager

Index

Constructors

Methods

_addVote _removeVote getResult toJSON

Constructors

constructor

new MessagePollManager(
    client: Client,
    existingResponses?:
        | MessagePollManagerStorageJSON
        | MessagePollManagerCacheJSON,
): MessagePollManager
Creates a message poll manager.
Parameters
- client: Client
- existingResponses: MessagePollManagerStorageJSON | MessagePollManagerCacheJSON = {}
  Existing responses for a poll.
Returns MessagePollManager
- Defined in src/managers/MessagePollManager.ts:21

Methods

_addVote

_addVote(user_id: string, answer_id: number): void
Adds a response to a poll.
Parameters
- user_id: string
  The id of the user who voted.
- answer_id: number
  The id of the answer that was voted for.
Returns void
Throws
Method
Implementation of MessagePollManagerType._addVote
- Defined in src/managers/MessagePollManager.ts:61

_removeVote

_removeVote(user_id: string, answer_id: number): void
Removes a response from a poll.
Parameters
- user_id: string
  The id of the user whose vote was removed.
- answer_id: number
  The id of the answer for which the vote was removed.
Returns void
Throws
Method
Implementation of MessagePollManagerType._removeVote
- Defined in src/managers/MessagePollManager.ts:83

getResult

getResult(answerId: number): string[]
Returns the result for a given answer.
Parameters
- answerId: number
  The ID of the answer to get the result for.
Returns string[]
Implementation of MessagePollManagerType.getResult
- Defined in src/managers/MessagePollManager.ts:104

toJSON

toJSON(
    format?: JsonTypes,
):
    | MessagePollManagerStorageJSON
    | MessagePollManagerCacheJSON
    | MessagePollManagerDiscordJSON
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns
    | MessagePollManagerStorageJSON
    | MessagePollManagerCacheJSON
    | MessagePollManagerDiscordJSON
Method
Implementation of MessagePollManagerType.toJSON
- Defined in src/managers/MessagePollManager.ts:119