Class AuthenticationService

A base class for the Authentication Service

Hierarchy

AuthenticationService

Index

Constructors

Properties

authenticationClient router user

Methods

getLoggedInUserId isUserLoggedIn login logout register

Constructors

constructor

new AuthenticationService(authenticationClient: AuthenticationClient, router: Router): AuthenticationService
Constructor for the AuthenticationService
Parameters
- authenticationClient: AuthenticationClient
- router: Router
  
  For redirecting User to web pages
Returns AuthenticationService
- Defined in authentication/authentication.service.ts:28

Properties

`Private` authenticationClient

authenticationClient: AuthenticationClient

`Private` router

router: Router

For redirecting User to web pages

`Private` user

user: User = ...

The User loggin in

Methods

getLoggedInUserId

getLoggedInUserId(): string
Retrieves the logged in Users ID if it exists

Returns
A User ID if a user is logged in, else null

Returns string
- Defined in authentication/authentication.service.ts:102

isUserLoggedIn

isUserLoggedIn(): boolean
Checks whether a User is logged in

Returns
True if a User ID is stored in local storage. False if no User ID is in local storage.

Returns boolean
- Defined in authentication/authentication.service.ts:93

login

login(email: string, password: string): void
Checks if User details email and password match a record in the database. If Login is valid, redirect to '/homepage', else redirect to '/login' web page.
Parameters
- email: string
  
  Email address of User logging in
- password: string
  
  Password of User logging in
Returns void
- Defined in authentication/authentication.service.ts:40

logout

logout(): void
Logs a User out by deleting their ID and eMail in local storage and then redirects to the '/login' web page.

Returns void
- Defined in authentication/authentication.service.ts:83

register

register(firstName: string, lastName: string, email: string, password: string, kNumber: string): void
Registers a new site User
Parameters
- firstName: string
  
  New User first name
- lastName: string
  
  New User last name
- email: string
  
  New User email address
- password: string
  
  New User password
- kNumber: string
  
  New user kNumber
Returns void
- Defined in authentication/authentication.service.ts:71

Generated using TypeDoc