Package dev.sympho.bot_utils.event

Interface MessageCreateEventContext

All Superinterfaces:

AccessContext, AccessValidator, ChannelAccessContext, ChannelAccessValidator, ChannelEventContext, EventContext, MessageBasedContext, MessageEventContext, MessageIncludedContext

public interface MessageCreateEventContext
extends MessageEventContext, MessageIncludedContext

The context of a new message being created.

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.
MessageCreateEvent	event()	Retrieves the triggering event.
default Mono<Message>	fetchMessage()	Retrieves the message that the event originates from.
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 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.
default User	user()	Retrieves the user.

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

asGuild, isPrivate, member, member

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

MessageCreateEvent event()

Description copied from interface: EventContext

Retrieves the triggering event.

Specified by:

event in interface EventContext

Specified by:

event in interface MessageEventContext

Returns:

The event.

message

default 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

Specified by:

message in interface MessageIncludedContext

Returns:

The message, or null if the message data is not attached to the received event.

See Also:

• MessageBasedContext.fetchMessage()

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.

user

default User user()

Description copied from interface: AccessContext

Retrieves the user.

Specified by:

user in interface AccessContext

Returns:

The user.

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.

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.

channel

default Mono<MessageChannel> channel()

Description copied from interface: ChannelAccessContext

Retrieves the channel.

Specified by:

channel in interface ChannelAccessContext

Specified by:

channel in interface MessageBasedContext

Returns:

The channel.