Skip to main content

Role

Documentation


Documentation / @discordeno/bot / Role

Interface: Role

Defined in: bot/src/transformers/types.ts:1494

Properties

availableForPurchase

availableForPurchase: boolean

Defined in: bot/src/transformers/types.ts:1536

Whether this role is available for purchase.


color

color: number

Defined in: bot/src/transformers/types.ts:1523

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:1525

The role's color


flags

flags: RoleFlags

Defined in: bot/src/transformers/types.ts:1531

Role flags combined as a bitfield


guildConnections

guildConnections: boolean

Defined in: bot/src/transformers/types.ts:1538

Whether this is a guild's linked role.


guildId

guildId: bigint

Defined in: bot/src/transformers/types.ts:1498

The guild id where this role is located.


hoist

hoist: boolean

Defined in: bot/src/transformers/types.ts:1502

If this role is showed separately in the user listing


icon?

optional icon: bigint

Defined in: bot/src/transformers/types.ts:1516


id

id: bigint

Defined in: bot/src/transformers/types.ts:1496

Role id


managed

managed: boolean

Defined in: bot/src/transformers/types.ts:1506

Whether this role is managed by an integration


mentionable

mentionable: boolean

Defined in: bot/src/transformers/types.ts:1508

Whether this role is mentionable


name

name: string

Defined in: bot/src/transformers/types.ts:1518

Role name


permissions

permissions: Permissions

Defined in: bot/src/transformers/types.ts:1504

Permission bit set


position

position: number

Defined in: bot/src/transformers/types.ts:1527

Position of this role


premiumSubscriber

premiumSubscriber: boolean

Defined in: bot/src/transformers/types.ts:1534


tags?

optional tags: RoleTags

Defined in: bot/src/transformers/types.ts:1533

The tags this role has


toggles?

optional toggles: RoleToggles

Defined in: bot/src/transformers/types.ts:1500

The compressed version of the boolean values on this role.


unicodeEmoji?

optional unicodeEmoji: string

Defined in: bot/src/transformers/types.ts:1529

role unicode emoji