| Package | Description |
|---|---|
| com.docusign.esign.model |
| Modifier and Type | Method and Description |
|---|---|
Editor |
Editor.accessCode(String accessCode)
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
|
Editor |
Editor.addAccessCodeToEmail(String addAccessCodeToEmail)
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.
|
Editor |
Editor.clientUserId(String clientUserId)
Specifies whether the recipient is embedded or remote.
|
Editor |
Editor.customFields(List<String> customFields)
An optional array of strings that allows the sender to provide custom data about the recipient.
|
Editor |
Editor.declinedDateTime(String declinedDateTime)
The date and time the recipient declined the document.
|
Editor |
Editor.declinedReason(String declinedReason)
The reason the recipient declined the document.
|
Editor |
Editor.deliveredDateTime(String deliveredDateTime)
Reserved: For DocuSign use only.
|
Editor |
Editor.deliveryMethod(String deliveryMethod)
Reserved: For DocuSign use only.
|
Editor |
Editor.email(String email)
Email id of the recipient.
|
Editor |
Editor.emailNotification(RecipientEmailNotification emailNotification) |
Editor |
Editor.emailRecipientPostSigningURL(String emailRecipientPostSigningURL) |
Editor |
Editor.embeddedRecipientStartURL(String embeddedRecipientStartURL)
Specifies a sender provided valid URL string for redirecting an embedded recipient.
|
Editor |
Editor.errorDetails(ErrorDetails errorDetails) |
Editor |
Editor.faxNumber(String faxNumber)
Reserved:
|
Editor |
Editor.idCheckConfigurationName(String idCheckConfigurationName)
Specifies authentication check by name.
|
Editor |
Editor.idCheckInformationInput(IdCheckInformationInput idCheckInformationInput) |
Editor |
Editor.inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
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.
|
Editor |
Editor.name(String name)
legal name of the recipient.\n\nMaximum Length: 100 characters.
|
Editor |
Editor.note(String note)
Specifies a note that is unique to this recipient.
|
Editor |
Editor.phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication) |
Editor |
Editor.recipientAttachments(List<Attachment> recipientAttachments)
Reserved:
|
Editor |
Editor.recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus) |
Editor |
Editor.recipientId(String recipientId)
Unique for the recipient.
|
Editor |
Editor.recipientIdGuid(String recipientIdGuid) |
Editor |
Editor.requireIdLookup(String requireIdLookup)
When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
Editor |
Editor.roleName(String roleName)
Optional element.
|
Editor |
Editor.routingOrder(String routingOrder)
Specifies the routing order of the recipient in the envelope.
|
Editor |
Editor.samlAuthentication(RecipientSAMLAuthentication samlAuthentication) |
Editor |
Editor.sentDateTime(String sentDateTime)
The date and time the envelope was sent.
|
Editor |
Editor.signedDateTime(String signedDateTime)
Reserved: For DocuSign use only.
|
Editor |
Editor.signingGroupId(String signingGroupId)
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).
|
Editor |
Editor.signingGroupName(String signingGroupName)
The display name for the signing group.
|
Editor |
Editor.signingGroupUsers(List<UserInfo> signingGroupUsers)
A complex type that contains information about users in the signing group.
|
Editor |
Editor.smsAuthentication(RecipientSMSAuthentication smsAuthentication) |
Editor |
Editor.socialAuthentications(List<SocialAuthentication> socialAuthentications)
Lists the social ID type that can be used for recipient authentication.
|
Editor |
Editor.status(String status)
Indicates the envelope status.
|
Editor |
Editor.templateLocked(String templateLocked)
When set to **true**, the sender cannot change any attributes of the recipient.
|
Editor |
Editor.templateRequired(String templateRequired)
When set to **true**, the sender may not remove the recipient.
|
Editor |
Editor.totalTabCount(String totalTabCount) |
Editor |
Editor.userId(String userId) |
| Modifier and Type | Method and Description |
|---|---|
List<Editor> |
TemplateRecipients.getEditors() |
List<Editor> |
Recipients.getEditors() |
| Modifier and Type | Method and Description |
|---|---|
TemplateRecipients |
TemplateRecipients.editors(List<Editor> editors) |
Recipients |
Recipients.editors(List<Editor> editors)
A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.
|
void |
TemplateRecipients.setEditors(List<Editor> editors) |
void |
Recipients.setEditors(List<Editor> editors) |
Copyright © 2016. All rights reserved.