module:model/Document

module:model/Document

new module:model/Document()

Source:

Constructs a new Document.
A document object.

Members

(inner) applyAnchorTabs :String

Source:

Reserved: TBD

Type:
  • String

(inner) assignTabsToRecipientId :String

Source:
Type:
  • String

(inner) display :String

Source:
Type:
  • String

(inner) docGenFormFields :Array.<module:model/DocGenFormField>

Source:
Type:

(inner) documentBase64 :String

Source:

The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.

Type:
  • String

(inner) documentFields :Array.<module:model/NameValue>

Source:
Type:

(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) encryptedWithKeyManager :String

Source:

When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.

Type:
  • String

(inner) fileExtension :String

Source:

The file extension type of the document. If the document is not a PDF it is converted to a PDF.

Type:
  • String

(inner) fileFormatHint :String

Source:
Type:
  • String

(inner) htmlDefinition :module:model/DocumentHtmlDefinition

Source:

Defines how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide.

Type:

(inner) includeInDownload :String

Source:
Type:
  • String

(inner) isDocGenDocument :String

Source:
Type:
  • String

(inner) matchBoxes :Array.<module:model/MatchBox>

Source:

Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.

Type:

(inner) name :String

Source:
Type:
  • String

(inner) order :String

Source:
Type:
  • String

(inner) pages :String

Source:
Type:
  • String

(inner) password :String

Source:
Type:
  • String

(inner) pdfFormFieldOption :String

Source:
Type:
  • String

(inner) remoteUrl :String

Source:

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}].

Type:
  • String

(inner) signerMustAcknowledge :String

Source:
Type:
  • String

(inner) signerMustAcknowledgeUseAccountDefault :Boolean

Source:
Type:
  • Boolean

(inner) tabs :module:model/Tabs

Source:

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

Type:

(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) transformPdfFields :String

Source:

When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.

Type:
  • String

(inner) uri :String

Source:
Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/Document}

Source:

Constructs a Document 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/Document

Optional instance to populate.
Returns:

The populated Document instance.

Type
module:model/Document