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

All Implemented Interfaces:

Serializable
```
public class EnvelopeDocument
extends Object
implements Serializable
```
This object contains details about the envelope document..

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

EnvelopeDocument()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`EnvelopeDocument`	`addAddedRecipientIdsItem(String addedRecipientIdsItem)`	addAddedRecipientIdsItem.
`EnvelopeDocument`	`addAvailableDocumentTypesItem(SignatureType availableDocumentTypesItem)`	addAvailableDocumentTypesItem.
`EnvelopeDocument`	`addDocGenErrorsItem(DocGenSyntaxError docGenErrorsItem)`	addDocGenErrorsItem.
`EnvelopeDocument`	`addDocGenFormFieldsItem(DocGenFormField docGenFormFieldsItem)`	addDocGenFormFieldsItem.
`EnvelopeDocument`	`addDocumentFieldsItem(NameValue documentFieldsItem)`	addDocumentFieldsItem.
`EnvelopeDocument`	`addedRecipientIds(List<String> addedRecipientIds)`	addedRecipientIds.
`EnvelopeDocument`	`addPagesItem(Page pagesItem)`	addPagesItem.
`EnvelopeDocument`	`attachmentTabId(String attachmentTabId)`	attachmentTabId.
`EnvelopeDocument`	`authoritativeCopy(String authoritativeCopy)`	authoritativeCopy.
`EnvelopeDocument`	`authoritativeCopyMetadata(PropertyMetadata authoritativeCopyMetadata)`	authoritativeCopyMetadata.
`EnvelopeDocument`	`availableDocumentTypes(List<SignatureType> availableDocumentTypes)`	availableDocumentTypes.
`EnvelopeDocument`	`containsPdfFormFields(String containsPdfFormFields)`	containsPdfFormFields.
`EnvelopeDocument`	`display(String display)`	display.
`EnvelopeDocument`	`displayMetadata(PropertyMetadata displayMetadata)`	displayMetadata.
`EnvelopeDocument`	`docGenDocumentStatus(String docGenDocumentStatus)`	docGenDocumentStatus.
`EnvelopeDocument`	`docGenErrors(List<DocGenSyntaxError> docGenErrors)`	docGenErrors.
`EnvelopeDocument`	`docGenFormFields(List<DocGenFormField> docGenFormFields)`	docGenFormFields.
`EnvelopeDocument`	`documentBase64(String documentBase64)`	documentBase64.
`EnvelopeDocument`	`documentFields(List<NameValue> documentFields)`	documentFields.
`EnvelopeDocument`	`documentId(String documentId)`	documentId.
`EnvelopeDocument`	`documentIdGuid(String documentIdGuid)`	documentIdGuid.
`boolean`	`equals(Object o)`	Compares objects.
`EnvelopeDocument`	`errorDetails(ErrorDetails errorDetails)`	errorDetails.
`List<String>`	`getAddedRecipientIds()`	.
`String`	`getAttachmentTabId()`	.
`String`	`getAuthoritativeCopy()`	Specifies the Authoritative copy feature.
`PropertyMetadata`	`getAuthoritativeCopyMetadata()`	Metadata that indicates if the sender can edit the `authoritativeCopy` property.
`List<SignatureType>`	`getAvailableDocumentTypes()`	.
`String`	`getContainsPdfFormFields()`	.
`String`	`getDisplay()`	.
`PropertyMetadata`	`getDisplayMetadata()`	Metadata that indicates if the sender can edit the `display` property.
`String`	`getDocGenDocumentStatus()`	.
`List<DocGenSyntaxError>`	`getDocGenErrors()`	.
`List<DocGenFormField>`	`getDocGenFormFields()`	.
`String`	`getDocumentBase64()`	.
`List<NameValue>`	`getDocumentFields()`	.
`String`	`getDocumentId()`	Specifies the document ID number that the tab is placed on.
`String`	`getDocumentIdGuid()`	.
`ErrorDetails`	`getErrorDetails()`	Array or errors..
`String`	`getIncludeInDownload()`	.
`PropertyMetadata`	`getIncludeInDownloadMetadata()`	Metadata that indicates if the sender can edit the `includeInDownload` property.
`String`	`getIsAceGenDocument()`	.
`String`	`getIsDocGenDocument()`	.
`String`	`getName()`	.
`PropertyMetadata`	`getNameMetadata()`	Metadata that indicates if the sender can edit the `name` property.
`String`	`getOrder()`	.
`List<Page>`	`getPages()`	.
`String`	`getSignerMustAcknowledge()`	.
`PropertyMetadata`	`getSignerMustAcknowledgeMetadata()`	Metadata that indicates if the sender can edit the `signerMustAcknowledge` property.
`String`	`getSizeBytes()`	.
`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`	`getType()`	.
`String`	`getUri()`	.
`int`	`hashCode()`	Returns the HashCode.
`EnvelopeDocument`	`includeInDownload(String includeInDownload)`	includeInDownload.
`EnvelopeDocument`	`includeInDownloadMetadata(PropertyMetadata includeInDownloadMetadata)`	includeInDownloadMetadata.
`EnvelopeDocument`	`isAceGenDocument(String isAceGenDocument)`	isAceGenDocument.
`EnvelopeDocument`	`isDocGenDocument(String isDocGenDocument)`	isDocGenDocument.
`EnvelopeDocument`	`name(String name)`	name.
`EnvelopeDocument`	`nameMetadata(PropertyMetadata nameMetadata)`	nameMetadata.
`EnvelopeDocument`	`order(String order)`	order.
`EnvelopeDocument`	`pages(List<Page> pages)`	pages.
`void`	`setAddedRecipientIds(List<String> addedRecipientIds)`	setAddedRecipientIds.
`void`	`setAttachmentTabId(String attachmentTabId)`	setAttachmentTabId.
`void`	`setAuthoritativeCopy(String authoritativeCopy)`	setAuthoritativeCopy.
`void`	`setAuthoritativeCopyMetadata(PropertyMetadata authoritativeCopyMetadata)`	setAuthoritativeCopyMetadata.
`void`	`setAvailableDocumentTypes(List<SignatureType> availableDocumentTypes)`	setAvailableDocumentTypes.
`void`	`setContainsPdfFormFields(String containsPdfFormFields)`	setContainsPdfFormFields.
`void`	`setDisplay(String display)`	setDisplay.
`void`	`setDisplayMetadata(PropertyMetadata displayMetadata)`	setDisplayMetadata.
`void`	`setDocGenDocumentStatus(String docGenDocumentStatus)`	setDocGenDocumentStatus.
`void`	`setDocGenErrors(List<DocGenSyntaxError> docGenErrors)`	setDocGenErrors.
`void`	`setDocGenFormFields(List<DocGenFormField> docGenFormFields)`	setDocGenFormFields.
`void`	`setDocumentBase64(String documentBase64)`	setDocumentBase64.
`void`	`setDocumentFields(List<NameValue> documentFields)`	setDocumentFields.
`void`	`setDocumentId(String documentId)`	setDocumentId.
`void`	`setDocumentIdGuid(String documentIdGuid)`	setDocumentIdGuid.
`void`	`setErrorDetails(ErrorDetails errorDetails)`	setErrorDetails.
`void`	`setIncludeInDownload(String includeInDownload)`	setIncludeInDownload.
`void`	`setIncludeInDownloadMetadata(PropertyMetadata includeInDownloadMetadata)`	setIncludeInDownloadMetadata.
`void`	`setIsAceGenDocument(String isAceGenDocument)`	setIsAceGenDocument.
`void`	`setIsDocGenDocument(String isDocGenDocument)`	setIsDocGenDocument.
`void`	`setName(String name)`	setName.
`void`	`setNameMetadata(PropertyMetadata nameMetadata)`	setNameMetadata.
`void`	`setOrder(String order)`	setOrder.
`void`	`setPages(List<Page> pages)`	setPages.
`void`	`setSignerMustAcknowledge(String signerMustAcknowledge)`	setSignerMustAcknowledge.
`void`	`setSignerMustAcknowledgeMetadata(PropertyMetadata signerMustAcknowledgeMetadata)`	setSignerMustAcknowledgeMetadata.
`void`	`setSizeBytes(String sizeBytes)`	setSizeBytes.
`void`	`setTemplateLocked(String templateLocked)`	setTemplateLocked.
`void`	`setTemplateRequired(String templateRequired)`	setTemplateRequired.
`void`	`setType(String type)`	setType.
`void`	`setUri(String uri)`	setUri.
`EnvelopeDocument`	`signerMustAcknowledge(String signerMustAcknowledge)`	signerMustAcknowledge.
`EnvelopeDocument`	`signerMustAcknowledgeMetadata(PropertyMetadata signerMustAcknowledgeMetadata)`	signerMustAcknowledgeMetadata.
`EnvelopeDocument`	`sizeBytes(String sizeBytes)`	sizeBytes.
`EnvelopeDocument`	`templateLocked(String templateLocked)`	templateLocked.
`EnvelopeDocument`	`templateRequired(String templateRequired)`	templateRequired.
`String`	`toString()`	Converts the given object to string.
`EnvelopeDocument`	`type(String type)`	type.
`EnvelopeDocument`	`uri(String uri)`	uri.

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

