User

Documentation

---

Documentation / @discordeno/bot / User

Interface: User

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

Properties

accentColor?

optional accentColor: number

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

the user's banner color encoded as an integer representation of hexadecimal color code

---

avatar?

optional avatar: bigint

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

The user's avatar hash

---

avatarDecorationData?

optional avatarDecorationData: AvatarDecorationData

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

data for the user's avatar decoration

---

banner?

optional banner: bigint

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

the user's banner, or null if unset

---

bot

bot: boolean

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

Whether the user belongs to an OAuth2 application

---

collectibles?

optional collectibles: Collectibles

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

data for the user's collectibles

---

discriminator

discriminator: string

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

The user's discord-tag

---

email?

optional email: string

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

The user's email

---

flags?

optional flags: ToggleBitfield

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

The flags on a user's account

---

globalName?

optional globalName: string

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

The user's display name, if it is set. For bots, this is the application name

---

id

id: bigint

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

The user's id

---

locale?

optional locale: string

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

The user's chosen language option

---

mfaEnabled

mfaEnabled: boolean

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

Whether the user has two factor enabled on their account

---

premiumType?

optional premiumType: PremiumTypes

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

The type of Nitro subscription on a user's account

---

primaryGuild?

optional primaryGuild: UserPrimaryGuild

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

The user's primary guild

---

publicFlags?

optional publicFlags: ToggleBitfield

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

The public flags on a user's account

---

system

system: boolean

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

Whether the user is an Official Discord System user (part of the urgent message system)

---

tag

tag: string

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

The user tag in the form of username#discriminator

---

toggles?

optional toggles: UserToggles

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

Compressed version of all the booleans on a user.

---

username

username: string

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

The user's username, not unique across the platform

---

verified

verified: boolean

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

Whether the email on this account has been verified