Class TeamSpeakClient

Hierarchy

Abstract<ClientEntry>
- TeamSpeakClient

Constructors

constructor

new TeamSpeakClient(parent, list): TeamSpeakClient
Parameters
- parent: TeamSpeak
- list: ClientEntry
Returns TeamSpeakClient
Overrides Abstract<ClientEntry>.constructor
- Defined in node/Client.ts:12

Accessors

away

get away(): number
Returns number
- Defined in node/Client.ts:40

awayMessage

get awayMessage(): string
Returns string
- Defined in node/Client.ts:44

badges

get badges(): string
Returns string
- Defined in node/Client.ts:132

channelGroupId

get channelGroupId(): string
Returns string
- Defined in node/Client.ts:92

channelGroupInheritedChannelId

get channelGroupInheritedChannelId(): number
Returns number
- Defined in node/Client.ts:96

cid

get cid(): string
Returns string
- Defined in node/Client.ts:20

clid

get clid(): string
Returns string
- Defined in node/Client.ts:16

connectionClientIp

get connectionClientIp(): string
Returns string
- Defined in node/Client.ts:128

country

get country(): undefined | string
Returns undefined | string
- Defined in node/Client.ts:120

created

get created(): number
Returns number
- Defined in node/Client.ts:112

databaseId

get databaseId(): string
Returns string
- Defined in node/Client.ts:24

estimatedLocation

get estimatedLocation(): undefined | string
Returns undefined | string
- Defined in node/Client.ts:124

flagTalking

get flagTalking(): boolean
Returns boolean
- Defined in node/Client.ts:48

idleTime

get idleTime(): number
Returns number
- Defined in node/Client.ts:108

inputHardware

get inputHardware(): boolean
Returns boolean
- Defined in node/Client.ts:60

inputMuted

get inputMuted(): boolean
Returns boolean
- Defined in node/Client.ts:52

isChannelCommander

get isChannelCommander(): number
Returns number
- Defined in node/Client.ts:84

isPrioritySpeaker

get isPrioritySpeaker(): boolean
Returns boolean
- Defined in node/Client.ts:76

isRecording

get isRecording(): boolean
Returns boolean
- Defined in node/Client.ts:80

isTalker

get isTalker(): boolean
Returns boolean
- Defined in node/Client.ts:72

lastconnected

get lastconnected(): number
Returns number
- Defined in node/Client.ts:116

nickname

get nickname(): string
Returns string
- Defined in node/Client.ts:28

outputHardware

get outputHardware(): boolean
Returns boolean
- Defined in node/Client.ts:64

outputMuted

get outputMuted(): boolean
Returns boolean
- Defined in node/Client.ts:56

platform

get platform(): string
Returns string
- Defined in node/Client.ts:104

servergroups

get servergroups(): string[]
Returns string[]
- Defined in node/Client.ts:88

talkPower

get talkPower(): number
Returns number
- Defined in node/Client.ts:68

type

get type(): number
Returns number
- Defined in node/Client.ts:32

uniqueIdentifier

get uniqueIdentifier(): string
Returns string
- Defined in node/Client.ts:36

version

get version(): string
Returns string
- Defined in node/Client.ts:100

Methods

addGroups

addGroups(sgid): Promise<[]>
adds the client to one or more groups
Parameters
- sgid: string | string[] | TeamSpeakServerGroup | TeamSpeakServerGroup[]
  
  one or more servergroup ids which the client should be added to
Returns Promise<[]>
- Defined in node/Client.ts:219

addPerm

addPerm(perm): Promise<[]>
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<[]>
- Defined in node/Client.ts:277

ban

ban(banreason, time?): Promise<BanAdd>
bans the chosen client with its uid
Parameters
- banreason: string
  
  ban reason
- Optional time: number
  
  bantime in seconds, if left empty it will result in a permaban
Returns Promise<BanAdd>
- Defined in node/Client.ts:202

createPerm

createPerm(): Permission<any>
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>
- Defined in node/Client.ts:286

customDelete

customDelete(ident): Promise<[]>
removes a custom property from the client
Parameters
- ident: string
  
  the key which should be deleted
Returns Promise<[]>
- Defined in node/Client.ts:167

customInfo

customInfo(): Promise<CustomInfo>
returns a list of custom properties for the client

Returns Promise<CustomInfo>
- Defined in node/Client.ts:159

customSet

customSet(ident, value): 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<[]>
- Defined in node/Client.ts:177

dbEdit

dbEdit(properties): Promise<[]>
Changes a clients settings using given properties.
Parameters
- properties: ClientDBEdit
  
  the properties which should be modified
Returns Promise<[]>
- Defined in node/Client.ts:243

delGroups

