Skip to main content
Version: 2025.1

ServerData

Encapsulates a ServerData object and provides functionalities.

Methods​

getBuild​

getBuild(): string

Returns the build identifier of this server, or an empty String.

Returns​

string

the build identifier of this server, or an empty String.

getDataDir​

getDataDir(): string

Returns the path of the data dir, or an empty String.

Returns​

string

the path of the data dir, or an empty String.

getDrainMessage​

getDrainMessage(): string

Returns the message which is shown on the client login screen if drain mode is activated, or an empty String.

Returns​

string

the message which is shown on the client login screen if drain mode is activated, or an empty String

getEdition​

getEdition(): string

Returns the kind of editition (COMMUNITY, SIGNEDLICENSE etc...). or an empty String.

Returns​

string

never null.

getHomeDir​

getHomeDir(): string

Returns the home directory where the server resides in.

Returns​

string

never null.

getLicenseId​

getLicenseId(): string

Returns the servers license id.

Returns​

string

never null.

getLogDir​

getLogDir(): string

Returns the directory where the log files are located.

Returns​

string

never null.

getServerId​

getServerId(): string

Returns the unique ID of this server, or an empty String.

Returns​

string

the unique ID of this server, or an empty String

getServerName​

getServerName(): string

Returns the name of the server.

Returns​

string

never null.

getStartupTime​

getStartupTime(): number

Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT.

Returns​

number

never null.

getStatus​

getStatus(): string

Returns the Status of the Server.

Returns​

string

never null

getVersion​

getVersion(): string

Returns the version of the server.

Returns​

string

never null.

isDrainModeActive​

isDrainModeActive(): boolean

Returns true, if the drain mode is active.

Returns​

boolean

true or false.