Methods
__setDomain(domain) → {LoginBuilder}
Set domain application. Used in MSISDN flow only. TEMPORARY AND ONLY FOR TEST!
Parameters:
| Name | Type | Description |
|---|---|---|
domain |
String | the application domain |
Returns:
the same instance
- Type
- LoginBuilder
getCustomLoginFlow() → {CustomLoginFlow}
Create a custom login flow.
Returns:
- Type
- CustomLoginFlow
getExternalLoginFlow() → {ExternalLoginFlow}
Create an external login flow.
Returns:
- Type
- ExternalLoginFlow
getMSISDNPINForgotFlow() → {MSISDNPINForgotFlow}
Create a msisdn pin forgot flow.
Returns:
- Type
- MSISDNPINForgotFlow
getMSISDNPINLoginFlow() → {MSISDNPINLoginFlow}
Create a msisdn pin login flow.
Returns:
- Type
- MSISDNPINLoginFlow
getMSISDNURLoginFlow() → {MSISDNURLoginFlow}
Create a msisdn login flow.
Returns:
- Type
- MSISDNURLoginFlow
getOAuthLoginFlow() → {OAuthLoginFlow}
Create a custom login flow.
Returns:
- Type
- OAuthLoginFlow
setAccessToken(access_token) → {LoginBuilder}
Set access token from oauth.
Parameters:
| Name | Type | Description |
|---|---|---|
access_token |
String | The access token given |
Returns:
the same instance
- Type
- LoginBuilder
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
setErrorUrl(errorUrl) → {LoginBuilder}
Set error url.
Parameters:
| Name | Type | Description |
|---|---|---|
errorUrl |
String |
Returns:
the same instance
- Type
- LoginBuilder
setExternalID(externalID) → {LoginBuilder}
Set external id. Used in external flow only.
Parameters:
| Name | Type | Description |
|---|---|---|
externalID |
String | external user id |
Returns:
the same instance
- Type
- LoginBuilder
setMSISDN(msisdn) → {LoginBuilder}
Set MSISDN. Used in MSISDNPINLoginFlow
Parameters:
| Name | Type | Description |
|---|---|---|
msisdn |
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 invoked when a flow is ended
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
FlowCompleteCallback | Invoked at the end of the login flow |
Returns:
the same instance
- Type
- LoginBuilder
setOnFlowCompleteCallback(callback) → {LoginBuilder}
Set callback invoked when a flow is ended
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
FlowCompleteCallback | Invoked at the end of the login flow |
Returns:
the same instance
- Type
- LoginBuilder
setPIN(pin) → {LoginBuilder}
Set PIN. Used in MSISDNPINLoginFlow
Parameters:
| Name | Type | Description |
|---|---|---|
pin |
String |
Returns:
the same instance
- Type
- LoginBuilder
setReturnUrl(returnUrl) → {LoginBuilder}
Set return url.
Parameters:
| Name | Type | Description |
|---|---|---|
returnUrl |
String |
Returns:
the same instance
- Type
- LoginBuilder
setSubscribeUrl(subscribeUrl) → {LoginBuilder}
Set subscribe url. Used in MSISDN flow only.
Parameters:
| Name | Type | Description |
|---|---|---|
subscribeUrl |
String | the login url |
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