Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthService

The AuthService interface is used to authenticate and authorize users of the Gis Framework

Hierarchy

  • AuthService

Index

Properties

Properties

accessLevels

accessLevels: AccessLevels

Property accessLevels contains AccessLevels used in this service.

authenticate

authenticate: function

Authenticate the current User

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

authorize

authorize: function

Compare resource Role bitMask vs a user's Role bitMask

param

Role.

param

Role.

returns

number.

Type declaration

    • (accessLevel: any, role: Role): number

    • Parameters

      • accessLevel: any
      • role: Role

      Returns number

isLoggedIn

isLoggedIn: function

Check a User's authentication status

param

User.

returns

boolean.

Type declaration

    • (user: User): boolean

    • Parameters

      • user: User

      Returns boolean

loginChange

loginChange: Event<User>

Event triggered when logged in user changes

logout

logout: function

Log out the current User

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

user

user: User

Property user contains the current User.

userRoles

userRoles: Role[]

Property userRoles contains an array of Role used in this service.