RequirePermissions

Requires the caller to hold every permission in scopescope, via checkPermissionscheckPermissions. Refuses outside a guild.

Interaction-only and excludes ModalSubmit, since a modal lacks a reliable cached caller member.

See also:Gated

RequirePermissions(
    scope: BotPermissionScope,
    options?: RequirePermissionsOptions
): Gate<InteractionGateContext<NonModalInteraction>, "RequirePermissions">

RequirePermissions(
    scope: BotPermissionScope,
    options?: RequirePermissionsOptions
): Gate<InteractionGateContext<NonModalInteraction>, "RequirePermissions">

import { PermissionFlagsBits } from 'discord.js';

\@Gated(RequirePermissions([PermissionFlagsBits.BanMembers]))
\@SlashRoute('ban')
class BanHandler extends SlashHandler<'ban'> {
    async execute() {
        const target = this.options.getUser('target');
    }
}

import { PermissionFlagsBits } from 'discord.js';

\@Gated(RequirePermissions([PermissionFlagsBits.BanMembers]))
\@SlashRoute('ban')
class BanHandler extends SlashHandler<'ban'> {
    async execute() {
        const target = this.options.getUser('target');
    }
}

scope

scope: BotPermissionScope

scope: BotPermissionScope

The permission flag bits the caller must all hold.

options?

options?: RequirePermissionsOptions

options?: RequirePermissionsOptions

Override each refusal, the outside-guild one with notInGuildnotInGuild and the missing-permissions one with missingmissing.