Class DonationAlertsPollOption

Represents Donation Alerts poll option.

Hierarchy

DataObject<DonationAlertsPollOptionData>
- DonationAlertsPollOption

Index

Accessors

amountPercent amountValue id isWinner title

Accessors

amountPercent

get amountPercent(): number
The percent value of poll option relative other poll options.

Returns number
- Defined in packages/events/src/events/polls/DonationAlertsPollOption.ts:41

amountValue

get amountValue(): number
The absolute value of poll option. Depending on poll type the value may contain number or sum of donations.

Returns number
- Defined in packages/events/src/events/polls/DonationAlertsPollOption.ts:34

id

get id(): number
The unique poll option identifier.

Returns number
- Defined in packages/events/src/events/polls/DonationAlertsPollOption.ts:20

isWinner

get isWinner(): boolean
A flag indicating whether the poll option is the poll winner or not. Please note that poll may have multiple winners if maximum amountValue value is shared by several poll options.

Returns boolean
- Defined in packages/events/src/events/polls/DonationAlertsPollOption.ts:49

title

get title(): string
The poll option title.

Returns string
- Defined in packages/events/src/events/polls/DonationAlertsPollOption.ts:27

Generated using TypeDoc