Package org.javacord.api.entity.message.component

Enum ComponentType

java.lang.Object

java.lang.Enum<ComponentType>

org.javacord.api.entity.message.component.ComponentType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ComponentType>

public enum ComponentType
extends java.lang.Enum<ComponentType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTION_ROW
BUTTON
SELECT_MENU_CHANNEL
SELECT_MENU_MENTIONABLE
SELECT_MENU_ROLE
SELECT_MENU_STRING
SELECT_MENU_USER
TEXT_INPUT
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static ComponentType	fromId(int id)	Parse an integer into a ComponentType.
static ComponentType[]	getSelectMenuTypes()	Gets an array with all types that are text channel types.
boolean	isSelectMenuType()	Whether this component is a type of select menu.
java.lang.String	toString()
int	value()	Get the internal value.
static ComponentType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ComponentType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final ComponentType UNKNOWN

ACTION_ROW

public static final ComponentType ACTION_ROW

BUTTON

public static final ComponentType BUTTON

SELECT_MENU_STRING

public static final ComponentType SELECT_MENU_STRING

TEXT_INPUT

public static final ComponentType TEXT_INPUT

SELECT_MENU_USER

public static final ComponentType SELECT_MENU_USER

SELECT_MENU_ROLE

public static final ComponentType SELECT_MENU_ROLE

SELECT_MENU_MENTIONABLE

public static final ComponentType SELECT_MENU_MENTIONABLE

SELECT_MENU_CHANNEL

public static final ComponentType SELECT_MENU_CHANNEL

Method Detail

values

public static ComponentType[] 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 (ComponentType c : ComponentType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ComponentType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

value

public int value()

Get the internal value.

Returns:

The component type's identifier.

isSelectMenuType

public boolean isSelectMenuType()

Whether this component is a type of select menu.

Returns:

True if it's a type of select menu.

getSelectMenuTypes

public static ComponentType[] getSelectMenuTypes()

Gets an array with all types that are text channel types.

Returns:

All types that are text channel types.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ComponentType>

fromId

public static ComponentType fromId(int id)

Parse an integer into a ComponentType.

Parameters:

id - A component type identifier.

Returns:

A ComponentType enumerator.