TS3Api (TeamSpeak 3 Java API 1.0.12 API)

java.lang.Object
- com.github.theholywaffle.teamspeak3.TS3Api

```
public class TS3Api
extends Object
```
API to interact with the TS3Query synchronously.
This class is used to easily interact with a TS3Query. It constructs commands, sends them to the TeamSpeak3 server, processes the response and returns the result.
All methods in this class are synchronous, so they will block until the response arrives. Calls to this API will usually take about 50 milliseconds to complete (plus ping), but delays can range up to 4 seconds. If a command takes longer than 4 seconds to complete, a TS3ConnectionFailedException will be thrown.
You won't be able to execute most commands while you're not logged in due to missing permissions. Make sure to either pass your login credentials to the TS3Config object when creating the TS3Query or to call login(String, String) to log in.
After that, most commands also require you to select a virtual server. To do so, call either selectVirtualServerByPort(int) or selectVirtualServerById(int).
Be aware that many methods in this class will return null or -1 if a command fails.

See Also:

The asynchronous version of the API

Constructor Summary

Constructors
Constructor and Description

TS3Api(TS3Query query)
Creates a new synchronous API object for the given TS3Query.

Constructors
Constructor and Description
`TS3Api(TS3Query query)` Creates a new synchronous API object for the given `TS3Query`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`addBan(String ip, String name, String uid, long timeInSeconds, String reason)` Adds a new ban entry.
`boolean`	`addChannelClientPermission(int channelId, int clientDBId, String permName, int permValue)` Adds a specified permission to a client in a specific channel.
`int`	`addChannelGroup(String name)` Creates a new channel group for clients using a given name and returns its ID.
`int`	`addChannelGroup(String name, PermissionGroupDatabaseType type)` Creates a new channel group using a given name and returns its ID.
`boolean`	`addChannelGroupPermission(int groupId, String permName, int permValue)` Adds a specified permission to a channel group.
`boolean`	`addChannelPermission(int channelId, String permName, int permValue)` Adds a specified permission to a channel.
`boolean`	`addClientPermission(int clientDBId, String permName, int value, boolean skipped)` Adds a specified permission to a channel.
`boolean`	`addClientToServerGroup(int groupId, int clientDatabaseId)` Adds a client to the specified server group.
`boolean`	`addComplaint(int clientDBId, String message)` Submits a complaint about the specified client.
`boolean`	`addPermissionToAllServerGroups(ServerGroupType type, String permName, int value, boolean negated, boolean skipped)` Adds a specified permission to all server groups of the type specified by `type` on all virtual servers.
`String`	`addPrivilegeKey(TokenType type, int groupId, int channelId, String description)` Create a new privilege key that allows one client to join a server or channel group.
`String`	`addPrivilegeKeyChannelGroup(int channelGroupId, int channelId, String description)` Creates a new privilege key for a channel group.
`String`	`addPrivilegeKeyServerGroup(int serverGroupId, String description)` Creates a new privilege key for a server group.
`int`	`addServerGroup(String name)` Creates a new server group for clients using a given name and returns its ID.
`int`	`addServerGroup(String name, PermissionGroupDatabaseType type)` Creates a new server group using a given name and returns its ID.
`boolean`	`addServerGroupPermission(int groupId, String permName, int value, boolean negated, boolean skipped)` Adds a specified permission to a server group.
`void`	`addTS3Listeners(TS3Listener... listeners)` Adds one or more `TS3Listener`s to the event manager of the query.
`int[]`	`banClient(int clientId, long timeInSeconds)` Bans a client with a given client ID for a given time.
`int[]`	`banClient(int clientId, long timeInSeconds, String reason)` Bans a client with a given client ID for a given time for the specified reason.
`int[]`	`banClient(int clientId, String reason)` Bans a client with a given client ID permanently for the specified reason.
`boolean`	`broadcast(String message)` Sends a text message to all clients on all virtual servers.
`boolean`	`copyChannelGroup(int sourceGroupId, int targetGroupId, PermissionGroupDatabaseType type)` Creates a copy of the channel group specified by `sourceGroupId`, overwriting any other channel group specified by `targetGroupId`.
`int`	`copyChannelGroup(int sourceGroupId, String targetName, PermissionGroupDatabaseType type)` Creates a copy of the channel group specified by `sourceGroupId` with a given name and returns the ID of the newly created channel group.
`boolean`	`copyServerGroup(int sourceGroupId, int targetGroupId, PermissionGroupDatabaseType type)` Creates a copy of the server group specified by `sourceGroupId`, overwriting another server group specified by `targetGroupId`.
`int`	`copyServerGroup(int sourceGroupId, String targetName, PermissionGroupDatabaseType type)` Creates a copy of the server group specified by `sourceGroupId` with a given name and returns the ID of the newly created server group.
`int`	`createChannel(String name, Map<ChannelProperty,String> options)` Creates a new channel with a given name using the given properties and returns its ID.
`CreatedVirtualServer`	`createServer(String name, Map<VirtualServerProperty,String> options)` Creates a new virtual server with the given name and returns an object containing the ID of the newly created virtual server, the default server admin token and the virtual server's voice port.
`Snapshot`	`createServerSnapshot()` Creates a `Snapshot` of the selected virtual server containing all settings, groups and known client identities.
`boolean`	`deleteAllBans()` Deletes all active ban rules from the server.
`boolean`	`deleteAllComplaints(int clientDBId)` Deletes all complaints about the client with specified database ID from the server.
`boolean`	`deleteBan(int banId)` Deletes the ban rule with the specified ID from the server.
`boolean`	`deleteChannel(int channelId)` Deletes an existing channel specified by its ID, kicking all clients out of the channel.
`boolean`	`deleteChannel(int channelId, boolean force)` Deletes an existing channel with a given ID.
`boolean`	`deleteChannelClientPermission(int channelId, int clientDBId, String permName)` Removes a specified permission from a client in a specific channel.
`boolean`	`deleteChannelGroup(int groupId)` Removes the channel group with the given ID.
`boolean`	`deleteChannelGroup(int groupId, boolean force)` Removes the channel group with the given ID.
`boolean`	`deleteChannelGroupPermission(int groupId, String permName)` Removes a permission from the channel group with the given ID.
`boolean`	`deleteChannelPermission(int channelId, String permName)` Removes a permission from the channel with the given ID.
`boolean`	`deleteClientPermission(int clientDBId, String permName)` Removes a permission from a client.
`boolean`	`deleteComplaint(int targetClientDBId, int fromClientDBId)` Deletes the complaint about the client with database ID `targetClientDBId` submitted by the client with database ID `fromClientDBId` from the server.
`boolean`	`deleteDatabaseClientProperties(int clientDBId)` Removes all stored database information about the specified client.
`boolean`	`deleteOfflineMessage(int messageId)` Deletes the offline message with the specified ID.
`boolean`	`deletePermissionFromAllServerGroups(ServerGroupType type, String permName)` Removes a specified permission from all server groups of the type specified by `type` on all virtual servers.
`boolean`	`deletePrivilegeKey(String token)` Deletes the privilege key with the given token.
`boolean`	`deleteServer(int serverId)` Deletes the virtual server with the specified ID.
`boolean`	`deleteServerGroup(int groupId)` Deletes the server group with the specified ID, even if the server group still contains clients.
`boolean`	`deleteServerGroup(int groupId, boolean force)` Deletes a server group with the specified ID.
`boolean`	`deleteServerGroupPermission(int groupId, String permName)` Removes a permission from the server group with the given ID.
`boolean`	`deployServerSnapshot(Snapshot snapshot)` Restores the selected virtual servers configuration using the data from a previously created server snapshot.
`boolean`	`deployServerSnapshot(String snapshot)` Restores the configuration of the selected virtual server using the data from a previously created server snapshot.
`boolean`	`editChannel(int channelId, Map<ChannelProperty,String> options)` Changes a channel's configuration using the given properties.
`boolean`	`editClient(int clientId, Map<ClientProperty,String> options)` Changes a client's configuration using given properties.
`boolean`	`editDatabaseClient(int clientDBId, Map<ClientProperty,String> options)` Changes a client's database settings using given properties.
`boolean`	`editInstance(ServerInstanceProperty property, String value)` Changes the server instance configuration using given properties.
`boolean`	`editServer(Map<VirtualServerProperty,String> options)` Changes the configuration of the selected virtual server using given properties.
`List<Ban>`	`getBans()` Gets a list of all bans on the selected virtual server.
`List<Binding>`	`getBindings()` Gets a list of IP addresses used by the server instance.
`Channel`	`getChannelByNameExact(String name, boolean ignoreCase)` Finds and returns the channel matching the given name exactly.
`List<Permission>`	`getChannelClientPermissions(int channelId, int clientDBId)` Displays a list of permissions defined for a client in a specific channel.
`List<ChannelGroupClient>`	`getChannelGroupClients(int channelId, int clientDBId, int groupId)` Gets all client / channel ID combinations currently assigned to channel groups.
`List<ChannelGroupClient>`	`getChannelGroupClientsByChannelGroupId(int groupId)` Gets all client / channel ID combinations currently assigned to the specified channel group.
`List<ChannelGroupClient>`	`getChannelGroupClientsByChannelId(int channelId)` Gets all channel group assignments in the specified channel.
`List<ChannelGroupClient>`	`getChannelGroupClientsByClientDBId(int clientDBId)` Gets all channel group assignments for the specified client.
`List<Permission>`	`getChannelGroupPermissions(int groupId)` Gets a list of all permissions assigned to the specified channel group.
`List<ChannelGroup>`	`getChannelGroups()` Gets a list of all channel groups on the selected virtual server.
`ChannelInfo`	`getChannelInfo(int channelId)` Gets detailed configuration information about the channel specified channel.
`List<Permission>`	`getChannelPermissions(int channelId)` Gets a list of all permissions assigned to the specified channel.
`List<Channel>`	`getChannels()` Gets a list of all channels on the selected virtual server.
`List<Channel>`	`getChannelsByName(String name)` Gets a list of channels whose names contain the given search string.
`Client`	`getClientByNameExact(String name, boolean ignoreCase)` Finds and returns the client whose nickname matches the given name exactly.
`ClientInfo`	`getClientByUId(String clientUId)` Gets information about the client with the specified unique identifier.
`ClientInfo`	`getClientInfo(int clientId)` Gets information about the client with the specified client ID.
`List<Permission>`	`getClientPermissions(int clientDBId)` Gets a list of all permissions assigned to the specified client.
`List<Client>`	`getClients()` Gets a list of all clients on the selected virtual server.
`List<Client>`	`getClientsByName(String name)` Gets a list of clients whose nicknames contain the given search string.
`List<Complaint>`	`getComplaints()` Gets a list of all complaints on the selected virtual server.
`List<Complaint>`	`getComplaints(int clientDBId)` Gets a list of all complaints about the specified client.
`ConnectionInfo`	`getConnectionInfo()` Gets detailed connection information about the selected virtual server.
`DatabaseClientInfo`	`getDatabaseClientByUId(String clientUId)` Gets information about the client with the specified unique identifier in the server database.
`DatabaseClientInfo`	`getDatabaseClientInfo(int clientDBId)` Gets information about the client with the specified database ID in the server database.
`List<DatabaseClient>`	`getDatabaseClients()` Gets information about all clients in the server database.
`List<DatabaseClientInfo>`	`getDatabaseClientsByName(String name)` Gets all clients in the database whose last nickname matches the specified name exactly.
`HostInfo`	`getHostInfo()` Displays detailed configuration information about the server instance including uptime, number of virtual servers online, traffic information, etc.
`InstanceInfo`	`getInstanceInfo()` Displays the server instance configuration including database revision number, the file transfer port, default group IDs, etc.
`String`	`getOfflineMessage(int messageId)` Reads the message body of a message.
`String`	`getOfflineMessage(Message message)` Reads the message body of a message.
`List<Message>`	`getOfflineMessages()` Gets a list of all offline messages for the server query.
`List<AdvancedPermission>`	`getPermissionAssignments(String permName)` Displays detailed information about all assignments of the permission specified with `permName`.
`int`	`getPermissionIdByName(String permName)` Gets the ID of the permission specified by `permName`.
`List<AdvancedPermission>`	`getPermissionOverview(int channelId, int clientDBId)` Gets a list of all assigned permissions for a client in a specified channel.
`List<PermissionInfo>`	`getPermissions()` Displays a list of all permissions, including ID, name and description.
`int`	`getPermissionValue(String permName)` Displays the current value of the specified permission for this server query instance.
`List<PrivilegeKey>`	`getPrivilegeKeys()` Gets a list of all available tokens to join channel or server groups, including their type and group IDs.
`List<ServerGroupClient>`	`getServerGroupClients(int serverGroupId)` Gets a list of all clients in the specified server group.
`List<ServerGroupClient>`	`getServerGroupClients(ServerGroup serverGroup)` Gets a list of all clients in the specified server group.
`List<Permission>`	`getServerGroupPermissions(int serverGroupId)` Gets a list of all permissions assigned to the specified server group.
`List<Permission>`	`getServerGroupPermissions(ServerGroup serverGroup)` Gets a list of all permissions assigned to the specified server group.
`List<ServerGroup>`	`getServerGroups()` Gets a list of all server groups on the virtual server.
`List<ServerGroup>`	`getServerGroupsByClient(Client client)` Gets a list of all server groups set for a client.
`List<ServerGroup>`	`getServerGroupsByClientId(int clientDatabaseId)` Gets a list of all server groups set for a client.
`int`	`getServerIdByPort(int port)` Gets the ID of a virtual server by its port.
`VirtualServerInfo`	`getServerInfo()` Gets detailed information about the virtual server the server query is currently in.
`Version`	`getVersion()` Gets the version, build number and platform of the TeamSpeak3 server.
`List<VirtualServer>`	`getVirtualServers()` Gets a list of all virtual servers including their ID, status, number of clients online, etc.
`boolean`	`kickClientFromChannel(Client... clients)` Kicks one or more clients from their current channels.
`boolean`	`kickClientFromChannel(int... clientIds)` Kicks one or more clients from their current channels.
`boolean`	`kickClientFromChannel(String message, Client... clients)` Kicks one or more clients from their current channels for the specified reason.
`boolean`	`kickClientFromChannel(String message, int... clientIds)` Kicks one or more clients from their current channels for the specified reason.
`boolean`	`kickClientFromServer(Client... clients)` Kicks one or more clients from the server.
`boolean`	`kickClientFromServer(int... clientIds)` Kicks one or more clients from the server.
`boolean`	`kickClientFromServer(String message, Client... clients)` Kicks one or more clients from the server for the specified reason.
`boolean`	`kickClientFromServer(String message, int... clientIds)` Kicks one or more clients from the server for the specified reason.
`boolean`	`login(String username, String password)` Logs the server query in using the specified username and password.
`boolean`	`logout()` Logs the server query out and deselects the current virtual server.
`boolean`	`moveChannel(int channelId, int channelTargetId)` Moves a channel to a new parent channel specified by its ID.
`boolean`	`moveChannel(int channelId, int channelTargetId, int order)` Moves a channel to a new parent channel specified by its ID.
`boolean`	`moveClient(ChannelBase channel)` Moves the server query into the specified channel.
`boolean`	`moveClient(ChannelBase channel, String channelPassword)` Moves the server query into the specified channel using the specified password.
`boolean`	`moveClient(Client client, ChannelBase channel)` Moves a client into the specified channel.
`boolean`	`moveClient(Client client, ChannelBase channel, String channelPassword)` Moves a client into the specified channel using the specified password.
`boolean`	`moveClient(int channelId)` Moves the server query into the specified channel.
`boolean`	`moveClient(int clientId, int channelId)` Moves a client into the specified channel.
`boolean`	`moveClient(int clientId, int channelId, String channelPassword)` Moves a client into the specified channel using the specified password.
`boolean`	`moveClient(int channelId, String channelPassword)` Moves the server query into the specified channel using the specified password.
`boolean`	`pokeClient(int clientId, String message)` Pokes the client with the specified client ID.
`boolean`	`quit()` Deprecated. This command leaves the query in an undefined state, where the connection is closed without the socket being closed and no more command can be executed. To terminate a connection, use `TS3Query.exit()`.
`boolean`	`registerAllEvents()` Registers the server query to receive notifications about all server events.
`boolean`	`registerEvent(TS3EventType eventType)` Registers the server query to receive notifications about a given event type.
`boolean`	`registerEvent(TS3EventType eventType, int channelId)` Registers the server query to receive notifications about a given event type.
`boolean`	`registerEvents(TS3EventType... eventTypes)` Registers the server query to receive notifications about multiple given event types.
`boolean`	`removeClientFromServerGroup(int serverGroupId, int clientDatabaseId)` Removes the client specified by its database ID from the specified server group.
`boolean`	`removeClientFromServerGroup(ServerGroup serverGroup, Client client)` Removes the specified client from the specified server group.
`void`	`removeTS3Listeners(TS3Listener... listeners)` Removes one or more `TS3Listener`s to the event manager of the query.
`boolean`	`renameChannelGroup(ChannelGroup channelGroup, String name)` Renames the specified channel group.
`boolean`	`renameChannelGroup(int channelGroupId, String name)` Renames the channel group with the specified ID.
`boolean`	`renameServerGroup(int serverGroupId, String name)` Renames the server group with the specified ID.
`boolean`	`renameServerGroup(ServerGroup serverGroup, String name)` Renames the specified server group.
`String`	`resetPermissions()` Resets all permissions and deletes all server / channel groups.
`boolean`	`selectVirtualServer(VirtualServer server)` Moves the server query into the specified virtual server.
`boolean`	`selectVirtualServerById(int id)` Moves the server query into the virtual server with the specified ID.
`boolean`	`selectVirtualServerByPort(int port)` Moves the server query into the virtual server with the specified voice port.
`boolean`	`sendChannelMessage(int channelId, String message)` Sends a text message to the channel with the specified ID.
`boolean`	`sendChannelMessage(String message)` Sends a text message to the channel the server query is currently in.
`boolean`	`sendOfflineMessage(String clientUId, String subject, String message)` Sends an offline message to the client with the given unique identifier.
`boolean`	`sendPrivateMessage(int clientId, String message)` Sends a private message to the client with the specified client ID.
`boolean`	`sendServerMessage(int serverId, String message)` Sends a text message to the virtual server with the specified ID.
`boolean`	`sendServerMessage(String message)` Sends a text message to the virtual server the server query is currently in.
`boolean`	`sendTextMessage(TextMessageTargetMode targetMode, int targetId, String message)` Sends a text message either to the whole virtual server, a channel or specific client.
`boolean`	`setClientChannelGroup(int groupId, int channelId, int clientDBId)` Sets a channel group for a client in a specific channel.
`boolean`	`setMessageRead(int messageId)` Sets the read flag to true for a given message.
`boolean`	`setMessageRead(Message message)` Sets the read flag to true for a given message.
`boolean`	`setMessageReadFlag(int messageId, boolean read)` Sets the read flag for a given message.
`boolean`	`setMessageReadFlag(Message message, boolean read)` Sets the read flag for a given message.
`boolean`	`setNickname(String nickname)` Sets the nickname of the server query client.
`boolean`	`startServer(int serverId)` Starts the virtual server with the specified ID.
`boolean`	`startServer(VirtualServer virtualServer)` Starts the specified virtual server.
`boolean`	`stopServer(int serverId)` Stops the virtual server with the specified ID.
`boolean`	`stopServer(VirtualServer virtualServer)` Stops the specified virtual server.
`boolean`	`stopServerProcess()` Stops the entire TeamSpeak 3 Server instance by shutting down the process.
`boolean`	`unregisterAllEvents()` Unregisters the server query from receiving any event notifications.
`boolean`	`updateClient(Map<ClientProperty,String> options)` Updates several client properties for this server query instance.
`String`	`updateServerQueryLogin(String loginName)` Generates new login credentials for the currently connected server query instance, using the given name.
`boolean`	`usePrivilegeKey(PrivilegeKey privilegeKey)` Uses an existing privilege key to join a server or channel group.
`boolean`	`usePrivilegeKey(String token)` Uses an existing privilege key to join a server or channel group.
`ServerQueryInfo`	`whoAmI()` Gets information about the current server query instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TS3Api
```
public TS3Api(TS3Query query)
```
    Creates a new synchronous API object for the given TS3Query.
    Usually, this constructor should not be called. Use TS3Query.getApi() instead.
    
    Parameters:
    
    query - the TS3Query to call
