| Package | Description |
|---|---|
| com.github.theholywaffle.teamspeak3 | |
| com.github.theholywaffle.teamspeak3.api | |
| com.github.theholywaffle.teamspeak3.commands |
| Modifier and Type | Method and Description |
|---|---|
CommandFuture<Integer> |
TS3ApiAsync.addBan(String ip,
String name,
String uid,
long timeInSeconds,
String reason)
Adds a new ban entry.
|
CommandFuture<Integer> |
TS3ApiAsync.addBan(String ip,
String name,
String uid,
String myTSId,
long timeInSeconds,
String reason)
Adds a new ban entry.
|
CommandFuture<Void> |
TS3ApiAsync.addChannelClientPermission(int channelId,
int clientDBId,
String permName,
int permValue)
Adds a specified permission to a client in a specific channel.
|
CommandFuture<Integer> |
TS3ApiAsync.addChannelGroup(String name)
Creates a new channel group for clients using a given name and returns its ID.
|
CommandFuture<Integer> |
TS3ApiAsync.addChannelGroup(String name,
PermissionGroupDatabaseType type)
Creates a new channel group using a given name and returns its ID.
|
CommandFuture<Void> |
TS3ApiAsync.addChannelGroupPermission(int groupId,
String permName,
int permValue)
Adds a specified permission to a channel group.
|
CommandFuture<Void> |
TS3ApiAsync.addChannelPermission(int channelId,
String permName,
int permValue)
Adds a specified permission to a channel.
|
CommandFuture<Void> |
TS3ApiAsync.addClientPermission(int clientDBId,
BPermissionType permName,
boolean value,
boolean skipped)
Adds a specified permission to a client.
|
CommandFuture<Void> |
TS3ApiAsync.addClientPermission(int clientDBId,
IPermissionType permName,
int value,
boolean skipped)
Adds a specified permission to a client.
|
CommandFuture<Void> |
TS3ApiAsync.addClientPermission(int clientDBId,
String permName,
int value,
boolean skipped)
Deprecated.
This method is no longer preferred for adding permissions to a client.
Use |
CommandFuture<Void> |
TS3ApiAsync.addClientToServerGroup(int groupId,
int clientDatabaseId)
Adds a client to the specified server group.
|
CommandFuture<Void> |
TS3ApiAsync.addComplaint(int clientDBId,
String message)
Submits a complaint about the specified client.
|
CommandFuture<Void> |
TS3ApiAsync.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. |
CommandFuture<String> |
TS3ApiAsync.addPrivilegeKey(PrivilegeKeyType type,
int groupId,
int channelId,
String description)
Create a new privilege key that allows one client to join a server or channel group.
|
CommandFuture<String> |
TS3ApiAsync.addPrivilegeKeyChannelGroup(int channelGroupId,
int channelId,
String description)
Creates a new privilege key for a channel group.
|
CommandFuture<String> |
TS3ApiAsync.addPrivilegeKeyServerGroup(int serverGroupId,
String description)
Creates a new privilege key for a server group.
|
CommandFuture<Integer> |
TS3ApiAsync.addServerGroup(String name)
Creates a new server group for clients using a given name and returns its ID.
|
CommandFuture<Integer> |
TS3ApiAsync.addServerGroup(String name,
PermissionGroupDatabaseType type)
Creates a new server group using a given name and returns its ID.
|
CommandFuture<Void> |
TS3ApiAsync.addServerGroupPermission(int groupId,
String permName,
int value,
boolean negated,
boolean skipped)
Adds a specified permission to a server group.
|
CommandFuture<CreatedQueryLogin> |
TS3ApiAsync.addServerQueryLogin(String loginName,
int clientDBId)
Creates a server query login with name
loginName for the client specified by clientDBId
on the currently selected virtual server and returns the password of the created login. |
CommandFuture<int[]> |
TS3ApiAsync.banClient(int clientId,
long timeInSeconds)
Bans a client with a given client ID for a given time.
|
CommandFuture<int[]> |
TS3ApiAsync.banClient(int clientId,
long timeInSeconds,
String reason)
Bans a client with a given client ID for a given time for the specified reason.
|
CommandFuture<int[]> |
TS3ApiAsync.banClient(int clientId,
String reason)
Bans a client with a given client ID permanently for the specified reason.
|
CommandFuture<int[]> |
TS3ApiAsync.banClients(int[] clientIds,
long timeInSeconds,
String reason,
boolean continueOnError)
Bans multiple clients by their client ID for a given time for the specified reason.
|
CommandFuture<Void> |
TS3ApiAsync.broadcast(String message)
Sends a text message to all clients on all virtual servers.
|
CommandFuture<Void> |
TS3ApiAsync.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. |
CommandFuture<Integer> |
TS3ApiAsync.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. |
CommandFuture<Integer> |
TS3ApiAsync.copyServerGroup(int sourceGroupId,
int targetGroupId,
PermissionGroupDatabaseType type)
Creates a copy of the server group specified by
sourceGroupId,
overwriting another server group specified by targetGroupId. |
CommandFuture<Integer> |
TS3ApiAsync.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. |
CommandFuture<Integer> |
TS3ApiAsync.createChannel(String name,
Map<ChannelProperty,String> options)
Creates a new channel with a given name using the given properties and returns its ID.
|
CommandFuture<Void> |
TS3ApiAsync.createFileDirectory(String directoryPath,
int channelId)
Creates a new directory on the file repository in the specified channel.
|
CommandFuture<Void> |
TS3ApiAsync.createFileDirectory(String directoryPath,
int channelId,
String channelPassword)
Creates a new directory on the file repository in the specified channel.
|
CommandFuture<CreatedVirtualServer> |
TS3ApiAsync.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.
|
CommandFuture<Snapshot> |
TS3ApiAsync.createServerSnapshot()
Creates a
Snapshot of the selected virtual server containing all settings,
groups and known client identities. |
CommandFuture<Void> |
TS3ApiAsync.deleteAllBans()
Deletes all active ban rules from the server.
|
CommandFuture<Void> |
TS3ApiAsync.deleteAllComplaints(int clientDBId)
Deletes all complaints about the client with specified database ID from the server.
|
CommandFuture<Void> |
TS3ApiAsync.deleteBan(int banId)
Deletes the ban rule with the specified ID from the server.
|
CommandFuture<Void> |
TS3ApiAsync.deleteChannel(int channelId)
Deletes an existing channel specified by its ID, kicking all clients out of the channel.
|
CommandFuture<Void> |
TS3ApiAsync.deleteChannel(int channelId,
boolean force)
Deletes an existing channel with a given ID.
|
CommandFuture<Void> |
TS3ApiAsync.deleteChannelClientPermission(int channelId,
int clientDBId,
String permName)
Removes a specified permission from a client in a specific channel.
|
CommandFuture<Void> |
TS3ApiAsync.deleteChannelGroup(int groupId)
Removes the channel group with the given ID.
|
CommandFuture<Void> |
TS3ApiAsync.deleteChannelGroup(int groupId,
boolean force)
Removes the channel group with the given ID.
|
CommandFuture<Void> |
TS3ApiAsync.deleteChannelGroupPermission(int groupId,
String permName)
Removes a permission from the channel group with the given ID.
|
CommandFuture<Void> |
TS3ApiAsync.deleteChannelPermission(int channelId,
String permName)
Removes a permission from the channel with the given ID.
|
CommandFuture<Void> |
TS3ApiAsync.deleteClientPermission(int clientDBId,
BPermissionType permName)
Removes a permission from a client.
|
CommandFuture<Void> |
TS3ApiAsync.deleteClientPermission(int clientDBId,
IPermissionType permName)
Removes a permission from a client.
|
CommandFuture<Void> |
TS3ApiAsync.deleteClientPermission(int clientDBId,
String permName)
Deprecated.
This method is no longer preferred for removing permissions from a client.
Use |
CommandFuture<Void> |
TS3ApiAsync.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. |
CommandFuture<Void> |
TS3ApiAsync.deleteCustomClientProperty(int clientDBId,
String key)
Removes the
key custom client property from a client. |
CommandFuture<Void> |
TS3ApiAsync.deleteDatabaseClientProperties(int clientDBId)
Removes all stored database information about the specified client.
|
CommandFuture<Void> |
TS3ApiAsync.deleteFile(String filePath,
int channelId)
Deletes a file or directory from the file repository in the specified channel.
|
CommandFuture<Void> |
TS3ApiAsync.deleteFile(String filePath,
int channelId,
String channelPassword)
Deletes a file or directory from the file repository in the specified channel.
|
CommandFuture<Void> |
TS3ApiAsync.deleteFiles(String[] filePaths,
int channelId)
Deletes multiple files or directories from the file repository in the specified channel.
|
CommandFuture<Void> |
TS3ApiAsync.deleteFiles(String[] filePaths,
int channelId,
String channelPassword)
Deletes multiple files or directories from the file repository in the specified channel.
|
CommandFuture<Void> |
TS3ApiAsync.deleteIcon(long iconId)
Deletes an icon from the icon directory in the file repository.
|
CommandFuture<Void> |
TS3ApiAsync.deleteIcons(long... iconIds)
Deletes multiple icons from the icon directory in the file repository.
|
CommandFuture<Void> |
TS3ApiAsync.deleteOfflineMessage(int messageId)
Deletes the offline message with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.deletePermissionFromAllServerGroups(ServerGroupType type,
String permName)
Removes a specified permission from all server groups of the type specified by
type on all virtual servers. |
CommandFuture<Void> |
TS3ApiAsync.deletePrivilegeKey(String token)
Deletes the privilege key with the given token.
|
CommandFuture<Void> |
TS3ApiAsync.deleteServer(int serverId)
Deletes the virtual server with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.deleteServerGroup(int groupId)
Deletes the server group with the specified ID, even if the server group still contains clients.
|
CommandFuture<Void> |
TS3ApiAsync.deleteServerGroup(int groupId,
boolean force)
Deletes a server group with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.deleteServerGroupPermission(int groupId,
String permName)
Removes a permission from the server group with the given ID.
|
CommandFuture<Void> |
TS3ApiAsync.deleteServerQueryLogin(int clientDBId)
Deletes the server query login with the specified client database ID.
|
CommandFuture<Void> |
TS3ApiAsync.deployServerSnapshot(Snapshot snapshot)
Restores the selected virtual servers configuration using the data from a
previously created server snapshot.
|
CommandFuture<Void> |
TS3ApiAsync.deployServerSnapshot(String snapshot)
Restores the configuration of the selected virtual server using the data from a
previously created server snapshot.
|
CommandFuture<Long> |
TS3ApiAsync.downloadFile(OutputStream dataOut,
String filePath,
int channelId)
Downloads a file from the file repository at a given path and channel
and writes the file's bytes to an open
OutputStream. |
CommandFuture<Long> |
TS3ApiAsync.downloadFile(OutputStream dataOut,
String filePath,
int channelId,
String channelPassword)
Downloads a file from the file repository at a given path and channel
and writes the file's bytes to an open
OutputStream. |
CommandFuture<byte[]> |
TS3ApiAsync.downloadFileDirect(String filePath,
int channelId)
Downloads a file from the file repository at a given path and channel
and returns the file's bytes as a byte array.
|
CommandFuture<byte[]> |
TS3ApiAsync.downloadFileDirect(String filePath,
int channelId,
String channelPassword)
Downloads a file from the file repository at a given path and channel
and returns the file's bytes as a byte array.
|
CommandFuture<Long> |
TS3ApiAsync.downloadIcon(OutputStream dataOut,
long iconId)
Downloads an icon from the icon directory in the file repository
and writes the file's bytes to an open
OutputStream. |
CommandFuture<byte[]> |
TS3ApiAsync.downloadIconDirect(long iconId)
Downloads an icon from the icon directory in the file repository
and returns the file's bytes as a byte array.
|
CommandFuture<Void> |
TS3ApiAsync.editChannel(int channelId,
ChannelProperty property,
String value)
Changes a single property of the given channel.
|
CommandFuture<Void> |
TS3ApiAsync.editChannel(int channelId,
Map<ChannelProperty,String> options)
Changes a channel's configuration using the given properties.
|
CommandFuture<Void> |
TS3ApiAsync.editClient(int clientId,
ClientProperty property,
String value)
Changes a single property of the given client.
|
CommandFuture<Void> |
TS3ApiAsync.editClient(int clientId,
Map<ClientProperty,String> options)
Changes a client's configuration using given properties.
|
CommandFuture<Void> |
TS3ApiAsync.editDatabaseClient(int clientDBId,
Map<ClientProperty,String> options)
Changes a client's database settings using given properties.
|
CommandFuture<Void> |
TS3ApiAsync.editInstance(ServerInstanceProperty property,
String value)
Changes the server instance configuration using given properties.
|
CommandFuture<Void> |
TS3ApiAsync.editServer(Map<VirtualServerProperty,String> options)
Changes the configuration of the selected virtual server using given properties.
|
CommandFuture<List<Ban>> |
TS3ApiAsync.getBans()
Gets a list of all bans on the selected virtual server.
|
CommandFuture<List<Binding>> |
TS3ApiAsync.getBindings()
Gets a list of IP addresses used by the server instance.
|
CommandFuture<Channel> |
TS3ApiAsync.getChannelByNameExact(String name,
boolean ignoreCase)
Finds and returns the channel matching the given name exactly.
|
CommandFuture<List<Permission>> |
TS3ApiAsync.getChannelClientPermissions(int channelId,
int clientDBId)
Displays a list of permissions defined for a client in a specific channel.
|
CommandFuture<List<ChannelGroupClient>> |
TS3ApiAsync.getChannelGroupClients(int channelId,
int clientDBId,
int groupId)
Gets all client / channel ID combinations currently assigned to channel groups.
|
CommandFuture<List<ChannelGroupClient>> |
TS3ApiAsync.getChannelGroupClientsByChannelGroupId(int groupId)
Gets all client / channel ID combinations currently assigned to the specified channel group.
|
CommandFuture<List<ChannelGroupClient>> |
TS3ApiAsync.getChannelGroupClientsByChannelId(int channelId)
Gets all channel group assignments in the specified channel.
|
CommandFuture<List<ChannelGroupClient>> |
TS3ApiAsync.getChannelGroupClientsByClientDBId(int clientDBId)
Gets all channel group assignments for the specified client.
|
CommandFuture<List<Permission>> |
TS3ApiAsync.getChannelGroupPermissions(int groupId)
Gets a list of all permissions assigned to the specified channel group.
|
CommandFuture<List<ChannelGroup>> |
TS3ApiAsync.getChannelGroups()
Gets a list of all channel groups on the selected virtual server.
|
CommandFuture<ChannelInfo> |
TS3ApiAsync.getChannelInfo(int channelId)
Gets detailed configuration information about the channel specified channel.
|
CommandFuture<List<Permission>> |
TS3ApiAsync.getChannelPermissions(int channelId)
Gets a list of all permissions assigned to the specified channel.
|
CommandFuture<List<Channel>> |
TS3ApiAsync.getChannels()
Gets a list of all channels on the selected virtual server.
|
CommandFuture<List<Channel>> |
TS3ApiAsync.getChannelsByName(String name)
Gets a list of channels whose names contain the given search string.
|
CommandFuture<Client> |
TS3ApiAsync.getClientByNameExact(String name,
boolean ignoreCase)
Finds and returns the client whose nickname matches the given name exactly.
|
CommandFuture<ClientInfo> |
TS3ApiAsync.getClientByUId(String clientUId)
Gets information about the client with the specified unique identifier.
|
CommandFuture<ClientInfo> |
TS3ApiAsync.getClientInfo(int clientId)
Gets information about the client with the specified client ID.
|
CommandFuture<List<Permission>> |
TS3ApiAsync.getClientPermissions(int clientDBId)
Gets a list of all permissions assigned to the specified client.
|
CommandFuture<List<Client>> |
TS3ApiAsync.getClients()
Gets a list of all clients on the selected virtual server.
|
CommandFuture<List<Client>> |
TS3ApiAsync.getClientsByName(String name)
Gets a list of clients whose nicknames contain the given search string.
|
CommandFuture<List<Complaint>> |
TS3ApiAsync.getComplaints()
Gets a list of all complaints on the selected virtual server.
|
CommandFuture<List<Complaint>> |
TS3ApiAsync.getComplaints(int clientDBId)
Gets a list of all complaints about the specified client.
|
CommandFuture<ConnectionInfo> |
TS3ApiAsync.getConnectionInfo()
Gets detailed connection information about the selected virtual server.
|
CommandFuture<Map<String,String>> |
TS3ApiAsync.getCustomClientProperties(int clientDBId)
Gets a map of all custom client properties and their values
assigned to the client with database ID
clientDBId. |
CommandFuture<DatabaseClientInfo> |
TS3ApiAsync.getDatabaseClientByUId(String clientUId)
Gets information about the client with the specified unique identifier in the server database.
|
CommandFuture<DatabaseClientInfo> |
TS3ApiAsync.getDatabaseClientInfo(int clientDBId)
Gets information about the client with the specified database ID in the server database.
|
CommandFuture<List<DatabaseClient>> |
TS3ApiAsync.getDatabaseClients()
Gets information about all clients in the server database.
|
CommandFuture<List<DatabaseClient>> |
TS3ApiAsync.getDatabaseClients(int offset,
int count)
Gets information about a set number of clients in the server database, starting at
offset. |
CommandFuture<List<DatabaseClientInfo>> |
TS3ApiAsync.getDatabaseClientsByName(String name)
Gets all clients in the database whose last nickname matches the specified name exactly.
|
CommandFuture<FileInfo> |
TS3ApiAsync.getFileInfo(String filePath,
int channelId)
Gets information about a file on the file repository in the specified channel.
|
CommandFuture<FileInfo> |
TS3ApiAsync.getFileInfo(String filePath,
int channelId,
String channelPassword)
Gets information about a file on the file repository in the specified channel.
|
CommandFuture<List<FileInfo>> |
TS3ApiAsync.getFileInfos(String[] filePaths,
int channelId)
Gets information about multiple files on the file repository in the specified channel.
|
CommandFuture<List<FileInfo>> |
TS3ApiAsync.getFileInfos(String[] filePaths,
int[] channelIds,
String[] channelPasswords)
Gets information about multiple files on the file repository in multiple channels.
|
CommandFuture<List<FileInfo>> |
TS3ApiAsync.getFileInfos(String[] filePaths,
int channelId,
String channelPassword)
Gets information about multiple files on the file repository in the specified channel.
|
CommandFuture<List<FileListEntry>> |
TS3ApiAsync.getFileList(String directoryPath,
int channelId)
Gets a list of files and directories in the specified parent directory and channel.
|
CommandFuture<List<FileListEntry>> |
TS3ApiAsync.getFileList(String directoryPath,
int channelId,
String channelPassword)
Gets a list of files and directories in the specified parent directory and channel.
|
CommandFuture<List<FileTransfer>> |
TS3ApiAsync.getFileTransfers()
Gets a list of active or recently active file transfers.
|
CommandFuture<HostInfo> |
TS3ApiAsync.getHostInfo()
Displays detailed configuration information about the server instance including
uptime, number of virtual servers online, traffic information, etc.
|
CommandFuture<List<IconFile>> |
TS3ApiAsync.getIconList()
Gets a list of all icon files on this virtual server.
|
CommandFuture<InstanceInfo> |
TS3ApiAsync.getInstanceInfo()
Displays the server instance configuration including database revision number,
the file transfer port, default group IDs, etc.
|
CommandFuture<List<String>> |
TS3ApiAsync.getInstanceLogEntries()
Fetches the last 100 log entries from the server log.
|
CommandFuture<List<String>> |
TS3ApiAsync.getInstanceLogEntries(int lines)
Fetches the specified amount of log entries from the server log.
|
CommandFuture<String> |
TS3ApiAsync.getOfflineMessage(int messageId)
Reads the message body of a message.
|
CommandFuture<String> |
TS3ApiAsync.getOfflineMessage(Message message)
Reads the message body of a message.
|
CommandFuture<List<Message>> |
TS3ApiAsync.getOfflineMessages()
Gets a list of all offline messages for the server query.
|
CommandFuture<List<PermissionAssignment>> |
TS3ApiAsync.getPermissionAssignments(String permName)
Displays detailed information about all assignments of the permission specified
with
permName. |
CommandFuture<Integer> |
TS3ApiAsync.getPermissionIdByName(String permName)
Gets the ID of the permission specified by
permName. |
CommandFuture<int[]> |
TS3ApiAsync.getPermissionIdsByName(String... permNames)
Gets the IDs of the permissions specified by
permNames. |
CommandFuture<List<PermissionAssignment>> |
TS3ApiAsync.getPermissionOverview(int channelId,
int clientDBId)
Gets a list of all assigned permissions for a client in a specified channel.
|
CommandFuture<List<PermissionInfo>> |
TS3ApiAsync.getPermissions()
Displays a list of all permissions, including ID, name and description.
|
CommandFuture<Integer> |
TS3ApiAsync.getPermissionValue(String permName)
Displays the current value of the specified permission for this server query instance.
|
CommandFuture<int[]> |
TS3ApiAsync.getPermissionValues(String... permNames)
Displays the current values of the specified permissions for this server query instance.
|
CommandFuture<List<PrivilegeKey>> |
TS3ApiAsync.getPrivilegeKeys()
Gets a list of all available tokens to join channel or server groups,
including their type and group IDs.
|
CommandFuture<List<ServerGroupClient>> |
TS3ApiAsync.getServerGroupClients(int serverGroupId)
Gets a list of all clients in the specified server group.
|
CommandFuture<List<ServerGroupClient>> |
TS3ApiAsync.getServerGroupClients(ServerGroup serverGroup)
Gets a list of all clients in the specified server group.
|
CommandFuture<List<Permission>> |
TS3ApiAsync.getServerGroupPermissions(int serverGroupId)
Gets a list of all permissions assigned to the specified server group.
|
CommandFuture<List<Permission>> |
TS3ApiAsync.getServerGroupPermissions(ServerGroup serverGroup)
Gets a list of all permissions assigned to the specified server group.
|
CommandFuture<List<ServerGroup>> |
TS3ApiAsync.getServerGroups()
Gets a list of all server groups on the virtual server.
|
CommandFuture<List<ServerGroup>> |
TS3ApiAsync.getServerGroupsByClient(Client client)
Gets a list of all server groups set for a client.
|
CommandFuture<List<ServerGroup>> |
TS3ApiAsync.getServerGroupsByClientId(int clientDatabaseId)
Gets a list of all server groups set for a client.
|
CommandFuture<Integer> |
TS3ApiAsync.getServerIdByPort(int port)
Gets the ID of a virtual server by its port.
|
CommandFuture<VirtualServerInfo> |
TS3ApiAsync.getServerInfo()
Gets detailed information about the virtual server the server query is currently in.
|
CommandFuture<List<QueryLogin>> |
TS3ApiAsync.getServerQueryLogins()
Gets a list of all server query logins (containing login name, virtual server ID, and client database ID).
|
CommandFuture<List<QueryLogin>> |
TS3ApiAsync.getServerQueryLoginsByName(String pattern)
Gets a list of all server query logins (containing login name, virtual server ID, and client database ID)
whose login name matches the specified SQL-like pattern.
|
CommandFuture<Version> |
TS3ApiAsync.getVersion()
Gets the version, build number and platform of the TeamSpeak3 server.
|
CommandFuture<List<String>> |
TS3ApiAsync.getVirtualServerLogEntries()
Fetches the last 100 log entries from the currently selected virtual server.
|
CommandFuture<List<String>> |
TS3ApiAsync.getVirtualServerLogEntries(int lines)
Fetches the specified amount of log entries from the currently selected virtual server.
|
CommandFuture<List<VirtualServer>> |
TS3ApiAsync.getVirtualServers()
Gets a list of all virtual servers including their ID, status, number of clients online, etc.
|
CommandFuture<Boolean> |
TS3ApiAsync.isClientOnline(int clientId)
Checks whether the client with the specified client ID is online.
|
CommandFuture<Boolean> |
TS3ApiAsync.isClientOnline(String clientUId)
Checks whether the client with the specified unique identifier is online.
|
CommandFuture<Void> |
TS3ApiAsync.kickClientFromChannel(Client... clients)
Kicks one or more clients from their current channels.
|
CommandFuture<Void> |
TS3ApiAsync.kickClientFromChannel(int... clientIds)
Kicks one or more clients from their current channels.
|
CommandFuture<Void> |
TS3ApiAsync.kickClientFromChannel(String message,
Client... clients)
Kicks one or more clients from their current channels for the specified reason.
|
CommandFuture<Void> |
TS3ApiAsync.kickClientFromChannel(String message,
int... clientIds)
Kicks one or more clients from their current channels for the specified reason.
|
CommandFuture<Void> |
TS3ApiAsync.kickClientFromServer(Client... clients)
Kicks one or more clients from the server.
|
CommandFuture<Void> |
TS3ApiAsync.kickClientFromServer(int... clientIds)
Kicks one or more clients from the server.
|
CommandFuture<Void> |
TS3ApiAsync.kickClientFromServer(String message,
Client... clients)
Kicks one or more clients from the server for the specified reason.
|
CommandFuture<Void> |
TS3ApiAsync.kickClientFromServer(String message,
int... clientIds)
Kicks one or more clients from the server for the specified reason.
|
CommandFuture<Void> |
TS3ApiAsync.login(String username,
String password)
Logs the server query in using the specified username and password.
|
CommandFuture<Void> |
TS3ApiAsync.logout()
Logs the server query out and deselects the current virtual server.
|
CommandFuture<Void> |
TS3ApiAsync.moveChannel(int channelId,
int channelTargetId)
Moves a channel to a new parent channel specified by its ID.
|
CommandFuture<Void> |
TS3ApiAsync.moveChannel(int channelId,
int channelTargetId,
int order)
Moves a channel to a new parent channel specified by its ID.
|
CommandFuture<Void> |
TS3ApiAsync.moveClient(Client client,
ChannelBase channel)
Moves a single client into a channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveClient(Client client,
ChannelBase channel,
String channelPassword)
Moves a single client into a channel using the specified password.
|
CommandFuture<Void> |
TS3ApiAsync.moveClient(int clientId,
int channelId)
Moves a single client into a channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveClient(int clientId,
int channelId,
String channelPassword)
Moves a single client into a channel using the specified password.
|
CommandFuture<Void> |
TS3ApiAsync.moveClients(Client[] clients,
ChannelBase channel)
Moves multiple clients into a channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveClients(Client[] clients,
ChannelBase channel,
String channelPassword)
Moves multiple clients into a channel using the specified password.
|
CommandFuture<Void> |
TS3ApiAsync.moveClients(int[] clientIds,
int channelId)
Moves multiple clients into a channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveClients(int[] clientIds,
int channelId,
String channelPassword)
Moves multiple clients into a channel using the specified password.
|
CommandFuture<Void> |
TS3ApiAsync.moveFile(String oldPath,
String newPath,
int channelId)
Moves and renames a file on the file repository within the same channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveFile(String oldPath,
String newPath,
int oldChannelId,
int newChannelId)
Renames a file on the file repository and moves it to a new path in a different channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveFile(String oldPath,
String newPath,
int channelId,
String channelPassword)
Moves and renames a file on the file repository within the same channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveFile(String oldPath,
String newPath,
int oldChannelId,
String oldPassword,
int newChannelId,
String newPassword)
Renames a file on the file repository and moves it to a new path in a different channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveQuery(ChannelBase channel)
Moves the server query into a channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveQuery(ChannelBase channel,
String channelPassword)
Moves the server query into a channel using the specified password.
|
CommandFuture<Void> |
TS3ApiAsync.moveQuery(int channelId)
Moves the server query into a channel.
|
CommandFuture<Void> |
TS3ApiAsync.moveQuery(int channelId,
String channelPassword)
Moves the server query into a channel using the specified password.
|
CommandFuture<Void> |
TS3ApiAsync.pokeClient(int clientId,
String message)
Pokes the client with the specified client ID.
|
CommandFuture<Void> |
TS3ApiAsync.registerAllEvents()
Registers the server query to receive notifications about all server events.
|
CommandFuture<Void> |
TS3ApiAsync.registerEvent(TS3EventType eventType)
Registers the server query to receive notifications about a given event type.
|
CommandFuture<Void> |
TS3ApiAsync.registerEvent(TS3EventType eventType,
int channelId)
Registers the server query to receive notifications about a given event type.
|
CommandFuture<Void> |
TS3ApiAsync.registerEvents(TS3EventType... eventTypes)
Registers the server query to receive notifications about multiple given event types.
|
CommandFuture<Void> |
TS3ApiAsync.removeClientFromServerGroup(int serverGroupId,
int clientDatabaseId)
Removes the client specified by its database ID from the specified server group.
|
CommandFuture<Void> |
TS3ApiAsync.removeClientFromServerGroup(ServerGroup serverGroup,
Client client)
Removes the specified client from the specified server group.
|
CommandFuture<Void> |
TS3ApiAsync.renameChannelGroup(ChannelGroup channelGroup,
String name)
Renames the specified channel group.
|
CommandFuture<Void> |
TS3ApiAsync.renameChannelGroup(int channelGroupId,
String name)
Renames the channel group with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.renameServerGroup(int serverGroupId,
String name)
Renames the server group with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.renameServerGroup(ServerGroup serverGroup,
String name)
Renames the specified server group.
|
CommandFuture<String> |
TS3ApiAsync.resetPermissions()
Resets all permissions and deletes all server / channel groups.
|
CommandFuture<List<CustomPropertyAssignment>> |
TS3ApiAsync.searchCustomClientProperty(String key)
Finds all clients that have any value associated with the
key custom client property,
and returns the client's database ID and the key and value of the matching custom property. |
CommandFuture<List<CustomPropertyAssignment>> |
TS3ApiAsync.searchCustomClientProperty(String key,
String valuePattern)
Finds all clients whose value associated with the
key custom client property matches the
SQL-like pattern valuePattern, and returns the client's database ID and the key and value
of the matching custom property. |
CommandFuture<Void> |
TS3ApiAsync.selectVirtualServer(VirtualServer server)
Moves the server query into the specified virtual server.
|
CommandFuture<Void> |
TS3ApiAsync.selectVirtualServer(VirtualServer server,
String nickname)
Moves the server query into the specified virtual server
and sets the server query's nickname.
|
CommandFuture<Void> |
TS3ApiAsync.selectVirtualServerById(int id)
Moves the server query into the virtual server with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.selectVirtualServerById(int id,
String nickname)
Moves the server query into the virtual server with the specified ID
and sets the server query's nickname.
|
CommandFuture<Void> |
TS3ApiAsync.selectVirtualServerByPort(int port)
Moves the server query into the virtual server with the specified voice port.
|
CommandFuture<Void> |
TS3ApiAsync.selectVirtualServerByPort(int port,
String nickname)
Moves the server query into the virtual server with the specified voice port
and sets the server query's nickname.
|
CommandFuture<Void> |
TS3ApiAsync.sendChannelMessage(int channelId,
String message)
Sends a text message to the channel with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.sendChannelMessage(String message)
Sends a text message to the channel the server query is currently in.
|
CommandFuture<Void> |
TS3ApiAsync.sendOfflineMessage(String clientUId,
String subject,
String message)
Sends an offline message to the client with the given unique identifier.
|
CommandFuture<Void> |
TS3ApiAsync.sendPrivateMessage(int clientId,
String message)
Sends a private message to the client with the specified client ID.
|
CommandFuture<Void> |
TS3ApiAsync.sendServerMessage(int serverId,
String message)
Sends a text message to the virtual server with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.sendServerMessage(String message)
Sends a text message to the virtual server the server query is currently in.
|
CommandFuture<Void> |
TS3ApiAsync.sendTextMessage(TextMessageTargetMode targetMode,
int targetId,
String message)
Sends a text message either to the whole virtual server, a channel or specific client.
|
CommandFuture<Void> |
TS3ApiAsync.setClientChannelGroup(int groupId,
int channelId,
int clientDBId)
Sets a channel group for a client in a specific channel.
|
CommandFuture<Void> |
TS3ApiAsync.setCustomClientProperties(int clientDBId,
Map<String,String> properties)
Sets the value of the multiple custom client properties for a client.
|
CommandFuture<Void> |
TS3ApiAsync.setCustomClientProperty(int clientDBId,
String key,
String value)
Sets the value of the
key custom client property for a client. |
CommandFuture<Void> |
TS3ApiAsync.setMessageRead(int messageId)
Sets the read flag to
true for a given message. |
CommandFuture<Void> |
TS3ApiAsync.setMessageRead(Message message)
Sets the read flag to
true for a given message. |
CommandFuture<Void> |
TS3ApiAsync.setMessageReadFlag(int messageId,
boolean read)
Sets the read flag for a given message.
|
CommandFuture<Void> |
TS3ApiAsync.setMessageReadFlag(Message message,
boolean read)
Sets the read flag for a given message.
|
CommandFuture<Void> |
TS3ApiAsync.setNickname(String nickname)
Sets the nickname of the server query client.
|
CommandFuture<Void> |
TS3ApiAsync.startServer(int serverId)
Starts the virtual server with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.startServer(VirtualServer virtualServer)
Starts the specified virtual server.
|
CommandFuture<Void> |
TS3ApiAsync.stopServer(int serverId)
Stops the virtual server with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.stopServer(int serverId,
String reason)
Stops the virtual server with the specified ID.
|
CommandFuture<Void> |
TS3ApiAsync.stopServer(VirtualServer virtualServer)
Stops the specified virtual server.
|
CommandFuture<Void> |
TS3ApiAsync.stopServer(VirtualServer virtualServer,
String reason)
Stops the specified virtual server.
|
CommandFuture<Void> |
TS3ApiAsync.stopServerProcess()
Stops the entire TeamSpeak 3 Server instance by shutting down the process.
|
CommandFuture<Void> |
TS3ApiAsync.stopServerProcess(String reason)
Stops the entire TeamSpeak 3 Server instance by shutting down the process.
|
CommandFuture<Void> |
TS3ApiAsync.unregisterAllEvents()
Unregisters the server query from receiving any event notifications.
|
CommandFuture<Void> |
TS3ApiAsync.updateClient(ClientProperty property,
String value)
Changes a single client property for this server query instance.
|
CommandFuture<Void> |
TS3ApiAsync.updateClient(Map<ClientProperty,String> options)
Updates several client properties for this server query instance.
|
CommandFuture<String> |
TS3ApiAsync.updateServerQueryLogin(String loginName)
Generates new login credentials for the currently connected server query instance, using the given name.
|
CommandFuture<Void> |
TS3ApiAsync.uploadFile(InputStream dataIn,
long dataLength,
String filePath,
boolean overwrite,
int channelId)
Uploads a file to the file repository at a given path and channel
by reading
dataLength bytes from an open InputStream. |
CommandFuture<Void> |
TS3ApiAsync.uploadFile(InputStream dataIn,
long dataLength,
String filePath,
boolean overwrite,
int channelId,
String channelPassword)
Uploads a file to the file repository at a given path and channel
by reading
dataLength bytes from an open InputStream. |
CommandFuture<Void> |
TS3ApiAsync.uploadFileDirect(byte[] data,
String filePath,
boolean overwrite,
int channelId)
Uploads a file that is already stored in memory to the file repository
at a given path and channel.
|
CommandFuture<Void> |
TS3ApiAsync.uploadFileDirect(byte[] data,
String filePath,
boolean overwrite,
int channelId,
String channelPassword)
Uploads a file that is already stored in memory to the file repository
at a given path and channel.
|
CommandFuture<Long> |
TS3ApiAsync.uploadIcon(InputStream dataIn,
long dataLength)
Uploads an icon to the icon directory in the file repository
by reading
dataLength bytes from an open InputStream. |
CommandFuture<Long> |
TS3ApiAsync.uploadIconDirect(byte[] data)
Uploads an icon that is already stored in memory to the icon directory
in the file repository.
|
CommandFuture<Void> |
TS3ApiAsync.usePrivilegeKey(PrivilegeKey privilegeKey)
Uses an existing privilege key to join a server or channel group.
|
CommandFuture<Void> |
TS3ApiAsync.usePrivilegeKey(String token)
Uses an existing privilege key to join a server or channel group.
|
CommandFuture<ServerQueryInfo> |
TS3ApiAsync.whoAmI()
Gets information about the current server query instance.
|
| Modifier and Type | Method and Description |
|---|---|
CommandFuture<V> |
CommandFuture.forwardFailure(CommandFuture<?> otherFuture)
Forwards a failure to another future by calling
fail(TS3Exception)
on that future with the error that caused this future to fail. |
CommandFuture<V> |
CommandFuture.forwardSuccess(CommandFuture<? super V> otherFuture)
Forwards a success to another future by calling
set(Object) on
that future with the value this future was set to. |
static <V> CommandFuture<V> |
CommandFuture.immediate(V value)
Returns a new
CommandFuture that already has a value set. |
<F> CommandFuture<F> |
CommandFuture.map(Function<? super V,? extends F> fn)
Creates a new
CommandFuture that succeeds with fn(result)
if the original future succeeded with a value result, and fails
if the original future failed or if the mapping function fn threw
an exception. |
static <F> CommandFuture<List<F>> |
CommandFuture.ofAll(Collection<CommandFuture<F>> futures)
Combines a collection of
CommandFutures into a single future, which will
succeed if all futures succeed and fail as soon as one future fails. |
static <F> CommandFuture<List<F>> |
CommandFuture.ofAll(CommandFuture<F>... futures)
Combines multiple
CommandFutures into a single future, which will
succeed if all futures succeed and fail as soon as one future fails. |
static <F> CommandFuture<F> |
CommandFuture.ofAny(Collection<CommandFuture<F>> futures)
Combines a collection of
CommandFutures into a single future, which will
succeed as soon as one of the futures succeeds and fail if all futures fail. |
static <F> CommandFuture<F> |
CommandFuture.ofAny(CommandFuture<F>... futures)
Combines multiple
CommandFutures into a single future, which will
succeed if any of the futures succeeds and fail if all of the futures fail. |
CommandFuture<V> |
CommandFuture.onFailure(CommandFuture.FailureListener listener)
Sets a
CommandFuture.FailureListener which will be notified when this future
fails because of a error returned by the TeamSpeak server. |
CommandFuture<V> |
CommandFuture.onSuccess(CommandFuture.SuccessListener<? super V> listener)
Sets a
CommandFuture.SuccessListener which will be notified when this future
succeeded and a value has been set. |
<F> CommandFuture<F> |
CommandFuture.then(Function<? super V,CommandFuture<F>> fn)
Creates a new
CommandFuture that succeeds with the result value of
the CommandFuture returned by fn if both the original future
and the future returned by fn succeed. |
| Modifier and Type | Method and Description |
|---|---|
CommandFuture<V> |
CommandFuture.forwardFailure(CommandFuture<?> otherFuture)
Forwards a failure to another future by calling
fail(TS3Exception)
on that future with the error that caused this future to fail. |
void |
CommandFuture.forwardResult(CommandFuture<V> otherFuture)
Forwards both a success as well as a failure to another
CommandFuture. |
CommandFuture<V> |
CommandFuture.forwardSuccess(CommandFuture<? super V> otherFuture)
Forwards a success to another future by calling
set(Object) on
that future with the value this future was set to. |
static <F> CommandFuture<List<F>> |
CommandFuture.ofAll(CommandFuture<F>... futures)
Combines multiple
CommandFutures into a single future, which will
succeed if all futures succeed and fail as soon as one future fails. |
static <F> CommandFuture<F> |
CommandFuture.ofAny(CommandFuture<F>... futures)
Combines multiple
CommandFutures into a single future, which will
succeed if any of the futures succeeds and fail if all of the futures fail. |
| Modifier and Type | Method and Description |
|---|---|
static <F> CommandFuture<List<F>> |
CommandFuture.ofAll(Collection<CommandFuture<F>> futures)
Combines a collection of
CommandFutures into a single future, which will
succeed if all futures succeed and fail as soon as one future fails. |
static <F> CommandFuture<F> |
CommandFuture.ofAny(Collection<CommandFuture<F>> futures)
Combines a collection of
CommandFutures into a single future, which will
succeed as soon as one of the futures succeeds and fail if all futures fail. |
<F> CommandFuture<F> |
CommandFuture.then(Function<? super V,CommandFuture<F>> fn)
Creates a new
CommandFuture that succeeds with the result value of
the CommandFuture returned by fn if both the original future
and the future returned by fn succeed. |
| Modifier and Type | Method and Description |
|---|---|
CommandFuture<DefaultArrayResponse> |
Command.getFuture() |
Released under the MIT license.