Package net.dv8tion.jda.api.entities.channel.concrete

Enum ForumChannel.Layout

java.lang.Object

java.lang.Enum<ForumChannel.Layout>

net.dv8tion.jda.api.entities.channel.concrete.ForumChannel.Layout

All Implemented Interfaces:

Serializable, Comparable<ForumChannel.Layout>

Enclosing interface:

ForumChannel

public static enum ForumChannel.Layout
extends Enum<ForumChannel.Layout>

The layout used to sort forum posts.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT_VIEW	Displayed as default (not set).
GALLERY_VIEW	Displayed as a collection of tiles.
LIST_VIEW	Displayed as a chronological list.
UNKNOWN	Placeholder for future layout types.

Method Summary

Modifier and Type	Method	Description
static ForumChannel.Layout	fromKey(int key)	The ForumChannel.Layout for the provided key.
int	getKey()	The underlying value as used by Discord.
static ForumChannel.Layout	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ForumChannel.Layout[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT_VIEW

public static final ForumChannel.Layout DEFAULT_VIEW

Displayed as default (not set).

LIST_VIEW

public static final ForumChannel.Layout LIST_VIEW

Displayed as a chronological list.

GALLERY_VIEW

public static final ForumChannel.Layout GALLERY_VIEW

Displayed as a collection of tiles.

UNKNOWN

public static final ForumChannel.Layout UNKNOWN

Placeholder for future layout types.

Method Details

values

public static ForumChannel.Layout[] values()

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

Returns:

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

valueOf

public static ForumChannel.Layout 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

getKey

public int getKey()

The underlying value as used by Discord.

Returns:

The raw order key

fromKey

@Nonnull
public static ForumChannel.Layout fromKey(int key)

The ForumChannel.Layout for the provided key.

Parameters:

key - The key to get the ForumChannel.Layout for

Returns:

The ForumChannel.Layout for the provided key, or UNKNOWN if the key is not known