Enum Class 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>, Constable
- Enclosing interface:
ForumChannel
The layout used to sort forum posts.
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDisplayed as default (not set).Displayed as a collection of tiles.Displayed as a chronological list.Placeholder for future layout types. -
Method Summary
Modifier and TypeMethodDescriptionstatic ForumChannel.LayoutfromKey(int key) TheForumChannel.Layoutfor the provided key.intgetKey()The underlying value as used by Discord.static ForumChannel.LayoutReturns the enum constant of this class with the specified name.static ForumChannel.Layout[]values()Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
DEFAULT_VIEW
Displayed as default (not set). -
LIST_VIEW
Displayed as a chronological list. -
GALLERY_VIEW
Displayed as a collection of tiles. -
UNKNOWN
Placeholder for future layout types.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException- if the argument is null
-
getKey
public int getKey()The underlying value as used by Discord.- Returns:
- The raw order key
-
fromKey
TheForumChannel.Layoutfor the provided key.- Parameters:
key- The key to get theForumChannel.Layoutfor- Returns:
- The
ForumChannel.Layoutfor the provided key, orUNKNOWNif the key is not known
-