Package 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 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	Description
EmbedFooter(@NotNull String text, @Nullable String icon)	Creates a new embed footer

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EmbedFooter

public EmbedFooter(@NotNull
                   @NotNull String text,
                   @Nullable
                   @Nullable 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 String getText()

The visible text of the footer.

Returns:

The text

getIconUrl

@Nullable
@JSONPropertyName("icon_url")
public @Nullable String getIconUrl()

The url for the icon of this footer

Returns:

Possibly-null icon url

toString

public String toString()

JSON representation of this footer

Overrides:

toString in class Object

Returns:

The JSON representation

toJSONString

public String toJSONString()

Specified by:

toJSONString in interface org.json.JSONString