Class ModerationActionService

Hierarchy (View Summary, Expand)

Constructors

constructor

Methods

boot summarizeActions takeActions 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

summarizeActions

  • summarizeActions(
        actions: (
            | {
                delete_timeframe?: number;
                duration?: number;
                notify?: boolean;
                reason?: string;
                type: "ban";
            }
            | { notify?: boolean; reason?: string; type: "kick" }
            | { duration?: number; notify?: boolean; reason?: string; type: "mute" }
            | {
                duration?: number;
                mode: "give" | "take";
                notify?: boolean;
                reason?: string;
                roles: string[];
                type: "role";
            }
            | { type: "none" }
            | { notify?: boolean; reason?: string; type: "warn" }
            | { notify: true; reason?: string; type: "verbal_warn" }
            | { count: number; notify?: boolean; reason?: string; type: "clear" }
            | { type: "delete_message" }
        )[],
    ): string

    Parameters

    • actions: (
          | {
              delete_timeframe?: number;
              duration?: number;
              notify?: boolean;
              reason?: string;
              type: "ban";
          }
          | { notify?: boolean; reason?: string; type: "kick" }
          | { duration?: number; notify?: boolean; reason?: string; type: "mute" }
          | {
              duration?: number;
              mode: "give" | "take";
              notify?: boolean;
              reason?: string;
              roles: string[];
              type: "role";
          }
          | { type: "none" }
          | { notify?: boolean; reason?: string; type: "warn" }
          | { notify: true; reason?: string; type: "verbal_warn" }
          | { count: number; notify?: boolean; reason?: string; type: "clear" }
          | { type: "delete_message" }
      )[]

    Returns string

takeActions

  • takeActions(
        guild: Guild,
        target: GuildMember | User,
        actions: (
            | {
                delete_timeframe?: number;
                duration?: number;
                notify?: boolean;
                reason?: string;
                type: "ban";
            }
            | { notify?: boolean; reason?: string; type: "kick" }
            | { duration?: number; notify?: boolean; reason?: string; type: "mute" }
            | {
                duration?: number;
                mode: "give" | "take";
                notify?: boolean;
                reason?: string;
                roles: string[];
                type: "role";
            }
            | { type: "none" }
            | { notify?: boolean; reason?: string; type: "warn" }
            | { notify: true; reason?: string; type: "verbal_warn" }
            | { count: number; notify?: boolean; reason?: string; type: "clear" }
            | { type: "delete_message" }
        )[],
        payload?: TakeActionPayload,
    ): Promise<TakeActionResult>

    Parameters

    • guild: Guild
    • target: GuildMember | User
    • actions: (
          | {
              delete_timeframe?: number;
              duration?: number;
              notify?: boolean;
              reason?: string;
              type: "ban";
          }
          | { notify?: boolean; reason?: string; type: "kick" }
          | { duration?: number; notify?: boolean; reason?: string; type: "mute" }
          | {
              duration?: number;
              mode: "give" | "take";
              notify?: boolean;
              reason?: string;
              roles: string[];
              type: "role";
          }
          | { type: "none" }
          | { notify?: boolean; reason?: string; type: "warn" }
          | { notify: true; reason?: string; type: "verbal_warn" }
          | { count: number; notify?: boolean; reason?: string; type: "clear" }
          | { type: "delete_message" }
      )[]
    • payload: TakeActionPayload = {}

    Returns Promise<TakeActionResult>

StaticgetName

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR