Home Manual Reference Source 
import LoginController from 'automation.client.ui/src/controllers/web/login.controller.js'
public class | source

LoginController

Extends:

* → LoginController

Controller to perform login related actions

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public
public
public

Method Summary

Public Methods
public

Checks for errors on the login page
public

async disableWalkMe()

Disable walk me from showing
public

async isLoggedIn(): Boolean

Determines if user is logged in
public

async isLoggedOut(): Boolean

Determinse if user is considered logged out
public

async isLoggingIn(): Boolean

Determines if user is currently logging in
public

async login(email: String, password: String)

Logs in via the normal login page
public

async loginWithCookies(email: String, password: String)

Bypasses normal login page then sets cookies, then navigates to /auth to login.
public

async logout()

Logs out of the app

public

async preLogin()

Pre login steps to set onboarded local storage and disable walkme
public

async setForcedIp()

Set Forced CSS IP
public

async setOnboarded()

Set onboarded local storage to true
public

When closing browser or navigating away, we are presented with an alert.
public

Waits up to 30 seconds to be considered logged in
public

Wait until user is considered logged out

Public Constructors

public constructor(args: Object) source

Params:

NameTypeAttributeDescription
args Object

Args from client

Public Members

public headerPanel: * source

public homePage: * source

public loginPage: * source

public onboardingPage: * source

Public Methods

public async checkForLoginErrors(): String source

Checks for errors on the login page

Return:

String

Text of error message or null

public async disableWalkMe() source

Disable walk me from showing

public async isLoggedIn(): Boolean source

Determines if user is logged in

Return:

Boolean

True if welcome message is visible

TODO:

  • check more things to be considered 'logged in'?

public async isLoggedOut(): Boolean source

Determinse if user is considered logged out

Return:

Boolean

True if considered logged out

public async isLoggingIn(): Boolean source

Determines if user is currently logging in

Return:

Boolean

True if considered logging in

public async login(email: String, password: String) source

Logs in via the normal login page

Params:

NameTypeAttributeDescription
email String

email of user
password String

password of user

Example:

login('test@lifesize.com', 'password123')

public async loginWithCookies(email: String, password: String) source

Bypasses normal login page then sets cookies, then navigates to /auth to login.

Params:

NameTypeAttributeDescription
email String

email of user
password String

password of user

Example:

loginWithCookies('test@lifesize.com', 'password123')

public async logout() source

Logs out of the app

public async preLogin() source

Pre login steps to set onboarded local storage and disable walkme

public async setForcedIp() source

Set Forced CSS IP

public async setOnboarded() source

Set onboarded local storage to true

public async setSkipAlertOnClose() source

When closing browser or navigating away, we are presented with an alert. This run js on the page that tells the app to skip this alert. Hard coded to 300,000ms (5 minutes)

public async waitUntilIsLoggedIn() source

Waits up to 30 seconds to be considered logged in

Example:

client.loginController.waitUntilIsLoggedIn()

public async waitUntilIsLoggedOut() source

Wait until user is considered logged out