Class MessageEditData

java.lang.Object

net.dv8tion.jda.api.utils.messages.MessageEditData

All Implemented Interfaces:

AutoCloseable, SerializableData, MessageData

public class MessageEditData
extends Object
implements MessageData, AutoCloseable, SerializableData

Output of a MessageEditRequest and used for editing messages in channels/webhooks/interactions.

See Also:

• MessageEditBuilder
• MessageChannel.editMessageById(String, MessageEditData)
• IMessageEditCallback.editMessage(MessageEditData)
• WebhookClient.editMessageById(String, MessageEditData)
• InteractionHook.editOriginal(MessageEditData)

Method Summary

Modifier and Type	Method	Description
void	close()
static Set<AttachedFile>	createAllDistinctFiles(Collection<AttachedFile> files, Collection<MessageTopLevelComponentUnion> components)
static MessageEditData	fromContent(String content)	Shortcut for new MessageEditBuilder().setContent(content).build().
static MessageEditData	fromCreateData(MessageCreateData data)	Shortcut for new MessageCreateBuilder().applyCreateData(data).build().
static MessageEditData	fromEmbeds(Collection<? extends MessageEmbed> embeds)	Shortcut for new MessageEditBuilder().setEmbeds(embeds).build().
static MessageEditData	fromEmbeds(MessageEmbed... embeds)	Shortcut for new MessageEditBuilder().setEmbeds(embeds).build().
static MessageEditData	fromFiles(Collection<? extends FileUpload> files)	Shortcut for new MessageEditBuilder().setFiles(embeds).build().
static MessageEditData	fromFiles(FileUpload... files)	Shortcut for new MessageEditBuilder().setFiles(embeds).build().
static MessageEditData	fromMessage(Message message)	Shortcut for new MessageEditBuilder().applyMessage(message).build().
Set<? extends AttachedFile>	getAllDistinctFiles()	Returns both the FileUploads attached to that message, and those added indirectly to this message, such as from V2 components and embeds, references to the same uploads are deduplicated.
EnumSet<Message.MentionType>	getAllowedMentions()	The mention types which are whitelisted.
List<AttachedFile>	getAttachments()	The AttachedFiles attached to this message.
List<MessageTopLevelComponentUnion>	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.
boolean	isMentionRepliedUser()	Whether this message would mention a user, if it is sent as a reply.
boolean	isSuppressEmbeds()	Whether embeds will be suppressed on this message.
boolean	isUsingComponentsV2()	Whether this message is using components V2.
DataObject	toData()	Serialized DataObject for this object.

Methods inherited from class Object

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

Methods inherited from interface MessageData

getComponentTree

Method Details

fromContent

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

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

Parameters:

content - The message content (up to 2000)

Returns:

New valid instance of MessageEditData

Throws:

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

See Also:

• MessageEditBuilder.setContent(String)

fromEmbeds

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

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

Parameters:

embeds - The message embeds (up to 10)

Returns:

New valid instance of MessageEditData

Throws:

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

See Also:

• MessageEditBuilder.setEmbeds(Collection)

fromEmbeds

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

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

Parameters:

embeds - The message embeds (up to 10)

Returns:

New valid instance of MessageEditData

Throws:

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

See Also:

• MessageEditBuilder.setEmbeds(Collection)

fromFiles

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

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

Parameters:

files - The file uploads

Returns:

New valid instance of MessageEditData

Throws:

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

See Also:

• MessageRequest.setFiles(Collection)

fromFiles

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

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

Parameters:

files - The file uploads

Returns:

New valid instance of MessageEditData

Throws:

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

See Also:

• MessageRequest.setFiles(Collection)

fromMessage

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

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

Parameters:

message - The message to apply

Returns:

New valid instance of MessageEditData

Throws:

IllegalArgumentException - If the message is null or a system message

See Also:

• MessageRequest.applyMessage(Message)

fromCreateData

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

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

Parameters:

data - The message create data to apply

Returns:

New valid instance of MessageEditData

Throws:

IllegalArgumentException - If the data is null or empty

See Also:

• MessageEditRequest.applyCreateData(MessageCreateData)

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 set

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 set

See Also:

• MessageRequest.setEmbeds(Collection)

getComponents

@Nonnull
public List<MessageTopLevelComponentUnion> getComponents()

The components of the message.

Specified by:

getComponents in interface MessageData

Returns:

The components or an empty list if none were set

See Also:

• MessageRequest.setEmbeds(Collection)

isUsingComponentsV2

public boolean isUsingComponentsV2()

Description copied from interface: MessageData

Whether this message is using components V2.

Specified by:

isUsingComponentsV2 in interface MessageData

Returns:

true if this is using components V2

See Also:

• MessageRequest.useComponentsV2()
• MessageRequest.useComponentsV2(boolean)

getAttachments

@Nonnull
public List<AttachedFile> getAttachments()

The AttachedFiles attached to this message.

Specified by:

getAttachments in interface MessageData

Returns:

The list of attachments, or an empty list if none were set

See Also:

• MessageRequest.setFiles(Collection)

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

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

getAllDistinctFiles

@Nonnull
public Set<? extends AttachedFile> getAllDistinctFiles()

Returns both the FileUploads attached to that message, and those added indirectly to this message, such as from V2 components and embeds, references to the same uploads are deduplicated.

Returns:

The set of all file uploads

createAllDistinctFiles

@Nonnull
public static Set<AttachedFile> createAllDistinctFiles(@Nullable
 Collection<AttachedFile> files,
 @Nonnull
 Collection<MessageTopLevelComponentUnion> components)

close

public void close()

Specified by:

close in interface AutoCloseable