Class MessagePollData

java.lang.Object

net.dv8tion.jda.api.utils.messages.MessagePollData

All Implemented Interfaces:

SerializableData

public class MessagePollData
extends Object
implements SerializableData

A poll that can be attached to a MessageCreateRequest.

Example

channel.sendMessage("Hello guys! Check my poll:")
  .setPoll(
    MessagePollData.builder("Which programming language is better?")
      .addAnswer("Java", Emoji.fromFormatted("<:java:1006323566314274856>"))
      .addAnswer("Kotlin", Emoji.fromFormatted("<:kotlin:295940257797636096>"))
      .build())
  .queue()

See Also:

• builder(String)
• MessageCreateBuilder.setPoll(MessagePollData)

Constructor Summary

Constructors

Constructor	Description
MessagePollData(MessagePoll.LayoutType layout, MessagePoll.Question question, List<MessagePoll.Answer> answers, Duration duration, boolean isMultiAnswer)

Method Summary

Modifier and Type	Method	Description
static MessagePollBuilder	builder(String title)	Creates a new MessagePollBuilder.
static MessagePollData	from(MessagePoll poll)	Converts a MessagePoll to a sendable MessagePollData instance.
DataObject	toData()	Serialized DataObject for this object.

Methods inherited from class Object

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

Constructor Details

MessagePollData

public MessagePollData(MessagePoll.LayoutType layout,
 MessagePoll.Question question,
 List<MessagePoll.Answer> answers,
 Duration duration,
 boolean isMultiAnswer)

Method Details

builder

@Nonnull
public static MessagePollBuilder builder(@Nonnull
 String title)

Creates a new MessagePollBuilder.

A poll must have at least one answer.

Parameters:

title - The poll title (up to 300 characters)

Returns:

MessagePollBuilder

Throws:

IllegalArgumentException - If the title is blank or longer than 300 characters

from

@Nonnull
public static MessagePollData from(@Nonnull
 MessagePoll poll)

Converts a MessagePoll to a sendable MessagePollData instance.
This does not support duration, which cannot be derived from an active poll.

Parameters:

poll - The poll to copy

Returns:

MessagePollData instance

Throws:

IllegalArgumentException - If null is provided

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject