Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamSpeakClient

Hierarchy

Index

Type aliases

Static ClientType

ClientType: string | TeamSpeakClient

Static MultiClientType

MultiClientType: string[] | TeamSpeakClient[] | ClientType

Constructors

constructor

Accessors

away

  • get away(): number

awayMessage

  • get awayMessage(): string

badges

  • get badges(): string

channelGroupId

  • get channelGroupId(): string

channelGroupInheritedChannelId

  • get channelGroupInheritedChannelId(): number

cid

  • get cid(): string

clid

  • get clid(): string

connectionClientIp

  • get connectionClientIp(): string

country

  • get country(): string

created

  • get created(): number

databaseId

  • get databaseId(): string

flagTalking

  • get flagTalking(): boolean

idleTime

  • get idleTime(): number

inputHardware

  • get inputHardware(): boolean

inputMuted

  • get inputMuted(): boolean

isChannelCommander

  • get isChannelCommander(): number

isPrioritySpeaker

  • get isPrioritySpeaker(): boolean

isRecording

  • get isRecording(): boolean

isTalker

  • get isTalker(): boolean

lastconnected

  • get lastconnected(): number

nickname

  • get nickname(): string

outputHardware

  • get outputHardware(): boolean

outputMuted

  • get outputMuted(): boolean

platform

  • get platform(): string

servergroups

  • get servergroups(): string[]

talkPower

  • get talkPower(): number

type

  • get type(): number

uniqueIdentifier

  • get uniqueIdentifier(): string

version

  • get version(): string

Methods

addGroups

addPerm

  • Adds a set of specified permissions to a client. Multiple permissions can be added by providing the three parameters of each permission. A permission can be specified by permid or permsid.

    Parameters

    • perm: PermType

      the permission object to set

    Returns Promise<[]>

ban

  • ban(banreason: string, time?: undefined | number): Promise<BanAdd>
  • bans the chosen client with its uid

    Parameters

    • banreason: string

      ban reason

    • Optional time: undefined | number

      bantime in seconds, if left empty it will result in a permaban

    Returns Promise<BanAdd>

createPerm

  • Adds a set of specified permissions to a client. Multiple permissions can be added by providing the three parameters of each permission. A permission can be specified by permid or permsid.

    Returns Permission<any>

customDelete

  • customDelete(ident: string): Promise<[]>
  • removes a custom property from the client

    Parameters

    • ident: string

      the key which should be deleted

    Returns Promise<[]>

customInfo

customSet

  • customSet(ident: string, value: string): Promise<[]>
  • creates or updates a custom property for the client ident and value can be any value, and are the key value pair of the custom property

    Parameters

    • ident: string

      the key which should be set

    • value: string

      the value which should be set

    Returns Promise<[]>

dbEdit

  • Changes a clients settings using given properties.

    Parameters

    • properties: ClientDBEdit

      the properties which should be modified

    Returns Promise<[]>

delGroups

delPerm

  • delPerm(perm: string | number): Promise<[]>
  • Removes a set of specified permissions from a client. Multiple permissions can be removed at once. A permission can be specified by permid or permsid

    Parameters

    • perm: string | number

      the permid or permsid

    Returns Promise<[]>

edit

getAvatar

  • getAvatar(): Promise<Buffer>

getAvatarName

  • getAvatarName(): Promise<string>

getDBInfo

getIcon

  • getIcon(): Promise<Buffer>

getIconId

  • getIconId(): Promise<number>

getInfo

getNameSpace

  • getNameSpace(): string

getParent

getPropertyByName

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

getUrl

  • getUrl(): string

isQuery

  • isQuery(): boolean
  • evaluates if the client is a query client or a normal client

    Returns boolean

kickFromChannel

  • kickFromChannel(msg: string): Promise<[]>
  • kicks the client from their currently joined channel

    Parameters

    • msg: string

      the message the client should receive when getting kicked (max 40 Chars)

    Returns Promise<[]>

kickFromServer

  • kickFromServer(msg: string): Promise<[]>
  • kicks the client from the server

    Parameters

    • msg: string

      the message the client should receive when getting kicked

    Returns Promise<[]>

message

  • message(msg: string): any
  • sends a textmessage to the client

    Parameters

    • msg: string

      the message the client should receive

    Returns any

move

  • moves the client to a different channel

    Parameters

    • cid: string | TeamSpeakChannel

      channel id in which the client should get moved

    • Optional cpw: undefined | string

      the channel password

    Returns Promise<[]>

permList

  • permList(permsid?: undefined | false | true): Promise<Permission<{ cldbid: string }>[]>
  • returns a list of permissions defined for the client

    Parameters

    • Optional permsid: undefined | false | true

      if the permsid option is set to true the output will contain the permission names

    Returns Promise<Permission<{ cldbid: string }>[]>

poke

  • poke(msg: string): Promise<[]>
  • pokes the client with a certain message

    Parameters

    • msg: string

      the message the client should receive

    Returns Promise<[]>

toJSON

  • toJSON(includeNameSpace?: boolean): {}

updateCache

Static getDbid

  • getDbid<T>(client?: T): T extends undefined ? undefined : string
  • retrieves the client dbid from a string or teamspeak client

    Type parameters

    Parameters

    • Optional client: T

    Returns T extends undefined ? undefined : string

Static getId

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

    Type parameters

    Parameters

    • Optional client: T

    Returns T extends undefined ? undefined : string

Static getMultipleDbids

Static getMultipleIds

Static getMultipleUids

Static getUid

  • getUid<T>(client?: T): T extends undefined ? undefined : string
  • retrieves the client dbid from a string or teamspeak client

    Type parameters

    Parameters

    • Optional client: T

    Returns T extends undefined ? undefined : string

Generated using TypeDoc