Class Users

Various methods for interacting with users.

Hierarchy

Users

Index

Constructors

Accessors

Methods

editSelf get leaveGuild

Constructors

constructor

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

Accessors

createDM

get createDM(): ((recipient: string) => Promise<PrivateChannel>)
Alias for Channels#createDM.

Returns ((recipient: string) => Promise<PrivateChannel>)
- - (recipient: string): Promise<PrivateChannel>
  - Create a direct message. This will not create a new channel if you have already started a dm with the user.
    Parameters
    - recipient: string
      
      The ID of the recipient of the direct message.
    Returns Promise<PrivateChannel>
- Defined in lib/routes/Users.ts:17

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:27

get

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

leaveGuild

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