Package discord4j.core.event.domain

Class Event

java.lang.Object

discord4j.core.event.domain.Event

Direct Known Subclasses:

ApplicationCommandCreateEvent, ApplicationCommandEvent, AutoModActionExecutedEvent, AutoModRuleEvent, ChannelEvent, GatewayLifecycleEvent, GuildEvent, IntegrationCreateEvent, IntegrationDeleteEvent, IntegrationUpdateEvent, InteractionCreateEvent, InviteCreateEvent, InviteDeleteEvent, MessageEvent, PresenceUpdateEvent, RoleEvent, StageInstanceCreateEvent, StageInstanceDeleteEvent, StageInstanceUpdateEvent, ThreadEvent, UserUpdateEvent, VoiceServerUpdateEvent, VoiceStateUpdateEvent, WebhooksUpdateEvent

public abstract class Event
extends Object

Represents a Discord real-time event used to track a client's state.

Gateway lifecycle events

These events are specifically sent by Discord as real-time payload.

• ReadyEvent: Discord has established a fresh Gateway session
• ResumeEvent: specifically sent after successful resumption

Message related events

• MessageCreateEvent: a guild or DM message was created
• MessageDeleteEvent: a message was deleted
• MessageUpdateEvent: a message's content was updated
• MessageBulkDeleteEvent: a batch of messages were deleted at once
• ReactionAddEvent: a reaction was added to a message
• ReactionRemoveEvent: a reaction was removed from a message
• ReactionRemoveEmojiEvent: reactions for a given emoji were removed from a message
• ReactionRemoveAllEvent: all reactions were removed from a message

Interaction related events

• ChatInputInteractionEvent: user interacted with a slash command
• MessageInteractionEvent: user interacted with a message context menu
• UserInteractionEvent: user interacted with a user context menu
• ApplicationCommandInteractionEvent: user interacted with an application command
• SelectMenuInteractionEvent: user interacted with a select menu component
• ButtonInteractionEvent: user interacted with a button component
• ComponentInteractionEvent: user interacted with a component
• InteractionCreateEvent: base for all Gateway interaction events

Guild related events

• GuildCreateEvent: a startup event providing initial Guild details, content depends on Intent configuration
• GuildDeleteEvent: after being kicked from a guild, after leaving a guild or after a guild becoming unavailable due to outage
• GuildUpdateEvent: a guild has changed one or more properties
• MemberJoinEvent: a user has joined a guild
• MemberLeaveEvent: a user has left or was kicked from a guild
• MemberUpdateEvent: a user had their nickname and/or roles change
• MemberChunkEvent: a batch of a guild's member details
• EmojisUpdateEvent: a guild's emoji list was updated
• StickersUpdateEvent: a guild's sticker list was updated
• BanEvent: a user was banned from a guild
• UnbanEvent: a user's ban was removed from a guild
• IntegrationsUpdateEvent: a guild has updated their app integrations
• WebhooksUpdateEvent: a guild's webhooks were updated

Channel related events

• Channel creation events: TextChannelCreateEvent, VoiceChannelCreateEvent, CategoryCreateEvent, NewsChannelCreateEvent, StoreChannelCreateEvent
• Channel deletion events: TextChannelDeleteEvent, VoiceChannelDeleteEvent, CategoryDeleteEvent, NewsChannelDeleteEvent, StoreChannelDeleteEvent
• Channel update events: TextChannelUpdateEvent, VoiceChannelUpdateEvent, CategoryUpdateEvent, NewsChannelUpdateEvent, StoreChannelUpdateEvent
• TypingStartEvent: as a user has started typing a message
• PinsUpdateEvent: a channel's pinned messages were updated

Role related events

• RoleCreateEvent: a role was created in a guild
• RoleDeleteEvent: a role was deleted from a guild
• RoleUpdateEvent: one or more role's properties were updated in a guild

Invite related events

• InviteCreateEvent: an invite to a channel was created
• InviteDeleteEvent: an invite to a channel has expired

User related events

• UserUpdateEvent: one or more user's properties were updated
• PresenceUpdateEvent: a user's presence or status has changed

Voice connections related events

• VoiceStateUpdateEvent: a user's connected voice channel and status, was requested or has updated
• VoiceServerUpdateEvent: a guild's voice server was requested or has updated

Connection lifecycle events

These events are derived by Discord4J according to the status of the websocket lifecycle.

• ConnectEvent: connected to the Gateway for the first time only
• ReconnectEvent: subsequent reconnections to the Gateway, either through resumption or full retry
• DisconnectEvent: disconnected from the Gateway
• ReconnectStartEvent: a resumption or reconnection attempt has begun
• ReconnectFailEvent: a resumption or reconnection attempt has failed but can be retried
• SessionInvalidatedEvent: a gateway session has been invalidated

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Event(GatewayDiscordClient gateway, ShardInfo shardInfo)

Method Summary

Modifier and Type	Method	Description
GatewayDiscordClient	getClient()	Get the GatewayDiscordClient that emitted this Event.
ShardInfo	getShardInfo()	Retrieve the shard details from this Event.

Methods inherited from class java.lang.Object

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

Constructor Details

Event

protected Event(GatewayDiscordClient gateway,
 ShardInfo shardInfo)

Method Details

getClient

public GatewayDiscordClient getClient()

Get the GatewayDiscordClient that emitted this Event.

Returns:

The client emitting this event.

getShardInfo

public ShardInfo getShardInfo()

Retrieve the shard details from this Event.

Returns:

a ShardInfo object reflecting index and count for this event.