Editor (docusign-esign-java 3.10.1 API)

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

```
public class Editor
extends Object
```
Editor

Constructor Summary

Constructors
Constructor and Description

Editor()

Constructors
Constructor and Description
`Editor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Editor`	`accessCode(String accessCode)`
`Editor`	`accessCodeMetadata(PropertyMetadata accessCodeMetadata)`
`Editor`	`addAccessCodeToEmail(String addAccessCodeToEmail)`
`Editor`	`addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)`
`Editor`	`addCustomFieldsItem(String customFieldsItem)`
`Editor`	`addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)`
`Editor`	`additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)`
`Editor`	`addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)`
`Editor`	`addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)`
`Editor`	`addSigningGroupUsersItem(UserInfo signingGroupUsersItem)`
`Editor`	`addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)`
`Editor`	`allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`
`Editor`	`clientUserId(String clientUserId)`
`Editor`	`completedCount(String completedCount)`
`Editor`	`customFields(List<String> customFields)`
`Editor`	`declinedDateTime(String declinedDateTime)`
`Editor`	`declinedReason(String declinedReason)`
`Editor`	`deliveredDateTime(String deliveredDateTime)`
`Editor`	`deliveryMethod(String deliveryMethod)`
`Editor`	`deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)`
`Editor`	`designatorId(String designatorId)`
`Editor`	`designatorIdGuid(String designatorIdGuid)`
`Editor`	`documentVisibility(List<DocumentVisibility> documentVisibility)`
`Editor`	`email(String email)`
`Editor`	`emailMetadata(PropertyMetadata emailMetadata)`
`Editor`	`emailNotification(RecipientEmailNotification emailNotification)`
`Editor`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)`
`boolean`	`equals(Object o)`
`Editor`	`errorDetails(ErrorDetails errorDetails)`
`Editor`	`faxNumber(String faxNumber)`
`Editor`	`faxNumberMetadata(PropertyMetadata faxNumberMetadata)`
`Editor`	`firstName(String firstName)`
`Editor`	`firstNameMetadata(PropertyMetadata firstNameMetadata)`
`Editor`	`fullName(String fullName)`
`Editor`	`fullNameMetadata(PropertyMetadata fullNameMetadata)`
`String`	`getAccessCode()` If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
`PropertyMetadata`	`getAccessCodeMetadata()` Get accessCodeMetadata
`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.
`List<RecipientAdditionalNotification>`	`getAdditionalNotifications()`
`String`	`getAllowSystemOverrideForLockedRecipient()`
`String`	`getClientUserId()` Specifies whether the recipient is embedded or remote.
`String`	`getCompletedCount()`
`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`	`getDeliveredDateTime()` Reserved: For DocuSign use only.
`String`	`getDeliveryMethod()` Reserved: For DocuSign use only.
`PropertyMetadata`	`getDeliveryMethodMetadata()` Get deliveryMethodMetadata
`String`	`getDesignatorId()`
`String`	`getDesignatorIdGuid()`
`List<DocumentVisibility>`	`getDocumentVisibility()`
`String`	`getEmail()` Email id of the recipient.
`PropertyMetadata`	`getEmailMetadata()` Get emailMetadata
`RecipientEmailNotification`	`getEmailNotification()` Get emailNotification
`String`	`getEmbeddedRecipientStartURL()` Specifies a sender provided valid URL string for redirecting an embedded recipient.
`ErrorDetails`	`getErrorDetails()` Get errorDetails
`String`	`getFaxNumber()` Reserved:
`PropertyMetadata`	`getFaxNumberMetadata()` Get faxNumberMetadata
`String`	`getFirstName()` The user's first name.
`PropertyMetadata`	`getFirstNameMetadata()` Get firstNameMetadata
`String`	`getFullName()`
`PropertyMetadata`	`getFullNameMetadata()` Get fullNameMetadata
`String`	`getIdCheckConfigurationName()` Specifies authentication check by name.
`PropertyMetadata`	`getIdCheckConfigurationNameMetadata()` Get idCheckConfigurationNameMetadata
`IdCheckInformationInput`	`getIdCheckInformationInput()` Get idCheckInformationInput
`RecipientIdentityVerification`	`getIdentityVerification()` Get identityVerification
`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`	`getLastName()`
`PropertyMetadata`	`getLastNameMetadata()` Get lastNameMetadata
`String`	`getLockedRecipientPhoneAuthEditable()`
`String`	`getLockedRecipientSmsEditable()`
`String`	`getName()` legal name of the recipient.
`PropertyMetadata`	`getNameMetadata()` Get nameMetadata
`String`	`getNote()` Specifies a note that is unique to this recipient.
`PropertyMetadata`	`getNoteMetadata()` Get noteMetadata
`RecipientPhoneAuthentication`	`getPhoneAuthentication()` Get phoneAuthentication
`List<RecipientAttachment>`	`getRecipientAttachments()` Reserved:
`AuthenticationStatus`	`getRecipientAuthenticationStatus()` Get recipientAuthenticationStatus
`List<FeatureAvailableMetadata>`	`getRecipientFeatureMetadata()`
`String`	`getRecipientId()` Unique for the recipient.
`String`	`getRecipientIdGuid()`
`String`	`getRecipientType()`
`PropertyMetadata`	`getRecipientTypeMetadata()` Get recipientTypeMetadata
`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.
`PropertyMetadata`	`getRequireIdLookupMetadata()` Get requireIdLookupMetadata
`String`	`getRoleName()` Optional element.
`String`	`getRoutingOrder()` Specifies the routing order of the recipient in the envelope.
`PropertyMetadata`	`getRoutingOrderMetadata()` Get routingOrderMetadata
`String`	`getSentDateTime()` The date and time the envelope was sent.
`String`	`getSignedDateTime()` Reserved: For DocuSign use only.
`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).
`PropertyMetadata`	`getSigningGroupIdMetadata()` Get signingGroupIdMetadata
`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()` Get smsAuthentication
`List<SocialAuthentication>`	`getSocialAuthentications()` Lists the social ID type that can be used for recipient authentication.
`String`	`getStatus()` Indicates the envelope status.
`String`	`getStatusCode()`
`String`	`getSuppressEmails()`
`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()`
`Editor`	`idCheckConfigurationName(String idCheckConfigurationName)`
`Editor`	`idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)`
`Editor`	`idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`Editor`	`identityVerification(RecipientIdentityVerification identityVerification)`
`Editor`	`inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`
`Editor`	`lastName(String lastName)`
`Editor`	`lastNameMetadata(PropertyMetadata lastNameMetadata)`
`Editor`	`lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)`
`Editor`	`lockedRecipientSmsEditable(String lockedRecipientSmsEditable)`
`Editor`	`name(String name)`
`Editor`	`nameMetadata(PropertyMetadata nameMetadata)`
`Editor`	`note(String note)`
`Editor`	`noteMetadata(PropertyMetadata noteMetadata)`
`Editor`	`phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`Editor`	`recipientAttachments(List<RecipientAttachment> recipientAttachments)`
`Editor`	`recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`
`Editor`	`recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)`
`Editor`	`recipientId(String recipientId)`
`Editor`	`recipientIdGuid(String recipientIdGuid)`
`Editor`	`recipientType(String recipientType)`
`Editor`	`recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`
`Editor`	`requireIdLookup(String requireIdLookup)`
`Editor`	`requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`
`Editor`	`roleName(String roleName)`
`Editor`	`routingOrder(String routingOrder)`
`Editor`	`routingOrderMetadata(PropertyMetadata routingOrderMetadata)`
`Editor`	`sentDateTime(String sentDateTime)`
`void`	`setAccessCode(String accessCode)`
`void`	`setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)`
`void`	`setAddAccessCodeToEmail(String addAccessCodeToEmail)`
`void`	`setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)`
`void`	`setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setCompletedCount(String completedCount)`
`void`	`setCustomFields(List<String> customFields)`
`void`	`setDeclinedDateTime(String declinedDateTime)`
`void`	`setDeclinedReason(String declinedReason)`
`void`	`setDeliveredDateTime(String deliveredDateTime)`
`void`	`setDeliveryMethod(String deliveryMethod)`
`void`	`setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)`
`void`	`setDesignatorId(String designatorId)`
`void`	`setDesignatorIdGuid(String designatorIdGuid)`
`void`	`setDocumentVisibility(List<DocumentVisibility> documentVisibility)`
`void`	`setEmail(String email)`
`void`	`setEmailMetadata(PropertyMetadata emailMetadata)`
`void`	`setEmailNotification(RecipientEmailNotification emailNotification)`
`void`	`setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFaxNumber(String faxNumber)`
`void`	`setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)`
`void`	`setFirstName(String firstName)`
`void`	`setFirstNameMetadata(PropertyMetadata firstNameMetadata)`
`void`	`setFullName(String fullName)`
`void`	`setFullNameMetadata(PropertyMetadata fullNameMetadata)`
`void`	`setIdCheckConfigurationName(String idCheckConfigurationName)`
`void`	`setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)`
`void`	`setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`void`	`setIdentityVerification(RecipientIdentityVerification identityVerification)`
`void`	`setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`
`void`	`setLastName(String lastName)`
`void`	`setLastNameMetadata(PropertyMetadata lastNameMetadata)`
`void`	`setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)`
`void`	`setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)`
`void`	`setName(String name)`
`void`	`setNameMetadata(PropertyMetadata nameMetadata)`
`void`	`setNote(String note)`
`void`	`setNoteMetadata(PropertyMetadata noteMetadata)`
`void`	`setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`void`	`setRecipientAttachments(List<RecipientAttachment> recipientAttachments)`
`void`	`setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`
`void`	`setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRecipientIdGuid(String recipientIdGuid)`
`void`	`setRecipientType(String recipientType)`
`void`	`setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`
`void`	`setRequireIdLookup(String requireIdLookup)`
`void`	`setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`
`void`	`setRoleName(String roleName)`
`void`	`setRoutingOrder(String routingOrder)`
`void`	`setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)`
`void`	`setSentDateTime(String sentDateTime)`
`void`	`setSignedDateTime(String signedDateTime)`
`void`	`setSigningGroupId(String signingGroupId)`
`void`	`setSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)`
`void`	`setSigningGroupName(String signingGroupName)`
`void`	`setSigningGroupUsers(List<UserInfo> signingGroupUsers)`
`void`	`setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`void`	`setSocialAuthentications(List<SocialAuthentication> socialAuthentications)`
`void`	`setStatus(String status)`
`void`	`setStatusCode(String statusCode)`
`void`	`setSuppressEmails(String suppressEmails)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setTotalTabCount(String totalTabCount)`
`void`	`setUserId(String userId)`
`Editor`	`signedDateTime(String signedDateTime)`
`Editor`	`signingGroupId(String signingGroupId)`
`Editor`	`signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)`
`Editor`	`signingGroupName(String signingGroupName)`
`Editor`	`signingGroupUsers(List<UserInfo> signingGroupUsers)`
`Editor`	`smsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`Editor`	`socialAuthentications(List<SocialAuthentication> socialAuthentications)`
`Editor`	`status(String status)`
`Editor`	`statusCode(String statusCode)`
`Editor`	`suppressEmails(String suppressEmails)`
`Editor`	`templateLocked(String templateLocked)`
`Editor`	`templateRequired(String templateRequired)`
`String`	`toString()`
`Editor`	`totalTabCount(String totalTabCount)`
`Editor`	`userId(String userId)`

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

