ESET Secure Authentication SDK documentation
 All Classes Namespaces Functions Variables
Public Member Functions | List of all members
ESET\SecureAuthentication\SDK\TwoFactorConfiguration Class Reference
Inheritance diagram for ESET\SecureAuthentication\SDK\TwoFactorConfiguration:
ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings

Public Member Functions

 __construct ($apiKey, $apiSecret, $userStorage)
 
 getUserStorage ()
 
 getAuditor ()
 
 setAuditor ($value)
 
 getTextMessageSender ()
 
 setTextMessageSender ($value)
 
- Public Member Functions inherited from ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings
 __construct ($apiKey, $apiSecret)
 
 getApiKey ()
 
 getApiSecret ()
 
 getTokenName ()
 
 setTokenName ($value)
 
 getPinEnforced ()
 
 setPinEnforced ($value)
 
 getAppInstallTextMessageText ()
 
 setAppInstallTextMessageText ($value)
 
 getTextMessageOtpText ()
 
 setTextMessageOtpText ($value)
 
 getMaxFailuresBeforeLocking ()
 
 setMaxFailuresBeforeLocking ($value)
 
 getTextMessageOtpLifetime ()
 
 setTextMessageOtpLifetime ($value)
 
 getSeedLength ()
 
 getOtpLength ()
 
 getTextMessageOtpLength ()
 
 getHotpLookAheadWindow ()
 

Constructor & Destructor Documentation

ESET\SecureAuthentication\SDK\TwoFactorConfiguration::__construct (   $apiKey,
  $apiSecret,
  $userStorage 
)

Create a new TwoFactorConfiguration object.

To retrieve the API key and secret, see the included licensing utility.

Parameters
string$apiKeyAPI key
string$apiSecretAPI secret
IUserStorage$userStorage

Member Function Documentation

ESET\SecureAuthentication\SDK\TwoFactorConfiguration::getAuditor ( )

Retrieve the custom security auditor implementation

Returns
IAuditor
ESET\SecureAuthentication\SDK\TwoFactorConfiguration::getTextMessageSender ( )

Retrieve the custom text message gateway implementation

Returns
ITextMessageSender
ESET\SecureAuthentication\SDK\TwoFactorConfiguration::getUserStorage ( )

Retrieve the custom user storage implementation

Returns
IUserStorage
ESET\SecureAuthentication\SDK\TwoFactorConfiguration::setAuditor (   $value)

Set the custom security auditor implementation

Parameters
IAuditor$value
ESET\SecureAuthentication\SDK\TwoFactorConfiguration::setTextMessageSender (   $value)

Set the custom text message gateway implementation

Parameters
ITextMessageSender$value