Class ClientUser

Represents a client user that extends the base User class. This class is used to interact with the authenticated user.

Hierarchy (View Summary)

User
- ClientUser

Index

Constructors

constructor

new ClientUser(
    client: UsingClient,
    data: APIUser,
    application: Pick<APIApplication, "id" | "flags">,
): ClientUser
Creates an instance of ClientUser.
Parameters
- client: UsingClient
  The client instance used for making API requests.
- data: APIUser
  The user data received from the gateway.
- application: Pick<APIApplication, "id" | "flags">
  The application data received from the gateway.
Returns ClientUser
Overrides User.constructor
- Defined in src/structures/ClientUser.ts:26

Properties

`Optional`accentColor

accentColor?: number | null

`Readonly`application

application: Pick<APIApplication, "id" | "flags">

The application data received from the gateway.

avatar

avatar: string | null

`Optional`avatarDecorationData

avatarDecorationData?: { asset: string; skuId: string } | null

`Optional`banner

banner?: string | null

bot

bot: boolean = true

Indicates if the user is a bot.

`Readonly`client

client: UsingClient

discriminator

discriminator: string

`Optional`email

email?: string | null

`Optional`flags

flags?: UserFlags

globalName

globalName: string | null

id

id: string

`Optional`locale

locale?: string

`Optional`mfaEnabled

mfaEnabled?: boolean

`Optional`premiumType

premiumType?: UserPremiumType

`Optional`primaryGuild

primaryGuild?: {
    badge: string | null;
    identityEnabled: boolean | null;
    identityGuildId: string | null;
    tag: string | null;
}

`Optional`publicFlags

publicFlags?: UserFlags

`Optional`system

system?: boolean

username

username: string

`Optional`verified

verified?: boolean

Accessors

createdAt

get createdAt(): Date
createdAt gets the creation Date instace of the current object.

Returns Date
Inherited from User.createdAt
- Defined in src/structures/extra/DiscordBase.ts:27

createdTimestamp

get createdTimestamp(): number
Create a timestamp for the current object.

Returns number
Inherited from User.createdTimestamp
- Defined in src/structures/extra/DiscordBase.ts:20

name

get name(): string
Returns string
Inherited from User.name
- Defined in src/structures/User.ts:15

Methods

avatarDecorationURL

avatarDecorationURL(options?: CDNUrlOptions): string | undefined
Parameters
- Optionaloptions: CDNUrlOptions
Returns string | undefined
Inherited from User.avatarDecorationURL
- Defined in src/structures/User.ts:49

avatarURL

avatarURL(options?: CDNUrlOptions): string
Parameters
- Optionaloptions: CDNUrlOptions
Returns string
Inherited from User.avatarURL
- Defined in src/structures/User.ts:41

bannerURL

bannerURL(options?: CDNUrlOptions): string | undefined
Parameters
- Optionaloptions: CDNUrlOptions
Returns string | undefined
Inherited from User.bannerURL
- Defined in src/structures/User.ts:54

defaultAvatarURL

defaultAvatarURL(): string
Returns string
Inherited from User.defaultAvatarURL
- Defined in src/structures/User.ts:37

dm

dm(force?: boolean): Promise<DMChannel>
Open a DM with the user
Parameters
- force: boolean = false
Returns Promise<DMChannel>
Inherited from User.dm
- Defined in src/structures/User.ts:29

edit

edit(body: RESTPatchAPICurrentUserJSONBody): Promise<ClientUser>
Edits the current user data.
Parameters
- body: RESTPatchAPICurrentUserJSONBody
  The data to update the user with.
Returns Promise<ClientUser>
A promise that resolves to the updated ClientUserStructure.
- Defined in src/structures/ClientUser.ts:50

fetch

fetch(): Promise<ClientUser>
Fetches the current user data from the API.

Returns Promise<ClientUser>
A promise that resolves to the ClientUserStructure.
Overrides User.fetch
- Defined in src/structures/ClientUser.ts:39

presence

presence(): ReturnCache<
    | Omit<GatewayPresenceUpdate, "user"> & { id: string; user_id: string } & {
        guild_id: string;
    }
    | undefined,
>
Returns ReturnCache<
    | Omit<GatewayPresenceUpdate, "user"> & { id: string; user_id: string } & {
        guild_id: string;
    }
    | undefined,
>
Inherited from User.presence
- Defined in src/structures/User.ts:59

toString

toString(): `<@${string}>`
Returns a string representation of an object.

Returns `<@${string}>`
Inherited from User.toString
- Defined in src/structures/User.ts:63

write

write(
    body: Omit<
        RESTPostAPIChannelMessageJSONBody,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps,
): Promise<Message>
Parameters
- body: Omit<
      RESTPostAPIChannelMessageJSONBody,
      "components"
      | "content"
      | "embeds"
      | "poll",
  > & SendResolverProps
Returns Promise<Message>
Inherited from User.write
- Defined in src/structures/User.ts:33

Class ClientUser

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ClientUser

Properties

OptionalaccentColor

Readonlyapplication

avatar

OptionalavatarDecorationData

Optionalbanner

bot

Readonlyclient

discriminator

Optionalemail

Optionalflags

globalName

id

Optionallocale

OptionalmfaEnabled

OptionalpremiumType

OptionalprimaryGuild

OptionalpublicFlags

Optionalsystem

username

Optionalverified

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

name

Returns string

tag

Returns string

Methods

avatarDecorationURL

Parameters

Returns string | undefined

avatarURL

Parameters

Returns string

bannerURL

Parameters

Returns string | undefined

defaultAvatarURL

Returns string

dm

Parameters

Returns Promise<DMChannel>

edit

Parameters

Returns Promise<ClientUser>

fetch

Returns Promise<ClientUser>

presence

Returns ReturnCache< | Omit<GatewayPresenceUpdate, "user"> & { id: string; user_id: string } & { guild_id: string; } | undefined,>

toString

Returns `<@${string}>`

write

Parameters

Returns Promise<Message>

Settings

On This Page

`Optional`accentColor

`Readonly`application

`Optional`avatarDecorationData

`Optional`banner

`Readonly`client

`Optional`email

`Optional`flags

`Optional`locale

`Optional`mfaEnabled

`Optional`premiumType

`Optional`primaryGuild

`Optional`publicFlags

`Optional`system

`Optional`verified

Returns ReturnCache<
| Omit<GatewayPresenceUpdate, "user"> & { id: string; user_id: string } & {
guild_id: string;
}
| undefined,
>