Class AuthenticationService

An "authentication" service for a GeoMapFish application. Upon loading, it launches a request to determine whether a user is currently logged in or not.

The possible API requests it supports, which are all self-explanatory, are:

changePassword
login
logout
resetPassword

Hierarchy

AuthenticationService

Index

Constructors

constructor

new AuthenticationService(): AuthenticationService
Returns AuthenticationService
- Defined in src/auth/service.ts:91

Properties

verifyConnection_

verifyConnection_: number

Methods

changePassword

changePassword(login: string, oldPwd: string, newPwd: string, confPwd: string, otp??: string): Promise<void>
Returns
Promise.
Parameters
- login: string
  
  Login.
- oldPwd: string
  
  Old password.
- newPwd: string
  
  New password.
- confPwd: string
  
  New password confirmation.
- Optional otp: string = undefined
  
  One-time password.
Returns Promise<void>
- Defined in src/auth/service.ts:191

checkUser_

checkUser_(data: User): User
Check the user to have a user with all parameters in all cases.

Returns
Response.
Parameters
- data: User
  
  Ajax response.
Returns User
- Defined in src/auth/service.ts:260

getEmail

getEmail(): string
Returns
User's email

Returns string
- Defined in src/auth/service.ts:309

getRolesIds

getRolesIds(): number[]
Returns
The roles IDs.

Returns number[]
- Defined in src/auth/service.ts:316

getRolesNames

getRolesNames(): string[]
Returns
The roles names.

Returns string[]
- Defined in src/auth/service.ts:323

getUsername

getUsername(): string
Returns
Username

Returns string
- Defined in src/auth/service.ts:302

handleDisconnection

handleDisconnection(): void
Returns void
- Defined in src/auth/service.ts:158

login

login(login: string, pwd: string, otp??: string): Promise<void | User>
Returns
Promise.
Parameters
- login: string
  
  Login name.
- pwd: string
  
  Password.
- Optional otp: string = undefined
  
  One-time password.
Returns Promise<void | User>
- Defined in src/auth/service.ts:229

logout

logout(): Promise<void>
Returns
Promise.

Returns Promise<void>
- Defined in src/auth/service.ts:272

resetPassword

resetPassword(login: string): Promise<AuthenticationDefaultResponse>
Returns
Promise.
Parameters
- login: string
  
  Login name.
Returns Promise<AuthenticationDefaultResponse>
- Defined in src/auth/service.ts:285

resetUser

resetUser(userState: UserState, noReload: boolean): void
Parameters
- userState: UserState
  
  state of the user.
- noReload: boolean
  
  Don't request a new user object from the back-end after logging out, defaults to false.
Returns void
- Defined in src/auth/service.ts:357

Class AuthenticationService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AuthenticationService

Properties

verifyConnection_

Methods

changePassword

Returns

Parameters

login: string

oldPwd: string

newPwd: string

confPwd: string

Optional otp: string = undefined

Returns Promise<void>

checkUser_

Returns

Parameters

data: User

Returns User

getEmail

Returns

Returns string

getRolesIds

Returns

Returns number[]

getRolesNames

Returns

Returns string[]

getUsername

Returns

Returns string

handleDisconnection

Returns void

login

Returns

Parameters

login: string

pwd: string

Optional otp: string = undefined

Returns Promise<void | User>

logout

Returns

Returns Promise<void>

resetPassword

Returns

Parameters

login: string

Returns Promise<AuthenticationDefaultResponse>

resetUser

Parameters

userState: UserState

noReload: boolean

Returns void

Settings

Member Visibility

Theme

`Optional` otp: string = undefined

`Optional` otp: string = undefined