Class Query

Represents a ServerQuery connection.

Hierarchy

AsyncEventEmitter<EventTypes>
- Query

Index

Constructors

Properties

actions bans channelGroups channels client clients commands instance notifications permissions privilegeKeys serverGroups transport virtualServers

Methods

addLog connect createRawApiKey createRawComplain createRawPrivilegeKey createRawQueryLogin createRawServerSnapshot createRawServerTempPassword deleteRawApiKey deleteRawComplain deleteRawComplains deleteRawPrivilegeKey deleteRawQueryLogin deleteRawServerTempPassword deployRawServerSnapshot destroy fetchHostInfo fetchInstance fetchLogs fetchServerVersion getRawApiKeys getRawBindings getRawChannelPermissions getRawClientDatabaseIdFromUniqueId getRawClientDatabaseProperties getRawClientIds getRawClientNameFromDatabaseId getRawClientNameFromUniqueId getRawClientPermissions getRawClientUniqueIdFromClientId getRawComplains getRawDbClients getRawHostInfo getRawPermissions getRawPrivilegeKeys getRawQueryLogins getRawServerConnectionInfo getRawServerIdByPort getRawServerInfo getRawServerTempPasswords getRawServerVersion login logout sendChannelMessage sendHostMessage sendServerMessage stopServerProcess updateLoginCredentials useRawPrivilegeKey useVirtualServer useVirtualServerByPort

Constructors

constructor

new Query(options: ClientOptions): Query
Parameters
- options: ClientOptions
Returns Query
Overrides AsyncEventEmitter<EventTypes>.constructor
- Defined in query.ts:144

Properties

actions

actions: ActionManager = ...

The Action Manager of the Query instance.

bans

bans: BanManager = ...

The Ban Manager of the Query instance.

channelGroups

channelGroups: ChannelGroupManager = ...

The Channel Group Manager of the Query instance.

channels

channels: ChannelManager = ...

The Channel Manager of the Query instance.

client

client: QueryClient = ...

The Query Client of the Query instance. Will be null until the client is logged in.

clients

clients: ClientManager = ...

The Client Manager of the Query instance.

commands

commands: CommandManager = ...

The Command Manager of the Query instance.

instance

instance: Instance = ...

The Instance of the Query instance. Needs to be fetched first using fetchInstance().

notifications

notifications: NotificationManager = ...

The Notification Manager of the Query instance.

permissions

permissions: PermissionManager = ...

The Permission Manager of the Query instance.

privilegeKeys

privilegeKeys: PrivilegeKeyManager = ...

The Privilege Key Manager of the Query instance.

serverGroups

serverGroups: ServerGroupManager = ...

The Server Group Manager of the Query instance.

transport

transport: Transport

virtualServers

virtualServers: VirtualServerManager = ...

The Virtual Server Manager of the Query instance.

Methods

addLog

addLog(level: LogLevel, message: string): Promise<void>
Parameters
- level: LogLevel
- message: string
Returns Promise<void>
- Defined in query.ts:370

connect

connect(timeoutMs?: number): Promise<void>
Connect to the Host and wait until the ServerQuery welcome message is received. Resolves when the underlying transport emits 'ready'.
Parameters
- timeoutMs: number = 15000
Returns Promise<void>
- Defined in query.ts:195

createRawApiKey

createRawApiKey(
    __namedParameters: {
        cldbid?: number;
        lifetime?: number;
        scope: ApiKeyScope;
    },
): Promise<RawApiKey>
Create a new API key.

scope: Scope of the API key (required).

lifetime: Lifetime in days (optional, default: 14). Use 0 for no expiration.

cldbid: Client Database ID of the client the key should be assigned to (optional). Otherwise, the invoker will be used.
Parameters
- __namedParameters: { cldbid?: number; lifetime?: number; scope: ApiKeyScope }
Returns Promise<RawApiKey>
- Defined in query.ts:525

createRawComplain

createRawComplain(tcldbid: number, message: string): Promise<void>
Create a new complain.
Parameters
- tcldbid: number
  The client database ID of the complained about client.
