Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Role

Represents a role on Discord

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

client

client: Client

The client that instantiated this structure

data

data: APIRole

Raw Role data

guildId

guildId: string

The Id of the guild the role is in

permissions

permissions: PermissionsBitField

The role permissions

Accessors

color

  • get color(): number

  • Integer representation of hexadecimal color code

    Returns number

createdAt

  • get createdAt(): Date

  • The time the role was created at

    Returns Date

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the role was created at

    Returns number

guild

  • get guild(): undefined | Guild

  • The guild that the role belongs to

    Returns undefined | Guild

hoist

  • get hoist(): boolean

  • If true, users that are part of this role will appear in a separate category in the users list

    Returns boolean

id

  • get id(): string

  • The role's Id

    Returns string

managed

  • get managed(): boolean

  • Whether or not the role is managed by an external service

    Returns boolean

mentionable

  • get mentionable(): boolean

  • Whether or not the role can be mentioned by anyone

    Returns boolean

name

  • get name(): string

  • The name of this role

    Returns string

position

  • get position(): number

  • The position of this role

    Returns number

tags

  • The tags this role has

    Returns RoleTags

Methods

clone

  • clone(): any

  • Returns any

Private parseData

  • Parameters

    Returns Role

toString

  • toString(): string

  • Returns the mention of the role

    Returns string

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM