Package com.docusign.esign.model
Class InPersonSigner
- java.lang.Object
-
- com.docusign.esign.model.InPersonSigner
-
public class InPersonSigner extends Object
InPersonSigner.
-
-
Constructor Summary
Constructors Constructor Description InPersonSigner()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InPersonSigneraccessCode(String accessCode)accessCode.InPersonSigneraddAccessCodeToEmail(String addAccessCodeToEmail)addAccessCodeToEmail.InPersonSigneraddCustomFieldsItem(String customFieldsItem)addCustomFieldsItem.InPersonSigneraddDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)addDocumentVisibilityItem.InPersonSigneraddExcludedDocumentsItem(String excludedDocumentsItem)addExcludedDocumentsItem.InPersonSigneraddRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)addRecipientAttachmentsItem.InPersonSigneraddRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)addRecipientSignatureProvidersItem.InPersonSigneraddSigningGroupUsersItem(UserInfo signingGroupUsersItem)addSigningGroupUsersItem.InPersonSigneraddSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)addSocialAuthenticationsItem.InPersonSignerautoNavigation(String autoNavigation)autoNavigation.InPersonSignercanSignOffline(String canSignOffline)canSignOffline.InPersonSignerclientUserId(String clientUserId)clientUserId.InPersonSignercreationReason(String creationReason)creationReason.InPersonSignercustomFields(List<String> customFields)customFields.InPersonSignerdeclinedDateTime(String declinedDateTime)declinedDateTime.InPersonSignerdeclinedReason(String declinedReason)declinedReason.InPersonSignerdefaultRecipient(String defaultRecipient)defaultRecipient.InPersonSignerdeliveredDateTime(String deliveredDateTime)deliveredDateTime.InPersonSignerdeliveryMethod(String deliveryMethod)deliveryMethod.InPersonSignerdocumentVisibility(List<DocumentVisibility> documentVisibility)documentVisibility.InPersonSigneremail(String email)email.InPersonSigneremailNotification(RecipientEmailNotification emailNotification)emailNotification.InPersonSignerembeddedRecipientStartURL(String embeddedRecipientStartURL)embeddedRecipientStartURL.booleanequals(Object o)Compares objects.InPersonSignererrorDetails(ErrorDetails errorDetails)errorDetails.InPersonSignerexcludedDocuments(List<String> excludedDocuments)excludedDocuments.InPersonSignerfaxNumber(String faxNumber)faxNumber.StringgetAccessCode()If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.StringgetAddAccessCodeToEmail()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..StringgetAutoNavigation().StringgetCanSignOffline()When set to **true**, specifies that the signer can perform the signing ceremony offline..StringgetClientUserId()Specifies whether the recipient is embedded or remote.StringgetCreationReason().List<String>getCustomFields()An optional array of strings that allows the sender to provide custom data about the recipient.StringgetDeclinedDateTime()The date and time the recipient declined the document..StringgetDeclinedReason()The reason the recipient declined the document..StringgetDefaultRecipient().StringgetDeliveredDateTime()Reserved: For DocuSign use only..StringgetDeliveryMethod()Reserved: For DocuSign use only..List<DocumentVisibility>getDocumentVisibility().StringgetEmail().RecipientEmailNotificationgetEmailNotification()Get emailNotification.StringgetEmbeddedRecipientStartURL()Specifies a sender provided valid URL string for redirecting an embedded recipient.ErrorDetailsgetErrorDetails()Get errorDetails.List<String>getExcludedDocuments()Specifies the documents that are not visible to this recipient.StringgetFaxNumber()Reserved:.StringgetHostEmail().StringgetHostName()Specifies the name of the signing host.StringgetIdCheckConfigurationName()Specifies authentication check by name.IdCheckInformationInputgetIdCheckInformationInput()Get idCheckInformationInput.RecipientIdentityVerificationgetIdentityVerification()Get identityVerification.StringgetInheritEmailNotificationConfiguration()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.StringgetInPersonSigningType().StringgetName().NotaryHostgetNotaryHost()Get notaryHost.StringgetNote()Specifies a note that is unique to this recipient.OfflineAttributesgetOfflineAttributes()Get offlineAttributes.RecipientPhoneAuthenticationgetPhoneAuthentication()Get phoneAuthentication.List<RecipientAttachment>getRecipientAttachments()Reserved:.AuthenticationStatusgetRecipientAuthenticationStatus()Get recipientAuthenticationStatus.StringgetRecipientId()Unique for the recipient.StringgetRecipientIdGuid().List<RecipientSignatureProvider>getRecipientSignatureProviders().StringgetRecipientSuppliesTabs().StringgetRequireIdLookup()When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.StringgetRequireSignerCertificate().StringgetRequireSignOnPaper().StringgetRoleName()Optional element.StringgetRoutingOrder()Specifies the routing order of the recipient in the envelope.RecipientSAMLAuthenticationgetSamlAuthentication()Get samlAuthentication.StringgetSentDateTime()The date and time the envelope was sent..RecipientSignatureInformationgetSignatureInfo()Get signatureInfo.StringgetSignedDateTime()Reserved: For DocuSign use only.StringgetSignerEmail()The email address for an InPersonSigner recipient Type.StringgetSignerName()Required.StringgetSignInEachLocation()When set to **true**, specifies that the signer must sign in all locations..StringgetSigningGroupId()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)..StringgetSigningGroupName()The display name for the signing group.List<UserInfo>getSigningGroupUsers()A complex type that contains information about users in the signing group..RecipientSMSAuthenticationgetSmsAuthentication()Get smsAuthentication.List<SocialAuthentication>getSocialAuthentications()Lists the social ID type that can be used for recipient authentication..StringgetStatus()Indicates the envelope status.TabsgetTabs()Get tabs.StringgetTemplateLocked()When set to **true**, the sender cannot change any attributes of the recipient.StringgetTemplateRequired()When set to **true**, the sender may not remove the recipient.StringgetTotalTabCount().StringgetUserId().inthashCode()Returns the HashCode.InPersonSignerhostEmail(String hostEmail)hostEmail.InPersonSignerhostName(String hostName)hostName.InPersonSigneridCheckConfigurationName(String idCheckConfigurationName)idCheckConfigurationName.InPersonSigneridCheckInformationInput(IdCheckInformationInput idCheckInformationInput)idCheckInformationInput.InPersonSigneridentityVerification(RecipientIdentityVerification identityVerification)identityVerification.InPersonSignerinheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)inheritEmailNotificationConfiguration.InPersonSignerinPersonSigningType(String inPersonSigningType)inPersonSigningType.InPersonSignername(String name)name.InPersonSignernotaryHost(NotaryHost notaryHost)notaryHost.InPersonSignernote(String note)note.InPersonSignerofflineAttributes(OfflineAttributes offlineAttributes)offlineAttributes.InPersonSignerphoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)phoneAuthentication.InPersonSignerrecipientAttachments(List<RecipientAttachment> recipientAttachments)recipientAttachments.InPersonSignerrecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)recipientAuthenticationStatus.InPersonSignerrecipientId(String recipientId)recipientId.InPersonSignerrecipientIdGuid(String recipientIdGuid)recipientIdGuid.InPersonSignerrecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)recipientSignatureProviders.InPersonSignerrecipientSuppliesTabs(String recipientSuppliesTabs)recipientSuppliesTabs.InPersonSignerrequireIdLookup(String requireIdLookup)requireIdLookup.InPersonSignerrequireSignerCertificate(String requireSignerCertificate)requireSignerCertificate.InPersonSignerrequireSignOnPaper(String requireSignOnPaper)requireSignOnPaper.InPersonSignerroleName(String roleName)roleName.InPersonSignerroutingOrder(String routingOrder)routingOrder.InPersonSignersamlAuthentication(RecipientSAMLAuthentication samlAuthentication)samlAuthentication.InPersonSignersentDateTime(String sentDateTime)sentDateTime.voidsetAccessCode(String accessCode)setAccessCode.voidsetAddAccessCodeToEmail(String addAccessCodeToEmail)setAddAccessCodeToEmail.voidsetAutoNavigation(String autoNavigation)setAutoNavigation.voidsetCanSignOffline(String canSignOffline)setCanSignOffline.voidsetClientUserId(String clientUserId)setClientUserId.voidsetCreationReason(String creationReason)setCreationReason.voidsetCustomFields(List<String> customFields)setCustomFields.voidsetDeclinedDateTime(String declinedDateTime)setDeclinedDateTime.voidsetDeclinedReason(String declinedReason)setDeclinedReason.voidsetDefaultRecipient(String defaultRecipient)setDefaultRecipient.voidsetDeliveredDateTime(String deliveredDateTime)setDeliveredDateTime.voidsetDeliveryMethod(String deliveryMethod)setDeliveryMethod.voidsetDocumentVisibility(List<DocumentVisibility> documentVisibility)setDocumentVisibility.voidsetEmail(String email)setEmail.voidsetEmailNotification(RecipientEmailNotification emailNotification)setEmailNotification.voidsetEmbeddedRecipientStartURL(String embeddedRecipientStartURL)setEmbeddedRecipientStartURL.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetExcludedDocuments(List<String> excludedDocuments)setExcludedDocuments.voidsetFaxNumber(String faxNumber)setFaxNumber.voidsetHostEmail(String hostEmail)setHostEmail.voidsetHostName(String hostName)setHostName.voidsetIdCheckConfigurationName(String idCheckConfigurationName)setIdCheckConfigurationName.voidsetIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)setIdCheckInformationInput.voidsetIdentityVerification(RecipientIdentityVerification identityVerification)setIdentityVerification.voidsetInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)setInheritEmailNotificationConfiguration.voidsetInPersonSigningType(String inPersonSigningType)setInPersonSigningType.voidsetName(String name)setName.voidsetNotaryHost(NotaryHost notaryHost)setNotaryHost.voidsetNote(String note)setNote.voidsetOfflineAttributes(OfflineAttributes offlineAttributes)setOfflineAttributes.voidsetPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)setPhoneAuthentication.voidsetRecipientAttachments(List<RecipientAttachment> recipientAttachments)setRecipientAttachments.voidsetRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)setRecipientAuthenticationStatus.voidsetRecipientId(String recipientId)setRecipientId.voidsetRecipientIdGuid(String recipientIdGuid)setRecipientIdGuid.voidsetRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)setRecipientSignatureProviders.voidsetRecipientSuppliesTabs(String recipientSuppliesTabs)setRecipientSuppliesTabs.voidsetRequireIdLookup(String requireIdLookup)setRequireIdLookup.voidsetRequireSignerCertificate(String requireSignerCertificate)setRequireSignerCertificate.voidsetRequireSignOnPaper(String requireSignOnPaper)setRequireSignOnPaper.voidsetRoleName(String roleName)setRoleName.voidsetRoutingOrder(String routingOrder)setRoutingOrder.voidsetSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)setSamlAuthentication.voidsetSentDateTime(String sentDateTime)setSentDateTime.voidsetSignatureInfo(RecipientSignatureInformation signatureInfo)setSignatureInfo.voidsetSignedDateTime(String signedDateTime)setSignedDateTime.voidsetSignerEmail(String signerEmail)setSignerEmail.voidsetSignerName(String signerName)setSignerName.voidsetSignInEachLocation(String signInEachLocation)setSignInEachLocation.voidsetSigningGroupId(String signingGroupId)setSigningGroupId.voidsetSigningGroupName(String signingGroupName)setSigningGroupName.voidsetSigningGroupUsers(List<UserInfo> signingGroupUsers)setSigningGroupUsers.voidsetSmsAuthentication(RecipientSMSAuthentication smsAuthentication)setSmsAuthentication.voidsetSocialAuthentications(List<SocialAuthentication> socialAuthentications)setSocialAuthentications.voidsetStatus(String status)setStatus.voidsetTabs(Tabs tabs)setTabs.voidsetTemplateLocked(String templateLocked)setTemplateLocked.voidsetTemplateRequired(String templateRequired)setTemplateRequired.voidsetTotalTabCount(String totalTabCount)setTotalTabCount.voidsetUserId(String userId)setUserId.InPersonSignersignatureInfo(RecipientSignatureInformation signatureInfo)signatureInfo.InPersonSignersignedDateTime(String signedDateTime)signedDateTime.InPersonSignersignerEmail(String signerEmail)signerEmail.InPersonSignersignerName(String signerName)signerName.InPersonSignersignInEachLocation(String signInEachLocation)signInEachLocation.InPersonSignersigningGroupId(String signingGroupId)signingGroupId.InPersonSignersigningGroupName(String signingGroupName)signingGroupName.InPersonSignersigningGroupUsers(List<UserInfo> signingGroupUsers)signingGroupUsers.InPersonSignersmsAuthentication(RecipientSMSAuthentication smsAuthentication)smsAuthentication.InPersonSignersocialAuthentications(List<SocialAuthentication> socialAuthentications)socialAuthentications.InPersonSignerstatus(String status)status.InPersonSignertabs(Tabs tabs)tabs.InPersonSignertemplateLocked(String templateLocked)templateLocked.InPersonSignertemplateRequired(String templateRequired)templateRequired.StringtoString()Converts the given object to string.InPersonSignertotalTabCount(String totalTabCount)totalTabCount.InPersonSigneruserId(String userId)userId.
-
-
-
Method Detail
-
accessCode
public InPersonSigner accessCode(String accessCode)
accessCode.- Returns:
- InPersonSigner
-
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. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required..- Returns:
- accessCode
-
setAccessCode
public void setAccessCode(String accessCode)
setAccessCode.
-
addAccessCodeToEmail
public InPersonSigner addAccessCodeToEmail(String addAccessCodeToEmail)
addAccessCodeToEmail.- Returns:
- InPersonSigner
-
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..- Returns:
- addAccessCodeToEmail
-
setAddAccessCodeToEmail
public void setAddAccessCodeToEmail(String addAccessCodeToEmail)
setAddAccessCodeToEmail.
-
autoNavigation
public InPersonSigner autoNavigation(String autoNavigation)
autoNavigation.- Returns:
- InPersonSigner
-
getAutoNavigation
public String getAutoNavigation()
.- Returns:
- autoNavigation
-
setAutoNavigation
public void setAutoNavigation(String autoNavigation)
setAutoNavigation.
-
canSignOffline
public InPersonSigner canSignOffline(String canSignOffline)
canSignOffline.- Returns:
- InPersonSigner
-
getCanSignOffline
public String getCanSignOffline()
When set to **true**, specifies that the signer can perform the signing ceremony offline..- Returns:
- canSignOffline
-
setCanSignOffline
public void setCanSignOffline(String canSignOffline)
setCanSignOffline.
-
clientUserId
public InPersonSigner clientUserId(String clientUserId)
clientUserId.- Returns:
- InPersonSigner
-
getClientUserId
public String getClientUserId()
Specifies whether the recipient is embedded or remote. If 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. Maximum length: 100 characters. .- Returns:
- clientUserId
-
setClientUserId
public void setClientUserId(String clientUserId)
setClientUserId.
-
creationReason
public InPersonSigner creationReason(String creationReason)
creationReason.- Returns:
- InPersonSigner
-
getCreationReason
public String getCreationReason()
.- Returns:
- creationReason
-
setCreationReason
public void setCreationReason(String creationReason)
setCreationReason.
-
customFields
public InPersonSigner customFields(List<String> customFields)
customFields.- Returns:
- InPersonSigner
-
addCustomFieldsItem
public InPersonSigner addCustomFieldsItem(String customFieldsItem)
addCustomFieldsItem.- Returns:
- InPersonSigner
-
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..- Returns:
- customFields
-
declinedDateTime
public InPersonSigner declinedDateTime(String declinedDateTime)
declinedDateTime.- Returns:
- InPersonSigner
-
getDeclinedDateTime
public String getDeclinedDateTime()
The date and time the recipient declined the document..- Returns:
- declinedDateTime
-
setDeclinedDateTime
public void setDeclinedDateTime(String declinedDateTime)
setDeclinedDateTime.
-
declinedReason
public InPersonSigner declinedReason(String declinedReason)
declinedReason.- Returns:
- InPersonSigner
-
getDeclinedReason
public String getDeclinedReason()
The reason the recipient declined the document..- Returns:
- declinedReason
-
setDeclinedReason
public void setDeclinedReason(String declinedReason)
setDeclinedReason.
-
defaultRecipient
public InPersonSigner defaultRecipient(String defaultRecipient)
defaultRecipient.- Returns:
- InPersonSigner
-
getDefaultRecipient
public String getDefaultRecipient()
.- Returns:
- defaultRecipient
-
setDefaultRecipient
public void setDefaultRecipient(String defaultRecipient)
setDefaultRecipient.
-
deliveredDateTime
public InPersonSigner deliveredDateTime(String deliveredDateTime)
deliveredDateTime.- Returns:
- InPersonSigner
-
getDeliveredDateTime
public String getDeliveredDateTime()
Reserved: For DocuSign use only..- Returns:
- deliveredDateTime
-
setDeliveredDateTime
public void setDeliveredDateTime(String deliveredDateTime)
setDeliveredDateTime.
-
deliveryMethod
public InPersonSigner deliveryMethod(String deliveryMethod)
deliveryMethod.- Returns:
- InPersonSigner
-
getDeliveryMethod
public String getDeliveryMethod()
Reserved: For DocuSign use only..- Returns:
- deliveryMethod
-
setDeliveryMethod
public void setDeliveryMethod(String deliveryMethod)
setDeliveryMethod.
-
documentVisibility
public InPersonSigner documentVisibility(List<DocumentVisibility> documentVisibility)
documentVisibility.- Returns:
- InPersonSigner
-
addDocumentVisibilityItem
public InPersonSigner addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
addDocumentVisibilityItem.- Returns:
- InPersonSigner
-
getDocumentVisibility
public List<DocumentVisibility> getDocumentVisibility()
.- Returns:
- documentVisibility
-
setDocumentVisibility
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
setDocumentVisibility.
-
email
public InPersonSigner email(String email)
email.- Returns:
- InPersonSigner
-
getEmail
public String getEmail()
.- Returns:
-
setEmail
public void setEmail(String email)
setEmail.
-
emailNotification
public InPersonSigner emailNotification(RecipientEmailNotification emailNotification)
emailNotification.- Returns:
- InPersonSigner
-
getEmailNotification
public RecipientEmailNotification getEmailNotification()
Get emailNotification.- Returns:
- emailNotification
-
setEmailNotification
public void setEmailNotification(RecipientEmailNotification emailNotification)
setEmailNotification.
-
embeddedRecipientStartURL
public InPersonSigner embeddedRecipientStartURL(String embeddedRecipientStartURL)
embeddedRecipientStartURL.- Returns:
- InPersonSigner
-
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. If 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. It 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. If 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. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` .- Returns:
- embeddedRecipientStartURL
-
setEmbeddedRecipientStartURL
public void setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)
setEmbeddedRecipientStartURL.
-
errorDetails
public InPersonSigner errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- InPersonSigner
-
getErrorDetails
public ErrorDetails getErrorDetails()
Get errorDetails.- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
excludedDocuments
public InPersonSigner excludedDocuments(List<String> excludedDocuments)
excludedDocuments.- Returns:
- InPersonSigner
-
addExcludedDocumentsItem
public InPersonSigner addExcludedDocumentsItem(String excludedDocumentsItem)
addExcludedDocumentsItem.- Returns:
- InPersonSigner
-
getExcludedDocuments
public List<String> getExcludedDocuments()
Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent..- Returns:
- excludedDocuments
-
setExcludedDocuments
public void setExcludedDocuments(List<String> excludedDocuments)
setExcludedDocuments.
-
faxNumber
public InPersonSigner faxNumber(String faxNumber)
faxNumber.- Returns:
- InPersonSigner
-
getFaxNumber
public String getFaxNumber()
Reserved:.- Returns:
- faxNumber
-
setFaxNumber
public void setFaxNumber(String faxNumber)
setFaxNumber.
-
hostEmail
public InPersonSigner hostEmail(String hostEmail)
hostEmail.- Returns:
- InPersonSigner
-
getHostEmail
public String getHostEmail()
.- Returns:
- hostEmail
-
setHostEmail
public void setHostEmail(String hostEmail)
setHostEmail.
-
hostName
public InPersonSigner hostName(String hostName)
hostName.- Returns:
- InPersonSigner
-
getHostName
public String getHostName()
Specifies the name of the signing host. It is a required element for In Person Signers recipient Type. Maximum Length: 100 characters..- Returns:
- hostName
-
setHostName
public void setHostName(String hostName)
setHostName.
-
idCheckConfigurationName
public InPersonSigner idCheckConfigurationName(String idCheckConfigurationName)
idCheckConfigurationName.- Returns:
- InPersonSigner
-
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. *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..- Returns:
- idCheckConfigurationName
-
setIdCheckConfigurationName
public void setIdCheckConfigurationName(String idCheckConfigurationName)
setIdCheckConfigurationName.
-
idCheckInformationInput
public InPersonSigner idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
idCheckInformationInput.- Returns:
- InPersonSigner
-
getIdCheckInformationInput
public IdCheckInformationInput getIdCheckInformationInput()
Get idCheckInformationInput.- Returns:
- idCheckInformationInput
-
setIdCheckInformationInput
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
setIdCheckInformationInput.
-
identityVerification
public InPersonSigner identityVerification(RecipientIdentityVerification identityVerification)
identityVerification.- Returns:
- InPersonSigner
-
getIdentityVerification
public RecipientIdentityVerification getIdentityVerification()
Get identityVerification.- Returns:
- identityVerification
-
setIdentityVerification
public void setIdentityVerification(RecipientIdentityVerification identityVerification)
setIdentityVerification.
-
inheritEmailNotificationConfiguration
public InPersonSigner inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
inheritEmailNotificationConfiguration.- Returns:
- InPersonSigner
-
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. .- Returns:
- inheritEmailNotificationConfiguration
-
setInheritEmailNotificationConfiguration
public void setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
setInheritEmailNotificationConfiguration.
-
inPersonSigningType
public InPersonSigner inPersonSigningType(String inPersonSigningType)
inPersonSigningType.- Returns:
- InPersonSigner
-
getInPersonSigningType
public String getInPersonSigningType()
.- Returns:
- inPersonSigningType
-
setInPersonSigningType
public void setInPersonSigningType(String inPersonSigningType)
setInPersonSigningType.
-
name
public InPersonSigner name(String name)
name.- Returns:
- InPersonSigner
-
getName
public String getName()
.- Returns:
- name
-
setName
public void setName(String name)
setName.
-
notaryHost
public InPersonSigner notaryHost(NotaryHost notaryHost)
notaryHost.- Returns:
- InPersonSigner
-
getNotaryHost
public NotaryHost getNotaryHost()
Get notaryHost.- Returns:
- notaryHost
-
setNotaryHost
public void setNotaryHost(NotaryHost notaryHost)
setNotaryHost.
-
note
public InPersonSigner note(String note)
note.- Returns:
- InPersonSigner
-
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. Maximum Length: 1000 characters..- Returns:
- note
-
setNote
public void setNote(String note)
setNote.
-
offlineAttributes
public InPersonSigner offlineAttributes(OfflineAttributes offlineAttributes)
offlineAttributes.- Returns:
- InPersonSigner
-
getOfflineAttributes
public OfflineAttributes getOfflineAttributes()
Get offlineAttributes.- Returns:
- offlineAttributes
-
setOfflineAttributes
public void setOfflineAttributes(OfflineAttributes offlineAttributes)
setOfflineAttributes.
-
phoneAuthentication
public InPersonSigner phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
phoneAuthentication.- Returns:
- InPersonSigner
-
getPhoneAuthentication
public RecipientPhoneAuthentication getPhoneAuthentication()
Get phoneAuthentication.- Returns:
- phoneAuthentication
-
setPhoneAuthentication
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
setPhoneAuthentication.
-
recipientAttachments
public InPersonSigner recipientAttachments(List<RecipientAttachment> recipientAttachments)
recipientAttachments.- Returns:
- InPersonSigner
-
addRecipientAttachmentsItem
public InPersonSigner addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
addRecipientAttachmentsItem.- Returns:
- InPersonSigner
-
getRecipientAttachments
public List<RecipientAttachment> getRecipientAttachments()
Reserved:.- Returns:
- recipientAttachments
-
setRecipientAttachments
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
setRecipientAttachments.
-
recipientAuthenticationStatus
public InPersonSigner recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
recipientAuthenticationStatus.- Returns:
- InPersonSigner
-
getRecipientAuthenticationStatus
public AuthenticationStatus getRecipientAuthenticationStatus()
Get recipientAuthenticationStatus.- Returns:
- recipientAuthenticationStatus
-
setRecipientAuthenticationStatus
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
setRecipientAuthenticationStatus.
-
recipientId
public InPersonSigner recipientId(String recipientId)
recipientId.- Returns:
- InPersonSigner
-
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.
-
recipientIdGuid
public InPersonSigner recipientIdGuid(String recipientIdGuid)
recipientIdGuid.- Returns:
- InPersonSigner
-
getRecipientIdGuid
public String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.
-
recipientSignatureProviders
public InPersonSigner recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
recipientSignatureProviders.- Returns:
- InPersonSigner
-
addRecipientSignatureProvidersItem
public InPersonSigner addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
addRecipientSignatureProvidersItem.- Returns:
- InPersonSigner
-
getRecipientSignatureProviders
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
.- Returns:
- recipientSignatureProviders
-
setRecipientSignatureProviders
public void setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
setRecipientSignatureProviders.
-
recipientSuppliesTabs
public InPersonSigner recipientSuppliesTabs(String recipientSuppliesTabs)
recipientSuppliesTabs.- Returns:
- InPersonSigner
-
getRecipientSuppliesTabs
public String getRecipientSuppliesTabs()
.- Returns:
- recipientSuppliesTabs
-
setRecipientSuppliesTabs
public void setRecipientSuppliesTabs(String recipientSuppliesTabs)
setRecipientSuppliesTabs.
-
requireIdLookup
public InPersonSigner requireIdLookup(String requireIdLookup)
requireIdLookup.- Returns:
- InPersonSigner
-
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. .- Returns:
- requireIdLookup
-
setRequireIdLookup
public void setRequireIdLookup(String requireIdLookup)
setRequireIdLookup.
-
requireSignerCertificate
public InPersonSigner requireSignerCertificate(String requireSignerCertificate)
requireSignerCertificate.- Returns:
- InPersonSigner
-
getRequireSignerCertificate
public String getRequireSignerCertificate()
.- Returns:
- requireSignerCertificate
-
setRequireSignerCertificate
public void setRequireSignerCertificate(String requireSignerCertificate)
setRequireSignerCertificate.
-
requireSignOnPaper
public InPersonSigner requireSignOnPaper(String requireSignOnPaper)
requireSignOnPaper.- Returns:
- InPersonSigner
-
getRequireSignOnPaper
public String getRequireSignOnPaper()
.- Returns:
- requireSignOnPaper
-
setRequireSignOnPaper
public void setRequireSignOnPaper(String requireSignOnPaper)
setRequireSignOnPaper.
-
roleName
public InPersonSigner roleName(String roleName)
roleName.- Returns:
- InPersonSigner
-
getRoleName
public String getRoleName()
Optional element. Specifies the role name associated with the recipient.
This is required when working with template recipients..- Returns:
- roleName
-
setRoleName
public void setRoleName(String roleName)
setRoleName.
-
routingOrder
public InPersonSigner routingOrder(String routingOrder)
routingOrder.- Returns:
- InPersonSigner
-
getRoutingOrder
public String getRoutingOrder()
Specifies the routing order of the recipient in the envelope. .- Returns:
- routingOrder
-
setRoutingOrder
public void setRoutingOrder(String routingOrder)
setRoutingOrder.
-
samlAuthentication
public InPersonSigner samlAuthentication(RecipientSAMLAuthentication samlAuthentication)
samlAuthentication.- Returns:
- InPersonSigner
-
getSamlAuthentication
public RecipientSAMLAuthentication getSamlAuthentication()
Get samlAuthentication.- Returns:
- samlAuthentication
-
setSamlAuthentication
public void setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)
setSamlAuthentication.
-
sentDateTime
public InPersonSigner sentDateTime(String sentDateTime)
sentDateTime.- Returns:
- InPersonSigner
-
getSentDateTime
public String getSentDateTime()
The date and time the envelope was sent..- Returns:
- sentDateTime
-
setSentDateTime
public void setSentDateTime(String sentDateTime)
setSentDateTime.
-
signatureInfo
public InPersonSigner signatureInfo(RecipientSignatureInformation signatureInfo)
signatureInfo.- Returns:
- InPersonSigner
-
getSignatureInfo
public RecipientSignatureInformation getSignatureInfo()
Get signatureInfo.- Returns:
- signatureInfo
-
setSignatureInfo
public void setSignatureInfo(RecipientSignatureInformation signatureInfo)
setSignatureInfo.
-
signedDateTime
public InPersonSigner signedDateTime(String signedDateTime)
signedDateTime.- Returns:
- InPersonSigner
-
getSignedDateTime
public String getSignedDateTime()
Reserved: For DocuSign use only. .- Returns:
- signedDateTime
-
setSignedDateTime
public void setSignedDateTime(String signedDateTime)
setSignedDateTime.
-
signerEmail
public InPersonSigner signerEmail(String signerEmail)
signerEmail.- Returns:
- InPersonSigner
-
getSignerEmail
public String getSignerEmail()
The email address for an InPersonSigner recipient Type. Maximum Length: 100 characters. .- Returns:
- signerEmail
-
setSignerEmail
public void setSignerEmail(String signerEmail)
setSignerEmail.
-
signerName
public InPersonSigner signerName(String signerName)
signerName.- Returns:
- InPersonSigner
-
getSignerName
public String getSignerName()
Required. The full legal name of a signer for the envelope. Maximum Length: 100 characters. .- Returns:
- signerName
-
setSignerName
public void setSignerName(String signerName)
setSignerName.
-
signInEachLocation
public InPersonSigner signInEachLocation(String signInEachLocation)
signInEachLocation.- Returns:
- InPersonSigner
-
getSignInEachLocation
public String getSignInEachLocation()
When set to **true**, specifies that the signer must sign in all locations..- Returns:
- signInEachLocation
-
setSignInEachLocation
public void setSignInEachLocation(String signInEachLocation)
setSignInEachLocation.
-
signingGroupId
public InPersonSigner signingGroupId(String signingGroupId)
signingGroupId.- Returns:
- InPersonSigner
-
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)..- Returns:
- signingGroupId
-
setSigningGroupId
public void setSigningGroupId(String signingGroupId)
setSigningGroupId.
-
signingGroupName
public InPersonSigner signingGroupName(String signingGroupName)
signingGroupName.- Returns:
- InPersonSigner
-
getSigningGroupName
public String getSigningGroupName()
The display name for the signing group. Maximum Length: 100 characters. .- Returns:
- signingGroupName
-
setSigningGroupName
public void setSigningGroupName(String signingGroupName)
setSigningGroupName.
-
signingGroupUsers
public InPersonSigner signingGroupUsers(List<UserInfo> signingGroupUsers)
signingGroupUsers.- Returns:
- InPersonSigner
-
addSigningGroupUsersItem
public InPersonSigner addSigningGroupUsersItem(UserInfo signingGroupUsersItem)
addSigningGroupUsersItem.- Returns:
- InPersonSigner
-
getSigningGroupUsers
public List<UserInfo> getSigningGroupUsers()
A complex type that contains information about users in the signing group..- Returns:
- signingGroupUsers
-
setSigningGroupUsers
public void setSigningGroupUsers(List<UserInfo> signingGroupUsers)
setSigningGroupUsers.
-
smsAuthentication
public InPersonSigner smsAuthentication(RecipientSMSAuthentication smsAuthentication)
smsAuthentication.- Returns:
- InPersonSigner
-
getSmsAuthentication
public RecipientSMSAuthentication getSmsAuthentication()
Get smsAuthentication.- Returns:
- smsAuthentication
-
setSmsAuthentication
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
setSmsAuthentication.
-
socialAuthentications
public InPersonSigner socialAuthentications(List<SocialAuthentication> socialAuthentications)
socialAuthentications.- Returns:
- InPersonSigner
-
addSocialAuthenticationsItem
public InPersonSigner addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
addSocialAuthenticationsItem.- Returns:
- InPersonSigner
-
getSocialAuthentications
public List<SocialAuthentication> getSocialAuthentications()
Lists the social ID type that can be used for recipient authentication..- Returns:
- socialAuthentications
-
setSocialAuthentications
public void setSocialAuthentications(List<SocialAuthentication> socialAuthentications)
setSocialAuthentications.
-
status
public InPersonSigner status(String status)
status.- Returns:
- InPersonSigner
-
getStatus
public String getStatus()
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..- Returns:
- status
-
setStatus
public void setStatus(String status)
setStatus.
-
tabs
public InPersonSigner tabs(Tabs tabs)
tabs.- Returns:
- InPersonSigner
-
getTabs
public Tabs getTabs()
Get tabs.- Returns:
- tabs
-
setTabs
public void setTabs(Tabs tabs)
setTabs.
-
templateLocked
public InPersonSigner templateLocked(String templateLocked)
templateLocked.- Returns:
- InPersonSigner
-
getTemplateLocked
public String getTemplateLocked()
When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .- Returns:
- templateLocked
-
setTemplateLocked
public void setTemplateLocked(String templateLocked)
setTemplateLocked.
-
templateRequired
public InPersonSigner templateRequired(String templateRequired)
templateRequired.- Returns:
- InPersonSigner
-
getTemplateRequired
public String getTemplateRequired()
When set to **true**, the sender may not remove the recipient. Used only when working with template recipients..- Returns:
- templateRequired
-
setTemplateRequired
public void setTemplateRequired(String templateRequired)
setTemplateRequired.
-
totalTabCount
public InPersonSigner totalTabCount(String totalTabCount)
totalTabCount.- Returns:
- InPersonSigner
-
getTotalTabCount
public String getTotalTabCount()
.- Returns:
- totalTabCount
-
setTotalTabCount
public void setTotalTabCount(String totalTabCount)
setTotalTabCount.
-
userId
public InPersonSigner userId(String userId)
userId.- Returns:
- InPersonSigner
-
getUserId
public String getUserId()
.- Returns:
- userId
-
setUserId
public void setUserId(String userId)
setUserId.
-
equals
public boolean equals(Object o)
Compares objects.
-
-