Package net.md_5.bungee.api

Class ServerConnectRequest.Builder

java.lang.Object

net.md_5.bungee.api.ServerConnectRequest.Builder

Enclosing class:

ServerConnectRequest

public static class ServerConnectRequest.Builder
extends Object

Class that sets default properties/adds methods to the lombok builder generated class.

Method Summary

Modifier and Type	Method	Description
ServerConnectRequest	build()
ServerConnectRequest.Builder	callback(Callback<ServerConnectRequest.Result> callback)	Callback to execute post request.
ServerConnectRequest.Builder	connectTimeout(int connectTimeout)	Timeout in milliseconds for request.
ServerConnectRequest.Builder	reason(ServerConnectEvent.Reason reason)	Reason for connecting to server.
ServerConnectRequest.Builder	requireAccess(boolean requireAccess)	Disabled by default.
ServerConnectRequest.Builder	retry(boolean retry)	Should the player be attempted to connect to the next server in their queue if the initial request fails.
ServerConnectRequest.Builder	sendFeedback(boolean sendFeedback)	Should feedback from the request be sent to players, allows plugins to silently deal with the outcome on their own
ServerConnectRequest.Builder	target(@NonNull ServerInfo target)	Target server to connect to.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

target

public ServerConnectRequest.Builder target(@NonNull
 @NonNull ServerInfo target)

Target server to connect to.

Returns:

this.

reason

public ServerConnectRequest.Builder reason(@NonNull
 ServerConnectEvent.Reason reason)

Reason for connecting to server.

Returns:

this.

callback

public ServerConnectRequest.Builder callback(Callback<ServerConnectRequest.Result> callback)

Callback to execute post request.

Returns:

this.

connectTimeout

public ServerConnectRequest.Builder connectTimeout(int connectTimeout)

Timeout in milliseconds for request.

Returns:

this.

retry

public ServerConnectRequest.Builder retry(boolean retry)

Should the player be attempted to connect to the next server in their queue if the initial request fails.

Returns:

this.

sendFeedback

public ServerConnectRequest.Builder sendFeedback(boolean sendFeedback)

Should feedback from the request be sent to players, allows plugins to silently deal with the outcome on their own

Returns:

this.

requireAccess

public ServerConnectRequest.Builder requireAccess(boolean requireAccess)

Disabled by default. Set to true if the permissions defined in the config to restrict servers to certain players should be respected for this request.

Returns:

this.

build

public ServerConnectRequest build()

toString

public String toString()

Overrides:

toString in class Object