Constructor Detail
- EnvelopeDocument
```
public EnvelopeDocument()
```

Method Detail

addedRecipientIds

public EnvelopeDocument addedRecipientIds(List<String> addedRecipientIds)

addedRecipientIds.

Returns:: EnvelopeDocument

addAddedRecipientIdsItem

public EnvelopeDocument addAddedRecipientIdsItem(String addedRecipientIdsItem)

addAddedRecipientIdsItem.

Returns:: EnvelopeDocument

getAddedRecipientIds

public List<String> getAddedRecipientIds()

.

Returns:: addedRecipientIds

setAddedRecipientIds

public void setAddedRecipientIds(List<String> addedRecipientIds)

setAddedRecipientIds.

attachmentTabId

public EnvelopeDocument attachmentTabId(String attachmentTabId)

attachmentTabId.

Returns:: EnvelopeDocument

getAttachmentTabId
```
public String getAttachmentTabId()
```
.

Returns:

attachmentTabId

setAttachmentTabId

public void setAttachmentTabId(String attachmentTabId)

setAttachmentTabId.

authoritativeCopy

public EnvelopeDocument authoritativeCopy(String authoritativeCopy)

authoritativeCopy.

Returns:: EnvelopeDocument

getAuthoritativeCopy
```
public String getAuthoritativeCopy()
```
Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled..

