InPersonSigner (com.docusign:docusign-esign-java 2.0.0 API)

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

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

Constructor Summary

Constructors
Constructor and Description

InPersonSigner()

Constructors
Constructor and Description
`InPersonSigner()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAccessCode()` If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
`String`	`getAddAccessCodeToEmail()` This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`String`	`getCanSignOffline()` When set to true, specifies that the signer can perform the signing ceremony offline.
`String`	`getClientUserId()` Specifies whether the recipient is embedded or remote.
`List<String>`	`getCustomFields()` An optional array of strings that allows the sender to provide custom data about the recipient.
`String`	`getDeclinedDateTime()` The date and time the recipient declined the document.
`String`	`getDeclinedReason()` The reason the recipient declined the document.
`String`	`getDefaultRecipient()`
`String`	`getDeliveredDateTime()` Reserved: For DocuSign use only.
`String`	`getDeliveryMethod()` Reserved: For DocuSign use only.
`RecipientEmailNotification`	`getEmailNotification()`
`String`	`getEmbeddedRecipientStartURL()` Specifies a sender provided valid URL string for redirecting an embedded recipient.
`ErrorDetails`	`getErrorDetails()`
`String`	`getFaxNumber()` Reserved:
`String`	`getHostEmail()`
`String`	`getHostName()` Specifies the name of the signing host.
`String`	`getIdCheckConfigurationName()` Specifies authentication check by name.
`IdCheckInformationInput`	`getIdCheckInformationInput()`
`String`	`getInheritEmailNotificationConfiguration()` When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`String`	`getNote()` Specifies a note that is unique to this recipient.
`OfflineAttributes`	`getOfflineAttributes()`
`RecipientPhoneAuthentication`	`getPhoneAuthentication()`
`List<Attachment>`	`getRecipientAttachments()` Reserved:
`AuthenticationStatus`	`getRecipientAuthenticationStatus()`
`String`	`getRecipientId()` Unique for the recipient.
`String`	`getRecipientIdGuid()`
`String`	`getRecipientSuppliesTabs()`
`String`	`getRequireIdLookup()` When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`String`	`getRequireSignerCertificate()`
`String`	`getRequireSignOnPaper()`
`String`	`getRoleName()` Optional element.
`String`	`getRoutingOrder()` Specifies the routing order of the recipient in the envelope.
`RecipientSAMLAuthentication`	`getSamlAuthentication()`
`String`	`getSentDateTime()` The date and time the envelope was sent.
`RecipientSignatureInformation`	`getSignatureInfo()`
`String`	`getSignedDateTime()` Reserved: For DocuSign use only.
`String`	`getSignerEmail()` The email address for an InPersonSigner recipient Type.
`String`	`getSignerName()` Required.
`String`	`getSignInEachLocation()` When set to true, specifies that the signer must sign in all locations.
`String`	`getSigningGroupId()` When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
`String`	`getSigningGroupName()` The display name for the signing group.
`List<UserInfo>`	`getSigningGroupUsers()` A complex type that contains information about users in the signing group.
`RecipientSMSAuthentication`	`getSmsAuthentication()`
`List<SocialAuthentication>`	`getSocialAuthentications()` Lists the social ID type that can be used for recipient authentication.
`String`	`getStatus()` Indicates the envelope status.
`Tabs`	`getTabs()`
`String`	`getTemplateLocked()` When set to true, the sender cannot change any attributes of the recipient.
`String`	`getTemplateRequired()` When set to true, the sender may not remove the recipient.
`String`	`getTotalTabCount()`
`String`	`getUserId()`
`int`	`hashCode()`
`void`	`setAccessCode(String accessCode)`
`void`	`setAddAccessCodeToEmail(String addAccessCodeToEmail)`
`void`	`setCanSignOffline(String canSignOffline)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setCustomFields(List<String> customFields)`
`void`	`setDeclinedDateTime(String declinedDateTime)`
`void`	`setDeclinedReason(String declinedReason)`
`void`	`setDefaultRecipient(String defaultRecipient)`
`void`	`setDeliveredDateTime(String deliveredDateTime)`
`void`	`setDeliveryMethod(String deliveryMethod)`
`void`	`setEmailNotification(RecipientEmailNotification emailNotification)`
`void`	`setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFaxNumber(String faxNumber)`
`void`	`setHostEmail(String hostEmail)`
`void`	`setHostName(String hostName)`
`void`	`setIdCheckConfigurationName(String idCheckConfigurationName)`
`void`	`setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`void`	`setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`
`void`	`setNote(String note)`
`void`	`setOfflineAttributes(OfflineAttributes offlineAttributes)`
`void`	`setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`void`	`setRecipientAttachments(List<Attachment> recipientAttachments)`
`void`	`setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRecipientIdGuid(String recipientIdGuid)`
`void`	`setRecipientSuppliesTabs(String recipientSuppliesTabs)`
`void`	`setRequireIdLookup(String requireIdLookup)`
`void`	`setRequireSignerCertificate(String requireSignerCertificate)`
`void`	`setRequireSignOnPaper(String requireSignOnPaper)`
`void`	`setRoleName(String roleName)`
`void`	`setRoutingOrder(String routingOrder)`
`void`	`setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)`
`void`	`setSentDateTime(String sentDateTime)`
`void`	`setSignatureInfo(RecipientSignatureInformation signatureInfo)`
`void`	`setSignedDateTime(String signedDateTime)`
`void`	`setSignerEmail(String signerEmail)`
`void`	`setSignerName(String signerName)`
`void`	`setSignInEachLocation(String signInEachLocation)`
`void`	`setSigningGroupId(String signingGroupId)`
`void`	`setSigningGroupName(String signingGroupName)`
`void`	`setSigningGroupUsers(List<UserInfo> signingGroupUsers)`
`void`	`setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`void`	`setSocialAuthentications(List<SocialAuthentication> socialAuthentications)`
`void`	`setStatus(String status)`
`void`	`setTabs(Tabs tabs)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setTotalTabCount(String totalTabCount)`
`void`	`setUserId(String userId)`
`String`	`toString()`

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

- Constructor Detail
  - InPersonSigner
```
public InPersonSigner()
```
- Method Detail
  - getHostName
```
public String getHostName()
```
    Specifies the name of the signing host. It is a required element for In Person Signers recipient Type. \nMaximum Length: 100 characters.
  - setHostName
```
public void setHostName(String hostName)
```
  - getHostEmail
```
public String getHostEmail()
```
  - setHostEmail
```
public void setHostEmail(String hostEmail)
```
  - getSignerName
```
public String getSignerName()
```
    Required. The full legal name of a signer for the envelope. \n\nMaximum Length: 100 characters.
  - setSignerName
```
public void setSignerName(String signerName)
```
  - getSignerEmail
```
public String getSignerEmail()
```
    The email address for an InPersonSigner recipient Type. \n\nMaximum Length: 100 characters.
  - setSignerEmail
```
public void setSignerEmail(String signerEmail)
```
  - getSignatureInfo
```
public RecipientSignatureInformation getSignatureInfo()
```
  - setSignatureInfo
```
public void setSignatureInfo(RecipientSignatureInformation signatureInfo)
```
  - getDefaultRecipient
```
public String getDefaultRecipient()
```
  - setDefaultRecipient
```
public void setDefaultRecipient(String defaultRecipient)
```
  - getOfflineAttributes
```
public OfflineAttributes getOfflineAttributes()
```
  - setOfflineAttributes
```
public void setOfflineAttributes(OfflineAttributes offlineAttributes)
```
  - getTabs
```
public Tabs getTabs()
```
  - setTabs
```
public void setTabs(Tabs tabs)
```
  - getSignInEachLocation
```
public String getSignInEachLocation()
```
    When set to **true**, specifies that the signer must sign in all locations.
  - setSignInEachLocation
```
public void setSignInEachLocation(String signInEachLocation)
```
  - getRequireSignerCertificate
```
public String getRequireSignerCertificate()
```
  - setRequireSignerCertificate
```
public void setRequireSignerCertificate(String requireSignerCertificate)
```
  - getRequireSignOnPaper
```
public String getRequireSignOnPaper()
```
  - setRequireSignOnPaper
```
public void setRequireSignOnPaper(String requireSignOnPaper)
```
  - getCanSignOffline
```
public String getCanSignOffline()
```
    When set to **true**, specifies that the signer can perform the signing ceremony offline.
  - setCanSignOffline
```
public void setCanSignOffline(String canSignOffline)
```
  - getRecipientSuppliesTabs
```
public String getRecipientSuppliesTabs()
```
  - setRecipientSuppliesTabs
```
public void setRecipientSuppliesTabs(String recipientSuppliesTabs)
```
  - getSigningGroupId
```
public String getSigningGroupId()
```
    When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
  - setSigningGroupId
```
public void setSigningGroupId(String signingGroupId)
```
  - getSigningGroupName
```
public String getSigningGroupName()
```
    The display name for the signing group. \n\nMaximum Length: 100 characters.
  - setSigningGroupName
```
public void setSigningGroupName(String signingGroupName)
```
  - getSigningGroupUsers
```
public List<UserInfo> getSigningGroupUsers()
```
    A complex type that contains information about users in the signing group.
  - setSigningGroupUsers
```
public void setSigningGroupUsers(List<UserInfo> signingGroupUsers)
```
  - 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)
```
  - getRecipientIdGuid