- Method Detail
  - addBan
```
public int addBan(String ip,
                  String name,
                  String uid,
                  long timeInSeconds,
                  String reason)
```
    Adds a new ban entry. At least one of the parameters ip, name or uid needs to be not null. Returns the ID of the newly created ban.
    
    Parameters:
    
    ip - a RegEx pattern to match a client's IP against, can be null
    
    name - a RegEx pattern to match a client's name against, can be null
    
    uid - the unique identifier of a client, can be null
    
    timeInSeconds - the duration of the ban in seconds. 0 equals a permanent ban
    
    reason - the reason for the ban, can be null
    
    Returns:
    
    the ID of the newly created ban entry
    
    See Also:
    
    RegEx Pattern, Client.getId(), Client.getUniqueIdentifier(), ClientInfo.getIp()
    
    Number of query commands sent:
    
    1
  - addChannelClientPermission
```
public boolean addChannelClientPermission(int channelId,
                                          int clientDBId,
                                          String permName,
                                          int permValue)
```
    Adds a specified permission to a client in a specific channel.
    
    Parameters:
    
    channelId - the ID of the channel wherein the permission should be granted
    
    clientDBId - the database ID of the client to add a permission to
    
    permName - the name of the permission to grant
    
    permValue - the numeric value of the permission (or for boolean permissions: 1 = true, 0 = false)
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), Client.getDatabaseId(), Permission
    
    Number of query commands sent:
    
    1
  - addChannelGroup
