@hunteroi/discord-temp-channels
    Preparing search index...

    Interface ParentChannelOptions

    The configuration for the channel that triggers the system.

    ParentChannelOptions

    interface ParentChannelOptions {
        childAutoDeleteIfEmpty: boolean;
        childAutoDeleteIfOwnerLeaves: boolean;
        childAutoDeleteIfParentGetsUnregistered?: boolean;
        childBitrate?: number;
        childCanBeRenamed?: boolean;
        childCategory?: null | string;
        childMaxUsers?: number;
        childOverwriteRolesAndUsers?: Resolvables[];
        childPermissionOverwriteOptions?: Partial<
            Record<
                | "CreateInstantInvite"
                | "KickMembers"
                | "BanMembers"
                | "Administrator"
                | "ManageChannels"
                | "ManageGuild"
                | "AddReactions"
                | "ViewAuditLog"
                | "PrioritySpeaker"
                | "Stream"
                | "ViewChannel"
                | "SendMessages"
                | "SendTTSMessages"
                | "ManageMessages"
                | "EmbedLinks"
                | "AttachFiles"
                | "ReadMessageHistory"
                | "MentionEveryone"
                | "UseExternalEmojis"
                | "ViewGuildInsights"
                | "Connect"
                | "Speak"
                | "MuteMembers"
                | "DeafenMembers"
                | "MoveMembers"
                | "UseVAD"
                | "ChangeNickname"
                | "ManageNicknames"
                | "ManageRoles"
                | "ManageWebhooks"
                | "ManageEmojisAndStickers"
                | "ManageGuildExpressions"
                | "UseApplicationCommands"
                | "RequestToSpeak"
                | "ManageEvents"
                | "ManageThreads"
                | "CreatePublicThreads"
                | "CreatePrivateThreads"
                | "UseExternalStickers"
                | "SendMessagesInThreads"
                | "UseEmbeddedActivities"
                | "ModerateMembers"
                | "ViewCreatorMonetizationAnalytics"
                | "UseSoundboard"
                | "CreateGuildExpressions"
                | "CreateEvents"
                | "UseExternalSounds"
                | "SendVoiceMessages"
                | "SendPolls"
                | "UseExternalApps"
                | "PinMessages",
                null
                | boolean,
            >,
        >;
        childShouldBeACopyOfParent?: boolean;
        childVoiceFormatRegex: RegExp;
        childVoiceFormat(str: string, count: number): string;
    }
    Index

    Properties

    childAutoDeleteIfEmpty childAutoDeleteIfOwnerLeaves childAutoDeleteIfParentGetsUnregistered? childBitrate? childCanBeRenamed? childCategory? childMaxUsers? childOverwriteRolesAndUsers? childPermissionOverwriteOptions? childShouldBeACopyOfParent? childVoiceFormatRegex

    Methods

    childVoiceFormat

    Properties

    childAutoDeleteIfEmpty: boolean

    Whether the child channel should be removed when empty.

    ParentChannelOptions

    childAutoDeleteIfOwnerLeaves: boolean

    Whether the child channel should be removed when its owner leaves it.

    ParentChannelOptions

    childAutoDeleteIfParentGetsUnregistered?: boolean

    Whether the child channel should be removed if its parent becomes unregistered.

    ParentChannelOptions

    childBitrate?: number

    The bitrate of a child voice channel.

    Will be ignored if childShouldBeACopyOfParent is set to true.

    ParentChannelOptions

    childCanBeRenamed?: boolean

    Whether the child channel can be renamed or not without forcing the add of the prefix. Please notice that if set on true, the capacity to reload channels into memory on bot restart cannot be guaranteed.

    ParentChannelOptions

    childCategory?: null | string

    The category in which the child channels should be created.

    ParentChannelOptions

    childMaxUsers?: number

    The maximum number of users in a child channel.

    Will be ignored if childShouldBeACopyOfParent is set to true.

    ParentChannelOptions

    childOverwriteRolesAndUsers?: Resolvables[]

    The list of users or roles to which the childPermissionOverwriteOption are applied.

    ParentChannelOptions

    childPermissionOverwriteOptions?: Partial<
        Record<
            | "CreateInstantInvite"
            | "KickMembers"
            | "BanMembers"
            | "Administrator"
            | "ManageChannels"
            | "ManageGuild"
            | "AddReactions"
            | "ViewAuditLog"
            | "PrioritySpeaker"
            | "Stream"
            | "ViewChannel"
            | "SendMessages"
            | "SendTTSMessages"
            | "ManageMessages"
            | "EmbedLinks"
            | "AttachFiles"
            | "ReadMessageHistory"
            | "MentionEveryone"
            | "UseExternalEmojis"
            | "ViewGuildInsights"
            | "Connect"
            | "Speak"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "UseVAD"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ManageRoles"
            | "ManageWebhooks"
            | "ManageEmojisAndStickers"
            | "ManageGuildExpressions"
            | "UseApplicationCommands"
            | "RequestToSpeak"
            | "ManageEvents"
            | "ManageThreads"
            | "CreatePublicThreads"
            | "CreatePrivateThreads"
            | "UseExternalStickers"
            | "SendMessagesInThreads"
            | "UseEmbeddedActivities"
            | "ModerateMembers"
            | "ViewCreatorMonetizationAnalytics"
            | "UseSoundboard"
            | "CreateGuildExpressions"
            | "CreateEvents"
            | "UseExternalSounds"
            | "SendVoiceMessages"
            | "SendPolls"
            | "UseExternalApps"
            | "PinMessages",
            null
            | boolean,
        >,
    >

    The permissions overwrites of a child channel.

    ParentChannelOptions

    childShouldBeACopyOfParent?: boolean

    Whether the child channel should be a clone of the parent's channel or not.

    Setting this parameter to true will force the manager to fully clone the parent's channel, giving no use to childBitrate and childMaxUsers. Only the name of the child channel will be customized.

    false

    ParentChannelOptions

    childVoiceFormatRegex: RegExp

    The regular expression that should fit the childVoiceFormat in order to detect the child channels in case the bot crashes and reconnects.

    ParentChannelOptions

    Methods

    • The function that resolves the name of the child voice channels when automatically generated.

      Parameters

      • str: string
      • count: number

      Returns string

      {string}

      ParentChannelOptions

    Settings

    Member Visibility

    On This Page

    Properties
    Methods