Skip to main content

Role

Documentation


Documentation / @discordeno/bot / Role

Interface: Role

Defined in: transformers/types.ts:1694

Properties​

availableForPurchase​

availableForPurchase: boolean

Defined in: transformers/types.ts:1736

Whether this role is available for purchase.


color​

color: number

Defined in: transformers/types.ts:1723

Integer representation of hexadecimal color code

Deprecated​

the colors field is recommended for use instead of this field


colors​

colors: RoleColors

Defined in: transformers/types.ts:1725

The role's color


flags​

flags: RoleFlags

Defined in: transformers/types.ts:1731

Role flags combined as a bitfield


guildConnections​

guildConnections: boolean

Defined in: transformers/types.ts:1738

Whether this is a guild's linked role.


guildId​

guildId: bigint

Defined in: transformers/types.ts:1698

The guild id where this role is located.


hoist​

hoist: boolean

Defined in: transformers/types.ts:1702

If this role is showed separately in the user listing


icon?​

optional icon?: bigint

Defined in: transformers/types.ts:1716


id​

id: bigint

Defined in: transformers/types.ts:1696

Role id


managed​

managed: boolean

Defined in: transformers/types.ts:1706

Whether this role is managed by an integration


mentionable​

mentionable: boolean

Defined in: transformers/types.ts:1708

Whether this role is mentionable


name​

name: string

Defined in: transformers/types.ts:1718

Role name


permissions​

permissions: Permissions

Defined in: transformers/types.ts:1704

Permission bit set


position​

position: number

Defined in: transformers/types.ts:1727

Position of this role


premiumSubscriber​

premiumSubscriber: boolean

Defined in: transformers/types.ts:1734


tags?​

optional tags?: RoleTags

Defined in: transformers/types.ts:1733

The tags this role has


toggles?​

optional toggles?: RoleToggles

Defined in: transformers/types.ts:1700

The compressed version of the boolean values on this role.


unicodeEmoji?​

optional unicodeEmoji?: string

Defined in: transformers/types.ts:1729

role unicode emoji