Class Users

Various methods for interacting with users.

Hierarchy

Users

Index

Constructors

Methods

editSelf get getCurrentUser leaveGuild

Constructors

constructor

new Users(manager: RESTManager): Users
Parameters
- manager: RESTManager
Returns Users
- Defined in lib/routes/Users.ts:11

Methods

editSelf

editSelf(options: EditSelfUserOptions): Promise<ExtendedUser>
Edit the currently authenticated user.

Note: This does not touch the client's cache in any way.
Parameters
- options: EditSelfUserOptions
  
  The options to edit with.
Returns Promise<ExtendedUser>
- Defined in lib/routes/Users.ts:21

get

get(id: string): Promise<User>
Get a user.
Parameters
- id: string
  
  the ID of the user
Returns Promise<User>
- Defined in lib/routes/Users.ts:36

getCurrentUser

getCurrentUser(): Promise<ExtendedUser>
Get the currently authenticated user's information.

Note: This does not touch the client's cache in any way.

Returns Promise<ExtendedUser>
- Defined in lib/routes/Users.ts:48

leaveGuild

leaveGuild(id: string): Promise<void>
Leave a guild.
Parameters
- id: string
  
  The ID of the guild to leave.
Returns Promise<void>
- Defined in lib/routes/Users.ts:59