discord4j.core.object

Enum Embed.Type

java.lang.Object

java.lang.Enum<Embed.Type>

discord4j.core.object.Embed.Type

All Implemented Interfaces:

Serializable, Comparable<Embed.Type>

Enclosing class:

Embed

public static enum Embed.Type
extends Enum<Embed.Type>

Represents the various types of embeds.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IMAGE An embed generated by an image.
LINK An embed generated by a link.
RICH An embed generated by rich content.
VIDEO An embed generated by a video.

Method Summary

Modifier and Type	Method and Description
String	getValue() Gets the underlying value as represented by Discord.
static Embed.Type	of(String value) Gets the type of embed.
static Embed.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Embed.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IMAGE

public static final Embed.Type IMAGE

An embed generated by an image.

LINK

public static final Embed.Type LINK

An embed generated by a link.

RICH

public static final Embed.Type RICH

An embed generated by rich content.

VIDEO

public static final Embed.Type VIDEO

An embed generated by a video.

Method Detail

values

public static Embed.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Embed.Type c : Embed.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Embed.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Gets the underlying value as represented by Discord.

Returns:

The underlying value as represented by Discord.

of

public static Embed.Type of(String value)

Gets the type of embed. It is guaranteed that invoking getValue() from the returned enum will equal (Enum.equals(Object)) the supplied value.

Parameters:

value - The underlying value as represented by Discord.

Returns:

The type of embed.