ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings Class Reference

Inheritance diagram for ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings:

Public Member Functions
	__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\Internal\TwoFactorSettings::__construct	(		$apiKey,
			$apiSecret
	)

Create a new TwoFactorSettings object

Parameters

string	$apiKey	API key
string	$apiSecret	API secret

Member Function Documentation

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::getApiKey

(

)

Retrieve the API key

Returns

string

Implements ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings.

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::getApiSecret

(

)

Retrieve the API secret

Returns

string

Implements ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings.

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::getAppInstallTextMessageText

(

)

Retrieve the text message template used when sending app install URLs

Returns

string

Implements ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings.

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::getMaxFailuresBeforeLocking

(

)

Retrieve the maximum number of consecutive login failures before an account is locked

Returns

int

Implements ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings.

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::getPinEnforced

(

)

Retrieve the PIN enforcement value

Returns

bool True: PINs are required by the mobile app; False: PINs are optional

Implements ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings.

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::getTextMessageOtpLifetime

(

)

Retrieve the number of minutes for which a text message OTP remains valid

Returns

int

Implements ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings.

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::getTextMessageOtpText

(

)

Retrieve the text message template used when sending text message OTPs

Returns

string

Implements ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings.

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::getTokenName

(

)

Retrieve the token name used in the mobile app

Returns

string

Implements ESET\SecureAuthentication\SDK\Internal\ITwoFactorSettings.

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::setAppInstallTextMessageText

(

$value

)

Set the text message template used when sending app install URLs

The template must contain the value of the Constants::APP_INSTALL_TEXT_MESSAGE_TEXT_URL_PLACEHOLDER constant.

Constants string $value Message template

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::setMaxFailuresBeforeLocking

(

$value

)

Set the maximum number of consecutive login failures before an account is locked

Parameters

int

$value

3 <= $value <= 30

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::setPinEnforced

(

$value

)

Set the PIN enforcement value

Parameters

bool

$value

True: PINs are required by the mobile app; False: PINs are optional

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::setTextMessageOtpLifetime

(

$value

)

Set the number of minutes for which a text message OTP remains valid

Parameters

int

$value

5 <= $value <= 60

Exceptions

\ESET\SecureAuthentication\SDK\Exceptions\ArgumentOutOfRangeException

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::setTextMessageOtpText

(

$value

)

Set the text message template used when sending text message OTPs

The template must contain the value of the Constants::TEXT_MESSAGE_OTP_TEXT_OTP_PLACEHOLDER constant.

Constants string $value Message template

ESET\SecureAuthentication\SDK\Internal\TwoFactorSettings::setTokenName

(

$value

)

Set the token name used in the mobile app

Only takes effect when provisioning a new mobile app

Parameters

string

$value