-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
367d1a9
commit 764e6d2
Showing
3 changed files
with
108 additions
and
92 deletions.
There are no files selected for viewing
106 changes: 106 additions & 0 deletions
106
src/main/java/minevalley/core/api/messaging/DialogReceiver.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| package minevalley.core.api.messaging; | ||
|
|
||
| import minevalley.core.api.messaging.clickable.ChatMenu; | ||
| import minevalley.core.api.messaging.clickable.ClickableOption; | ||
| import minevalley.core.api.messaging.instruction.Instruction; | ||
| import minevalley.core.api.messaging.types.MessageType; | ||
| import net.kyori.adventure.text.ComponentLike; | ||
| import org.jetbrains.annotations.Contract; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import java.util.function.Consumer; | ||
|
|
||
| @SuppressWarnings("unused") | ||
| public interface DialogReceiver { | ||
|
|
||
| /** | ||
| * Sends a message to the receiver. | ||
| * | ||
| * @param message the message to send | ||
| * @param menu the menu to send | ||
| * @return the menu that was sent | ||
| * @throws IllegalArgumentException if the message or menu is null | ||
| */ | ||
| @Nonnull | ||
| @Contract("_, _ -> new") | ||
| ChatMenu sendMessage(@Nonnull ComponentLike message, @Nonnull ClickableOption... menu) | ||
| throws IllegalArgumentException; | ||
|
|
||
| /** | ||
| * Sends a message to the receiver. | ||
| * | ||
| * @param message the message to send | ||
| * @param instruction the instruction to send | ||
| * @param menu the menu to send | ||
| * @return the menu that was sent | ||
| * @throws IllegalArgumentException if the message, instruction or menu is null | ||
| */ | ||
| @Nonnull | ||
| @Contract("_, _, _ -> new") | ||
| ChatMenu sendMessage(@Nonnull ComponentLike message, @Nonnull Instruction instruction, | ||
| @Nonnull ClickableOption... menu) throws IllegalArgumentException; | ||
|
|
||
| /** | ||
| * Sends a message to the receiver. | ||
| * | ||
| * @param type the type of message | ||
| * @param message the message to send | ||
| * @param menu the menu to send | ||
| * @return the menu that was sent | ||
| * @throws IllegalArgumentException if the type, message or menu is null | ||
| */ | ||
| @Nonnull | ||
| @Contract("_, _, _ -> new") | ||
| ChatMenu sendMessage(@Nonnull MessageType type, @Nonnull ComponentLike message, @Nonnull ClickableOption... menu) | ||
| throws IllegalArgumentException; | ||
|
|
||
| /** | ||
| * Sends a message to the receiver. | ||
| * | ||
| * @param type the type of message | ||
| * @param message the message to send | ||
| * @param instruction the instruction to send | ||
| * @param menu the menu to send | ||
| * @return the menu that was sent | ||
| * @throws IllegalArgumentException if the type, message, instruction or menu is null | ||
| */ | ||
| @Nonnull | ||
| @Contract("_, _, _, _ -> new") | ||
| ChatMenu sendMessage(@Nonnull MessageType type, @Nonnull ComponentLike message, @Nonnull Instruction instruction, | ||
| @Nonnull ClickableOption... menu) throws IllegalArgumentException; | ||
|
|
||
| /** | ||
| * Sends a message to the receiver and waits for an input. | ||
| * | ||
| * @param text the text to send | ||
| * @param callback the callback to call when the user inputs something | ||
| * @throws IllegalArgumentException if the text or callback is null | ||
| */ | ||
| void input(@Nonnull String text, @Nonnull Consumer<String> callback) throws IllegalArgumentException; | ||
|
|
||
| /** | ||
| * Sends a message to the receiver and waits for an input. | ||
| * | ||
| * @param text the text to send | ||
| * @param instruction the instruction to send | ||
| * @param callback the callback to call when the user inputs something | ||
| * @throws IllegalArgumentException if the text, instruction or callback is null | ||
| */ | ||
| void input(@Nonnull String text, @Nonnull Instruction instruction, @Nonnull Consumer<String> callback) | ||
| throws IllegalArgumentException; | ||
|
|
||
| /** | ||
| * Checks if the receiver is currently in a chat input. | ||
| * | ||
| * @return true if the receiver is in a chat input, false otherwise | ||
| */ | ||
| @Contract(pure = true) | ||
| boolean isInChatInput(); | ||
|
|
||
| /** | ||
| * Leaves the current chat input. | ||
| * <p> | ||
| * If the receiver is not in a chat input, this method does nothing. | ||
| */ | ||
| void leaveChatInput(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters