User

Documentation

---

Documentation / @discordeno/bot / User

Interface: User

Defined in: transformers/types.ts:1957

Properties

accentColor?

optional accentColor?: number

Defined in: transformers/types.ts:1977

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

---

avatar?

optional avatar?: bigint

Defined in: transformers/types.ts:1983

The user's avatar hash

---

avatarDecorationData?

optional avatarDecorationData?: AvatarDecorationData

Defined in: transformers/types.ts:1989

data for the user's avatar decoration

---

avatarUrl

avatarUrl: (options?) => string | undefined

Defined in: transformers/types.ts:2011

Get user's avatar in formatted url

Parameters

options?

ImageOptions

Image format options

Returns

string | undefined

User's avatar in formatted url

---

banner?

optional banner?: bigint

Defined in: transformers/types.ts:1987

the user's banner, or null if unset

---

bot

bot: boolean

Defined in: transformers/types.ts:1993

Whether the user belongs to an OAuth2 application

---

collectibles?

optional collectibles?: Collectibles

Defined in: transformers/types.ts:2001

data for the user's collectibles

---

createdTimestamp

createdTimestamp: number

Defined in: transformers/types.ts:1967

Get the timestamp in milliseconds of user's creation date

---

defaultAvatarUrl

defaultAvatarUrl: string

Defined in: transformers/types.ts:2005

Get user's default avatar in formatted url

---

discriminator

discriminator: string

Defined in: transformers/types.ts:1981

The user's discord-tag

---

displayAvatarUrl

displayAvatarUrl: (options?) => string

Defined in: transformers/types.ts:2017

Get user's display avatar in formatted url

Parameters

options?

ImageOptions

Image format options

Returns

string

User's display avatar in formatted url

---

displayName

displayName: string

Defined in: transformers/types.ts:1965

The user's display name based on globalName and username

---

email?

optional email?: string

Defined in: transformers/types.ts:1985

The user's email

---

flags?

optional flags?: ToggleBitfield

Defined in: transformers/types.ts:1971

The flags on a user's account

---

globalName?

optional globalName?: string

Defined in: transformers/types.ts:1963

The user's display name, if it is set

---

id

id: bigint

Defined in: transformers/types.ts:1979

The user's id

---

locale?

optional locale?: string

Defined in: transformers/types.ts:1969

The user's chosen language option

---

mfaEnabled

mfaEnabled: boolean

Defined in: transformers/types.ts:1997

Whether the user has two factor enabled on their account

---

premiumType?

optional premiumType?: PremiumTypes

Defined in: transformers/types.ts:1973

The type of Nitro subscription on a user's account

---

primaryGuild?

optional primaryGuild?: UserPrimaryGuild

Defined in: transformers/types.ts:2003

The user's primary guild

---

publicFlags?

optional publicFlags?: ToggleBitfield

Defined in: transformers/types.ts:1975

The public flags on a user's account

---

system

system: boolean

Defined in: transformers/types.ts:1995

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

---

tag

tag: string

Defined in: transformers/types.ts:1991

The user tag in the form of username or username#discriminator for legacy username system

---

toggles?

optional toggles?: UserToggles

Defined in: transformers/types.ts:1959

Compressed version of all the booleans on a user.

---

username

username: string

Defined in: transformers/types.ts:1961

The user's username, not unique across the platform

---

verified

verified: boolean

Defined in: transformers/types.ts:1999

Whether the email on this account has been verified