Constructor Detail
- Editor
```
public Editor()
```

Method Detail

accessCode

public Editor accessCode(String accessCode)

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)

accessCodeMetadata

public Editor accessCodeMetadata(PropertyMetadata accessCodeMetadata)

getAccessCodeMetadata
```
public PropertyMetadata getAccessCodeMetadata()
```
Get accessCodeMetadata

Returns:

accessCodeMetadata

setAccessCodeMetadata

public void setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)

addAccessCodeToEmail

public Editor addAccessCodeToEmail(String addAccessCodeToEmail)

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)

additionalNotifications

public Editor additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)

addAdditionalNotificationsItem

public Editor addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)

getAdditionalNotifications

public List<RecipientAdditionalNotification> getAdditionalNotifications()

Returns:: additionalNotifications

setAdditionalNotifications

public void setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)

allowSystemOverrideForLockedRecipient

public Editor allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)

getAllowSystemOverrideForLockedRecipient
```
public String getAllowSystemOverrideForLockedRecipient()
```
Returns:

allowSystemOverrideForLockedRecipient

setAllowSystemOverrideForLockedRecipient

public void setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)

clientUserId

public Editor clientUserId(String clientUserId)

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)

completedCount

public Editor completedCount(String completedCount)

getCompletedCount
```
public String getCompletedCount()
```
Returns:

