Package com.velocitypowered.api.event.player

Class CookieRequestEvent.ForwardResult

java.lang.Object

com.velocitypowered.api.event.player.CookieRequestEvent.ForwardResult

All Implemented Interfaces:

ResultedEvent.Result

Enclosing class:

CookieRequestEvent

public static final class CookieRequestEvent.ForwardResult
extends Object
implements ResultedEvent.Result

A result determining whether or not to forward the cookie request on.

Method Summary

Modifier and Type	Method	Description
static CookieRequestEvent.ForwardResult	forward()	Allows the cookie request to be forwarded to the client.
Key	getKey()
static CookieRequestEvent.ForwardResult	handled()	Prevents the cookie request from being forwarded to the client, the cookie request is handled by the proxy.
boolean	isAllowed()	Returns whether or not the event is allowed to proceed.
static CookieRequestEvent.ForwardResult	key(Key key)	Allows the cookie request to be forwarded to the client, but silently replaces the identifier of the cookie with another.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

isAllowed

public boolean isAllowed()

Description copied from interface: ResultedEvent.Result

Returns whether or not the event is allowed to proceed. Plugins may choose to skip denied events, and the proxy will respect the result of this method.

Specified by:

isAllowed in interface ResultedEvent.Result

Returns:

whether or not the event is allowed to proceed

getKey

public Key getKey()

toString

public String toString()

Overrides:

toString in class Object

forward

public static CookieRequestEvent.ForwardResult forward()

Allows the cookie request to be forwarded to the client.

Returns:

the forward result

handled

public static CookieRequestEvent.ForwardResult handled()

Prevents the cookie request from being forwarded to the client, the cookie request is handled by the proxy.

Returns:

the handled result

key

public static CookieRequestEvent.ForwardResult key(Key key)

Allows the cookie request to be forwarded to the client, but silently replaces the identifier of the cookie with another.

Parameters:

key - the identifier to use instead

Returns:

a result with a new key