Class ExtendedUser

Represents the currently authenticated user.

Hierarchy (view full)

User
- ExtendedUser

Constructors

constructor

new ExtendedUser(data, client): ExtendedUser
Parameters
- data: RawOAuthUser
- client: Client<ClientEvents>
Returns ExtendedUser
Overrides User.constructor
- Defined in lib/structures/ExtendedUser.ts:19

Properties

`Optional` accentColor

accentColor?: null | number

The user's banner color. If this member was received via the gateway, this will never be present.

avatar

avatar: null | string

The user's avatar hash.

`Optional` avatarDecoration

avatarDecoration?: null | string

The hash of this user's avatar decoration. This will always resolve to a png.

`Optional` banner

banner?: null | string

The user's banner hash. If this member was received via the gateway, this will never be present.

bot

bot: boolean

If this user is a bot.

client

client: Client<ClientEvents>

discriminator

discriminator: string

The 4 digits after this user's username, if they have not been migrated. If migrated, this will be a single "0".

email

email: null | string

The user's email. (always null for bots)

flags

flags: number

The flags of the user.

globalName

globalName: null | string

The user's display name, if set.

id

id: string

`Optional` locale

locale?: string

The locale of the user

mfaEnabled

mfaEnabled: boolean

If the user has mfa enabled on their account

publicFlags

publicFlags: number

The user's public flags.

system

system: boolean

If this user is an official discord system user.

username

username: string

The user's username.

verified

verified: boolean

If this user's email is verified. (always true for bots)

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from User.createdAt
- Defined in lib/structures/Base.ts:39

defaultAvatar

get defaultAvatar(): number
The default avatar value of this user.

Returns number
Inherited from User.defaultAvatar
- Defined in lib/structures/User.ts:76

isMigrated

get isMigrated(): boolean
If this user has migrated to the new username system.

Returns boolean
Inherited from User.isMigrated
- Defined in lib/structures/User.ts:84

mention

get mention(): string
A string that will mention this user.

Returns string
Inherited from User.mention
- Defined in lib/structures/User.ts:89

Methods

avatarDecorationURL

avatarDecorationURL(size?): null | string
The url of this user's avatar decoration. This will always be a png. Discord does not combine the decoration and their current avatar for you. This is ONLY the decoration.
Parameters
- Optional size: number
  The dimensions of the image.
Returns null | string
Note
As of 12/8/2022 (Dec 8) avatar_decoration is only visible to bots if they set an X-Super-Properties header with a client_build_number ~162992. You can do this via the rest.superProperties option.
Inherited from User.avatarDecorationURL
- Defined in lib/structures/User.ts:107

avatarURL

avatarURL(format?, size?): string
The url of this user's avatar (or default avatar, if they have not set an avatar).
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
  The format the url should be.
- Optional size: number
  The dimensions of the image.
Returns string
Inherited from User.avatarURL
- Defined in lib/structures/User.ts:116

bannerURL

bannerURL(format?, size?): null | string
The url of this user's banner.
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
  The format the url should be.
- Optional size: number
  The dimensions of the image.
Returns null | string
Inherited from User.bannerURL
- Defined in lib/structures/User.ts:125

createDM

createDM(): Promise<PrivateChannel>
Create a direct message with this user.

Returns Promise<PrivateChannel>
Inherited from User.createDM
- Defined in lib/structures/User.ts:132

createTestEntitlement

createTestEntitlement(skuID, applicationID?): Promise<TestEntitlement>
Create a test entitlement for this user.
Parameters
- skuID: string
  The ID of the SKU to create an entitlement for.
- Optional applicationID: string
  The ID of the application to create the entitlement for. If present, defaults to the logged in client's application id.
Returns Promise<TestEntitlement>
Inherited from User.createTestEntitlement
- Defined in lib/structures/User.ts:141

defaultAvatarURL

defaultAvatarURL(): string
The url of this user's default avatar.

Returns string
Inherited from User.defaultAvatarURL
- Defined in lib/structures/User.ts:155

edit

edit(options): Promise<ExtendedUser>
Modify this user.
Parameters
- options: EditSelfUserOptions
  The options for editing the user.
Returns Promise<ExtendedUser>
- Defined in lib/structures/ExtendedUser.ts:45

getEntitlements

getEntitlements(options?, applicationID?): Promise<(Entitlement | TestEntitlement)[]>
Get the entitlements for this guild.
Parameters
- Optional options: Omit<SearchEntitlementsOptions, "userID">
  The options for getting the entitlements.
- Optional applicationID: string
Returns Promise<(Entitlement | TestEntitlement)[]>
Inherited from User.getEntitlements
- Defined in lib/structures/User.ts:163

toJSON

toJSON(): JSONExtendedUser
Returns JSONExtendedUser
Overrides User.toJSON
- Defined in lib/structures/ExtendedUser.ts:49

toString

toString(): string
Returns string
Inherited from User.toString
- Defined in lib/structures/Base.ts:64

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from User.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from User.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from User.getDiscordEpoch
- Defined in lib/structures/Base.ts:32

Class ExtendedUser

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: RawOAuthUser

client: Client<ClientEvents>

Returns ExtendedUser

Properties

Optional accentColor

avatar

Optional avatarDecoration

Optional banner

bot

client

discriminator

email

flags

globalName

id

Optional locale

mfaEnabled

publicFlags

system

username

verified

Accessors

createdAt

Returns Date

defaultAvatar

Returns number

isMigrated

Returns boolean

mention

Returns string

tag

Returns string

Methods

avatarDecorationURL

Parameters

Optional size: number

Returns null | string

Note

avatarURL

Parameters

Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

Optional size: number

Returns string

bannerURL

Parameters

Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

Optional size: number

Returns null | string

createDM

Returns Promise<PrivateChannel>

createTestEntitlement

Parameters

skuID: string

Optional applicationID: string

Returns Promise<TestEntitlement>

defaultAvatarURL

Returns string

edit

Parameters

options: EditSelfUserOptions

Returns Promise<ExtendedUser>

getEntitlements

Parameters

Optional options: Omit<SearchEntitlementsOptions, "userID">

Optional applicationID: string

Returns Promise<(Entitlement | TestEntitlement)[]>

toJSON

Returns JSONExtendedUser

toString

Returns string

`Optional` accentColor

`Optional` avatarDecoration

`Optional` banner

`Optional` locale

`Optional` size: number

`Optional` format: "jpg" | "jpeg" | "png" | "webp" | "gif"

`Optional` size: number

`Optional` format: "jpg" | "jpeg" | "png" | "webp" | "gif"

`Optional` size: number

`Optional` applicationID: string

`Optional` options: Omit<SearchEntitlementsOptions, "userID">

`Optional` applicationID: string

`Static` generateID

`Static` getCreatedAt

`Static` getDiscordEpoch