completedCount

setCompletedCount

public void setCompletedCount(String completedCount)

customFields

public Editor customFields(List<String> customFields)

addCustomFieldsItem

public Editor addCustomFieldsItem(String customFieldsItem)

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

setCustomFields

public void setCustomFields(List<String> customFields)

declinedDateTime

public Editor declinedDateTime(String declinedDateTime)

getDeclinedDateTime
```
public String getDeclinedDateTime()
```
The date and time the recipient declined the document.

Returns:

declinedDateTime

setDeclinedDateTime

public void setDeclinedDateTime(String declinedDateTime)

declinedReason

public Editor declinedReason(String declinedReason)

getDeclinedReason
```
public String getDeclinedReason()
```
The reason the recipient declined the document.

Returns:

declinedReason

setDeclinedReason

public void setDeclinedReason(String declinedReason)

deliveredDateTime

public Editor deliveredDateTime(String deliveredDateTime)

getDeliveredDateTime
```
public String getDeliveredDateTime()
```
Reserved: For DocuSign use only.

Returns:

deliveredDateTime

setDeliveredDateTime

public void setDeliveredDateTime(String deliveredDateTime)

deliveryMethod

public Editor deliveryMethod(String deliveryMethod)

getDeliveryMethod
```
public String getDeliveryMethod()
```
Reserved: For DocuSign use only.

