Role

@discordeno/bot

---

Documentation / @discordeno/bot / Role

Interface: Role

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

Properties

availableForPurchase

availableForPurchase: boolean

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

Whether this role is available for purchase.

---

color

color: number

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

Integer representation of hexadecimal color code

---

flags

flags: RoleFlags

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

Role flags combined as a bitfield

---

guildConnections

guildConnections: boolean

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

Whether this is a guild's linked role.

---

guildId

guildId: bigint

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

The guild id where this role is located.

---

hoist

hoist: boolean

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

If this role is showed separately in the user listing

---

icon?

optional icon: bigint

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

---

id

id: bigint

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

Role id

---

internalTags?

optional internalTags: InternalRoleTags

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

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

Whether this role is managed by an integration

---

mentionable

mentionable: boolean

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

Whether this role is mentionable

---

name

name: string

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

Role name

---

permissions

permissions: Permissions

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

Permission bit set

---

position

position: number

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

Position of this role

---

premiumSubscriber

premiumSubscriber: boolean

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

---

tags?

optional tags: RoleTags

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

The tags this role has

---

toggles?

optional toggles: RoleToggles

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

The compressed version of the boolean values on this role.

---

unicodeEmoji?

optional unicodeEmoji: string

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

role unicode emoji