Interface UserAdminService

Service used to login/logout a user. Available as service with interface ct.framework.api.UserAdmin

interface UserAdminService {
    getAuthentication(): Authentication;
    getAuthorization(authentication?: Authentication | User): Authorization;
    getUser(authentication?: Authentication): undefined | User;
    login(
        credentials?: LoginCredentials,
        options?: LoginOptions,
    ): Promise<Authentication>;
    logout(authentication?: Authentication): Promise<boolean>;
    on<Name extends keyof UserAdminServiceEvents>(
        name: Name,
        callBack: EventCallback<UserAdminServiceEvents[Name]>,
    ): Handle;
}

Hierarchy

EventSource<UserAdminServiceEvents>
- UserAdminService

Index

Methods

getAuthentication getAuthorization getUser login logout on

Methods

getAuthentication

getAuthentication(): Authentication
Gets the current authentication state.

Returns Authentication
- Defined in apprt/api/index.ts:2210

getAuthorization

getAuthorization(authentication?: Authentication | User): Authorization
Creates an Authorization object that provides access to the roles of the current user.
Parameters
- Optionalauthentication: Authentication | User
Returns Authorization
- Defined in apprt/api/index.ts:2215

getUser

getUser(authentication?: Authentication): undefined | User
Creates an User object that provides access to properties of the current user. (normally triggered via: getAuthentication().getUser(); )
Parameters
- Optionalauthentication: Authentication
Returns undefined | User
- Defined in apprt/api/index.ts:2221

login

login(
credentials?: LoginCredentials,
options?: LoginOptions,
): Promise<Authentication>
Performs a login. options is only {refresh:true}, which marks that no events are triggered!
Parameters
- Optionalcredentials: LoginCredentials
- Optionaloptions: LoginOptions
Returns Promise<Authentication>
- Defined in apprt/api/index.ts:2227

logout

logout(authentication?: Authentication): Promise<boolean>
Triggers logout of an Authentication instance (normally triggered via: getAuthentication().logout();
Parameters
- Optionalauthentication: Authentication
Returns Promise<boolean>
- Defined in apprt/api/index.ts:2233

on

on<Name extends keyof UserAdminServiceEvents>(
name: Name,
callBack: EventCallback<UserAdminServiceEvents[Name]>,
): Handle
Registers event listener.
Type Parameters
- Name extends keyof UserAdminServiceEvents
Parameters
- name: Name
- callBack: EventCallback<UserAdminServiceEvents[Name]>
Returns Handle
Inherited from EventSource.on
- Defined in apprt-core/Types.ts:85