RecipientViewRequest (docusign-esign-java 3.14.0 API)

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

public class RecipientViewRequest
extends Object

RecipientViewRequest

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`	`addFrameAncestorsItem(String frameAncestorsItem)`
`RecipientViewRequest`	`addMessageOriginsItem(String messageOriginsItem)`
`RecipientViewRequest`	`assertionId(String assertionId)`
`RecipientViewRequest`	`authenticationInstant(String authenticationInstant)`
`RecipientViewRequest`	`authenticationMethod(String authenticationMethod)`
`RecipientViewRequest`	`clientURLs(RecipientTokenClientURLs clientURLs)`
`RecipientViewRequest`	`clientUserId(String clientUserId)`
`RecipientViewRequest`	`email(String email)`
`boolean`	`equals(Object o)`
`RecipientViewRequest`	`frameAncestors(List<String> frameAncestors)`
`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.
`RecipientTokenClientURLs`	`getClientURLs()` Get clientURLs
`String`	`getClientUserId()` A sender created value that shows the recipient is embedded (captive).
`String`	`getEmail()` Specifies the email of the recipient.
`List<String>`	`getFrameAncestors()`
`List<String>`	`getMessageOrigins()`
`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 redirected to after the signing session has ended.
`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.
`String`	`getXFrameOptions()`
`String`	`getXFrameOptionsAllowFromUrl()`
`int`	`hashCode()`
`RecipientViewRequest`	`messageOrigins(List<String> messageOrigins)`
`RecipientViewRequest`	`pingFrequency(String pingFrequency)`
`RecipientViewRequest`	`pingUrl(String pingUrl)`
`RecipientViewRequest`	`recipientId(String recipientId)`
`RecipientViewRequest`	`returnUrl(String returnUrl)`
`RecipientViewRequest`	`securityDomain(String securityDomain)`
`void`	`setAssertionId(String assertionId)`
`void`	`setAuthenticationInstant(String authenticationInstant)`
`void`	`setAuthenticationMethod(String authenticationMethod)`
`void`	`setClientURLs(RecipientTokenClientURLs clientURLs)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setEmail(String email)`
`void`	`setFrameAncestors(List<String> frameAncestors)`
`void`	`setMessageOrigins(List<String> messageOrigins)`
`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)`
`void`	`setXFrameOptions(String xFrameOptions)`
`void`	`setXFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)`
`String`	`toString()`
`RecipientViewRequest`	`userId(String userId)`
`RecipientViewRequest`	`userName(String userName)`
`RecipientViewRequest`	`xFrameOptions(String xFrameOptions)`
`RecipientViewRequest`	`xFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)`

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

- Constructor Detail
  - RecipientViewRequest
```
public RecipientViewRequest()
```
- Method Detail
  - assertionId
```
public RecipientViewRequest assertionId(String assertionId)
```
  - getAssertionId
```
public String getAssertionId()
```
    A unique identifier of the authentication event executed by the client application.
    
    Returns:
    
    assertionId
  - setAssertionId
```
public void setAssertionId(String assertionId)
```
  - authenticationInstant
```
public RecipientViewRequest authenticationInstant(String authenticationInstant)
```
  - getAuthenticationInstant
```
public String getAuthenticationInstant()
```
    A sender generated value that indicates the date/time that the signer was authenticated.
    
    Returns:
    
    authenticationInstant
  - setAuthenticationInstant
```
public void setAuthenticationInstant(String authenticationInstant)
```
  - authenticationMethod
```
public RecipientViewRequest authenticationMethod(String authenticationMethod)
```
  - 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.
    
    Returns:
    
    authenticationMethod
  - setAuthenticationMethod
```
public void setAuthenticationMethod(String authenticationMethod)
```
  - clientURLs
```
public RecipientViewRequest clientURLs(RecipientTokenClientURLs clientURLs)
```
  - getClientURLs
```
public RecipientTokenClientURLs getClientURLs()
```
    Get clientURLs
    
    Returns:
    
    clientURLs
  - setClientURLs
```
public void setClientURLs(RecipientTokenClientURLs clientURLs)
```
  - clientUserId
```
public RecipientViewRequest clientUserId(String clientUserId)
```
  - getClientUserId
