Class SelfRoleManager`Abstract`

The manager handling assignation and removal of roles based on user interactions/reactions.

Export

SelfRoleManager

Hierarchy (View Summary)

EventEmitter
- SelfRoleManager
  - InteractionsSelfRoleManager
  - ReactionsSelfRoleManager

Index

Constructors

constructor

new SelfRoleManager(client?: Client, options?: SelfRoleOptions): SelfRoleManager
Creates an instance of SelfRoleManager.
Parameters
- Optionalclient: Client
  The client that instantiated this Manager
- Optionaloptions: SelfRoleOptions = ...
Returns SelfRoleManager
Overrides EventEmitter.constructor
- Defined in SelfRoleManager.ts:72

Properties

`Readonly`channels

channels: Collection<string, ChannelProperties>

The collection of registered channels.

Name

SelfRoleManager#channels

`Readonly`client

client: Client

The client that instantiated this Manager

Name

SelfRoleManager#client

`Readonly`options

options: SelfRoleOptions

The options of the manager.

Methods

`Protected`generateRolesChangesListener

generateRolesChangesListener(
    rolesToEmojis: RoleToEmojiData[],
): (
    oldMember: GuildMember | PartialGuildMember,
    newMember: GuildMember,
) => Promise<void>
Parameters
- rolesToEmojis: RoleToEmojiData[]
Returns (
oldMember: GuildMember | PartialGuildMember,
newMember: GuildMember,
) => Promise<void>
- Defined in SelfRoleManager.ts:367

`Protected`getRTE

getRTE(
    sender:
        | MessageReaction
        | PartialMessageReaction
        | StringSelectMenuInteraction<CacheType>
        | ButtonInteraction<CacheType>,
    channelOptions: ChannelOptions,
    emoji?: null | GuildEmoji | ReactionEmoji | APIMessageComponentEmoji,
): undefined | RoleToEmojiData | RoleToEmojiData[]
Returns the RTE (and its role) based on the emoji provided.
Parameters
- sender:
      | MessageReaction
      | PartialMessageReaction
      | StringSelectMenuInteraction<CacheType>
      | ButtonInteraction<CacheType>
  the button component or message reaction
- channelOptions: ChannelOptions
  the channel options
- Optionalemoji: null | GuildEmoji | ReactionEmoji | APIMessageComponentEmoji
  the emoji clicked
Returns undefined | RoleToEmojiData | RoleToEmojiData[]
The proper RoteToEmojiData
- Defined in SelfRoleManager.ts:235

`Protected` `Abstract`handleUserAction

handleUserAction(
    userAction:
        | MessageReaction
        | PartialMessageReaction
        | StringSelectMenuInteraction<CacheType>
        | ButtonInteraction<CacheType>,
    user?: null | User | PartialUser,
    isReactionRemoval?: null | boolean,
): Promise<void>
Handle the behaviour once a user adds a reaction or clicks on a button.
Parameters
- userAction:
      | MessageReaction
      | PartialMessageReaction
      | StringSelectMenuInteraction<CacheType>
      | ButtonInteraction<CacheType>
  the user action, whether it is a reaction or a button interaction
- Optionaluser: null | User | PartialUser
  the user who did the action
- OptionalisReactionRemoval: null | boolean
  invert the logic of the action (only for reactions)
Returns Promise<void>
- Defined in SelfRoleManager.ts:218

registerChannel

registerChannel(channelID: string, options: ChannelOptions): Promise<void>
Registers a channel. When a user reacts to the message in it, a role will be given/removed.
Parameters
- channelID: string
- options: ChannelOptions
Returns Promise<void>
Name
SelfRoleManager#registerChannel
- Defined in SelfRoleManager.ts:124

`Protected` `Abstract`sendsMessageAndRegisterChannel

sendsMessageAndRegisterChannel(
channel: TextChannel,
channelOptions: ChannelOptions,
): Promise<void>
Handle the registering of a channel, sending the main message for the automated role-giver system.
Parameters
- channel: TextChannel
- channelOptions: ChannelOptions
Returns Promise<void>
- Defined in SelfRoleManager.ts:207

unregisterChannel

unregisterChannel(channelID: string): 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
- Defined in SelfRoleManager.ts:152

`Protected`userCanBeAddedToRole

