net.dv8tion.jda

Class MessageBuilder

java.lang.Object

net.dv8tion.jda.MessageBuilder

public class MessageBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageBuilder.Formatting Holds the Available formatting used in appendString(String, Formatting...)

Constructor Summary

Constructors

Constructor and Description
MessageBuilder()

Method Summary

Modifier and Type	Method and Description
MessageBuilder	appendCodeBlock(java.lang.String text, java.lang.String language) Appends a code-block to the Message
MessageBuilder	appendEveryoneMention() Appends a @everyone mention to the Message
MessageBuilder	appendMention(TextChannel channel) Appends a channel mention to the Message.
MessageBuilder	appendMention(User user) Appends a mention to the Message
MessageBuilder	appendString(java.lang.String text) Appends a string to the Message
MessageBuilder	appendString(java.lang.String text, MessageBuilder.Formatting... format) Appends a formatted string to the Message
Message	build() Creates a Message object from this Builder
int	getLength() Returns the current length of the content that will be built into a Message when build() is called. If this value is 0 or greater than 2000 when build() is called, an exception will be raised.
MessageBuilder	setTTS(boolean tts) Makes the created Message a TTS message

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageBuilder

public MessageBuilder()

Method Detail

setTTS

public MessageBuilder setTTS(boolean tts)

Makes the created Message a TTS message

Parameters:

tts - whether the created Message should be a tts message

Returns:

this instance

appendString

public MessageBuilder appendString(java.lang.String text)

Appends a string to the Message

Parameters:

text - the text to append

Returns:

this instance

appendString

public MessageBuilder appendString(java.lang.String text,
                                   MessageBuilder.Formatting... format)

Appends a formatted string to the Message

Parameters:

text - the text to append

format - the format(s) to apply to the text

Returns:

this instance

appendCodeBlock

public MessageBuilder appendCodeBlock(java.lang.String text,
                                      java.lang.String language)

Appends a code-block to the Message

Parameters:

text - the code to append

language - the language of the code. If unknown use an empty string

Returns:

this instance

appendMention

public MessageBuilder appendMention(User user)

Appends a mention to the Message

Parameters:

user - the user to mention

Returns:

this instance

appendEveryoneMention

public MessageBuilder appendEveryoneMention()

Appends a @everyone mention to the Message

Returns:

this instance

appendMention

public MessageBuilder appendMention(TextChannel channel)

Appends a channel mention to the Message. For this to work, the given TextChannel has to be from the Guild the mention is posted to.

Parameters:

channel - the TextChannel to mention

Returns:

this instance

getLength

public int getLength()

Returns the current length of the content that will be built into a Message when build() is called.
If this value is 0 or greater than 2000 when build() is called, an exception will be raised.

Returns:

The currently length of the content that will be built into a Message.

build

public Message build()

Creates a Message object from this Builder

Returns:

the created Message

Throws:

java.lang.UnsupportedOperationException -

• If you attempt to build() an empty Message (no content added to the Message)
• If you attempt to build() a Message with more than 2000 characters of content.