Class MessageBuilder
- java.lang.Object
-
- net.dv8tion.jda.api.MessageBuilder
-
- All Implemented Interfaces:
Appendable
public class MessageBuilder extends Object implements Appendable
Builder system used to buildMessages.
Internally the builder uses aStringBuilderto take advantage of the efficiencies offered by the StringBuilder, and the methods provided by this class are a combination of those offered by the StringBuilder andString.format(String, Object...).- Since:
- 1.0
- Author:
- Michael Ritter, Aljoscha Grebe
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMessageBuilder.FormattingHolds the available formatting used inappend(java.lang.CharSequence, net.dv8tion.jda.api.MessageBuilder.Formatting...)static interfaceMessageBuilder.SplitPolicyInterface to allow custom implementation of Splitting rules forMessageBuilder.buildAll(SplitPolicy...).
-
Constructor Summary
Constructors Constructor Description MessageBuilder()MessageBuilder(CharSequence content)MessageBuilder(EmbedBuilder builder)MessageBuilder(Message message)MessageBuilder(MessageEmbed embed)MessageBuilder(MessageBuilder builder)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessageBuilderappend(char c)MessageBuilderappend(CharSequence text)MessageBuilderappend(CharSequence text, int start, int end)MessageBuilderappend(CharSequence text, MessageBuilder.Formatting... format)Appends a String using the specified chatFormatting(s).MessageBuilderappend(Object object)Appends the string representation of an object to the Message.MessageBuilderappend(IMentionable mention)Appends a mention to the Message.MessageBuilderappendCodeBlock(CharSequence text, CharSequence language)Appends a code-block to the Message.MessageBuilderappendCodeLine(CharSequence text)Appends a code-line to the Message.MessageBuilderappendFormat(String format, Object... args)This method is an extended form ofString.format(String, Object...).Messagebuild()Creates aMessageobject from this MessageBuilderQueue<Message>buildAll(MessageBuilder.SplitPolicy... policy)MessageBuilderclear()Clears the current builder.StringBuildergetStringBuilder()Returns the underlyingStringBuilder.intindexOf(CharSequence target, int fromIndex, int endIndex)Returns the index within this string of the first occurrence of the specified substring between the specified indices.booleanisEmpty()Checks if the message contains any contend.intlastIndexOf(CharSequence target, int fromIndex, int endIndex)Returns the index within this string of the last occurrence of the specified substring between the specified indices.intlength()MessageBuilderreplace(String target, String replacement)Replaces each substring that matches the target string with the specified replacement string.MessageBuilderreplaceFirst(String target, String replacement)Replaces the first substring that matches the target string with the specified replacement string.MessageBuilderreplaceLast(String target, String replacement)Replaces the last substring that matches the target string with the specified replacement string.MessageActionsendTo(MessageChannel channel)Creates aMessageActionwith the current settings without building aMessageinstance first.MessageBuildersetContent(String content)Sets the content of the resulting Message
This will replace already added content.MessageBuildersetEmbed(MessageEmbed embed)Adds aMessageEmbedto the Message.MessageBuildersetNonce(String nonce)Sets the nonce of the built message(s).MessageBuildersetTTS(boolean tts)Makes the created Message a TTS message.MessageBuilderstripMentions(Guild guild)Removes all mentions and replaces them with the closest looking textual representation.MessageBuilderstripMentions(Guild guild, Message.MentionType... types)Removes all mentions of the specified types and replaces them with the closest looking textual representation.MessageBuilderstripMentions(JDA jda)Removes all mentions and replaces them with the closest looking textual representation.MessageBuilderstripMentions(JDA jda, Message.MentionType... types)Removes all mentions of the specified types and replaces them with the closest looking textual representation.
-
-
-
Constructor Detail
-
MessageBuilder
public MessageBuilder()
-
MessageBuilder
public MessageBuilder(@Nullable CharSequence content)
-
MessageBuilder
public MessageBuilder(@Nullable MessageBuilder builder)
-
MessageBuilder
public MessageBuilder(@Nullable EmbedBuilder builder)
-
MessageBuilder
public MessageBuilder(@Nullable MessageEmbed embed)
-
-
Method Detail
-
setTTS
@Nonnull public MessageBuilder setTTS(boolean tts)
Makes the created Message a TTS message.
TTS stands for Text-To-Speech. When a TTS method is received by the Discord client, it is vocalized so long as the user has not disabled TTS.- Parameters:
tts- whether the created Message should be a tts message- Returns:
- The MessageBuilder instance. Useful for chaining.
-
setEmbed
@Nonnull public MessageBuilder setEmbed(@Nullable MessageEmbed embed)
Adds aMessageEmbedto the Message. Embeds can be built using theEmbedBuilderand offer specialized formatting.- Parameters:
embed- the embed to add, or null to remove- Returns:
- The MessageBuilder instance. Useful for chaining.
-
setNonce
@Nonnull public MessageBuilder setNonce(@Nullable String nonce)
Sets the nonce of the built message(s). It is recommended to have only 100% unique strings to validate messages via this nonce.
The nonce will be available from the resulting message viaMessage.getNonce()in message received by events and RestAction responses.
Whennullis provided no nonce will be used.- Parameters:
nonce- Validation nonce string- Returns:
- The MessageBuilder instance. Useful for chaining.
- See Also:
Message.getNonce(), Cryptographic Nonce - Wikipedia
-
setContent
@Nonnull public MessageBuilder setContent(@Nullable String content)
Sets the content of the resulting Message
This will replace already added content.- Parameters:
content- The content to use, ornullto reset the content- Returns:
- The MessageBuilder instance. Useful for chaining.
- Throws:
IllegalArgumentException- If the provided content exceedsMessage.MAX_CONTENT_LENGTH- See Also:
Message.getContentRaw()
-
append
@Nonnull public MessageBuilder append(@Nullable CharSequence text)
- Specified by:
appendin interfaceAppendable
-
append
@Nonnull public MessageBuilder append(@Nullable CharSequence text, int start, int end)
- Specified by:
appendin interfaceAppendable
-
append
@Nonnull public MessageBuilder append(char c)
- Specified by:
appendin interfaceAppendable
-
append
@Nonnull public MessageBuilder append(@Nullable Object object)
Appends the string representation of an object to the Message.
This is the same asappend(String.valueOf(object))- Parameters:
object- the object to append- Returns:
- The MessageBuilder instance. Useful for chaining.
-
append
@Nonnull public MessageBuilder append(@Nonnull IMentionable mention)
Appends a mention to the Message.
Typical usage would be providing anIMentionablelikeUserorTextChannel.- Parameters:
mention- the mention to append- Returns:
- The MessageBuilder instance. Useful for chaining.
- Throws:
IllegalArgumentException- If provided with null
-
append
@Nonnull public MessageBuilder append(@Nullable CharSequence text, @Nonnull MessageBuilder.Formatting... format)
Appends a String using the specified chatFormatting(s).- Parameters:
text- the text to append.format- the format(s) to apply to the text.- Returns:
- The MessageBuilder instance. Useful for chaining.
-
appendFormat
@Nonnull public MessageBuilder appendFormat(@Nonnull String format, @Nonnull Object... args)
This method is an extended form ofString.format(String, Object...). It allows for all of the token replacement functionality that String.format(String, Object...) supports.
A lot of JDA entities implementFormattableand will provide specific format outputs for their specific type.IMentionable
These will output theirgetAsMentionby default, some implementations have alternatives such asUserandTextChannel.MessageChannel
All message channels format to"#" + getName()by default, TextChannel has special handling and uses the getAsMention output by default and the MessageChannel output as alternative (#flag).Message
Messages by default output theirgetContentDisplay()value and as alternative use thegetContentRaw()value
Example:
If you placed the following code in an method handling aMessageReceivedEvent
It would build a message that mentions the author and says that he is really cool!. If the user's name was "Minn" and his discriminator "6688", it would say:User user = event.getAuthor(); MessageBuilder builder = new MessageBuilder(); builder.appendFormat("%#s is really cool!", user); builder.build();"Minn#6688 is really cool!"
Note that this uses the#flag to utilize the alternative format forUser.
By default it would fallback toIMentionable.getAsMention()- Parameters:
format- a format string.args- an array objects that will be used to replace the tokens, they must be provided in the order that the tokens appear in the provided format string.- Returns:
- The MessageBuilder instance. Useful for chaining.
- Throws:
IllegalArgumentException- If the provided format string isnullor emptyIllegalFormatException- If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.
-
appendCodeLine
@Nonnull public MessageBuilder appendCodeLine(@Nullable CharSequence text)
Appends a code-line to the Message. Code Lines are similar to code-blocks, however they are displayed in-line and do not support language specific highlighting.- Parameters:
text- the code to append- Returns:
- The MessageBuilder instance. Useful for chaining.
-
appendCodeBlock
@Nonnull public MessageBuilder appendCodeBlock(@Nullable CharSequence text, @Nullable CharSequence language)
Appends a code-block to the Message.
Discord uses Highlight.js for its language highlighting support. You can find out what specific languages are supported here.- Parameters:
text- the code to appendlanguage- the language of the code. If unknown use an empty string- Returns:
- The MessageBuilder instance. Useful for chaining.
-
length
public int length()
Returns the current length of the content that will be built into aMessagewhenbuild()is called.
If this value is0(and there is no embed) or greater than2000whenbuild()is called, an exception will be raised as you cannot send an empty message to Discord and Discord has a hard limit of 2000 characters per message.Hint: You can use
build(int, int)orbuildAll(SplitPolicy...)as possible ways to deal with the 2000 character cap.- Returns:
- the current length of the content that will be built into a Message.
-
isEmpty
public boolean isEmpty()
Checks if the message contains any contend. This includes text as well as embeds.- Returns:
- weather the message contains content
-
replace
@Nonnull public MessageBuilder replace(@Nonnull String target, @Nonnull String replacement)
Replaces each substring that matches the target string with the specified replacement string. The replacement proceeds from the beginning of the string to the end, for example, replacing "aa" with "b" in the message "aaa" will result in "ba" rather than "ab".- Parameters:
target- the sequence of char values to be replacedreplacement- the replacement sequence of char values- Returns:
- The MessageBuilder instance. Useful for chaining.
-
replaceFirst
@Nonnull public MessageBuilder replaceFirst(@Nonnull String target, @Nonnull String replacement)
Replaces the first substring that matches the target string with the specified replacement string.- Parameters:
target- the sequence of char values to be replacedreplacement- the replacement sequence of char values- Returns:
- The MessageBuilder instance. Useful for chaining.
-
replaceLast
@Nonnull public MessageBuilder replaceLast(@Nonnull String target, @Nonnull String replacement)
Replaces the last substring that matches the target string with the specified replacement string.- Parameters:
target- the sequence of char values to be replacedreplacement- the replacement sequence of char values- Returns:
- The MessageBuilder instance. Useful for chaining.
-
stripMentions
@Nonnull public MessageBuilder stripMentions(@Nonnull JDA jda)
Removes all mentions and replaces them with the closest looking textual representation.Use this over
stripMentions(Guild)ifUsermentions should be replaced with theirUser.getName()instead of their Nicknames.- Parameters:
jda- The JDA instance used to resolve the mentions.- Returns:
- The MessageBuilder instance. Useful for chaining.
-
stripMentions
@Nonnull public MessageBuilder stripMentions(@Nonnull Guild guild)
Removes all mentions and replaces them with the closest looking textual representation.Use this over
stripMentions(JDA)ifUsermentions should be replaced with their nicknames in a specific guild based.
UsesMember.getEffectiveName()- Parameters:
guild- the guild forUsermentions- Returns:
- The MessageBuilder instance. Useful for chaining.
-
stripMentions
@Nonnull public MessageBuilder stripMentions(@Nonnull Guild guild, @Nonnull Message.MentionType... types)
Removes all mentions of the specified types and replaces them with the closest looking textual representation.Use this over
stripMentions(JDA, Message.MentionType...)ifUsermentions should be replaced with their nicknames in a specific guild based.
UsesMember.getEffectiveName()- Parameters:
guild- the guild forUsermentionstypes- theMentionTypesthat should be stripped- Returns:
- The MessageBuilder instance. Useful for chaining.
-
stripMentions
@Nonnull public MessageBuilder stripMentions(@Nonnull JDA jda, @Nonnull Message.MentionType... types)
Removes all mentions of the specified types and replaces them with the closest looking textual representation.Use this over
stripMentions(Guild, Message.MentionType...)ifUsermentions should be replaced with theirUser.getName().- Parameters:
jda- The JDA instance used to resolve the mentions.types- theMentionTypesthat should be stripped- Returns:
- The MessageBuilder instance. Useful for chaining.
-
getStringBuilder
@Nonnull public StringBuilder getStringBuilder()
Returns the underlyingStringBuilder.- Returns:
- The
StringBuilderused by thisMessageBuilder
-
clear
@Nonnull public MessageBuilder clear()
Clears the current builder. Useful for mass message creation.- Returns:
- The MessageBuilder instance. Useful for chaining.
-
indexOf
public int indexOf(@Nonnull CharSequence target, int fromIndex, int endIndex)
Returns the index within this string of the first occurrence of the specified substring between the specified indices.If no such value of
targetexists, then-1is returned.- Parameters:
target- the substring to search for.fromIndex- the index from which to start the search.endIndex- the index at which to end the search.- Returns:
- the index of the first occurrence of the specified substring between
the specified indices or
-1if there is no such occurrence. - Throws:
IndexOutOfBoundsException-
-
lastIndexOf
public int lastIndexOf(@Nonnull CharSequence target, int fromIndex, int endIndex)
Returns the index within this string of the last occurrence of the specified substring between the specified indices. If no such value oftargetexists, then-1is returned.- Parameters:
target- the substring to search for.fromIndex- the index from which to start the search.endIndex- the index at which to end the search.- Returns:
- the index of the last occurrence of the specified substring between
the specified indices or
-1if there is no such occurrence. - Throws:
IndexOutOfBoundsException-
-
sendTo
@Nonnull @CheckReturnValue public MessageAction sendTo(@Nonnull MessageChannel channel)
Creates aMessageActionwith the current settings without building aMessageinstance first.- Parameters:
channel- The not-null targetMessageChannel- Returns:
MessageAction- Throws:
IllegalArgumentException- If the provided channel isnullPermissionException- If the currently logged in account does not have permission to send or read messages in this channel.UnsupportedOperationException- If this is a PrivateChannel and both users (sender and receiver) are bots
-
build
@Nonnull public Message build()
Creates aMessageobject from this MessageBuilderHint: You can use
build(int, int)orbuildAll(SplitPolicy...)as possible ways to deal with the 2000 character cap.- Returns:
- the created
Message - Throws:
IllegalStateException-- If you attempt to build() an empty Message (
length()is0and noMessageEmbedwas provided tosetEmbed(net.dv8tion.jda.api.entities.MessageEmbed)) - If you attempt to build() a Message with more than 2000 characters of content.
- If you attempt to build() an empty Message (
-
buildAll
@Nonnull public Queue<Message> buildAll(@Nullable MessageBuilder.SplitPolicy... policy)
Creates aQueueofMessageobjects from this MessageBuilder.This method splits the content if it exceeds 2000 chars. The splitting behaviour can be customized using
SplitPolicies. The method will try the policies in the order they are passed to it.
If no SplitPolicy is provided each message will be split after exactly 2000 chars.This is not Markdown safe. An easy workaround is to include Zero Width Spaces as predetermined breaking points to the message and only split on them.
- Parameters:
policy- TheMessageBuilder.SplitPolicydefining how to split the text in the MessageBuilder into different, individual messages.- Returns:
- the created
Messages
-
-