helix/io.github.captnblubber.twitchkt.helix.model/Poll

Poll

@Serializable

data class Poll(val id: String, val broadcasterId: String, val broadcasterName: String, val broadcasterLogin: String, val title: String, val choices: List<PollChoice>, val bitsVotingEnabled: Boolean = false, val bitsPerVote: Int = 0, val channelPointsVotingEnabled: Boolean = false, val channelPointsPerVote: Int = 0, val status: PollStatus, val duration: Int, val startedAt: Instant? = null, val endedAt: Instant? = null)

Represents a poll from the Twitch Helix API.

See also

Twitch API Reference - Get Polls

Constructors

constructor(id: String, broadcasterId: String, broadcasterName: String, broadcasterLogin: String, title: String, choices: List<PollChoice>, bitsVotingEnabled: Boolean = false, bitsPerVote: Int = 0, channelPointsVotingEnabled: Boolean = false, channelPointsPerVote: Int = 0, status: PollStatus, duration: Int, startedAt: Instant? = null, endedAt: Instant? = null)

Properties

@SerialName(value = "bits_per_vote")

val bitsPerVote: Int

not used; will be set to 0.

bitsVotingEnabled

@SerialName(value = "bits_voting_enabled")

val bitsVotingEnabled: Boolean

not used; will be set to false.

@SerialName(value = "broadcaster_id")

val broadcasterId: String

an ID that identifies the broadcaster that created the poll.

broadcasterLogin

@SerialName(value = "broadcaster_login")

val broadcasterLogin: String

the broadcaster's login name.

broadcasterName

@SerialName(value = "broadcaster_name")

val broadcasterName: String

the broadcaster's display name.

channelPointsPerVote

@SerialName(value = "channel_points_per_vote")

val channelPointsPerVote: Int

the number of points the viewer must spend to cast one additional vote.

channelPointsVotingEnabled

@SerialName(value = "channel_points_voting_enabled")

val channelPointsVotingEnabled: Boolean

a Boolean value that indicates whether viewers may cast additional votes using Channel Points.

val choices: List<PollChoice>

a list of choices that viewers can choose from. The list will contain a minimum of two choices and up to a maximum of five choices.

val duration: Int

the length of time (in seconds) that the poll will run for.

@SerialName(value = "ended_at")

val endedAt: Instant?

the UTC date and time (in RFC3339 format) of when the poll ended. If status is ACTIVE, this field is set to null.

an ID that identifies the poll.

@SerialName(value = "started_at")

val startedAt: Instant?

the UTC date and time (in RFC3339 format) of when the poll began.

val status: PollStatus

the poll's status: ACTIVE, COMPLETED, TERMINATED, ARCHIVED, MODERATED, or INVALID.

val title: String

the question that viewers are voting on. For example, What game should I play next? The title may contain a maximum of 60 characters.