club.minnced.discord.webhook.send

Class WebhookEmbed.EmbedFooter

java.lang.Object

club.minnced.discord.webhook.send.WebhookEmbed.EmbedFooter

All Implemented Interfaces:

org.json.JSONString

Enclosing class:

WebhookEmbed

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

POJO for an embed footer.
Useful to display meta-data about context such as for a github comment a repository name/icon.

Constructor Summary

Constructors

Constructor and Description
EmbedFooter(@NotNull java.lang.String text, @Nullable java.lang.String icon) Creates a new embed footer

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.String	getIconUrl() The url for the icon of this footer
@NotNull java.lang.String	getText() The visible text of the footer.
java.lang.String	toJSONString()
java.lang.String	toString() JSON representation of this footer

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbedFooter

public EmbedFooter(@NotNull
                   @NotNull java.lang.String text,
                   @Nullable
                   @Nullable java.lang.String icon)

Creates a new embed footer

Parameters:

text - The visible text of the footer

icon - The (nullable) icon url of the footer

See Also:

WebhookEmbedBuilder.setFooter(club.minnced.discord.webhook.send.WebhookEmbed.EmbedFooter)

Method Detail

getText

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

The visible text of the footer.

Returns:

The text

getIconUrl

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

The url for the icon of this footer

Returns:

Possibly-null icon url

toString

public java.lang.String toString()

JSON representation of this footer

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