Class ServerRole

constructor

• new ServerRole(
      client: Client,
      serverId: string,
      id: string,
      data: {
          _id: string;
          colour?: null | string;
          hoist?: boolean;
          icon?:
              | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | {
                          animated?: null | boolean;
                          height: number;
                          thumbhash?: null | number[];
                          type: "Image";
                          width: number;
                      }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
          name: string;
          permissions: { a: number; d: number };
          rank?: number;
      },
  ): ServerRole

  Construct server role

  Parameters

  • client: Client

    Client
  • serverId: string

    Server ID
  • id: string

    Role ID
  • data: {
        _id: string;
        colour?: null | string;
        hoist?: boolean;
        icon?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | {
                        animated?: null | boolean;
                        height: number;
                        thumbhash?: null | number[];
                        type: "Image";
                        width: number;
                    }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        name: string;
        permissions: { a: number; d: number };
        rank?: number;
    }

    Role data

    • _id: string

      Description

      Unique Id

    • 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

    • Optionalicon?:
          | null
          | {
              _id: string;
              content_type: string;
              deleted?: null
              | boolean;
              filename: string;
              message_id?: null | string;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | {
                      animated?: null | boolean;
                      height: number;
                      thumbhash?: null | number[];
                      type: "Image";
                      width: number;
                  }
                  | { height: number; type: "Video"; width: number }
                  | { type: "Audio" };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          }

      Description

      Role icon

    • 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

      Default

      0
      Copy

  Returns ServerRole

Optional Readonlycolour

Readonlyhoist

Optional Readonlyicon

Readonlyid

Readonlyname

Readonlypermissions

Readonlyrank

assigned

• get assigned(): boolean

  Whether this role is assigned to our server member

  Returns boolean

server

• get server(): undefined | Server

  Server attached to this role

  Returns undefined | Server

delete

• delete(): Promise<void>

  Delete this role

  Returns Promise<void>

toString

• toString(): string

  Write to string as a role mention

  Returns string

  Formatted String