RecipientViewRequest (docusign-esign-java 2.0.1 API)

java.lang.Object
- com.docusign.esign.model.RecipientViewRequest

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2016-04-27T11:06:30.816-07:00")
public class RecipientViewRequest
extends Object

Constructor Summary

Constructors
Constructor and Description

RecipientViewRequest()

Constructors
Constructor and Description
`RecipientViewRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecipientViewRequest`	`assertionId(String assertionId)` A unique identifier of the authentication event executed by the client application.
`RecipientViewRequest`	`authenticationInstant(String authenticationInstant)` A sender generated value that indicates the date/time that the signer was authenticated.
`RecipientViewRequest`	`authenticationMethod(String authenticationMethod)` A sender created value that indicates the convention used to authenticate the signer.
`RecipientViewRequest`	`clientUserId(String clientUserId)` A sender created value that shows the recipient is embedded (captive).
`RecipientViewRequest`	`email(String email)` Specifies the email of the recipient.
`boolean`	`equals(Object o)`
`String`	`getAssertionId()`
`String`	`getAuthenticationInstant()`
`String`	`getAuthenticationMethod()`
`String`	`getClientUserId()`
`String`	`getEmail()`
`String`	`getPingFrequency()`
`String`	`getPingUrl()`
`String`	`getRecipientId()`
`String`	`getReturnUrl()`
`String`	`getSecurityDomain()`
`String`	`getUserId()`
`String`	`getUserName()`
`int`	`hashCode()`
`RecipientViewRequest`	`pingFrequency(String pingFrequency)` Only used if pingUrl is specified.
`RecipientViewRequest`	`pingUrl(String pingUrl)` A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active.
`RecipientViewRequest`	`recipientId(String recipientId)` Unique for the recipient.
`RecipientViewRequest`	`returnUrl(String returnUrl)` The URL the recipient is directed to on certain events.
`RecipientViewRequest`	`securityDomain(String securityDomain)` The domain in which the user authenticated.
`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()`
`RecipientViewRequest`	`userId(String userId)` Specifies the user ID of the recipient.
`RecipientViewRequest`	`userName(String userName)` Specifies the username of the recipient.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecipientViewRequest
```
public RecipientViewRequest()
```
- Method Detail
  - clientUserId
```
public RecipientViewRequest clientUserId(String clientUserId)
```
    A sender created value that shows the recipient is embedded (captive). \n\nMaximum length: 100 characters.
  - getClientUserId
```
public String getClientUserId()
```
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - userId
```
public RecipientViewRequest userId(String userId)
```
    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.
  - getUserId
```
public String getUserId()
```
  - setUserId
```
public void setUserId(String userId)
```
  - userName
```
public RecipientViewRequest userName(String userName)
```
    Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.
  - getUserName
```
public String getUserName()
```
  - setUserName
```
public void setUserName(String userName)
```
  - email
```
public RecipientViewRequest email(String email)
```
    Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.
  - getEmail
```
public String getEmail()
```
  - setEmail
```
public void setEmail(String email)
```
  - recipientId
```
public RecipientViewRequest recipientId(String recipientId)
```
    Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
  - getRecipientId
```
public String getRecipientId()
```
  - setRecipientId
```
public void setRecipientId(String recipientId)
```
  - returnUrl
```
public RecipientViewRequest returnUrl(String returnUrl)
```
    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.
  - getReturnUrl
```
public String getReturnUrl()
```
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
  - pingUrl
```
public RecipientViewRequest pingUrl(String pingUrl)
```
    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.
  - getPingUrl
```
public String getPingUrl()
```
  - setPingUrl
```
public void setPingUrl(String pingUrl)
```
  - pingFrequency
```
public RecipientViewRequest pingFrequency(String pingFrequency)
```
    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.
  - getPingFrequency
```
public String getPingFrequency()
```
  - setPingFrequency
```
public void setPingFrequency(String pingFrequency)
```
  - authenticationMethod
```
public RecipientViewRequest authenticationMethod(String authenticationMethod)
```
    A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion.
  - getAuthenticationMethod
```
public String getAuthenticationMethod()
```
  - setAuthenticationMethod
```
public void setAuthenticationMethod(String authenticationMethod)
```
  - assertionId
```
public RecipientViewRequest assertionId(String assertionId)
```
    A unique identifier of the authentication event executed by the client application.
  - getAssertionId
```
public String getAssertionId()
```
  - setAssertionId
```
public void setAssertionId(String assertionId)
```
  - authenticationInstant
```
public RecipientViewRequest authenticationInstant(String authenticationInstant)
```
    A sender generated value that indicates the date/time that the signer was authenticated.
  - getAuthenticationInstant
```
public String getAuthenticationInstant()
```
  - setAuthenticationInstant
```
public void setAuthenticationInstant(String authenticationInstant)
```
  - securityDomain
```
public RecipientViewRequest securityDomain(String securityDomain)
```
    The domain in which the user authenticated.
  - getSecurityDomain
```
public String getSecurityDomain()
```
  - 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

Class RecipientViewRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecipientViewRequest

Method Detail

clientUserId

getClientUserId

setClientUserId

userId

getUserId

setUserId

userName

getUserName

setUserName

email

getEmail

setEmail

recipientId

getRecipientId

setRecipientId

returnUrl

getReturnUrl

setReturnUrl

pingUrl

getPingUrl

setPingUrl

pingFrequency

getPingFrequency

setPingFrequency

authenticationMethod

getAuthenticationMethod

setAuthenticationMethod

assertionId

getAssertionId

setAssertionId

authenticationInstant

getAuthenticationInstant

setAuthenticationInstant

securityDomain

getSecurityDomain

setSecurityDomain

equals

hashCode

toString