TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixPoll

A channel poll.

Overview

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

channelPointsPerVote

Type: number

The amount of channel points that a vote costs.

choices

Type: HelixPollChoice[]

The choices of the poll.

durationInSeconds

Type: number

The duration of the poll, in seconds.

endDate

Type: Date

The date when the poll ended or will end.

id

Type: string

The ID of the poll.

isChannelPointsVotingEnabled

Type: boolean

Whether voting with channel points is enabled for the poll.

startDate

Type: Date

The date when the poll started.

status

Type: HelixPollStatus

The status of the poll.

title

Type: string

The title of the poll.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser