PollAPI

export declare class PollAPI
export declare class PollAPI

No summary provided.

constructor(rest)
Constructs a new instance of the PollAPI class
NameTypeOptionalDescription
restRESTNoNone
expirePoll(channelId, messageId, options?):Promise<APIMessage>
Immediately expires (i.e. ends) a poll
NameTypeOptionalDescription
channelIdSnowflakeNoThe id of the channel containing the message
messageIdSnowflakeNoThe id of the message containing the poll
optionsPick<RequestData, 'signal'>YesThe options for expiring the poll
getAnswerVoters(channelId, messageId, answerId, query?, options?):Promise<RESTGetAPIPollAnswerVotersResult>
Gets the list of users that voted for a specific answer in a poll
NameTypeOptionalDescription
channelIdSnowflakeNoThe id of the channel containing the message
messageIdSnowflakeNoThe id of the message containing the poll
answerIdnumberNoThe id of the answer to get voters for
queryRESTGetAPIPollAnswerVotersQueryYesThe query for getting the list of voters
optionsPick<RequestData, 'signal'>YesThe options for getting the list of voters