Results

Namespace

Type

Options to use when calling discord.Role.edit, all properties are optional.

Hierarchy

  • IRoleOptions <-- You are here!

Index

Properties

Optional color

color: undefined | number

The color of this role. An integer representation of a hexadecimal color code.

The default color for roles (no color) is 0.

Note: You can set this to a hex color code using an integer represented in hex format.

Example: 0xFF0000 (or 16711680) is red.

Optional hoist

hoist: undefined | false | true

true if this role should be hoisted in the member list (displayed separately).

Optional mentionable

mentionable: undefined | false | true

true if users should be able to mention and ping this role.

Optional name

name: undefined | string

The name of the role.

Optional permissions

permissions: undefined | number

The permission bits users extend when this role is assigned.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc