Constructor
new LoginController()
Methods
(static) addEventHandler(eventName, eventHandler)
Add handler function for Login Controller's event.
Parameters:
| Name | Type | Description |
|---|---|---|
eventName |
String | Name of the event. |
eventHandler |
function | Function that will be called when event is fired. |
- Since:
- 11.7.0
(static) cancelSSO(errorHandleropt)
Cancel ongoing SSO procedure.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) removeEventHandler(eventName)
Remove handler function for Login Controller's event.
Parameters:
| Name | Type | Description |
|---|---|---|
eventName |
String | Name of the event for which handler will be removed. |
- Since:
- 11.7.0
(static) resetUserData(errorHandleropt)
Erases all user specific data that was cached in add-on.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) setCredentials(username, password, errorHandleropt)
Set credentials that will be used in login process. Should be called when "onCredentialsRequired" event is fired.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
username |
String | Username to be set. | |
password |
String | Password to be set. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) setCTIServers(CTIServers, errorHandleropt)
Set up to a maximum of 3 CTI servers.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
CTIServers |
Array | List of CTI servers to be set | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) setCUCMPServers(CUCMServers, errorHandleropt)
Set up to a maximum of 3 CUCM servers.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
CUCMServers |
Array | List of CUCM servers to be set | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) setEmail(email, errorHandleropt)
Set email address that will be used for service discovery. Should be called when "onEmailRequired" event is fired.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
email |
String | E-mail address to be set. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) setSSORedirectURL(redirectURL)
Set URL that will be used as a redirection once a successful authentication has been performed with
identity provider.
Parameters:
| Name | Type | Description |
|---|---|---|
redirectURL |
String | URL that will be set. |
- Since:
- 11.7.0
(static) setSSOTokenUri(uri, errorHandleropt)
Set SSO token uri that was retrieved from identity provided.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
uri |
String | Token uri that will be set. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) setTFTPServers(TFTPServers, errorHandleropt)
Set up to a maximum of 3 TFTP servers.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
TFTPServers |
Array | List of TFTP servers to be set | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) signIn(errorHandleropt)
Performs manual sign in. In order for sign in to be successful credentials and servers needs to be setup properly.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) signOut(errorHandleropt)
Perform sign out.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) startDiscovery(errorHandleropt)
Start service discovery lifecycle.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
Events
onAuthenticationError
This event is fired if login authentication process fails.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
AuthenticationError | Authentication error that has occurred. |
- Since:
- 11.7.0
onAuthenticationStateChanged
This event is fired during login/logout process.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
AuthenticationState | New state. |
- Since:
- 11.7.0
onCredentialsRequired
This event is fired during login process. Credentials need to be provided in order for login process to continue.
- Since:
- 11.7.0
onDataResetting
This event is fired when user data is being reset.
- Since:
- 11.7.0
onEmailRequired
This event is fired during login process. Email needs to be provided in order for login process to continue.
- Since:
- 11.7.0
onServiceDiscovering
This event is fired when service discovery is in progress.
- Since:
- 11.7.0
onSignedIn
This event is fired when user is signed in.
- Since:
- 11.7.0
onSignedOut
This event is fired when user is signed out.
- Since:
- 11.7.0
onSigningIn
This event is fired when user is signing in.
- Since:
- 11.7.0
onSigningOut
This event is fired when user is signing out.
onSSONavigationRequired
This event is fired during login process. SSO Token needs to be retrieved from .
Parameters:
| Name | Type | Description |
|---|---|---|
redirectURL |
String | SSO redirection URL. |
- Since:
- 11.7.0