Methods
getCustomLoginFlow() → {CustomLoginFlow}
Create a custom login flow.
Returns:
- Type
- CustomLoginFlow
getExternalLoginFlow() → {ExternalLoginFlow}
Create a external login flow.
Returns:
- Type
- ExternalLoginFlow
getOAuthLoginFlow() → {OAuthLoginFlow}
Create a custom login flow.
Returns:
- Type
- OAuthLoginFlow
setAllowCustomLogin() → {LoginBuilder}
Persist the custom login among the page refreshing. A session cookie is set.
Returns:
the same instance
- Type
- LoginBuilder
setCustomData(loginData) → {LoginBuilder}
Set login data. Useful to track campaign parameters
Parameters:
Name | Type | Description |
---|---|---|
loginData |
Newton.SimpleObject | the custom data for the login event |
Returns:
the same instance
- Type
- LoginBuilder
setCustomID(customID) → {LoginBuilder}
Set custom id. Used in custom flow only.
Parameters:
Name | Type | Description |
---|---|---|
customID |
String | custom user id |
Returns:
the same instance
- Type
- LoginBuilder
setCustomID(customID) → {LoginBuilder}
Set custom id. Used in custom flow only.
Parameters:
Name | Type | Description |
---|---|---|
customID |
String | custom user id |
Returns:
the same instance
- Type
- LoginBuilder
setErrorUrl(errorUrl) → {LoginBuilder}
Set error url. Used in OAuthLoginFlow
Parameters:
Name | Type | Description |
---|---|---|
errorUrl |
String |
Returns:
the same instance
- Type
- LoginBuilder
setOAuthProvider(oauth) → {LoginBuilder}
Set oauth provider needed for OAuthLoginFlow
Parameters:
Name | Type | Description |
---|---|---|
oauth |
String | provider |
Returns:
the same instance
- Type
- LoginBuilder
setOnFlowCompleteCallback(callback) → {LoginBuilder}
Set callback
Parameters:
Name | Type | Description |
---|---|---|
callback |
FlowCompleteCallback | Invoked at the end of the login flow |
Returns:
the same instance
- Type
- LoginBuilder
setReturnUrl(returnUrl) → {LoginBuilder}
Set return url. Used in OAuthLoginFlow
Parameters:
Name | Type | Description |
---|---|---|
returnUrl |
String |
Returns:
the same instance
- Type
- LoginBuilder
setWaitingUrl(waitingUrl) → {LoginBuilder}
Set waiting url. Used in OAuthLoginFlow
Parameters:
Name | Type | Description |
---|---|---|
waitingUrl |
String |
Returns:
the same instance
- Type
- LoginBuilder