Package net.dv8tion.jda.api.events

Class RawGatewayEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.RawGatewayEvent

All Implemented Interfaces:

GenericEvent

public class RawGatewayEvent
extends Event

Wrapper for the raw dispatch event received from discord.
This provides the raw structure of a gateway event through a DataObject instance containing:

• d: The payload of the package (DataObject)
• t: The type of the package (String)
• op: The opcode of the package, always 0 for dispatch (int)
• s: The sequence number, equivalent to Event.getResponseNumber() (long)

Sent after derived events. This is disabled by default and can be enabled through either the JDABuilder or DefaultShardManagerBuilder.

See Also:

• JDABuilder.setRawEventsEnabled(boolean)
• DefaultShardManagerBuilder.setRawEventsEnabled(boolean)
• Gateway Documentation

Constructor Summary

Constructors

Constructor	Description
RawGatewayEvent(JDA api, long responseNumber, DataObject data)

Method Summary

Modifier and Type	Method	Description
DataObject	getPackage()	The raw gateway package including sequence and type.
DataObject	getPayload()	The payload of the package.
String	getType()	The type of event.

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

getJDA, getResponseNumber

Methods inherited from class java.lang.Object

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

Constructor Details

RawGatewayEvent

public RawGatewayEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 DataObject data)

Method Details

getPackage

@Nonnull
public DataObject getPackage()

The raw gateway package including sequence and type.

• d: The payload of the package (DataObject)
• t: The type of the package (String)
• op: The opcode of the package, always 0 for dispatch (int)
• s: The sequence number, equivalent to Event.getResponseNumber() (long)

Returns:

The data object

getPayload

@Nonnull
public DataObject getPayload()

The payload of the package.

Returns:

The payload as a DataObject instance

getType

@Nonnull
public String getType()

The type of event.

Returns:

The type of event.