All Implemented Interfaces:

@Immutable() 
public final class Poll

The Poll object represents a poll in a channel.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`id`
`private final String`	`name`
`private final String`	`description`
`private final List<Option>`	`options`
`private final VotingVisibility`	`votingVisibility`
`private final Boolean`	`enforceUniqueVote`
`private final Integer`	`maxVotesAllowed`
`private final Boolean`	`allowUserSuggestedOptions`
`private final Boolean`	`allowAnswers`
`private final Map<String, Integer>`	`voteCountsByOption`
`private final List<Vote>`	`votes`
`private final List<Vote>`	`ownVotes`
`private final Date`	`createdAt`
`private final Date`	`updatedAt`
`private final Boolean`	`closed`
`private final List<Answer>`	`answers`

Constructor Summary

Constructors
Constructor	Description
`Poll(String id, String name, String description, List<Option> options, VotingVisibility votingVisibility, Boolean enforceUniqueVote, Integer maxVotesAllowed, Boolean allowUserSuggestedOptions, Boolean allowAnswers, Map<String, Integer> voteCountsByOption, List<Vote> votes, List<Vote> ownVotes, Date createdAt, Date updatedAt, Boolean closed, List<Answer> answers)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getId()`	The unique identifier of the poll.
`final String`	`getName()`	The name of the poll.
`final String`	`getDescription()`	The description of the poll.
`final List<Option>`	`getOptions()`	The list of options for the poll.
`final VotingVisibility`	`getVotingVisibility()`	The visibility of the votes.
`final Boolean`	`getEnforceUniqueVote()`	If set to true, a user can only vote once.
`final Integer`	`getMaxVotesAllowed()`	The maximum number of votes a user can cast.
`final Boolean`	`getAllowUserSuggestedOptions()`	If set to true, users can suggest new options.
`final Boolean`	`getAllowAnswers()`	If set to true, users can vote.
`final Map<String, Integer>`	`getVoteCountsByOption()`	The number of votes for each option.
`final List<Vote>`	`getVotes()`	The list of votes.
`final List<Vote>`	`getOwnVotes()`	The list of votes cast by the current user.
`final Date`	`getCreatedAt()`	The creation date of the poll.
`final Date`	`getUpdatedAt()`	The last update date of the poll.
`final Boolean`	`getClosed()`	If set to true, the poll is closed and no more votes can be cast.
`final List<Answer>`	`getAnswers()`	The list of poll answers.
`final List<Vote>`	`getVotes(Option option)`	Get the votes for a specific option.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Poll
```
Poll(String id, String name, String description, List<Option> options, VotingVisibility votingVisibility, Boolean enforceUniqueVote, Integer maxVotesAllowed, Boolean allowUserSuggestedOptions, Boolean allowAnswers, Map<String, Integer> voteCountsByOption, List<Vote> votes, List<Vote> ownVotes, Date createdAt, Date updatedAt, Boolean closed, List<Answer> answers)
```
- Method Detail
  - getId
```
 final String getId()
```
    The unique identifier of the poll.
  - getName
```
 final String getName()
```
    The name of the poll.
  - getDescription
```
 final String getDescription()
```
    The description of the poll.
  - getOptions
```
 final List<Option> getOptions()
```
    The list of options for the poll.
  - getVotingVisibility
```
 final VotingVisibility getVotingVisibility()
```
    The visibility of the votes. If set to VotingVisibility.ANONYMOUS, the votes will be anonymous.
  - getEnforceUniqueVote
```
 final Boolean getEnforceUniqueVote()
```
    If set to true, a user can only vote once.
  - getMaxVotesAllowed
```
 final Integer getMaxVotesAllowed()
```
    The maximum number of votes a user can cast.
  - getAllowUserSuggestedOptions
```
 final Boolean getAllowUserSuggestedOptions()
```
    If set to true, users can suggest new options.
  - getAllowAnswers
```
 final Boolean getAllowAnswers()
```
    If set to true, users can vote.
  - getVoteCountsByOption
```
 final Map<String, Integer> getVoteCountsByOption()
```
    The number of votes for each option.
  - getVotes
```
 final List<Vote> getVotes()
```
    The list of votes.
  - getOwnVotes
```
 final List<Vote> getOwnVotes()
```
    The list of votes cast by the current user.
  - getCreatedAt
```
 final Date getCreatedAt()
```
    The creation date of the poll.
  - getUpdatedAt
```
 final Date getUpdatedAt()
```
    The last update date of the poll.
  - getClosed
```
 final Boolean getClosed()
```
    If set to true, the poll is closed and no more votes can be cast.
  - getAnswers
```
 final List<Answer> getAnswers()
```
    The list of poll answers.
  - getVotes
```
 final List<Vote> getVotes(Option option)
```
    Get the votes for a specific option.
    
    Parameters:
    
    option - The option to get the votes for.
    
    Returns:
    
    The list of votes for the option.

Class Poll

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Poll

Method Detail

getId

getName

getDescription

getOptions

getVotingVisibility

getEnforceUniqueVote

getMaxVotesAllowed

getAllowUserSuggestedOptions

getAllowAnswers

getVoteCountsByOption

getVotes

getOwnVotes

getCreatedAt

getUpdatedAt

getClosed

getAnswers

getVotes