Package net.dv8tion.jda.api.interactions.modals

Interface ModalTopLevelComponentUnion

All Superinterfaces:
Component, IComponentUnion, ModalTopLevelComponent
All Known Implementing Classes:
ActionRowImpl, UnknownComponentImpl
public interface ModalTopLevelComponentUnion extends ModalTopLevelComponent, IComponentUnion
Represents a union of ModalTopLevelComponents that can be one of:

  • Method Details

    • asActionRow

      @Nonnull ActionRow asActionRow()
      Casts this union to a ActionRow. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 ActionRow row = union.asActionRow();
 ActionRow row2 = (ActionRow) union;
      You can use Component.getType() to see if the component is of type Component.Type.ACTION_ROW to validate whether you can call this method in addition to normal instanceof checks: component instanceof ActionRow
      Returns:
      The component as a ActionRow
      Throws:
      IllegalStateException - If the component represented by this union is not actually a ActionRow.

    • withUniqueId

      @Nonnull ModalTopLevelComponentUnion withUniqueId(int uniqueId)
      Description copied from interface: Component
      Creates a new component with the provided numeric ID.
      If no ID is set, Discord will generate IDs incrementally starting from 1 and will not use existing IDs from the same message/modal.
      Specified by:
      withUniqueId in interface Component
      Specified by:
      withUniqueId in interface IComponentUnion
      Specified by:
      withUniqueId in interface ModalTopLevelComponent
      Parameters:
      uniqueId - The new ID; must be higher or equal to 1
      Returns:
      The new component