Stores the information required to verify an account.
This object is only valid for a specific time after creation and it holds all the
information needed to validate a PIN using
verifyAccount(String, VerificationHandle)
. If an expired handle is returned by
challengeAccount(RecaptchaHandle, String)
, then
getOperationAbortedToken()
will return a token that can be used with the reCAPTCHA
Enterprise API CreateAssessment() to get more details.
Public Constructor Summary
Public Method Summary
abstract int |
getCodeLength()
Returns the length of the PIN code.
|
abstract String |
getOperationAbortedToken()
Returns a reCAPTCHA token in the case
challengeAccount(RecaptchaHandle, String) operation was aborted and
an expired VerificationHandle
was returned, otherwise this returns an empty string.
|
abstract String |
getSiteKey()
Returns the site public key you registered for using reCAPTCHA.
|
abstract long |
getTimeoutMinutes()
Returns the validity duration of the object since its creation in minutes.
|
abstract String |
getVerificationToken()
Returns an encrypted version of the internal verification token that will be
used in
verifyAccount(String, VerificationHandle) call.
|
boolean |
isValid()
Returns a boolean indicating if the
VerificationHandle
is valid for
verifyAccount(String, VerificationHandle) API calls.
|
Inherited Method Summary
Public Constructors
public VerificationHandle ()
Public Methods
public abstract int getCodeLength ()
Returns the length of the PIN code.
public abstract String getOperationAbortedToken ()
Returns a reCAPTCHA token in the case
challengeAccount(RecaptchaHandle, String)
operation was aborted and an
expired VerificationHandle
was returned, otherwise this returns an empty string. This can be used with the
reCAPTCHA Enterprise API CreateAssessment() to retrieve more details.
public abstract String getSiteKey ()
Returns the site public key you registered for using reCAPTCHA.
public abstract long getTimeoutMinutes ()
Returns the validity duration of the object since its creation in minutes.
public abstract String getVerificationToken ()
Returns an encrypted version of the internal verification token that will be used in
verifyAccount(String, VerificationHandle)
call.
public boolean isValid ()
Returns a boolean indicating if the VerificationHandle
is valid for
verifyAccount(String, VerificationHandle)
API calls. An invalid handle will
cause
verifyAccount(String, VerificationHandle)
calls to fail immediately.