Class Role

Represents a role in a guild.

Hierarchy

Constructors

constructor

Properties

_cachedGuild? client color guildID hoist icon id managed mentionable name permissions position tags unicodeEmoji

Accessors

createdAt guild mention

Methods

delete edit toJSON toString update generateID getCreatedAt getDiscordEpoch

Constructors

constructor

  • Parameters

    Returns Role

Properties

Private Optional _cachedGuild

_cachedGuild?: any

client

client: Client<ClientEvents>

color

color: number

The color of this role.

guildID

guildID: string

The id of the guild this role is in.

hoist

hoist: boolean

If this role is hoisted.

icon

icon: null | string

The icon has of this role.

id

id: string

managed

managed: boolean

If this role is managed by an integration.

mentionable

mentionable: boolean

If this role can be mentioned by anybody.

name

name: string

The name of this role.

permissions

permissions: Permission

The permissions of this role.

position

position: number

The position of this role.

tags

tags: RoleTags

The tags of this role.

unicodeEmoji

unicodeEmoji: null | string

The unicode emoji of this role.

Accessors

createdAt

  • get createdAt(): Date

  • Returns Date

guild

  • get guild(): Guild

  • The guild this role is in. This will throw an error if the guild is not cached.

    Returns Guild

mention

  • get mention(): string

  • A string that will mention this role.

    Returns string

Methods

delete

  • Delete this role.

    Parameters

    • Optional reason: string

      The reason for deleting the role.

    Returns Promise<void>

edit

  • Edit this role.

    Parameters

    Returns Promise<Role>

toJSON

  • Returns JSONRole

toString

  • Returns string

Protected update

  • Parameters

    Returns void

Static generateID

  • Parameters

    • Optional timestamp: number | Date

    Returns string

Static getCreatedAt

  • Parameters

    • id: string

    Returns Date

Static getDiscordEpoch

  • Parameters

    • id: string

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc