new module:model/MergeField()
- Source:
Constructs a new MergeField
.
Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
Members
(inner) allowSenderToEdit :String
- Source:
When set to true, the sender can modify the value of the custom tab during the sending process.
Type:
- String
(inner) allowSenderToEditMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates if the sender can edit the allowSenderToEdit
property.
Type:
(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) configurationTypeMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates if the sender can edit the configurationType
property.
Type:
(inner) path :String
- Source:
Sets the object associated with the custom tab. Currently this is the Salesforce Object.
Type:
- String
(inner) pathExtended :Array.<module:model/PathExtendedElement>
- Source:
Type:
- Array.<module:model/PathExtendedElement>
(inner) pathExtendedMetadata :module:model/PropertyMetadata
- Source:
Reserved for DocuSign.
Type:
(inner) pathMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the path
property is editable.
Type:
(inner) row :String
- Source:
Specifies the row number in a Salesforce table that the merge field value corresponds to.
Type:
- String
(inner) rowMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the row
property is editable.
Type:
(inner) writeBack :String
- Source:
When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.
Type:
- String
(inner) writeBackMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates if the sender can edit the writeBack
property.
Type:
Methods
(static) constructFromObject(data, obj) → {module:model/MergeField}
- Source:
Constructs a MergeField
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/MergeField | Optional instance to populate. |
Returns:
The populated MergeField
instance.