Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamSpeakChannelGroup

Hierarchy

Index

Type aliases

Static GroupType

GroupType: string | TeamSpeakChannelGroup

Static MultiGroupType

MultiGroupType: string[] | TeamSpeakChannelGroup[] | GroupType

Constructors

constructor

Accessors

cgid

  • get cgid(): string

iconid

  • get iconid(): string

nMemberAddp

  • get nMemberAddp(): number

nMemberRemovep

  • get nMemberRemovep(): number

nModifyp

  • get nModifyp(): number

name

  • get name(): string

namemode

  • get namemode(): number

savedb

  • get savedb(): number

sortid

  • get sortid(): number

type

  • get type(): number

Methods

addPerm

  • Adds a specified permissions to the channel group. A permission can be specified by permid or permsid.

    Parameters

    Returns Promise<[]>

clientList

copy

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

createPerm

del

  • del(force?: undefined | false | true): 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: undefined | false | true

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

    Returns Promise<[]>

delPerm

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

getIcon

  • getIcon(): Promise<Buffer>

getIconId

  • getIconId(): Promise<number>

getNameSpace

  • getNameSpace(): string

getParent

getPropertyByName

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

permList

  • permList(permsid?: boolean): Promise<Permission<{ cgid: string }>[]>
  • returns a list of permissions assigned to the channel group specified with cgid.

    Parameters

    • Default value permsid: boolean = false

      if the permsid option is set to true the output will contain the permission names

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

rename

  • rename(name: string): Promise<[]>
  • changes the name of the channelgroup

    Parameters

    • name: string

      new name of the group

    Returns Promise<[]>

setClient

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