Class UserAPI

A wrapper for the Foxogram user API.

Index

Constructors

Methods

channels confirmDelete current delete edit get

Constructors

constructor

new UserAPI(rest: REST): UserAPI
Parameters
- rest: REST
Returns UserAPI
- Defined in UserAPI.ts:20

Methods

channels

channels(): Promise<RESTGetAPIUserChannelsResult>
Gets user channels.

Returns Promise<RESTGetAPIUserChannelsResult>
- Defined in UserAPI.ts:69

confirmDelete

confirmDelete(body: RESTPostAPIUserDeleteConfirmBody): Promise<APIOk>
Confirms user deletion.
Parameters
- body: RESTPostAPIUserDeleteConfirmBody
Returns Promise<APIOk>
- Defined in UserAPI.ts:59

current

current(): Promise<APIUser>
Returns the current user.

Returns Promise<APIUser>
- Defined in UserAPI.ts:32

delete

delete(body: RESTDeleteAPIUserBody): Promise<APIOk>
Requests user deletion.
Parameters
- body: RESTDeleteAPIUserBody
Returns Promise<APIOk>
- Defined in UserAPI.ts:49

edit

edit(body: RESTPatchAPIUserBody): Promise<APIUser>
Edits the current user.
Parameters
- body: RESTPatchAPIUserBody
Returns Promise<APIUser>
- Defined in UserAPI.ts:39

get

get(userKey: UserKey): Promise<APIUser>
Fetches a user.
Parameters
- userKey: UserKey
Returns Promise<APIUser>
- Defined in UserAPI.ts:25