Package net.dv8tion.jda.api.interactions.components

Enum Component.Type

java.lang.Object

java.lang.Enum<Component.Type>

net.dv8tion.jda.api.interactions.components.Component.Type

All Implemented Interfaces:

Serializable, Comparable<Component.Type>

Enclosing interface:

Component

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

The component types

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTION_ROW	A row of interactive components on a message
BUTTON	A button
SELECTION_MENU	A selection menu
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static Component.Type	fromKey(int type)	Maps the provided type id to the respective enum instance.
int	getMaxPerRow()	How many of these components can be added to one ActionRow.
static Component.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Component.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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final Component.Type UNKNOWN

ACTION_ROW

public static final Component.Type ACTION_ROW

A row of interactive components on a message

BUTTON

public static final Component.Type BUTTON

A button

SELECTION_MENU

public static final Component.Type SELECTION_MENU

A selection menu

Method Detail

values

public static Component.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 (Component.Type c : Component.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 Component.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

getMaxPerRow

public int getMaxPerRow()

How many of these components can be added to one ActionRow.

Returns:

The maximum amount an action row can contain

fromKey

@Nonnull
public static Component.Type fromKey(int type)

Maps the provided type id to the respective enum instance.

Parameters:

type - The raw type id

Returns:

The Type or UNKNOWN