@japofc/baileys - v2.4.7
    Preparing search index...

    Interface Gatekeeper

    interface Gatekeeper {
        blockedCount: number;
        allowChat(jid: string): void;
        allows(msg: unknown): boolean;
        allowsJid(user?: string, chat?: string): boolean;
        allowUser(jid: string): void;
        banChat(
            jid: string,
            reason?: string,
            options?: { expiresInMs?: number },
        ): void;
        banMany(
            jids: string[],
            reason?: string,
            options?: { expiresInMs?: number },
        ): number;
        banUser(
            jid: string,
            reason?: string,
            options?: { expiresInMs?: number },
        ): void;
        clear(): void;
        disallowChat(jid: string): boolean;
        disallowUser(jid: string): boolean;
        filter<
            T extends
                (upsert: { messages: unknown[] }, ...rest: unknown[]) => unknown,
        >(
            handler: T,
        ): T;
        getBanInfo(
            jid: string,
        ): { at: number; expiresAt?: number; reason: string } | null;
        getBannedChats(): string[];
        getBannedUsers(): string[];
        isBannedChat(jid: string): boolean;
        isBannedUser(jid: string): boolean;
        listBans(): {
            at: number;
            expiresAt: number
            | null;
            jid: string;
            reason: string;
            remainingMs: number | null;
            type: "user" | "chat";
        }[];
        load(snapshot: Record<string, unknown>): void;
        onBlocked(cb: (event: GatekeeperBlockEvent) => void): () => void;
        toJSON(): Record<string, unknown>;
        unbanAll(): number;
        unbanChat(jid: string): boolean;
        unbanUser(jid: string): boolean;
    }
    Index
    blockedCount
    allowChat allows allowsJid allowUser banChat banMany banUser clear disallowChat disallowUser filter getBanInfo getBannedChats getBannedUsers isBannedChat isBannedUser listBans load onBlocked toJSON unbanAll unbanChat unbanUser
    blockedCount: number

    • Parameters

      • Optionaluser: string
      • Optionalchat: string

      Returns boolean

    • Parameters

      • jid: string
      • Optionalreason: string
      • Optionaloptions: { expiresInMs?: number }

      Returns void

    • Bulk ban (raid cleanup). Returns how many were newly added.

      Parameters

      • jids: string[]
      • Optionalreason: string
      • Optionaloptions: { expiresInMs?: number }

      Returns number

    • Parameters

      • jid: string
      • Optionalreason: string
      • Optionaloptions: { expiresInMs?: number }

      Returns void

    • Wrap a messages.upsert handler — banned messages never reach it.

      Type Parameters

      • T extends (upsert: { messages: unknown[] }, ...rest: unknown[]) => unknown

      Parameters

      • handler: T

      Returns T

    • Parameters

      • jid: string

      Returns { at: number; expiresAt?: number; reason: string } | null

    • Detailed ban list with reasons and remaining time.

      Returns {
          at: number;
          expiresAt: number | null;
          jid: string;
          reason: string;
          remainingMs: number | null;
          type: "user" | "chat";
      }[]

    • Parameters

      • snapshot: Record<string, unknown>

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods