UsersResource | discord-rose

Users resource

Hierarchy

UsersResource

Index

Constructors

constructor

Properties

dmCache

Methods

Constructors

constructor

new UsersResource(rest: RestManager): UsersResource

- Defined in src/rest/resources/Users.ts:10
Parameters
- rest: RestManager
Returns UsersResource

Properties

dmCache

dmCache: Cache<string, APIChannel> = ...

Methods

createDM

createDM(userId: string): Promise<APIChannel>

- Defined in src/rest/resources/Users.ts:25
Creates a DM channel

Parameters
- userId: string
  
  ID of user
Returns Promise<APIChannel>

dm

dm(userId: string, message: MessageTypes): Promise<APIMessage>

- Defined in src/rest/resources/Users.ts:42
Send a DM to user (create's DM channel for you)

Parameters
- userId: string
  
  ID of user
- message: MessageTypes
  
  Message data
Returns Promise<APIMessage>

get

get(userId?: string): Promise<APIUser>

- Defined in src/rest/resources/Users.ts:17
Get user

Parameters
- userId: string = '@me'
  
  User ID or defaults to own user
Returns Promise<APIUser>

Generated using TypeDoc