ESET Secure Authentication SDK documentation
 All Classes Functions Variables
Public Member Functions | List of all members
com.eset.secureauthentication.sdk.internal.TwoFactorSettings Class Reference
Inheritance diagram for com.eset.secureauthentication.sdk.internal.TwoFactorSettings:
com.eset.secureauthentication.sdk.internal.ITwoFactorSettings com.eset.secureauthentication.sdk.TwoFactorConfiguration

Public Member Functions

 TwoFactorSettings (String apiKey, String apiSecret)
 
String getApiKey ()
 
String getApiSecret ()
 
String getTokenName ()
 
void setTokenName (String tokenName)
 
boolean getPINEnforced ()
 
void setPINEnforced (boolean pinEnforced)
 
String getAppInstallTextMessageText ()
 
void setAppInstallTextMessageText (String appInstallTextMessageText)
 
String getTextMessageOTPText ()
 
void setTextMessageOTPText (String textMessageOTPText)
 
int getMaxFailuresBeforeLocking ()
 
void setMaxFailuresBeforeLocking (int maxFailuresBeforeLocking)
 
int getTextMessageOTPLifetime ()
 
void setTextMessageOTPLifetime (int textMessageOTPLifetime)
 
int getSeedLength ()
 
int getOTPLength ()
 
int getTextMessageOTPLength ()
 
int getHOTPLookAheadWindow ()
 

Detailed Description

Configuration data.

Constructor & Destructor Documentation

com.eset.secureauthentication.sdk.internal.TwoFactorSettings.TwoFactorSettings ( String  apiKey,
String  apiSecret 
)
inline

Construct a new instance of #com.eset.secureauthentication.sdk.internal.TwoFactorSettings.

Parameters
apiKeyAPI key
apiSecretAPI secret

Member Function Documentation

String com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getApiKey ( )
inline
String com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getApiSecret ( )
inline
String com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getAppInstallTextMessageText ( )
inline
Returns
the text that is displayed in the mobile app installation text message

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

int com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getHOTPLookAheadWindow ( )
inline

This setting can not be changed.

Returns
number of OTPs to look ahead when authentication mobile app HOTPs

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

int com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getMaxFailuresBeforeLocking ( )
inline

Get the maximum number of allowed failures before locking.

Returns
the maximum number of allowed failures before the user will be locked

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

int com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getOTPLength ( )
inline

This setting can not be changed.

Returns
length of mobile app OTPs (number of characters)

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

boolean com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getPINEnforced ( )
inline

Get value of the PIN enforced setting.

Returns
true if PIN protection is enforced for the mobile app

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

int com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getSeedLength ( )
inline

This setting can not be changed.

Returns
length of mobile app OTP seed (shared secret)

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

int com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getTextMessageOTPLength ( )
inline

This setting can not be changed.

Returns
length of text message OTPs (number of characters)

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

int com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getTextMessageOTPLifetime ( )
inline

Get text message OTP lifetime.

Returns
the number of minutes for which text message OTPs remain valid

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

String com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getTextMessageOTPText ( )
inline
Returns
text message OTP text

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

String com.eset.secureauthentication.sdk.internal.TwoFactorSettings.getTokenName ( )
inline

Get token name setting.

Returns
name of OTP token displayed in mobile app

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

void com.eset.secureauthentication.sdk.internal.TwoFactorSettings.setAppInstallTextMessageText ( String  appInstallTextMessageText)
inline
Parameters
appInstallTextMessageTextvalue to set text that is displayed in the mobile app installation text message to, must contain Constants.APP_INSTALL_TEXT_MESSAGE_TEXT_URL_PLACEHOLDER

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

void com.eset.secureauthentication.sdk.internal.TwoFactorSettings.setMaxFailuresBeforeLocking ( int  maxFailuresBeforeLocking)
inline

Set the maximum number of allowed failures before locking.

Parameters
maxFailuresBeforeLockingthe maximum number of allowed failures before the user will be locked, must be between 3 and 30 (inclusive)

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

void com.eset.secureauthentication.sdk.internal.TwoFactorSettings.setPINEnforced ( boolean  pinEnforced)
inline

Set the value of the PIN enforced settings.

Parameters
pinEnforcedtrue if PIN protection is enforced for the mobile app

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

void com.eset.secureauthentication.sdk.internal.TwoFactorSettings.setTextMessageOTPLifetime ( int  textMessageOTPLifetime)
inline

Set text message OTP lifetime. The number of minutes for which text message OTPs remain valid.

Parameters
textMessageOTPLifetimevalue to set text message OTP lifetime to, must be between 5 and 60 minutes (inclusive)

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

void com.eset.secureauthentication.sdk.internal.TwoFactorSettings.setTextMessageOTPText ( String  textMessageOTPText)
inline
Parameters
textMessageOTPTextvalue to set text message OTP text to, must contain Constants.TEXT_MESSAGE_OTP_TEXT_OTP_PLACEHOLDER

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.

void com.eset.secureauthentication.sdk.internal.TwoFactorSettings.setTokenName ( String  tokenName)
inline

Set token name setting.

Parameters
tokenNamevalue to set name of OTP token displayed in mobile app to

Implements com.eset.secureauthentication.sdk.internal.ITwoFactorSettings.


The documentation for this class was generated from the following file: