Package com.docusign.esign.model

Class AuthenticationStatus

java.lang.Object

com.docusign.esign.model.AuthenticationStatus

public class AuthenticationStatus
extends Object

Contains information about the authentication status..

Constructor Summary

Constructors

Constructor	Description
AuthenticationStatus()

Method Summary

Modifier and Type	Method	Description
AuthenticationStatus	accessCodeResult(EventResult accessCodeResult)	accessCodeResult.
AuthenticationStatus	ageVerifyResult(EventResult ageVerifyResult)	ageVerifyResult.
AuthenticationStatus	anySocialIDResult(EventResult anySocialIDResult)	anySocialIDResult.
boolean	equals(Object o)	Compares objects.
AuthenticationStatus	facebookResult(EventResult facebookResult)	facebookResult.
EventResult	getAccessCodeResult()	The result of a user's attempt to authenticate by using an access code.
EventResult	getAgeVerifyResult()	The result of an age verification check.
EventResult	getAnySocialIDResult()	Deprecated..
EventResult	getFacebookResult()	Deprecated..
EventResult	getGoogleResult()	Deprecated..
EventResult	getIdentityVerificationResult()	The result of an [Identity Verification][IDV] workflow.
EventResult	getIdLookupResult()	The result of an ID lookup authentication check.
EventResult	getIdQuestionsResult()	The result of the user's answers to ID challenge questions.
EventResult	getLinkedinResult()	Deprecated..
EventResult	getLiveIDResult()	Deprecated..
EventResult	getOfacResult()	The result of an Office of Foreign Asset Control (OFAC) check.
EventResult	getOpenIDResult()	Deprecated..
EventResult	getPhoneAuthResult()	The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging.
EventResult	getSalesforceResult()	Success/failure result of authentication using sign-in with a Salesforce account.
EventResult	getSignatureProviderResult()	The result of the user's attempt to authenticate by using a signature provider..
EventResult	getSmsAuthResult()	The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone..
EventResult	getSTANPinResult()	The result of a Student Authentication Network (STAN) authentication check.
EventResult	getTwitterResult()	Deprecated..
EventResult	getYahooResult()	Deprecated..
AuthenticationStatus	googleResult(EventResult googleResult)	googleResult.
int	hashCode()	Returns the HashCode.
AuthenticationStatus	identityVerificationResult(EventResult identityVerificationResult)	identityVerificationResult.
AuthenticationStatus	idLookupResult(EventResult idLookupResult)	idLookupResult.
AuthenticationStatus	idQuestionsResult(EventResult idQuestionsResult)	idQuestionsResult.
AuthenticationStatus	linkedinResult(EventResult linkedinResult)	linkedinResult.
AuthenticationStatus	liveIDResult(EventResult liveIDResult)	liveIDResult.
AuthenticationStatus	ofacResult(EventResult ofacResult)	ofacResult.
AuthenticationStatus	openIDResult(EventResult openIDResult)	openIDResult.
AuthenticationStatus	phoneAuthResult(EventResult phoneAuthResult)	phoneAuthResult.
AuthenticationStatus	salesforceResult(EventResult salesforceResult)	salesforceResult.
void	setAccessCodeResult(EventResult accessCodeResult)	setAccessCodeResult.
void	setAgeVerifyResult(EventResult ageVerifyResult)	setAgeVerifyResult.
void	setAnySocialIDResult(EventResult anySocialIDResult)	setAnySocialIDResult.
void	setFacebookResult(EventResult facebookResult)	setFacebookResult.
void	setGoogleResult(EventResult googleResult)	setGoogleResult.
void	setIdentityVerificationResult(EventResult identityVerificationResult)	setIdentityVerificationResult.
void	setIdLookupResult(EventResult idLookupResult)	setIdLookupResult.
void	setIdQuestionsResult(EventResult idQuestionsResult)	setIdQuestionsResult.
void	setLinkedinResult(EventResult linkedinResult)	setLinkedinResult.
void	setLiveIDResult(EventResult liveIDResult)	setLiveIDResult.
void	setOfacResult(EventResult ofacResult)	setOfacResult.
void	setOpenIDResult(EventResult openIDResult)	setOpenIDResult.
void	setPhoneAuthResult(EventResult phoneAuthResult)	setPhoneAuthResult.
void	setSalesforceResult(EventResult salesforceResult)	setSalesforceResult.
void	setSignatureProviderResult(EventResult signatureProviderResult)	setSignatureProviderResult.
void	setSmsAuthResult(EventResult smsAuthResult)	setSmsAuthResult.
void	setSTANPinResult(EventResult sTANPinResult)	setSTANPinResult.
void	setTwitterResult(EventResult twitterResult)	setTwitterResult.
void	setYahooResult(EventResult yahooResult)	setYahooResult.
AuthenticationStatus	signatureProviderResult(EventResult signatureProviderResult)	signatureProviderResult.
AuthenticationStatus	smsAuthResult(EventResult smsAuthResult)	smsAuthResult.
AuthenticationStatus	sTANPinResult(EventResult sTANPinResult)	sTANPinResult.
String	toString()	Converts the given object to string.
AuthenticationStatus	twitterResult(EventResult twitterResult)	twitterResult.
AuthenticationStatus	yahooResult(EventResult yahooResult)	yahooResult.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthenticationStatus

