teamspeak.js - v1.11.0
    Preparing search index...

    Class VirtualServer

    Represents a virtual server.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    antiFloodPointsNeededCommandBlock antiFloodPointsNeededIpBlock antiFloodPointsNeededPluginBlock antiFloodPointsTickReduce askForPrivilegeKey autoStart capabilityExtensions channelsOnline channelTempDeleteDelayDefault clientConnections clientsOnline codecEncryptionMode complainAutobanCount complainAutobanTime complainRemoveTime connectionBandwidthReceivedLastMinuteTotal connectionBandwidthReceivedLastSecondTotal connectionBandwidthSentLastMinuteTotal connectionBandwidthSentLastSecondTotal connectionBytesReceivedControl connectionBytesReceivedKeepAlive connectionBytesReceivedSpeech connectionBytesReceivedTotal connectionBytesSentControl connectionBytesSentKeepAlive connectionBytesSentSpeech connectionBytesSentTotal connectionFileTransferBandwidthReceived connectionFileTransferBandwidthSent connectionFileTransferBytesReceivedTotal connectionFileTransferBytesSentTotal connectionPacketsReceivedControl connectionPacketsReceivedKeepAlive connectionPacketsReceivedSpeech connectionPacketsReceivedTotal connectionPacketsSentControl connectionPacketsSentKeepAlive connectionPacketsSentSpeech connectionPacketsSentTotal createdTimestamp defaultChannelAdminGroup defaultChannelGroup defaultServerGroup downloadQuota filebase fileStorageClass hostBannerGfxInterval hostBannerGfxUrl hostBannerMode hostBannerUrl hostButtonGfxUrl hostButtonTooltip hostButtonUrl hostMessage hostMessageMode iconId id ip logChannel logClient logFileTransfer logPermissions logQuery logServer machineId maxClients maxDownloadTotalBandwidth maxUploadTotalBandwidth minAndroidVersion minClientsInChannelBeforeForcedSilence minClientVersion minIosVersion monthBytesDownloaded monthBytesUploaded name namePhonetic neededIdentitySecurityLevel nickname password platform port prioritySpeakerDimmModificator queryClientConnections queryClientsOnline reservedSlots status totalBytesDownloaded totalBytesUploaded totalPacketLossControl totalPacketLossKeepAlive totalPacketLossSpeech totalPacketLossTotal totalPing uniqueId uploadQuota uptime version webListEnabled welcomeMessage

    Accessors

    createdAt

    Methods

    _clone _patch _update delete edit setAutoStart setName setPort start stop toJSON valueOf

    Constructors

    Properties

    antiFloodPointsNeededCommandBlock: number | null = null
    antiFloodPointsNeededIpBlock: number | null = null
    antiFloodPointsNeededPluginBlock: number | null = null
    antiFloodPointsTickReduce: number | null = null
    askForPrivilegeKey: boolean | null = null
    autoStart: boolean | null = null
    capabilityExtensions: string | null = null
    channelsOnline: number | null = null
    channelTempDeleteDelayDefault: number | null = null
    clientConnections: number | null = null
    clientsOnline: number | null = null
    codecEncryptionMode: string | null = null
    complainAutobanCount: number | null = null
    complainAutobanTime: number | null = null
    complainRemoveTime: number | null = null
    connectionBandwidthReceivedLastMinuteTotal: number | null = null
    connectionBandwidthReceivedLastSecondTotal: number | null = null
    connectionBandwidthSentLastMinuteTotal: number | null = null
    connectionBandwidthSentLastSecondTotal: number | null = null
    connectionBytesReceivedControl: number | null = null
    connectionBytesReceivedKeepAlive: number | null = null
    connectionBytesReceivedSpeech: number | null = null
    connectionBytesReceivedTotal: number | null = null
    connectionBytesSentControl: number | null = null
    connectionBytesSentKeepAlive: number | null = null
    connectionBytesSentSpeech: number | null = null
    connectionBytesSentTotal: number | null = null
    connectionFileTransferBandwidthReceived: number | null = null
    connectionFileTransferBandwidthSent: number | null = null
    connectionFileTransferBytesReceivedTotal: number | null = null
    connectionFileTransferBytesSentTotal: number | null = null
    connectionPacketsReceivedControl: number | null = null
    connectionPacketsReceivedKeepAlive: number | null = null
    connectionPacketsReceivedSpeech: number | null = null
    connectionPacketsReceivedTotal: number | null = null
    connectionPacketsSentControl: number | null = null
    connectionPacketsSentKeepAlive: number | null = null
    connectionPacketsSentSpeech: number | null = null
    connectionPacketsSentTotal: number | null = null
    createdTimestamp: number | null = null
    defaultChannelAdminGroup: number | null = null
    defaultChannelGroup: number | null = null
    defaultServerGroup: number | null = null
    downloadQuota: number | null = null
    filebase: string | null = null
    fileStorageClass: string | null = null
    hostBannerGfxInterval: number | null = null
    hostBannerGfxUrl: string | null = null
    hostBannerMode: string | null = null
    hostBannerUrl: string | null = null
    hostButtonGfxUrl: string | null = null
    hostButtonTooltip: string | null = null
    hostButtonUrl: string | null = null
    hostMessage: string | null = null
    hostMessageMode: string | null = null
    iconId: number | null = null
    id: number
    ip: string | null = null
    logChannel: boolean | null = null
    logClient: boolean | null = null
    logFileTransfer: boolean | null = null
    logPermissions: boolean | null = null
    logQuery: boolean | null = null
    logServer: boolean | null = null
    machineId: string | null = null
    maxClients: number | null = null
    maxDownloadTotalBandwidth: number | null = null
    maxUploadTotalBandwidth: number | null = null
    minAndroidVersion: number | null = null
    minClientsInChannelBeforeForcedSilence: number | null = null
    minClientVersion: number | null = null
    minIosVersion: number | null = null
    monthBytesDownloaded: number | null = null
    monthBytesUploaded: number | null = null
    name: string | null = null
    namePhonetic: string | null = null
    neededIdentitySecurityLevel: number | null = null
    nickname: string | null = null
    password: string | null = null
    platform: string | null = null
    port: number | null = null
    prioritySpeakerDimmModificator: number | null = null
    queryClientConnections: number | null = null
    queryClientsOnline: number | null = null
    reservedSlots: number | null = null
    status: string | null = null
    totalBytesDownloaded: number | null = null
    totalBytesUploaded: number | null = null
    totalPacketLossControl: number | null = null
    totalPacketLossKeepAlive: number | null = null
    totalPacketLossSpeech: number | null = null
    totalPacketLossTotal: number | null = null
    totalPing: number | null = null
    uniqueId: string | null = null
    uploadQuota: number | null = null
    uptime: number | null = null
    version: string | null = null
    webListEnabled: boolean | null = null
    welcomeMessage: string | null = null

    Accessors

    Methods

    _clone

    _patch

    _update

    • Delete the virtual server. Note: Only stopped virtual servers can be deleted.

      Returns Promise<void>

      A promise that resolves when the virtual server has been deleted.

    • Start the virtual server.

      Returns Promise<void>

      A promise that resolves when the virtual server has started.

    • Stop the virtual server.

      Parameters

      • Optionalreason: string

        The reason for stopping the virtual server. (optional)

      Returns Promise<void>

      A promise that resolves when the virtual server has stopped.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    antiFloodPointsNeededCommandBlockantiFloodPointsNeededIpBlockantiFloodPointsNeededPluginBlockantiFloodPointsTickReduceaskForPrivilegeKeyautoStartcapabilityExtensionschannelsOnlinechannelTempDeleteDelayDefaultclientConnectionsclientsOnlinecodecEncryptionModecomplainAutobanCountcomplainAutobanTimecomplainRemoveTimeconnectionBandwidthReceivedLastMinuteTotalconnectionBandwidthReceivedLastSecondTotalconnectionBandwidthSentLastMinuteTotalconnectionBandwidthSentLastSecondTotalconnectionBytesReceivedControlconnectionBytesReceivedKeepAliveconnectionBytesReceivedSpeechconnectionBytesReceivedTotalconnectionBytesSentControlconnectionBytesSentKeepAliveconnectionBytesSentSpeechconnectionBytesSentTotalconnectionFileTransferBandwidthReceivedconnectionFileTransferBandwidthSentconnectionFileTransferBytesReceivedTotalconnectionFileTransferBytesSentTotalconnectionPacketsReceivedControlconnectionPacketsReceivedKeepAliveconnectionPacketsReceivedSpeechconnectionPacketsReceivedTotalconnectionPacketsSentControlconnectionPacketsSentKeepAliveconnectionPacketsSentSpeechconnectionPacketsSentTotalcreatedTimestampdefaultChannelAdminGroupdefaultChannelGroupdefaultServerGroupdownloadQuotafilebasefileStorageClasshostBannerGfxIntervalhostBannerGfxUrlhostBannerModehostBannerUrlhostButtonGfxUrlhostButtonTooltiphostButtonUrlhostMessagehostMessageModeiconIdidiplogChannellogClientlogFileTransferlogPermissionslogQuerylogServermachineIdmaxClientsmaxDownloadTotalBandwidthmaxUploadTotalBandwidthminAndroidVersionminClientsInChannelBeforeForcedSilenceminClientVersionminIosVersionmonthBytesDownloadedmonthBytesUploadednamenamePhoneticneededIdentitySecurityLevelnicknamepasswordplatformportprioritySpeakerDimmModificatorqueryClientConnectionsqueryClientsOnlinereservedSlotsstatustotalBytesDownloadedtotalBytesUploadedtotalPacketLossControltotalPacketLossKeepAlivetotalPacketLossSpeechtotalPacketLossTotaltotalPinguniqueIduploadQuotauptimeversionwebListEnabledwelcomeMessage
    Accessors
    Methods