Package dev.sympho.bot_utils.event

Interface ModalEventContext

All Superinterfaces:

AccessContext, AccessValidator, ChannelAccessContext, ChannelAccessValidator, ChannelEventContext, ComponentEventContext, DeferrableInteractionEventContext, EventContext, InteractionEventContext, MessageBasedContext, RepliableContext

public interface ModalEventContext
extends ComponentEventContext

The context of a modal component being submitted by a user.

Since:

1.0

Version:

1.0

Method Summary

Modifier and Type	Method	Description
ModalSubmitInteractionEvent	event()	Retrieves the triggering event.
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 interface dev.sympho.bot_utils.access.AccessContext

asGuild, isPrivate

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

asUser

Methods inherited from interface dev.sympho.bot_utils.event.ChannelEventContext

belongs, belongs, belongs, belongs, hasAccess, hasAccess, validate, validator

Methods inherited from interface dev.sympho.bot_utils.event.ComponentEventContext

channel, fetchMessage, message, messageId

Methods inherited from interface dev.sympho.bot_utils.event.EventContext

client, validate

Methods inherited from interface dev.sympho.bot_utils.event.InteractionEventContext

channelId, guild, guildId, interaction, member, member, user

Methods inherited from interface dev.sympho.bot_utils.event.RepliableContext

replies, reply, reply, reply, reply, reply, reply, reply

Method Details

event

ModalSubmitInteractionEvent event()

Description copied from interface: EventContext

Retrieves the triggering event.

Specified by:

event in interface ComponentEventContext

Specified by:

event in interface DeferrableInteractionEventContext

Specified by:

event in interface EventContext

Specified by:

event in interface InteractionEventContext

Returns:

The event.

getField

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

Collection<TextInput> getFields()

Retrieves the input fields in this context.

Returns:

The input fields.