- message: string
  The message of the complain.
Returns Promise<void>
- Defined in query.ts:588

createRawPrivilegeKey

createRawPrivilegeKey(
    params: {
        customset?: string;
        tokendescription?: string;
        tokenid1: number;
        tokenid2: number;
        tokentype: number;
    },
): Promise<string>
Create a new privilege key.

tokentype: 0 = group, 1 = channel

tokenid1: Group ID

tokenid2: Channel ID (if tokentype is 1). Must be set to 0 if tokentype is 0.

tokendescription: Description of the privilege key (optional)

customset: Custom set of the privilege key (optional)
Parameters
- params: {
      customset?: string;
      tokendescription?: string;
      tokenid1: number;
      tokenid2: number;
      tokentype: number;
  }
  The parameters for the privilege key.
Returns Promise<string>
The created privilege key.

Deprecated
Please use Query.privilegeKeys.create() instead.
- Defined in query.ts:741

createRawQueryLogin

createRawQueryLogin(
loginName: string,
clientDatabaseId: number,
): Promise<RawQueryLoginAdd>
Create a new query login for the current virtual server. If no virtual server is selected, the login will be created globally.
Parameters
- loginName: string
  The name of the query login.
- clientDatabaseId: number
  The ID of the client to login as.
Returns Promise<RawQueryLoginAdd>
- Defined in query.ts:777

createRawServerSnapshot

createRawServerSnapshot(): Promise<RawServerSnapshot>
Create a new server snapshot.

Returns Promise<RawServerSnapshot>
- Defined in query.ts:612

createRawServerTempPassword

createRawServerTempPassword(
    params: {
        desc: string;
        duration: number;
        pw: string;
        tcid?: string;
        tcpw?: string;
    },
): Promise<void>
Create a new server temporary password.
Parameters
- params: { desc: string; duration: number; pw: string; tcid?: string; tcpw?: string }
  The parameters for the server temporary password.
  
  pw: The password to create.
  
  desc: The description of the server temporary password.
  
  duration: The duration of the server temporary password IN SECONDS.
  
  tcid: The channel ID to create the server temporary password for. (optional, defaults to the default channel)
  
  tcpw: The channel password to create the server temporary password for. (optional)
Returns Promise<void>
- Defined in query.ts:813

deleteRawApiKey

deleteRawApiKey(id: number): Promise<void>
Delete an API key by its ID.
Parameters
- id: number
  The ID of the API key to delete.
Returns Promise<void>
- Defined in query.ts:571

deleteRawComplain

deleteRawComplain(tcldbid: number, fcldbid: number): Promise<void>
Delete a complain by its IDs.
Parameters
- tcldbid: number
  The client database ID of the complained about client.
- fcldbid: number
  The client database ID of the complainee.
Returns Promise<void>
- Defined in query.ts:597

deleteRawComplains

deleteRawComplains(tcldbid: number): Promise<void>
Delete all complains by the complainee's ID.
Parameters
- tcldbid: number
  The client database ID of the complained about client.
Returns Promise<void>
- Defined in query.ts:605

deleteRawPrivilegeKey

deleteRawPrivilegeKey(token: string): Promise<void>
Delete a privilege key by its token.
Parameters
- token: string
  The token of the privilege key to delete.
Returns Promise<void>
Deprecated
Please use Query.privilegeKeys.delete() or Query.privilegeKeys.deleteByToken() instead.
- Defined in query.ts:758

deleteRawQueryLogin

deleteRawQueryLogin(clientDatabaseId: number): Promise<void>
Delete a query login by its client database ID.
Parameters
- clientDatabaseId: number
  The ID of the client to delete the login for.
Returns Promise<void>
- Defined in query.ts:788

deleteRawServerTempPassword

deleteRawServerTempPassword(pw: string): Promise<void>
Delete a server temporary password by its password.
Parameters
- pw: string
  The password of the server temporary password to delete.
Returns Promise<void>
- Defined in query.ts:827

deployRawServerSnapshot