Returns:

deliveryMethod

setDeliveryMethod

public void setDeliveryMethod(String deliveryMethod)

deliveryMethodMetadata

public Editor deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)

getDeliveryMethodMetadata
```
public PropertyMetadata getDeliveryMethodMetadata()
```
Get deliveryMethodMetadata

Returns:

deliveryMethodMetadata

setDeliveryMethodMetadata

public void setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)

designatorId

public Editor designatorId(String designatorId)

getDesignatorId
```
public String getDesignatorId()
```
Returns:

designatorId

setDesignatorId

public void setDesignatorId(String designatorId)

designatorIdGuid

public Editor designatorIdGuid(String designatorIdGuid)

getDesignatorIdGuid
```
public String getDesignatorIdGuid()
```
Returns:

designatorIdGuid

setDesignatorIdGuid

public void setDesignatorIdGuid(String designatorIdGuid)

documentVisibility

public Editor documentVisibility(List<DocumentVisibility> documentVisibility)

addDocumentVisibilityItem

public Editor addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)

getDocumentVisibility

public List<DocumentVisibility> getDocumentVisibility()

Returns:: documentVisibility

setDocumentVisibility

public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)

email
```
public Editor email(String email)
```

getEmail
```
public String getEmail()
```
Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.

Returns:

email

setEmail
```
public void setEmail(String email)
```

emailMetadata

public Editor emailMetadata(PropertyMetadata emailMetadata)

getEmailMetadata
```
public PropertyMetadata getEmailMetadata()
```
Get emailMetadata

Returns:

emailMetadata

setEmailMetadata

public void setEmailMetadata(PropertyMetadata emailMetadata)

emailNotification

public Editor emailNotification(RecipientEmailNotification emailNotification)

getEmailNotification
```
public RecipientEmailNotification getEmailNotification()
```
Get emailNotification

Returns:

emailNotification

setEmailNotification

public void setEmailNotification(RecipientEmailNotification emailNotification)

embeddedRecipientStartURL

public Editor embeddedRecipientStartURL(String embeddedRecipientStartURL)

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)

errorDetails

public Editor errorDetails(ErrorDetails errorDetails)

