Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthenticationService

Interface that describes how injectable Authentication Services should work

Hierarchy

  • Disposable
    • AuthenticationService

Implemented by

Index

Properties

currentUser

currentUser: ObservableValue<User>

dispose

dispose: function

Method called when the IDisposable is disposed.

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

state

state: ObservableValue<LoginState>

This observable indicates the current state of the service

LoginState.Pending

Methods

checkForUpdate

  • checkForUpdate(): Promise<boolean>

login

  • login(username: string, password: string): Promise<boolean>
  • Tries to log in with a specified credentials. Updates the current state subject based on the login response.

    Parameters

    • username: string

      The user's name

    • password: string

      The user's password

    Returns Promise<boolean>

    that indicates if the login was successful

logout

  • logout(): Promise<boolean>

Generated using TypeDoc