stream-chat-android-core/io.getstream.chat.android.models/Poll

Poll

@Immutable

data class Poll(val id: String, val name: String, val description: String, val options: List<Option>, val votingVisibility: VotingVisibility, val enforceUniqueVote: Boolean, val maxVotesAllowed: Int, val allowUserSuggestedOptions: Boolean, val allowAnswers: Boolean, val voteCount: Int, val voteCountsByOption: Map<String, Int>, val votes: List<Vote>, val ownVotes: List<Vote>, val createdAt: Date, val updatedAt: Date, val closed: Boolean, val answersCount: Int, val answers: List<Answer> = emptyList(), val createdBy: User?, val extraData: Map<String, Any> = emptyMap()) : ComparableFieldProvider

The Poll object represents a poll in a channel.

Constructors

constructor(id: String, name: String, description: String, options: List<Option>, votingVisibility: VotingVisibility, enforceUniqueVote: Boolean, maxVotesAllowed: Int, allowUserSuggestedOptions: Boolean, allowAnswers: Boolean, voteCount: Int, voteCountsByOption: Map<String, Int>, votes: List<Vote>, ownVotes: List<Vote>, createdAt: Date, updatedAt: Date, closed: Boolean, answersCount: Int, answers: List<Answer> = emptyList(), createdBy: User?, extraData: Map<String, Any> = emptyMap())

Properties

val allowAnswers: Boolean

If set to true, users can vote.

allowUserSuggestedOptions

val allowUserSuggestedOptions: Boolean

If set to true, users can suggest new options.

val answers: List<Answer>

The list of poll answers.

val answersCount: Int

The total number of answers in the poll.

val closed: Boolean

If set to true, the poll is closed and no more votes can be cast.

val createdAt: Date

The creation date of the poll.

val createdBy: User?

The user who created the poll. This property is optional and might be null.

val description: String

The description of the poll.

enforceUniqueVote

val enforceUniqueVote: Boolean

If set to true, a user can only vote once.

val extraData: Map<String, Any>

Any additional data associated with the poll.

The unique identifier of the poll.

maxVotesAllowed

val maxVotesAllowed: Int

The maximum number of votes a user can cast.

val name: String

The name of the poll.

val options: List<Option>

The list of options for the poll.

val ownVotes: List<Vote>

The list of votes cast by the current user.

val updatedAt: Date

The last update date of the poll.

val voteCount: Int

The total number of votes cast in the poll.

voteCountsByOption

val voteCountsByOption: Map<String, Int>

The number of votes for each option.

val votes: List<Vote>

The list of votes.

votingVisibility

val votingVisibility: VotingVisibility

The visibility of the votes. If set to VotingVisibility.ANONYMOUS, the votes will be anonymous.

Functions

getComparableField

open override fun getComparableField(fieldName: String): Comparable<*>?

Gets a comparable fields from a name.

fun getVotes(option: Option): List<Vote>

Get the votes for a specific option.