Skip to main content

DiscordPoll

@discordeno/botDocs


Documentation / @discordeno/bot / DiscordPoll

Interface: DiscordPoll

https://discord.com/developers/docs/resources/poll#poll-object

Properties

allow_multiselect

allow_multiselect: boolean

Whether a user can select multiple answers

Defined in

packages/types/dist/types/discord.d.ts:1423


answers

answers: DiscordPollAnswer[]

Each of the answers available in the poll. There is a maximum of 10 answers per poll.

Defined in

packages/types/dist/types/discord.d.ts:1414


expiry

expiry: null | string

The time when the poll ends.

Remarks

expiry is marked as nullable to support non-expiring polls in the future, but all polls have an expiry currently.

Defined in

packages/types/dist/types/discord.d.ts:1421


layout_type

layout_type: Default

The layout type of the poll

Defined in

packages/types/dist/types/discord.d.ts:1425


question

question: DiscordPollMedia

The question of the poll. Only text is supported.

Defined in

packages/types/dist/types/discord.d.ts:1412


results?

optional results: DiscordPollResult

The results of the poll

Remarks

This value will not be sent by discord under specific conditions where they don't fetch them on their backend. When this value is missing it should be interpreted as "Unknown results" and not as "No results" The results may not be totally accurate while the poll has not ended. When it ends discord will re-calculate all the results and set DiscordPollResult.is_finalized to true

Defined in

packages/types/dist/types/discord.d.ts:1433