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

PollConfig

data class PollConfig

The PollConfig object is used to configure a poll.

Constructors

Link copied to clipboard
constructor(name: String, options: List<String>, description: String = "", votingVisibility: VotingVisibility = VotingVisibility.PUBLIC, enforceUniqueVote: Boolean = true, maxVotesAllowed: Int = 1, allowUserSuggestedOptions: Boolean = false, allowAnswers: Boolean = false)

Constructor to create a PollConfig with a list of option texts.

constructor(name: String, options: List<PollOption>, description: String = "", votingVisibility: VotingVisibility = VotingVisibility.PUBLIC, enforceUniqueVote: Boolean = true, maxVotesAllowed: Int = 1, allowUserSuggestedOptions: Boolean = false, allowAnswers: Boolean = false, extraData: Map<String, Any> = emptyMap())

Alternative constructor to create a PollConfig with a list of options with extra data.

Properties

Link copied to clipboard
val allowAnswers: Boolean

If set to true, users can send answers.

Link copied to clipboard
val allowUserSuggestedOptions: Boolean

If set to true, users can suggest new options.

Link copied to clipboard
val description: String

The description of the poll.

Link copied to clipboard
val enforceUniqueVote: Boolean

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

Link copied to clipboard
val extraData: Map<String, Any>

Any additional data associated with the poll.

Link copied to clipboard
val maxVotesAllowed: Int

The maximum number of votes a user can cast.

Link copied to clipboard
val name: String

The name of the poll.

Link copied to clipboard
val options: List<String>

The list of option texts for the poll.

Link copied to clipboard
val optionsWithExtraData: List<PollOption>

The list of options for the poll.

Link copied to clipboard
val votingVisibility: VotingVisibility

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