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

Interface MessageCreateRequest<R extends MessageCreateRequest<R>>

Type Parameters:

R - The return type for method chaining convenience

All Superinterfaces:

MessageData, MessageRequest<R>

All Known Subinterfaces:

ForumPostAction, MessageCreateAction, ReplyCallbackAction, WebhookMessageCreateAction<T>

All Known Implementing Classes:

MessageCreateBuilder

public interface MessageCreateRequest<R extends MessageCreateRequest<R>>
extends MessageRequest<R>

Specialized abstraction of setters and accumulators for creating messages throughout the API.

See Also:

• MessageCreateBuilder
• MessageCreateData
• MessageCreateAction

Method Summary

Modifier and Type	Method	Description
default R	addActionRow(Collection<? extends ItemComponent> components)	Appends a single ActionRow to the request.
default R	addActionRow(ItemComponent... components)	Appends a single ActionRow to the request.
R	addComponents(Collection<? extends LayoutComponent> components)	Appends the provided LayoutComponents to the request.
default R	addComponents(LayoutComponent... components)	Appends the provided LayoutComponents to the request.
R	addContent(String content)	Appends the content to the currently set content of this request.
R	addEmbeds(Collection<? extends MessageEmbed> embeds)	Appends the provided MessageEmbeds to the request.
default R	addEmbeds(MessageEmbed... embeds)	Appends the provided MessageEmbeds to the request.
R	addFiles(Collection<? extends FileUpload> files)	Appends the provided FileUploads to the request.
default R	addFiles(FileUpload... files)	Appends the provided FileUploads to the request.
default R	applyData(MessageCreateData data)	Applies the provided MessageCreateData to this request.
default R	applyEditData(MessageEditData data)	Applies the provided MessageEditData to this request.
default R	applyMessage(Message message)	Applies all the data of the provided Message and attempts to copy it.
List<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.
MessagePollData	getPoll()	The poll attached to this message
R	setPoll(MessagePollData poll)	Add a poll to this message.
R	setSuppressedNotifications(boolean suppressed)	Set whether this message should trigger push/desktop notifications to other users.
R	setTTS(boolean tts)	Whether the message should use Text-to-Speech (TTS).

Methods inherited from interface net.dv8tion.jda.api.utils.messages.MessageData

getAllowedMentions, getComponents, getContent, getEmbeds, getMentionedRoles, getMentionedUsers, isMentionRepliedUser, isSuppressEmbeds

Methods inherited from interface net.dv8tion.jda.api.utils.messages.MessageRequest

mention, mention, mentionRepliedUser, mentionRoles, mentionRoles, mentionRoles, mentionUsers, mentionUsers, mentionUsers, setActionRow, setActionRow, setAllowedMentions, setComponents, setComponents, setContent, setEmbeds, setEmbeds, setFiles, setFiles, setSuppressEmbeds

Method Details

addContent

@Nonnull
R addContent(@Nonnull
 String content)

Appends the content to the currently set content of this request.
Use MessageRequest.setContent(String) instead, to replace the content entirely.

Example
Sending a message with the content "Hello World!":

 channel.sendMessage("Hello ").addContent("World!").queue();
 

Parameters:

content - The content to append

Returns:

The same instance for chaining

Throws:

IllegalArgumentException - If the provided content is null or the accumulated content is longer than 2000 characters

addEmbeds

@Nonnull
R addEmbeds(@Nonnull
 Collection<? extends MessageEmbed> embeds)

Appends the provided MessageEmbeds to the request.
Use MessageRequest.setEmbeds(Collection) instead, to replace the embeds entirely.

Example
Sending a message with multiple embeds:

 channel.sendMessageEmbeds(embed1).addEmbeds(embed2).queue();
 

Parameters:

embeds - The embeds to add

Returns:

The same instance for chaining

Throws:

IllegalArgumentException - If null is provided or the accumulated embed list is longer than 10

addEmbeds

@Nonnull
default R addEmbeds(@Nonnull
 MessageEmbed... embeds)

Appends the provided MessageEmbeds to the request.
Use MessageRequest.setEmbeds(Collection) instead, to replace the embeds entirely.

Example
Sending a message with multiple embeds:

 channel.sendMessageEmbeds(embed1).addEmbeds(embed2).queue();
 

Parameters:

embeds - The embeds to add

Returns:

The same instance for chaining

Throws:

IllegalArgumentException - If null is provided or the accumulated embed list is longer than 10

addComponents

@Nonnull
R addComponents(@Nonnull
 Collection<? extends LayoutComponent> components)

Appends the provided LayoutComponents to the request.
Use MessageRequest.setComponents(Collection) instead, to replace the components entirely.

Example
Sending a message with multiple action rows:

 channel.sendMessageComponents(ActionRow.of(selectMenu))
        .addComponents(ActionRow.of(button1, button2))
        .queue();
 

Parameters:

components - The layout components to add

Returns:

The same instance for chaining

Throws:

IllegalArgumentException -

• If null is provided
• If any of the components is not message compatible
• If the accumulated list of components is longer than 5

See Also:

• ActionRow

addComponents

@Nonnull
default R addComponents(@Nonnull
 LayoutComponent... components)

Appends the provided LayoutComponents to the request.
Use MessageRequest.setComponents(Collection) instead, to replace the components entirely.

Example
Sending a message with multiple action rows:

 channel.sendMessageComponents(ActionRow.of(selectMenu))
        .addComponents(ActionRow.of(button1, button2))
        .queue();
 

