Class TeamSpeakChannel

Hierarchy

Abstract<ChannelEntry>
- TeamSpeakChannel

Constructors

constructor

new TeamSpeakChannel(parent, list): TeamSpeakChannel
Parameters
- parent: TeamSpeak
- list: ChannelEntry
Returns TeamSpeakChannel
Overrides Abstract<ChannelEntry>.constructor
- Defined in node/Channel.ts:10

Accessors

bannerGfxUrl

get bannerGfxUrl(): string
Returns string
- Defined in node/Channel.ts:90

bannerMode

get bannerMode(): number
Returns number
- Defined in node/Channel.ts:94

cid

get cid(): string
Returns string
- Defined in node/Channel.ts:14

codec

get codec(): Codec
Returns Codec
- Defined in node/Channel.ts:50

codecQuality

get codecQuality(): number
Returns number
- Defined in node/Channel.ts:54

flagDefault

get flagDefault(): boolean
Returns boolean
- Defined in node/Channel.ts:34

flagPassword

get flagPassword(): boolean
Returns boolean
- Defined in node/Channel.ts:38

flagPermanent

get flagPermanent(): boolean
Returns boolean
- Defined in node/Channel.ts:42

flagSemiPermanent

get flagSemiPermanent(): boolean
Returns boolean
- Defined in node/Channel.ts:46

iconId

get iconId(): string
Returns string
- Defined in node/Channel.ts:62

maxclients

get maxclients(): number
Returns number
- Defined in node/Channel.ts:74

maxfamilyclients

get maxfamilyclients(): number
Returns number
- Defined in node/Channel.ts:78

name

get name(): string
Returns string
- Defined in node/Channel.ts:26

neededSubscribePower

get neededSubscribePower(): number
Returns number
- Defined in node/Channel.ts:86

neededTalkPower

get neededTalkPower(): number
Returns number
- Defined in node/Channel.ts:58

order

get order(): number
Returns number
- Defined in node/Channel.ts:22

pid

get pid(): string
Returns string
- Defined in node/Channel.ts:18

secondsEmpty

get secondsEmpty(): number
Returns number
- Defined in node/Channel.ts:66

topic

get topic(): string
Returns string
- Defined in node/Channel.ts:30

totalClients

get totalClients(): number
Returns number
- Defined in node/Channel.ts:82

totalClientsFamily

get totalClientsFamily(): number
Returns number
- Defined in node/Channel.ts:70

Methods

createPerm

createPerm(): Permission<any>
Adds a permission to a channel Multiple permissions can be added by providing the two parameters of each permission. A permission can be specified by permid or permsid.

Returns Permission<any>
- Defined in node/Channel.ts:164

del

del(force?): Promise<[]>
Deletes an existing channel by ID. If force is set to 1, the channel will be deleted even if there are clients within. The clients will be kicked to the default channel with an appropriate reason message.
Parameters
- force: boolean = false
  
  if set to 1 the channel will be deleted even when clients are in it
Returns Promise<[]>
- Defined in node/Channel.ts:128

delPerm

delPerm(perm): Promise<[]>
Removes a set of specified permissions from a channel. 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/Channel.ts:174

edit

edit(properties): Promise<[]>
Changes a channels configuration using given properties. Note that this command accepts multiple properties which means that you're able to change all settings of the channel specified with cid at once.
Parameters
- properties: ChannelEdit
  
  the properties of the channel which should get changed
Returns Promise<[]>
- Defined in node/Channel.ts:136

getClients

getClients(filter?): Promise<TeamSpeakClient[]>
Gets a List of Clients in the current Channel
Parameters
- filter: Partial<ClientEntry> = {}
  
  the filter object
Returns Promise<TeamSpeakClient[]>
- Defined in node/Channel.ts:182

getIcon

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

Returns Promise<Buffer>
- Defined in node/Channel.ts:188

getIconId

getIconId(): Promise<number>
returns the icon name of the channel

Returns Promise<number>
- Defined in node/Channel.ts:193

getInfo

getInfo(): Promise<ChannelInfo>
returns detailed configuration information about a channel including ID, topic, description, etc

Returns Promise<ChannelInfo>
- Defined in node/Channel.ts:99

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

message

message(msg): Promise<void>
sends a message to the specified channel
Parameters
- msg: string
  
  message which should be sent to the channel
Returns Promise<void>
- Defined in node/Channel.ts:118

move

move(parent, order?): Promise<[]>
Moves a channel to a new parent channel with the ID cpid. If order is specified, the channel will be sorted right under the channel with the specified ID. If order is set to 0, the channel will be sorted right below the new parent.
Parameters
- parent: string | TeamSpeakChannel
  
  channel parent id
- order: number = 0
  
  channel sort order
Returns Promise<[]>
- Defined in node/Channel.ts:110

permList

permList(permsid?): Promise<Permission<{
cid: string;
}>[]>
Displays a list of permissions defined for a channel.
Parameters
- permsid: boolean = false
  
  whether the permsid should be displayed aswell
Returns Promise<Permission<{
cid: string;
}>[]>
- Defined in node/Channel.ts:144

setPerm

setPerm(perm): Promise<[]>
Adds a set of specified permissions to a channel. Multiple permissions can be added by providing the two parameters of each permission. A permission can be specified by permid or permsid.
Parameters
- perm: PermType
  
  permission object to set
Returns Promise<[]>
- Defined in node/Channel.ts:154

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): TeamSpeakChannel
updates the cache with the given object
Parameters
- props: ResponseEntry
Returns TeamSpeakChannel
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 ChannelType
Parameters
- Optional channel: T
Returns T extends undefined
? undefined
: string
- Defined in node/Channel.ts:198

`Static` getMultipleIds

getMultipleIds(channels): string[]
retrieves the clients from an array
Parameters
- channels: MultiChannelType
Returns string[]
- Defined in node/Channel.ts:204

Generated using TypeDoc