delGroups(sgid): Promise<[]>
Removes the client from one or more groups
Parameters
- sgid: string | string[] | TeamSpeakServerGroup | TeamSpeakServerGroup[]
  
  one or more servergroup ids which the client should be added to
Returns Promise<[]>
- Defined in node/Client.ts:227

delPerm

delPerm(perm): 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<[]>
- Defined in node/Client.ts:296

edit

edit(properties): Promise<[]>
edits the client
Parameters
- properties: ClientEdit
  
  the properties to change
Returns Promise<[]>
- Defined in node/Client.ts:235

getAvatar

getAvatar(): Promise<Buffer>
returns a Buffer with the avatar of the user

Returns Promise<Buffer>
- Defined in node/Client.ts:301

getAvatarName

getAvatarName(): Promise<string>
returns the avatar name of the client

Returns Promise<string>
- Defined in node/Client.ts:311

getDBInfo

getDBInfo(): Promise<ClientDBInfo>
returns the clients database info

Returns Promise<ClientDBInfo>
- Defined in node/Client.ts:154

getIcon

getIcon(): Promise<Buffer>
returns a Buffer with the icon of the client

Returns Promise<Buffer>
- Defined in node/Client.ts:306

getIconId

getIconId(): Promise<number>
gets the icon name of the client

Returns Promise<number>
- Defined in node/Client.ts:316

getInfo

getInfo(): Promise<ClientInfo>
returns general info of the client, requires the client to be online

Returns Promise<ClientInfo>
- Defined in node/Client.ts:149

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

getUrl

getUrl(): string
Retrieves a displayable Client Link for the TeamSpeak Chat

Returns string
- Defined in node/Client.ts:144

isQuery

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

Returns boolean
- Defined in node/Client.ts:137

kickFromChannel

kickFromChannel(msg): 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<[]>
- Defined in node/Client.ts:193

kickFromServer

kickFromServer(msg): Promise<[]>
kicks the client from the server
Parameters
- msg: string
  
  the message the client should receive when getting kicked
Returns Promise<[]>
- Defined in node/Client.ts:185

message

message(msg): any
sends a textmessage to the client
Parameters
- msg: string
  
  the message the client should receive
Returns any
- Defined in node/Client.ts:259

move

move(cid, cpw?): Promise<[]>
moves the client to a different channel
Parameters
- cid: string | TeamSpeakChannel
  
  channel id in which the client should get moved
- Optional cpw: string
  
  the channel password
Returns Promise<[]>
- Defined in node/Client.ts:211

permList

permList(permsid?): Promise<Permission<{
cldbid: string;
}>[]>
returns a list of permissions defined for the client
Parameters
- Optional permsid: boolean
  
  if the permsid option is set to true the output will contain the permission names
Returns Promise<Permission<{
cldbid: string;
}>[]>
- Defined in node/Client.ts:267

poke

poke(msg): Promise<[]>
pokes the client with a certain message
Parameters
- msg: string
  
  the message the client should receive
Returns Promise<[]>
- Defined in node/Client.ts:251

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): TeamSpeakClient
updates the cache with the given object
Parameters
- props: ResponseEntry
Returns TeamSpeakClient
Inherited from Abstract.updateCache
- Defined in node/Abstract.ts:37

`Static` getDbid

getDbid<T>(client?): T extends undefined
? undefined
: string
retrieves the client dbid from a string or teamspeak client
Type Parameters
- T extends TeamSpeakClient.ClientType
Parameters
- Optional client: T
Returns T extends undefined
? undefined
: string
- Defined in node/Client.ts:327

`Static` getId

getId<T>(client?): T extends undefined
? undefined
: string
retrieves the client id from a string or teamspeak client
Type Parameters
- T extends TeamSpeakClient.ClientType
Parameters
- Optional client: T
Returns T extends undefined
? undefined
: string
- Defined in node/Client.ts:321

`Static` getMultipleDbids

getMultipleDbids(client): string[]
retrieves the clients from an array
Parameters
- client: MultiClientType
Returns string[]
- Defined in node/Client.ts:345

`Static` getMultipleIds

getMultipleIds(client): string[]
retrieves the clients from an array
Parameters
- client: MultiClientType
Returns string[]
- Defined in node/Client.ts:339

`Static` getMultipleUids

getMultipleUids(client): string[]
retrieves the clients from an array
Parameters
- client: MultiClientType
Returns string[]
- Defined in node/Client.ts:351

`Static` getUid

getUid<T>(client?): T extends undefined
? undefined
: string
retrieves the client dbid from a string or teamspeak client
Type Parameters
- T extends TeamSpeakClient.ClientType
Parameters
- Optional client: T
Returns T extends undefined
? undefined
: string
- Defined in node/Client.ts:333

Generated using TypeDoc