Package dev.sympho.bot_utils.component

Class ModalManager.ModalContext

java.lang.Object

dev.sympho.bot_utils.component.ComponentManager.ComponentContext<ModalSubmitInteractionEvent>

dev.sympho.bot_utils.component.ModalManager.ModalContext

All Implemented Interfaces:

AccessContext, AccessValidator, ChannelAccessContext

Enclosing class:

ModalManager

public final class ModalManager.ModalContext
extends ComponentManager.ComponentContext<ModalSubmitInteractionEvent>

The execution context of a modal being submitted.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
TextInput	getField(String fieldId)	Retrieves the input field with the given custom ID.
Collection<TextInput>	getFields()	Retrieves the input fields in this context.

Methods inherited from class dev.sympho.bot_utils.component.ComponentManager.ComponentContext

getChannel, getChannelId, getClient, getEvent, getGuild, getGuildId, getInteraction, getMember, getMember, getMessage, getMessageId, getUser, hasAccess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.sympho.bot_utils.access.AccessContext

asGuild, isPrivate

Methods inherited from interface dev.sympho.bot_utils.access.AccessValidator

validate

Methods inherited from interface dev.sympho.bot_utils.access.ChannelAccessContext

asUser

Method Details

getField

public TextInput getField(String fieldId)
                   throws IllegalArgumentException

Retrieves the input field with the given custom ID.

Parameters:

fieldId - The custom ID.

Returns:

The input field with that ID.

Throws:

IllegalArgumentException - if there is no field in this context with that ID.

getFields

public Collection<TextInput> getFields()

Retrieves the input fields in this context.

Returns:

The input fields.