getErrorDetails
```
public ErrorDetails getErrorDetails()
```
Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

faxNumber

public Editor faxNumber(String faxNumber)

getFaxNumber
```
public String getFaxNumber()
```
Reserved:

Returns:

faxNumber

setFaxNumber

public void setFaxNumber(String faxNumber)

faxNumberMetadata

public Editor faxNumberMetadata(PropertyMetadata faxNumberMetadata)

getFaxNumberMetadata
```
public PropertyMetadata getFaxNumberMetadata()
```
Get faxNumberMetadata

Returns:

faxNumberMetadata

setFaxNumberMetadata

public void setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)

firstName

public Editor firstName(String firstName)

getFirstName
```
public String getFirstName()
```
The user's first name. Maximum Length: 50 characters.

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

firstNameMetadata

public Editor firstNameMetadata(PropertyMetadata firstNameMetadata)

getFirstNameMetadata
```
public PropertyMetadata getFirstNameMetadata()
```
Get firstNameMetadata

Returns:

firstNameMetadata

setFirstNameMetadata

public void setFirstNameMetadata(PropertyMetadata firstNameMetadata)

fullName

public Editor fullName(String fullName)

getFullName
```
public String getFullName()
```
Returns:

fullName

setFullName

public void setFullName(String fullName)

fullNameMetadata

public Editor fullNameMetadata(PropertyMetadata fullNameMetadata)

getFullNameMetadata
```
public PropertyMetadata getFullNameMetadata()
```
Get fullNameMetadata

Returns:

fullNameMetadata

setFullNameMetadata

public void setFullNameMetadata(PropertyMetadata fullNameMetadata)

idCheckConfigurationName

public Editor idCheckConfigurationName(String idCheckConfigurationName)

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)

idCheckConfigurationNameMetadata

public Editor idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)

getIdCheckConfigurationNameMetadata
```
public PropertyMetadata getIdCheckConfigurationNameMetadata()
```
Get idCheckConfigurationNameMetadata

Returns:

idCheckConfigurationNameMetadata

setIdCheckConfigurationNameMetadata

public void setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)

idCheckInformationInput

public Editor idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)

getIdCheckInformationInput
```
public IdCheckInformationInput getIdCheckInformationInput()
```
Get idCheckInformationInput

Returns:

idCheckInformationInput

setIdCheckInformationInput

public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)

identityVerification

public Editor identityVerification(RecipientIdentityVerification identityVerification)

getIdentityVerification
```
public RecipientIdentityVerification getIdentityVerification()
```
Get identityVerification

Returns:

identityVerification

setIdentityVerification

public void setIdentityVerification(RecipientIdentityVerification identityVerification)

inheritEmailNotificationConfiguration

public Editor inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)

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)

lastName

public Editor lastName(String lastName)

getLastName
```
public String getLastName()
```
Returns:

lastName

setLastName

public void setLastName(String lastName)

lastNameMetadata

public Editor lastNameMetadata(PropertyMetadata lastNameMetadata)

getLastNameMetadata
```
public PropertyMetadata getLastNameMetadata()
```
Get lastNameMetadata

Returns:

lastNameMetadata

setLastNameMetadata

public void setLastNameMetadata(PropertyMetadata lastNameMetadata)

lockedRecipientPhoneAuthEditable

public Editor lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)

getLockedRecipientPhoneAuthEditable
```
public String getLockedRecipientPhoneAuthEditable()
```
Returns:

lockedRecipientPhoneAuthEditable

setLockedRecipientPhoneAuthEditable

public void setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)

lockedRecipientSmsEditable

public Editor lockedRecipientSmsEditable(String lockedRecipientSmsEditable)

getLockedRecipientSmsEditable
```
public String getLockedRecipientSmsEditable()
```
Returns:

lockedRecipientSmsEditable

setLockedRecipientSmsEditable

public void setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)

name
```
public Editor name(String name)
```

getName
```
public String getName()
```
legal name of the recipient. Maximum Length: 100 characters.

Returns:

name

setName
```
public void setName(String name)
```

nameMetadata

public Editor nameMetadata(PropertyMetadata nameMetadata)

