Class Login

Used for login into the Leo, it's required for most of the methods. Use the method exec() before use for another class constructor

Hierarchy (view full)

Method
- Login

Index

Constructors

Properties

AuthToken Cache? Route StudentCode? Token isTokenUsed

Methods

checkVigencia exec getPlanfromCache getToken recreateToken setToken

Constructors

constructor

new Login(credentials, options?): Login
Parameters
- credentials: UserCredentials
- Optionaloptions: Partial<Options>
Returns Login
Overrides Method.constructor
- Defined in source/auth/Login.ts:51

Properties

`Protected`AuthToken

AuthToken: string

`Optional`Cache

Cache?: Cache

`Protected`Route

Route: string = "https://micro-leo.udg.mx/login/v1/validar"

`Optional`StudentCode

StudentCode?: string

`Protected`Token

Token: TokenType = ...

isTokenUsed

isTokenUsed: boolean = false

Methods

checkVigencia

checkVigencia(): boolean
Check if you need to regenerate a token

Returns boolean
- Defined in source/auth/Login.ts:108

exec

exec(): Promise<void>
Returns Promise<void>
Overrides Method.exec
- Defined in source/auth/Login.ts:75

getPlanfromCache

getPlanfromCache(student): undefined | Plans
Execute the login method, it's required for most of the methods. This will load the token and the student code on the class
Parameters
- student: string
Returns undefined | Plans
- Defined in source/auth/Login.ts:66

getToken

getToken(): Required<TokenType>
Get the token and its vigency

Returns Required<TokenType>
- Defined in source/auth/Login.ts:103

`Protected`recreateToken

recreateToken(): void
Used for create a new token after it was used

Returns void
Inherited from Method.recreateToken
- Defined in source/utils/Method.ts:20

setToken

setToken(token): void
Parameters
- token: Required<TokenType>
Returns void
- Defined in source/auth/Login.ts:123