Class MemberRolesController

Provides an interface for a member's roles cache. The roles are mapped by their IDs

Hierarchy

BaseController<Role>
- MemberRolesController

Index

Constructors

constructor

Properties

cache
member

Methods

add
remove

Constructors

constructor

new MemberRolesController(member: Member): MemberRolesController

Overrides BaseController.constructor
- Defined in src/controllers/member/MemberRolesController.ts:20
Parameters
- member: Member
Returns MemberRolesController

Properties

cache

cache: ControllerCache<Role>

The cached data this controller contains

Readonly member

member: Member

The member associated to this controller

Methods

add

add(roleId: Snowflake): Promise<void>

- Defined in src/controllers/member/MemberRolesController.ts:34
Adds a role to this member by the role's ID

Parameters
- roleId: Snowflake
  
  The ID of the role
Returns Promise<void>

remove

remove(roleId: Snowflake): Promise<void>

- Defined in src/controllers/member/MemberRolesController.ts:43
Removes a role from this member by the role's ID

Parameters
- roleId: Snowflake
  
  The ID of the role
Returns Promise<void>

Generated using TypeDoc