deployRawServerSnapshot(
    version: number,
    data: string,
    __namedParameters?: {
        _keepfiles?: true;
        _mapping?: true;
        password?: string;
        salt?: string;
    },
): Promise<unknown>
Deploy a server snapshot.
Parameters
- version: number
  The version of the server snapshot.
- data: string
  The data of the server snapshot.
- __namedParameters: { _keepfiles?: true; _mapping?: true; password?: string; salt?: string } = {}
Returns Promise<unknown>
- Defined in query.ts:621

destroy

destroy(): void
Close the connection and destroy the Query instance.

Returns void
- Defined in query.ts:238

fetchHostInfo

fetchHostInfo(): Promise<HostInfo>
Returns Promise<HostInfo>
- Defined in query.ts:403

fetchInstance

fetchInstance(): Promise<Instance>
Returns Promise<Instance>
- Defined in query.ts:363

fetchLogs

fetchLogs(): Promise<
    {
        level: string;
        message: string;
        module: string;
        timestamp: Date;
        virtualServerId: number;
    }[],
>
Returns Promise<
    {
        level: string;
        message: string;
        module: string;
        timestamp: Date;
        virtualServerId: number;
    }[],
>
- Defined in query.ts:374

fetchServerVersion

fetchServerVersion(): Promise<ServerVersion>
Returns Promise<ServerVersion>
- Defined in query.ts:394

getRawApiKeys

getRawApiKeys(
    __namedParameters: {
        cldbid: number | "*";
        count?: true;
        duration?: number;
        start?: number;
    },
): Promise<RawApiKey | RawApiKey[]>
Get a list of API keys.

cldbid: Client Database ID or "*" to get all keys.

start: Starting index (optional, default: 0).

duration: Maximum number of keys to return (optional, default: 100).

count: Include total count (optional, default: false).
Parameters
- __namedParameters: { cldbid: number | "*"; count?: true; duration?: number; start?: number }
Returns Promise<RawApiKey | RawApiKey[]>
- Defined in query.ts:548

getRawBindings

getRawBindings(
subsystem?: "query" | "voice" | "filetransfer",
): Promise<RawBinding | RawBinding[]>
Get a list of bindings.
Parameters
- Optionalsubsystem: "query" | "voice" | "filetransfer"
  The subsystem of the binding.
Returns Promise<RawBinding | RawBinding[]>
- Defined in query.ts:645

getRawChannelPermissions

getRawChannelPermissions(
channelId: number,
): Promise<RawChannelPermission | RawChannelPermission[]>
Get a list of channel permissions.
Parameters
- channelId: number
  The ID of the channel.
Returns Promise<RawChannelPermission | RawChannelPermission[]>
- Defined in query.ts:699

getRawClientDatabaseIdFromUniqueId

getRawClientDatabaseIdFromUniqueId(uniqueId: string): Promise<RawClientDbid>
Get the raw client database ID from its unique identifier.
Parameters
- uniqueId: string
  The unique identifier of the client.
Returns Promise<RawClientDbid>
- Defined in query.ts:489

getRawClientDatabaseProperties

getRawClientDatabaseProperties(
clientDatabaseId: number,
): Promise<RawClientDbInfo>
Get a list of client database properties.
Parameters
- clientDatabaseId: number
  The ID of the client.
Returns Promise<RawClientDbInfo>
- Defined in query.ts:655

getRawClientIds

getRawClientIds(uniqueId: string): Promise<RawClientIdsItem | RawClientIds>
Get the client IDs and nicknames by their unique identifier.
Parameters
- uniqueId: string
  The unique identifier of the client.
Returns Promise<RawClientIdsItem | RawClientIds>
- Defined in query.ts:481

getRawClientNameFromDatabaseId

getRawClientNameFromDatabaseId(dbid: number): Promise<RawClientName>
Get the raw client name from its database ID.
Parameters
- dbid: number
  The database ID of the client.
Returns Promise<RawClientName>
- Defined in query.ts:505

getRawClientNameFromUniqueId

getRawClientNameFromUniqueId(uniqueId: string): Promise<RawClientName>
Get the raw client name from its unique identifier.
Parameters
- uniqueId: string
  The unique identifier of the client.