getNameMetadata
```
public PropertyMetadata getNameMetadata()
```
Get nameMetadata

Returns:

nameMetadata

setNameMetadata

public void setNameMetadata(PropertyMetadata nameMetadata)

note
```
public Editor note(String note)
```

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)
```

noteMetadata

public Editor noteMetadata(PropertyMetadata noteMetadata)

getNoteMetadata
```
public PropertyMetadata getNoteMetadata()
```
Get noteMetadata

Returns:

noteMetadata

setNoteMetadata

public void setNoteMetadata(PropertyMetadata noteMetadata)

phoneAuthentication

public Editor phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)

getPhoneAuthentication
```
public RecipientPhoneAuthentication getPhoneAuthentication()
```
Get phoneAuthentication

Returns:

phoneAuthentication

setPhoneAuthentication

public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)

recipientAttachments

public Editor recipientAttachments(List<RecipientAttachment> recipientAttachments)

addRecipientAttachmentsItem

public Editor addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)

getRecipientAttachments

public List<RecipientAttachment> getRecipientAttachments()

Reserved:

Returns:: recipientAttachments

setRecipientAttachments

public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)

recipientAuthenticationStatus

public Editor recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)

getRecipientAuthenticationStatus
```
public AuthenticationStatus getRecipientAuthenticationStatus()
```
Get recipientAuthenticationStatus

Returns:

recipientAuthenticationStatus

setRecipientAuthenticationStatus

public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)

recipientFeatureMetadata

public Editor recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)

addRecipientFeatureMetadataItem

public Editor addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)

getRecipientFeatureMetadata

public List<FeatureAvailableMetadata> getRecipientFeatureMetadata()

Returns:: recipientFeatureMetadata

setRecipientFeatureMetadata

public void setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)

recipientId

public Editor 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)

recipientIdGuid

public Editor recipientIdGuid(String recipientIdGuid)

getRecipientIdGuid
```
public String getRecipientIdGuid()
```
Returns:

recipientIdGuid

setRecipientIdGuid

public void setRecipientIdGuid(String recipientIdGuid)

recipientType

public Editor recipientType(String recipientType)

getRecipientType
```
public String getRecipientType()
```
Returns:

recipientType

setRecipientType

public void setRecipientType(String recipientType)

recipientTypeMetadata

public Editor recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)

getRecipientTypeMetadata
```
public PropertyMetadata getRecipientTypeMetadata()
```
Get recipientTypeMetadata

Returns:

recipientTypeMetadata

setRecipientTypeMetadata

public void setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)

requireIdLookup

public Editor requireIdLookup(String requireIdLookup)

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)

requireIdLookupMetadata

public Editor requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)

getRequireIdLookupMetadata
```
public PropertyMetadata getRequireIdLookupMetadata()
```
Get requireIdLookupMetadata

Returns:

requireIdLookupMetadata

setRequireIdLookupMetadata

public void setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)

roleName

public Editor roleName(String roleName)

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)

routingOrder

public Editor routingOrder(String routingOrder)

getRoutingOrder
```
public String getRoutingOrder()
```
Specifies the routing order of the recipient in the envelope.

Returns:

routingOrder

setRoutingOrder

public void setRoutingOrder(String routingOrder)

routingOrderMetadata

public Editor routingOrderMetadata(PropertyMetadata routingOrderMetadata)

getRoutingOrderMetadata
```
public PropertyMetadata getRoutingOrderMetadata()
```
Get routingOrderMetadata

Returns:

routingOrderMetadata

setRoutingOrderMetadata

public void setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)

sentDateTime

public Editor sentDateTime(String sentDateTime)

getSentDateTime
```
public String getSentDateTime()
```
The date and time the envelope was sent.

Returns:

sentDateTime

setSentDateTime

public void setSentDateTime(String sentDateTime)

signedDateTime

public Editor signedDateTime(String signedDateTime)

getSignedDateTime
```
public String getSignedDateTime()
```
Reserved: For DocuSign use only.

Returns:

signedDateTime

setSignedDateTime

public void setSignedDateTime(String signedDateTime)

signingGroupId

public Editor signingGroupId(String signingGroupId)

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)

signingGroupIdMetadata

public Editor signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)

getSigningGroupIdMetadata
```
public PropertyMetadata getSigningGroupIdMetadata()
```
Get signingGroupIdMetadata

Returns:

signingGroupIdMetadata

setSigningGroupIdMetadata

public void setSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)

signingGroupName

public Editor signingGroupName(String signingGroupName)

getSigningGroupName
```
public String getSigningGroupName()
```
The display name for the signing group. Maximum Length: 100 characters.

Returns:

signingGroupName

setSigningGroupName

public void setSigningGroupName(String signingGroupName)

signingGroupUsers

public Editor signingGroupUsers(List<UserInfo> signingGroupUsers)

addSigningGroupUsersItem

public Editor addSigningGroupUsersItem(UserInfo signingGroupUsersItem)

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)

smsAuthentication

public Editor smsAuthentication(RecipientSMSAuthentication smsAuthentication)

getSmsAuthentication
```
public RecipientSMSAuthentication getSmsAuthentication()
```
Get smsAuthentication

Returns:

smsAuthentication

setSmsAuthentication

public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)

socialAuthentications

public Editor socialAuthentications(List<SocialAuthentication> socialAuthentications)

addSocialAuthenticationsItem

public Editor addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)

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)

status
```
public Editor status(String status)
```

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)
```

