Package net.dv8tion.jda.api.utils.messages

Class MessageCreateData

java.lang.Object

net.dv8tion.jda.api.utils.messages.MessageCreateData

All Implemented Interfaces:

AutoCloseable, SerializableData, MessageData

public class MessageCreateData
extends Object
implements MessageData, AutoCloseable, SerializableData

Output of a MessageCreateBuilder and used for sending messages to channels/webhooks/interactions.

See Also:

• MessageCreateBuilder
• MessageChannel.sendMessage(MessageCreateData)
• IReplyCallback.reply(MessageCreateData)
• WebhookClient.sendMessage(MessageCreateData)

Method Summary

Modifier and Type	Method	Description
void	close()
static MessageCreateData	fromContent(String content)	Shortcut for new MessageCreateBuilder().setContent(content).build().
static MessageCreateData	fromEditData(MessageEditData data)	Shortcut for new MessageCreateBuilder().applyEditData(data).build().
static MessageCreateData	fromEmbeds(Collection<? extends MessageEmbed> embeds)	Shortcut for new MessageCreateBuilder().setEmbeds(embeds).build().
static MessageCreateData	fromEmbeds(MessageEmbed... embeds)	Shortcut for new MessageCreateBuilder().setEmbeds(embeds).build().
static MessageCreateData	fromFiles(Collection<? extends FileUpload> files)	Shortcut for new MessageCreateBuilder().setFiles(embeds).build().
static MessageCreateData	fromFiles(FileUpload... files)	Shortcut for new MessageCreateBuilder().setFiles(embeds).build().
static MessageCreateData	fromMessage(Message message)	Shortcut for new MessageCreateBuilder().applyMessage(message).build().
EnumSet<Message.MentionType>	getAllowedMentions()	The mention types which are whitelisted.
List<? extends FileUpload>	getAttachments()	The configured message attachments as AttachedFile, this is the opposite of MessageRequest.setFiles(Collection) and only returns what was set using that setter.
List<LayoutComponent>	getComponents()	The components of the message.
String	getContent()	The content of the message.
List<MessageEmbed>	getEmbeds()	The embeds of the message.
List<FileUpload>	getFiles()	The FileUploads attached to this message.
Set<String>	getMentionedRoles()	The IDs for roles which are allowed to be mentioned, or an empty list.
Set<String>	getMentionedUsers()	The IDs for users which are allowed to be mentioned, or an empty list.
MessagePollData	getPoll()	The poll to send with the message
boolean	isMentionRepliedUser()	Whether this message would mention a user, if it is sent as a reply.
boolean	isSuppressedNotifications()	Whether this message is silent.
boolean	isSuppressEmbeds()	Whether embeds will be suppressed on this message.
boolean	isTTS()	Whether this message uses Text-to-Speech (TTS).
DataObject	toData()	Serialized DataObject for this object.

Methods inherited from class java.lang.Object

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

Method Details

fromContent

@Nonnull
public static MessageCreateData fromContent(@Nonnull
 String content)

Shortcut for new MessageCreateBuilder().setContent(content).build().

Parameters:

content - The message content (up to 2000)

Returns:

New valid instance of MessageCreateData

Throws:

IllegalArgumentException - If the content is null, empty, or longer than 2000

See Also:

• AbstractMessageBuilder.setContent(String)

fromEmbeds

@Nonnull
public static MessageCreateData fromEmbeds(@Nonnull
 Collection<? extends MessageEmbed> embeds)

Shortcut for new MessageCreateBuilder().setEmbeds(embeds).build().

Parameters:

embeds - The message embeds (up to 10)

Returns:

New valid instance of MessageCreateData

Throws:

IllegalArgumentException - If the embed list is null, empty, or longer than 10

See Also:

• AbstractMessageBuilder.setEmbeds(Collection)

fromEmbeds

@Nonnull
public static MessageCreateData fromEmbeds(@Nonnull
 MessageEmbed... embeds)

Shortcut for new MessageCreateBuilder().setEmbeds(embeds).build().

Parameters:

embeds - The message embeds (up to 10)

Returns:

New valid instance of MessageCreateData

Throws:

IllegalArgumentException - If the embed list is null, empty, or longer than 10

See Also:

• AbstractMessageBuilder.setEmbeds(Collection)

fromFiles

@Nonnull
public static MessageCreateData fromFiles(@Nonnull
 Collection<? extends FileUpload> files)

Shortcut for new MessageCreateBuilder().setFiles(embeds).build().

