Functionseedcordv0.13.0

RequireRole

Requires the caller to have roleIdroleId, read from the member's role cache. Refuses outside a guild first, then when the role is missing.

Interaction-only and excludes ModalSubmit.

See also:Gated

RequireRole(
    roleId: string,
    options?: RequireRoleOptions
): Gate<InteractionGateContext<NonModalInteraction>, "RequireRole">

RequireRole(
    roleId: string,
    options?: RequireRoleOptions
): Gate<InteractionGateContext<NonModalInteraction>, "RequireRole">

\@Gated(RequireRole('123456789012345678'))
\@SlashRoute('vip')
class VipHandler extends SlashHandler<'vip'> {
    async execute() {
        // ...
    }
}

\@Gated(RequireRole('123456789012345678'))
\@SlashRoute('vip')
class VipHandler extends SlashHandler<'vip'> {
    async execute() {
        // ...
    }
}

roleId

roleId: string

roleId: string

The role snowflake the caller must hold, read from the member's role cache.

options?

options?: RequireRoleOptions

options?: RequireRoleOptions

Override each refusal, the outside-guild one with notInGuildnotInGuild and the missing-role one with missingRolemissingRole.