revbot.js
    Preparing search index...

    Class RoleManager

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    cache holds Holds

    Methods

    _add _remove create delete edit resolve resolveId valueOf

    Constructors

    Properties

    cache: Map<string, Role> = ...
    holds: typeof Role = Role
    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

          Colour used for this role

          This can be any valid CSS colour

        • Optionalhoist?: boolean

          Whether this role should be shown separately on the member sidebar

        • name: string

          Role name

        • permissions: { a: number; d: number }

          Permissions available to this role

          • a: number

            Format: int64

            Allow bit flags

          • d: number

            Format: int64

            Disallow bit flags

        • Optionalrank?: number

          Format: int64

          Ranking of this role

          0
        • id: string

      Returns Role

    _remove

    • Parameters

      • role: RoleResolvable

        the role to edit

      • data: editableRole

        data to edit the role with

        Represents a role that can be edited in a server.

        • Optionalcolour?: string | null

          Colour of the role, or null if no colour is set.

        • Optionalhoist?: boolean

          Whether the role is displayed separately in the member list.

        • Optionalname?: string

          Name of the role.

        • Optionalpermissions?: editablePermissions

          Permissions to set for the role. Format: { a: allow, d: deny }

        • Optionalrank?: number

          Rank of the role, used for ordering.

        • Optionalremove?: (keyof API.Role & { [key: string]: unknown })[]

          Fields to remove from the role. Each key corresponds to a field in the Role type.

      Returns Promise<Role>

      Role

      If the role ID is invalid

    • Parameters

      Returns 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

            Colour used for this role

            This can be any valid CSS colour

          • Optionalhoist?: boolean

            Whether this role should be shown separately on the member sidebar

          • name: string

            Role name

          • permissions: { a: number; d: number }

            Permissions available to this role

            • a: number

              Format: int64

              Allow bit flags

            • d: number

              Format: int64

              Disallow bit flags

          • Optionalrank?: number

            Format: int64

            Ranking of this role

            0
          • id: string

      Returns 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

            Colour used for this role

            This can be any valid CSS colour

          • Optionalhoist?: boolean

            Whether this role should be shown separately on the member sidebar

          • name: string

            Role name

          • permissions: { a: number; d: number }

            Permissions available to this role

            • a: number

              Format: int64

              Allow bit flags

            • d: number

              Format: int64

              Disallow bit flags

          • Optionalrank?: number

            Format: int64

            Ranking of this role

            0
          • id: string

      Returns 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

            Colour used for this role

            This can be any valid CSS colour

          • Optionalhoist?: boolean

            Whether this role should be shown separately on the member sidebar

          • name: string

            Role name

          • permissions: { a: number; d: number }

            Permissions available to this role

            • a: number

              Format: int64

              Allow bit flags

            • d: number

              Format: int64

              Disallow bit flags

          • Optionalrank?: number

            Format: int64

            Ranking of this role

            0
          • id: string

      Returns null | string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods