Adds a client to a server group.
The client to add.
The server group to add the client to.
Deletes the database properties of a client.
The ID of the client.
A promise that resolves when the database properties have been deleted.
Edits a client.
The client to edit.
The new client data.
The updated client.
Obtains a client from TeamSpeak, or the cache if it's available.
The client to fetch.
Optional
options: BaseFetchOptionsThe options for fetching the client.
The client.
Fetches the server groups a client is in.
The client to fetch server groups for.
A promise that resolves to a collection of server groups.
Kicks a client from the current channel.
The client to kick.
Optional
reason: stringThe reason for the kick.
A promise that resolves when the client has been kicked.
Kicks a client from the server.
The client to kick.
Optional
reason: stringThe reason for the kick.
A promise that resolves when the client has been kicked.
Moves a client to a different channel.
The client to move.
The channel to move the client to.
Optional
channelPassword: stringThe password for the channel, if required.
A promise that resolves to the moved client.
Pokes a client.
The client to poke.
The content of the poke.
A promise that resolves when the poke has been sent.
Removes a client from a server group.
The client to remove.
The server group to remove the client from.
Resolves a client ID.
The object to resolve.
The client ID.
Searches for clients based on the client nickname.
The search query.
The found clients.
Searches for clients based on the client nickname or unique ID.
Supports SQL-like pattern matching with "%"
The options for searching the client.
The nickname to search for.
Optional
uniqueId?: undefinedOptional
nickname?: undefinedThe unique ID to search for.
The found clients database IDs
Sends a message to a client.
The client to send the message to.
The content of the message.
A promise that resolves when the message has been sent.
Sets a channel group for a client in a channel.
The client to set the channel group for.
The channel to set the channel group for.
The channel group to set for the client.
A promise that resolves when the channel group has been set.
Manages the clients in the TeamSpeak server.