Returns:

authoritativeCopy

setAuthoritativeCopy

public void setAuthoritativeCopy(String authoritativeCopy)

setAuthoritativeCopy.

authoritativeCopyMetadata

public EnvelopeDocument authoritativeCopyMetadata(PropertyMetadata authoritativeCopyMetadata)

authoritativeCopyMetadata.

Returns:: EnvelopeDocument

getAuthoritativeCopyMetadata
```
public PropertyMetadata getAuthoritativeCopyMetadata()
```
Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents..

Returns:

authoritativeCopyMetadata

setAuthoritativeCopyMetadata

public void setAuthoritativeCopyMetadata(PropertyMetadata authoritativeCopyMetadata)

setAuthoritativeCopyMetadata.

availableDocumentTypes

public EnvelopeDocument availableDocumentTypes(List<SignatureType> availableDocumentTypes)

availableDocumentTypes.

Returns:: EnvelopeDocument

addAvailableDocumentTypesItem

public EnvelopeDocument addAvailableDocumentTypesItem(SignatureType availableDocumentTypesItem)

addAvailableDocumentTypesItem.

Returns:: EnvelopeDocument

getAvailableDocumentTypes

public List<SignatureType> getAvailableDocumentTypes()

.

Returns:: availableDocumentTypes

setAvailableDocumentTypes

public void setAvailableDocumentTypes(List<SignatureType> availableDocumentTypes)

setAvailableDocumentTypes.

containsPdfFormFields

public EnvelopeDocument containsPdfFormFields(String containsPdfFormFields)

containsPdfFormFields.

Returns:: EnvelopeDocument

getContainsPdfFormFields
```
public String getContainsPdfFormFields()
```
.

Returns:

containsPdfFormFields

setContainsPdfFormFields

public void setContainsPdfFormFields(String containsPdfFormFields)

setContainsPdfFormFields.

display

public EnvelopeDocument display(String display)

display.

Returns:: EnvelopeDocument

getDisplay
```
public String getDisplay()
```
.

Returns:

display

setDisplay

public void setDisplay(String display)

setDisplay.

displayMetadata

public EnvelopeDocument displayMetadata(PropertyMetadata displayMetadata)

displayMetadata.

Returns:: EnvelopeDocument

getDisplayMetadata
```
public PropertyMetadata getDisplayMetadata()
```
Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents..

Returns:

displayMetadata

setDisplayMetadata

public void setDisplayMetadata(PropertyMetadata displayMetadata)

setDisplayMetadata.

