Package dev.sympho.bot_utils.event

Interface InteractionEventContext

All Superinterfaces:

AccessContext, AccessValidator, ChannelAccessContext, ChannelAccessValidator, ChannelEventContext, EventContext

All Known Subinterfaces:

ApplicationCommandEventContext, ButtonEventContext, ComponentEventContext, DeferrableInteractionEventContext, ModalEventContext, SlashCommandEventContext

public interface InteractionEventContext
extends ChannelEventContext

The context of an interaction-based event.

Since:

1.0

Version:

1.0

Method Summary

Modifier and Type	Method	Description
default Mono<MessageChannel>	channel()	Retrieves the channel.
default Snowflake	channelId()	Retrieves the ID of the channel.
InteractionCreateEvent	event()	Retrieves the triggering event.
default Mono<Guild>	guild()	Retrieves the guild, if there is one.
default @Nullable Snowflake	guildId()	Retrieves the ID of the guild, if there is one.
default Interaction	interaction()	Retrieves the interaction associated with the event.
default Mono<Member>	member()	Retrieves the user as a guild member.
default Mono<Member>	member(Snowflake guildId)	Retrieves the user as a guild member of the given guild.
default User	user()	Retrieves the user.

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

Method Details

event

InteractionCreateEvent event()

Description copied from interface: EventContext

Retrieves the triggering event.

Specified by:

event in interface EventContext

Returns:

The event.

interaction

@Pure
default Interaction interaction()

Retrieves the interaction associated with the event.

Returns:

The interaction.

guild

default Mono<Guild> guild()

Description copied from interface: AccessContext

Retrieves the guild, if there is one.

Specified by:

guild in interface AccessContext

Returns:

The invoking guild.

guildId

default @Nullable Snowflake guildId()

Description copied from interface: AccessContext

Retrieves the ID of the guild, if there is one.

Specified by:

guildId in interface AccessContext

Returns:

The guild's ID, or null if a private channel.

user

default User user()

Description copied from interface: AccessContext

Retrieves the user.

Specified by:

user in interface AccessContext

Returns:

The user.

member

default Mono<Member> member()

Description copied from interface: AccessContext

Retrieves the user as a guild member.

Specified by:

member in interface AccessContext

Returns:

The calling user as a guild member. May be empty if the context is a private channel.

member

default Mono<Member> member(Snowflake guildId)

Description copied from interface: AccessContext

Retrieves the user as a guild member of the given guild.

Specified by:

member in interface AccessContext

Parameters:

guildId - The ID of the target guild.

Returns:

The user as a guild member of the given guild.

channel

default Mono<MessageChannel> channel()

Description copied from interface: ChannelAccessContext

Retrieves the channel.

Specified by:

channel in interface ChannelAccessContext

Returns:

The channel.

channelId

default Snowflake channelId()

Description copied from interface: ChannelAccessContext

Retrieves the ID of the channel.

Specified by:

channelId in interface ChannelAccessContext

Returns:

The channel's ID.