| Package | Description |
|---|---|
| com.github.theholywaffle.teamspeak3 | |
| com.github.theholywaffle.teamspeak3.api |
| 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<Boolean> |
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<Boolean> |
TS3ApiAsync.addChannelGroupPermission(int groupId,
String permName,
int permValue)
Adds a specified permission to a channel group.
|
CommandFuture<Boolean> |
TS3ApiAsync.addChannelPermission(int channelId,
String permName,
int permValue)
Adds a specified permission to a channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.addClientPermission(int clientDBId,
String permName,
int value,
boolean skipped)
Adds a specified permission to a channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.addClientToServerGroup(int groupId,
int clientDatabaseId)
Adds a client to the specified server group.
|
CommandFuture<Boolean> |
TS3ApiAsync.addComplaint(int clientDBId,
String message)
Submits a complaint about the specified client.
|
CommandFuture<Boolean> |
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(TokenType 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<Boolean> |
TS3ApiAsync.addServerGroupPermission(int groupId,
String permName,
int value,
boolean negated,
boolean skipped)
Adds a specified permission to a server group.
|
CommandFuture<Integer[]> |
TS3ApiAsync.banClient(int clientId,
long timeInSeconds)
Bans a client with a given client ID for a given time.
|
CommandFuture<Integer[]> |
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<Integer[]> |
TS3ApiAsync.banClient(int clientId,
String reason)
Bans a client with a given client ID permanently for the specified reason.
|
CommandFuture<Boolean> |
TS3ApiAsync.broadcast(String message)
Sends a text message to all clients on all virtual servers.
|
CommandFuture<Boolean> |
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<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<Boolean> |
TS3ApiAsync.deleteAllBans()
Deletes all active ban rules from the server.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteAllComplaints(int clientDBId)
Deletes all complaints about the client with specified database ID from the server.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteBan(int banId)
Deletes the ban rule with the specified ID from the server.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteChannel(int channelId)
Deletes an existing channel specified by its ID, kicking all clients out of the channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteChannel(int channelId,
boolean force)
Deletes an existing channel with a given ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteChannelClientPermission(int channelId,
int clientDBId,
String permName)
Removes a specified permission from a client in a specific channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteChannelGroup(int groupId)
Removes the channel group with the given ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteChannelGroup(int groupId,
boolean force)
Removes the channel group with the given ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteChannelGroupPermission(int groupId,
String permName)
Removes a permission from the channel group with the given ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteChannelPermission(int channelId,
String permName)
Removes a permission from the channel with the given ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteClientPermission(int clientDBId,
String permName)
Removes a permission from a client.
|
CommandFuture<Boolean> |
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<Boolean> |
TS3ApiAsync.deleteDatabaseClientProperties(int clientDBId)
Removes all stored database information about the specified client.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteOfflineMessage(int messageId)
Deletes the offline message with the specified ID.
|
CommandFuture<Boolean> |
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<Boolean> |
TS3ApiAsync.deletePrivilegeKey(String token)
Deletes the privilege key with the given token.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteServer(int serverId)
Deletes the virtual server with the specified ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteServerGroup(int groupId)
Deletes the server group with the specified ID, even if the server group still contains clients.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteServerGroup(int groupId,
boolean force)
Deletes a server group with the specified ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.deleteServerGroupPermission(int groupId,
String permName)
Removes a permission from the server group with the given ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.deployServerSnapshot(Snapshot snapshot)
Restores the selected virtual servers configuration using the data from a
previously created server snapshot.
|
CommandFuture<Boolean> |
TS3ApiAsync.deployServerSnapshot(String snapshot)
Restores the configuration of the selected virtual server using the data from a
previously created server snapshot.
|
CommandFuture<Boolean> |
TS3ApiAsync.editChannel(int channelId,
Map<ChannelProperty,String> options)
Changes a channel's configuration using the given properties.
|
CommandFuture<Boolean> |
TS3ApiAsync.editClient(int clientId,
Map<ClientProperty,String> options)
Changes a client's configuration using given properties.
|
CommandFuture<Boolean> |
TS3ApiAsync.editDatabaseClient(int clientDBId,
Map<ClientProperty,String> options)
Changes a client's database settings using given properties.
|
CommandFuture<Boolean> |
TS3ApiAsync.editInstance(ServerInstanceProperty property,
String value)
Changes the server instance configuration using given properties.
|
CommandFuture<Boolean> |
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<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<HostInfo> |
TS3ApiAsync.getHostInfo()
Displays detailed configuration information about the server instance including
uptime, number of virtual servers online, traffic information, etc.
|
CommandFuture<InstanceInfo> |
TS3ApiAsync.getInstanceInfo()
Displays the server instance configuration including database revision number,
the file transfer port, default group IDs, etc.
|
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<AdvancedPermission>> |
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<List<AdvancedPermission>> |
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<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<Version> |
TS3ApiAsync.getVersion()
Gets the version, build number and platform of the TeamSpeak3 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.kickClientFromChannel(Client... clients)
Kicks one or more clients from their current channels.
|
CommandFuture<Boolean> |
TS3ApiAsync.kickClientFromChannel(int... clientIds)
Kicks one or more clients from their current channels.
|
CommandFuture<Boolean> |
TS3ApiAsync.kickClientFromChannel(String message,
Client... clients)
Kicks one or more clients from their current channels for the specified reason.
|
CommandFuture<Boolean> |
TS3ApiAsync.kickClientFromChannel(String message,
int... clientIds)
Kicks one or more clients from their current channels for the specified reason.
|
CommandFuture<Boolean> |
TS3ApiAsync.kickClientFromServer(Client... clients)
Kicks one or more clients from the server.
|
CommandFuture<Boolean> |
TS3ApiAsync.kickClientFromServer(int... clientIds)
Kicks one or more clients from the server.
|
CommandFuture<Boolean> |
TS3ApiAsync.kickClientFromServer(String message,
Client... clients)
Kicks one or more clients from the server for the specified reason.
|
CommandFuture<Boolean> |
TS3ApiAsync.kickClientFromServer(String message,
int... clientIds)
Kicks one or more clients from the server for the specified reason.
|
CommandFuture<Boolean> |
TS3ApiAsync.login(String username,
String password)
Logs the server query in using the specified username and password.
|
CommandFuture<Boolean> |
TS3ApiAsync.logout()
Logs the server query out and deselects the current virtual server.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveChannel(int channelId,
int channelTargetId)
Moves a channel to a new parent channel specified by its ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveChannel(int channelId,
int channelTargetId,
int order)
Moves a channel to a new parent channel specified by its ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveClient(ChannelBase channel)
Moves the server query into the specified channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveClient(ChannelBase channel,
String channelPassword)
Moves the server query into the specified channel using the specified password.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveClient(Client client,
ChannelBase channel)
Moves a client into the specified channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveClient(Client client,
ChannelBase channel,
String channelPassword)
Moves a client into the specified channel using the specified password.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveClient(int channelId)
Moves the server query into the specified channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveClient(int clientId,
int channelId)
Moves a client into the specified channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveClient(int clientId,
int channelId,
String channelPassword)
Moves a client into the specified channel using the specified password.
|
CommandFuture<Boolean> |
TS3ApiAsync.moveClient(int channelId,
String channelPassword)
Moves the server query into the specified channel using the specified password.
|
CommandFuture<Boolean> |
TS3ApiAsync.pokeClient(int clientId,
String message)
Pokes the client with the specified client ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.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(). |
CommandFuture<Boolean> |
TS3ApiAsync.registerAllEvents()
Registers the server query to receive notifications about all server events.
|
CommandFuture<Boolean> |
TS3ApiAsync.registerEvent(TS3EventType eventType)
Registers the server query to receive notifications about a given event type.
|
CommandFuture<Boolean> |
TS3ApiAsync.registerEvent(TS3EventType eventType,
int channelId)
Registers the server query to receive notifications about a given event type.
|
CommandFuture<Boolean> |
TS3ApiAsync.registerEvents(TS3EventType... eventTypes)
Registers the server query to receive notifications about multiple given event types.
|
CommandFuture<Boolean> |
TS3ApiAsync.removeClientFromServerGroup(int serverGroupId,
int clientDatabaseId)
Removes the client specified by its database ID from the specified server group.
|
CommandFuture<Boolean> |
TS3ApiAsync.removeClientFromServerGroup(ServerGroup serverGroup,
Client client)
Removes the specified client from the specified server group.
|
CommandFuture<Boolean> |
TS3ApiAsync.renameChannelGroup(ChannelGroup channelGroup,
String name)
Renames the specified channel group.
|
CommandFuture<Boolean> |
TS3ApiAsync.renameChannelGroup(int channelGroupId,
String name)
Renames the channel group with the specified ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.renameServerGroup(int serverGroupId,
String name)
Renames the server group with the specified ID.
|
CommandFuture<Boolean> |
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<Boolean> |
TS3ApiAsync.selectVirtualServer(VirtualServer server)
Moves the server query into the specified virtual server.
|
CommandFuture<Boolean> |
TS3ApiAsync.selectVirtualServerById(int id)
Moves the server query into the virtual server with the specified ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.selectVirtualServerByPort(int port)
Moves the server query into the virtual server with the specified voice port.
|
CommandFuture<Boolean> |
TS3ApiAsync.sendChannelMessage(int channelId,
String message)
Sends a text message to the channel with the specified ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.sendChannelMessage(String message)
Sends a text message to the channel the server query is currently in.
|
CommandFuture<Boolean> |
TS3ApiAsync.sendOfflineMessage(String clientUId,
String subject,
String message)
Sends an offline message to the client with the given unique identifier.
|
CommandFuture<Boolean> |
TS3ApiAsync.sendPrivateMessage(int clientId,
String message)
Sends a private message to the client with the specified client ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.sendServerMessage(int serverId,
String message)
Sends a text message to the virtual server with the specified ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.sendServerMessage(String message)
Sends a text message to the virtual server the server query is currently in.
|
CommandFuture<Boolean> |
TS3ApiAsync.sendTextMessage(TextMessageTargetMode targetMode,
int targetId,
String message)
Sends a text message either to the whole virtual server, a channel or specific client.
|
CommandFuture<Boolean> |
TS3ApiAsync.setClientChannelGroup(int groupId,
int channelId,
int clientDBId)
Sets a channel group for a client in a specific channel.
|
CommandFuture<Boolean> |
TS3ApiAsync.setMessageRead(int messageId)
Sets the read flag to true for a given message.
|
CommandFuture<Boolean> |
TS3ApiAsync.setMessageRead(Message message)
Sets the read flag to true for a given message.
|
CommandFuture<Boolean> |
TS3ApiAsync.setMessageReadFlag(int messageId,
boolean read)
Sets the read flag for a given message.
|
CommandFuture<Boolean> |
TS3ApiAsync.setMessageReadFlag(Message message,
boolean read)
Sets the read flag for a given message.
|
CommandFuture<Boolean> |
TS3ApiAsync.setNickname(String nickname)
Sets the nickname of the server query client.
|
CommandFuture<Boolean> |
TS3ApiAsync.startServer(int serverId)
Starts the virtual server with the specified ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.startServer(VirtualServer virtualServer)
Starts the specified virtual server.
|
CommandFuture<Boolean> |
TS3ApiAsync.stopServer(int serverId)
Stops the virtual server with the specified ID.
|
CommandFuture<Boolean> |
TS3ApiAsync.stopServer(VirtualServer virtualServer)
Stops the specified virtual server.
|
CommandFuture<Boolean> |
TS3ApiAsync.stopServerProcess()
Stops the entire TeamSpeak 3 Server instance by shutting down the process.
|
CommandFuture<Boolean> |
TS3ApiAsync.unregisterAllEvents()
Unregisters the server query from receiving any event notifications.
|
CommandFuture<Boolean> |
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<Boolean> |
TS3ApiAsync.usePrivilegeKey(PrivilegeKey privilegeKey)
Uses an existing privilege key to join a server or channel group.
|
CommandFuture<Boolean> |
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(QueryError)
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 <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. |
| Modifier and Type | Method and Description |
|---|---|
CommandFuture<V> |
CommandFuture.forwardFailure(CommandFuture<?> otherFuture)
Forwards a failure to another future by calling
fail(QueryError)
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. |
Copyright © 2015. All rights reserved.