club.minnced.discord.webhook.send

Class WebhookEmbed.EmbedAuthor

java.lang.Object

club.minnced.discord.webhook.send.WebhookEmbed.EmbedAuthor

All Implemented Interfaces:

org.json.JSONString

Enclosing class:

WebhookEmbed

public static class WebhookEmbed.EmbedAuthor
extends java.lang.Object
implements org.json.JSONString

POJO for an embed author.
This can contain an icon (avatar), a name, and a url. Often useful for posts from other platforms such as twitter/github.

Constructor Summary

Constructors

Constructor and Description
EmbedAuthor(@NotNull java.lang.String name, @Nullable java.lang.String iconUrl, @Nullable java.lang.String url) Creates a new embed author

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.String	getIconUrl() The iconUrl of this author.
@NotNull java.lang.String	getName() The name of the author, this is the only visible text of this component.
@Nullable java.lang.String	getUrl() The url of this author.
java.lang.String	toJSONString()
java.lang.String	toString() JSON representation of this author

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbedAuthor

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

Creates a new embed author

Parameters:

name - The name of the author

iconUrl - The (nullable) icon url of the author

url - The (nullable) hyperlink of the author

See Also:

WebhookEmbedBuilder.setAuthor(club.minnced.discord.webhook.send.WebhookEmbed.EmbedAuthor)

Method Detail

getName

@NotNull
public @NotNull java.lang.String getName()

The name of the author, this is the only visible text of this component.

Returns:

The name

getIconUrl

@Nullable
 @JSONPropertyName(value="icon_url")
public @Nullable java.lang.String getIconUrl()

The iconUrl of this author.
This is displayed left to the name, similar to messages in discord.

Returns:

Possibly-null iconUrl url

getUrl

@Nullable
public @Nullable java.lang.String getUrl()

The url of this author.
This can be used to highlight the name as a hyperlink to the platform's profile service.

Returns:

Possibly-null url

toString

public java.lang.String toString()

JSON representation of this author

Overrides:

toString in class java.lang.Object

Returns:

The JSON representation

toJSONString

public java.lang.String toJSONString()

Specified by:

toJSONString in interface org.json.JSONString