club.minnced.discord.webhook.send

Class WebhookEmbed.EmbedField

java.lang.Object

club.minnced.discord.webhook.send.WebhookEmbed.EmbedField

All Implemented Interfaces:

org.json.JSONString

Enclosing class:

WebhookEmbed

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

POJO for an embed field.
An embed can have up to fields. A row of fields can be up 3 wide, or 2 when a thumbnail is configured. To be displayed in the same row as other fields, the field has to be set to inline.

Constructor Summary

Constructors

Constructor and Description
EmbedField(boolean inline, @NotNull java.lang.String name, @NotNull java.lang.String value) Creates a new embed field

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	getName() The name of this field.
@NotNull java.lang.String	getValue() The value of this field.
boolean	isInline() Whether this field should share a row with other fields
java.lang.String	toJSONString()
java.lang.String	toString() JSON representation of this field

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbedField

public EmbedField(boolean inline,
                  @NotNull
                  @NotNull java.lang.String name,
                  @NotNull
                  @NotNull java.lang.String value)

Creates a new embed field

Parameters:

inline - Whether or not this should share a row with other fields

name - The name of the field

value - The value of the field

See Also:

WebhookEmbedBuilder.addField(club.minnced.discord.webhook.send.WebhookEmbed.EmbedField)

Method Detail

isInline

public boolean isInline()

Whether this field should share a row with other fields

Returns:

True, if this should be in the same row as other fields

getName

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

The name of this field.
This is displayed above the value in a bold font.

Returns:

The name

getValue

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

The value of this field.
This is displayed below the name in a regular font.

Returns:

The value

toString

public java.lang.String toString()

JSON representation of this field

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