new module:model/EnvelopeFormData()
- Source:
Constructs a new EnvelopeFormData
.
Describes the form data of the envelope.
Members
(inner) emailSubject :String
- Source:
Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
Type:
- String
(inner) envelopeId :String
- Source:
The envelope ID of the envelope status that failed to post.
Type:
- String
(inner) formData :Array.<module:model/FormDataItem>
- Source:
Type:
- Array.<module:model/FormDataItem>
(inner) prefillFormData :module:model/PrefillFormData
- Source:
An array of formDataItem
objects for prefill tabs.
Type:
(inner) recipientFormData :Array.<module:model/RecipientFormData>
- Source:
Type:
- Array.<module:model/RecipientFormData>
(inner) sentDateTime :String
- Source:
The date and time the envelope was sent.
Type:
- String
(inner) status :String
- Source:
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/EnvelopeFormData}
- Source:
Constructs a EnvelopeFormData
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/EnvelopeFormData | Optional instance to populate. |
Returns:
The populated EnvelopeFormData
instance.