new module:model/EnvelopeDocument()
- Source:
Constructs a new EnvelopeDocument.
This object contains details about the envelope document.
Members
(inner) addedRecipientIds :Array.<String>
- Source:
Type:
- Array.<String>
(inner) attachmentTabId :String
- Source:
Type:
- String
(inner) authoritativeCopy :String
- Source:
Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
Type:
- String
(inner) authoritativeCopyMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates if the sender can edit the authoritativeCopy property. Not applicable for template documents.
Type:
(inner) availableDocumentTypes :Array.<module:model/SignatureType>
- Source:
Type:
- Array.<module:model/SignatureType>
(inner) containsPdfFormFields :String
- Source:
Type:
- String
(inner) display :String
- Source:
Type:
- String
(inner) displayMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates if the sender can edit the display property. Not applicable for template documents.
Type:
(inner) docGenDocumentStatus :String
- Source:
Type:
- String
(inner) docGenErrors :Array.<module:model/DocGenSyntaxError>
- Source:
Type:
- Array.<module:model/DocGenSyntaxError>
(inner) docGenFormFields :Array.<module:model/DocGenFormField>
- Source:
Type:
- Array.<module:model/DocGenFormField>
(inner) documentBase64 :String
- Source:
Type:
- String
(inner) documentFields :Array.<module:model/NameValue>
- Source:
Type:
- Array.<module:model/NameValue>
(inner) documentId :String
- Source:
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
Type:
- String
(inner) documentIdGuid :String
- Source:
Type:
- String
(inner) errorDetails :module:model/ErrorDetails
- Source:
Array or errors.
Type:
(inner) includeInDownload :String
- Source:
Type:
- String
(inner) includeInDownloadMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates if the sender can edit the includeInDownload property. Not applicable for template documents.
Type:
(inner) isDocGenDocument :String
- Source:
Type:
- String
(inner) name :String
- Source:
Type:
- String
(inner) nameMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates if the sender can edit the name property. Not applicable for template documents.
Type:
(inner) order :String
- Source:
Type:
- String
(inner) pages :Array.<module:model/Page>
- Source:
Type:
- Array.<module:model/Page>
(inner) signerMustAcknowledge :String
- Source:
Type:
- String
(inner) signerMustAcknowledgeMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates if the sender can edit the signerMustAcknowledge property. Not applicable for template documents.
Type:
(inner) sizeBytes :String
- Source:
Type:
- String
(inner) templateLocked :String
- Source:
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
Type:
- String
(inner) templateRequired :String
- Source:
When set to true, the sender may not remove the recipient. Used only when working with template recipients.
Type:
- String
(inner) type :String
- Source:
Type:
- String
(inner) uri :String
- Source:
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/EnvelopeDocument}
- Source:
Constructs a EnvelopeDocument from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/EnvelopeDocument | Optional instance to populate. |
Returns:
The populated EnvelopeDocument instance.