Interface IUserRead

This accessor provides methods for accessing users in a read-only-fashion.

Hierarchy

IUserRead

Index

Methods

getAppUser getById getByUsername getUserUnreadMessageCount

Methods

getAppUser

getAppUser(appId?): Promise<IUser>
Gets the app user of this app.
Parameters
- Optional appId: string
Returns Promise<IUser>
- Defined in src/definition/accessors/IUserRead.ts:15

getById

getById(id): Promise<IUser>
Parameters
- id: string
Returns Promise<IUser>
- Defined in src/definition/accessors/IUserRead.ts:8

getByUsername

getByUsername(username): Promise<IUser>
Parameters
- username: string
Returns Promise<IUser>
- Defined in src/definition/accessors/IUserRead.ts:10

getUserUnreadMessageCount

getUserUnreadMessageCount(uid): Promise<number>
Gets the user's badge count (unread messages count).
Parameters
- uid: string
  
  user's id
Returns Promise<number>
- Defined in src/definition/accessors/IUserRead.ts:21

Generated using TypeDoc