```
public String getClientUserId()
```
    A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters.
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - email
```
public RecipientViewRequest email(String email)
```
  - getEmail
```
public String getEmail()
```
    Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
  - frameAncestors
```
public RecipientViewRequest frameAncestors(List<String> frameAncestors)
```
  - addFrameAncestorsItem
```
public RecipientViewRequest addFrameAncestorsItem(String frameAncestorsItem)
```
  - getFrameAncestors
```
public List<String> getFrameAncestors()
```
    Returns:
    
    frameAncestors
  - setFrameAncestors
```
public void setFrameAncestors(List<String> frameAncestors)
```
  - messageOrigins
```
public RecipientViewRequest messageOrigins(List<String> messageOrigins)
```
  - addMessageOriginsItem
```
public RecipientViewRequest addMessageOriginsItem(String messageOriginsItem)
```
  - getMessageOrigins
```
public List<String> getMessageOrigins()
```
    Returns:
    
    messageOrigins
  - setMessageOrigins
```
public void setMessageOrigins(List<String> messageOrigins)
```
  - pingFrequency
```
public RecipientViewRequest pingFrequency(String pingFrequency)
```
  - 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.
    
    Returns:
    
    pingFrequency
  - setPingFrequency
```
public void setPingFrequency(String pingFrequency)
```
  - pingUrl
```
public RecipientViewRequest pingUrl(String pingUrl)
```
  - 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.
    
    Returns:
    
    pingUrl
  - setPingUrl
```
public void setPingUrl(String pingUrl)
```
  - recipientId
```
public RecipientViewRequest recipientId(String recipientId)
```
  - 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)
```
  - returnUrl
```
public RecipientViewRequest returnUrl(String returnUrl)
```
  - getReturnUrl
```
public String getReturnUrl()
```
    The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.
    
    Returns:
    
    returnUrl
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
  - securityDomain
```
public RecipientViewRequest securityDomain(String securityDomain)
```
  - getSecurityDomain
```
public String getSecurityDomain()
```
    The domain in which the user authenticated.
    
    Returns:
    
    securityDomain
  - setSecurityDomain
```
public void setSecurityDomain(String securityDomain)
```
  - userId
```
public RecipientViewRequest userId(String userId)
```
  - 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.
    
    Returns:
    
    userId
  - setUserId
```
public void setUserId(String userId)
```
  - userName
```
public RecipientViewRequest userName(String userName)
```
  - getUserName
```
public String getUserName()
```
    Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.
    
    Returns:
    
    userName
  - setUserName
```
public void setUserName(String userName)
```
  - xFrameOptions
```
public RecipientViewRequest xFrameOptions(String xFrameOptions)
```
  - getXFrameOptions
```
public String getXFrameOptions()
```
    Returns:
    
    xFrameOptions
  - setXFrameOptions
```
public void setXFrameOptions(String xFrameOptions)
```
  - xFrameOptionsAllowFromUrl
```
public RecipientViewRequest xFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)
```
  - getXFrameOptionsAllowFromUrl
```
public String getXFrameOptionsAllowFromUrl()
```
    Returns:
    
    xFrameOptionsAllowFromUrl
  - setXFrameOptionsAllowFromUrl
```
public void setXFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl)
```
  - 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

assertionId

getAssertionId

setAssertionId

authenticationInstant

getAuthenticationInstant

setAuthenticationInstant

authenticationMethod

getAuthenticationMethod

setAuthenticationMethod

clientURLs

getClientURLs

setClientURLs

clientUserId

getClientUserId

setClientUserId

email

getEmail

setEmail

frameAncestors

addFrameAncestorsItem

getFrameAncestors

setFrameAncestors

messageOrigins

addMessageOriginsItem

getMessageOrigins

setMessageOrigins

pingFrequency

getPingFrequency

setPingFrequency

pingUrl

getPingUrl

setPingUrl

recipientId

getRecipientId

setRecipientId

returnUrl

getReturnUrl

setReturnUrl

securityDomain

getSecurityDomain

setSecurityDomain

userId

getUserId

setUserId

userName

getUserName

setUserName

xFrameOptions

getXFrameOptions

setXFrameOptions

xFrameOptionsAllowFromUrl

getXFrameOptionsAllowFromUrl

setXFrameOptionsAllowFromUrl

equals

hashCode

toString