com.freya02.botcommands.api.modals.annotations.ModalHandler Maven / Gradle / Ivy

Go to download
package com.freya02.botcommands.api.modals.annotations;

import com.freya02.botcommands.api.core.annotations.Handler;
import com.freya02.botcommands.api.core.config.BConfigBuilder;
import com.freya02.botcommands.api.core.options.annotations.Aggregate;
import com.freya02.botcommands.api.modals.ModalBuilder;
import com.freya02.botcommands.api.modals.Modals;
import net.dv8tion.jda.api.events.interaction.ModalInteractionEvent;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Specifies that this method handles modals with the specified modal name
 *
 * The method must:
 * 

 *     Be in the {@link BConfigBuilder#addSearchPath(String) search path}
 *     Be non-static and public
 *     Have {@link ModalInteractionEvent} as its first parameter
 *     Optionally: Have all your consecutive {@link ModalData}, specified in {@link ModalBuilder#bindTo(String, Object...)}
 *     And finally: Have all your {@link ModalInput} and custom parameters, in the order you want
 * 
 *
 * Requirement: The declaring class must be annotated with {@link Handler}.
 *
 * @see ModalData
 * @see ModalInput
 * @see Aggregate
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface ModalHandler {
	/**
	 * The name of the handler, must be the same as the handler name supplied in {@link Modals#create(String)}
	 *
	 * @return The name of the modal handler
	 */
	String name();
}