```
public int addChannelGroup(String name)
```
    Creates a new channel group for clients using a given name and returns its ID.
    To create channel group templates or ones for server queries, use addChannelGroup(String, PermissionGroupDatabaseType).
    
    Parameters:
    
    name - the name of the new channel group
    
    Returns:
    
    the ID of the newly created channel group
    
    See Also:
    
    ChannelGroup
    
    Number of query commands sent:
    
    1
  - addChannelGroup
```
public int addChannelGroup(String name,
                           PermissionGroupDatabaseType type)
```
    Creates a new channel group using a given name and returns its ID.
    
    Parameters:
    
    name - the name of the new channel group
    
    type - the desired type of channel group
    
    Returns:
    
    the ID of the newly created channel group
    
    See Also:
    
    ChannelGroup
    
    Number of query commands sent:
    
    1
  - addChannelGroupPermission
```
public boolean addChannelGroupPermission(int groupId,
                                         String permName,
                                         int permValue)
```
    Adds a specified permission to a channel group.
    
    Parameters:
    
    groupId - the ID of the channel group to grant the permission
    
    permName - the name of the permission to be granted
    
    permValue - the numeric value of the permission (or for boolean permissions: 1 = true, 0 = false)
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ChannelGroup.getId(), Permission
    
    Number of query commands sent:
    
    1
  - addChannelPermission
```
public boolean addChannelPermission(int channelId,
                                    String permName,
                                    int permValue)
```
    Adds a specified permission to a channel.
    
    Parameters:
    
    channelId - the ID of the channel wherein the permission should be granted
    
    permName - the name of the permission to grant
    
    permValue - the numeric value of the permission (or for boolean permissions: 1 = true, 0 = false)
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), Permission
    
    Number of query commands sent:
    
    1
  - addClientPermission
```
public boolean addClientPermission(int clientDBId,
                                   String permName,
                                   int value,
                                   boolean skipped)
```
    Adds a specified permission to a channel.
    
    Parameters:
    
    clientDBId - the database ID of the client to grant the permission
    
    permName - the name of the permission to grant
    
    value - the numeric value of the permission (or for boolean permissions: 1 = true, 0 = false)
    
    skipped - if set to true, the permission will not be overridden by channel permissions
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getDatabaseId(), Permission
    
    Number of query commands sent:
    
    1
  - addClientToServerGroup
```
public boolean addClientToServerGroup(int groupId,
                                      int clientDatabaseId)
```
    Adds a client to the specified server group.
    Please note that a client cannot be added to default groups or template groups.
    
    Parameters:
    
    groupId - the ID of the server group to add the client to
    
    clientDatabaseId - the database ID of the client to add
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroup.getId(), Client.getDatabaseId()
    
    Number of query commands sent:
    
    1
  - addComplaint
```
public boolean addComplaint(int clientDBId,
                            String message)
```
    Submits a complaint about the specified client. The length of the message is limited to 200 UTF-8 bytes and BB codes in it will be ignored.
    
    Parameters:
    
    clientDBId - the database ID of the client
    
    message - the message of the complaint, may not contain BB codes
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getDatabaseId(), Complaint.getMessage()
    
    Number of query commands sent:
    
    1
  - addPermissionToAllServerGroups
```
public boolean addPermissionToAllServerGroups(ServerGroupType type,
                                              String permName,
                                              int value,
                                              boolean negated,
                                              boolean skipped)
```
    Adds a specified permission to all server groups of the type specified by type on all virtual servers.
    
    Parameters:
    
    type - the kind of server group this permission should be added to
    
    permName - the name of the permission to be granted
    
    value - the numeric value of the permission (or for boolean permissions: 1 = true, 0 = false)
    
    negated - if set to true, the lowest permission value will be selected instead of the highest
    
    skipped - if set to true, this permission will not be overridden by client of channel permissions
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroupType, Permission
    
    Number of query commands sent:
    
    1
  - addPrivilegeKey
```
public String addPrivilegeKey(TokenType type,
                              int groupId,
                              int channelId,
                              String description)
```
    Create a new privilege key that allows one client to join a server or channel group.
    - If type is set to SERVER_GROUP, groupId is used as a server group ID and channelId is ignored.
    - If type is set to CHANNEL_GROUP, groupId is used as a channel group ID and channelId is used as the channel in which the group should be set.
    Parameters:
    
    type - the type of token that should be created
    
    groupId - the ID of the server or channel group
    
    channelId - the ID of the channel, in case the token is channel group token
    
    description - the description for the token, can be null
    
    Returns:
    
    the created token for a client to use
    
    See Also:
    
    TokenType, addPrivilegeKeyServerGroup(int, String), addPrivilegeKeyChannelGroup(int, int, String)
    
    Number of query commands sent:
    
    1
  - addPrivilegeKeyChannelGroup
```
public String addPrivilegeKeyChannelGroup(int channelGroupId,
                                          int channelId,
                                          String description)
```
    Creates a new privilege key for a channel group.
    
    Parameters:
    
    channelGroupId - the ID of the channel group
    
    channelId - the ID of the channel in which the channel group should be set
    
    description - the description for the token, can be null
    
    Returns:
    
    the created token for a client to use
    
    See Also:
    
    ChannelGroup.getId(), Channel.getId(), addPrivilegeKey(TokenType, int, int, String), addPrivilegeKeyServerGroup(int, String)
    
    Number of query commands sent:
    
    1
  - addPrivilegeKeyServerGroup
```
public String addPrivilegeKeyServerGroup(int serverGroupId,
                                         String description)
```
    Creates a new privilege key for a server group.
    
    Parameters:
    
    serverGroupId - the ID of the server group
    
    description - the description for the token, can be null
    
    Returns:
    
    the created token for a client to use
    
    See Also:
    
    ServerGroup.getId(), addPrivilegeKey(TokenType, int, int, String), addPrivilegeKeyChannelGroup(int, int, String)
    
    Number of query commands sent:
    
    1
  - addServerGroup
```
public int addServerGroup(String name)
```
    Creates a new server group for clients using a given name and returns its ID.
    To create server group templates or ones for server queries, use addServerGroup(String, PermissionGroupDatabaseType).
    
    Parameters:
    
    name - the name of the new server group
    
    Returns:
    
    the ID of the newly created server group
    
    See Also:
    
    ServerGroup
    
    Number of query commands sent:
    
    1
  - addServerGroup
```
public int addServerGroup(String name,
                          PermissionGroupDatabaseType type)
```
    Creates a new server group using a given name and returns its ID.
    
    Parameters:
    
    name - the name of the new server group
    
    type - the desired type of server group
    
    Returns:
    
    the ID of the newly created server group
    
    See Also:
    
    ServerGroup, PermissionGroupDatabaseType
    
    Number of query commands sent:
    
    1
  - addServerGroupPermission
```
public boolean addServerGroupPermission(int groupId,
                                        String permName,
                                        int value,
                                        boolean negated,
                                        boolean skipped)
```
    Adds a specified permission to a server group.
    
    Parameters:
    
    groupId - the ID of the channel group to which the permission should be added
    
    permName - the name of the permission to add
    
    value - the numeric value of the permission (or for boolean permissions: 1 = true, 0 = false)
    
    negated - if set to true, the lowest permission value will be selected instead of the highest
    
    skipped - if set to true, this permission will not be overridden by client of channel permissions
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroup.getId(), Permission
    
    Number of query commands sent:
    
    1
  - addTS3Listeners
```
public void addTS3Listeners(TS3Listener... listeners)
```
    Adds one or more TS3Listeners to the event manager of the query. These listeners will be notified when the TS3 server fires an event.
    Note that for the TS3 server to fire events, you must first also register the event types you want to listen to.
    
    Parameters:
    
    listeners - one or more listeners to register
    
    See Also:
    
    registerAllEvents(), registerEvent(TS3EventType, int), TS3Listener, TS3EventType
  - banClient
```
public int[] banClient(int clientId,
                       long timeInSeconds)
```
    Bans a client with a given client ID for a given time.
    Please note that this will create two separate ban rules, one for the targeted client's IP address and their unique identifier.
    
    Parameters:
    
    clientId - the ID of the client
    
    timeInSeconds - the duration of the ban in seconds. 0 equals a permanent ban
    
    Returns:
    
    an array containing the IDs of the first and the second ban entry
    
    See Also:
    
    Client.getId(), addBan(String, String, String, long, String)
    
    Number of query commands sent:
    
    1
  - banClient
```
public int[] banClient(int clientId,
                       long timeInSeconds,
                       String reason)
```
    Bans a client with a given client ID for a given time for the specified reason.
    Please note that this will create two separate ban rules, one for the targeted client's IP address and their unique identifier.
    
    Parameters:
    
    clientId - the ID of the client
    
    timeInSeconds - the duration of the ban in seconds. 0 equals a permanent ban
    
    reason - the reason for the ban, can be null
    
    Returns:
    
    an array containing the IDs of the first and the second ban entry
    
    See Also:
    
    Client.getId(), addBan(String, String, String, long, String)
    
    Number of query commands sent:
    
    1
  - banClient
```
public int[] banClient(int clientId,
                       String reason)
```
    Bans a client with a given client ID permanently for the specified reason.
    Please note that this will create two separate ban rules, one for the targeted client's IP address and their unique identifier.
    
    Parameters:
    
    clientId - the ID of the client
    
    reason - the reason for the ban, can be null
    
    Returns:
    
    an array containing the IDs of the first and the second ban entry
    
    See Also:
    
    Client.getId(), addBan(String, String, String, long, String)
    
    Number of query commands sent:
    
    1
  - broadcast
```
public boolean broadcast(String message)
```
    Sends a text message to all clients on all virtual servers. These messages will appear to clients in the tab for server messages.
    
    Parameters:
    
    message - the message to be sent
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - copyChannelGroup
```
public boolean copyChannelGroup(int sourceGroupId,
                                int targetGroupId,
                                PermissionGroupDatabaseType type)
```
    Creates a copy of the channel group specified by sourceGroupId, overwriting any other channel group specified by targetGroupId.
    The parameter type can be used to create server query and template groups.
    
    Parameters:
    
    sourceGroupId - the ID of the channel group to copy
    
    targetGroupId - the ID of another channel group to overwrite
    
    type - the desired type of channel group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ChannelGroup.getId()
    
    Number of query commands sent:
    
    1
  - copyChannelGroup
```
public int copyChannelGroup(int sourceGroupId,
                            String targetName,
                            PermissionGroupDatabaseType type)
```
    Creates a copy of the channel group specified by sourceGroupId with a given name and returns the ID of the newly created channel group.
    
    Parameters:
    
    sourceGroupId - the ID of the channel group to copy
    
    targetName - the name for the copy of the channel group
    
    type - the desired type of channel group
    
    Returns:
    
    the ID of the newly created channel group
    
    See Also:
    
    ChannelGroup.getId()
    
    Number of query commands sent:
    
    1
  - copyServerGroup
