RequireBotPermissions

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

Checks the bot's own member, so unlike RequirePermissionsRequirePermissions it attaches to a modal handler too.

See also:Gated

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

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

import { PermissionFlagsBits } from 'discord.js';

\@Gated(RequireBotPermissions([PermissionFlagsBits.BanMembers]))
\@ModalRoute(MyModalId)
class MyModalHandler extends ModalHandler<[typeof MyModalId]> {
    async execute() {
        // ...
    }
}

import { PermissionFlagsBits } from 'discord.js';

\@Gated(RequireBotPermissions([PermissionFlagsBits.BanMembers]))
\@ModalRoute(MyModalId)
class MyModalHandler extends ModalHandler<[typeof MyModalId]> {
    async execute() {
        // ...
    }
}

scope

scope: BotPermissionScope

scope: BotPermissionScope

The permission flag bits the bot must all hold.

options?

options?: RequirePermissionsOptions

options?: RequirePermissionsOptions

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