ClientUser

Extends

• User

Constructors

new ClientUser(client, data, application)

new ClientUser(
   client: UsingClient,
   data: APIUser,
   application: Pick<APIApplication, "id" | "flags">): ClientUser

Parameters

Parameter	Type
client	UsingClient
data	APIUser
application	Pick<APIApplication, "id" | "flags">

Returns

ClientUser

Overrides

User.constructor

Source

seyfert/src/structures/ClientUser.ts:7

Properties

Property	Modifier	Type	Overrides	Inherited from
accentColor	public	undefined | null | number	User.accentColor	User.accentColor
application	public	Pick<APIApplication, "id" | "flags">	-	-
avatar	public	null | string	User.avatar	User.avatar
avatarDecoration	public	undefined | null | string	User.avatarDecoration	User.avatarDecoration
banner	public	undefined | null | string	User.banner	User.banner
bot	public	boolean	User.bot	User.bot
client	readonly	UsingClient	User.client	User.client
discriminator	public	string	User.discriminator	User.discriminator
email	public	undefined | null | string	User.email	User.email
flags	public	undefined | UserFlags	User.flags	User.flags
globalName	public	null | string	User.globalName	User.globalName
id	public	string	User.id	User.id
locale	public	undefined | string	User.locale	User.locale
mfaEnabled	public	undefined | boolean	User.mfaEnabled	User.mfaEnabled
premiumType	public	undefined | UserPremiumType	User.premiumType	User.premiumType
publicFlags	public	undefined | UserFlags	User.publicFlags	User.publicFlags
system	public	undefined | boolean	User.system	User.system
username	public	string	User.username	User.username
verified	public	undefined | boolean	User.verified	User.verified

Accessors

createdAt

get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

---

createdTimestamp

get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

---

name

get name(): string

Returns

string

Source

seyfert/src/structures/User.ts:14

---

tag

get tag(): string

Returns

string

Source

seyfert/src/structures/User.ts:10

Methods

avatarDecorationURL()

avatarDecorationURL(options?: CDNUrlOptions): undefined | string

Parameters

Parameter	Type
options?	CDNUrlOptions

Returns

undefined | string

Inherited from

User.avatarDecorationURL

Source

seyfert/src/structures/User.ts:43

---

avatarURL()

avatarURL(options?: CDNUrlOptions): string

Parameters

Parameter	Type
options?	CDNUrlOptions

Returns

string

Inherited from

User.avatarURL

Source

seyfert/src/structures/User.ts:36

---

bannerURL()

bannerURL(options?: CDNUrlOptions): undefined | string

Parameters

Parameter	Type
options?	CDNUrlOptions

Returns

undefined | string

Inherited from

User.bannerURL

Source

seyfert/src/structures/User.ts:48

---

dm()

dm(force: boolean): Promise<DMChannel>

Open a DM with the user

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

Promise<DMChannel>

Inherited from

User.dm

Source

seyfert/src/structures/User.ts:28

---

edit()

edit(body: RESTPatchAPICurrentUserJSONBody): Promise<ClientUser>

Parameters

Parameter	Type
body	RESTPatchAPICurrentUserJSONBody

Returns

Promise<ClientUser>

Source

seyfert/src/structures/ClientUser.ts:20

---

fetch()

fetch(): Promise<ClientUser>

Fetch user

Returns

Promise<ClientUser>

Overrides

User.fetch

Source

seyfert/src/structures/ClientUser.ts:15

---

presence()

presence(): ReturnCache<undefined | Omit<GatewayPresenceUpdate, "user"> & Object & Object>

Returns

ReturnCache<undefined | Omit<GatewayPresenceUpdate, "user"> & Object & Object>

Inherited from

User.presence

Source

seyfert/src/structures/User.ts:53

---

toString()

toString(): string

Returns

string

Inherited from

User.toString

Source

seyfert/src/structures/User.ts:57

---

write()

write(body: Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps): Promise<Message>

Parameters

Parameter	Type
body	Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps

Returns

Promise<Message>

Inherited from

User.write

Source

seyfert/src/structures/User.ts:32