Role

@discordeno/bot

---

Documentation / @discordeno/bot / Role

Interface: Role

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

Properties

availableForPurchase

availableForPurchase: boolean

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

Whether this role is available for purchase.

---

color

color: number

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

Integer representation of hexadecimal color code

---

flags

flags: RoleFlags

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

Role flags combined as a bitfield

---

guildConnections

guildConnections: boolean

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

Whether this is a guild's linked role.

---

guildId

guildId: bigint

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

The guild id where this role is located.

---

hoist

hoist: boolean

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

If this role is showed separately in the user listing

---

icon?

optional icon: bigint

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

---

id

id: bigint

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

Role id

---

internalTags?

optional internalTags: InternalRoleTags

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

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

Whether this role is managed by an integration

---

mentionable

mentionable: boolean

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

Whether this role is mentionable

---

name

name: string

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

Role name

---

permissions

permissions: Permissions

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

Permission bit set

---

position

position: number

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

Position of this role

---

premiumSubscriber

premiumSubscriber: boolean

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

---

tags?

optional tags: RoleTags

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

The tags this role has

---

toggles?

optional toggles: RoleToggles

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

The compressed version of the boolean values on this role.

---

unicodeEmoji?

optional unicodeEmoji: string

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

role unicode emoji