Role

@discordeno/bot

---

Documentation / @discordeno/bot / Role

Interface: Role

Defined in: packages/bot/src/transformers/types.ts:1420

Properties

availableForPurchase

availableForPurchase: boolean

Defined in: packages/bot/src/transformers/types.ts:1457

Whether this role is available for purchase.

---

color

color: number

Defined in: packages/bot/src/transformers/types.ts:1446

Integer representation of hexadecimal color code

---

flags

flags: RoleFlags

Defined in: packages/bot/src/transformers/types.ts:1452

Role flags combined as a bitfield

---

guildConnections

guildConnections: boolean

Defined in: packages/bot/src/transformers/types.ts:1459

Whether this is a guild's linked role.

---

guildId

guildId: bigint

Defined in: packages/bot/src/transformers/types.ts:1424

The guild id where this role is located.

---

hoist

hoist: boolean

Defined in: packages/bot/src/transformers/types.ts:1428

If this role is showed separately in the user listing

---

icon?

optional icon: bigint

Defined in: packages/bot/src/transformers/types.ts:1442

---

id

id: bigint

Defined in: packages/bot/src/transformers/types.ts:1422

Role id

---

internalTags?

optional internalTags: InternalRoleTags

Defined in: packages/bot/src/transformers/types.ts:1441

Internal

Role tags

Use role.tags. This is for internal use only, and prone to breaking changes.

---

managed

managed: boolean

Defined in: packages/bot/src/transformers/types.ts:1432

Whether this role is managed by an integration

---

mentionable

mentionable: boolean

Defined in: packages/bot/src/transformers/types.ts:1434

Whether this role is mentionable

---

name

name: string

Defined in: packages/bot/src/transformers/types.ts:1444

Role name

---

permissions

permissions: Permissions

Defined in: packages/bot/src/transformers/types.ts:1430

Permission bit set

---

position

position: number

Defined in: packages/bot/src/transformers/types.ts:1448

Position of this role

---

premiumSubscriber

premiumSubscriber: boolean

Defined in: packages/bot/src/transformers/types.ts:1455

---

tags?

optional tags: RoleTags

Defined in: packages/bot/src/transformers/types.ts:1454

The tags this role has

---

toggles?

optional toggles: RoleToggles

Defined in: packages/bot/src/transformers/types.ts:1426

The compressed version of the boolean values on this role.

---

unicodeEmoji?

optional unicodeEmoji: string

Defined in: packages/bot/src/transformers/types.ts:1450

role unicode emoji