Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamSpeakChannel

Hierarchy

Index

Type aliases

Static ChannelType

ChannelType: string | TeamSpeakChannel

Static MultiChannelType

MultiChannelType: string[] | TeamSpeakChannel[] | ChannelType

Constructors

constructor

Accessors

bannerGfxUrl

  • get bannerGfxUrl(): string

bannerMode

  • get bannerMode(): number

cid

  • get cid(): string

codec

codecQuality

  • get codecQuality(): number

flagDefault

  • get flagDefault(): boolean

flagPassword

  • get flagPassword(): boolean

flagPermanent

  • get flagPermanent(): boolean

flagSemiPermanent

  • get flagSemiPermanent(): boolean

iconId

  • get iconId(): string

maxclients

  • get maxclients(): number

maxfamilyclients

  • get maxfamilyclients(): number

name

  • get name(): string

neededSubscribePower

  • get neededSubscribePower(): number

neededTalkPower

  • get neededTalkPower(): number

order

  • get order(): number

pid

  • get pid(): string

secondsEmpty

  • get secondsEmpty(): number

topic

  • get topic(): string

totalClients

  • get totalClients(): number

totalClientsFamily

  • get totalClientsFamily(): number

Methods

createPerm

  • 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>

del

  • del(force?: boolean): 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

    • Default value force: boolean = false

      if set to 1 the channel will be deleted even when clients are in it

    Returns Promise<[]>

delPerm

  • delPerm(perm: string | number): 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<[]>

edit

  • 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<[]>

getClients

getIcon

  • getIcon(): Promise<Buffer>

getIconId

  • getIconId(): Promise<number>

getInfo

getNameSpace

  • getNameSpace(): string

getParent

getPropertyByName

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

move

  • 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

    • Default value order: number = 0

      channel sort order

    Returns Promise<[]>

permList

  • permList(permsid?: boolean): Promise<Permission<{ cid: string }>[]>
  • Displays a list of permissions defined for a channel.

    Parameters

    • Default value permsid: boolean = false

      whether the permsid should be displayed aswell

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

setPerm

  • 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<[]>

toJSON

  • toJSON(includeNameSpace?: boolean): {}

updateCache

Static getId

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

    Type parameters

    Parameters

    • Optional channel: T

    Returns T extends undefined ? undefined : string

Static getMultipleIds

Generated using TypeDoc