Class UserAPI

A wrapper for the FoxoChat user API.

Index

Constructors

Methods

addContact channels confirmDelete contacts current delete deleteContact edit get uploadAvatar uploadBanner

Constructors

constructor

new UserAPI(rest: REST): UserAPI
Parameters
- rest: REST
Returns UserAPI
- Defined in packages/api/src/UserAPI.ts:28

Methods

addContact

addContact(userId: number): Promise<RESTPostAPIUserContactResult>
Adds the user as contact.
Parameters
- userId: number
Returns Promise<RESTPostAPIUserContactResult>
- Defined in packages/api/src/UserAPI.ts:96

channels

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

Returns Promise<RESTGetAPIUserChannelsResult>
- Defined in packages/api/src/UserAPI.ts:68

confirmDelete

confirmDelete(body: RESTPostAPIUserDeleteConfirmBody): Promise<APIOk>
Confirms user deletion.
Parameters
- body: RESTPostAPIUserDeleteConfirmBody
Returns Promise<APIOk>
- Defined in packages/api/src/UserAPI.ts:61

contacts

contacts(): Promise<RESTGetAPIUserContactsResult>
Gets user contacts.

Returns Promise<RESTGetAPIUserContactsResult>
- Defined in packages/api/src/UserAPI.ts:75

current

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

Returns Promise<RESTGetAPIUserResult>
- Defined in packages/api/src/UserAPI.ts:40

delete

delete(body: RESTDeleteAPIUserBody): Promise<APIOk>
Requests user deletion.
Parameters
- body: RESTDeleteAPIUserBody
Returns Promise<APIOk>
- Defined in packages/api/src/UserAPI.ts:54

deleteContact

deleteContact(userId: number): Promise<APIOk>
Removes the user from contacts.
Parameters
- userId: number
Returns Promise<APIOk>
- Defined in packages/api/src/UserAPI.ts:103

edit

edit(body: RESTPatchAPIUserBody): Promise<RESTPatchAPIUserResult>
Edits the current user.
Parameters
- body: RESTPatchAPIUserBody
Returns Promise<RESTPatchAPIUserResult>
- Defined in packages/api/src/UserAPI.ts:47

get

get(userKey: PublicUserKey): Promise<RESTGetAPIUserResult>
Fetches a user.
Parameters
- userKey: PublicUserKey
Returns Promise<RESTGetAPIUserResult>
- Defined in packages/api/src/UserAPI.ts:33

uploadAvatar

uploadAvatar(body: RESTAPIAvatarUploadRequest): Promise<APIMediaUpload>
Uploads the user avatar.
Parameters
- body: RESTAPIAvatarUploadRequest
Returns Promise<APIMediaUpload>
- Defined in packages/api/src/UserAPI.ts:82

uploadBanner

uploadBanner(body: RESTAPIAvatarUploadRequest): Promise<APIMediaUpload>
Uploads the user banner.
Parameters
- body: RESTAPIAvatarUploadRequest
Returns Promise<APIMediaUpload>
- Defined in packages/api/src/UserAPI.ts:89