```
public boolean copyServerGroup(int sourceGroupId,
                               int targetGroupId,
                               PermissionGroupDatabaseType type)
```
    Creates a copy of the server group specified by sourceGroupId, overwriting another server group specified by targetGroupId.
    The parameter type can be used to create server query and template groups.
    
    Parameters:
    
    sourceGroupId - the ID of the server group to copy
    
    targetGroupId - the ID of another server group to overwrite
    
    type - the desired type of server group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroup.getId()
    
    Number of query commands sent:
    
    1
  - copyServerGroup
```
public int copyServerGroup(int sourceGroupId,
                           String targetName,
                           PermissionGroupDatabaseType type)
```
    Creates a copy of the server group specified by sourceGroupId with a given name and returns the ID of the newly created server group.
    
    Parameters:
    
    sourceGroupId - the ID of the server group to copy
    
    targetName - the name for the copy of the server group
    
    type - the desired type of server group
    
    Returns:
    
    the ID of the newly created server group
    
    See Also:
    
    ServerGroup.getId()
    
    Number of query commands sent:
    
    1
  - createChannel
```
public int createChannel(String name,
                         Map<ChannelProperty,String> options)
```
    Creates a new channel with a given name using the given properties and returns its ID.
    
    Parameters:
    
    name - the name for the new channel
    
    options - a map of options that should be set for the channel
    
    Returns:
    
    the ID of the newly created channel
    
    See Also:
    
    Channel
    
    Number of query commands sent:
    
    1
  - createServer
```
public CreatedVirtualServer createServer(String name,
                                         Map<VirtualServerProperty,String> options)
```
    Creates a new virtual server with the given name and returns an object containing the ID of the newly created virtual server, the default server admin token and the virtual server's voice port. Usually, the virtual server is also automatically started. This can be turned off on the TS3 server, though.
    If VirtualServerProperty.VIRTUALSERVER_PORT is not specified in the virtual server properties, the server will test for the first unused UDP port.
    Please also note that creating virtual servers usually requires the server query admin account and that there is a limit to how many virtual servers can be created, which is dependent on your license. Unlicensed TS3 server instances are limited to 1 virtual server with up to 32 client slots.
    
    Parameters:
    
    name - the name for the new virtual server
    
    options - a map of options that should be set for the virtual server
    
    Returns:
    
    information about the newly created virtual server
    
    See Also:
    
    VirtualServer
    
    Number of query commands sent:
    
    1
  - createServerSnapshot
```
public Snapshot createServerSnapshot()
```
    Creates a Snapshot of the selected virtual server containing all settings, groups and known client identities. The data from a server snapshot can be used to restore a virtual servers configuration.
    
    Returns:
    
    a snapshot of the virtual server
    
    See Also:
    
    deployServerSnapshot(Snapshot)
    
    Number of query commands sent:
    
    1
  - deleteAllBans
```
public boolean deleteAllBans()
```
    Deletes all active ban rules from the server. Use with caution.
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - deleteAllComplaints
```
public boolean deleteAllComplaints(int clientDBId)
```
    Deletes all complaints about the client with specified database ID from the server.
    
    Parameters:
    
    clientDBId - the database ID of the client
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getDatabaseId(), Complaint
    
    Number of query commands sent:
    
    1
  - deleteBan
```
public boolean deleteBan(int banId)
```
    Deletes the ban rule with the specified ID from the server.
    
    Parameters:
    
    banId - the ID of the ban to delete
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Ban.getId()
    
    Number of query commands sent:
    
    1
  - deleteChannel
```
public boolean deleteChannel(int channelId)
```
    Deletes an existing channel specified by its ID, kicking all clients out of the channel.
    
    Parameters:
    
    channelId - the ID of the channel to delete
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), deleteChannel(int, boolean), kickClientFromChannel(String, int...)
    
    Number of query commands sent:
    
    1
  - deleteChannel
```
public boolean deleteChannel(int channelId,
                             boolean force)
```
    Deletes an existing channel with a given ID. If force is true, the channel will be deleted even if there are clients within, else the command will fail in this situation.
    
    Parameters:
    
    channelId - the ID of the channel to delete
    
    force - whether clients should be kicked out of the channel
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), kickClientFromChannel(String, int...)
    
    Number of query commands sent:
    
    1
  - deleteChannelClientPermission
```
public boolean deleteChannelClientPermission(int channelId,
                                             int clientDBId,
                                             String permName)
```
    Removes a specified permission from a client in a specific channel.
    
    Parameters:
    
    channelId - the ID of the channel wherein the permission should be removed
    
    clientDBId - the database ID of the client
    
    permName - the name of the permission to revoke
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), Client.getDatabaseId(), Permission.getName()
    
    Number of query commands sent:
    
    1
  - deleteChannelGroup
```
public boolean deleteChannelGroup(int groupId)
```
    Removes the channel group with the given ID.
    
    Parameters:
    
    groupId - the ID of the channel group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ChannelGroup.getId()
    
    Number of query commands sent:
    
    1
  - deleteChannelGroup
```
public boolean deleteChannelGroup(int groupId,
                                  boolean force)
```
    Removes the channel group with the given ID. If force is true, the channel group will be deleted even if it still contains clients, else the command will fail in this situation.
    
    Parameters:
    
    groupId - the ID of the channel group
    
    force - whether the channel group should be deleted even if it still contains clients
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ChannelGroup.getId()
    
    Number of query commands sent:
    
    1
  - deleteChannelGroupPermission
```
public boolean deleteChannelGroupPermission(int groupId,
                                            String permName)
```
    Removes a permission from the channel group with the given ID.
    
    Parameters:
    
    groupId - the ID of the channel group
    
    permName - the name of the permission to revoke
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ChannelGroup.getId(), Permission.getName()
    
    Number of query commands sent:
    
    1
  - deleteChannelPermission
```
public boolean deleteChannelPermission(int channelId,
                                       String permName)
```
    Removes a permission from the channel with the given ID.
    
    Parameters:
    
    channelId - the ID of the channel
    
    permName - the name of the permission to revoke
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), Permission.getName()
    
    Number of query commands sent:
    
    1
  - deleteClientPermission
```
public boolean deleteClientPermission(int clientDBId,
                                      String permName)
```
    Removes a permission from a client.
    
    Parameters:
    
    clientDBId - the database ID of the client
    
    permName - the name of the permission to revoke
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getDatabaseId(), Permission.getName()
    
    Number of query commands sent:
    
    1
  - deleteComplaint
```
public boolean deleteComplaint(int targetClientDBId,
                               int fromClientDBId)
```
    Deletes the complaint about the client with database ID targetClientDBId submitted by the client with database ID fromClientDBId from the server.
    
    Parameters:
    
    targetClientDBId - the database ID of the client the complaint is about
    
    fromClientDBId - the database ID of the client who added the complaint
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Complaint, Client.getDatabaseId()
    
    Number of query commands sent:
    
    1
  - deleteDatabaseClientProperties
```
public boolean deleteDatabaseClientProperties(int clientDBId)
```
    Removes all stored database information about the specified client. Please note that this data is also automatically removed after a configured time (usually 90 days).
    See DatabaseClientInfo for a list of stored information about a client.
    
    Parameters:
    
    clientDBId - the database ID of the client
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getDatabaseId(), getDatabaseClientInfo(int), DatabaseClientInfo
    
    Number of query commands sent:
    
    1
  - deleteOfflineMessage
```
public boolean deleteOfflineMessage(int messageId)
```
    Deletes the offline message with the specified ID.
    
    Parameters:
    
    messageId - the ID of the offline message to delete
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Message.getId()
    
    Number of query commands sent:
    
    1
  - deletePermissionFromAllServerGroups
```
public boolean deletePermissionFromAllServerGroups(ServerGroupType type,
                                                   String permName)
```
    Removes a specified permission from all server groups of the type specified by type on all virtual servers.
    
    Parameters:
    
    type - the kind of server group this permission should be removed from
    
    permName - the name of the permission to remove
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroupType, Permission.getName()
    
    Number of query commands sent:
    
    1
  - deletePrivilegeKey
```
public boolean deletePrivilegeKey(String token)
```
    Deletes the privilege key with the given token.
    
    Parameters:
    
    token - the token of the privilege key
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    PrivilegeKey
    
    Number of query commands sent:
    
    1
  - deleteServer
```
public boolean deleteServer(int serverId)
```
    Deletes the virtual server with the specified ID.
    Only stopped virtual servers can be deleted.
    
    Parameters:
    
    serverId - the ID of the virtual server
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    VirtualServer.getId(), stopServer(int)
    
    Number of query commands sent:
    
    1
  - deleteServerGroup
```
public boolean deleteServerGroup(int groupId)
```
    Deletes the server group with the specified ID, even if the server group still contains clients.
    
    Parameters:
    
    groupId - the ID of the server group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroup.getId()
    
    Number of query commands sent:
    
    1
  - deleteServerGroup
```
public boolean deleteServerGroup(int groupId,
                                 boolean force)
```
    Deletes a server group with the specified ID.
    If force is true, the server group will be deleted even if it contains clients, else the command will fail in this situation.
    
    Parameters:
    
    groupId - the ID of the server group
    
    force - whether the server group should be deleted if it still contains clients
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroup.getId()
    
    Number of query commands sent:
    
    1
  - deleteServerGroupPermission
```
public boolean deleteServerGroupPermission(int groupId,
                                           String permName)
```
    Removes a permission from the server group with the given ID.
    
    Parameters:
    
    groupId - the ID of the server group
    
    permName - the name of the permission to revoke
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroup.getId(), Permission.getName()
    
    Number of query commands sent:
    
    1
  - deployServerSnapshot
```
public boolean deployServerSnapshot(Snapshot snapshot)
```
    Restores the selected virtual servers configuration using the data from a previously created server snapshot.
    
    Parameters:
    
    snapshot - the snapshot to restore
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    createServerSnapshot()
    
    Number of query commands sent:
    
    1
  - deployServerSnapshot
```
public boolean deployServerSnapshot(String snapshot)
```
    Restores the configuration of the selected virtual server using the data from a previously created server snapshot.
    
    Parameters:
    
    snapshot - the snapshot to restore
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    createServerSnapshot()
    
    Number of query commands sent:
    
    1
  - editChannel
```
public boolean editChannel(int channelId,
                           Map<ChannelProperty,String> options)
```
    Changes a channel's configuration using the given properties.
    
    Parameters:
    
    channelId - the ID of the channel to edit
    
    options - the map of properties to modify
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId()
    
    Number of query commands sent:
    
    1
  - editClient
```
public boolean editClient(int clientId,
                          Map<ClientProperty,String> options)
```
    Changes a client's configuration using given properties.
    Only ClientProperty.CLIENT_DESCRIPTION can be changed for other clients. To update the current client's properties, use updateClient(Map).
    
    Parameters:
    
    clientId - the ID of the client to edit
    
    options - the map of properties to modify
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId(), updateClient(Map)
    
    Number of query commands sent:
    
    1
  - editDatabaseClient
