Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Role<T>

Type parameters

  • T

Hierarchy

Index

Constructors

constructor

Properties

Readonly client

client: T

color

color: number

The role's integer representation of hexadecimal color code.

since

0.0.1

deleted

deleted: boolean = false

Whether the role is deleted.

since

0.0.1

Readonly guild

guild: Guild

The guild this role belongs to.

since

0.0.1

hoist

hoist: boolean

Whether or not the role is pinned in the user listing.

since

0.0.1

Readonly id

id: string

The role's ID.

since

0.0.1

Readonly managed

managed: boolean

Whether or not the role is managed by an integration.

since

0.0.1

mentionable

mentionable: boolean

Whether or not the role is mentionable.

since

0.0.1

name

name: string

The role's name.

since

0.0.1

permissions

permissions: Readonly<Permissions>

The role's permissions.

since

0.0.1

position

position: number

The role's position.

since

0.0.1

Accessors

createdAt

  • get createdAt(): Date

createdTimestamp

  • get createdTimestamp(): number

Methods

Protected _patch

  • _patch(data: APIRoleData): this

addTo

  • addTo(memberID: string): Promise<this>

clone

  • clone(): this

delete

  • delete(requestOptions?: RequestOptions): Promise<this>

modify

permissionsIn

removeFrom

  • removeFrom(memberID: string): Promise<this>

toJSON

  • toJSON(): Record<string, any>

toString

  • toString(): string

valueOf

  • valueOf(): string

Generated using TypeDoc