Class TeamSpeakServer

Hierarchy

Abstract<ServerEntry>
- TeamSpeakServer

Index

Constructors

Accessors

autostart clientsonline id machineId maxclients name port queryclientsonline status uniqueIdentifier uptime

Methods

del getNameSpace getParent getPropertyByName start stop toJSON updateCache use getId getMultipleIds

Constructors

constructor

new TeamSpeakServer(parent, list): TeamSpeakServer
Parameters
- parent: TeamSpeak
- list: ServerEntry
Returns TeamSpeakServer
Overrides Abstract<ServerEntry>.constructor
- Defined in node/Server.ts:7

Accessors

autostart

get autostart(): number
Returns number
- Defined in node/Server.ts:43

clientsonline

get clientsonline(): number
Returns number
- Defined in node/Server.ts:23

id

get id(): string
Returns string
- Defined in node/Server.ts:11

machineId

get machineId(): string
Returns string
- Defined in node/Server.ts:47

maxclients

get maxclients(): number
Returns number
- Defined in node/Server.ts:31

name

get name(): string
Returns string
- Defined in node/Server.ts:39

port

get port(): number
Returns number
- Defined in node/Server.ts:15

queryclientsonline

get queryclientsonline(): number
Returns number
- Defined in node/Server.ts:27

status

get status(): string
Returns string
- Defined in node/Server.ts:19

uniqueIdentifier

get uniqueIdentifier(): string
Returns string
- Defined in node/Server.ts:51

uptime

get uptime(): number
Returns number
- Defined in node/Server.ts:35

Methods

del

del(): Promise<[]>
deletes the server

Returns Promise<[]>
- Defined in node/Server.ts:64

getNameSpace

getNameSpace(): string
retrieves the namespace of this class

Returns string
Inherited from Abstract.getNameSpace
- Defined in node/Abstract.ts:17

getParent

getParent(): TeamSpeak
returns the parent class

Returns TeamSpeak
Inherited from Abstract.getParent
- Defined in node/Abstract.ts:43

getPropertyByName

getPropertyByName<Y>(name): ServerEntry[Y]
retrieves a single property value by the given name
Type Parameters
- Y extends keyof ServerEntry
Parameters
- name: Y
  
  the name from where the value should be retrieved
Returns ServerEntry[Y]
Inherited from Abstract.getPropertyByName
- Defined in node/Abstract.ts:32

start

start(): Promise<[]>
Starts the virtual server. Depending on your permissions, you're able to start either your own virtual server only or all virtual servers in the server instance.

Returns Promise<[]>
- Defined in node/Server.ts:72

stop

stop(msg?): Promise<[]>
Stops the virtual server. Depending on your permissions, you're able to stop either your own virtual server only or all virtual servers in the server instance.
Parameters
- Optional msg: string
  
  specifies a text message that is sent to the clients before the client disconnects (requires TeamSpeak Server 3.2.0 or newer).
Returns Promise<[]>
- Defined in node/Server.ts:81

toJSON

toJSON(includeNameSpace?): Record<string, any>
returns JSONifyable data
Parameters
- includeNameSpace: boolean = true
Returns Record<string, any>
Inherited from Abstract.toJSON
- Defined in node/Abstract.ts:22

updateCache

updateCache(props): TeamSpeakServer
updates the cache with the given object
Parameters
- props: ResponseEntry
Returns TeamSpeakServer
Inherited from Abstract.updateCache
- Defined in node/Abstract.ts:37

use

use(clientNickname?): Promise<[]>
selects a virtual server
Parameters
- Optional clientNickname: string
Returns Promise<[]>
- Defined in node/Server.ts:59

`Static` getId

getId<T>(server?): T extends undefined
? undefined
: string
retrieves the client id from a string or teamspeak client
Type Parameters
- T extends ServerType
Parameters
- Optional server: T
Returns T extends undefined
? undefined
: string
- Defined in node/Server.ts:86

`Static` getMultipleIds

getMultipleIds(servers): string[]
retrieves the clients from an array
Parameters
- servers: MultiServerType
Returns string[]
- Defined in node/Server.ts:92

Generated using TypeDoc