Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamSpeakServerGroup

Hierarchy

Index

Type aliases

Static GroupType

GroupType: string | TeamSpeakServerGroup

Static MultiGroupType

MultiGroupType: string[] | TeamSpeakServerGroup[] | GroupType

Constructors

constructor

Accessors

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

sgid

  • get sgid(): string

sortid

  • get sortid(): number

type

  • get type(): number

Methods

addClient

  • Adds a client to the server group. Please note that a client cannot be added to default groups or template groups.

    Parameters

    • client: ClientType

      the client database id which should be added to the Group

    Returns Promise<[]>

addPerm

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

clientList

copy

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

createPerm

del

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

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

    Returns Promise<[]>

delClient

  • removes a client specified with cldbid from the servergroup

    Parameters

    • client: ClientType

      the client database id which should be removed from the group

    Returns Promise<[]>

delPerm

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

getIcon

  • getIcon(): Promise<Buffer>

getIconId

  • getIconId(): Promise<number>

getNameSpace

  • getNameSpace(): string

getParent

getPropertyByName

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

permList

  • permList(permsid: boolean): 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 }>[]>

rename

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

    Parameters

    • name: string

      new name of the group

    Returns Promise<[]>

toJSON

  • toJSON(includeNameSpace?: boolean): {}

updateCache

Static getId

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

    Type parameters

    Parameters

    • Optional group: T

    Returns T extends undefined ? undefined : string

Static getMultipleIds

Generated using TypeDoc