```
public String getRecipientIdGuid()
```
  - setRecipientIdGuid
```
public void setRecipientIdGuid(String recipientIdGuid)
```
  - getAccessCode
```
public String getAccessCode()
```
    If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and must conform to account’s access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then access code is not required.
  - setAccessCode
```
public void setAccessCode(String accessCode)
```
  - getAddAccessCodeToEmail
```
public String getAddAccessCodeToEmail()
```
    This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
  - setAddAccessCodeToEmail
```
public void setAddAccessCodeToEmail(String addAccessCodeToEmail)
```
  - getRequireIdLookup
```
public String getRequireIdLookup()
```
    When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
  - setRequireIdLookup
```
public void setRequireIdLookup(String requireIdLookup)
```
  - getIdCheckConfigurationName
```
public String getIdCheckConfigurationName()
```
    Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.\n\n*Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
  - setIdCheckConfigurationName
```
public void setIdCheckConfigurationName(String idCheckConfigurationName)
```
  - getSocialAuthentications
```
public List<SocialAuthentication> getSocialAuthentications()
```
    Lists the social ID type that can be used for recipient authentication.
  - setSocialAuthentications
```
public void setSocialAuthentications(List<SocialAuthentication> socialAuthentications)
```
  - getPhoneAuthentication
```
public RecipientPhoneAuthentication getPhoneAuthentication()
```
  - setPhoneAuthentication
