new module:model/CompositeTemplate()
- Source:
Constructs a new CompositeTemplate.
This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/
Members
(inner) compositeTemplateId :String
- Source:
The identify of this composite template. It is used as a reference when adding document object information. If used, the document's content-disposition must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the documentId property only. If no document object is specified, the composite template inherits the first document.
Type:
- String
(inner) document :module:model/Document
- Source:
An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.
Type:
(inner) inlineTemplates :Array.<module:model/InlineTemplate>
- Source:
Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.
Type:
- Array.<module:model/InlineTemplate>
(inner) pdfMetaDataTemplateSequence :String
- Source:
Type:
- String
(inner) serverTemplates :Array.<module:model/ServerTemplate>
- Source:
0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value
Type:
- Array.<module:model/ServerTemplate>
Methods
(static) constructFromObject(data, obj) → {module:model/CompositeTemplate}
- Source:
Constructs a CompositeTemplate 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/CompositeTemplate | Optional instance to populate. |
Returns:
The populated CompositeTemplate instance.