com.diluv.schoomp.message.embed

Class Embed

java.lang.Object

com.diluv.schoomp.message.embed.Embed

public final class Embed
extends java.lang.Object

This class represents an embedded message. These allow for special formatting and other features which are not available to standard messages. A single message can have up to ten embeds. To use this object simply create a new instance and use the setter methods to customize the embed.

Constructor Summary

Constructors

Constructor and Description
Embed()

Method Summary

Modifier and Type	Method and Description
Embed	addField(Field field) Adds a new field to the embed.
Embed	addField(java.lang.String name, java.lang.Number value, boolean inline) Adds a new field to the embed.
Embed	addField(java.lang.String name, java.lang.String value, boolean inline) Adds a new field to the embed.
Author	getAuthor() Gets the author info of the embed.
int	getColor() Gets the color to display for the embed.
java.lang.String	getDescription() Gets the description text for the embed.
java.util.List<Field>	getFields() Gets all the field info for the embed.
Footer	getFooter() Gets the footer info for the embed.
Image	getImage() Gets the image info for the embed.
Thumbnail	getThumbnail() Gets the thumbnail info for the embed.
java.time.OffsetDateTime	getTimestamp() Gets the embed timestamp info.
java.lang.String	getTitle() Gets the title of the embed.
java.lang.String	getUrl() Gets the URL of the embed.
Embed	setAuthor(Author author) Sets the authorship info for the embed.
Embed	setColor(int color) Sets the color of the embed.
Embed	setDescription(java.lang.String description) Sets the description text for the embed.
Embed	setFooter(Footer footer) Sets the footer info for the embed.
Embed	setImage(Image image) Sets the image info for the embed.
Embed	setImage(java.lang.String url) Sets the image URL of the embed.
Embed	setThumbnail(java.lang.String url) Sets the thumbnail URL for the embed.
Embed	setThumbnail(Thumbnail thumbnail) Sets the thumbnail info for the embed.
Embed	setTimestamp() Sets the embed timestamp to the current system time..
Embed	setTimestamp(java.time.OffsetDateTime timestamp) Sets the embed timestamp.
Embed	setTimestamp(java.time.temporal.TemporalAccessor timestamp) Sets the embed timestamp.
Embed	setTitle(java.lang.String title) Sets the title of the embed.
Embed	setUrl(java.lang.String url) Sets the URL for the embed to link to.

Methods inherited from class java.lang.Object

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

Constructor Detail

Embed

public Embed()

Method Detail

getTitle

@Nullable
public java.lang.String getTitle()

Gets the title of the embed.

Returns:

The title of the embed.

setTitle

public Embed setTitle(@Nullable
                      java.lang.String title)

Sets the title of the embed.

Parameters:

title - The title of the embed.

Returns:

The same embed instance.

getUrl

@Nullable
public java.lang.String getUrl()

Gets the URL of the embed.

Returns:

The URL of the embed.

setUrl

public Embed setUrl(@Nullable
                    java.lang.String url)

Sets the URL for the embed to link to. If the title has also been set this will create a hyperlink.

Parameters:

url - The URL for the embed to link to.

Returns:

The same embed object.

getDescription

@Nullable
public java.lang.String getDescription()

Gets the description text for the embed.

Returns:

The description text for the embed.

setDescription

public Embed setDescription(@Nullable
                            java.lang.String description)

Sets the description text for the embed.

Parameters:

description - The description text for the embed.

Returns:

The same embed object.

getColor

public int getColor()

Gets the color to display for the embed.

Returns:

The color to display for the embed.

setColor

public Embed setColor(int color)

Sets the color of the embed.

Parameters:

color - The color of the embed as a packed RGB integer.

Returns:

The same embed object.

getAuthor

@Nullable
public Author getAuthor()

Gets the author info of the embed.

Returns:

The authorship info.

setAuthor

public Embed setAuthor(@Nullable
                       Author author)

Sets the authorship info for the embed.

Parameters:

author - The new authorship info.

Returns:

The same embed object.

getFields

@Nullable
public java.util.List<Field> getFields()

Gets all the field info for the embed.

Returns:

The list of fields for the embed.

addField

public Embed addField(java.lang.String name,
                      java.lang.Number value,
                      boolean inline)

Adds a new field to the embed.

Parameters:

name - The name of the field.

value - The value of the field.

inline - Whether or not the field should be linline with other fields.

Returns:

The same embed object.

addField

public Embed addField(java.lang.String name,
                      java.lang.String value,
                      boolean inline)

Adds a new field to the embed.

Parameters:

name - The name of the field.

value - The value of the field.

inline - Whether or not the field should be inline with other fields.

Returns:

The same embed object.

addField

public Embed addField(Field field)

Adds a new field to the embed.

Parameters:

field - The new field to add to the embed.

Returns:

The same embed object.

getThumbnail

@Nullable
public Thumbnail getThumbnail()

Gets the thumbnail info for the embed.

Returns:

The thumbnail info for the embed.

setThumbnail

public Embed setThumbnail(java.lang.String url)

Sets the thumbnail URL for the embed.

Parameters:

url - The thumbnail URL to use.

Returns:

The same embed object.

setThumbnail

public Embed setThumbnail(@Nullable
                          Thumbnail thumbnail)

Sets the thumbnail info for the embed.

Parameters:

thumbnail - The thumbnail info for the embed.

Returns:

The same embed object.

getImage

@Nullable
public Image getImage()

Gets the image info for the embed.

Returns:

The image info for the embed.

setImage

public Embed setImage(java.lang.String url)

Sets the image URL of the embed.

Parameters:

url - The image URL for the embed.

Returns:

The same embed object.

setImage

public Embed setImage(@Nullable
                      Image image)

Sets the image info for the embed.

Parameters:

image - The new image info for the embed.

Returns:

The same embed object.

getFooter

@Nullable
public Footer getFooter()

Gets the footer info for the embed.

Returns:

The footer info for the embed.

setFooter

public Embed setFooter(@Nullable
                       Footer footer)

Sets the footer info for the embed.

Parameters:

footer - The footer info for the embed.

Returns:

The same embed object.

getTimestamp

@Nullable
public java.time.OffsetDateTime getTimestamp()

Gets the embed timestamp info.

Returns:

The embed timestamp.

setTimestamp

public Embed setTimestamp(@Nullable
                          java.time.temporal.TemporalAccessor timestamp)

Sets the embed timestamp.

Parameters:

timestamp - The embed timestamp.

Returns:

The same embed object.

setTimestamp

public Embed setTimestamp()

Sets the embed timestamp to the current system time..

Returns:

The same embed object.

setTimestamp

public Embed setTimestamp(@Nullable
                          java.time.OffsetDateTime timestamp)

Sets the embed timestamp.

Parameters:

timestamp - The embed timestamp.

Returns:

The same embed object.