Class RoleManager

Hierarchy (View Summary)

BaseManager<Role, API.Role & { id: string }>
- RoleManager

Index

Constructors

constructor

new RoleManager(server: Server): RoleManager
Parameters
- server: Server
Returns RoleManager
Overrides BaseManager.constructor
- Defined in work/revbot.js/revbot.js/src/managers/roleManager.ts:9

Properties

`Readonly`cache

cache: Map<string, Role> = ...

holds

holds: typeof Role = Role

Holds

Holds: any

Methods

_add

_add(
    data: {
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: { a: number; d: number };
        rank?: number;
    } & { id: string },
): Role
Parameters
- data: {
      colour?: null | string;
      hoist?: boolean;
      name: string;
      permissions: { a: number; d: number };
      rank?: number;
  } & { id: string }
  - Optionalcolour?: null | string
    Description
    Colour used for this role
    
    This can be any valid CSS colour
  - Optionalhoist?: boolean
    Description
    Whether this role should be shown separately on the member sidebar
  - name: string
    Description
    Role name
  - permissions: { a: number; d: number }
    Description
    Permissions available to this role
    
    a: number
    Format: int64
    
    Description
    Allow bit flags
    
    d: number
    Format: int64
    
    Description
    Disallow bit flags
  - Optionalrank?: number
    Format: int64
    
    Description
    Ranking of this role
  - id: string
Returns Role
Overrides BaseManager._add
- Defined in work/revbot.js/revbot.js/src/managers/roleManager.ts:13

_remove

_remove(id: string): void
Parameters
- id: string
Returns void
Inherited from BaseManager._remove
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:16

create

create(name: string): Promise<Role>
creates a new role in the server
Parameters
- name: string
  The name of the role to create
Returns Promise<Role>
- Defined in work/revbot.js/revbot.js/src/managers/roleManager.ts:24

delete

delete(role: RoleResolvable): Promise<void>
deletes a role from the server
Parameters
- role: RoleResolvable
  the role to delete
Returns Promise<void>
A promise that resolves when the role is deleted
- Defined in work/revbot.js/revbot.js/src/managers/roleManager.ts:37

resolve

resolve(resolvable: Role): null | Role
Parameters
- resolvable: Role
Returns null | Role
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:22
resolve(
    resolvable:
        | string
        | {
            colour?: null
            | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        } & { id: string },
): null | Role
Parameters
- resolvable:
      | string
      | {
          colour?: null
          | string;
          hoist?: boolean;
          name: string;
          permissions: { a: number; d: number };
          rank?: number;
      } & { id: string }
  - string
  - {
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: { a: number; d: number };
        rank?: number;
    } & { id: string }
    Optionalcolour?: null | string
    Description
    Colour used for this role
    
    This can be any valid CSS colour
    
    Optionalhoist?: boolean
    Description
    Whether this role should be shown separately on the member sidebar
    
    name: string
    Description
    Role name
    
    permissions: { a: number; d: number }
    Description
    Permissions available to this role
    
    a: number
    Format: int64
    
    Description
    Allow bit flags
    
    d: number
    Format: int64
    
    Description
    Disallow bit flags
    
    Optionalrank?: number
    Format: int64
    
    Description
    Ranking of this role
    
    id: string
Returns null | Role
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:23
resolve(
    resolvable:
        | string
        | Role
        | {
            colour?: null
            | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        } & { id: string },
): null | Role
Parameters
- resolvable:
      | string
      | Role
      | {
          colour?: null
          | string;
          hoist?: boolean;
          name: string;
          permissions: { a: number; d: number };
          rank?: number;
      } & { id: string }
  - string
  - Role
  - {
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: { a: number; d: number };
        rank?: number;
    } & { id: string }
    Optionalcolour?: null | string
    Description
    Colour used for this role
    
    This can be any valid CSS colour
    
    Optionalhoist?: boolean
    Description
    Whether this role should be shown separately on the member sidebar
    
    name: string
    Description
    Role name
    
    permissions: { a: number; d: number }
    Description
    Permissions available to this role
    
    a: number
    Format: int64
    
    Description
    Allow bit flags
    
    d: number
    Format: int64
    
    Description
    Disallow bit flags
    
    Optionalrank?: number
    Format: int64
    
    Description
    Ranking of this role
    
    id: string
Returns null | Role
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:24

resolveId

resolveId(
    resolvable:
        | string
        | Role
        | {
            colour?: null
            | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        } & { id: string },
): null | string
Parameters
- resolvable:
      | string
      | Role
      | {
          colour?: null
          | string;
          hoist?: boolean;
          name: string;
          permissions: { a: number; d: number };
          rank?: number;
      } & { id: string }
  - string
  - Role
  - {
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: { a: number; d: number };
        rank?: number;
    } & { id: string }
    Optionalcolour?: null | string
    Description
    Colour used for this role
    
    This can be any valid CSS colour
    
    Optionalhoist?: boolean
    Description
    Whether this role should be shown separately on the member sidebar
    
    name: string
    Description
    Role name
    
    permissions: { a: number; d: number }
    Description
    Permissions available to this role
    
    a: number
    Format: int64
    
    Description
    Allow bit flags
    
    d: number
    Format: int64
    
    Description
    Disallow bit flags
    
    Optionalrank?: number
    Format: int64
    
    Description
    Ranking of this role
    
    id: string
Returns null | string
Inherited from BaseManager.resolveId
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:31

valueOf

valueOf(): Map<string, Role>
Returns Map<string, Role>
Inherited from BaseManager.valueOf
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:40

Class RoleManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RoleManager

Properties

Readonlycache

holds

Holds

Methods

_add

Parameters

Optionalcolour?: null | string

Description

Optionalhoist?: boolean

Description

name: string

Description

permissions: { a: number; d: number }

Description

a: number

Description

d: number

Description

Optionalrank?: number

Description

id: string

Returns Role

_remove

Parameters

Returns void

create

Parameters

Returns Promise<Role>

delete

Parameters

Returns Promise<void>

resolve

Parameters

Returns null | Role

Parameters

Optionalcolour?: null | string

Description

Optionalhoist?: boolean

Description

name: string

Description

permissions: { a: number; d: number }

Description

a: number

Description

d: number

Description

Optionalrank?: number

Description

id: string

Returns null | Role

Parameters

Optionalcolour?: null | string

Description

Optionalhoist?: boolean

Description

name: string

Description

permissions: { a: number; d: number }

Description

a: number

Description

d: number

Description

Optionalrank?: number

Description

id: string

Returns null | Role

resolveId

`Readonly`cache

`Optional`colour?: null | string

`Optional`hoist?: boolean

`Optional`rank?: number

`Optional`colour?: null | string

`Optional`hoist?: boolean

`Optional`rank?: number

`Optional`colour?: null | string

`Optional`hoist?: boolean

`Optional`rank?: number

`Optional`colour?: null | string

`Optional`hoist?: boolean

`Optional`rank?: number