java.lang.Object
- com.docusign.esign.model.MergeField

```
public class MergeField
extends Object
```
Contains information for transfering values between Salesforce data fields and DocuSign Tabs..

Constructor Summary

Constructors
Constructor Description

MergeField()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MergeField`	`addPathExtendedItem(PathExtendedElement pathExtendedItem)`	addPathExtendedItem.
`MergeField`	`allowSenderToEdit(String allowSenderToEdit)`	allowSenderToEdit.
`MergeField`	`allowSenderToEditMetadata(PropertyMetadata allowSenderToEditMetadata)`	allowSenderToEditMetadata.
`MergeField`	`configurationType(String configurationType)`	configurationType.
`MergeField`	`configurationTypeMetadata(PropertyMetadata configurationTypeMetadata)`	configurationTypeMetadata.
`boolean`	`equals(Object o)`	Compares objects.
`String`	`getAllowSenderToEdit()`	When set to true, the sender can modify the value of the custom tab during the sending process..
`PropertyMetadata`	`getAllowSenderToEditMetadata()`	Metadata that indicates if the sender can edit the `allowSenderToEdit` property..
`String`	`getConfigurationType()`	If merge field's are being used, specifies the type of the merge field.
`PropertyMetadata`	`getConfigurationTypeMetadata()`	Metadata that indicates if the sender can edit the `configurationType` property..
`String`	`getPath()`	Sets the object associated with the custom tab.
`List<PathExtendedElement>`	`getPathExtended()`	.
`PropertyMetadata`	`getPathExtendedMetadata()`	Reserved for DocuSign..
`PropertyMetadata`	`getPathMetadata()`	Metadata that indicates whether the `path` property is editable.
`String`	`getRow()`	Specifies the row number in a Salesforce table that the merge field value corresponds to..
`PropertyMetadata`	`getRowMetadata()`	Metadata that indicates whether the `row` property is editable.
`String`	`getWriteBack()`	When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed..
`PropertyMetadata`	`getWriteBackMetadata()`	Metadata that indicates if the sender can edit the `writeBack` property..
`int`	`hashCode()`	Returns the HashCode.
`MergeField`	`path(String path)`	path.
`MergeField`	`pathExtended(List<PathExtendedElement> pathExtended)`	pathExtended.
`MergeField`	`pathExtendedMetadata(PropertyMetadata pathExtendedMetadata)`	pathExtendedMetadata.
`MergeField`	`pathMetadata(PropertyMetadata pathMetadata)`	pathMetadata.
`MergeField`	`row(String row)`	row.
`MergeField`	`rowMetadata(PropertyMetadata rowMetadata)`	rowMetadata.
`void`	`setAllowSenderToEdit(String allowSenderToEdit)`	setAllowSenderToEdit.
`void`	`setAllowSenderToEditMetadata(PropertyMetadata allowSenderToEditMetadata)`	setAllowSenderToEditMetadata.
`void`	`setConfigurationType(String configurationType)`	setConfigurationType.
`void`	`setConfigurationTypeMetadata(PropertyMetadata configurationTypeMetadata)`	setConfigurationTypeMetadata.
`void`	`setPath(String path)`	setPath.
`void`	`setPathExtended(List<PathExtendedElement> pathExtended)`	setPathExtended.
`void`	`setPathExtendedMetadata(PropertyMetadata pathExtendedMetadata)`	setPathExtendedMetadata.
`void`	`setPathMetadata(PropertyMetadata pathMetadata)`	setPathMetadata.
`void`	`setRow(String row)`	setRow.
`void`	`setRowMetadata(PropertyMetadata rowMetadata)`	setRowMetadata.
`void`	`setWriteBack(String writeBack)`	setWriteBack.
`void`	`setWriteBackMetadata(PropertyMetadata writeBackMetadata)`	setWriteBackMetadata.
`String`	`toString()`	Converts the given object to string.
`MergeField`	`writeBack(String writeBack)`	writeBack.
`MergeField`	`writeBackMetadata(PropertyMetadata writeBackMetadata)`	writeBackMetadata.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MergeField
```
public MergeField()
```
- Method Detail
  - allowSenderToEdit
```
public MergeField allowSenderToEdit(String allowSenderToEdit)
```
    allowSenderToEdit.
    
    Returns:
    
    MergeField
  - getAllowSenderToEdit
```
public String getAllowSenderToEdit()
```
    When set to **true**, the sender can modify the value of the custom tab during the sending process..
    
    Returns:
    
    allowSenderToEdit
  - setAllowSenderToEdit
```
public void setAllowSenderToEdit(String allowSenderToEdit)
```
    setAllowSenderToEdit.
  - allowSenderToEditMetadata
```
public MergeField allowSenderToEditMetadata(PropertyMetadata allowSenderToEditMetadata)
```
    allowSenderToEditMetadata.
    
    Returns:
    
    MergeField
  - getAllowSenderToEditMetadata
```
public PropertyMetadata getAllowSenderToEditMetadata()
```
    Metadata that indicates if the sender can edit the `allowSenderToEdit` property..
    
    Returns:
    
    allowSenderToEditMetadata
  - setAllowSenderToEditMetadata
```
public void setAllowSenderToEditMetadata(PropertyMetadata allowSenderToEditMetadata)
```
    setAllowSenderToEditMetadata.
  - configurationType
```
public MergeField configurationType(String configurationType)
```
    configurationType.
    
    Returns:
    
    MergeField
  - getConfigurationType
```
public String getConfigurationType()
```
    If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**..
    
    Returns:
    
    configurationType
  - setConfigurationType
```
public void setConfigurationType(String configurationType)
```
    setConfigurationType.
  - configurationTypeMetadata
```
public MergeField configurationTypeMetadata(PropertyMetadata configurationTypeMetadata)
```
    configurationTypeMetadata.
    
    Returns:
    
    MergeField
  - getConfigurationTypeMetadata
```
public PropertyMetadata getConfigurationTypeMetadata()
```
    Metadata that indicates if the sender can edit the `configurationType` property..
    
    Returns:
    
    configurationTypeMetadata
  - setConfigurationTypeMetadata
```
public void setConfigurationTypeMetadata(PropertyMetadata configurationTypeMetadata)
```
    setConfigurationTypeMetadata.
  - path
```
public MergeField path(String path)
```
    path.
    
    Returns:
    
    MergeField
  - getPath
```
public String getPath()
```
    Sets the object associated with the custom tab. Currently this is the Salesforce Object..
    
    Returns:
    
    path
  - setPath
```
public void setPath(String path)
```
    setPath.
  - pathExtended
```
public MergeField pathExtended(List<PathExtendedElement> pathExtended)
```
    pathExtended.
    
    Returns:
    
    MergeField
  - addPathExtendedItem
```
public MergeField addPathExtendedItem(PathExtendedElement pathExtendedItem)
```
    addPathExtendedItem.
    
    Returns:
    
    MergeField
  - getPathExtended
```
public List<PathExtendedElement> getPathExtended()
```
    .
    
    Returns:
    
    pathExtended
  - setPathExtended
```
public void setPathExtended(List<PathExtendedElement> pathExtended)
```
    setPathExtended.
  - pathExtendedMetadata
```
public MergeField pathExtendedMetadata(PropertyMetadata pathExtendedMetadata)
```
    pathExtendedMetadata.
    
    Returns:
    
    MergeField
  - getPathExtendedMetadata
```
public PropertyMetadata getPathExtendedMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    pathExtendedMetadata
  - setPathExtendedMetadata