Parameters:

components - The layout components to add

Returns:

The same instance for chaining

Throws:

IllegalArgumentException -

• If null is provided
• If any of the components is not message compatible
• If the accumulated list of components is longer than 5

See Also:

• ActionRow

addActionRow

@Nonnull
default R addActionRow(@Nonnull
 Collection<? extends ItemComponent> components)

Appends a single ActionRow to the request.
Use MessageRequest.setComponents(Collection) instead, to replace the components entirely.

Example
Sending a message with multiple action rows:

 channel.sendMessageComponents(ActionRow.of(selectMenu))
        .addActionRow(button1, button2)
        .queue();
 

Parameters:

components - The components to add to the action row, must not be empty

Returns:

The same instance for chaining

Throws:

IllegalArgumentException -

• If null is provided
• If any of the components is not message compatible
• If the accumulated list of components is longer than 5
• In all the same cases as ActionRow.of(Collection) throws an exception

See Also:

• ActionRow.of(Collection)

addActionRow

@Nonnull
default R addActionRow(@Nonnull
 ItemComponent... components)

Appends a single ActionRow to the request.
Use MessageRequest.setComponents(Collection) instead, to replace the components entirely.

Example
Sending a message with multiple action rows:

 channel.sendMessageComponents(ActionRow.of(selectMenu))
        .addActionRow(button1, button2)
        .queue();
 

Parameters:

components - The components to add to the action row, must not be empty

Returns:

The same instance for chaining

Throws:

IllegalArgumentException -

• If null is provided
• If any of the components is not message compatible
• If the accumulated list of components is longer than 5
• In all the same cases as ActionRow.of(ItemComponent...) throws an exception

See Also:

• ActionRow.of(ItemComponent...)

addFiles

@Nonnull
R addFiles(@Nonnull
 Collection<? extends FileUpload> files)

Appends the provided FileUploads to the request.
Use MessageRequest.setFiles(Collection) instead, to replace the file attachments entirely.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Example
Sending a message with multiple files:

 channel.sendFiles(file1).addFiles(file2).queue();
 

Parameters:

files - The files to add

Returns:

The same instance for chaining

Throws:

IllegalArgumentException - If null is provided

addFiles

@Nonnull
default R addFiles(@Nonnull
 FileUpload... files)

Appends the provided FileUploads to the request.
Use MessageRequest.setFiles(Collection) instead, to replace the file attachments entirely.

Resource Handling Note: Once the request is handed off to the requester, for example when you call RestAction.queue(), the requester will automatically clean up all opened files by itself. You are only responsible to close them yourself if it is never handed off properly. For instance, if an exception occurs after using FileUpload.fromData(File), before calling RestAction.queue(). You can safely use a try-with-resources to handle this, since FileUpload.close() becomes ineffective once the request is handed off.

Example
Sending a message with multiple files:

 channel.sendFiles(file1).addFiles(file2).queue();
 

Parameters:

files - The files to add

Returns:

The same instance for chaining

Throws:

IllegalArgumentException - If null is provided

getAttachments

@Nonnull
List<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
MessagePollData getPoll()

The poll attached to this message

Returns:

The attached poll, or null if no poll is present

setPoll

@Nonnull
R setPoll(@Nullable
 MessagePollData poll)

Add a poll to this message.

Parameters:

poll - The poll to send

Returns:

The same instance for chaining

See Also:

• MessagePollBuilder

setTTS

@Nonnull
R setTTS(boolean tts)

Whether the message should use Text-to-Speech (TTS).

Requires Permission.MESSAGE_TTS to be enabled.

Parameters:

tts - True, if the message should use TTS

Returns:

The same instance for chaining

setSuppressedNotifications

@Nonnull
R setSuppressedNotifications(boolean suppressed)

Set whether this message should trigger push/desktop notifications to other users.
When a message is suppressed, it will not trigger push/desktop notifications.

Parameters:

suppressed - True, if this message should not trigger push/desktop notifications

Returns:

The same reply action, for chaining convenience

applyData

@Nonnull
default R applyData(@Nonnull
 MessageCreateData data)

Applies the provided MessageCreateData to this request.

Parameters:

data - The message create data to apply

Returns:

The same instance for chaining

Throws:

IllegalArgumentException - If the data is null

applyMessage

@Nonnull
default R applyMessage(@Nonnull
 Message message)

Description copied from interface: MessageRequest

Applies all the data of the provided Message and attempts to copy it.
This cannot copy the file attachments of the message, they must be manually downloaded and provided to MessageRequest.setFiles(FileUpload...).
The allowed mentions are not updated to reflect the provided message, and might mention users that the message did not.

For edit requests, this will set MessageEditRequest.setReplace(boolean) to true, and replace the existing message completely.

Specified by:

applyMessage in interface MessageRequest<R extends MessageCreateRequest<R>>

Parameters:

message - The message to copy the data from

Returns:

The same instance for chaining

applyEditData

@Nonnull
default R applyEditData(@Nonnull
 MessageEditData data)

Applies the provided MessageEditData to this request.
This will only set fields which were explicitly set on the MessageEditBuilder, unless it was configured to be replacing.

This will not copy the message's attachments, only any configured FileUploads. To copy attachments, you must download them explicitly instead.

Parameters:

data - The message create data to apply

Returns:

The same instance for chaining

Throws:

IllegalArgumentException - If the data is null