```
public boolean editDatabaseClient(int clientDBId,
                                  Map<ClientProperty,String> options)
```
    Changes a client's database settings using given properties.
    
    Parameters:
    
    clientDBId - the database ID of the client to edit
    
    options - the map of properties to modify
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    DatabaseClientInfo, Client.getDatabaseId()
    
    Number of query commands sent:
    
    1
  - editInstance
```
public boolean editInstance(ServerInstanceProperty property,
                            String value)
```
    Changes the server instance configuration using given properties. If the given property is not changeable, IllegalArgumentException will be thrown.
    
    Parameters:
    
    property - the property to edit, must be changeable
    
    value - the new value for the edit
    
    Returns:
    
    whether the command succeeded or not
    
    Throws:
    
    IllegalArgumentException - if property is not changeable
    
    See Also:
    
    ServerInstanceProperty.isChangeable()
    
    Number of query commands sent:
    
    1
  - editServer
```
public boolean editServer(Map<VirtualServerProperty,String> options)
```
    Changes the configuration of the selected virtual server using given properties.
    
    Parameters:
    
    options - the map of properties to edit
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    VirtualServerProperty
    
    Number of query commands sent:
    
    1
  - getBans
```
public List<Ban> getBans()
```
    Gets a list of all bans on the selected virtual server.
    
    Returns:
    
    a list of all bans on the virtual server
    
    See Also:
    
    Ban
    
    Number of query commands sent:
    
    1
  - getBindings
```
public List<Binding> getBindings()
```
    Gets a list of IP addresses used by the server instance.
    
    Returns:
    
    the list of bound IP addresses
    
    See Also:
    
    Binding
    
    Number of query commands sent:
    
    1
  - getChannelByNameExact
```
public Channel getChannelByNameExact(String name,
                                     boolean ignoreCase)
```
    Finds and returns the channel matching the given name exactly.
    
    Parameters:
    
    name - the name of the channel
    
    ignoreCase - whether the case of the name should be ignored
    
    Returns:
    
    the found channel or null if no channel was found
    
    See Also:
    
    Channel, getChannelsByName(String)
    
    Number of query commands sent:
    
    1
  - getChannelsByName
```
public List<Channel> getChannelsByName(String name)
```
    Gets a list of channels whose names contain the given search string.
    
    Parameters:
    
    name - the name to search
    
    Returns:
    
    a list of all channels with names matching the search pattern
    
    See Also:
    
    Channel, getChannelByNameExact(String, boolean)
    
    Number of query commands sent:
    
    2
  - getChannelClientPermissions
```
public List<Permission> getChannelClientPermissions(int channelId,
                                                    int clientDBId)
```
    Displays a list of permissions defined for a client in a specific channel.
    
    Parameters:
    
    channelId - the ID of the channel
    
    clientDBId - the database ID of the client
    
    Returns:
    
    a list of permissions for the user in the specified channel
    
    See Also:
    
    Channel.getId(), Client.getDatabaseId(), Permission
    
    Number of query commands sent:
    
    1
  - getChannelGroupClients
```
public List<ChannelGroupClient> getChannelGroupClients(int channelId,
                                                       int clientDBId,
                                                       int groupId)
```
    Gets all client / channel ID combinations currently assigned to channel groups. All three parameters are optional and can be turned off by setting it to -1.
    
    Parameters:
    
    channelId - restricts the search to the channel with a specified ID. Set to -1 to ignore.
    
    clientDBId - restricts the search to the client with a specified database ID. Set to -1 to ignore.
    
    groupId - restricts the search to the channel group with the specified ID. Set to -1 to ignore.
    
    Returns:
    
    a list of combinations of channel ID, client database ID and channel group ID
    
    See Also:
    
    Channel.getId(), Client.getDatabaseId(), ChannelGroup.getId(), ChannelGroupClient
    
    Number of query commands sent:
    
    1
  - getChannelGroupClientsByChannelGroupId
```
public List<ChannelGroupClient> getChannelGroupClientsByChannelGroupId(int groupId)
```
    Gets all client / channel ID combinations currently assigned to the specified channel group.
    
    Parameters:
    
    groupId - the ID of the channel group whose client / channel assignments should be returned.
    
    Returns:
    
    a list of combinations of channel ID, client database ID and channel group ID
    
    See Also:
    
    ChannelGroup.getId(), ChannelGroupClient, getChannelGroupClients(int, int, int)
    
    Number of query commands sent:
    
    1
  - getChannelGroupClientsByChannelId
```
public List<ChannelGroupClient> getChannelGroupClientsByChannelId(int channelId)
```
    Gets all channel group assignments in the specified channel.
    
    Parameters:
    
    channelId - the ID of the channel whose channel group assignments should be returned.
    
    Returns:
    
    a list of combinations of channel ID, client database ID and channel group ID
    
    See Also:
    
    Channel.getId(), ChannelGroupClient, getChannelGroupClients(int, int, int)
    
    Number of query commands sent:
    
    1
  - getChannelGroupClientsByClientDBId
```
public List<ChannelGroupClient> getChannelGroupClientsByClientDBId(int clientDBId)
```
    Gets all channel group assignments for the specified client.
    
    Parameters:
    
    clientDBId - the database ID of the client whose channel group
    
    Returns:
    
    a list of combinations of channel ID, client database ID and channel group ID
    
    See Also:
    
    Client.getDatabaseId(), ChannelGroupClient, getChannelGroupClients(int, int, int)
    
    Number of query commands sent:
    
    1
  - getChannelGroupPermissions
```
public List<Permission> getChannelGroupPermissions(int groupId)
```
    Gets a list of all permissions assigned to the specified channel group.
    
    Parameters:
    
    groupId - the ID of the channel group.
    
    Returns:
    
    a list of permissions assigned to the channel group
    
    See Also:
    
    ChannelGroup.getId(), Permission
    
    Number of query commands sent:
    
    1
  - getChannelGroups
```
public List<ChannelGroup> getChannelGroups()
```
    Gets a list of all channel groups on the selected virtual server.
    
    Returns:
    
    a list of all channel groups on the virtual server
    
    See Also:
    
    ChannelGroup
    
    Number of query commands sent:
    
    1
  - getChannelInfo
```
public ChannelInfo getChannelInfo(int channelId)
```
    Gets detailed configuration information about the channel specified channel.
    
    Parameters:
    
    channelId - the ID of the channel
    
    Returns:
    
    information about the channel
    
    See Also:
    
    Channel.getId(), ChannelInfo
    
    Number of query commands sent:
    
    1
  - getChannelPermissions
```
public List<Permission> getChannelPermissions(int channelId)
```
    Gets a list of all permissions assigned to the specified channel.
    
    Parameters:
    
    channelId - the ID of the channel
    
    Returns:
    
    a list of all permissions assigned to the channel
    
    See Also:
    
    Channel.getId(), Permission
    
    Number of query commands sent:
    
    1
  - getChannels
```
public List<Channel> getChannels()
```
    Gets a list of all channels on the selected virtual server.
    
    Returns:
    
    a list of all channels on the virtual server
    
    See Also:
    
    Channel
    
    Number of query commands sent:
    
    1
  - getClientByNameExact
```
public Client getClientByNameExact(String name,
                                   boolean ignoreCase)
```
    Finds and returns the client whose nickname matches the given name exactly.
    
    Parameters:
    
    name - the name of the client
    
    ignoreCase - whether the case of the name should be ignored
    
    Returns:
    
    the found client or null if no client was found
    
    See Also:
    
    Client, getClientsByName(String)
    
    Number of query commands sent:
    
    1
  - getClientsByName
```
public List<Client> getClientsByName(String name)
```
    Gets a list of clients whose nicknames contain the given search string.
    
    Parameters:
    
    name - the name to search
    
    Returns:
    
    a list of all clients with nicknames matching the search pattern
    
    See Also:
    
    Client, getClientByNameExact(String, boolean)
    
    Number of query commands sent:
    
    2
  - getClientByUId
```
public ClientInfo getClientByUId(String clientUId)
```
    Gets information about the client with the specified unique identifier.
    
    Parameters:
    
    clientUId - the unique identifier of the client
    
    Returns:
    
    the client or null if no client was found
    
    See Also:
    
    Client.getUniqueIdentifier(), ClientInfo
    
    Number of query commands sent:
    
    2
  - getClientInfo
```
public ClientInfo getClientInfo(int clientId)
```
    Gets information about the client with the specified client ID.
    
    Parameters:
    
    clientId - the client ID of the client
    
    Returns:
    
    the client or null if no client was found
    
    See Also:
    
    Client.getId(), ClientInfo
    
    Number of query commands sent:
    
    1
  - getClientPermissions
```
public List<Permission> getClientPermissions(int clientDBId)
```
    Gets a list of all permissions assigned to the specified client.
    
    Parameters:
    
    clientDBId - the database ID of the client
    
    Returns:
    
    a list of all permissions assigned to the client
    
    See Also:
    
    Client.getDatabaseId(), Permission
    
    Number of query commands sent:
    
    1
  - getClients
```
public List<Client> getClients()
```
    Gets a list of all clients on the selected virtual server.
    
    Returns:
    
    a list of all clients on the virtual server
    
    See Also:
    
    Client
    
    Number of query commands sent:
    
    1
  - getComplaints
```
public List<Complaint> getComplaints()
```
    Gets a list of all complaints on the selected virtual server.
    
    Returns:
    
    a list of all complaints on the virtual server
    
    See Also:
    
    Complaint, getComplaints(int)
    
    Number of query commands sent:
    
    1
  - getComplaints
```
public List<Complaint> getComplaints(int clientDBId)
```
    Gets a list of all complaints about the specified client.
    
    Parameters:
    
    clientDBId - the database ID of the client
    
    Returns:
    
    a list of all complaints about the specified client
    
    See Also:
    
    Client.getDatabaseId(), Complaint
    
    Number of query commands sent:
    
    1
  - getConnectionInfo
```
public ConnectionInfo getConnectionInfo()
```
    Gets detailed connection information about the selected virtual server.
    
    Returns:
    
    connection information about the selected virtual server
    
    See Also:
    
    ConnectionInfo, getServerInfo()
    
    Number of query commands sent:
    
    1
  - getDatabaseClientsByName
```
public List<DatabaseClientInfo> getDatabaseClientsByName(String name)
```
    Gets all clients in the database whose last nickname matches the specified name exactly.
    
    Parameters:
    
    name - the nickname for the clients to match
    
    Returns:
    
    a list of all clients with a matching nickname
    
    See Also:
    
    Client.getNickname()
    
    Number of query commands sent:
    
    1 + n, where n is the amount of database clients with a matching nickname
  - getDatabaseClientByUId
