core_v2_poll Script API

Ben Tiedt — Fri, 15 Jan 2021 19:33:26 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:33:26

Enables widgets to use Polls

Methods

Gets a poll.

#set($pollResponse = $core_v2_poll.Get($id))

var pollResponse = core_v2_poll.Get(id);

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required

[[Poll Script API Type|Poll]]

Gets a poll summary.

#set($voteSummaryResponse = $core_v2_poll.GetSummary($pollId))

var voteSummaryResponse = core_v2_poll.GetSummary(pollId);

Name	Type	Description	Required	Default	Options
pollId	`Guid`	Poll Id	Required

[[VoteSummary Script API Type|VoteSummary]]

Gets the current user's vote on a poll. Will return null if user hasn't voted.

#set($nullableResponse = $core_v2_poll.GetVote($pollId))

var nullableResponse = core_v2_poll.GetVote(pollId);

Name	Type	Description	Required	Default	Options
pollId	`Guid`	Poll Id	Required

Nullable of Guid

Casts a vote on the specified option for the current user.

$core_v2_poll.Vote($pollId, $optionId)

core_v2_poll.Vote(pollId, optionId);

Name	Type	Description	Required	Default	Options
pollId	`Guid`	Poll Id	Required
optionId	`Guid`	Option Id	Required

Nothing