new module:model/TextCustomField()
- Source:
Constructs a new TextCustomField
.
This object represents a free text custom field where envelope creators and senders can enter custom data.
Members
(inner) configurationType :String
- Source:
If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.
Type:
- String
(inner) errorDetails :module:model/ErrorDetails
- Source:
Array or errors.
Type:
(inner) fieldId :String
- Source:
An ID used to specify a custom field.
Type:
- String
(inner) name :String
- Source:
The name of the custom field.
Type:
- String
(inner) required :String
- Source:
When set to true, the signer is required to fill out this tab
Type:
- String
(inner) show :String
- Source:
A boolean indicating if the value should be displayed.
Type:
- String
(inner) value :String
- Source:
The value of the custom field.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/TextCustomField}
- Source:
Constructs a TextCustomField
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/TextCustomField | Optional instance to populate. |
Returns:
The populated TextCustomField
instance.