com.diluv.schoomp.message

Class Message

java.lang.Object

com.diluv.schoomp.message.Message

public final class Message
extends java.lang.Object

This class represents a message that can be sent to Discord using a Webhook. To use this class simply create a new instance and use the various setters to customize it.

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
Message	addEmbed(Embed embed) Adds a new embed to the message.
java.lang.String	getAvatarUrl() Gets the URL of the avatar image override.
java.lang.String	getContent() Gets the basic message contents.
java.util.List<Embed>	getEmbeds() Gets a list of all the embeds on this message.
java.lang.String	getUsername() Gets the display name override for the message.
boolean	isTts() Checks whether or not the message will use Discord Text To Speech.
Message	setAvatarUrl(java.lang.String avatarUrl) Sets the avatar image to a temporary override image.
Message	setContent(java.lang.String content) Sets the basic message contents.
Message	setTts(boolean tts) Sets whether or not the message should use Discord Text To Speech.
Message	setUsername(java.lang.String username) Sets the override username for the message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message()

Method Detail

getUsername

@Nullable
public java.lang.String getUsername()

Gets the display name override for the message. Null means the default in Discord will be used.

Returns:

The display name override for the message, or null if there is no override.

setUsername

public Message setUsername(@Nullable
                           java.lang.String username)

Sets the override username for the message. Setting this value to a non-null string will replace the display name set in Discord for this specific message. Setting this value to null will reset the value back to the default name set in Discord.

Parameters:

username - The desired username.

Returns:

The same message instance.

getAvatarUrl

@Nullable
public java.lang.String getAvatarUrl()

Gets the URL of the avatar image override. A null value means the default is being used.

Returns:

The avatar override image, or null if there is no override.

setAvatarUrl

public Message setAvatarUrl(@Nullable
                            java.lang.String avatarUrl)

Sets the avatar image to a temporary override image. Setting this to null will remove the override and default back to the avatar set in Discord.

Parameters:

avatarUrl - The desired avatar override image.

Returns:

The same message instance.

getContent

@Nullable
public java.lang.String getContent()

Gets the basic message contents. If this is null it means no base text has been set.

Returns:

The basic message contents, or null if none have been set.

setContent

public Message setContent(@Nullable
                          java.lang.String content)

Sets the basic message contents. If this is set to null the message contents will be removed.

Parameters:

content - The desired message contents.

Returns:

The same message instance.

isTts

public boolean isTts()

Checks whether or not the message will use Discord Text To Speech. This is off by default.

Returns:

Whether or not TTS is enabled.

setTts

public Message setTts(boolean tts)

Sets whether or not the message should use Discord Text To Speech.

Parameters:

tts - Whether or not TTS should be used.

Returns:

The same message instance.

addEmbed

public Message addEmbed(Embed embed)

Adds a new embed to the message. Embeds are used to display styled content in a Discord message. Keep in mind that there is a max of 10 embeds per one message, adding more will cause an exception.

Parameters:

embed - The embed to add.

Returns:

The same message instance.

getEmbeds

@Nullable
public java.util.List<Embed> getEmbeds()

Gets a list of all the embeds on this message. This will usually be null if there are no embeds.

Returns:

A list of all the embeds, or null if no embeds have been added.