userCanBeAddedToRole(
    member: GuildMember,
    role: Role,
    userAction:
        | MessageReaction
        | PartialMessageReaction
        | StringSelectMenuInteraction<CacheType>
        | ButtonInteraction<CacheType>,
): Promise<void>
Parameters
- member: GuildMember
- role: Role
- userAction:
      | MessageReaction
      | PartialMessageReaction
      | StringSelectMenuInteraction<CacheType>
      | ButtonInteraction<CacheType>
Returns Promise<void>
- Defined in SelfRoleManager.ts:315

`Protected`userCanBeRemovedFromRole

userCanBeRemovedFromRole(
    member: GuildMember,
    role: Role,
    userAction:
        | MessageReaction
        | PartialMessageReaction
        | StringSelectMenuInteraction<CacheType>
        | ButtonInteraction<CacheType>,
): Promise<void>
Parameters
- member: GuildMember
- role: Role
- userAction:
      | MessageReaction
      | PartialMessageReaction
      | StringSelectMenuInteraction<CacheType>
      | ButtonInteraction<CacheType>
Returns Promise<void>
- Defined in SelfRoleManager.ts:341

`Protected`userHasMissingRequiredRoles

userHasMissingRequiredRoles(
    member: GuildMember,
    userAction:
        | MessageReaction
        | PartialMessageReaction
        | StringSelectMenuInteraction<CacheType>
        | ButtonInteraction<CacheType>,
    role: Role,
    requiredRoles: undefined | RoleResolvable[],
): Promise<void>
Parameters
- member: GuildMember
- userAction:
      | MessageReaction
      | PartialMessageReaction
      | StringSelectMenuInteraction<CacheType>
      | ButtonInteraction<CacheType>
- role: Role
- requiredRoles: undefined | RoleResolvable[]
Returns Promise<void>
- Defined in SelfRoleManager.ts:296

`Protected`userHasReachedMaxRoles

userHasReachedMaxRoles(
    member: GuildMember,
    userAction:
        | MessageReaction
        | PartialMessageReaction
        | StringSelectMenuInteraction<CacheType>
        | ButtonInteraction<CacheType>,
    numberOfMemberManagedRoles: number,
    numberOfMaxRolesAssigned: undefined | number,
    role: Role,
): Promise<void>
Parameters
- member: GuildMember
- userAction:
      | MessageReaction
      | PartialMessageReaction
      | StringSelectMenuInteraction<CacheType>
      | ButtonInteraction<CacheType>
- numberOfMemberManagedRoles: number
- numberOfMaxRolesAssigned: undefined | number
- role: Role
Returns Promise<void>
- Defined in SelfRoleManager.ts:275

Class SelfRoleManagerAbstract

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SelfRoleManager

Properties

Readonlychannels

Name

Readonlyclient

Name

Readonlyoptions

Methods

ProtectedgenerateRolesChangesListener

Parameters

Returns ( oldMember: GuildMember | PartialGuildMember, newMember: GuildMember,) => Promise<void>

ProtectedgetRTE

Parameters

Returns undefined | RoleToEmojiData | RoleToEmojiData[]

Protected AbstracthandleUserAction

Parameters

Returns Promise<void>

registerChannel

Parameters

Returns Promise<void>

Name

Protected AbstractsendsMessageAndRegisterChannel

Parameters

Returns Promise<void>

unregisterChannel

Parameters

Returns Promise<void>

Name

ProtecteduserCanBeAddedToRole

Parameters

Returns Promise<void>

ProtecteduserCanBeRemovedFromRole

Parameters

Returns Promise<void>

ProtecteduserHasMissingRequiredRoles

Parameters

Returns Promise<void>

ProtecteduserHasReachedMaxRoles

Parameters

Returns Promise<void>

Settings

On This Page

Class SelfRoleManager`Abstract`

`Readonly`channels

`Readonly`client

`Readonly`options

`Protected`generateRolesChangesListener

Returns (
oldMember: GuildMember | PartialGuildMember,
newMember: GuildMember,
) => Promise<void>

`Protected`getRTE

`Protected` `Abstract`handleUserAction

`Protected` `Abstract`sendsMessageAndRegisterChannel

`Protected`userCanBeAddedToRole

`Protected`userCanBeRemovedFromRole

`Protected`userHasMissingRequiredRoles

`Protected`userHasReachedMaxRoles