Class TeamSpeakServerGroup

Hierarchy

Abstract<ServerGroupEntry>
- TeamSpeakServerGroup

Index

Constructors

Accessors

iconid nMemberAddp nMemberRemovep nModifyp name namemode savedb sgid sortid type

Methods

addClient addPerm clientList copy createPerm del delClient delPerm getIcon getIconId getNameSpace getParent getPropertyByName permList rename toJSON updateCache getId getMultipleIds

Constructors

constructor

new TeamSpeakServerGroup(parent, list): TeamSpeakServerGroup
Parameters
- parent: TeamSpeak
- list: ServerGroupEntry
Returns TeamSpeakServerGroup
Overrides Abstract<ServerGroupEntry>.constructor
- Defined in node/ServerGroup.ts:9

Accessors

iconid

get iconid(): string
Returns string
- Defined in node/ServerGroup.ts:25

nMemberAddp

get nMemberAddp(): number
Returns number
- Defined in node/ServerGroup.ts:45

nMemberRemovep

get nMemberRemovep(): number
Returns number
- Defined in node/ServerGroup.ts:49

nModifyp

get nModifyp(): number
Returns number
- Defined in node/ServerGroup.ts:41

name

get name(): string
Returns string
- Defined in node/ServerGroup.ts:17

namemode

get namemode(): number
Returns number
- Defined in node/ServerGroup.ts:37

savedb

get savedb(): number
Returns number
- Defined in node/ServerGroup.ts:29

sgid

get sgid(): string
Returns string
- Defined in node/ServerGroup.ts:13

sortid

get sortid(): number
Returns number
- Defined in node/ServerGroup.ts:33

type

get type(): number
Returns number
- Defined in node/ServerGroup.ts:21

Methods

addClient

addClient(client): Promise<[]>
Adds a client to the server group. Please note that a client cannot be added to default groups or template groups.
Parameters
- client: TeamSpeakClient.ClientType
  
  the client database id which should be added to the Group
Returns Promise<[]>
- Defined in node/ServerGroup.ts:120

addPerm

addPerm(perm): Promise<[]>
Adds a specified permissions to the server group. A permission can be specified by permid or permsid.
Parameters
- perm: PermType
  
  the permission object to set
Returns Promise<[]>
- Defined in node/ServerGroup.ts:95

clientList

clientList(): Promise<ServerGroupClientEntry[]>
returns the ids of all clients currently residing in the server group

Returns Promise<ServerGroupClientEntry[]>
- Defined in node/ServerGroup.ts:133

copy

copy(targetGroup, type, name): Promise<ServerGroupCopy>
Creates a copy of the server group specified with ssgid. If tsgid is set to 0, the server will create a new group. To overwrite an existing group, simply set tsgid to the ID of a designated target group. If a target group is set, the name parameter will be ignored.
Parameters
- targetGroup: string | TeamSpeakServerGroup
- type: number
  
  type of the group (0 = Query Group | 1 = Normal Group)
- name: string
  
  name of the group
Returns Promise<ServerGroupCopy>
- Defined in node/ServerGroup.ts:70

createPerm

createPerm(): Permission<any>
Adds a specified permissions to the server group. A permission can be specified by permid or permsid.

Returns Permission<any>
- Defined in node/ServerGroup.ts:103

del

del(force?): Promise<[]>
Deletes the server group. If force is set to 1, the server group will be deleted even if there are clients within.
Parameters
- Optional force: boolean
  
  if set to 1 the servergroup will be deleted even when clients are in it
Returns Promise<[]>
- Defined in node/ServerGroup.ts:58

delClient

delClient(client): Promise<[]>
removes a client specified with cldbid from the servergroup
Parameters
- client: TeamSpeakClient.ClientType
  
  the client database id which should be removed from the group
Returns Promise<[]>
- Defined in node/ServerGroup.ts:128

delPerm

delPerm(perm): Promise<[]>
rmoves a set of specified permissions from the server group. A permission can be specified by permid or permsid.
Parameters
- perm: string | number
  
  the permid or permsid
Returns Promise<[]>
- Defined in node/ServerGroup.ts:112

getIcon

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

Returns Promise<Buffer>
- Defined in node/ServerGroup.ts:138

getIconId

getIconId(): Promise<number>
gets the icon id of the servergroup

Returns Promise<number>
- Defined in node/ServerGroup.ts:143

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

permList

permList(permsid): Promise<Permission<{
sgid: string;
}>[]>
returns a list of permissions assigned to the server group specified with sgid
Parameters
- permsid: boolean
  
  if the permsid option is set to true the output will contain the permission names
Returns Promise<Permission<{
sgid: string;
}>[]>
- Defined in node/ServerGroup.ts:86

rename

rename(name): Promise<[]>
changes the name of the server group
Parameters
- name: string
  
  new name of the group
Returns Promise<[]>
- Defined in node/ServerGroup.ts:78

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

`Static` getId

getId<T>(group?): T extends undefined
? undefined
: string
retrieves the client id from a string or teamspeak client
Type Parameters
- T extends TeamSpeakServerGroup.GroupType
Parameters
- Optional group: T
Returns T extends undefined
? undefined
: string
- Defined in node/ServerGroup.ts:148

`Static` getMultipleIds

getMultipleIds(groups): string[]
retrieves the clients from an array
Parameters
- groups: TeamSpeakServerGroup.MultiGroupType
Returns string[]
- Defined in node/ServerGroup.ts:154

Class TeamSpeakServerGroup

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

parent: TeamSpeak

list: ServerGroupEntry

Returns TeamSpeakServerGroup

Accessors

iconid

Returns string

nMemberAddp

Returns number

nMemberRemovep

Returns number

nModifyp

Returns number

name

Returns string

namemode

Returns number

savedb

Returns number

sgid

Returns string

sortid

Returns number

type

Returns number

Methods

addClient

Parameters

client: TeamSpeakClient.ClientType

Returns Promise<[]>

addPerm

Parameters

perm: PermType

Returns Promise<[]>

clientList

Returns Promise<ServerGroupClientEntry[]>

copy

Parameters

targetGroup: string | TeamSpeakServerGroup

type: number

name: string

Returns Promise<ServerGroupCopy>

createPerm

Returns Permission<any>

del

Parameters

Optional force: boolean

Returns Promise<[]>

delClient

Parameters

client: TeamSpeakClient.ClientType

Returns Promise<[]>

delPerm

Parameters

perm: string | number

Returns Promise<[]>

getIcon

Returns Promise<Buffer>

getIconId

Returns Promise<number>

getNameSpace

Returns string

getParent

Returns TeamSpeak

getPropertyByName

Type Parameters

Y extends keyof ServerGroupEntry

Parameters

name: Y

Returns ServerGroupEntry[Y]

permList

Parameters

`Optional` force: boolean

Returns Promise<Permission<{
sgid: string;
}>[]>

`Static` getId

`Optional` group: T

Returns T extends undefined
? undefined
: string

`Static` getMultipleIds