Package com.docusign.esign.model
Class RecipientPreviewRequest
- java.lang.Object
-
- com.docusign.esign.model.RecipientPreviewRequest
-
- All Implemented Interfaces:
Serializable
public class RecipientPreviewRequest extends Object implements Serializable
This request object contains the information necessary to create a recipient preview..- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description RecipientPreviewRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RecipientPreviewRequestassertionId(String assertionId)assertionId.RecipientPreviewRequestauthenticationInstant(String authenticationInstant)authenticationInstant.RecipientPreviewRequestauthenticationMethod(String authenticationMethod)authenticationMethod.RecipientPreviewRequestclientURLs(RecipientTokenClientURLs clientURLs)clientURLs.booleanequals(Object o)Compares objects.StringgetAssertionId().StringgetAuthenticationInstant().StringgetAuthenticationMethod().RecipientTokenClientURLsgetClientURLs().StringgetPingFrequency().StringgetPingUrl().StringgetRecipientId()Unique for the recipient.StringgetReturnUrl().StringgetSecurityDomain().StringgetXFrameOptions().StringgetXFrameOptionsAllowFromUrl().inthashCode()Returns the HashCode.RecipientPreviewRequestpingFrequency(String pingFrequency)pingFrequency.RecipientPreviewRequestpingUrl(String pingUrl)pingUrl.RecipientPreviewRequestrecipientId(String recipientId)recipientId.RecipientPreviewRequestreturnUrl(String returnUrl)returnUrl.RecipientPreviewRequestsecurityDomain(String securityDomain)securityDomain.voidsetAssertionId(String assertionId)setAssertionId.voidsetAuthenticationInstant(String authenticationInstant)setAuthenticationInstant.voidsetAuthenticationMethod(String authenticationMethod)setAuthenticationMethod.voidsetClientURLs(RecipientTokenClientURLs clientURLs)setClientURLs.voidsetPingFrequency(String pingFrequency)setPingFrequency.voidsetPingUrl(String pingUrl)setPingUrl.voidsetRecipientId(String recipientId)setRecipientId.voidsetReturnUrl(String returnUrl)setReturnUrl.voidsetSecurityDomain(String securityDomain)setSecurityDomain.voidsetXFrameOptions(String xFrameOptions)setXFrameOptions.voidsetXFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)setXFrameOptionsAllowFromUrl.StringtoString()Converts the given object to string.RecipientPreviewRequestxFrameOptions(String xFrameOptions)xFrameOptions.RecipientPreviewRequestxFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)xFrameOptionsAllowFromUrl.
-
-
-
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.
-
-