Class: UserEndpoint

Defined in: endpoints/user.ts:18

Constructors

Constructor

new UserEndpoint(client): UserEndpoint;

Defined in: endpoints/user.ts:19

Parameters

Parameter	Type
client	RESTClient

Returns

UserEndpoint

Methods

deleteAccount()

deleteAccount(currentPassword?): Promise<IDeleteUserResponse>;

Defined in: endpoints/user.ts:95

Delete the signed-in account. An account with an email sign-in must confirm it with currentPassword.

Parameters

Parameter	Type
currentPassword?	string

Returns

Promise<IDeleteUserResponse>

---

disableTurbo()

disableTurbo(): Promise<IUpdateUserResponse>;

Defined in: endpoints/user.ts:48

Disable your Turbo status without changing your appearance preferences.

Returns

Promise<IUpdateUserResponse>

---

getOwnBadges()

getOwnBadges(): Promise<IOwnBadgesResponse>;

Defined in: endpoints/user.ts:80

every badge you hold, including ones you have hidden

Returns

Promise<IOwnBadgesResponse>

---

getProfile()

getProfile(userId): Promise<IUserProfileResponse>;

Defined in: endpoints/user.ts:30

Someone's whole profile: bio, colours, CSS, badges, and the servers and friends you have in common. Badges from a server are included only when you are in that server too.

Parameters

Parameter	Type
userId	number

Returns

Promise<IUserProfileResponse>

---

getUserProfile()

getUserProfile(userId): Promise<IGetUserResponse>;

Defined in: endpoints/user.ts:21

Parameters

Parameter	Type
userId	number

Returns

Promise<IGetUserResponse>

---

markBadgesSeen()

markBadgesSeen(badgeIds): Promise<IApiResponse>;

Defined in: endpoints/user.ts:90

the "badge unlocked" popup has been shown for these, so no device shows it again

Parameters

Parameter	Type
badgeIds	number[]

Returns

Promise<IApiResponse>

---

searchUsers()

searchUsers(query): Promise<ISearchUsersResponse>;

Defined in: endpoints/user.ts:99

Parameters

Parameter	Type
query	string

Returns

Promise<ISearchUsersResponse>

---

setBadgeHidden()

setBadgeHidden(badgeId, hidden): Promise<IOwnBadgeResponse>;

Defined in: endpoints/user.ts:85

show or hide a badge you were given on your profile

Parameters

Parameter	Type
badgeId	number
hidden	boolean

Returns

Promise<IOwnBadgeResponse>

---

unlockTurbo()

unlockTurbo(): Promise<IUpdateUserResponse>;

Defined in: endpoints/user.ts:43

Unlock the Turbo Pro Max easter egg. No payment or application text is sent.

Returns

Promise<IUpdateUserResponse>

---

updateStatus()

updateStatus(params): Promise<IUpdateUserStatusResponse>;

Defined in: endpoints/user.ts:56

Your status as everyone else sees it, and its message. Idle, do not disturb and offline (invisible) are kept for when you next connect; online clears that.

Parameters

Parameter	Type
params	{ activeStatus?: IUserStatus; statusEmoji?: string | null; statusMessage?: string | null; }
params.activeStatus?	IUserStatus
params.statusEmoji?	string | null
params.statusMessage?	string | null

Returns

Promise<IUpdateUserStatusResponse>

---

updateUserPreferences()

updateUserPreferences(preferences, options?): Promise<IUpdateUserPreferencesResponse>;

Defined in: endpoints/user.ts:65

Bind queued saves to their original session, even if the client's token changes.

Parameters

Parameter	Type
preferences	IClientPreferences
options?	{ signal?: AbortSignal; token?: string; }
options.signal?	AbortSignal
options.token?	string

Returns

Promise<IUpdateUserPreferencesResponse>

---

updateUserProfile()

updateUserProfile(params): Promise<IUpdateUserResponse>;

Defined in: endpoints/user.ts:38

Change your own profile. Fields left out are unchanged; null clears one. Pictures are pending media ids from api.media.uploadMediaFile.

Parameters

Parameter	Type
params	IProfileUpdate

Returns

Promise<IUpdateUserResponse>