Uses of Class
com.docusign.esign.model.Envelope

Packages that use Envelope

Package	Description
com.docusign.esign.api
com.docusign.esign.model

Uses of Envelope in com.docusign.esign.api

Methods in com.docusign.esign.api that return Envelope

Modifier and Type	Method and Description
Envelope	EnvelopesApi.getEnvelope(String accountId, String envelopeId) Gets the status of a envelope.
Envelope	EnvelopesApi.getEnvelope(String accountId, String envelopeId, EnvelopesApi.GetEnvelopeOptions options) Gets the status of a envelope.

Methods in com.docusign.esign.api with parameters of type Envelope

Modifier and Type	Method and Description
EnvelopeUpdateSummary	EnvelopesApi.update(String accountId, String envelopeId, Envelope envelope) Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality:\n\n* Sends the specified single draft envelope.\nAdd {\"status\":\"sent\"} to the request body to send the envelope.\n\n* Voids the specified in-process envelope.\nAdd {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope.\n\n* Replaces the current email subject and message for a draft envelope.\nAdd {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message.\n\n* Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.\nAdd {\"purgeState\":\"purge type\"} to the request body.\n\n*Additional information on purging documents*\n\nThe purge request can only be used for completed envelopes that are not marked as the authoritative copy.
EnvelopeUpdateSummary	EnvelopesApi.update(String accountId, String envelopeId, Envelope envelope, EnvelopesApi.UpdateOptions options) Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality:\n\n* Sends the specified single draft envelope.\nAdd {\"status\":\"sent\"} to the request body to send the envelope.\n\n* Voids the specified in-process envelope.\nAdd {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope.\n\n* Replaces the current email subject and message for a draft envelope.\nAdd {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message.\n\n* Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.\nAdd {\"purgeState\":\"purge type\"} to the request body.\n\n*Additional information on purging documents*\n\nThe purge request can only be used for completed envelopes that are not marked as the authoritative copy.

Uses of Envelope in com.docusign.esign.model

Methods in com.docusign.esign.model that return Envelope

Modifier and Type	Method and Description
Envelope	Envelope.allowMarkup(String allowMarkup) When set to **true**, Document Markup is enabled for envelope.
Envelope	Envelope.allowReassign(String allowReassign) When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
Envelope	Envelope.asynchronous(String asynchronous) When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'.
Envelope	Envelope.authoritativeCopy(String authoritativeCopy) Specifies the Authoritative copy feature.
Envelope	Envelope.autoNavigation(String autoNavigation)
Envelope	Envelope.brandId(String brandId)
Envelope	Envelope.brandLock(String brandLock)
Envelope	Envelope.certificateUri(String certificateUri) Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
Envelope	Envelope.completedDateTime(String completedDateTime) Specifies the date and time this item was completed.
Envelope	Envelope.createdDateTime(String createdDateTime) Indicates the date and time the item was created.
Envelope	Envelope.customFields(CustomFields customFields)
Envelope	Envelope.customFieldsUri(String customFieldsUri) Contains a URI for an endpoint that you can use to retrieve the custom fields.
Envelope	Envelope.declinedDateTime(String declinedDateTime) The date and time the recipient declined the document.
Envelope	Envelope.deletedDateTime(String deletedDateTime) Specifies the data and time the item was deleted.
Envelope	Envelope.deliveredDateTime(String deliveredDateTime) Reserved: For DocuSign use only.
Envelope	Envelope.documentsCombinedUri(String documentsCombinedUri)
Envelope	Envelope.documentsUri(String documentsUri) Contains a URI for an endpoint that you can use to retrieve the documents.
Envelope	Envelope.emailBlurb(String emailBlurb) This is the same as the email body.
Envelope	Envelope.emailSettings(EmailSettings emailSettings)
Envelope	Envelope.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.
Envelope	Envelope.enableWetSign(String enableWetSign) When set to **true**, the signer is allowed to print the document and sign it on paper.
Envelope	Envelope.enforceSignerVisibility(String enforceSignerVisibility) When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document.
Envelope	Envelope.envelopeId(String envelopeId) The envelope ID of the envelope status that failed to post.
Envelope	Envelope.envelopeIdStamping(String envelopeIdStamping) When set to **true**, Envelope ID Stamping is enabled.
Envelope	Envelope.envelopeUri(String envelopeUri) Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
Envelope	InlineTemplate.getEnvelope()
Envelope	Envelope.initialSentDateTime(String initialSentDateTime)
Envelope	Envelope.is21CFRPart11(String is21CFRPart11) When set to **true**, indicates that this module is enabled on the account.
Envelope	Envelope.isSignatureProviderEnvelope(String isSignatureProviderEnvelope)
Envelope	Envelope.lastModifiedDateTime(String lastModifiedDateTime) The date and time the item was last modified.
Envelope	Envelope.lockInformation(LockInformation lockInformation)
Envelope	Envelope.messageLock(String messageLock) When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.
Envelope	Envelope.notification(Notification notification)
Envelope	Envelope.notificationUri(String notificationUri) Contains a URI for an endpoint that you can use to retrieve the notifications.
Envelope	Envelope.purgeState(String purgeState)
Envelope	Envelope.recipients(Recipients recipients)
Envelope	Envelope.recipientsLock(String recipientsLock) When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
Envelope	Envelope.recipientsUri(String recipientsUri) Contains a URI for an endpoint that you can use to retrieve the recipients.
Envelope	Envelope.sentDateTime(String sentDateTime) The date and time the envelope was sent.
Envelope	Envelope.signingLocation(String signingLocation) Specifies the physical location where the signing takes place.
Envelope	Envelope.status(String status) Indicates the envelope status.
Envelope	Envelope.statusChangedDateTime(String statusChangedDateTime) The data and time the status changed.
Envelope	Envelope.templatesUri(String templatesUri) Contains a URI for an endpoint which you can use to retrieve the templates.
Envelope	Envelope.transactionId(String transactionId) Used to identify an envelope.
Envelope	Envelope.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.
Envelope	Envelope.voidedDateTime(String voidedDateTime) The date and time the envelope or template was voided.
Envelope	Envelope.voidedReason(String voidedReason) The reason the envelope or template was voided.

Methods in com.docusign.esign.model that return types with arguments of type Envelope

Modifier and Type	Method and Description
List<Envelope>	EnvelopesInformation.getEnvelopes()

Methods in com.docusign.esign.model with parameters of type Envelope

Modifier and Type	Method and Description
InlineTemplate	InlineTemplate.envelope(Envelope envelope)
void	InlineTemplate.setEnvelope(Envelope envelope)

Method parameters in com.docusign.esign.model with type arguments of type Envelope

Modifier and Type	Method and Description
EnvelopesInformation	EnvelopesInformation.envelopes(List<Envelope> envelopes)
void	EnvelopesInformation.setEnvelopes(List<Envelope> envelopes)