```
public DatabaseClientInfo getDatabaseClientByUId(String clientUId)
```
    Gets information about the client with the specified unique identifier in the server database.
    
    Parameters:
    
    clientUId - the unique identifier of the client
    
    Returns:
    
    the database client or null if no client was found
    
    See Also:
    
    Client.getUniqueIdentifier(), DatabaseClientInfo
    
    Number of query commands sent:
    
    2
  - getDatabaseClientInfo
```
public DatabaseClientInfo getDatabaseClientInfo(int clientDBId)
```
    Gets information about the client with the specified database ID in the server database.
    
    Parameters:
    
    clientDBId - the database ID of the client
    
    Returns:
    
    the database client or null if no client was found
    
    See Also:
    
    Client.getDatabaseId(), DatabaseClientInfo
    
    Number of query commands sent:
    
    1
  - getDatabaseClients
```
public List<DatabaseClient> getDatabaseClients()
```
    Gets information about all clients in the server database.
    As this method uses internal commands which can only return 200 clients at once, this method can take quite some time to execute.
    Also keep in mind that the client database can easily accumulate several thousand entries.
    
    Returns:
    
    a List of all database clients
    
    See Also:
    
    DatabaseClient
    
    Number of query commands sent:
    
    1 + n, where n = Math.ceil([amount of database clients] / 200)
  - getHostInfo
```
public HostInfo getHostInfo()
```
    Displays detailed configuration information about the server instance including uptime, number of virtual servers online, traffic information, etc.
    
    Returns:
    
    information about the host
    
    Number of query commands sent:
    
    1
  - getInstanceInfo
```
public InstanceInfo getInstanceInfo()
```
    Displays the server instance configuration including database revision number, the file transfer port, default group IDs, etc.
    
    Returns:
    
    information about the TeamSpeak server instance.
    
    Number of query commands sent:
    
    1
  - getOfflineMessage
```
public String getOfflineMessage(int messageId)
```
    Reads the message body of a message. This will not set the read flag, though.
    
    Parameters:
    
    messageId - the ID of the message to be read
    
    Returns:
    
    the body of the message with the specified ID or null if there was no message with that ID
    
    See Also:
    
    Message.getId(), setMessageRead(int)
    
    Number of query commands sent:
    
    1
  - getOfflineMessage
```
public String getOfflineMessage(Message message)
```
    Reads the message body of a message. This will not set the read flag, though.
    
    Parameters:
    
    message - the message to be read
    
    Returns:
    
    the body of the message with the specified ID or null if there was no message with that ID
    
    See Also:
    
    Message.getId(), setMessageRead(Message)
    
    Number of query commands sent:
    
    1
  - getOfflineMessages
```
public List<Message> getOfflineMessages()
```
    Gets a list of all offline messages for the server query. The returned messages lack their message body, though. To read the actual message, use getOfflineMessage(int) or getOfflineMessage(Message).
    
    Returns:
    
    a list of all offline messages this server query has received
    
    Number of query commands sent:
    
    1
  - getPermissionAssignments
```
public List<AdvancedPermission> getPermissionAssignments(String permName)
```
    Displays detailed information about all assignments of the permission specified with permName. The output includes the type and the ID of the client, channel or group associated with the permission.
    
    Parameters:
    
    permName - the name of the permission
    
    Returns:
    
    a list of permission assignments
    
    See Also:
    
    getPermissionOverview(int, int)
    
    Number of query commands sent:
    
    1
  - getPermissionIdByName
```
public int getPermissionIdByName(String permName)
```
    Gets the ID of the permission specified by permName.
    Note that the use of numeric permission IDs is deprecated and that this API only uses the string variant of the IDs.
    
    Parameters:
    
    permName - the name of the permission
    
    Returns:
    
    the numeric ID of the specified permission
    
    Number of query commands sent:
    
    1
  - getPermissionOverview
```
public List<AdvancedPermission> getPermissionOverview(int channelId,
                                                      int clientDBId)
```
    Gets a list of all assigned permissions for a client in a specified channel. If you do not care about channel permissions, set channelId to -1.
    
    Parameters:
    
    channelId - the ID of the channel
    
    clientDBId - the database ID of the client to create the overview for
    
    Returns:
    
    a list of all permission assignments for the client in the specified channel
    
    See Also:
    
    Channel.getId(), Client.getDatabaseId()
    
    Number of query commands sent:
    
    1
  - getPermissions
```
public List<PermissionInfo> getPermissions()
```
    Displays a list of all permissions, including ID, name and description.
    
    Returns:
    
    a list of all permissions
    
    Number of query commands sent:
    
    1
  - getPermissionValue
```
public int getPermissionValue(String permName)
```
    Displays the current value of the specified permission for this server query instance.
    
    Parameters:
    
    permName - the name of the permission
    
    Returns:
    
    the permission value, usually ranging from 0 to 100
    
    Number of query commands sent:
    
    1
  - getPrivilegeKeys
```
public List<PrivilegeKey> getPrivilegeKeys()
```
    Gets a list of all available tokens to join channel or server groups, including their type and group IDs.
    
    Returns:
    
    a list of all generated, but still unclaimed privilege keys
    
    See Also:
    
    addPrivilegeKey(TokenType, int, int, String), usePrivilegeKey(String)
    
    Number of query commands sent:
    
    1
  - getServerGroupClients
```
public List<ServerGroupClient> getServerGroupClients(int serverGroupId)
```
    Gets a list of all clients in the specified server group.
    
    Parameters:
    
    serverGroupId - the ID of the server group for which the clients should be looked up
    
    Returns:
    
    a list of all clients in the server group
    
    Number of query commands sent:
    
    1
  - getServerGroupClients
```
public List<ServerGroupClient> getServerGroupClients(ServerGroup serverGroup)
```
    Gets a list of all clients in the specified server group.
    
    Parameters:
    
    serverGroup - the server group for which the clients should be looked up
    
    Returns:
    
    a list of all clients in the server group
    
    Number of query commands sent:
    
    1
  - getServerGroupPermissions
```
public List<Permission> getServerGroupPermissions(int serverGroupId)
```
    Gets a list of all permissions assigned to the specified server group.
    
    Parameters:
    
    serverGroupId - the ID of the server group for which the permissions should be looked up
    
    Returns:
    
    a list of all permissions assigned to the server group
    
    See Also:
    
    ServerGroup.getId(), getServerGroupPermissions(ServerGroup)
    
    Number of query commands sent:
    
    1
  - getServerGroupPermissions
```
public List<Permission> getServerGroupPermissions(ServerGroup serverGroup)
```
    Gets a list of all permissions assigned to the specified server group.
    
    Parameters:
    
    serverGroup - the server group for which the permissions should be looked up
    
    Returns:
    
    a list of all permissions assigned to the server group
    
    Number of query commands sent:
    
    1
  - getServerGroups
```
public List<ServerGroup> getServerGroups()
```
    Gets a list of all server groups on the virtual server.
    Depending on your permissions, the output may also contain global server query groups and template groups.
    
    Returns:
    
    a list of all server groups
    
    Number of query commands sent:
    
    1
  - getServerGroupsByClientId
```
public List<ServerGroup> getServerGroupsByClientId(int clientDatabaseId)
```
    Gets a list of all server groups set for a client.
    
    Parameters:
    
    clientDatabaseId - the database ID of the client for which the server groups should be looked up
    
    Returns:
    
    a list of all server groups set for the client
    
    See Also:
    
    Client.getDatabaseId(), getServerGroupsByClient(Client)
    
    Number of query commands sent:
    
    2
  - getServerGroupsByClient
```
public List<ServerGroup> getServerGroupsByClient(Client client)
```
    Gets a list of all server groups set for a client.
    
    Parameters:
    
    client - the client for which the server groups should be looked up
    
    Returns:
    
    a list of all server group set for the client
    
    See Also:
    
    getServerGroupsByClientId(int)
    
    Number of query commands sent:
    
    2
  - getServerIdByPort
```
public int getServerIdByPort(int port)
```
    Gets the ID of a virtual server by its port.
    
    Parameters:
    
    port - the port of a virtual server
    
    Returns:
    
    the ID of the virtual server
    
    See Also:
    
    VirtualServer.getPort(), VirtualServer.getId()
    
    Number of query commands sent:
    
    1
  - getServerInfo
```
public VirtualServerInfo getServerInfo()
```
    Gets detailed information about the virtual server the server query is currently in.
    
    Returns:
    
    information about the current virtual server
    
    Number of query commands sent:
    
    1
  - getVersion
```
public Version getVersion()
```
    Gets the version, build number and platform of the TeamSpeak3 server.
    
    Returns:
    
    the version information of the server
    
    Number of query commands sent:
    
    1
  - getVirtualServers
```
public List<VirtualServer> getVirtualServers()
```
    Gets a list of all virtual servers including their ID, status, number of clients online, etc.
    
    Returns:
    
    a list of all virtual servers
    
    Number of query commands sent:
    
    1
  - kickClientFromChannel
```
public boolean kickClientFromChannel(int... clientIds)
```
    Kicks one or more clients from their current channels. This will move the kicked clients into the default channel and won't do anything if the clients are already in the default channel.
    
    Parameters:
    
    clientIds - the IDs of the clients to kick
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    kickClientFromChannel(Client...), kickClientFromChannel(String, int...)
    
    Number of query commands sent:
    
    1
  - kickClientFromChannel
```
public boolean kickClientFromChannel(Client... clients)
```
    Kicks one or more clients from their current channels. This will move the kicked clients into the default channel and won't do anything if the clients are already in the default channel.
    
    Parameters:
    
    clients - the clients to kick
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    kickClientFromChannel(int...), kickClientFromChannel(String, Client...)
    
    Number of query commands sent:
    
    1
  - kickClientFromChannel
```
public boolean kickClientFromChannel(String message,
                                     int... clientIds)
```
    Kicks one or more clients from their current channels for the specified reason. This will move the kicked clients into the default channel and won't do anything if the clients are already in the default channel.
    
    Parameters:
    
    message - the reason message to display to the clients
    
    clientIds - the IDs of the clients to kick
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId(), kickClientFromChannel(int...), kickClientFromChannel(String, Client...)
    
    Number of query commands sent:
    
    1
  - kickClientFromChannel
```
public boolean kickClientFromChannel(String message,
                                     Client... clients)
```
    Kicks one or more clients from their current channels for the specified reason. This will move the kicked clients into the default channel and won't do anything if the clients are already in the default channel.
    
    Parameters:
    
    message - the reason message to display to the clients
    
    clients - the clients to kick
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    kickClientFromChannel(Client...), kickClientFromChannel(String, int...)
    
    Number of query commands sent:
    
    1
  - kickClientFromServer
```
public boolean kickClientFromServer(int... clientIds)
```
    Kicks one or more clients from the server.
    
    Parameters:
    
    clientIds - the IDs of the clients to kick
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId(), kickClientFromServer(Client...), kickClientFromServer(String, int...)
    
    Number of query commands sent:
    
    1
  - kickClientFromServer