```
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
  - getSamlAuthentication
```
public RecipientSAMLAuthentication getSamlAuthentication()
```
  - setSamlAuthentication
```
public void setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)
```
  - getSmsAuthentication
```
public RecipientSMSAuthentication getSmsAuthentication()
```
  - setSmsAuthentication
```
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
  - getUserId
```
public String getUserId()
```
  - setUserId
```
public void setUserId(String userId)
```
  - getClientUserId
```
public String getClientUserId()
```
    Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. \n\nMaximum length: 100 characters.
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - getEmbeddedRecipientStartURL
```
public String getEmbeddedRecipientStartURL()
```
    Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
  - setEmbeddedRecipientStartURL
```
public void setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)
```
  - getCustomFields
```
public List<String> getCustomFields()
```
    An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
  - setCustomFields
```
public void setCustomFields(List<String> customFields)
```
  - getRoutingOrder
```
public String getRoutingOrder()
```
    Specifies the routing order of the recipient in the envelope.
  - setRoutingOrder
```
public void setRoutingOrder(String routingOrder)
```
  - getIdCheckInformationInput
```
public IdCheckInformationInput getIdCheckInformationInput()
```
  - setIdCheckInformationInput
```
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
  - getRecipientAttachments
```
public List<Attachment> getRecipientAttachments()
```
    Reserved:
  - setRecipientAttachments
```
public void setRecipientAttachments(List<Attachment> recipientAttachments)
```
  - getNote
```
public String getNote()
```
    Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.\n\nMaximum Length: 1000 characters.
  - setNote
```
public void setNote(String note)
```
  - getRoleName
```
public String getRoleName()
```
    Optional element. Specifies the role name associated with the recipient.
    
    This is required when working with template recipients.
  - setRoleName
```
public void setRoleName(String roleName)
```
  - getStatus
```
public String getStatus()
```
    Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.
  - setStatus
```
public void setStatus(String status)
```
  - getSignedDateTime
```
public String getSignedDateTime()
```
    Reserved: For DocuSign use only.
  - setSignedDateTime
```
public void setSignedDateTime(String signedDateTime)
```
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
    Reserved: For DocuSign use only.
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
    The date and time the recipient declined the document.
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
  - getSentDateTime
```
public String getSentDateTime()
```
    The date and time the envelope was sent.
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
  - getDeclinedReason
```
public String getDeclinedReason()
```
    The reason the recipient declined the document.
  - setDeclinedReason
```
public void setDeclinedReason(String declinedReason)
```
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Reserved: For DocuSign use only.
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
  - getFaxNumber
```
public String getFaxNumber()
```
    Reserved:
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
  - getTemplateLocked
```
public String getTemplateLocked()
```
    When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
  - setTemplateLocked
```
public void setTemplateLocked(String templateLocked)
```
  - getTemplateRequired
```
public String getTemplateRequired()
```
    When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
  - setTemplateRequired
```
public void setTemplateRequired(String templateRequired)
```
  - getEmailNotification
```
public RecipientEmailNotification getEmailNotification()
```
  - setEmailNotification
```
public void setEmailNotification(RecipientEmailNotification emailNotification)
```
  - getInheritEmailNotificationConfiguration
```
public String getInheritEmailNotificationConfiguration()
```
    When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
  - setInheritEmailNotificationConfiguration
```
public void setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
  - getRecipientAuthenticationStatus
