Interface LabelChildComponentUnion

All Superinterfaces:
Component, IComponentUnion, LabelChildComponent
public interface LabelChildComponentUnion extends LabelChildComponent, IComponentUnion
Represents a union of LabelChildComponent that can be one of:

  • Method Details

    • asTextInput

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

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

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

    • asStringSelectMenu

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

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

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

    • asEntitySelectMenu

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

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

      //These are the same!
EntitySelectMenu menu = union.asEntitySelectMenu();
EntitySelectMenu menu2 = (EntitySelectMenu) union;
      You can use Component.getType() to see if the component is one of: to validate whether you can call this method in addition to normal instanceof checks: component instanceof EntitySelectMenu
      Returns:
      The component as a EntitySelectMenu
      Throws:
      IllegalStateException - If the component represented by this union is not actually a EntitySelectMenu.

    • asAttachmentUpload

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

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

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

    • asRadioGroup

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

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

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

    • asCheckboxGroup

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

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

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

    • asCheckbox

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

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

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

    • withUniqueId

      @Nonnull LabelChildComponentUnion 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 LabelChildComponent
      Parameters:
      uniqueId - The new ID; must be higher or equal to 1
      Returns:
      The new component