Skip to content
Functioncorev0.12.0

RequireBotPermissions

Requires the bot to hold every permission in scope. Refuses outside a guild first, then when a permission is missing. The Administrator bit passes any scope.

The default 'channel' scope reads the bot's effective channel set (wire app_permissions), what Discord enforces in the invoked channel. The 'guild' scope reads the bot's base set from roles and requires a GuildPermissionsContext, fitting a gateway handler only. The channel scope requires an AppPermissionsContext. An event handler takes in: 'guild'.

Throws:

  • A SeedcordError when the 'guild' scope runs and the bot's own member isn't cached.

See also:the @Gated decorator from your transport package

RequireBotPermissions(
    scope: PermissionScope,
    options: RequireBotPermissionsOptions & { in: "guild" }
): Gate<GuildPermissionsContext, "RequireBotPermissions">

scope

The permission flag bits the bot must all hold.

options

options: RequireBotPermissionsOptions & { in: 'guild'; }

Pick the scope with in. Replace a refusal with a Notice class as notInGuild or missing.