Version: Next

APIUserWithMember

@see: https://discord.com/developers/docs/resources/user#user-object

Hierarchy

APIUser
- APIUserWithMember

Index

Properties

accent_color
avatar
avatar_decoration
avatar_decoration_data
banner
bot
discriminator
email
flags
global_name
id
locale
member
mfa_enabled
premium_type
public_flags
system
username
verified

Properties

optionalinheritedaccent_color

accent_color?: null | number

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

inheritedavatar

avatar: null | string

The user's avatar hash

@see: https://discord.com/developers/docs/reference#image-formatting

optionalinheritedavatar_decoration

avatar_decoration?: null | string

The user's avatar decoration hash

@see: https://discord.com/developers/docs/reference#image-formatting
@deprecated: Use APIUser.avatar_decoration_data instead

optionalinheritedavatar_decoration_data

avatar_decoration_data?: null | APIAvatarDecorationData

The data for the user's avatar decoration

@see: https://discord.com/developers/docs/resources/user#avatar-decoration-data-object

optionalinheritedbanner

banner?: null | string

The user's banner hash

@see: https://discord.com/developers/docs/reference#image-formatting

optionalinheritedbot

bot?: boolean

Whether the user belongs to an OAuth2 application

inheriteddiscriminator

discriminator: string

The user's Discord-tag

optionalinheritedemail

email?: null | string

The user's email

optionalinheritedflags

flags?: UserFlags

The flags on a user's account

@see: https://discord.com/developers/docs/resources/user#user-object-user-flags

inheritedglobal_name

global_name: null | string

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

inheritedid

id: string

The user's id

optionalinheritedlocale

locale?: string

The user's chosen language option

optionalmember

member?: APIGuildMemberNoUser

The member field is only present in MESSAGE_CREATE and MESSAGE_UPDATE events from text-based guild channels

@see: https://discord.com/developers/docs/resources/guild#guild-member-object

optionalinheritedmfa_enabled

mfa_enabled?: boolean

Whether the user has two factor enabled on their account

optionalinheritedpremium_type

premium_type?: UserPremiumType

The type of Nitro subscription on a user's account

@see: https://discord.com/developers/docs/resources/user#user-object-premium-types

optionalinheritedpublic_flags

public_flags?: UserFlags

The public flags on a user's account

@see: https://discord.com/developers/docs/resources/user#user-object-user-flags

optionalinheritedsystem

system?: boolean

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

inheritedusername

username: string

The user's username, not unique across the platform

optionalinheritedverified

verified?: boolean

Whether the email on this account has been verified