com.docusign.esign.model

Class RecipientViewRequest

java.lang.Object

com.docusign.esign.model.RecipientViewRequest

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-14T16:41:01.888-08:00")
public class RecipientViewRequest
extends Object

Constructor Summary

Constructors

Constructor and Description
RecipientViewRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAssertionId() A unique identifier of the authentication event executed by the client application.
String	getAuthenticationInstant() A sender generated value that indicates the date/time that the signer was authenticated.
String	getAuthenticationMethod() A sender created value that indicates the convention used to authenticate the signer.
String	getClientUserId() A sender created value that shows the recipient is embedded (captive).
String	getEmail() Specifies the email of the recipient.
String	getPingFrequency() Only used if pingUrl is specified.
String	getPingUrl() A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active.
String	getRecipientId() Unique for the recipient.
String	getReturnUrl() The URL the recipient is directed to on certain events.
String	getSecurityDomain() The domain in which the user authenticated.
String	getUserId() Specifies the user ID of the recipient.
String	getUserName() Specifies the username of the recipient.
int	hashCode()
void	setAssertionId(String assertionId)
void	setAuthenticationInstant(String authenticationInstant)
void	setAuthenticationMethod(String authenticationMethod)
void	setClientUserId(String clientUserId)
void	setEmail(String email)
void	setPingFrequency(String pingFrequency)
void	setPingUrl(String pingUrl)
void	setRecipientId(String recipientId)
void	setReturnUrl(String returnUrl)
void	setSecurityDomain(String securityDomain)
void	setUserId(String userId)
void	setUserName(String userName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RecipientViewRequest

public RecipientViewRequest()

Method Detail

getClientUserId

public String getClientUserId()

A sender created value that shows the recipient is embedded (captive). \n\nMaximum length: 100 characters.

setClientUserId

public void setClientUserId(String clientUserId)

getUserId

public String getUserId()

Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user.

setUserId

public void setUserId(String userId)

getUserName

public String getUserName()

Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.

setUserName

public void setUserName(String userName)

getEmail

public String getEmail()

Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.

setEmail

public void setEmail(String email)

getRecipientId

public String getRecipientId()

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

setRecipientId

public void setRecipientId(String recipientId)

getReturnUrl

public String getReturnUrl()

The URL the recipient is directed to on certain events. DocuSign sends returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: \n\n* cancel (recipient cancels signing)\n* decline (recipient declines signing)\n* exception (exception occurs)\n* fax_pending (recipient has fax pending)\n* check); session_timeout (session times out)\n* completes signing)\n* expires)\n* viewing_complete (recipient completes viewing the envelope)\n\n## Important: You must include HTTPS:// in the URL or the redirect might be blocked by some browsers.

setReturnUrl

public void setReturnUrl(String returnUrl)

getPingUrl

public String getPingUrl()

A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received.

setPingUrl

public void setPingUrl(String pingUrl)

getPingFrequency

public String getPingFrequency()

Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.

setPingFrequency

public void setPingFrequency(String pingFrequency)

getAuthenticationMethod

public String getAuthenticationMethod()

A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion.

setAuthenticationMethod

public void setAuthenticationMethod(String authenticationMethod)

getAssertionId

public String getAssertionId()

A unique identifier of the authentication event executed by the client application.

setAssertionId

public void setAssertionId(String assertionId)

getAuthenticationInstant

public String getAuthenticationInstant()

A sender generated value that indicates the date/time that the signer was authenticated.

setAuthenticationInstant

public void setAuthenticationInstant(String authenticationInstant)

getSecurityDomain

public String getSecurityDomain()

The domain in which the user authenticated.

setSecurityDomain

public void setSecurityDomain(String securityDomain)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object