public AuthenticationStatus()

Method Detail

accessCodeResult

public AuthenticationStatus accessCodeResult(EventResult accessCodeResult)

accessCodeResult.

Returns:

AuthenticationStatus

getAccessCodeResult

public EventResult getAccessCodeResult()

The result of a user's attempt to authenticate by using an access code. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .

Returns:

accessCodeResult

setAccessCodeResult

public void setAccessCodeResult(EventResult accessCodeResult)

setAccessCodeResult.

ageVerifyResult

public AuthenticationStatus ageVerifyResult(EventResult ageVerifyResult)

ageVerifyResult.

Returns:

AuthenticationStatus

getAgeVerifyResult

public EventResult getAgeVerifyResult()

The result of an age verification check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .

Returns:

ageVerifyResult

setAgeVerifyResult

public void setAgeVerifyResult(EventResult ageVerifyResult)

setAgeVerifyResult.

anySocialIDResult

public AuthenticationStatus anySocialIDResult(EventResult anySocialIDResult)

anySocialIDResult.

Returns:

AuthenticationStatus

getAnySocialIDResult

public EventResult getAnySocialIDResult()

Deprecated..

Returns:

anySocialIDResult

setAnySocialIDResult

public void setAnySocialIDResult(EventResult anySocialIDResult)

setAnySocialIDResult.

facebookResult

public AuthenticationStatus facebookResult(EventResult facebookResult)

facebookResult.

Returns:

AuthenticationStatus

getFacebookResult

public EventResult getFacebookResult()

Deprecated..

Returns:

facebookResult

setFacebookResult

public void setFacebookResult(EventResult facebookResult)

setFacebookResult.

googleResult

public AuthenticationStatus googleResult(EventResult googleResult)

googleResult.

Returns:

AuthenticationStatus

getGoogleResult

public EventResult getGoogleResult()

Deprecated..

Returns:

googleResult

setGoogleResult

public void setGoogleResult(EventResult googleResult)

setGoogleResult.

identityVerificationResult

public AuthenticationStatus identityVerificationResult(EventResult identityVerificationResult)

identityVerificationResult.

Returns:

AuthenticationStatus

getIdentityVerificationResult

public EventResult getIdentityVerificationResult()

The result of an [Identity Verification][IDV] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/.

Returns:

identityVerificationResult

setIdentityVerificationResult

public void setIdentityVerificationResult(EventResult identityVerificationResult)

setIdentityVerificationResult.

idLookupResult

public AuthenticationStatus idLookupResult(EventResult idLookupResult)

idLookupResult.

Returns:

AuthenticationStatus

getIdLookupResult

public EventResult getIdLookupResult()

The result of an ID lookup authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .

Returns:

idLookupResult

setIdLookupResult

public void setIdLookupResult(EventResult idLookupResult)

setIdLookupResult.

idQuestionsResult

public AuthenticationStatus idQuestionsResult(EventResult idQuestionsResult)

idQuestionsResult.

Returns:

AuthenticationStatus

getIdQuestionsResult

public EventResult getIdQuestionsResult()

The result of the user's answers to ID challenge questions. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .

Returns:

idQuestionsResult

setIdQuestionsResult

public void setIdQuestionsResult(EventResult idQuestionsResult)

setIdQuestionsResult.

linkedinResult

public AuthenticationStatus linkedinResult(EventResult linkedinResult)

linkedinResult.

Returns:

