Class TeamSpeakChannelGroup

Hierarchy

Abstract<ChannelGroupEntry>
- TeamSpeakChannelGroup

Index

Constructors

Accessors

cgid iconid nMemberAddp nMemberRemovep nModifyp name namemode savedb sortid type

Methods

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

Constructors

constructor

new TeamSpeakChannelGroup(parent, list): TeamSpeakChannelGroup
Parameters
- parent: TeamSpeak
- list: ChannelGroupEntry
Returns TeamSpeakChannelGroup
Overrides Abstract<ChannelGroupEntry>.constructor
- Defined in node/ChannelGroup.ts:10

Accessors

cgid

get cgid(): string
Returns string
- Defined in node/ChannelGroup.ts:14

iconid

get iconid(): string
Returns string
- Defined in node/ChannelGroup.ts:26

nMemberAddp

get nMemberAddp(): number
Returns number
- Defined in node/ChannelGroup.ts:46

nMemberRemovep

get nMemberRemovep(): number
Returns number
- Defined in node/ChannelGroup.ts:50

nModifyp

get nModifyp(): number
Returns number
- Defined in node/ChannelGroup.ts:42

name

get name(): string
Returns string
- Defined in node/ChannelGroup.ts:18

namemode

get namemode(): number
Returns number
- Defined in node/ChannelGroup.ts:38

savedb

get savedb(): number
Returns number
- Defined in node/ChannelGroup.ts:30

sortid

get sortid(): number
Returns number
- Defined in node/ChannelGroup.ts:34

type

get type(): number
Returns number
- Defined in node/ChannelGroup.ts:22

Methods

addPerm

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

clientList

clientList(channel): Promise<ChannelGroupClientList>
returns the ids of all clients currently residing in the channelgroup
Parameters
- channel: string | TeamSpeakChannel
  
  the channel id
Returns Promise<ChannelGroupClientList>
- Defined in node/ChannelGroup.ts:129

copy

copy(tcgid, type, name): Promise<ChannelGroupCopy>
Creates a copy of the channel group. If tcgid is set to 0, the server will create a new group. To overwrite an existing group, simply set tcgid to the ID of a designated target group. If a target group is set, the name parameter will be ignored.
Parameters
- tcgid: string | TeamSpeakChannelGroup
  
  the target group, 0 to create a new group
- type: number
  
  the type of the group (0 = Template Group | 1 = Normal Group)
- name: string
  
  name of the group
Returns Promise<ChannelGroupCopy>
- Defined in node/ChannelGroup.ts:70

createPerm

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

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

del

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

delPerm

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

getIcon

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

Returns Promise<Buffer>
- Defined in node/ChannelGroup.ts:134

getIconId

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

Returns Promise<number>
- Defined in node/ChannelGroup.ts:139

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

permList

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

rename

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

setClient

setClient(channel, client): Promise<[]>
sets the channel group of a client
Parameters
- channel: string | TeamSpeakChannel
  
  the channel in which the client should be assigned the Group
- client: string | TeamSpeakClient
  
  the client database id which should be added to the Group
Returns Promise<[]>
- Defined in node/ChannelGroup.ts:121

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

`Static` getId

getId<T>(channel?): T extends undefined
? undefined
: string
retrieves the client id from a string or teamspeak client
Type Parameters
- T extends TeamSpeakChannelGroup.GroupType
Parameters
- Optional channel: T
Returns T extends undefined
? undefined
: string
- Defined in node/ChannelGroup.ts:144

`Static` getMultipleIds

getMultipleIds(client): string[]
retrieves the clients from an array
Parameters
- client: TeamSpeakChannelGroup.MultiGroupType
Returns string[]
- Defined in node/ChannelGroup.ts:150

Class TeamSpeakChannelGroup

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

parent: TeamSpeak

list: ChannelGroupEntry

Returns TeamSpeakChannelGroup

Accessors

cgid

Returns string

iconid

Returns string

nMemberAddp

Returns number

nMemberRemovep

Returns number

nModifyp

Returns number

name

Returns string

namemode

Returns number

savedb

Returns number

sortid

Returns number

type

Returns number

Methods

addPerm

Parameters

perm: PermType

Returns Promise<[]>

clientList

Parameters

channel: string | TeamSpeakChannel

Returns Promise<ChannelGroupClientList>

copy

Parameters

tcgid: string | TeamSpeakChannelGroup

type: number

name: string

Returns Promise<ChannelGroupCopy>

createPerm

Returns Permission<any>

del

Parameters

Optional force: boolean

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 ChannelGroupEntry

Parameters

name: Y

Returns ChannelGroupEntry[Y]

permList

Parameters

permsid: boolean = false

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

rename

Parameters

name: string

Returns Promise<[]>

`Optional` force: boolean

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

`Static` getId

`Optional` channel: T

Returns T extends undefined
? undefined
: string

`Static` getMultipleIds