| Package | Description |
|---|---|
| com.docusign.esign.model |
| Modifier and Type | Method and Description |
|---|---|
Signer |
Signer.accessCode(String accessCode)
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
|
Signer |
Signer.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.
|
Signer |
Signer.bulkRecipientsUri(String bulkRecipientsUri)
Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
|
Signer |
Signer.canSignOffline(String canSignOffline)
When set to **true**, specifies that the signer can perform the signing ceremony offline.
|
Signer |
Signer.clientUserId(String clientUserId)
Specifies whether the recipient is embedded or remote.
|
Signer |
Signer.customFields(List<String> customFields)
An optional array of strings that allows the sender to provide custom data about the recipient.
|
Signer |
Signer.declinedDateTime(String declinedDateTime)
The date and time the recipient declined the document.
|
Signer |
Signer.declinedReason(String declinedReason)
The reason the recipient declined the document.
|
Signer |
Signer.defaultRecipient(String defaultRecipient) |
Signer |
Signer.deliveredDateTime(String deliveredDateTime)
Reserved: For DocuSign use only.
|
Signer |
Signer.deliveryMethod(String deliveryMethod)
Reserved: For DocuSign use only.
|
Signer |
Signer.email(String email)
Email id of the recipient.
|
Signer |
Signer.emailNotification(RecipientEmailNotification emailNotification) |
Signer |
Signer.emailRecipientPostSigningURL(String emailRecipientPostSigningURL) |
Signer |
Signer.embeddedRecipientStartURL(String embeddedRecipientStartURL)
Specifies a sender provided valid URL string for redirecting an embedded recipient.
|
Signer |
Signer.errorDetails(ErrorDetails errorDetails) |
Signer |
Signer.excludedDocuments(List<String> excludedDocuments)
Specifies the documents that are not visible to this recipient.
|
Signer |
Signer.faxNumber(String faxNumber)
Reserved:
|
Signer |
Signer.idCheckConfigurationName(String idCheckConfigurationName)
Specifies authentication check by name.
|
Signer |
Signer.idCheckInformationInput(IdCheckInformationInput idCheckInformationInput) |
Signer |
Signer.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.
|
Signer |
Signer.isBulkRecipient(String isBulkRecipient)
When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.
|
Signer |
Signer.name(String name) |
Signer |
Signer.note(String note)
Specifies a note that is unique to this recipient.
|
Signer |
Signer.offlineAttributes(OfflineAttributes offlineAttributes) |
Signer |
Signer.phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication) |
Signer |
Signer.recipientAttachments(List<Attachment> recipientAttachments)
Reserved:
|
Signer |
Signer.recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus) |
Signer |
Signer.recipientId(String recipientId)
Unique for the recipient.
|
Signer |
Signer.recipientIdGuid(String recipientIdGuid) |
Signer |
Signer.recipientSuppliesTabs(String recipientSuppliesTabs) |
Signer |
Signer.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.
|
Signer |
Signer.requireSignerCertificate(String requireSignerCertificate)
Sets the type of signer certificate required for signing.
|
Signer |
Signer.requireSignOnPaper(String requireSignOnPaper)
When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.
|
Signer |
Signer.roleName(String roleName)
Optional element.
|
Signer |
Signer.routingOrder(String routingOrder)
Specifies the routing order of the recipient in the envelope.
|
Signer |
Signer.samlAuthentication(RecipientSAMLAuthentication samlAuthentication) |
Signer |
Signer.sentDateTime(String sentDateTime)
The date and time the envelope was sent.
|
Signer |
Signer.signatureInfo(RecipientSignatureInformation signatureInfo) |
Signer |
Signer.signedDateTime(String signedDateTime)
Reserved: For DocuSign use only.
|
Signer |
Signer.signInEachLocation(String signInEachLocation)
When set to **true**, specifies that the signer must sign in all locations.
|
Signer |
Signer.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).
|
Signer |
Signer.signingGroupName(String signingGroupName)
The display name for the signing group.
|
Signer |
Signer.signingGroupUsers(List<UserInfo> signingGroupUsers)
A complex type that contains information about users in the signing group.
|
Signer |
Signer.smsAuthentication(RecipientSMSAuthentication smsAuthentication) |
Signer |
Signer.socialAuthentications(List<SocialAuthentication> socialAuthentications)
Lists the social ID type that can be used for recipient authentication.
|
Signer |
Signer.status(String status)
Indicates the envelope status.
|
Signer |
Signer.tabs(Tabs tabs) |
Signer |
Signer.templateLocked(String templateLocked)
When set to **true**, the sender cannot change any attributes of the recipient.
|
Signer |
Signer.templateRequired(String templateRequired)
When set to **true**, the sender may not remove the recipient.
|
Signer |
Signer.totalTabCount(String totalTabCount) |
Signer |
Signer.userId(String userId) |
| Modifier and Type | Method and Description |
|---|---|
List<Signer> |
TemplateRecipients.getSigners() |
List<Signer> |
Recipients.getSigners() |
| Modifier and Type | Method and Description |
|---|---|
void |
TemplateRecipients.setSigners(List<Signer> signers) |
void |
Recipients.setSigners(List<Signer> signers) |
TemplateRecipients |
TemplateRecipients.signers(List<Signer> signers)
A complex type containing information about the Signer recipient.
|
Recipients |
Recipients.signers(List<Signer> signers)
A complex type containing information about the Signer recipient.
|
Copyright © 2016. All rights reserved.