Class InteractionsSelfRoleManager

A class that manages self-assignable roles using interactions.

Export

Hierarchy (view full)

Constructors

constructor

Properties

channels client options

Methods

generateRolesChangesListener getRTE handleUserAction registerChannel sendsMessageAndRegisterChannel unregisterChannel userCanBeAddedToRole userCanBeRemovedFromRole userHasMissingRequiredRoles userHasReachedMaxRoles

Constructors

constructor

Properties

Readonly channels

channels: Collection<string, ChannelProperties>

The collection of registered channels.

Name

SelfRoleManager#channels

Readonly client

client: Client<boolean>

The client that instantiated this Manager

Name

SelfRoleManager#client

Readonly options

options: SelfRoleOptions

The options of the manager.

Methods

Protected generateRolesChangesListener

  • generateRolesChangesListener(rolesToEmojis): ((oldMember, newMember) => Promise<void>)

  • Parameters

    Returns ((oldMember, newMember) => Promise<void>)

      • (oldMember, newMember): Promise<void>

      • Parameters

        • oldMember: GuildMember | PartialGuildMember
        • newMember: GuildMember

        Returns Promise<void>

Protected getRTE

Protected handleUserAction

  • handleUserAction(userAction): Promise<void>

  • Handle the behaviour once a user adds a reaction or clicks on a button.

    Parameters

    • userAction: StringSelectMenuInteraction<CacheType> | ButtonInteraction<CacheType>

      the user action, whether it is a reaction or a button interaction

    Returns Promise<void>

registerChannel

Protected sendsMessageAndRegisterChannel

unregisterChannel

  • unregisterChannel(channelID): Promise<void>

  • Unregisters a channel. When a user reacts to the message in it, nothing will happen.

    Parameters

    • channelID: string

    Returns Promise<void>

    Name

    SelfRoleManager#unregisterChannel

Protected userCanBeAddedToRole

  • userCanBeAddedToRole(member, role, userAction): Promise<void>

  • Parameters

    • member: GuildMember
    • role: Role
    • userAction: MessageReaction | PartialMessageReaction | StringSelectMenuInteraction<CacheType> | ButtonInteraction<CacheType>

    Returns Promise<void>

Protected userCanBeRemovedFromRole

  • userCanBeRemovedFromRole(member, role, userAction): Promise<void>

  • Parameters

    • member: GuildMember
    • role: Role
    • userAction: MessageReaction | PartialMessageReaction | StringSelectMenuInteraction<CacheType> | ButtonInteraction<CacheType>

    Returns Promise<void>

Protected userHasMissingRequiredRoles

  • userHasMissingRequiredRoles(member, userAction, role, requiredRoles): Promise<void>

  • Parameters

    • member: GuildMember
    • userAction: MessageReaction | PartialMessageReaction | StringSelectMenuInteraction<CacheType> | ButtonInteraction<CacheType>
    • role: Role
    • requiredRoles: undefined | RoleResolvable[]

    Returns Promise<void>

Protected userHasReachedMaxRoles

  • userHasReachedMaxRoles(member, userAction, numberOfMemberManagedRoles, numberOfMaxRolesAssigned, role): Promise<void>

  • Parameters

    • member: GuildMember
    • userAction: MessageReaction | PartialMessageReaction | StringSelectMenuInteraction<CacheType> | ButtonInteraction<CacheType>
    • numberOfMemberManagedRoles: number
    • numberOfMaxRolesAssigned: undefined | number
    • role: Role

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorchannelsclientoptionsgenerateRolesChangesListenergetRTEhandleUserActionregisterChannelsendsMessageAndRegisterChannelunregisterChanneluserCanBeAddedToRoleuserCanBeRemovedFromRoleuserHasMissingRequiredRolesuserHasReachedMaxRoles