Class: LoginBuilder

LoginBuilder

<private> new LoginBuilder()

Login utilities
Source:

Methods

getCustomFlow() → {CustomLoginFlow}

Create a custom login flow.
Source:
Returns:
Type
CustomLoginFlow

getOAuthFlow() → {OAuthLoginFlow}

Create a custom login flow.
Source:
Returns:
Type
OAuthLoginFlow

setAllowCustomLoginSession() → {LoginBuilder}

Persist the custom login among the page refreshing. A session cookie is set
Source:
Returns:
the same instance
Type
LoginBuilder

setCallback(callback) → {LoginBuilder}

Set callback
Parameters:
Name Type Description
callback
Source:
Returns:
the same instance
Type
LoginBuilder

setCustomID(customID) → {LoginBuilder}

Set custom id. Used in custom flow.
Parameters:
Name Type Description
customID string custom user id
Source:
Returns:
the same instance
Type
LoginBuilder

setErrorUrl(errorUrl) → {LoginBuilder}

Set return url. Used in OAuthLoginFlow
Parameters:
Name Type Description
errorUrl string
Source:
Returns:
the same instance
Type
LoginBuilder

setLoginData(loginData) → {LoginBuilder}

Set login data. Useful to track campaign parameters
Parameters:
Name Type Description
loginData SimpleObject the custom data for the login event
Source:
Returns:
the same instance
Type
LoginBuilder

setOAuthProvider(oauth) → {LoginBuilder}

Set oauth provider needed for OAuthLoginFlow
Parameters:
Name Type Description
oauth string provider
Source:
Returns:
the same instance
Type
LoginBuilder

setReturnUrl(returnUrl) → {LoginBuilder}

Set return url. Used in OAuthLoginFlow
Parameters:
Name Type Description
returnUrl string
Source:
Returns:
the same instance
Type
LoginBuilder

setWaitingUrl(waitingUrl) → {LoginBuilder}

Set return url. Used in OAuthLoginFlow
Parameters:
Name Type Description
waitingUrl string
Source:
Returns:
the same instance
Type
LoginBuilder