Appearance
GuildMemberRoleManager
Package: @erinjs/core
Manages a guild member's roles with add/remove/set and a cache of Role objects. Discord.js parity: member.roles.add(), member.roles.remove(), member.roles.set(), member.roles.cache
Constructor
| Name | Type | Optional | Description |
|---|---|---|---|
member | GuildMember | No | |
initialRoleIds | string[] | No |
Properties
| Name | Type | Readonly | Optional | Description |
|---|---|---|---|---|
cache | Collection<string, Role> | Yes | No | Collection of Role objects for this member's roles (from guild.roles). |
| Discord.js parity: member.roles.cache | ||||
roleIds | readonly string[] | Yes | No | Role IDs for this member. Used by permissions; prefer cache for Role objects. |
Methods
add() async
Add a role to this member. Discord.js parity: member.roles.add(roleId) Requires Manage Roles permission.
Returns: Promise<void>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
roleOrId | RoleResolvable | No |
has()
Check if the member has a role. Discord.js parity: member.roles.cache.has(roleId)
Returns: boolean
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
roleOrId | RoleResolvable | No |
remove() async
Remove a role from this member. Discord.js parity: member.roles.remove(roleId) Requires Manage Roles permission.
Returns: Promise<void>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
roleOrId | RoleResolvable | No |
set() async
Replace all roles for this member. PATCH /guilds/{id}/members/{userId} Discord.js parity: member.roles.set(roleIds) Requires Manage Roles permission.
Returns: Promise<void>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
roleIds | string[] | No |