Role
Documentation / @discordeno/bot / Role
Interface: Role
Defined in: bot/src/transformers/types.ts:1489
Properties
availableForPurchase
availableForPurchase:
boolean
Defined in: bot/src/transformers/types.ts:1531
Whether this role is available for purchase.
color
color:
number
Defined in: bot/src/transformers/types.ts:1518
Integer representation of hexadecimal color code
Deprecated
the colors field is recommended for use instead of this field
colors
colors:
RoleColors
Defined in: bot/src/transformers/types.ts:1520
The role's color
flags
flags:
RoleFlags
Defined in: bot/src/transformers/types.ts:1526
Role flags combined as a bitfield
guildConnections
guildConnections:
boolean
Defined in: bot/src/transformers/types.ts:1533
Whether this is a guild's linked role.
guildId
guildId:
bigint
Defined in: bot/src/transformers/types.ts:1493
The guild id where this role is located.
hoist
hoist:
boolean
Defined in: bot/src/transformers/types.ts:1497
If this role is showed separately in the user listing
icon?
optionalicon:bigint
Defined in: bot/src/transformers/types.ts:1511
id
id:
bigint
Defined in: bot/src/transformers/types.ts:1491
Role id
internalTags?
optionalinternalTags:InternalRoleTags
Defined in: bot/src/transformers/types.ts:1510
Internal
Role tags
Use role.tags. This is for internal use only, and prone to breaking changes.
managed
managed:
boolean
Defined in: bot/src/transformers/types.ts:1501
Whether this role is managed by an integration
mentionable
mentionable:
boolean
Defined in: bot/src/transformers/types.ts:1503
Whether this role is mentionable
name
name:
string
Defined in: bot/src/transformers/types.ts:1513
Role name
permissions
permissions:
Permissions
Defined in: bot/src/transformers/types.ts:1499
Permission bit set
position
position:
number
Defined in: bot/src/transformers/types.ts:1522
Position of this role
premiumSubscriber
premiumSubscriber:
boolean
Defined in: bot/src/transformers/types.ts:1529
tags?
optionaltags:RoleTags
Defined in: bot/src/transformers/types.ts:1528
The tags this role has
toggles?
optionaltoggles:RoleToggles
Defined in: bot/src/transformers/types.ts:1495
The compressed version of the boolean values on this role.
unicodeEmoji?
optionalunicodeEmoji:string
Defined in: bot/src/transformers/types.ts:1524
role unicode emoji