```
public AuthenticationStatus getRecipientAuthenticationStatus()
```
  - setRecipientAuthenticationStatus
```
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
  - getTotalTabCount
```
public String getTotalTabCount()
```
  - setTotalTabCount
```
public void setTotalTabCount(String totalTabCount)
```
  - 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 InPersonSigner

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InPersonSigner

Method Detail

getHostName

setHostName

getHostEmail

setHostEmail

getSignerName

setSignerName

getSignerEmail

setSignerEmail

getSignatureInfo

setSignatureInfo

getDefaultRecipient

setDefaultRecipient

getOfflineAttributes

setOfflineAttributes

getTabs

setTabs

getSignInEachLocation

setSignInEachLocation

getRequireSignerCertificate

setRequireSignerCertificate

getRequireSignOnPaper

setRequireSignOnPaper

getCanSignOffline

setCanSignOffline

getRecipientSuppliesTabs

setRecipientSuppliesTabs

getSigningGroupId

setSigningGroupId

getSigningGroupName

setSigningGroupName

getSigningGroupUsers

setSigningGroupUsers

getRecipientId

setRecipientId

getRecipientIdGuid

setRecipientIdGuid

getAccessCode

setAccessCode

getAddAccessCodeToEmail

setAddAccessCodeToEmail

getRequireIdLookup

setRequireIdLookup

getIdCheckConfigurationName

setIdCheckConfigurationName

getSocialAuthentications

setSocialAuthentications

getPhoneAuthentication

setPhoneAuthentication

getSamlAuthentication

setSamlAuthentication

getSmsAuthentication

setSmsAuthentication

getUserId

setUserId

getClientUserId

setClientUserId

getEmbeddedRecipientStartURL

setEmbeddedRecipientStartURL

getCustomFields

setCustomFields

getRoutingOrder

setRoutingOrder

getIdCheckInformationInput

setIdCheckInformationInput

getRecipientAttachments

setRecipientAttachments

getNote

setNote

getRoleName

setRoleName

getStatus

setStatus

getSignedDateTime