com.github.theholywaffle.teamspeak3.api.wrapper

Class ServerQueryInfo

java.lang.Object

com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

com.github.theholywaffle.teamspeak3.api.wrapper.ServerQueryInfo

public class ServerQueryInfo
extends Wrapper

A class containing information about a server query, returned by the API methods TS3Api.whoAmI() and TS3ApiAsync.whoAmI().

Constructor Summary

Constructors

Constructor and Description
ServerQueryInfo(Map<String,String> map) Creates a new ServerQueryInfo from the information present in the provided map.

Method Summary

Modifier and Type	Method and Description
int	getChannelId() Gets the ID of the channel the server query is currently in.
int	getDatabaseId() Gets the ID of the server query in the database.
int	getId() Gets the client ID of the server query.
String	getLoginName() Gets the username that was used when logging the query in (using a username-password combination).
String	getNickname() Gets the nickname currently used by the server query.
int	getOriginServerId() Gets the ID of the virtual server on which the server query login was created.
String	getUniqueIdentifier() Gets the unique identifier of the server query.
int	getVirtualServerId() Gets the ID of the currently selected virtual server.
int	getVirtualServerPort() Gets the port used by the currently selected virtual server.
VirtualServerStatus	getVirtualServerStatus() Gets the status of the currently selected virtual server.
String	getVirtualServerUniqueIdentifier() Gets the unique identifier of the currently selected virtual server.

Methods inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

get, get, getBoolean, getBoolean, getDouble, getDouble, getInt, getInt, getLong, getLong, getMap, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServerQueryInfo

public ServerQueryInfo(Map<String,String> map)

Creates a new ServerQueryInfo from the information present in the provided map.

Parameters:

map - the map containing the key-value pairs abstracted by this object

Method Detail

getChannelId

public int getChannelId()

Gets the ID of the channel the server query is currently in.

Returns:

the ID of the current channel

getDatabaseId

public int getDatabaseId()

Gets the ID of the server query in the database.

In case this server query account was created by a client, its database ID will be identical to the client's database ID.

Returns:

the server query's database ID

getId

public int getId()

Gets the client ID of the server query.

Returns:

the server query's client ID

getLoginName

public String getLoginName()

Gets the username that was used when logging the query in (using a username-password combination).

This username was set when creating the server query login and doesn't have to be related to the client who created the server query login.
In case a server query is not logged in yet, this method will return an empty string.

Returns:

the username used when logging this query in

See Also:

TS3Api#login(username, password) - logging in server queries

getNickname

public String getNickname()

Gets the nickname currently used by the server query. Unless explicitly set, the nickname will be formatted like

username from ip:port

Nicknames are only assigned after a virtual server has been selected. Until then, this method will return an empty string.

Returns:

the current nickname of the server query

getOriginServerId

public int getOriginServerId()

Gets the ID of the virtual server on which the server query login was created.

This method will return 0 (the ID of the template server) if a server query is not logged in or using the serveradmin login.

Returns:

the ID of the virtual server this server query belongs to

getUniqueIdentifier

public String getUniqueIdentifier()

Gets the unique identifier of the server query.

In case this server query account was created by a client, its unique ID will be identical to the client's unique ID.

Returns:

the server query's unique ID

getVirtualServerId

public int getVirtualServerId()

Gets the ID of the currently selected virtual server.

If used on a non-commercial TeamSpeak instance which can only host 1 virtual server, this ID will always be 1.
If no virtual server has been selected yet, this method will return 0.

Returns:

the ID of the current virtual server or 0 if none is selected

getVirtualServerPort

public int getVirtualServerPort()

Gets the port used by the currently selected virtual server.

If no virtual server has been selected yet, this method will return 0.

Returns:

the port used by the current virtual server or 0 if none is selected

getVirtualServerStatus

public VirtualServerStatus getVirtualServerStatus()

Gets the status of the currently selected virtual server.

If no virtual server has been selected yet, this method will return VirtualServerStatus.UNKNOWN.

Returns:

the status of the current virtual server

getVirtualServerUniqueIdentifier

public String getVirtualServerUniqueIdentifier()

Gets the unique identifier of the currently selected virtual server.

If no virtual server has been selected yet, this method will return an empty string.

Returns:

the unique ID of the current virtual server