Class TempChannelsManager

The temporary channels manager.

Export

TempChannelsManager

Hierarchy

VoiceChannelsManager
- TempChannelsManager

Index

Constructors

Properties

Methods

bindChannelToParent getParentChannel registerChannel unbindChannelFromParent unregisterChannel

Constructors

constructor

new TempChannelsManager(client: Client): TempChannelsManager
Creates an instance of TempChannelsManager.
Parameters
- client: Client
Returns TempChannelsManager
Memberof
TempChannelsManager
Overrides VoiceChannelsManager.constructor
- Defined in TempChannelsManager.ts:38

Properties

`Readonly`client

client: Client

Methods

bindChannelToParent

bindChannelToParent(
    parent: ParentChannelData,
    voiceChannel: VoiceChannel,
    owner: GuildMember,
): void
Adds a voice channel as a child of a parent. Emits the TempChannelsManagerEvents.childAdd event.
Parameters
- parent: ParentChannelData
- voiceChannel: VoiceChannel
- owner: GuildMember
Returns void
{void}

Memberof
VoiceChannelsManager
Inherited from VoiceChannelsManager.bindChannelToParent
- Defined in VoiceChannelsManager.ts:110

`Protected`getParentChannel

getParentChannel(
channelId: string,
lookAsChild?: boolean,
): undefined | ParentChannelData
Protected
Gets the parent channel either based on its ID or by looking for a match on the provided ID and its list of children.
Parameters
- channelId: string
- OptionallookAsChild: boolean = false
Returns undefined | ParentChannelData
Memberof
VoiceChannelsManager
Inherited from VoiceChannelsManager.getParentChannel
- Defined in VoiceChannelsManager.ts:46

registerChannel

registerChannel(channelId: string, options?: ParentChannelOptions): void
Registers a parent channel. When a user joins a it, a child will be created and they will be moved to it.
Parameters
- channelId: string
- Optionaloptions: ParentChannelOptions = ...
  [DRoom #${count}] ${name}, childFormatRegex: /^[DRoom #\d+]\s+.+/i, childPermissionOverwriteOption: { ManageChannels: true } }]
Returns void
Overrides VoiceChannelsManager.registerChannel
- Defined in TempChannelsManager.ts:69

unbindChannelFromParent

unbindChannelFromParent(parent: ParentChannelData, voiceChannelId: string): void
Removes a voice channel from the list of children of a parent. Emits the TempChannelsManagerEvents.childRemove event.
Parameters
- parent: ParentChannelData
- voiceChannelId: string
Returns void
{void}

Memberof
VoiceChannelsManager
Inherited from VoiceChannelsManager.unbindChannelFromParent
- Defined in VoiceChannelsManager.ts:131

unregisterChannel

unregisterChannel(channelId: string): boolean
Unregisters a parent channel. When a user joins it, nothing will happen.
Parameters
- channelId: string
Returns boolean
Overrides VoiceChannelsManager.unregisterChannel
- Defined in TempChannelsManager.ts:89