Class UserInfoCacheProvider

Provider for caching user information to optimize repeated lookups.

Implements

IUserInfoCacheProvider

Index

Constructors

Methods

clear getUserInfo getUsersInfo setUserInfo setUsersInfo

Constructors

constructor

new UserInfoCacheProvider(
    _expirationResolver: IUserInfoCacheExpirationResolver,
    _userInfoFactory: IUserInfoFactory,
    cacheSettings: ICacheSettingsProvider,
): UserInfoCacheProvider
Parameters
- _expirationResolver: IUserInfoCacheExpirationResolver
- _userInfoFactory: IUserInfoFactory
- cacheSettings: ICacheSettingsProvider
Returns UserInfoCacheProvider
- Defined in @tessa/platform/src/userInfo/userInfoCacheProvider.ts:33

Methods

clear

clear(): Promise<void>
Clears all cached user information.

Returns Promise<void>
Implementation of IUserInfoCacheProvider.clear
- Defined in @tessa/platform/src/userInfo/userInfoCacheProvider.ts:121

getUserInfo

getUserInfo(id: string, type?: null | string): Promise<null | IUserInfo>
Retrieves cached 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 IUserInfoCacheProvider.getUserInfo
- Defined in @tessa/platform/src/userInfo/userInfoCacheProvider.ts:60

getUsersInfo

getUsersInfo(ids: string[], type?: null | string): Promise<IUserInfo[]>
Retrieves cached 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 IUserInfoCacheProvider.getUsersInfo
- Defined in @tessa/platform/src/userInfo/userInfoCacheProvider.ts:80

setUserInfo

setUserInfo(info: IUserInfo, type?: null | string): Promise<void>
Caches a single user information object.
Parameters
- info: IUserInfo
  Basic user information.
- Optionaltype: null | string
  Optional user info handler type. If null, the default handler is used.
Returns Promise<void>
Implementation of IUserInfoCacheProvider.setUserInfo
- Defined in @tessa/platform/src/userInfo/userInfoCacheProvider.ts:101

setUsersInfo

setUsersInfo(info: IUserInfo[], type?: null | string): Promise<void>
Caches multiple user information objects.
Parameters
- info: IUserInfo[]
  A collection of basic user informations.
- Optionaltype: null | string
  Optional user info handler type. If null, the default handler is used.
Returns Promise<void>
Implementation of IUserInfoCacheProvider.setUsersInfo
- Defined in @tessa/platform/src/userInfo/userInfoCacheProvider.ts:113