ServerObject (TimoCloud-API 6.7.9 API)

All Superinterfaces:: IdentifiableObject

public interface ServerObject
extends IdentifiableObject

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`APIRequestFuture<Void>`	`executeCommand(String command)` Executes the given command as ConsoleSender on the server
`BaseObject`	`getBase()` Returns the base the server has been started by
`String`	`getExtra()` An extra is a custom value users can set per API.
`ServerGroupObject`	`getGroup()`
`String`	`getId()`
`InetAddress`	`getIpAddress()`
`APIRequestFuture<LogFractionObject>`	`getLogFraction(long startTime)`
`APIRequestFuture<LogFractionObject>`	`getLogFraction(long startTime, long endTime)`
`String`	`getMap()` If a server's map is assigned randomly, the map name will be the part of the map directory's name after the '_'.
`int`	`getMaxPlayerCount()` The server's maximum player count
`MessageClientAddress`	`getMessageAddress()`
`String`	`getMotd()` The server's MOTD (= message of the day)
`String`	`getName()`
`int`	`getOnlinePlayerCount()` The server's current online player count
`Collection<PlayerObject>`	`getOnlinePlayers()`
`int`	`getPort()`
`InetSocketAddress`	`getSocketAddress()`
`String`	`getState()`
`boolean`	`isSortedOut()`
`void`	`sendPluginMessage(PluginMessage message)` Send a plugin message to the server
`APIRequestFuture<Void>`	`setExtra(String extra)` An extra is a custom value users can set per API.
`APIRequestFuture<Void>`	`setState(String state)` Sets the server's state and sends it to TimoCloud BungeeCord
`APIRequestFuture<Void>`	`stop()` Stops the server

- Method Detail
  - getName
```
String getName()
```
    Specified by:
    
    getName in interface IdentifiableObject
    
    Returns:
    
    The server's name
  - getId
```
String getId()
```
    Specified by:
    
    getId in interface IdentifiableObject
    
    Returns:
    
    The server's unique id
  - getGroup
```
ServerGroupObject getGroup()
```
    Returns:
    
    The group the server is part of
  - getState
```
String getState()
```
    Returns:
    
    The server's state
  - setState
```
APIRequestFuture<Void> setState(String state)
```
    Sets the server's state and sends it to TimoCloud BungeeCord
    
    Parameters:
    
    state - The state, e.g. 'INGAME' or 'FULL'
    
    Returns:
    
    A future being completed when the state was changed
  - getExtra
```
String getExtra()
```
    An extra is a custom value users can set per API. An example use case would be 'Teaming' or 'NoTeaming'
  - setExtra
```
APIRequestFuture<Void> setExtra(String extra)
```
    An extra is a custom value users can set per API. An example use case would be 'Teaming' or 'NoTeaming'
    
    Returns:
    
    A future being completed when the extra was changed
  - getMap
```
String getMap()
```
    If a server's map is assigned randomly, the map name will be the part of the map directory's name after the '_'. E.g. 'BedWars_VILLAGE' becomes 'VILLAGE'. If no random maps exists, the 'defaultMapName' property from config.yml will be used.
  - getMotd
```
String getMotd()
```
    The server's MOTD (= message of the day)
  - getOnlinePlayers
```
Collection<PlayerObject> getOnlinePlayers()
```
    Returns:
    
    A collection of all online players
  - getOnlinePlayerCount
```
int getOnlinePlayerCount()
```
    The server's current online player count
  - getMaxPlayerCount
```
int getMaxPlayerCount()
```
    The server's maximum player count
  - getBase
```
BaseObject getBase()
```
    Returns the base the server has been started by
  - getSocketAddress
```
InetSocketAddress getSocketAddress()
```
    Returns:
    
    The server's IP address and port players can connect to
  - getIpAddress
```
InetAddress getIpAddress()
```
    Returns:
    
    The server's IP address
  - getPort
```
int getPort()
```
    Returns:
    
    The server's port
  - isSortedOut
```
boolean isSortedOut()
```
    Returns:
    
    Returns if the server's current state is contained in its group's sortOutStates list
  - getMessageAddress
```
MessageClientAddress getMessageAddress()
```
    Returns:
    
    The address plugin protocol to this server shall be addressed to
  - executeCommand
```
APIRequestFuture<Void> executeCommand(String command)
```
    Executes the given command as ConsoleSender on the server
    
    Parameters:
    
    command - Without leading /
    
    Returns:
    
    A future being completed when the command was executed
  - stop
```
APIRequestFuture<Void> stop()
```
    Stops the server
    
    Returns:
    
    A future being completed when the server was stopped
  - sendPluginMessage
```
void sendPluginMessage(PluginMessage message)
```
    Send a plugin message to the server
    
    Parameters:
    
    message - The message which shall be sent
  - getLogFraction
```
APIRequestFuture<LogFractionObject> getLogFraction(long startTime,
                                                   long endTime)
```
    Parameters:
    
    startTime - The timestamp at which the record of the log should start (0 if you want all log entries since the server's start)
    
    endTime - The timestamp at which the record of the log should end
    
    Returns:
    
    A LogFractionObject containing all log entries within the given slot of time
  - getLogFraction
```
APIRequestFuture<LogFractionObject> getLogFraction(long startTime)
```
    Parameters:
    
    startTime - The timestamp at which the record of the log should start (0 if you want all log entries since the server's start)
    
    Returns:
    
    A LogFractionObject containing all log entries after the given start time

Interface ServerObject

Method Summary

Method Detail

getName

getId

getGroup

getState

setState

getExtra

setExtra

getMap

getMotd

getOnlinePlayers

getOnlinePlayerCount

getMaxPlayerCount

getBase

getSocketAddress

getIpAddress

getPort

isSortedOut

getMessageAddress

executeCommand

stop

sendPluginMessage

getLogFraction

getLogFraction