```
public boolean kickClientFromServer(Client... clients)
```
    Kicks one or more clients from the server.
    
    Parameters:
    
    clients - the clients to kick
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    kickClientFromServer(int...), kickClientFromServer(String, Client...)
    
    Number of query commands sent:
    
    1
  - kickClientFromServer
```
public boolean kickClientFromServer(String message,
                                    int... clientIds)
```
    Kicks one or more clients from the server for the specified reason.
    
    Parameters:
    
    message - the reason message to display to the clients
    
    clientIds - the IDs of the clients to kick
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId(), kickClientFromServer(int...), kickClientFromServer(String, Client...)
    
    Number of query commands sent:
    
    1
  - kickClientFromServer
```
public boolean kickClientFromServer(String message,
                                    Client... clients)
```
    Kicks one or more clients from the server for the specified reason.
    
    Parameters:
    
    message - the reason message to display to the clients
    
    clients - the clients to kick
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    kickClientFromServer(Client...), kickClientFromServer(String, int...)
    
    Number of query commands sent:
    
    1
  - login
```
public boolean login(String username,
                     String password)
```
    Logs the server query in using the specified username and password.
    Note that you can also set the login in the TS3Config, so that you will be logged in right after the connection is established.
    
    Parameters:
    
    username - the username of the server query
    
    password - the password to use
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    TS3Config.setLoginCredentials(String, String), logout()
    
    Number of query commands sent:
    
    1
  - logout
```
public boolean logout()
```
    Logs the server query out and deselects the current virtual server.
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    login(String, String)
    
    Number of query commands sent:
    
    1
  - moveChannel
```
public boolean moveChannel(int channelId,
                           int channelTargetId)
```
    Moves a channel to a new parent channel specified by its ID. To move a channel to root level, set channelTargetId to 0.
    This will move the channel right below the specified parent channel, above all other child channels. This command will fail if the channel already has the specified target channel as the parent channel.
    
    Parameters:
    
    channelId - the channel to move
    
    channelTargetId - the new parent channel for the specified channel
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), moveChannel(int, int, int)
    
    Number of query commands sent:
    
    1
  - moveChannel
```
public boolean moveChannel(int channelId,
                           int channelTargetId,
                           int order)
```
    Moves a channel to a new parent channel specified by its ID. To move a channel to root level, set channelTargetId to 0.
    The channel will be ordered below the channel with the ID specified by order. To move the channel right below the parent channel, set order to 0. Also note that a channel cannot be re-ordered without also changing its parent channel.
    
    Parameters:
    
    channelId - the channel to move
    
    channelTargetId - the new parent channel for the specified channel
    
    order - the channel to sort the specified channel below
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), moveChannel(int, int)
    
    Number of query commands sent:
    
    1
  - moveClient
```
public boolean moveClient(int channelId)
```
    Moves the server query into the specified channel.
    
    Parameters:
    
    channelId - the ID of the channel to move the client into
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId()
    
    Number of query commands sent:
    
    1
  - moveClient
```
public boolean moveClient(ChannelBase channel)
```
    Moves the server query into the specified channel.
    
    Parameters:
    
    channel - the channel to move the client into
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - moveClient
```
public boolean moveClient(int channelId,
                          String channelPassword)
```
    Moves the server query into the specified channel using the specified password.
    
    Parameters:
    
    channelId - the ID of the channel to move the client into
    
    channelPassword - the password of the channel
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId()
    
    Number of query commands sent:
    
    1
  - moveClient
```
public boolean moveClient(ChannelBase channel,
                          String channelPassword)
```
    Moves the server query into the specified channel using the specified password.
    
    Parameters:
    
    channel - the channel to move the client into
    
    channelPassword - the password of the channel
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - moveClient
```
public boolean moveClient(int clientId,
                          int channelId)
```
    Moves a client into the specified channel.
    
    Parameters:
    
    clientId - the ID of the client to move
    
    channelId - the ID of the channel to move the client into
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId(), Channel.getId()
    
    Number of query commands sent:
    
    1
  - moveClient
```
public boolean moveClient(Client client,
                          ChannelBase channel)
```
    Moves a client into the specified channel.
    
    Parameters:
    
    client - the client to move
    
    channel - the channel to move the client into
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - moveClient
```
public boolean moveClient(int clientId,
                          int channelId,
                          String channelPassword)
```
    Moves a client into the specified channel using the specified password.
    
    Parameters:
    
    clientId - the ID of the client to move
    
    channelId - the ID of the channel to move the client into
    
    channelPassword - the password of the channel
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId(), Channel.getId()
    
    Number of query commands sent:
    
    1
  - moveClient
```
public boolean moveClient(Client client,
                          ChannelBase channel,
                          String channelPassword)
```
    Moves a client into the specified channel using the specified password.
    
    Parameters:
    
    client - the client to move
    
    channel - the channel to move the client into
    
    channelPassword - the password of the channel
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - pokeClient
```
public boolean pokeClient(int clientId,
                          String message)
```
    Pokes the client with the specified client ID. This opens up a small popup window for the client containing your message and plays a sound. The displayed message will be formatted like this:
    hh:mm:ss - "Your Nickname" poked you: <your message in green color>
    The displayed message length is limited to 100 UTF-8 bytes. If a client has already received a poke message, all subsequent pokes will simply add a line to the already opened popup window and will still play a sound.
    
    Parameters:
    
    clientId - the ID of the client to poke
    
    message - the message to send, may contain BB codes
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId()
    
    Number of query commands sent:
    
    1
  - quit
```
@Deprecated
public boolean quit()
```
    Deprecated. This command leaves the query in an undefined state, where the connection is closed without the socket being closed and no more command can be executed. To terminate a connection, use TS3Query.exit().
    
    Terminates the connection with the TeamSpeak3 server. This command should never be executed manually.
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - registerAllEvents
```
public boolean registerAllEvents()
```
    Registers the server query to receive notifications about all server events.
    This means that the following actions will trigger event notifications:
    - A client joins the server or disconnects from it
    - A client switches channels
    - A client sends a server message
    - A client sends a channel message in the channel the query is in
    - A client sends the server query a private message or a response to a private message
    The limitations to when the query receives notifications about chat events cannot be circumvented.
    To be able to process these events in your application, register an event listener.
    Returns:
    
    whether all commands succeeded or not
    
    See Also:
    
    addTS3Listeners(TS3Listener...)
    
    Number of query commands sent:
    
    5
  - registerEvent
```
public boolean registerEvent(TS3EventType eventType)
```
    Registers the server query to receive notifications about a given event type.
    If used with TS3EventType.TEXT_CHANNEL, this will listen to chat events in the current channel. If used with TS3EventType.CHANNEL, this will listen to all channel events. To specify a different channel for channel events, use registerEvent(TS3EventType, int).
    
    Parameters:
    
    eventType - the event type to be notified about
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    addTS3Listeners(TS3Listener...), registerEvent(TS3EventType, int), registerAllEvents()
    
    Number of query commands sent:
    
    1
  - registerEvent
```
public boolean registerEvent(TS3EventType eventType,
                             int channelId)
```
    Registers the server query to receive notifications about a given event type.
    
    Parameters:
    
    eventType - the event type to be notified about
    
    channelId - the ID of the channel to listen to, will be ignored if set to -1. Can be set to 0 for TS3EventType.CHANNEL to receive notifications about all channel switches.
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Channel.getId(), addTS3Listeners(TS3Listener...), registerAllEvents()
    
    Number of query commands sent:
    
    1
  - registerEvents
```
public boolean registerEvents(TS3EventType... eventTypes)
```
    Registers the server query to receive notifications about multiple given event types.
    If used with TS3EventType.TEXT_CHANNEL, this will listen to chat events in the current channel. If used with TS3EventType.CHANNEL, this will listen to all channel events. To specify a different channel for channel events, use registerEvent(TS3EventType, int).
    
    Parameters:
    
    eventTypes - the event types to be notified about
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    addTS3Listeners(TS3Listener...), registerEvent(TS3EventType, int), registerAllEvents()
    
    Number of query commands sent:
    
    n, one command per TS3EventType
  - removeClientFromServerGroup
```
public boolean removeClientFromServerGroup(int serverGroupId,
                                           int clientDatabaseId)
```
    Removes the client specified by its database ID from the specified server group.
    
    Parameters:
    
    serverGroupId - the ID of the server group
    
    clientDatabaseId - the database ID of the client
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroup.getId(), Client.getDatabaseId(), removeClientFromServerGroup(ServerGroup, Client)
    
    Number of query commands sent:
    
    1
  - removeClientFromServerGroup
```
public boolean removeClientFromServerGroup(ServerGroup serverGroup,
                                           Client client)
```
    Removes the specified client from the specified server group.
    
    Parameters:
    
    serverGroup - the server group to remove the client from
    
    client - the client to remove from the server group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    removeClientFromServerGroup(int, int)
    
    Number of query commands sent:
    
    1
  - removeTS3Listeners
```
public void removeTS3Listeners(TS3Listener... listeners)
```
    Removes one or more TS3Listeners to the event manager of the query.
    If a listener was not actually registered, it will be ignored and no exception will be thrown.
    
    Parameters:
    
    listeners - one or more listeners to remove
    
    See Also:
    
    addTS3Listeners(TS3Listener...), TS3Listener, TS3EventType
  - renameChannelGroup
```
public boolean renameChannelGroup(int channelGroupId,
                                  String name)
```
    Renames the channel group with the specified ID.
    
    Parameters:
    
    channelGroupId - the ID of the channel group to rename
    
    name - the new name for the channel group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ChannelGroup.getId(), renameChannelGroup(ChannelGroup, String)
    
    Number of query commands sent:
    
    1
  - renameChannelGroup
```
public boolean renameChannelGroup(ChannelGroup channelGroup,
                                  String name)
```
    Renames the specified channel group.
    
    Parameters:
    
    channelGroup - the channel group to rename
    
    name - the new name for the channel group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    renameChannelGroup(int, String)
    
    Number of query commands sent:
    
    1
  - renameServerGroup
```
public boolean renameServerGroup(int serverGroupId,
                                 String name)
```
    Renames the server group with the specified ID.
    
    Parameters:
    
    serverGroupId - the ID of the server group to rename
    
    name - the new name for the server group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ServerGroup.getId(), renameServerGroup(ServerGroup, String)
    
    Number of query commands sent:
    
    1
  - renameServerGroup
```
public boolean renameServerGroup(ServerGroup serverGroup,
                                 String name)
```
    Renames the specified server group.
    
    Parameters:
    
    serverGroup - the server group to rename
    
    name - the new name for the server group
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    renameServerGroup(int, String)
    
    Number of query commands sent:
    
    1
  - resetPermissions
```
public String resetPermissions()
```
    Resets all permissions and deletes all server / channel groups. Use carefully.
    
    Returns:
    
    a token for a new administrator account
    
    Number of query commands sent:
    
    1
  - selectVirtualServerById
