Package com.docusign.esign.model

Class RecipientPreviewRequest

java.lang.Object

com.docusign.esign.model.RecipientPreviewRequest

public class RecipientPreviewRequest
extends Object

This request object contains the information necessary to create a recipient preview..

Constructor Summary

Constructors

Constructor	Description
RecipientPreviewRequest()

Method Summary

Modifier and Type	Method	Description
RecipientPreviewRequest	assertionId(String assertionId)	assertionId.
RecipientPreviewRequest	authenticationInstant(String authenticationInstant)	authenticationInstant.
RecipientPreviewRequest	authenticationMethod(String authenticationMethod)	authenticationMethod.
RecipientPreviewRequest	clientURLs(RecipientTokenClientURLs clientURLs)	clientURLs.
boolean	equals(Object o)	Compares objects.
String	getAssertionId()	.
String	getAuthenticationInstant()	.
String	getAuthenticationMethod()	.
RecipientTokenClientURLs	getClientURLs()	.
String	getPingFrequency()	.
String	getPingUrl()	.
String	getRecipientId()	Unique for the recipient.
String	getReturnUrl()	.
String	getSecurityDomain()	.
String	getXFrameOptions()	.
String	getXFrameOptionsAllowFromUrl()	.
int	hashCode()	Returns the HashCode.
RecipientPreviewRequest	pingFrequency(String pingFrequency)	pingFrequency.
RecipientPreviewRequest	pingUrl(String pingUrl)	pingUrl.
RecipientPreviewRequest	recipientId(String recipientId)	recipientId.
RecipientPreviewRequest	returnUrl(String returnUrl)	returnUrl.
RecipientPreviewRequest	securityDomain(String securityDomain)	securityDomain.
void	setAssertionId(String assertionId)	setAssertionId.
void	setAuthenticationInstant(String authenticationInstant)	setAuthenticationInstant.
void	setAuthenticationMethod(String authenticationMethod)	setAuthenticationMethod.
void	setClientURLs(RecipientTokenClientURLs clientURLs)	setClientURLs.
void	setPingFrequency(String pingFrequency)	setPingFrequency.
void	setPingUrl(String pingUrl)	setPingUrl.
void	setRecipientId(String recipientId)	setRecipientId.
void	setReturnUrl(String returnUrl)	setReturnUrl.
void	setSecurityDomain(String securityDomain)	setSecurityDomain.
void	setXFrameOptions(String xFrameOptions)	setXFrameOptions.
void	setXFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)	setXFrameOptionsAllowFromUrl.
String	toString()	Converts the given object to string.
RecipientPreviewRequest	xFrameOptions(String xFrameOptions)	xFrameOptions.
RecipientPreviewRequest	xFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)	xFrameOptionsAllowFromUrl.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecipientPreviewRequest

public RecipientPreviewRequest()

Method Detail

assertionId

public RecipientPreviewRequest assertionId(String assertionId)

assertionId.

Returns:

RecipientPreviewRequest

getAssertionId

public String getAssertionId()

.

Returns:

assertionId

setAssertionId

public void setAssertionId(String assertionId)

setAssertionId.

authenticationInstant

public RecipientPreviewRequest authenticationInstant(String authenticationInstant)

authenticationInstant.

Returns:

RecipientPreviewRequest

getAuthenticationInstant

public String getAuthenticationInstant()

.

Returns:

authenticationInstant

setAuthenticationInstant

public void setAuthenticationInstant(String authenticationInstant)

setAuthenticationInstant.

authenticationMethod

public RecipientPreviewRequest authenticationMethod(String authenticationMethod)

authenticationMethod.

Returns:

RecipientPreviewRequest

getAuthenticationMethod

public String getAuthenticationMethod()

.

Returns:

authenticationMethod

setAuthenticationMethod

public void setAuthenticationMethod(String authenticationMethod)

setAuthenticationMethod.

clientURLs

public RecipientPreviewRequest clientURLs(RecipientTokenClientURLs clientURLs)

clientURLs.

Returns:

RecipientPreviewRequest

getClientURLs

public RecipientTokenClientURLs getClientURLs()

.

Returns:

clientURLs

setClientURLs

public void setClientURLs(RecipientTokenClientURLs clientURLs)

setClientURLs.

pingFrequency

public RecipientPreviewRequest pingFrequency(String pingFrequency)

pingFrequency.

Returns:

RecipientPreviewRequest

getPingFrequency

public String getPingFrequency()

.

Returns:

pingFrequency

setPingFrequency

public void setPingFrequency(String pingFrequency)

setPingFrequency.

pingUrl

public RecipientPreviewRequest pingUrl(String pingUrl)

pingUrl.

Returns:

RecipientPreviewRequest

getPingUrl

public String getPingUrl()

.

Returns:

pingUrl

setPingUrl

public void setPingUrl(String pingUrl)

setPingUrl.

recipientId

public RecipientPreviewRequest recipientId(String recipientId)

recipientId.

Returns:

RecipientPreviewRequest

getRecipientId

public String getRecipientId()

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..

Returns:

recipientId

setRecipientId

public void setRecipientId(String recipientId)

setRecipientId.

returnUrl

public RecipientPreviewRequest returnUrl(String returnUrl)

returnUrl.

Returns:

RecipientPreviewRequest

getReturnUrl

public String getReturnUrl()

.

Returns:

returnUrl

setReturnUrl

public void setReturnUrl(String returnUrl)

setReturnUrl.

securityDomain

public RecipientPreviewRequest securityDomain(String securityDomain)

securityDomain.

Returns:

RecipientPreviewRequest

getSecurityDomain

public String getSecurityDomain()

.

Returns:

securityDomain

setSecurityDomain

public void setSecurityDomain(String securityDomain)

setSecurityDomain.

xFrameOptions

public RecipientPreviewRequest xFrameOptions(String xFrameOptions)

xFrameOptions.

Returns:

RecipientPreviewRequest

getXFrameOptions

public String getXFrameOptions()

.

Returns:

xFrameOptions

setXFrameOptions

public void setXFrameOptions(String xFrameOptions)

setXFrameOptions.

xFrameOptionsAllowFromUrl

public RecipientPreviewRequest xFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)

xFrameOptionsAllowFromUrl.

Returns:

RecipientPreviewRequest

getXFrameOptionsAllowFromUrl

public String getXFrameOptionsAllowFromUrl()

.

Returns:

xFrameOptionsAllowFromUrl

setXFrameOptionsAllowFromUrl

public void setXFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)

setXFrameOptionsAllowFromUrl.

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