Parameters:

files - The file uploads

Returns:

New valid instance of MessageCreateData

Throws:

IllegalArgumentException - If the null is provided or the list is empty

See Also:

• MessageCreateBuilder.setFiles(Collection)

fromFiles

@Nonnull
public static MessageCreateData fromFiles(@Nonnull
 FileUpload... files)

Shortcut for new MessageCreateBuilder().setFiles(embeds).build().

Parameters:

files - The file uploads

Returns:

New valid instance of MessageCreateData

Throws:

IllegalArgumentException - If the null is provided or the list is empty

See Also:

• MessageCreateBuilder.setFiles(Collection)

fromMessage

@Nonnull
public static MessageCreateData fromMessage(@Nonnull
 Message message)

Shortcut for new MessageCreateBuilder().applyMessage(message).build().

Parameters:

message - The message to apply

Returns:

New valid instance of MessageCreateData

Throws:

IllegalArgumentException - If the message is null or a system message

See Also:

• MessageRequest.applyMessage(Message)

fromEditData

@Nonnull
public static MessageCreateData fromEditData(@Nonnull
 MessageEditData data)

Shortcut for new MessageCreateBuilder().applyEditData(data).build().

Parameters:

data - The message edit data to apply

Returns:

New valid instance of MessageCreateData

Throws:

IllegalArgumentException - If the data is null or empty

See Also:

• MessageCreateRequest.applyEditData(MessageEditData)

getContent

@Nonnull
public String getContent()

The content of the message.

Specified by:

getContent in interface MessageData

Returns:

The content or an empty string if none was provided

See Also:

• MessageRequest.setContent(String)

getEmbeds

@Nonnull
public List<MessageEmbed> getEmbeds()

The embeds of the message.

Specified by:

getEmbeds in interface MessageData

Returns:

The embeds or an empty list if none were provided

See Also:

• MessageRequest.setEmbeds(Collection)

getComponents

@Nonnull
public List<LayoutComponent> getComponents()

The components of the message.

Specified by:

getComponents in interface MessageData

Returns:

The components or an empty list if none were provided

See Also:

• MessageRequest.setEmbeds(Collection)

getAttachments

@Nonnull
public List<? extends FileUpload> getAttachments()

Description copied from interface: MessageData

The configured message attachments as AttachedFile, this is the opposite of MessageRequest.setFiles(Collection) and only returns what was set using that setter.

For message edit requests, this will not be the current file attachments of the message.

Specified by:

getAttachments in interface MessageData

Returns:

The currently configured attachments, or an empty list if none were set yet

See Also:

• MessageRequest.setFiles(Collection)

getPoll

@Nullable
public MessagePollData getPoll()

The poll to send with the message

Returns:

The poll, or null if no poll is sent

isSuppressEmbeds

public boolean isSuppressEmbeds()

Description copied from interface: MessageData

Whether embeds will be suppressed on this message.

Specified by:

isSuppressEmbeds in interface MessageData

Returns:

True, if embeds are suppressed

isTTS

public boolean isTTS()

Whether this message uses Text-to-Speech (TTS).

Returns:

True, if text to speech will be used when this is sent

isSuppressedNotifications

public boolean isSuppressedNotifications()

Whether this message is silent.

Returns:

True, if the message will not trigger push and desktop notifications

getMentionedUsers

@Nonnull
public Set<String> getMentionedUsers()

The IDs for users which are allowed to be mentioned, or an empty list.

Specified by:

getMentionedUsers in interface MessageData

Returns:

The user IDs which are mention whitelisted

getMentionedRoles

@Nonnull
public Set<String> getMentionedRoles()

The IDs for roles which are allowed to be mentioned, or an empty list.

Specified by:

getMentionedRoles in interface MessageData

Returns:

The role IDs which are mention whitelisted

getAllowedMentions

@Nonnull
public EnumSet<Message.MentionType> getAllowedMentions()

The mention types which are whitelisted.

Specified by:

getAllowedMentions in interface MessageData

Returns:

The mention types which can be mentioned by this message

isMentionRepliedUser

public boolean isMentionRepliedUser()

Whether this message would mention a user, if it is sent as a reply.

Specified by:

isMentionRepliedUser in interface MessageData

Returns:

True, if this would mention with the reply

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

getFiles

@Nonnull
public List<FileUpload> getFiles()

The FileUploads attached to this message.

Returns:

The list of file uploads

close

public void close()

Specified by:

close in interface AutoCloseable