com.diluv.schoomp.message.embed

Class Author

java.lang.Object

com.diluv.schoomp.message.embed.Author

public final class Author
extends java.lang.Object

This class represents the authorship info on a Discord embed. To use it you can construct a new instance and use the setters, or use some of the helper methods on the Embed instance.

Constructor Summary

Constructors

Constructor and Description
Author()
Author(java.lang.String name)
Author(java.lang.String name, java.lang.String url)
Author(java.lang.String name, java.lang.String url, java.lang.String iconUrl)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIconUrl() Gets an avatar URL for the author.
java.lang.String	getName() Gets the name of the author.
java.lang.String	getUrl() Gets a URL for the author.
Author	setIconUrl(java.lang.String iconUrl) Sets the avatar icon URL for the author.
Author	setName(java.lang.String name) Sets the name of the author.
void	setUrl(java.lang.String url) Sets the author's URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

Author

public Author()

Author

public Author(@Nullable
              java.lang.String name)

Author

public Author(@Nullable
              java.lang.String name,
              @Nullable
              java.lang.String url)

Author

public Author(@Nullable
              java.lang.String name,
              @Nullable
              java.lang.String url,
              @Nullable
              java.lang.String iconUrl)

Method Detail

getName

@Nullable
public java.lang.String getName()

Gets the name of the author.

Returns:

The name of the author.

setName

public Author setName(@Nullable
                      java.lang.String name)

Sets the name of the author.

Parameters:

name - The name of the author.

Returns:

The same instance.

getUrl

@Nullable
public java.lang.String getUrl()

Gets a URL for the author.

Returns:

The same instance.

setUrl

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

Sets the author's URL.

Parameters:

url - The author's URL.

getIconUrl

@Nullable
public java.lang.String getIconUrl()

Gets an avatar URL for the author.

Returns:

The author's avatar URL.

setIconUrl

public Author setIconUrl(@Nullable
                         java.lang.String iconUrl)

Sets the avatar icon URL for the author.

Parameters:

iconUrl - The avatar icon URL.

Returns:

The same instance.