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

Enum Component.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Component.Type>
    Enclosing interface:
    Component
    public static enum Component.Type
extends java.lang.Enum<Component.Type>
    The component types

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      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​(java.lang.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

      • ACTION_ROW

        public static final Component.Type ACTION_ROW
        A row of interactive components on a message

      • 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​(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

      • 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