IUserService
Represents a user. It is an entry point to various services that can be used to inspect and modify the user.
export interface IUserService
Methods
Method | Description |
|---|---|
(ALPHA) Returns service that can be used to manage API tokens of the user. | |
Returns currently authenticated user | |
Returns currently authenticated user with details | |
Returns service that can be used to obtain settings that are currently in effect for the user. |
Method details
IUserService.apiTokens()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to manage API tokens of the user.
apiTokens(): IUserApiTokensService;
Returns
IUserService.getUser()method
Returns currently authenticated user
getUser(): Promise<IUser>;
Returns
Promise<IUser>
IUserService.getUserWithDetails()method
Returns currently authenticated user with details
getUserWithDetails(): Promise<IUser>;
Returns
Promise<IUser>
IUserService.settings()method
Returns service that can be used to obtain settings that are currently in effect for the user.
settings(): IUserSettingsService;
Returns
user settings service