Package com.github.twitch4j.eventsub.socket.domain

Class SocketPayload

java.lang.Object

com.github.twitch4j.eventsub.socket.domain.SocketPayload

public class SocketPayload
extends Object

An object that contains the EventSub Websocket message.

Constructor Summary

Constructors

Constructor	Description
SocketPayload()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable Object	getEventData()	The event’s data.
@Nullable EventSubEvent	getParsedEvent()
@Nullable EventSubSocketInformation	getSession()	An object that contains information about the connection.
@Nullable EventSubSubscription	getSubscription()	An object that contains information about your subscription.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SocketPayload

public SocketPayload()

Method Details

getParsedEvent

@Nullable
public @Nullable EventSubEvent getParsedEvent()

Returns:

the parsed event data from raw Map to EventSubEvent, or null if this payload does not represent a notification.

getSession

@Nullable
public @Nullable EventSubSocketInformation getSession()

An object that contains information about the connection.

Present if SocketMessageMetadata.getMessageType() is: SocketMessageType.SESSION_WELCOME or SocketMessageType.SESSION_RECONNECT.

getSubscription

@Nullable
public @Nullable EventSubSubscription getSubscription()

An object that contains information about your subscription.

Present if SocketMessageMetadata.getMessageType() is: SocketMessageType.NOTIFICATION or SocketMessageType.REVOCATION.

getEventData

@Nullable
public @Nullable Object getEventData()

The event’s data.

For information about the event’s data, see the subscription type’s description in Subscription Types.

Present only if SocketMessageMetadata.getMessageType() is SocketMessageType.NOTIFICATION.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object