Returns Promise<RawClientName>
- Defined in query.ts:497

getRawClientPermissions

getRawClientPermissions(
clientDatabaseId: number,
): Promise<RawClientPermission | RawClientPermission[]>
Get a list of client permissions.
Parameters
- clientDatabaseId: number
  The ID of the client.
Returns Promise<RawClientPermission | RawClientPermission[]>
- Defined in query.ts:689

getRawClientUniqueIdFromClientId

getRawClientUniqueIdFromClientId(
clientId: number,
): Promise<RawClientUid | RawClientUid[]>
Get a list of client unique IDs from their client IDs.
Parameters
- clientId: number
  The ID of the client.
Returns Promise<RawClientUid | RawClientUid[]>
- Defined in query.ts:663

getRawComplains

getRawComplains(tcldbid?: number): Promise<RawComplain | RawComplain[]>
Get a list of complains.
Parameters
- Optionaltcldbid: number
  The client database ID of the complained about client. (optional, otherwise all complains will be returned)
Returns Promise<RawComplain | RawComplain[]>
- Defined in query.ts:579

getRawDbClients

getRawDbClients(
options?: { _count?: true; duration?: number; start?: number },
): Promise<RawDbClient | RawDbClient[]>
Get a list of database clients.
Parameters
- options: { _count?: true; duration?: number; start?: number } = {}
Returns Promise<RawDbClient | RawDbClient[]>
- Defined in query.ts:708

getRawHostInfo

getRawHostInfo(): Promise<RawHostInfo>
Get the raw ServerQuery host information.

Returns Promise<RawHostInfo>
Deprecated
Please use Query.fetchHostInfo() instead.
- Defined in query.ts:454

getRawPermissions

getRawPermissions(): Promise<RawPermission[]>
Get a list of permissions on the TeamSpeak 3 Server instance.

Returns Promise<RawPermission[]>
Deprecated
Please use Query.permissions.fetch() instead.
- Defined in query.ts:672

getRawPrivilegeKeys

getRawPrivilegeKeys(): Promise<RawPrivilegeKey | RawPrivilegeKey[]>
Get a list of privilege keys.

Returns Promise<RawPrivilegeKey | RawPrivilegeKey[]>
Deprecated
Please use Query.privilegeKeys.fetch() instead.
- Defined in query.ts:719

getRawQueryLogins

getRawQueryLogins(
    params?: {
        _count?: true;
        duration?: number;
        pattern?: string;
        start?: number;
    },
): Promise<RawQueryLogin | RawQueryLogin[]>
Get a list of query logins of the current virtual server. If no virtual server is selected, global logins will be returned as well.
Parameters
- params: { _count?: true; duration?: number; pattern?: string; start?: number } = {}
Returns Promise<RawQueryLogin | RawQueryLogin[]>
- Defined in query.ts:679

getRawServerConnectionInfo

getRawServerConnectionInfo(): Promise<RawServerConnectionInfo>
Get the raw server connection info.

Returns Promise<RawServerConnectionInfo>
- Defined in query.ts:512

getRawServerIdByPort

getRawServerIdByPort(port: number): Promise<{ server_id: string }>
Get the raw Server ID by its port.
Parameters
- port: number
  The virtual server port.
Returns Promise<{ server_id: string }>
Deprecated
Please use Query.virtualServers.fetchServerIdByPort(port) instead.
- Defined in query.ts:473

getRawServerInfo

getRawServerInfo(): Promise<RawVirtualServer>
Get the raw Server information.

Returns Promise<RawVirtualServer>
Deprecated
Please use Query.virtualServers.fetchCurrent() instead.
- Defined in query.ts:463

getRawServerTempPasswords

getRawServerTempPasswords(): Promise<
RawServerTempPassword
| RawServerTempPassword[],
>
Get a list of server temporary passwords.

Returns Promise<RawServerTempPassword | RawServerTempPassword[]>
- Defined in query.ts:795

getRawServerVersion

getRawServerVersion(): Promise<RawVersion>
Get the raw ServerQuery version information.