docGenDocumentStatus

public EnvelopeDocument docGenDocumentStatus(String docGenDocumentStatus)

docGenDocumentStatus.

Returns:: EnvelopeDocument

getDocGenDocumentStatus
```
public String getDocGenDocumentStatus()
```
.

Returns:

docGenDocumentStatus

setDocGenDocumentStatus

public void setDocGenDocumentStatus(String docGenDocumentStatus)

setDocGenDocumentStatus.

docGenErrors

public EnvelopeDocument docGenErrors(List<DocGenSyntaxError> docGenErrors)

docGenErrors.

Returns:: EnvelopeDocument

addDocGenErrorsItem

public EnvelopeDocument addDocGenErrorsItem(DocGenSyntaxError docGenErrorsItem)

addDocGenErrorsItem.

Returns:: EnvelopeDocument

getDocGenErrors

public List<DocGenSyntaxError> getDocGenErrors()

.

Returns:: docGenErrors

setDocGenErrors

public void setDocGenErrors(List<DocGenSyntaxError> docGenErrors)

setDocGenErrors.

docGenFormFields

public EnvelopeDocument docGenFormFields(List<DocGenFormField> docGenFormFields)

docGenFormFields.

Returns:: EnvelopeDocument

addDocGenFormFieldsItem

public EnvelopeDocument addDocGenFormFieldsItem(DocGenFormField docGenFormFieldsItem)

addDocGenFormFieldsItem.

Returns:: EnvelopeDocument

getDocGenFormFields

public List<DocGenFormField> getDocGenFormFields()

.

Returns:: docGenFormFields

setDocGenFormFields

public void setDocGenFormFields(List<DocGenFormField> docGenFormFields)

setDocGenFormFields.

documentBase64

public EnvelopeDocument documentBase64(String documentBase64)

documentBase64.

Returns:: EnvelopeDocument

getDocumentBase64
```
public String getDocumentBase64()
```
.

Returns:

documentBase64

setDocumentBase64

public void setDocumentBase64(String documentBase64)

setDocumentBase64.

documentFields

public EnvelopeDocument documentFields(List<NameValue> documentFields)

documentFields.

Returns:: EnvelopeDocument

addDocumentFieldsItem

public EnvelopeDocument addDocumentFieldsItem(NameValue documentFieldsItem)

addDocumentFieldsItem.

Returns:: EnvelopeDocument

getDocumentFields

public List<NameValue> getDocumentFields()

.

Returns:: documentFields

setDocumentFields

public void setDocumentFields(List<NameValue> documentFields)

setDocumentFields.

documentId

public EnvelopeDocument documentId(String documentId)

documentId.

Returns:: EnvelopeDocument

getDocumentId
```
public String getDocumentId()
```
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

setDocumentId.

documentIdGuid

public EnvelopeDocument documentIdGuid(String documentIdGuid)

documentIdGuid.

Returns:: EnvelopeDocument

getDocumentIdGuid
```
public String getDocumentIdGuid()
```
.

Returns:

documentIdGuid

setDocumentIdGuid

public void setDocumentIdGuid(String documentIdGuid)

setDocumentIdGuid.

errorDetails

public EnvelopeDocument errorDetails(ErrorDetails errorDetails)

errorDetails.

Returns:: EnvelopeDocument

getErrorDetails
```
public ErrorDetails getErrorDetails()
```
Array or errors..

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

setErrorDetails.

includeInDownload

public EnvelopeDocument includeInDownload(String includeInDownload)

includeInDownload.

Returns:: EnvelopeDocument

getIncludeInDownload
```
public String getIncludeInDownload()
```
.

Returns:

includeInDownload

setIncludeInDownload

public void setIncludeInDownload(String includeInDownload)

setIncludeInDownload.

includeInDownloadMetadata

public EnvelopeDocument includeInDownloadMetadata(PropertyMetadata includeInDownloadMetadata)

includeInDownloadMetadata.

Returns:: EnvelopeDocument

getIncludeInDownloadMetadata
```
public PropertyMetadata getIncludeInDownloadMetadata()
```
Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents..

Returns:

includeInDownloadMetadata

setIncludeInDownloadMetadata

public void setIncludeInDownloadMetadata(PropertyMetadata includeInDownloadMetadata)

setIncludeInDownloadMetadata.

isAceGenDocument

public EnvelopeDocument isAceGenDocument(String isAceGenDocument)