AuthenticationStatus

getLinkedinResult

public EventResult getLinkedinResult()

Deprecated..

Returns:

linkedinResult

setLinkedinResult

public void setLinkedinResult(EventResult linkedinResult)

setLinkedinResult.

liveIDResult

public AuthenticationStatus liveIDResult(EventResult liveIDResult)

liveIDResult.

Returns:

AuthenticationStatus

getLiveIDResult

public EventResult getLiveIDResult()

Deprecated..

Returns:

liveIDResult

setLiveIDResult

public void setLiveIDResult(EventResult liveIDResult)

setLiveIDResult.

ofacResult

public AuthenticationStatus ofacResult(EventResult ofacResult)

ofacResult.

Returns:

AuthenticationStatus

getOfacResult

public EventResult getOfacResult()

The result of an Office of Foreign Asset Control (OFAC) check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .

Returns:

ofacResult

setOfacResult

public void setOfacResult(EventResult ofacResult)

setOfacResult.

openIDResult

public AuthenticationStatus openIDResult(EventResult openIDResult)

openIDResult.

Returns:

AuthenticationStatus

getOpenIDResult

public EventResult getOpenIDResult()

Deprecated..

Returns:

openIDResult

setOpenIDResult

public void setOpenIDResult(EventResult openIDResult)

setOpenIDResult.

phoneAuthResult

public AuthenticationStatus phoneAuthResult(EventResult phoneAuthResult)

phoneAuthResult.

Returns:

AuthenticationStatus

getPhoneAuthResult

public EventResult getPhoneAuthResult()

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .

Returns:

phoneAuthResult

setPhoneAuthResult

public void setPhoneAuthResult(EventResult phoneAuthResult)

setPhoneAuthResult.

salesforceResult

public AuthenticationStatus salesforceResult(EventResult salesforceResult)

salesforceResult.

Returns:

AuthenticationStatus

getSalesforceResult

public EventResult getSalesforceResult()

Success/failure result of authentication using sign-in with a Salesforce account. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .

Returns:

salesforceResult

setSalesforceResult

public void setSalesforceResult(EventResult salesforceResult)

setSalesforceResult.

signatureProviderResult

public AuthenticationStatus signatureProviderResult(EventResult signatureProviderResult)

signatureProviderResult.

Returns:

AuthenticationStatus

getSignatureProviderResult

public EventResult getSignatureProviderResult()

The result of the user's attempt to authenticate by using a signature provider..

Returns:

signatureProviderResult

setSignatureProviderResult

public void setSignatureProviderResult(EventResult signatureProviderResult)

setSignatureProviderResult.

smsAuthResult

public AuthenticationStatus smsAuthResult(EventResult smsAuthResult)

smsAuthResult.

Returns:

AuthenticationStatus

getSmsAuthResult

public EventResult getSmsAuthResult()

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone..

Returns:

smsAuthResult

setSmsAuthResult

public void setSmsAuthResult(EventResult smsAuthResult)

setSmsAuthResult.

sTANPinResult

public AuthenticationStatus sTANPinResult(EventResult sTANPinResult)

sTANPinResult.

Returns:

AuthenticationStatus

getSTANPinResult

public EventResult getSTANPinResult()

The result of a Student Authentication Network (STAN) authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. .

Returns:

sTANPinResult

setSTANPinResult

public void setSTANPinResult(EventResult sTANPinResult)

setSTANPinResult.

twitterResult

public AuthenticationStatus twitterResult(EventResult twitterResult)

twitterResult.

Returns:

AuthenticationStatus

getTwitterResult

public EventResult getTwitterResult()

Deprecated..

Returns:

twitterResult

setTwitterResult

public void setTwitterResult(EventResult twitterResult)

setTwitterResult.

yahooResult

public AuthenticationStatus yahooResult(EventResult yahooResult)

yahooResult.

Returns:

AuthenticationStatus

getYahooResult

public EventResult getYahooResult()

Deprecated..

Returns:

yahooResult

setYahooResult

public void setYahooResult(EventResult yahooResult)

setYahooResult.

equals

public boolean equals(Object o)

Compares objects.

Overrides:

equals in class Object

Returns:

true or false depending on comparison result.

hashCode

public int hashCode()

Returns the HashCode.

Overrides:

hashCode in class Object

toString

public String toString()

Converts the given object to string.

Overrides:

toString in class Object