Class UserInfoService

Service for retrieving user information based on user identifier(s).

Implements

IUserInfoService

Index

Constructors

Methods

getUserInfo getUsersInfo

Constructors

constructor

new UserInfoService(
_apiClient: IApiClient,
_userInfoFactory: IUserInfoFactory,
): UserInfoService
Parameters
- _apiClient: IApiClient
- _userInfoFactory: IUserInfoFactory
Returns UserInfoService
- Defined in @tessa/platform/src/userInfo/userInfoService.ts:11

Methods

getUserInfo

getUserInfo(id: string, type?: null | string): Promise<null | IUserInfo>
Retrieves user information for single user with specified identifier.
Parameters
- id: string
  The user identifier.
- Optionaltype: null | string
  Optional user info handler type. If null, the default handler is used.
Returns Promise<null | IUserInfo>
User information or null user not found by identifier.
Implementation of IUserInfoService.getUserInfo
- Defined in @tessa/platform/src/userInfo/userInfoService.ts:20

getUsersInfo

getUsersInfo(ids: string[], type?: null | string): Promise<IUserInfo[]>
Retrieves user information for multiple users with specified identifiers.
Parameters
- ids: string[]
  A collection of the user identifiers.
- Optionaltype: null | string
  Optional user info handler type. If null, the default handler is used.
Returns Promise<IUserInfo[]>
A collection of user information for users that are found.
Implementation of IUserInfoService.getUsersInfo
- Defined in @tessa/platform/src/userInfo/userInfoService.ts:28