Package com.velocitypowered.api.event.player

Class CookieStoreEvent

java.lang.Object

com.velocitypowered.api.event.player.CookieStoreEvent

All Implemented Interfaces:

ResultedEvent<CookieStoreEvent.ForwardResult>

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

This event is fired when a cookie should be stored on a player's client. This process can be initiated either by a proxy plugin or by a backend server. Velocity will wait on this event to finish firing before discarding the cookie (if handled) or forwarding it to the client so that it can store the cookie.

Nested Class Summary

Nested Classes

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

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

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
byte[]	getOriginalData()	Returns the original data of the cookie to be stored.
Key	getOriginalKey()	Returns the original key identifying the cookie to be stored.
Player	getPlayer()	Returns the player who should store the cookie.
CookieStoreEvent.ForwardResult	getResult()	Returns the result associated with this event.
void	setResult(CookieStoreEvent.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

CookieStoreEvent

public CookieStoreEvent(Player player,
 Key key,
 byte[] data)

Creates a new instance.

Parameters:

player - the player who should store the cookie

key - the identifier of the cookie

data - the data of the cookie

Method Details

getResult

public CookieStoreEvent.ForwardResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<CookieStoreEvent.ForwardResult>

Returns:

the result of this event

setResult

public void setResult(CookieStoreEvent.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<CookieStoreEvent.ForwardResult>

Parameters:

result - the new result

getPlayer

public Player getPlayer()

Returns the player who should store the cookie.

Returns:

the player

getOriginalKey

public Key getOriginalKey()

Returns the original key identifying the cookie to be stored.

Returns:

the cookie key

getOriginalData

public byte[] getOriginalData()

Returns the original data of the cookie to be stored.

Returns:

the cookie data

toString

public String toString()

Overrides:

toString in class Object