Package net.dv8tion.jda.api.events.session

Class SessionDisconnectEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.session.GenericSessionEvent

net.dv8tion.jda.api.events.session.SessionDisconnectEvent

All Implemented Interfaces:

GenericEvent

public class SessionDisconnectEvent
extends GenericSessionEvent

Indicates that JDA has been disconnected from the remote server.
When this event is fired JDA will try to reconnect if possible unless JDABuilder.setAutoReconnect(Boolean) has been provided false or the disconnect was too fatal in which case a ShutdownEvent is fired.

When reconnecting was successful either a SessionRecreateEvent or SessionResumeEvent is fired.

Constructor Summary

Constructors

Constructor	Description
SessionDisconnectEvent(JDA api, WebSocketFrame serverCloseFrame, WebSocketFrame clientCloseFrame, boolean closedByServer, OffsetDateTime disconnectTime)

Method Summary

Modifier and Type	Method	Description
WebSocketFrame	getClientCloseFrame()	The close frame we sent to discord
CloseCode	getCloseCode()	Possibly-null CloseCode representing the meaning for this DisconnectEvent
WebSocketFrame	getServiceCloseFrame()	The close frame discord sent to us
OffsetDateTime	getTimeDisconnected()	Time at which we noticed the disconnection
boolean	isClosedByServer()	Whether the connection was closed by discord

Methods inherited from class net.dv8tion.jda.api.events.session.GenericSessionEvent

getState

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SessionDisconnectEvent

public SessionDisconnectEvent(@Nonnull
 JDA api,
 @Nullable
 WebSocketFrame serverCloseFrame,
 @Nullable
 WebSocketFrame clientCloseFrame,
 boolean closedByServer,
 @Nonnull
 OffsetDateTime disconnectTime)

Method Details

getCloseCode

@Nullable
public CloseCode getCloseCode()

Possibly-null CloseCode representing the meaning for this DisconnectEvent

This is null if this disconnect did either not happen because the Service closed the session (see isClosedByServer()) or if there is no mapped CloseCode enum constant for the service close code!

Returns:

Possibly-null CloseCode

getServiceCloseFrame

@Nullable
public WebSocketFrame getServiceCloseFrame()

The close frame discord sent to us

Returns:

The WebSocketFrame discord sent as closing handshake

getClientCloseFrame

@Nullable
public WebSocketFrame getClientCloseFrame()

The close frame we sent to discord

Returns:

The WebSocketFrame we sent as closing handshake

isClosedByServer

public boolean isClosedByServer()

Whether the connection was closed by discord

Returns:

True, if discord closed our connection

getTimeDisconnected

@Nonnull
public OffsetDateTime getTimeDisconnected()

Time at which we noticed the disconnection

Returns:

Time of closure