statusCode

public Editor statusCode(String statusCode)

getStatusCode
```
public String getStatusCode()
```
Returns:

statusCode

setStatusCode

public void setStatusCode(String statusCode)

suppressEmails

public Editor suppressEmails(String suppressEmails)

getSuppressEmails
```
public String getSuppressEmails()
```
Returns:

suppressEmails

setSuppressEmails

public void setSuppressEmails(String suppressEmails)

templateLocked

public Editor templateLocked(String templateLocked)

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)

templateRequired

public Editor templateRequired(String templateRequired)

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)

totalTabCount

public Editor totalTabCount(String totalTabCount)

getTotalTabCount
```
public String getTotalTabCount()
```
Returns:

totalTabCount

setTotalTabCount

public void setTotalTabCount(String totalTabCount)

userId
```
public Editor userId(String userId)
```

getUserId
```
public String getUserId()
```
Returns:

userId

setUserId
```
public void setUserId(String userId)
```

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 Editor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Editor

Method Detail

accessCode

getAccessCode

setAccessCode

accessCodeMetadata

getAccessCodeMetadata

setAccessCodeMetadata

addAccessCodeToEmail

getAddAccessCodeToEmail

setAddAccessCodeToEmail

additionalNotifications

addAdditionalNotificationsItem

getAdditionalNotifications

setAdditionalNotifications

allowSystemOverrideForLockedRecipient

getAllowSystemOverrideForLockedRecipient

setAllowSystemOverrideForLockedRecipient

clientUserId

getClientUserId

setClientUserId

completedCount

getCompletedCount

setCompletedCount

customFields

addCustomFieldsItem

getCustomFields

setCustomFields

declinedDateTime

getDeclinedDateTime

setDeclinedDateTime

declinedReason

getDeclinedReason

setDeclinedReason

deliveredDateTime

getDeliveredDateTime

setDeliveredDateTime

deliveryMethod

getDeliveryMethod

setDeliveryMethod

deliveryMethodMetadata

getDeliveryMethodMetadata

setDeliveryMethodMetadata

designatorId

getDesignatorId

setDesignatorId

designatorIdGuid

getDesignatorIdGuid

setDesignatorIdGuid

documentVisibility

addDocumentVisibilityItem

getDocumentVisibility

setDocumentVisibility

email

getEmail

setEmail

emailMetadata

getEmailMetadata

setEmailMetadata

emailNotification

getEmailNotification

setEmailNotification

embeddedRecipientStartURL

getEmbeddedRecipientStartURL

setEmbeddedRecipientStartURL

errorDetails

getErrorDetails

setErrorDetails

faxNumber

getFaxNumber

setFaxNumber

faxNumberMetadata

getFaxNumberMetadata

setFaxNumberMetadata

firstName