Interface Poll

Represents a poll attached to a status.

See

https://docs.joinmastodon.org/entities/poll/

interface Poll {
    expired: boolean;
    expiresAt?: null | string;
    id: string;
    multiple: boolean;
    options: PollOption[];
    ownVotes?: null | number[];
    voted?: boolean;
    votersCount?: null | number;
    votesCount: number;
}

Properties

expired expiresAt? id multiple options ownVotes? voted? votersCount? votesCount

Properties

expired

expired: boolean

Is the poll currently expired?

Optional expiresAt

expiresAt?: null | string

When the poll ends.

id

id: string

The ID of the poll in the database.

multiple

multiple: boolean

Does the poll allow multiple-choice answers?

options

options: PollOption[]

Possible answers for the poll.

Optional ownVotes

ownVotes?: null | number[]

When called with a user token, which options has the authorized user chosen? Contains an array of index values for options.

Optional voted

voted?: boolean

When called with a user token, has the authorized user voted?

Optional votersCount

votersCount?: null | number

How many unique accounts have voted on a multiple-choice poll.

votesCount

votesCount: number

How many votes have been received.

Settings

Member Visibility

Theme

On This Page

expiredexpiresAtidmultipleoptionsownVotesvotedvotersCountvotesCount