VerificationHandle

AI-generated Key Takeaways

VerificationHandle is an abstract class that stores information needed to verify an account and is only valid for a specific time.
This object holds information necessary for validating a PIN using the verifyAccount method.
An expired handle from challengeAccount provides a token that can be used with the reCAPTCHA Enterprise API for more details.
Key methods include retrieving PIN code length, site key, validity duration, verification token, and a token for aborted operations.

public abstract class VerificationHandle extends Object
implements Serializable

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

VerificationHandle ()

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

From class java.lang.Object

Object	clone ()
boolean	equals ( Object arg0)
void	finalize ()
final Class <?>	getClass ()
int	hashCode ()
final void	notify ()
final void	notifyAll ()
String	toString ()
final void	wait (long arg0, int arg1)
final void	wait (long arg0)
final void	wait ()

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.

VerificationHandle Stay organized with collections Save and categorize content based on your preferences.