Skip to main content

Role

Documentation


Documentation / @discordeno/bot / Role

Interface: Role

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

Properties

availableForPurchase

availableForPurchase: boolean

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

Whether this role is available for purchase.


color

color: number

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

Integer representation of hexadecimal color code


flags

flags: RoleFlags

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

Role flags combined as a bitfield


guildConnections

guildConnections: boolean

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

Whether this is a guild's linked role.


guildId

guildId: bigint

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

The guild id where this role is located.


hoist

hoist: boolean

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

If this role is showed separately in the user listing


icon?

optional icon: bigint

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


id

id: bigint

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

Role id


internalTags?

optional internalTags: InternalRoleTags

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

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

Whether this role is managed by an integration


mentionable

mentionable: boolean

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

Whether this role is mentionable


name

name: string

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

Role name


permissions

permissions: Permissions

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

Permission bit set


position

position: number

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

Position of this role


premiumSubscriber

premiumSubscriber: boolean

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


tags?

optional tags: RoleTags

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

The tags this role has


toggles?

optional toggles: RoleToggles

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

The compressed version of the boolean values on this role.


unicodeEmoji?

optional unicodeEmoji: string

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

role unicode emoji