Class ChannelGroupManager

Manages the channel groups in the TeamSpeak server.

Hierarchy (View Summary)

CachedManager<ChannelGroup, RawChannelGroup>
- ChannelGroupManager

Index

Constructors

Accessors

Methods

_add copy create delete fetch rename resolveId

Constructors

constructor

new ChannelGroupManager(query: Query): ChannelGroupManager
Parameters
- query: Query
Returns ChannelGroupManager
Overrides CachedManager.constructor
- Defined in managers/channel-group-manager.ts:42

Accessors

cache

get cache(): Collection<number, Holds>
Returns Collection<number, Holds>
Inherited from CachedManager.cache
- Defined in managers/cached-manager.ts:25

Methods

_add

_add(
    data: Partial<RawHolds>,
    cache?: boolean,
    __namedParameters?: { id?: number },
): ChannelGroup
Parameters
- data: Partial<RawHolds>
- cache: boolean = true
- __namedParameters: { id?: number } = {}
Returns ChannelGroup
Inherited from CachedManager._add
- Defined in managers/cached-manager.ts:29

copy

copy(
sourceGroup: ChannelGroupResolvable,
options: ChannelGroupCopyOptions_Create,
): Promise<ChannelGroup>
Copies a channel group into a new channel group.
Parameters
- sourceGroup: ChannelGroupResolvable
  The source channel group to copy.
- options: ChannelGroupCopyOptions_Create
  The options for copying the channel group.
Returns Promise<ChannelGroup>
The created channel group.
- Defined in managers/channel-group-manager.ts:120
copy(
sourceGroup: ChannelGroupResolvable,
options: ChannelGroupCopyOptions_Target,
): Promise<null>
Copies a channel group into an existing channel group.
Parameters
- sourceGroup: ChannelGroupResolvable
  The source channel group to copy.
- options: ChannelGroupCopyOptions_Target
  The options for copying the channel group.
Returns Promise<null>
A promise that resolves when the channel group has been copied.
- Defined in managers/channel-group-manager.ts:132

create

create(options: ChannelGroupCreateOptions): Promise<ChannelGroup>
Creates a new channel group.
Parameters
- options: ChannelGroupCreateOptions
  The options for creating the channel group.
Returns Promise<ChannelGroup>
The created channel group.
- Defined in managers/channel-group-manager.ts:80

delete

delete(channelGroup: ChannelGroupResolvable, force?: boolean): Promise<void>
Deletes a channel group.
Parameters
- channelGroup: ChannelGroupResolvable
  The channel group to delete.
- Optionalforce: boolean = false
  Whether to force the deletion. Force deletion will remove the channel group from all clients.
Returns Promise<void>
A promise that resolves when the channel group has been deleted.
- Defined in managers/channel-group-manager.ts:95

fetch

fetch(): Promise<Collection<number, ChannelGroup>>
Obtains all channel groups from TeamSpeak.

Returns Promise<Collection<number, ChannelGroup>>
The channel groups.
- Defined in managers/channel-group-manager.ts:60

rename

rename(
channelGroup: ChannelGroupResolvable,
name: string,
): Promise<ChannelGroup>
Renames a channel group.
Parameters
- channelGroup: ChannelGroupResolvable
  The channel group to rename.
- name: string
  The new name for the channel group.
Returns Promise<ChannelGroup>
The updated channel group.
- Defined in managers/channel-group-manager.ts:107

resolveId

resolveId(channelGroup: ChannelGroupResolvable): number
Resolves a channel group ID.
Parameters
- channelGroup: ChannelGroupResolvable
  The object to resolve.
Returns number
The channel group ID.
- Defined in managers/channel-group-manager.ts:51