```
public boolean selectVirtualServerById(int id)
```
    Moves the server query into the virtual server with the specified ID.
    
    Parameters:
    
    id - the ID of the virtual server
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    VirtualServer.getId(), selectVirtualServerByPort(int), selectVirtualServer(VirtualServer)
    
    Number of query commands sent:
    
    1
  - selectVirtualServerByPort
```
public boolean selectVirtualServerByPort(int port)
```
    Moves the server query into the virtual server with the specified voice port.
    
    Parameters:
    
    port - the voice port of the virtual server
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    VirtualServer.getPort(), selectVirtualServerById(int), selectVirtualServer(VirtualServer)
    
    Number of query commands sent:
    
    1
  - selectVirtualServer
```
public boolean selectVirtualServer(VirtualServer server)
```
    Moves the server query into the specified virtual server.
    
    Parameters:
    
    server - the virtual server to move into
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    selectVirtualServerById(int), selectVirtualServerByPort(int)
    
    Number of query commands sent:
    
    1
  - sendOfflineMessage
```
public boolean sendOfflineMessage(String clientUId,
                                  String subject,
                                  String message)
```
    Sends an offline message to the client with the given unique identifier.
    The message subject's length is limited to 200 UTF-8 bytes and BB codes in it will be ignored. The message body's length is limited to 4096 UTF-8 bytes and accepts BB codes
    
    Parameters:
    
    clientUId - the unique identifier of the client to send the message to
    
    subject - the subject for the message, may not contain BB codes
    
    message - the actual message body, may contain BB codes
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getUniqueIdentifier(), Message
    
    Number of query commands sent:
    
    1
  - sendTextMessage
```
public boolean sendTextMessage(TextMessageTargetMode targetMode,
                               int targetId,
                               String message)
```
    Sends a text message either to the whole virtual server, a channel or specific client. Your message may contain BB codes, but its length is limited to 1024 UTF-8 bytes.
    To send a message to all virtual servers, use broadcast(String). To send an offline message, use sendOfflineMessage(String, String, String).
    
    Parameters:
    
    targetMode - where the message should be sent to
    
    targetId - the client ID of the recipient of this message. This value is ignored unless targetMode is CLIENT
    
    message - the text message to send
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId()
    
    Number of query commands sent:
    
    1
  - sendChannelMessage
```
public boolean sendChannelMessage(int channelId,
                                  String message)
```
    Sends a text message to the channel with the specified ID. Your message may contain BB codes, but its length is limited to 1024 UTF-8 bytes.
    This will move the client into the channel with the specified channel ID, but will not move it back to the original channel!
    
    Parameters:
    
    channelId - the ID of the channel to which the message should be sent to
    
    message - the text message to send
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    sendChannelMessage(String), Channel.getId()
    
    Number of query commands sent:
    
    1
  - sendChannelMessage
```
public boolean sendChannelMessage(String message)
```
    Sends a text message to the channel the server query is currently in. Your message may contain BB codes, but its length is limited to 1024 UTF-8 bytes.
    
    Parameters:
    
    message - the text message to send
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - sendServerMessage
```
public boolean sendServerMessage(int serverId,
                                 String message)
```
    Sends a text message to the virtual server with the specified ID. Your message may contain BB codes, but its length is limited to 1024 UTF-8 bytes.
    This will move the client to the virtual server with the specified server ID, but will not move it back to the original virtual server!
    
    Parameters:
    
    serverId - the ID of the virtual server to which the message should be sent to
    
    message - the text message to send
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    sendServerMessage(String), VirtualServer.getId()
    
    Number of query commands sent:
    
    1
  - sendServerMessage
```
public boolean sendServerMessage(String message)
```
    Sends a text message to the virtual server the server query is currently in. Your message may contain BB codes, but its length is limited to 1024 UTF-8 bytes.
    
    Parameters:
    
    message - the text message to send
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - sendPrivateMessage
```
public boolean sendPrivateMessage(int clientId,
                                  String message)
```
    Sends a private message to the client with the specified client ID. Your message may contain BB codes, but its length is limited to 1024 UTF-8 bytes.
    
    Parameters:
    
    clientId - the ID of the client to send the message to
    
    message - the text message to send
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    Client.getId()
    
    Number of query commands sent:
    
    1
  - setClientChannelGroup
```
public boolean setClientChannelGroup(int groupId,
                                     int channelId,
                                     int clientDBId)
```
    Sets a channel group for a client in a specific channel.
    
    Parameters:
    
    groupId - the ID of the group the client should join
    
    channelId - the ID of the channel where the channel group should be assigned
    
    clientDBId - the database ID of the client for which the channel group should be set
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    ChannelGroup.getId(), Channel.getId(), Client.getDatabaseId()
    
    Number of query commands sent:
    
    1
  - setMessageRead
```
public boolean setMessageRead(int messageId)
```
    Sets the read flag to true for a given message. This will not delete the message.
    
    Parameters:
    
    messageId - the ID of the message for which the read flag should be set
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    setMessageReadFlag(int, boolean)
    
    Number of query commands sent:
    
    1
  - setMessageRead
```
public boolean setMessageRead(Message message)
```
    Sets the read flag to true for a given message. This will not delete the message.
    
    Parameters:
    
    message - the message for which the read flag should be set
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    setMessageRead(int), setMessageReadFlag(Message, boolean), deleteOfflineMessage(int)
    
    Number of query commands sent:
    
    1
  - setMessageReadFlag
```
public boolean setMessageReadFlag(int messageId,
                                  boolean read)
```
    Sets the read flag for a given message. This will not delete the message.
    
    Parameters:
    
    messageId - the ID of the message for which the read flag should be set
    
    read - the boolean value to which the read flag should be set
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    setMessageRead(int), setMessageReadFlag(Message, boolean), deleteOfflineMessage(int)
    
    Number of query commands sent:
    
    1
  - setMessageReadFlag
```
public boolean setMessageReadFlag(Message message,
                                  boolean read)
```
    Sets the read flag for a given message. This will not delete the message.
    
    Parameters:
    
    message - the message for which the read flag should be set
    
    read - the boolean value to which the read flag should be set
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    setMessageRead(Message), setMessageReadFlag(int, boolean), deleteOfflineMessage(int)
    
    Number of query commands sent:
    
    1
  - setNickname
```
public boolean setNickname(String nickname)
```
    Sets the nickname of the server query client. The nickname must be between 3 and 30 UTF-8 bytes long and BB codes will be ignored.
    
    Parameters:
    
    nickname - the new nickname, may not contain any BB codes and may not be null
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    updateClient(Map)
    
    Number of query commands sent:
    
    1
  - startServer
```
public boolean startServer(int serverId)
```
    Starts the virtual server with the specified ID.
    
    Parameters:
    
    serverId - the ID of the virtual server
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - startServer
```
public boolean startServer(VirtualServer virtualServer)
```
    Starts the specified virtual server.
    
    Parameters:
    
    virtualServer - the virtual server to start
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - stopServer
```
public boolean stopServer(int serverId)
```
    Stops the virtual server with the specified ID.
    
    Parameters:
    
    serverId - the ID of the virtual server
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - stopServer
```
public boolean stopServer(VirtualServer virtualServer)
```
    Stops the specified virtual server.
    
    Parameters:
    
    virtualServer - the virtual server to stop
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - stopServerProcess
```
public boolean stopServerProcess()
```
    Stops the entire TeamSpeak 3 Server instance by shutting down the process.
    To have permission to use this command, you need to use the server query admin login.
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - unregisterAllEvents
```
public boolean unregisterAllEvents()
```
    Unregisters the server query from receiving any event notifications.
    
    Returns:
    
    whether the command succeeded or not
    
    Number of query commands sent:
    
    1
  - updateClient
```
public boolean updateClient(Map<ClientProperty,String> options)
```
    Updates several client properties for this server query instance.
    
    Parameters:
    
    options - the map of properties to update
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    editClient(int, Map)
    
    Number of query commands sent:
    
    1
  - updateServerQueryLogin
```
public String updateServerQueryLogin(String loginName)
```
    Generates new login credentials for the currently connected server query instance, using the given name.
    This will remove the current login credentials! You won't be logged out, but after disconnecting, the old credentials will no longer work. Make sure to not lock yourselves out!
    
    Parameters:
    
    loginName - the name for the server query login
    
    Returns:
    
    the generated password for the server query login
    
    Number of query commands sent:
    
    1
  - usePrivilegeKey
```
public boolean usePrivilegeKey(String token)
```
    Uses an existing privilege key to join a server or channel group.
    
    Parameters:
    
    token - the privilege key to use
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    PrivilegeKey, addPrivilegeKey(TokenType, int, int, String), usePrivilegeKey(PrivilegeKey)
    
    Number of query commands sent:
    
    1
  - usePrivilegeKey
```
public boolean usePrivilegeKey(PrivilegeKey privilegeKey)
```
    Uses an existing privilege key to join a server or channel group.
    
    Parameters:
    
    privilegeKey - the privilege key to use
    
    Returns:
    
    whether the command succeeded or not
    
    See Also:
    
    PrivilegeKey, addPrivilegeKey(TokenType, int, int, String), usePrivilegeKey(String)
    
    Number of query commands sent:
    
    1
  - whoAmI
```
public ServerQueryInfo whoAmI()
```
    Gets information about the current server query instance.
    
    Returns:
    
    information about the server query instance
    
    See Also:
    
    getClientInfo(int)
    
    Number of query commands sent:
    
    1

Class TS3Api

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TS3Api

Method Detail

addBan

addChannelClientPermission

addChannelGroup

addChannelGroup

addChannelGroupPermission

addChannelPermission

addClientPermission

addClientToServerGroup

addComplaint

addPermissionToAllServerGroups

addPrivilegeKey

addPrivilegeKeyChannelGroup

addPrivilegeKeyServerGroup

addServerGroup

addServerGroup

addServerGroupPermission

addTS3Listeners

banClient

banClient

banClient

broadcast

copyChannelGroup

copyChannelGroup

copyServerGroup

copyServerGroup

createChannel

createServer

createServerSnapshot

deleteAllBans

deleteAllComplaints

deleteBan

deleteChannel

deleteChannel

deleteChannelClientPermission

deleteChannelGroup

deleteChannelGroup

deleteChannelGroupPermission

deleteChannelPermission

deleteClientPermission

deleteComplaint

deleteDatabaseClientProperties

deleteOfflineMessage

deletePermissionFromAllServerGroups

deletePrivilegeKey

deleteServer

deleteServerGroup

deleteServerGroup

deleteServerGroupPermission

deployServerSnapshot

deployServerSnapshot

editChannel

editClient

editDatabaseClient

editInstance

editServer

getBans

getBindings

getChannelByNameExact

getChannelsByName

getChannelClientPermissions

getChannelGroupClients

getChannelGroupClientsByChannelGroupId

getChannelGroupClientsByChannelId

getChannelGroupClientsByClientDBId

getChannelGroupPermissions

getChannelGroups

getChannelInfo

getChannelPermissions

getChannels

getClientByNameExact

getClientsByName

getClientByUId

getClientInfo