Interface IUserRead

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

Hierarchy

IUserRead

Index

Methods

Methods

getAppUser

getAppUser(appId?: string): Promise<IUser>

- Defined in src/definition/accessors/IUserRead.ts:15
Gets the app user of this app.

Parameters
- Optional appId: string
Returns Promise<IUser>

getById

getById(id: string): Promise<IUser>

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

getByUsername

getByUsername(username: string): Promise<IUser>

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

getUserUnreadMessageCount

getUserUnreadMessageCount(uid: string): Promise<number>

- Defined in src/definition/accessors/IUserRead.ts:21
Gets the user's badge count (unread messages count).

Parameters
- uid: string
  
  user's id
Returns Promise<number>

Generated using TypeDoc