Appearance
Interface: PollCreateData
Optional native participation and audience settings.
Extends
Properties
allow_vote_change?
ts
optional allow_vote_change?: boolean;Allow a viewer to change their vote while the poll is active.
Default Value
true
chat_command?
ts
optional chat_command?: string;Chat command (e.g. "!vote"); null = a bare number in chat counts as a vote.
Default Value
"!vote"
chat_voting_enabled?
ts
optional chat_voting_enabled?: boolean;Allow viewers to vote via chat messages.
Default Value
true
choices
ts
choices: string[];Choice labels (2 to 10).
duration
ts
duration: number;Voting window in seconds (10 to 1800), or null for manual closure.
max_choices?
ts
optional max_choices?: number;Maximum selections per viewer. Each selection receives the full weight.
Default Value
ts
1participation_mode?
ts
optional participation_mode?: "native" | "app_only";native: chat/viewer UI; app_only: only the owner installation's API.
Default Value
ts
'native'Inherited from
NativeVoteCreateOptions.participation_mode
results_visibility?
ts
optional results_visibility?: "live" | "after_end";Hide intermediate results from viewers and native display until final status. Streamer and owner retain access.
Default Value
ts
'live'Inherited from
NativeVoteCreateOptions.results_visibility
show_display?
ts
optional show_display?: boolean;Show the native overlay display; false = the app renders its own UI.
Default Value
true
title
ts
title: string;Poll question.