Returns Promise<RawVersion>
Deprecated
Please use Query.fetchServerVersion() instead.
- Defined in query.ts:445

login(username: string, password: string): Promise<void>
Login to the ServerQuery.
Parameters
- username: string
  The username to login with.
- password: string
  The password to login with.
Returns Promise<void>
- Defined in query.ts:261

logout

logout(): Promise<void>
Logout from the ServerQuery.

Returns Promise<void>
- Defined in query.ts:271

sendChannelMessage

sendChannelMessage(content: string): Promise<void>
Sends a message to the current channel.
Parameters
- content: string
  The message content.
Returns Promise<void>
- Defined in query.ts:334

sendHostMessage

sendHostMessage(content: string): Promise<void>
Sends a server message to virtual servers in the TeamSpeak 3 Server instance.
Parameters
- content: string
  The message to send.
Returns Promise<void>
- Defined in query.ts:312

sendServerMessage

sendServerMessage(content: string): Promise<void>
Sends a server message to the current virtual server.
Parameters
- content: string
  The message to send.
Returns Promise<void>
- Defined in query.ts:320

stopServerProcess

stopServerProcess(reason?: string): Promise<void>
Stop the whole TeamSpeak 3 Server instance.
Parameters
- Optionalreason: string
  The reason for stopping the server process. (optional)
Returns Promise<void>
- Defined in query.ts:359

updateLoginCredentials

updateLoginCredentials(username: string): Promise<string>
Update the login credentials for the current ServerQuery. You can only pass the username, the password will be generated automatically.
Parameters
- username: string
  The username to set.
Returns Promise<string>
The generated password.
- Defined in query.ts:347

useRawPrivilegeKey

useRawPrivilegeKey(token: string): Promise<void>
Use a privilege key by its token.
Parameters
- token: string
  The token of the privilege key to use.
Returns Promise<void>
Deprecated
Please use Query.privilegeKeys.use() or Query.privilegeKeys.useByToken() instead.
- Defined in query.ts:768

useVirtualServer

useVirtualServer(id: number): Promise<void>
Select a virtual server by its ID.
Parameters
- id: number
  The virtual server ID.
Returns Promise<void>
Deprecated
Use Query.virtualServers.use(...) instead.
- Defined in query.ts:282

useVirtualServerByPort

useVirtualServerByPort(port: number): Promise<void>
Select a virtual server by its port.
Parameters
- port: number
  The virtual server port.
Returns Promise<void>
Deprecated
Use Query.virtualServers.use(...) instead.
- Defined in query.ts:302

Class Query

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Query

Properties

actions

bans

channelGroups

channels

client

clients

commands

instance

notifications

permissions

privilegeKeys

serverGroups

transport

virtualServers

Methods

addLog

Parameters

Returns Promise<void>

connect

Parameters

Returns Promise<void>

createRawApiKey

Parameters

Returns Promise<RawApiKey>

createRawComplain

Parameters

Returns Promise<void>

createRawPrivilegeKey

Parameters

Returns Promise<string>

Deprecated

createRawQueryLogin

Parameters

Returns Promise<RawQueryLoginAdd>

createRawServerSnapshot

Returns Promise<RawServerSnapshot>

createRawServerTempPassword

Parameters

Returns Promise<void>

deleteRawApiKey

Parameters

Returns Promise<void>

deleteRawComplain

Parameters

Returns Promise<void>

deleteRawComplains

Parameters

Returns Promise<void>

deleteRawPrivilegeKey

Parameters

Returns Promise<void>

Deprecated

deleteRawQueryLogin

Parameters

Returns Promise<void>

deleteRawServerTempPassword

Parameters

Returns Promise<void>

deployRawServerSnapshot

Parameters

Returns Promise<unknown>

destroy

Returns void

fetchHostInfo

Returns Promise<HostInfo>

fetchInstance

Returns Promise<Instance>

fetchLogs

Returns Promise< { level: string; message: string; module: string; timestamp: Date; virtualServerId: number; }[],>

Returns Promise<
{
level: string;
message: string;
module: string;
timestamp: Date;
virtualServerId: number;
}[],
>