| Package | Description |
|---|---|
| com.docusign.esign.api | |
| com.docusign.esign.model |
| Modifier and Type | Method and Description |
|---|---|
EnvelopeSummary |
EnvelopesApi.createEnvelope(String accountId,
EnvelopeDefinition envelopeDefinition)
Creates an envelope.
|
EnvelopeSummary |
EnvelopesApi.createEnvelope(String accountId,
EnvelopeDefinition envelopeDefinition,
EnvelopesApi.CreateEnvelopeOptions options)
Creates an envelope.
|
TemplateDocumentsResult |
TemplatesApi.deleteDocuments(String accountId,
String templateId,
EnvelopeDefinition envelopeDefinition)
Deletes documents from a template.
|
EnvelopeDocumentsResult |
EnvelopesApi.deleteDocuments(String accountId,
String envelopeId,
EnvelopeDefinition envelopeDefinition)
Deletes documents from a draft envelope.
|
TemplateDocumentsResult |
TemplatesApi.updateDocuments(String accountId,
String templateId,
EnvelopeDefinition envelopeDefinition)
Adds documents to a template document.
|
EnvelopeDocumentsResult |
EnvelopesApi.updateDocuments(String accountId,
String envelopeId,
EnvelopeDefinition envelopeDefinition)
Adds one or more documents to an existing envelope document.
|
EnvelopeDocumentsResult |
EnvelopesApi.updateDocuments(String accountId,
String envelopeId,
EnvelopeDefinition envelopeDefinition,
EnvelopesApi.UpdateDocumentsOptions options)
Adds one or more documents to an existing envelope document.
|
TemplateDocumentsResult |
TemplatesApi.updateDocuments(String accountId,
String templateId,
EnvelopeDefinition envelopeDefinition,
TemplatesApi.UpdateDocumentsOptions options)
Adds documents to a template document.
|
| Modifier and Type | Method and Description |
|---|---|
EnvelopeDefinition |
EnvelopeDefinition.accessibility(String accessibility)
Sets the document reading zones for screen reader applications.
|
EnvelopeDefinition |
EnvelopeDefinition.allowMarkup(String allowMarkup)
When set to **true**, Document Markup is enabled for envelope.
|
EnvelopeDefinition |
EnvelopeDefinition.allowReassign(String allowReassign)
When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
|
EnvelopeDefinition |
EnvelopeDefinition.allowRecipientRecursion(String allowRecipientRecursion)
When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.
|
EnvelopeDefinition |
EnvelopeDefinition.asynchronous(String asynchronous)
When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'.
|
EnvelopeDefinition |
EnvelopeDefinition.authoritativeCopy(String authoritativeCopy)
Specifies the Authoritative copy feature.
|
EnvelopeDefinition |
EnvelopeDefinition.autoNavigation(String autoNavigation) |
EnvelopeDefinition |
EnvelopeDefinition.brandId(String brandId)
This sets the brand profile format used for the envelope.
|
EnvelopeDefinition |
EnvelopeDefinition.brandLock(String brandLock) |
EnvelopeDefinition |
EnvelopeDefinition.certificateUri(String certificateUri)
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
|
EnvelopeDefinition |
EnvelopeDefinition.completedDateTime(String completedDateTime)
Specifies the date and time this item was completed.
|
EnvelopeDefinition |
EnvelopeDefinition.compositeTemplates(List<CompositeTemplate> compositeTemplates)
A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms.
|
EnvelopeDefinition |
EnvelopeDefinition.createdDateTime(String createdDateTime)
Indicates the date and time the item was created.
|
EnvelopeDefinition |
EnvelopeDefinition.customFields(CustomFields customFields) |
EnvelopeDefinition |
EnvelopeDefinition.customFieldsUri(String customFieldsUri)
Contains a URI for an endpoint that you can use to retrieve the custom fields.
|
EnvelopeDefinition |
EnvelopeDefinition.declinedDateTime(String declinedDateTime)
The date and time the recipient declined the document.
|
EnvelopeDefinition |
EnvelopeDefinition.deletedDateTime(String deletedDateTime)
Specifies the data and time the item was deleted.
|
EnvelopeDefinition |
EnvelopeDefinition.deliveredDateTime(String deliveredDateTime)
Reserved: For DocuSign use only.
|
EnvelopeDefinition |
EnvelopeDefinition.documents(List<Document> documents)
Complex element contains the details on the documents in the envelope.
|
EnvelopeDefinition |
EnvelopeDefinition.documentsCombinedUri(String documentsCombinedUri) |
EnvelopeDefinition |
EnvelopeDefinition.documentsUri(String documentsUri)
Contains a URI for an endpoint that you can use to retrieve the documents.
|
EnvelopeDefinition |
EnvelopeDefinition.emailBlurb(String emailBlurb)
Optional element.
|
EnvelopeDefinition |
EnvelopeDefinition.emailSettings(EmailSettings emailSettings) |
EnvelopeDefinition |
EnvelopeDefinition.emailSubject(String emailSubject)
Specifies the subject of the email that is sent to all recipients.\n\nSee [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
|
EnvelopeDefinition |
EnvelopeDefinition.enableWetSign(String enableWetSign)
When set to **true**, the signer is allowed to print the document and sign it on paper.
|
EnvelopeDefinition |
EnvelopeDefinition.enforceSignerVisibility(String enforceSignerVisibility)
When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document.
|
EnvelopeDefinition |
EnvelopeDefinition.envelopeId(String envelopeId)
The envelope ID of the envelope status that failed to post.
|
EnvelopeDefinition |
EnvelopeDefinition.envelopeIdStamping(String envelopeIdStamping)
When set to **true**, Envelope ID Stamping is enabled.
|
EnvelopeDefinition |
EnvelopeDefinition.envelopeUri(String envelopeUri)
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
|
EnvelopeDefinition |
EnvelopeDefinition.eventNotification(EventNotification eventNotification) |
EnvelopeDefinition |
EnvelopeDefinition.initialSentDateTime(String initialSentDateTime) |
EnvelopeDefinition |
EnvelopeDefinition.is21CFRPart11(String is21CFRPart11)
When set to **true**, indicates that this module is enabled on the account.
|
EnvelopeDefinition |
EnvelopeDefinition.isSignatureProviderEnvelope(String isSignatureProviderEnvelope) |
EnvelopeDefinition |
EnvelopeDefinition.lastModifiedDateTime(String lastModifiedDateTime)
The date and time the item was last modified.
|
EnvelopeDefinition |
EnvelopeDefinition.lockInformation(LockInformation lockInformation) |
EnvelopeDefinition |
EnvelopeDefinition.messageLock(String messageLock)
When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.
|
EnvelopeDefinition |
EnvelopeDefinition.notification(Notification notification) |
EnvelopeDefinition |
EnvelopeDefinition.notificationUri(String notificationUri)
Contains a URI for an endpoint that you can use to retrieve the notifications.
|
EnvelopeDefinition |
EnvelopeDefinition.password(String password) |
EnvelopeDefinition |
EnvelopeDefinition.purgeState(String purgeState)
Initiates a purge request.
|
EnvelopeDefinition |
EnvelopeDefinition.recipients(Recipients recipients) |
EnvelopeDefinition |
EnvelopeDefinition.recipientsLock(String recipientsLock)
When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
|
EnvelopeDefinition |
EnvelopeDefinition.recipientsUri(String recipientsUri)
Contains a URI for an endpoint that you can use to retrieve the recipients.
|
EnvelopeDefinition |
EnvelopeDefinition.sentDateTime(String sentDateTime)
The date and time the envelope was sent.
|
EnvelopeDefinition |
EnvelopeDefinition.signingLocation(String signingLocation)
Specifies the physical location where the signing takes place.
|
EnvelopeDefinition |
EnvelopeDefinition.status(String status)
Indicates the envelope status.
|
EnvelopeDefinition |
EnvelopeDefinition.statusChangedDateTime(String statusChangedDateTime)
The data and time the status changed.
|
EnvelopeDefinition |
EnvelopeDefinition.templateId(String templateId)
The unique identifier of the template.
|
EnvelopeDefinition |
EnvelopeDefinition.templateRoles(List<TemplateRole> templateRoles)
Specifies the template recipients.
|
EnvelopeDefinition |
EnvelopeDefinition.templatesUri(String templatesUri)
Contains a URI for an endpoint which you can use to retrieve the templates.
|
EnvelopeDefinition |
EnvelopeDefinition.transactionId(String transactionId)
Used to identify an envelope.
|
EnvelopeDefinition |
EnvelopeDefinition.useDisclosure(String useDisclosure)
When set to **true**, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting.
|
EnvelopeDefinition |
EnvelopeDefinition.voidedDateTime(String voidedDateTime)
The date and time the envelope or template was voided.
|
EnvelopeDefinition |
EnvelopeDefinition.voidedReason(String voidedReason)
The reason the envelope or template was voided.
|
Copyright © 2016. All rights reserved.