Class REST/Users

Various methods for interacting with users. Located at Client#rest .users.

Index

Constructors

Accessors

Methods

editSelf get leaveGuild

Constructors

constructor

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

Accessors

createDM

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

Returns ((recipient) => Promise<PrivateChannel>)
- - (recipient): 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>
    Caching
    This method does cache its result.
    
    Caches
    Client#privateChannels
- Defined in lib/routes/Users.ts:17

Methods

editSelf

editSelf(options): Promise<ExtendedUser>
Edit the currently authenticated user.
Parameters
- options: EditSelfUserOptions
  The options to edit with.
Returns Promise<ExtendedUser>
Caching
This method does not cache its result.
- Defined in lib/routes/Users.ts:26

get

get(userID): Promise<User>
Get a user.
Parameters
- userID: string
  the ID of the user
Returns Promise<User>
Caching
This method does cache its result.

Caches
Client#users
- Defined in lib/routes/Users.ts:48

leaveGuild

leaveGuild(guildID): Promise<void>
Leave a guild.
Parameters
- guildID: string
  The ID of the guild to leave.
Returns Promise<void>
Caching
This method does not cache its result.
- Defined in lib/routes/Users.ts:60