Package com.velocitypowered.api.event.player

Class CookieReceiveEvent

java.lang.Object

com.velocitypowered.api.event.player.CookieReceiveEvent

All Implemented Interfaces:

ResultedEvent<CookieReceiveEvent.ForwardResult>

@AwaitingEvent
public final class CookieReceiveEvent
extends Object
implements ResultedEvent<CookieReceiveEvent.ForwardResult>

This event is fired when a cookie response from a client is received by the proxy. This usually happens after either a proxy plugin or a backend server requested a cookie. Velocity will wait on this event to finish firing before discarding the received cookie (if handled) or forwarding it to the backend server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CookieReceiveEvent.ForwardResult	A result determining whether or not to forward the cookie response on.

Nested classes/interfaces inherited from interface com.velocitypowered.api.event.ResultedEvent

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
CookieReceiveEvent(Player player, Key key, byte @Nullable [] data)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
byte @Nullable []	getOriginalData()	Returns the original cookie data received from the client, if present.
Key	getOriginalKey()	Returns the original cookie identifier received from the client.
Player	getPlayer()	Returns the player who sent the cookie response.
CookieReceiveEvent.ForwardResult	getResult()	Returns the result associated with this event.
void	setResult(CookieReceiveEvent.ForwardResult result)	Sets the result of this event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CookieReceiveEvent

public CookieReceiveEvent(Player player,
 Key key,
 byte @Nullable [] data)

Creates a new instance.

Parameters:

player - the player who sent the cookie response

key - the identifier of the cookie

data - the data of the cookie

Method Details

getResult

public CookieReceiveEvent.ForwardResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<CookieReceiveEvent.ForwardResult>

Returns:

the result of this event

setResult

public void setResult(CookieReceiveEvent.ForwardResult result)

Description copied from interface: ResultedEvent

Sets the result of this event. The result must be non-null.

Specified by:

setResult in interface ResultedEvent<CookieReceiveEvent.ForwardResult>

Parameters:

result - the new result

getPlayer

public Player getPlayer()

Returns the player who sent the cookie response.

Returns:

the player

getOriginalKey

public Key getOriginalKey()

Returns the original cookie identifier received from the client.

Returns:

the original cookie key

getOriginalData

public byte @Nullable [] getOriginalData()

Returns the original cookie data received from the client, if present.

Returns:

the original cookie data, or null if not present

toString

public String toString()

Overrides:

toString in class Object