Package dev.sympho.bot_utils.event

Interface ComponentEventContext

All Superinterfaces:

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

All Known Subinterfaces:

ButtonEventContext, ModalEventContext

public interface ComponentEventContext
extends DeferrableInteractionEventContext, MessageBasedContext

The context of an event fired by interacting with a message component.

Since:

1.0

Version:

1.0

Method Summary

Modifier and Type	Method	Description
default Mono<MessageChannel>	channel()	Retrieves the channel.
ComponentInteractionEvent	event()	Retrieves the triggering event.
default Mono<Message>	fetchMessage()	Retrieves the message that the event originates from.
default @Nullable Message	message()	Retrieves the message that the event originates from, as attached to the event.
default Snowflake	messageId()	Retrieves the ID of the message that the event originates from.

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.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

ComponentInteractionEvent event()

Description copied from interface: EventContext

Retrieves the triggering event.

Specified by:

event in interface DeferrableInteractionEventContext

Specified by:

event in interface EventContext

Specified by:

event in interface InteractionEventContext

Returns:

The event.

message

default @Nullable Message message()

Description copied from interface: MessageBasedContext

Retrieves the message that the event originates from, as attached to the event.

Specified by:

message in interface MessageBasedContext

Returns:

The message, or null if the message is ephemeral.

See Also:

• MessageBasedContext.fetchMessage()

API Note:

If the message is ephemeral, only the ID will be present.

fetchMessage

default Mono<Message> fetchMessage()

Description copied from interface: MessageBasedContext

Retrieves the message that the event originates from.

Specified by:

fetchMessage in interface MessageBasedContext

Returns:

The message, or an empty mono if the message cannot be retrieved.

See Also:

• MessageBasedContext.message()

messageId

default Snowflake messageId()

Description copied from interface: MessageBasedContext

Retrieves the ID of the message that the event originates from.

Specified by:

messageId in interface MessageBasedContext

Returns:

The message ID.

channel

default Mono<MessageChannel> channel()

Description copied from interface: ChannelAccessContext

Retrieves the channel.

Specified by:

channel in interface ChannelAccessContext

Specified by:

channel in interface InteractionEventContext

Specified by:

channel in interface MessageBasedContext

Returns:

The channel.