Package net.dv8tion.jda.internal.entities.messages

Class MessagePollImpl

java.lang.Object

net.dv8tion.jda.internal.entities.messages.MessagePollImpl

All Implemented Interfaces:

MessagePoll

public class MessagePollImpl
extends Object
implements MessagePoll

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.messages.MessagePoll

MessagePoll.Answer, MessagePoll.LayoutType, MessagePoll.Question

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.messages.MessagePoll

MAX_ANSWER_TEXT_LENGTH, MAX_ANSWERS, MAX_DURATION_HOURS, MAX_QUESTION_TEXT_LENGTH

Constructor Summary

Constructors

Constructor	Description
MessagePollImpl(MessagePoll.LayoutType layout, MessagePoll.Question question, List<MessagePoll.Answer> answers, OffsetDateTime expiresAt, boolean isMultiAnswer, boolean isFinalizedVotes)

Method Summary

Modifier and Type	Method	Description
List<MessagePoll.Answer>	getAnswers()	The poll answers.
MessagePoll.LayoutType	getLayout()	The layout of the poll.
MessagePoll.Question	getQuestion()	The poll question, representing the title.
OffsetDateTime	getTimeExpiresAt()	The time when this poll will automatically expire.
boolean	isFinalizedVotes()	Whether this poll is finalized and recounted.
boolean	isMultiAnswer()	Whether this poll allows multiple answers to be selected.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.messages.MessagePoll

isExpired

Constructor Details

MessagePollImpl

public MessagePollImpl(MessagePoll.LayoutType layout,
 MessagePoll.Question question,
 List<MessagePoll.Answer> answers,
 OffsetDateTime expiresAt,
 boolean isMultiAnswer,
 boolean isFinalizedVotes)

Method Details

getLayout

@Nonnull
public MessagePoll.LayoutType getLayout()

Description copied from interface: MessagePoll

The layout of the poll.

Specified by:

getLayout in interface MessagePoll

Returns:

The poll layout, or MessagePoll.LayoutType.UNKNOWN if unknown

getQuestion

@Nonnull
public MessagePoll.Question getQuestion()

Description copied from interface: MessagePoll

The poll question, representing the title.

Specified by:

getQuestion in interface MessagePoll

Returns:

MessagePoll.Question

getAnswers

@Nonnull
public List<MessagePoll.Answer> getAnswers()

Description copied from interface: MessagePoll

The poll answers.

Each answer also has the current votes. The votes might not be finalized and might be incorrect before the poll has expired, see MessagePoll.isFinalizedVotes().

Specified by:

getAnswers in interface MessagePoll

Returns:

Immutable List of MessagePoll.Answer

getTimeExpiresAt

@Nonnull
public OffsetDateTime getTimeExpiresAt()

Description copied from interface: MessagePoll

The time when this poll will automatically expire.

The author of the poll can always expire the poll manually, using Message.endPoll().

Specified by:

getTimeExpiresAt in interface MessagePoll

Returns:

OffsetDateTime representing the time when the poll expires automatically, or null if it never expires

isMultiAnswer

public boolean isMultiAnswer()

Description copied from interface: MessagePoll

Whether this poll allows multiple answers to be selected.

Specified by:

isMultiAnswer in interface MessagePoll

Returns:

True, if this poll allows multi selection

isFinalizedVotes

public boolean isFinalizedVotes()

Description copied from interface: MessagePoll

Whether this poll is finalized and recounted.

The votes for answers might be inaccurate due to eventual consistency, until this is true. Finalization does not mean the votes cannot change anymore, use MessagePoll.isExpired() to check if a poll has ended.

Specified by:

isFinalizedVotes in interface MessagePoll

Returns:

True, if the votes have been precisely counted