```
public void setPathExtendedMetadata(PropertyMetadata pathExtendedMetadata)
```
    setPathExtendedMetadata.
  - pathMetadata
```
public MergeField pathMetadata(PropertyMetadata pathMetadata)
```
    pathMetadata.
    
    Returns:
    
    MergeField
  - getPathMetadata
```
public PropertyMetadata getPathMetadata()
```
    Metadata that indicates whether the `path` property is editable. .
    
    Returns:
    
    pathMetadata
  - setPathMetadata
```
public void setPathMetadata(PropertyMetadata pathMetadata)
```
    setPathMetadata.
  - row
```
public MergeField row(String row)
```
    row.
    
    Returns:
    
    MergeField
  - getRow
```
public String getRow()
```
    Specifies the row number in a Salesforce table that the merge field value corresponds to..
    
    Returns:
    
    row
  - setRow
```
public void setRow(String row)
```
    setRow.
  - rowMetadata
```
public MergeField rowMetadata(PropertyMetadata rowMetadata)
```
    rowMetadata.
    
    Returns:
    
    MergeField
  - getRowMetadata
```
public PropertyMetadata getRowMetadata()
```
    Metadata that indicates whether the `row` property is editable. .
    
    Returns:
    
    rowMetadata
  - setRowMetadata
```
public void setRowMetadata(PropertyMetadata rowMetadata)
```
    setRowMetadata.
  - writeBack
```
public MergeField writeBack(String writeBack)
```
    writeBack.
    
    Returns:
    
    MergeField
  - getWriteBack
```
public String getWriteBack()
```
    When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed..
    
    Returns:
    
    writeBack
  - setWriteBack
```
public void setWriteBack(String writeBack)
```
    setWriteBack.
  - writeBackMetadata
```
public MergeField writeBackMetadata(PropertyMetadata writeBackMetadata)
```
    writeBackMetadata.
    
    Returns:
    
    MergeField
  - getWriteBackMetadata
```
public PropertyMetadata getWriteBackMetadata()
```
    Metadata that indicates if the sender can edit the `writeBack` property..
    
    Returns:
    
    writeBackMetadata
  - setWriteBackMetadata
```
public void setWriteBackMetadata(PropertyMetadata writeBackMetadata)
```
    setWriteBackMetadata.
  - equals
```
public boolean equals(Object o)
```
    Compares objects.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true or false depending on comparison result.
  - hashCode
```
public int hashCode()
```
    Returns the HashCode.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Converts the given object to string.
    
    Overrides:
    
    toString in class Object

Class MergeField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MergeField

Method Detail

allowSenderToEdit

getAllowSenderToEdit

setAllowSenderToEdit

allowSenderToEditMetadata

getAllowSenderToEditMetadata

setAllowSenderToEditMetadata

configurationType

getConfigurationType

setConfigurationType

configurationTypeMetadata

getConfigurationTypeMetadata

setConfigurationTypeMetadata

path

getPath

setPath

pathExtended

addPathExtendedItem

getPathExtended

setPathExtended

pathExtendedMetadata

getPathExtendedMetadata

setPathExtendedMetadata

pathMetadata

getPathMetadata

setPathMetadata

row

getRow

setRow

rowMetadata

getRowMetadata

setRowMetadata

writeBack

getWriteBack

setWriteBack

writeBackMetadata

getWriteBackMetadata

setWriteBackMetadata

equals

hashCode

toString