Add support for modals

src/main/java/net/dv8tion/jda/api/events/interaction/ModalInteractionEvent.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.dv8tion.jda.api.events.interaction;
+
+import net.dv8tion.jda.api.JDA;
+import net.dv8tion.jda.api.interactions.InteractionHook;
+import net.dv8tion.jda.api.interactions.ModalInteraction;
+import net.dv8tion.jda.api.interactions.modals.ModalMapping;
+import net.dv8tion.jda.api.requests.restaction.interactions.MessageEditCallbackAction;
+import net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction;
+
+import javax.annotation.Nonnull;
+import java.util.List;
+
+/**
+ * Indicates that a {@link net.dv8tion.jda.api.interactions.components.text.Modal Modal} was submitted.
+ *
+ * <h2>Requirements</h2>
+ * To receive these events, you must unset the <b>Interactions Endpoint URL</b> in your application dashboard.
+ * You can simply remove the URL for this endpoint in your settings at the <a href="https://discord.com/developers/applications" target="_blank">Discord Developers Portal</a>.
+ *
+ * @see    net.dv8tion.jda.api.interactions.ModalInteraction
+ */
+public class ModalInteractionEvent extends GenericInteractionCreateEvent implements ModalInteraction
+{
+    private final ModalInteraction interaction;
+
+    public ModalInteractionEvent(@Nonnull JDA api, long responseNumber, @Nonnull ModalInteraction interaction)
+    {
+        super(api, responseNumber, interaction);
+        this.interaction = interaction;
+    }
+
+    @Nonnull
+    @Override
+    public ModalInteraction getInteraction()
+    {
+        return interaction;
+    }
+
+    @Nonnull
+    @Override
+    public String getModalId()
+    {
+        return interaction.getModalId();
+    }
+
+    @Nonnull
+    @Override
+    public List<ModalMapping> getValues()
+    {
+        return interaction.getValues();
+    }
+
+    @Nonnull
+    @Override
+    public ReplyCallbackAction deferReply()
+    {
+        return interaction.deferReply();
+    }
+
+    @Nonnull
+    @Override
+    public InteractionHook getHook()
+    {
+        return interaction.getHook();
+    }
+
+    @Nonnull
+    @Override
+    public MessageEditCallbackAction deferEdit()
+    {
+        return interaction.deferEdit();
+    }
+}

src/main/java/net/dv8tion/jda/api/hooks/ListenerAdapter.java

@@ -41,6 +41,7 @@
 import net.dv8tion.jda.api.events.http.HttpRequestEvent;
 import net.dv8tion.jda.api.events.interaction.GenericAutoCompleteInteractionEvent;
 import net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent;
+import net.dv8tion.jda.api.events.interaction.ModalInteractionEvent;
 import net.dv8tion.jda.api.events.interaction.command.*;
 import net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent;
 import net.dv8tion.jda.api.events.interaction.component.GenericComponentInteractionCreateEvent;
