Class Role

Hierarchy

BaseObject<APIRole>
- Role

Index

Constructors

Properties

client deleted server

Accessors

_id color createdAt hoist id name permissions rank source

Methods

delete edit fireUpdate offUpdate onUpdate toString update

Constructors

constructor

new Role(client: Client, server: Server, data: APIRole): Role
Parameters
- client: Client
- server: Server
- data: APIRole
Returns Role
Overrides BaseObject.constructor
- Defined in core/src/objects/Role.ts:9

Properties

client

client: Client

deleted

deleted: boolean = false

server

server: Server

Accessors

`Protected` _id

get _id(): ""
Returns ""
Inherited from BaseObject._id
- Defined in core/src/objects/BaseObject.ts:10

color

get color(): string
Returns string
- Defined in core/src/objects/Role.ts:16

createdAt

get createdAt(): number
Returns number
Inherited from BaseObject.createdAt
- Defined in core/src/objects/BaseObject.ts:19

hoist

get hoist(): boolean
Returns boolean
- Defined in core/src/objects/Role.ts:22

id

get id(): string
Returns string
Inherited from BaseObject.id
- Defined in core/src/objects/BaseObject.ts:16

name

get name(): string
Returns string
- Defined in core/src/objects/Role.ts:13

permissions

get permissions(): PermissionOverride
Returns PermissionOverride
- Defined in core/src/objects/Role.ts:25

rank

get rank(): number
Returns number
- Defined in core/src/objects/Role.ts:19

source

get source(): APIType
Original API object.

Returns APIType
Inherited from BaseObject.source
- Defined in core/src/objects/BaseObject.ts:7

Methods

delete

delete(): Promise<void>
Returns Promise<void>
- Defined in core/src/objects/Role.ts:37

edit

edit(data: {
    colour?: string;
    hoist?: boolean;
    name?: string;
    rank?: number;
    remove?: "Colour"[];
}): Promise<Role>
Parameters
- data: {
      colour?: string;
      hoist?: boolean;
      name?: string;
      rank?: number;
      remove?: "Colour"[];
  }
  - Optional colour?: string
    
    Description
    Role colour
  - Optional hoist?: boolean
    
    Description
    Whether this role should be displayed separately
  - Optional name?: string
    
    Description
    Role name
  - Optional rank?: number
    
    Format: int64
    
    Description
    Ranking position
    
    Smaller values take priority.
  - Optional remove?: "Colour"[]
    
    Description
    Fields to remove from role object
Returns Promise<Role>
- Defined in core/src/objects/Role.ts:32

fireUpdate

fireUpdate(updated?: any[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: any[]
  
  The objects that caused this update.
Returns void
Inherited from BaseObject.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:33

offUpdate

offUpdate(callback: MiniEmitterCallback<any>): Role
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to stop listening for updates on.
Returns Role
Inherited from BaseObject.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): Role
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to run when an update occurs.
Returns Role
Inherited from BaseObject.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:15

toString

toString(): string
Returns
The role name.

Returns string
Overrides BaseObject.toString
- Defined in core/src/objects/Role.ts:43

update

update(data?: Partial<APIRole>): Role
Update this object with new API data.
Parameters
- data: Partial<APIRole> = {}
Returns Role
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24