Package com.velocitypowered.api.util

Class ServerLink

java.lang.Object

com.velocitypowered.api.util.ServerLink

public final class ServerLink
extends Object

Represents a custom URL servers can show in player pause menus. Links can be of a built-in type or use a custom component text label.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ServerLink.Type	Built-in types of server links.

Method Summary

Modifier and Type	Method	Description
Optional<ServerLink.Type>	getBuiltInType()	Get the type of the server link.
Optional<Component>	getCustomLabel()	Get the custom component label of the server link.
URI	getUrl()	Get the link URI.
static ServerLink	serverLink(ServerLink.Type type, String link)	Creates a ServerLink with a built-in type label.
static ServerLink	serverLink(Component label, String link)	Creates a ServerLink with a custom component label.

Methods inherited from class java.lang.Object

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

Method Details

serverLink

public static ServerLink serverLink(Component label,
 String link)

Creates a ServerLink with a custom component label.

Parameters:

label - the Component to display to the user

link - the URL to open when clicked

Returns:

a ServerLink instance with the given label and URL

serverLink

public static ServerLink serverLink(ServerLink.Type type,
 String link)

Creates a ServerLink with a built-in type label.

Parameters:

type - the predefined type of the link

link - the URL to open when clicked

Returns:

a ServerLink instance with the given type and URL

getBuiltInType

public Optional<ServerLink.Type> getBuiltInType()

Get the type of the server link.

Returns:

the type of the server link

getCustomLabel

public Optional<Component> getCustomLabel()

Get the custom component label of the server link.

Returns:

the custom component label of the server link

getUrl

public URI getUrl()

Get the link URI.

Returns:

the link URI