@@ -128,6 +129,7 @@ public void onMessageContextInteraction(@Nonnull MessageContextInteractionEvent
     public void onButtonInteraction(@Nonnull ButtonInteractionEvent event) {}
     public void onSelectMenuInteraction(@Nonnull SelectMenuInteractionEvent event) {}
     public void onCommandAutoCompleteInteraction(@Nonnull CommandAutoCompleteInteractionEvent event) {}
+    public void onModalInteraction(@Nonnull ModalInteractionEvent event) {}
 
     //User Events
     public void onUserUpdateName(@Nonnull UserUpdateNameEvent event) {}

src/main/java/net/dv8tion/jda/api/interactions/Interaction.java

@@ -23,15 +23,16 @@
 import net.dv8tion.jda.api.interactions.callbacks.IMessageEditCallback;
 import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
 import net.dv8tion.jda.api.interactions.commands.Command;
+import net.dv8tion.jda.api.interactions.components.text.Modal;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.util.Locale;
 
 /**
  * Abstract representation for any kind of Discord interaction.
- * <br>This includes things such as {@link net.dv8tion.jda.api.interactions.commands.SlashCommandInteraction Slash-Commands}
- * or {@link net.dv8tion.jda.api.interactions.components.buttons.ButtonInteraction Buttons}.
+ * <br>This includes things such as {@link net.dv8tion.jda.api.interactions.commands.SlashCommandInteraction Slash-Commands},
+ * {@link net.dv8tion.jda.api.interactions.components.buttons.ButtonInteraction Buttons} or {@link ModalInteraction Modals}.
  *
  * <p>To properly handle an interaction you must acknowledge it.
  * Each interaction has different callbacks which acknowledge the interaction. These are added by the individual {@code I...Callback} interfaces:
@@ -42,6 +43,8 @@
  *     <br>Which supports direct message edits and deferred message edits (or no-operation) via {@link IMessageEditCallback#editMessage(String)} and {@link IMessageEditCallback#deferEdit()}</li>
  *     <li>{@link IAutoCompleteCallback}
  *     <br>Which supports choice suggestions for auto-complete interactions via {@link IAutoCompleteCallback#replyChoices(Command.Choice...)}</li>
+ *     <li>{@link net.dv8tion.jda.api.interactions.callbacks.IModalCallback}
+ *     <br>Which supports replying using a {@link net.dv8tion.jda.api.interactions.components.text.Modal Modal} via {@link net.dv8tion.jda.api.interactions.callbacks.IModalCallback#replyModal(Modal)}</li>
  * </ul>
  *
  * <p>Once the interaction is acknowledged, you can not reply with these methods again. If the interaction is a {@link IDeferrableCallback deferrable},

src/main/java/net/dv8tion/jda/api/interactions/InteractionType.java

@@ -31,6 +31,7 @@ public enum InteractionType
     COMMAND(2),
     COMPONENT(3),
     COMMAND_AUTOCOMPLETE(4),
+    MODAL_SUBMIT(5),
     ;
 
     private final int key;
@@ -59,6 +60,8 @@ public static InteractionType fromKey(int key)
             return COMPONENT;
         case 4:
             return COMMAND_AUTOCOMPLETE;
+        case 5:
+            return MODAL_SUBMIT;
         default:
             return UNKNOWN;
         }

src/main/java/net/dv8tion/jda/api/interactions/ModalInteraction.java

@@ -0,0 +1,219 @@
+/*
+ * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.dv8tion.jda.api.interactions;
+
+import net.dv8tion.jda.api.interactions.callbacks.IMessageEditCallback;
+import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
+import net.dv8tion.jda.api.interactions.modals.ModalMapping;
+import net.dv8tion.jda.internal.utils.Checks;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import java.util.List;
+import java.util.function.Function;
+import java.util.function.Supplier;
+
+/**
+ * Interaction on a {@link net.dv8tion.jda.api.interactions.components.text.Modal Modal}
+ *
+ * If the modal of this interaction was a reply to a {@link net.dv8tion.jda.api.interactions.components.ComponentInteraction ComponentInteraction}, you can also use {@link #deferEdit()} to edit the message instead of replying.
+ *
+ * @see    net.dv8tion.jda.api.events.interaction.ModalInteractionEvent
+ */
+public interface ModalInteraction extends IReplyCallback, IMessageEditCallback
+{
+    /**
+     * Returns the custom id of the Modal in question
+     *
+     * @return Custom id
+     * 
+     * @see    net.dv8tion.jda.api.interactions.components.text.Modal.Builder#setId(String) 
+     */
+    @Nonnull
+    String getModalId();
+
+    /**
+     * Returns a List of {@link ModalMapping ModalMappings} the modal in question contains
+     *
+     * @return List of {@link ModalMapping ModalMappings}
+     *
+     * @see    #getValue(String)
+     */
+    @Nonnull
+    List<ModalMapping> getValues();
+
+    /**
+     * Convenience method to get a {@link ModalMapping ModalMapping} by its id from the List of {@link ModalMapping ModalMappings}
+     *
+     * <p>Returns null if no component with that id has been found
+     * 
+     * <p>You can use the second and third parameter overloads to handle optional arguments gracefully.
+     * See {@link #getValue(String, Function)} and {@link #getValue(String, Object, Function)}
+     *
+     * @param  id
+     *         The custom id
+     *
+     * @throws IllegalArgumentException
+     *         If the provided id is null
+     *
+     * @return ModalMapping with this id, or null if not found
+     *
+     * @see    #getValues()
+     * @see    #getValue(String, Function) 
+     * @see    #getValue(String, Object, Function) 
+     * @see    #getValue(String, Supplier, Function) 
+     */
+    @Nullable
+    default ModalMapping getValue(@Nonnull String id)
+    {
+        Checks.notNull(id, "ID");
+        return getValues().stream()
+                .filter(mapping -> mapping.getId().equals(id))
+                .findFirst().orElse(null);
+    }
+
+    /**
+     * Finds the first value with the specified id.
+     * <br>A resolver is used to get the value if it is provided.
+     * If no value is provided for the given id, this will simply return null instead.
+     * You can use {@link #getValue(String, Object, Function)} to provide a fallback for missing values.
+     * 
+     * <p><b>Example</b>
+     * <br>>ou can understand this as a shortcut for these lines of code:
+     * <pre>{@code 
+     * ModalMapping mapping = event.getValue("email");
+     * String email = mapping == null ? null : mapping.getAsString();
+     * }</pre>
+     * Which can be written with this resolver as:
+     * <pre>{@code
+     * String email = event.getValue("email", ModalMapping::getAsString);
+     * }</pre>
+     * 
+     * @param  id
+     *         The value id
+     * @param  resolver
+     *         The mapping resolver function to use if there is a mapping available,
+     *         the provided mapping will never be null!
+     * @param  <T>
+     *         The type of the resolved value
+     *         
+     * @throws IllegalArgumentException
+     *         If the id or resolver is null
+     *         
+     * @return The resolved value with the provided id, or null if that value is not provided.
+     * 
+     * @see    #getValue(String, Object, Function) 
+     * @see    #getValue(String, Supplier, Function)
+     */
+    default <T> T getValue(@Nonnull String id,
+                           @Nonnull Function<? super ModalMapping, ? extends T> resolver)
+    {
+        return getValue(id, null, resolver);
+    }
+
+    /**
+     * Finds the first value with the specified id.
+     * <br>A resolver is used to get the value if it is provided.
+     * If no value is provided for the given id, this will simply return your provided fallback instead.
+     * You can use {@link #getValue(String, Function)} to fall back to {@code null}.
+     *
+     * <p><b>Example</b>
+     * <br>You can understand this as a shortcut for these lines of code:
+     * <pre>{@code
+     * ModalMapping mapping = event.getValue("email");
+     * String email = mapping == null ? "No email provided" : mapping.getAsString();
+     * }</pre>
+     * Which can be written with this resolver as:
+     * <pre>{@code
+     * String email = event.getValue("email", "No email provided", ModalMapping::getAsString);
+     * }</pre>
+     *
+     * @param  id
+     *         The value id
+     * @param  fallback
+     *         The fallback to use if the value is not provided, meaning {@link #getValue(String)} returns null
+     * @param  resolver
+     *         The mapping resolver function to use if there is a mapping available,
+     *         the provided mapping will never be null!
+     * @param  <T>
+     *         The type of the resolved value
+     *
+     * @throws IllegalArgumentException
+     *         If the id or resolver is null
+     *
+     * @return The resolved option with the provided id, or {@code fallback} if that option is not provided
+     *
+     * @see    #getValue(String, Function)
+     * @see    #getValue(String, Supplier, Function)
+     */
+    default <T> T getValue(@Nonnull String id,
+                           @Nullable T fallback,
+                           @Nonnull Function<? super ModalMapping, ? extends T> resolver)
+    {
+        Checks.notNull(resolver, "Resolver");
+        ModalMapping mapping = getValue(id);
+        if (mapping != null)
+            return resolver.apply(mapping);
+        return fallback;
+    }
+
+    /**
+     * Finds the first value with the specified id.
+     * <br>A resolver is used to get the value if it is provided.
+     * If no value is provided for the given id, this will simply return your provided fallback instead.
+     * You can use {@link #getValue(String, Function)} to fall back to {@code null}.
+     *
+     * <p><b>Example</b>
+     * <br>You can understand this as a shortcut for these lines of code:
+     * <pre>{@code
+     * ModalMapping mapping = event.getValue("email");
+     * String email = mapping == null ? context.getMissingEmailString() : mapping.getAsString();
+     * }</pre>
+     * Which can be written with this resolver as:
+     * <pre>{@code
+     * String email = event.getValue("email", context::getMissingEmailString , ModalMapping::getAsString);
+     * }</pre>
+     *
+     * @param  id
+     *         The option id
+     * @param  fallback
+     *         The fallback supplier to use if the value is not provided, meaning {@link #getValue(String)} returns null
+     * @param  resolver
+     *         The mapping resolver function to use if there is a mapping available,
+     *         the provided mapping will never be null!
+     * @param  <T>
+     *         The type of the resolved value
+     *
+     * @throws IllegalArgumentException
+     *         If the id or resolver is null
+     *
+     * @return The resolved option with the provided id, or {@code fallback} if that option is not provided
+     *
+     * @see    #getValue(String, Function)
+     * @see    #getValue(String, Object, Function)
+     */
+    default <T> T getValue(@Nonnull String id,
+                           @Nullable Supplier<? extends T> fallback,
+                           @Nonnull Function<? super ModalMapping, ? extends T> resolver)
+    {
+        Checks.notNull(resolver, "Resolver");
+        ModalMapping mapping = getValue(id);
+        if (mapping != null)
+            return resolver.apply(mapping);
+        return fallback == null ? null : fallback.get();
+    }
+}