cloud.timo.TimoCloud.api

Interface TimoCloudUniversalAPI

public interface TimoCloudUniversalAPI

Use TimoCloudAPI.getUniversalAPI() to get an instance of this class

Method Summary

Modifier and Type	Method and Description
APIRequestFuture<ProxyGroupObject>	createProxyGroup(ProxyGroupProperties properties)
APIRequestFuture<ServerGroupObject>	createServerGroup(ServerGroupProperties properties)
BaseObject	getBase(java.lang.String identifier)
java.util.Collection<BaseObject>	getBases()
CordObject	getCord(java.lang.String identifier)
java.util.Collection<CordObject>	getCords()
PlayerObject	getPlayer(java.lang.String name)
PlayerObject	getPlayer(java.util.UUID uuid)
java.util.Collection<PlayerObject>	getPlayers()
java.util.Collection<ProxyObject>	getProxies()
ProxyObject	getProxy(java.lang.String identifier) Use this to get a proxy by name
ProxyGroupObject	getProxyGroup(java.lang.String identifier) Use this to get a proxy group by name
java.util.Collection<ProxyGroupObject>	getProxyGroups()
ServerObject	getServer(java.lang.String identifier) Use this to get a server by name
ServerGroupObject	getServerGroup(java.lang.String identifier) Use this to get a server group by name
java.util.Collection<ServerGroupObject>	getServerGroups()
java.util.Collection<ServerObject>	getServers()
APIRequestFuture<java.lang.Void>	registerBase(java.lang.String publickey) Give a base the permission to connect to the core.

Method Detail

getServerGroups

java.util.Collection<ServerGroupObject> getServerGroups()

Returns:

A collection of ServerGroupObject which contains all server groups

getServerGroup

ServerGroupObject getServerGroup(java.lang.String identifier)

Use this to get a server group by name

Parameters:

identifier - The group's name or id, case-sensitive

Returns:

A ServerGroupObject corresponding to the given name

getServer

ServerObject getServer(java.lang.String identifier)

Use this to get a server by name

Parameters:

identifier - The server's name or id, case-sensitive

Returns:

A ServerObject corresponding to the given name or id

getServers

java.util.Collection<ServerObject> getServers()

Returns:

A collection of all servers in the network

getProxyGroups

java.util.Collection<ProxyGroupObject> getProxyGroups()

Returns:

A collection of ProxyGroupObject containing all proxy groups

getProxyGroup

ProxyGroupObject getProxyGroup(java.lang.String identifier)

Use this to get a proxy group by name

Parameters:

identifier - The group's name or id, case-sensitive

Returns:

A ServerGroupObject corresponding to the given name

getProxy

ProxyObject getProxy(java.lang.String identifier)

Use this to get a proxy by name

Parameters:

identifier - The proxy's name or id

Returns:

A ServerObject corresponding to the given name or id

getProxies

java.util.Collection<ProxyObject> getProxies()

Returns:

A collection of all proxies in the network

getBases

java.util.Collection<BaseObject> getBases()

Returns:

A collection of all bases

getBase

BaseObject getBase(java.lang.String identifier)

Parameters:

identifier - The base's name or id, case-sensitive

Returns:

A BaseObject corresponding to the given name

getCords

java.util.Collection<CordObject> getCords()

Returns:

A collection of all connected CordObjects

getCord

CordObject getCord(java.lang.String identifier)

Parameters:

identifier - The cord's name or id, case-sensitive

Returns:

A CordObject corresponding to the given name

getPlayer

PlayerObject getPlayer(java.util.UUID uuid)

Parameters:

uuid - The player's Minecraft UUID

Returns:

If the player is online, this will return a PlayerObject, else null

getPlayer

PlayerObject getPlayer(java.lang.String name)

Parameters:

name - The player's Minecraft name

Returns:

If the player is online, this will return a PlayerObject, else null

getPlayers

java.util.Collection<PlayerObject> getPlayers()

Returns:

A collection of all players in the network

registerBase

APIRequestFuture<java.lang.Void> registerBase(java.lang.String publickey)

Give a base the permission to connect to the core.

Parameters:

publickey - The publickey that should get permission to connect to the core (Base64 encoding)

Returns:

A future being completed when the value was changed

createServerGroup

APIRequestFuture<ServerGroupObject> createServerGroup(ServerGroupProperties properties)

Parameters:

properties - The group's properties

Returns:

An APIRequestFuture being completed once the group has been created

createProxyGroup

APIRequestFuture<ProxyGroupObject> createProxyGroup(ProxyGroupProperties properties)

Parameters:

properties - The group's properties

Returns:

An APIRequestFuture being completed once the group has been created