discord4j.core.event.domain.lifecycle

Class ReadyEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.lifecycle.GatewayLifecycleEvent

discord4j.core.event.domain.lifecycle.ReadyEvent

public class ReadyEvent
extends GatewayLifecycleEvent

Dispatched when an initial connection to the Discord gateway has been established.

This event is dispatched by Discord.

See Also:

Ready

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadyEvent.Guild An incomplete Guild provided by Discord upon the ready event.

Constructor Summary

Constructors

Constructor and Description
ReadyEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, int gatewayVersion, User self, Set<ReadyEvent.Guild> guilds, String sessionId, List<String> trace)

Method Summary

Modifier and Type	Method and Description
int	getGatewayVersion() Gets the gateway protocol version being used.
Set<ReadyEvent.Guild>	getGuilds() Gets a set of Unavailable ReadyEvent.Guild.
User	getSelf() Gets the bot User.
String	getSessionId() Gets the current session ID of the connection.
List<String>	getTrace() Gets the trace provided by Discord.
String	toString()

Methods inherited from class discord4j.core.event.domain.Event

getClient, getShardInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadyEvent

public ReadyEvent(GatewayDiscordClient gateway,
                  ShardInfo shardInfo,
                  int gatewayVersion,
                  User self,
                  Set<ReadyEvent.Guild> guilds,
                  String sessionId,
                  List<String> trace)

Method Detail

getGatewayVersion

public int getGatewayVersion()

Gets the gateway protocol version being used. Ex. 6.

Returns:

The gateway protocol version being used.

getSelf

public User getSelf()

Gets the bot User.

Returns:

The bot User.

getGuilds

public Set<ReadyEvent.Guild> getGuilds()

Gets a set of Unavailable ReadyEvent.Guild. These Guilds have not yet been provided via a GuildCreateEvent

Returns:

A set of unavailable Guilds.

See Also:

Unavailable Guild Object

getSessionId

public String getSessionId()

Gets the current session ID of the connection.

Returns:

the session ID of the connection

getTrace

public List<String> getTrace()

Gets the trace provided by Discord. Used for debugging - The Guilds the user is in.

Returns:

The trace provided by Discord.

toString

public String toString()

Overrides:

toString in class Object