Package net.dv8tion.jda.api.entities

Class MessageEmbed.Field

java.lang.Object

net.dv8tion.jda.api.entities.MessageEmbed.Field

Enclosing class:

MessageEmbed

public static class MessageEmbed.Field
extends java.lang.Object

Represents a field in an embed. A single embed contains an array of embed fields, each with a name and value, and a boolean determining if the field can display on the same line as previous fields if there is enough space horizontally.

Since:

3.0

Author:

John A. Grosh

Constructor Summary

Constructors

Constructor	Description
Field(java.lang.String name, java.lang.String value, boolean inline)
Field(java.lang.String name, java.lang.String value, boolean inline, boolean checked)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getName()	The name of the field
java.lang.String	getValue()	The value of the field
boolean	isInline()	If the field is in line.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Field

public Field(java.lang.String name,
             java.lang.String value,
             boolean inline,
             boolean checked)

Field

public Field(java.lang.String name,
             java.lang.String value,
             boolean inline)

Method Detail

getName

@Nullable
public java.lang.String getName()

The name of the field

Returns:

Possibly-null String containing the name of the field.

getValue

@Nullable
public java.lang.String getValue()

The value of the field

Returns:

Possibly-null String containing the value (contents) of the field.

isInline

public boolean isInline()

If the field is in line.

Returns:

true if the field can be in line with other fields, false otherwise.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object