Package com.velocitypowered.api.event.player

Class CookieRequestEvent

java.lang.Object

com.velocitypowered.api.event.player.CookieRequestEvent

All Implemented Interfaces:

ResultedEvent<CookieRequestEvent.ForwardResult>

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

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

Nested Class Summary

Nested Classes

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

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

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
CookieRequestEvent(Player player, Key key)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Key	getOriginalKey()	Returns the original identifier of the cookie being requested.
Player	getPlayer()	Returns the player from whom the cookie is being requested.
CookieRequestEvent.ForwardResult	getResult()	Returns the result associated with this event.
void	setResult(CookieRequestEvent.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

CookieRequestEvent

public CookieRequestEvent(Player player,
 Key key)

Creates a new instance.

Parameters:

player - the player from whom the cookies is requested

key - the identifier of the cookie

Method Details

getResult

public CookieRequestEvent.ForwardResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<CookieRequestEvent.ForwardResult>

Returns:

the result of this event

setResult

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

Parameters:

result - the new result

getPlayer

public Player getPlayer()

Returns the player from whom the cookie is being requested.

Returns:

the player

getOriginalKey

public Key getOriginalKey()

Returns the original identifier of the cookie being requested.

Returns:

the original cookie key

toString

public String toString()

Overrides:

toString in class Object