Class: LoginService

Hierarchy

• DefaultLocalService<LoginState>

  ↳ LoginService

Constructors

constructor

• new LoginService(notificationService, authService)

Parameters

Name	Type
notificationService	NotificationService
authService	AuthService

Overrides

DefaultLocalService.constructor

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:35

Properties

[combinedReducers]

• [combinedReducers]: (state: any, action: any) => any

Type declaration

▸ (state, action): any

Parameters

Name	Type
state	any
action	any

Returns

any

Inherited from

DefaultLocalService.[combinedReducers]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:63

---

[dispatch]

• [dispatch]: any

Inherited from

DefaultLocalService.[dispatch]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:62

---

[inReducer]

• [inReducer]: boolean

Inherited from

DefaultLocalService.[inReducer]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:64

---

[reducers]

• [reducers]: any

Inherited from

DefaultLocalService.[reducers]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:59

---

[sagas]

• [sagas]: any

Inherited from

DefaultLocalService.[sagas]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:61

---

[types]

• [types]: any

Inherited from

DefaultLocalService.[types]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:60

---

authService

• authService: AuthService

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:33

---

context

• context: BasicAppContext

Inherited from

DefaultLocalService.context

Defined in

onekijs/packages/onekijs-framework/src/app/LocalService.ts:9

---

notificationService

• notificationService: NotificationService

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:32

---

state

• state: LoginState

Inherited from

DefaultLocalService.state

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:66

Methods

[create]

▸ [create](initialState): void

Parameters

Name	Type
initialState	LoginState

Returns

void

Inherited from

DefaultLocalService.[create]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:69

---

[run]

▸ [run](): void

Returns

void

Inherited from

DefaultLocalService.[run]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:208

---

[stop]

▸ [stop](): void

Returns

void

Inherited from

DefaultLocalService.[stop]

Defined in

onekijs/packages/onekijs-framework/src/core/Service.ts:226

---

externalLogin

▸ externalLogin(idpName?, onError?): Generator<string | void | Promise<string>, void, unknown>

Redirect the user to an external login page

Parameters

Name	Type
idpName?	string
onError?	ErrorCallback<BasicError>

Returns

Generator<string | void | Promise<string>, void, unknown>

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:181

---

externalLoginCallback

▸ externalLoginCallback(idpName?, onError?, onSuccess?): Generator<string | void | Promise<any> | [any?, AnonymousObject<any>?] | Generator<void | CallEffect<void> | Generator<void | Promise<boolean> | ForkEffect<undefined | AnonymousObject<any>>, null | string | AnonymousObject<any>, boolean> | Generator<string | void | Promise<any> | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>>, undefined | null | AnonymousObject<any>, null | AnonymousObject<any>>, void, unknown>, void, string & [unknown, any]>

Parse the token and the security context from the response of the external login

Parameters

Name	Type
idpName?	string
onError?	ErrorCallback<BasicError>
onSuccess?	SuccessCallback<any>

Returns

Generator<string | void | Promise<any> | [any?, AnonymousObject<any>?] | Generator<void | CallEffect<void> | Generator<void | Promise<boolean> | ForkEffect<undefined | AnonymousObject<any>>, null | string | AnonymousObject<any>, boolean> | Generator<string | void | Promise<any> | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>>, undefined | null | AnonymousObject<any>, null | AnonymousObject<any>>, void, unknown>, void, string & [unknown, any]>

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:299

---

formLogin

▸ formLogin(data, idpName?, onError?, onSuccess?): Generator<unknown, void, [any, any]>

Submit the login form

Parameters

Name	Type
data	AnonymousObject<any>
idpName?	string
onError?	ErrorCallback<BasicError>
onSuccess?	SuccessCallback<any>

Returns

Generator<unknown, void, [any, any]>

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:90

---

login

▸ login(idpName?, onError?, onSuccess?): Generator<void | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>> | Generator<string | void | Promise<any> | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>>, undefined | null | AnonymousObject<any>, null | AnonymousObject<any>> | Generator<void | CallEffect<void> | Generator<void | Promise<boolean> | ForkEffect<undefined | AnonymousObject<any>>, null | string | AnonymousObject<any>, boolean> | Generator<string | void | Promise<any> | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>>, undefined | null | AnonymousObject<any>, null | AnonymousObject<any>>, void, unknown> | Generator<string | void | Promise<string>, void, unknown>, void, OidcToken & AnonymousObject<any>>

Check if a login is necessary.

Parameters

Name	Type
idpName?	string
onError?	ErrorCallback<BasicError>
onSuccess?	SuccessCallback<any>

Returns

Generator<void | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>> | Generator<string | void | Promise<any> | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>>, undefined | null | AnonymousObject<any>, null | AnonymousObject<any>> | Generator<void | CallEffect<void> | Generator<void | Promise<boolean> | ForkEffect<undefined | AnonymousObject<any>>, null | string | AnonymousObject<any>, boolean> | Generator<string | void | Promise<any> | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>>, undefined | null | AnonymousObject<any>, null | AnonymousObject<any>>, void, unknown> | Generator<string | void | Promise<string>, void, unknown>, void, OidcToken & AnonymousObject<any>>

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:517

---

onError

▸ onError(error): void

Inform the user if there is an error

Parameters

Name	Type
error	DefaultBasicError

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:59

---

onSuccess

▸ onSuccess(): void

Reset the loading and error message after a successful operation

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:70

---

setLoading

▸ setLoading(loading): void

Inform the user if there is a loading task

Parameters

Name	Type
loading	boolean

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:48

---

successLogin

▸ successLogin(token?, securityContext?, idpName?, onError?, onSuccess?): Generator<void | CallEffect<void> | Generator<void | Promise<boolean> | ForkEffect<undefined | AnonymousObject<any>>, null | string | AnonymousObject<any>, boolean> | Generator<string | void | Promise<any> | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>>, undefined | null | AnonymousObject<any>, null | AnonymousObject<any>>, void, unknown>

Save the token and the security context

Parameters

Name	Type
token?	string | AnonymousObject<any>
securityContext?	AnonymousObject<any>
idpName?	string
onError?	ErrorCallback<BasicError>
onSuccess?	SuccessCallback<any>

Returns

Generator<void | CallEffect<void> | Generator<void | Promise<boolean> | ForkEffect<undefined | AnonymousObject<any>>, null | string | AnonymousObject<any>, boolean> | Generator<string | void | Promise<any> | Generator<void | AnonymousObject<any>, undefined | null | string | AnonymousObject<any>, string & string & AnonymousObject<any>>, undefined | null | AnonymousObject<any>, null | AnonymousObject<any>>, void, unknown>

Defined in

onekijs/packages/onekijs-framework/src/auth/LoginService.ts:447