isAceGenDocument.

Returns:: EnvelopeDocument

getIsAceGenDocument
```
public String getIsAceGenDocument()
```
.

Returns:

isAceGenDocument

setIsAceGenDocument

public void setIsAceGenDocument(String isAceGenDocument)

setIsAceGenDocument.

isDocGenDocument

public EnvelopeDocument isDocGenDocument(String isDocGenDocument)

isDocGenDocument.

Returns:: EnvelopeDocument

getIsDocGenDocument
```
public String getIsDocGenDocument()
```
.

Returns:

isDocGenDocument

setIsDocGenDocument

public void setIsDocGenDocument(String isDocGenDocument)

setIsDocGenDocument.

name

public EnvelopeDocument name(String name)

name.

Returns:: EnvelopeDocument

getName
```
public String getName()
```
.

Returns:

name

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

nameMetadata

public EnvelopeDocument nameMetadata(PropertyMetadata nameMetadata)

nameMetadata.

Returns:: EnvelopeDocument

getNameMetadata
```
public PropertyMetadata getNameMetadata()
```
Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents..

Returns:

nameMetadata

setNameMetadata

public void setNameMetadata(PropertyMetadata nameMetadata)

setNameMetadata.

order

public EnvelopeDocument order(String order)

order.

Returns:: EnvelopeDocument

getOrder
```
public String getOrder()
```
.

Returns:

order

setOrder

public void setOrder(String order)

setOrder.

pages

public EnvelopeDocument pages(List<Page> pages)

pages.

Returns:: EnvelopeDocument

addPagesItem

public EnvelopeDocument addPagesItem(Page pagesItem)

addPagesItem.

Returns:: EnvelopeDocument

getPages
```
public List<Page> getPages()
```
.

Returns:

pages

setPages

public void setPages(List<Page> pages)

setPages.

signerMustAcknowledge

public EnvelopeDocument signerMustAcknowledge(String signerMustAcknowledge)

signerMustAcknowledge.

Returns:: EnvelopeDocument

getSignerMustAcknowledge
```
public String getSignerMustAcknowledge()
```
.

Returns:

signerMustAcknowledge

setSignerMustAcknowledge

public void setSignerMustAcknowledge(String signerMustAcknowledge)

setSignerMustAcknowledge.

signerMustAcknowledgeMetadata

public EnvelopeDocument signerMustAcknowledgeMetadata(PropertyMetadata signerMustAcknowledgeMetadata)

signerMustAcknowledgeMetadata.

Returns:: EnvelopeDocument

getSignerMustAcknowledgeMetadata
```
public PropertyMetadata getSignerMustAcknowledgeMetadata()
```
Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents..

Returns:

signerMustAcknowledgeMetadata

setSignerMustAcknowledgeMetadata

public void setSignerMustAcknowledgeMetadata(PropertyMetadata signerMustAcknowledgeMetadata)

setSignerMustAcknowledgeMetadata.

sizeBytes

public EnvelopeDocument sizeBytes(String sizeBytes)

sizeBytes.

Returns:: EnvelopeDocument

getSizeBytes
```
public String getSizeBytes()
```
.

Returns:

sizeBytes

setSizeBytes

public void setSizeBytes(String sizeBytes)

setSizeBytes.

templateLocked

public EnvelopeDocument templateLocked(String templateLocked)

templateLocked.

Returns:: EnvelopeDocument

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)

setTemplateLocked.

templateRequired

public EnvelopeDocument templateRequired(String templateRequired)

templateRequired.

Returns:: EnvelopeDocument

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)

setTemplateRequired.

type

public EnvelopeDocument type(String type)

type.

Returns:: EnvelopeDocument

getType
```
public String getType()
```
.

Returns:

type

setType
```
public void setType(String type)
```
setType.

uri

public EnvelopeDocument uri(String uri)

uri.

Returns:: EnvelopeDocument

getUri
```
public String getUri()
```
.

Returns:

uri

setUri
```
public void setUri(String uri)
```
setUri.

equals
```
public boolean equals(Object o)
```
Compares objects.

Overrides:

equals in class Object

Returns:

true or false depending on comparison result.

hashCode
```
public int hashCode()
```
Returns the HashCode.

Overrides:

hashCode in class Object

toString
```
public String toString()
```
Converts the given object to string.

Overrides:

toString in class Object

Class EnvelopeDocument

Constructor Summary