Retrieving & adding roles with getRole vs. fetch()

[samheckle]

Which application is this bug report for?

Documentation

Issue description

There's a bit of a discrepancy between the FAQ guides and the documentation and would love some clarification. I'm just confused as to where these get methods are being defined for roles, as the docs use fetch requests instead.

I see that interaction.options is defined by BaseInteraction. In the common use case of adding roles based on reactions, I don't think this works and you would need to use the RoleManager instead.

To be more specific, the way I added roles based off of a message reaction:

// inside of Events.MessageReactionAdd
const guild = reaction.message.guild;
await guild.members.fetch(user.id).then((m) => {
    m.guild.roles.fetch("1433556412964802660").then((r) => {
          m.roles.add(r);
    });
});

But based off the FAQ, adding roles is done through BaseInteraction.

const role = interaction.options.getRole('role');
const member = interaction.options.getMember('target');
member.roles.add(role);

Steps to Reproduce

1. Visit FAQ on guides page & scroll to "add a role to a member"

const role = interaction.options.getRole('role');

2. Visit RoleManager class & scroll to "fetch"

// Fetch a single role
message.guild.roles.fetch('222078108977594368')
  .then(role => console.log(`The role color is: ${role.colors.primaryColor}`))
  .catch(console.error);

Versions

• Firefox 144.0.0.2 (64-bit)

Issue priority

Low (slightly annoying)

[almostSouji]

getMember / getRole are convenience functions we define for interactions that let you retrieve the command options the user supplied (that being a member and a role in this example).

the guild member instance (retrieved via getMember or from the cache/rest call with .members.fetch("id")) then has the .roles.add() function on the guild member roles manager, to actually add a role.

if you have the id, you can simply pass the id here and don't need to fetch the role.
if you don't want to, you don't even have to fetch the member and can utilize the manager instead: <Guild>.members.addRole({role: "id", user: user.id})

---

to clarify, there is no discrepancy here, just a different entry point. you still use the exact same approach, no matter where you got the guild member instance from - guild.members.fetch(), interaction.getMember(), message.member.
for slash commands interaction.getMember() is just very conveniently accessing the author as a guild member (if available) without requiring another API call, since Discord already supplies the member that used a command in the interaction payload

[almostSouji]

that being said, i also want to bring attention to using buttons or select menus (or even relying on the discord-native onboarding feature) for role management.

"reaction roles" as a concept stems from a time where we had no better way of handling this.
reactions were never be meant to act as glorified buttons, and now we have proper buttons at our disposal!
ref: https://discordjs.guide/legacy/interactive-components/buttons

[samheckle]

i guess i am not such an active user where i'm in servers that are actively using buttons, but i will definitely take a look at this. thank you very much for the clarification & help :)