Class ChannelLockManager

Hierarchy (View Summary, Expand)

Constructors

constructor

Methods

boot lock lockAll unlock unlockAll getName

Constructors

constructor

Properties

Protected Readonlyapplication

application: Application

Protected Readonlyclient

client: BaseClient

Protected Readonlylogger

logger: Logger

Protected Staticname

name: string

Returns the name of the function. Function names are read-only and can not be changed.

Methods

boot

lock

  • lock(
        channel:
            | CategoryChannel
            | NewsChannel
            | StageChannel
            | TextChannel
            | VoiceChannel
            | ForumChannel
            | MediaChannel,
    ): Promise<
        | {
            code?: undefined;
            message: string;
            status: "error";
            type: "not_managable";
        }
        | {
            code?: undefined;
            message: string;
            status: "error";
            type: "channel_already_locked";
        }
        | {
            code: string
            | number;
            message: string;
            status: "error";
            type: "api_error";
        }
        | { code?: undefined; message: string; status: "error"; type: "unknown" }
        | {
            code?: undefined;
            message?: undefined;
            status: "success";
            type?: undefined;
        },
    >

    Parameters

    • channel:
          | CategoryChannel
          | NewsChannel
          | StageChannel
          | TextChannel
          | VoiceChannel
          | ForumChannel
          | MediaChannel

    Returns Promise<
        | {
            code?: undefined;
            message: string;
            status: "error";
            type: "not_managable";
        }
        | {
            code?: undefined;
            message: string;
            status: "error";
            type: "channel_already_locked";
        }
        | {
            code: string
            | number;
            message: string;
            status: "error";
            type: "api_error";
        }
        | { code?: undefined; message: string; status: "error"; type: "unknown" }
        | {
            code?: undefined;
            message?: undefined;
            status: "success";
            type?: undefined;
        },
    >

lockAll

  • lockAll(
        guild: Guild,
        channels?: Iterable<GuildBasedChannel, any, any>,
    ): Promise<
        {
            alreadyLocked: number;
            errors: string[];
            permissionErrors: number;
            skipped: number;
            success: number;
            total: number;
        },
    >

    Parameters

    • guild: Guild
    • Optionalchannels: Iterable<GuildBasedChannel, any, any>

    Returns Promise<
        {
            alreadyLocked: number;
            errors: string[];
            permissionErrors: number;
            skipped: number;
            success: number;
            total: number;
        },
    >

unlock

  • unlock(
        channel:
            | CategoryChannel
            | NewsChannel
            | StageChannel
            | TextChannel
            | VoiceChannel
            | ForumChannel
            | MediaChannel,
    ): Promise<
        | {
            code?: undefined;
            message: string;
            status: "error";
            type: "not_managable";
        }
        | {
            code?: undefined;
            message: string;
            status: "error";
            type: "channel_not_locked";
        }
        | {
            code: string
            | number;
            message: string;
            status: "error";
            type: "api_error";
        }
        | { code?: undefined; message: string; status: "error"; type: "unknown" }
        | {
            code?: undefined;
            message?: undefined;
            status: "success";
            type?: undefined;
        },
    >

    Parameters

    • channel:
          | CategoryChannel
          | NewsChannel
          | StageChannel
          | TextChannel
          | VoiceChannel
          | ForumChannel
          | MediaChannel

    Returns Promise<
        | {
            code?: undefined;
            message: string;
            status: "error";
            type: "not_managable";
        }
        | {
            code?: undefined;
            message: string;
            status: "error";
            type: "channel_not_locked";
        }
        | {
            code: string
            | number;
            message: string;
            status: "error";
            type: "api_error";
        }
        | { code?: undefined; message: string; status: "error"; type: "unknown" }
        | {
            code?: undefined;
            message?: undefined;
            status: "success";
            type?: undefined;
        },
    >

unlockAll

  • unlockAll(
        guild: Guild,
        channels?: Iterable<GuildBasedChannel, any, any>,
    ): Promise<
        {
            errors: string[];
            notLocked: number;
            permissionErrors: number;
            skipped: number;
            success: number;
            total: number;
        },
    >

    Parameters

    • guild: Guild
    • Optionalchannels: Iterable<GuildBasedChannel, any, any>

    Returns Promise<
        {
            errors: string[];
            notLocked: number;
            permissionErrors: number;
            skipped: number;
            success: number;
            total: number;
        },
    >

StaticgetName

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR