Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamSpeakServer

Hierarchy

Index

Type aliases

Static MultiServerType

MultiServerType: string[] | TeamSpeakServer[] | ServerType

Static ServerType

ServerType: string | TeamSpeakServer

Constructors

constructor

Accessors

autostart

  • get autostart(): number

clientsonline

  • get clientsonline(): number

id

  • get id(): string

machineId

  • get machineId(): string

maxclients

  • get maxclients(): number

name

  • get name(): string

port

  • get port(): number

queryclientsonline

  • get queryclientsonline(): number

status

  • get status(): string

uniqueIdentifier

  • get uniqueIdentifier(): string

uptime

  • get uptime(): number

Methods

del

  • del(): Promise<[]>

getNameSpace

  • getNameSpace(): string

getParent

getPropertyByName

  • getPropertyByName<Y>(name: Y): ServerEntry[Y]

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<[]>

stop

  • stop(msg?: undefined | string): 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: undefined | 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<[]>

toJSON

  • toJSON(includeNameSpace?: boolean): {}

updateCache

use

  • use(clientNickname?: undefined | string): Promise<[]>
  • selects a virtual server

    Parameters

    • Optional clientNickname: undefined | string

    Returns Promise<[]>

Static getId

  • getId<T>(server?: T): T extends undefined ? undefined : string
  • retrieves the client id from a string or teamspeak client

    Type parameters

    Parameters

    • Optional server: T

    Returns T extends undefined ? undefined : string

Static getMultipleIds

Generated using TypeDoc