SendbirdChat/com.sendbird.android.poll/Poll

Poll

class Poll

Class representing a poll.

A poll instance can be created using Poll.create with PollCreateParams and updated using GroupChannel.updatePoll with PollUpdateParams class. A poll can be attached to a message using UserMessageCreateParams.pollId.

Since

4.1.0

Types

Companion

object Companion

Properties

allowMultipleVotes

var allowMultipleVotes: Boolean

True if this poll allows multiple votes, false otherwise.

allowUserSuggestion

var allowUserSuggestion: Boolean

True if this poll allows user suggestion, false otherwise.

closeAt

var closeAt: Long

Unix timestamp at which the poll has closed or will close. (second precision) If poll closing time is not specified, this value will be -1.

createdAt

var createdAt: Long

Unix timestamp at which the poll is created.

createdBy

var createdBy: String?

UserId of the poll creator. null if the creator account is removed.

data

var data: PollData?

An additional json data to accompany the poll.

val id: Long

A unique identifier for this poll.

messageId

val messageId: Long

A id of the message that contains this poll

options

var options: List<PollOption>

Options for this poll.

status

var status: PollStatus

Indicates whether this poll is PollStatus.OPEN, or PollStatus.CLOSED

title

var title: String

Title of the poll.

updatedAt

var updatedAt: Long

Unix timestamp at which the poll is updated.

votedPollOptionIds

var votedPollOptionIds: List<Long>

Contains optionIds which the current user voted on. If the current user has not voted, this list will be empty.

voterCount

var voterCount: Long

Total voter count.

Functions

applyPollUpdateEvent

fun applyPollUpdateEvent(event: PollUpdateEvent): Boolean

Applies poll update event to this user message's poll.

applyPollVoteEvent

fun applyPollVoteEvent(event: PollVoteEvent): Boolean

Applies poll vote event to this user message's poll.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

serialize

fun serialize(): ByteArray

Serializes the Poll instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData.

toString

open override fun toString(): String