Role
@discordeno/bot • Docs
Documentation / @discordeno/bot / Role
Interface: Role
Properties
availableForPurchase
availableForPurchase:
boolean
Whether this role is available for purchase.
Defined in
packages/bot/src/transformers/types.ts:1444
color
color:
number
Integer representation of hexadecimal color code
Defined in
packages/bot/src/transformers/types.ts:1433
flags
flags:
RoleFlags
Role flags combined as a bitfield
Defined in
packages/bot/src/transformers/types.ts:1439
guildConnections
guildConnections:
boolean
Whether this is a guild's linked role.
Defined in
packages/bot/src/transformers/types.ts:1446
guildId
guildId:
bigint
The guild id where this role is located.
Defined in
packages/bot/src/transformers/types.ts:1411
hoist
hoist:
boolean
If this role is showed separately in the user listing
Defined in
packages/bot/src/transformers/types.ts:1415
icon?
optional
icon:bigint
Defined in
packages/bot/src/transformers/types.ts:1429
id
id:
bigint
Role id
Defined in
packages/bot/src/transformers/types.ts:1409
internalTags?
optional
internalTags:InternalRoleTags
Internal
Role tags
Use role.tags. This is for internal use only, and prone to breaking changes.
Defined in
packages/bot/src/transformers/types.ts:1428
managed
managed:
boolean
Whether this role is managed by an integration
Defined in
packages/bot/src/transformers/types.ts:1419
mentionable
mentionable:
boolean
Whether this role is mentionable
Defined in
packages/bot/src/transformers/types.ts:1421
name
name:
string
Role name
Defined in
packages/bot/src/transformers/types.ts:1431
permissions
permissions:
Permissions
Permission bit set
Defined in
packages/bot/src/transformers/types.ts:1417
position
position:
number
Position of this role
Defined in
packages/bot/src/transformers/types.ts:1435
premiumSubscriber
premiumSubscriber:
boolean
Defined in
packages/bot/src/transformers/types.ts:1442
tags?
optional
tags:RoleTags
The tags this role has
Defined in
packages/bot/src/transformers/types.ts:1441
toggles?
optional
toggles:RoleToggles
The compressed version of the boolean values on this role.
Defined in
packages/bot/src/transformers/types.ts:1413
unicodeEmoji?
optional
unicodeEmoji:string
role unicode emoji