SignerAttachment (docusign-esign-java 3.12.0 API)

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

public class SignerAttachment
extends Object

SignerAttachment

Constructor Summary

Constructors
Constructor and Description

SignerAttachment()

Constructors
Constructor and Description
`SignerAttachment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SignerAttachment`	`addTabGroupLabelsItem(String tabGroupLabelsItem)`
`SignerAttachment`	`anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)`
`SignerAttachment`	`anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)`
`SignerAttachment`	`anchorCaseSensitive(String anchorCaseSensitive)`
`SignerAttachment`	`anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)`
`SignerAttachment`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`
`SignerAttachment`	`anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)`
`SignerAttachment`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`SignerAttachment`	`anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)`
`SignerAttachment`	`anchorMatchWholeWord(String anchorMatchWholeWord)`
`SignerAttachment`	`anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)`
`SignerAttachment`	`anchorString(String anchorString)`
`SignerAttachment`	`anchorStringMetadata(PropertyMetadata anchorStringMetadata)`
`SignerAttachment`	`anchorTabProcessorVersion(String anchorTabProcessorVersion)`
`SignerAttachment`	`anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)`
`SignerAttachment`	`anchorUnits(String anchorUnits)`
`SignerAttachment`	`anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)`
`SignerAttachment`	`anchorXOffset(String anchorXOffset)`
`SignerAttachment`	`anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)`
`SignerAttachment`	`anchorYOffset(String anchorYOffset)`
`SignerAttachment`	`anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)`
`SignerAttachment`	`conditionalParentLabel(String conditionalParentLabel)`
`SignerAttachment`	`conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)`
`SignerAttachment`	`conditionalParentValue(String conditionalParentValue)`
`SignerAttachment`	`conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)`
`SignerAttachment`	`customTabId(String customTabId)`
`SignerAttachment`	`customTabIdMetadata(PropertyMetadata customTabIdMetadata)`
`SignerAttachment`	`documentId(String documentId)`
`SignerAttachment`	`documentIdMetadata(PropertyMetadata documentIdMetadata)`
`boolean`	`equals(Object o)`
`SignerAttachment`	`errorDetails(ErrorDetails errorDetails)`
`SignerAttachment`	`formOrder(String formOrder)`
`SignerAttachment`	`formOrderMetadata(PropertyMetadata formOrderMetadata)`
`SignerAttachment`	`formPageLabel(String formPageLabel)`
`SignerAttachment`	`formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)`
`SignerAttachment`	`formPageNumber(String formPageNumber)`
`SignerAttachment`	`formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)`
`String`	`getAnchorAllowWhiteSpaceInCharacters()`
`PropertyMetadata`	`getAnchorAllowWhiteSpaceInCharactersMetadata()` Get anchorAllowWhiteSpaceInCharactersMetadata
`String`	`getAnchorCaseSensitive()` When set to true, the anchor string does not consider case when matching strings in the document.
`PropertyMetadata`	`getAnchorCaseSensitiveMetadata()` Get anchorCaseSensitiveMetadata
`String`	`getAnchorHorizontalAlignment()` Specifies the alignment of anchor tabs with anchor strings.
`PropertyMetadata`	`getAnchorHorizontalAlignmentMetadata()` Get anchorHorizontalAlignmentMetadata
`String`	`getAnchorIgnoreIfNotPresent()` When set to true, this tab is ignored if anchorString is not found in the document.
`PropertyMetadata`	`getAnchorIgnoreIfNotPresentMetadata()` Get anchorIgnoreIfNotPresentMetadata
`String`	`getAnchorMatchWholeWord()` When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
`PropertyMetadata`	`getAnchorMatchWholeWordMetadata()` Get anchorMatchWholeWordMetadata
`String`	`getAnchorString()` Anchor text information for a radio button.
`PropertyMetadata`	`getAnchorStringMetadata()` Get anchorStringMetadata
`String`	`getAnchorTabProcessorVersion()`
`PropertyMetadata`	`getAnchorTabProcessorVersionMetadata()` Get anchorTabProcessorVersionMetadata
`String`	`getAnchorUnits()` Specifies units of the X and Y offset.
`PropertyMetadata`	`getAnchorUnitsMetadata()` Get anchorUnitsMetadata
`String`	`getAnchorXOffset()` Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
`PropertyMetadata`	`getAnchorXOffsetMetadata()` Get anchorXOffsetMetadata
`String`	`getAnchorYOffset()` Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
`PropertyMetadata`	`getAnchorYOffsetMetadata()` Get anchorYOffsetMetadata
`String`	`getConditionalParentLabel()` For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`PropertyMetadata`	`getConditionalParentLabelMetadata()` Get conditionalParentLabelMetadata
`String`	`getConditionalParentValue()` For conditional fields, this is the value of the parent tab that controls the tab's visibility.
`PropertyMetadata`	`getConditionalParentValueMetadata()` Get conditionalParentValueMetadata
`String`	`getCustomTabId()` The DocuSign generated custom tab ID for the custom tab to be applied.
`PropertyMetadata`	`getCustomTabIdMetadata()` Get customTabIdMetadata
`String`	`getDocumentId()` Specifies the document ID number that the tab is placed on.
`PropertyMetadata`	`getDocumentIdMetadata()` Get documentIdMetadata
`ErrorDetails`	`getErrorDetails()` Get errorDetails
`String`	`getFormOrder()`
`PropertyMetadata`	`getFormOrderMetadata()` Get formOrderMetadata
`String`	`getFormPageLabel()`
`PropertyMetadata`	`getFormPageLabelMetadata()` Get formPageLabelMetadata
`String`	`getFormPageNumber()`
`PropertyMetadata`	`getFormPageNumberMetadata()` Get formPageNumberMetadata
`String`	`getHeight()` Height of the tab in pixels.
`PropertyMetadata`	`getHeightMetadata()` Get heightMetadata
`MergeField`	`getMergeField()` Get mergeField
`String`	`getMergeFieldXml()`
`String`	`getName()`
`PropertyMetadata`	`getNameMetadata()` Get nameMetadata
`String`	`getOptional()`
`PropertyMetadata`	`getOptionalMetadata()` Get optionalMetadata
`String`	`getPageNumber()` Specifies the page number on which the tab is located.
`PropertyMetadata`	`getPageNumberMetadata()` Get pageNumberMetadata
`String`	`getRecipientId()` Unique for the recipient.
`String`	`getRecipientIdGuid()`
`PropertyMetadata`	`getRecipientIdGuidMetadata()` Get recipientIdGuidMetadata
`PropertyMetadata`	`getRecipientIdMetadata()` Get recipientIdMetadata
`String`	`getScaleValue()`
`PropertyMetadata`	`getScaleValueMetadata()` Get scaleValueMetadata
`SmartContractInformation`	`getSmartContractInformation()` Get smartContractInformation
`String`	`getSource()`
`String`	`getStatus()` Indicates the envelope status.
`PropertyMetadata`	`getStatusMetadata()` Get statusMetadata
`List<String>`	`getTabGroupLabels()`
`PropertyMetadata`	`getTabGroupLabelsMetadata()` Get tabGroupLabelsMetadata
`String`	`getTabId()` The unique identifier for the tab.
`PropertyMetadata`	`getTabIdMetadata()` Get tabIdMetadata
`String`	`getTabLabel()` The label string associated with the tab.
`PropertyMetadata`	`getTabLabelMetadata()` Get tabLabelMetadata
`String`	`getTabOrder()`
`PropertyMetadata`	`getTabOrderMetadata()` Get tabOrderMetadata
`String`	`getTabType()`
`PropertyMetadata`	`getTabTypeMetadata()` Get tabTypeMetadata
`String`	`getTemplateLocked()` When set to true, the sender cannot change any attributes of the recipient.
`PropertyMetadata`	`getTemplateLockedMetadata()` Get templateLockedMetadata
`String`	`getTemplateRequired()` When set to true, the sender may not remove the recipient.
`PropertyMetadata`	`getTemplateRequiredMetadata()` Get templateRequiredMetadata
`String`	`getTooltip()`
`PropertyMetadata`	`getToolTipMetadata()` Get toolTipMetadata
`String`	`getWidth()` Width of the tab in pixels.
`PropertyMetadata`	`getWidthMetadata()` Get widthMetadata
`String`	`getXPosition()` This indicates the horizontal offset of the object on the page.
`PropertyMetadata`	`getXPositionMetadata()` Get xPositionMetadata
`String`	`getYPosition()` This indicates the vertical offset of the object on the page.
`PropertyMetadata`	`getYPositionMetadata()` Get yPositionMetadata
`int`	`hashCode()`
`SignerAttachment`	`height(String height)`
`SignerAttachment`	`heightMetadata(PropertyMetadata heightMetadata)`
`SignerAttachment`	`mergeField(MergeField mergeField)`
`SignerAttachment`	`mergeFieldXml(String mergeFieldXml)`
`SignerAttachment`	`name(String name)`
`SignerAttachment`	`nameMetadata(PropertyMetadata nameMetadata)`
`SignerAttachment`	`optional(String optional)`
`SignerAttachment`	`optionalMetadata(PropertyMetadata optionalMetadata)`
`SignerAttachment`	`pageNumber(String pageNumber)`
`SignerAttachment`	`pageNumberMetadata(PropertyMetadata pageNumberMetadata)`
`SignerAttachment`	`recipientId(String recipientId)`
`SignerAttachment`	`recipientIdGuid(String recipientIdGuid)`
`SignerAttachment`	`recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)`
`SignerAttachment`	`recipientIdMetadata(PropertyMetadata recipientIdMetadata)`
`SignerAttachment`	`scaleValue(String scaleValue)`
`SignerAttachment`	`scaleValueMetadata(PropertyMetadata scaleValueMetadata)`
`void`	`setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)`
`void`	`setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)`
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`
`void`	`setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)`
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`
`void`	`setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)`
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`void`	`setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)`
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`
`void`	`setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)`
`void`	`setAnchorString(String anchorString)`
`void`	`setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)`
`void`	`setAnchorTabProcessorVersion(String anchorTabProcessorVersion)`
`void`	`setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)`
`void`	`setAnchorUnits(String anchorUnits)`
`void`	`setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)`
`void`	`setAnchorXOffset(String anchorXOffset)`
`void`	`setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)`
`void`	`setAnchorYOffset(String anchorYOffset)`
`void`	`setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)`
`void`	`setConditionalParentLabel(String conditionalParentLabel)`
`void`	`setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)`
`void`	`setConditionalParentValue(String conditionalParentValue)`
`void`	`setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)`
`void`	`setDocumentId(String documentId)`
`void`	`setDocumentIdMetadata(PropertyMetadata documentIdMetadata)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFormOrder(String formOrder)`
`void`	`setFormOrderMetadata(PropertyMetadata formOrderMetadata)`
`void`	`setFormPageLabel(String formPageLabel)`
`void`	`setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)`
`void`	`setFormPageNumber(String formPageNumber)`
`void`	`setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)`
`void`	`setHeight(String height)`
`void`	`setHeightMetadata(PropertyMetadata heightMetadata)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setMergeFieldXml(String mergeFieldXml)`
`void`	`setName(String name)`
`void`	`setNameMetadata(PropertyMetadata nameMetadata)`
`void`	`setOptional(String optional)`
`void`	`setOptionalMetadata(PropertyMetadata optionalMetadata)`
`void`	`setPageNumber(String pageNumber)`
`void`	`setPageNumberMetadata(PropertyMetadata pageNumberMetadata)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRecipientIdGuid(String recipientIdGuid)`
`void`	`setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)`
`void`	`setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)`
`void`	`setScaleValue(String scaleValue)`
`void`	`setScaleValueMetadata(PropertyMetadata scaleValueMetadata)`
`void`	`setSmartContractInformation(SmartContractInformation smartContractInformation)`
`void`	`setSource(String source)`
`void`	`setStatus(String status)`
`void`	`setStatusMetadata(PropertyMetadata statusMetadata)`
`void`	`setTabGroupLabels(List<String> tabGroupLabels)`
`void`	`setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)`
`void`	`setTabId(String tabId)`
`void`	`setTabIdMetadata(PropertyMetadata tabIdMetadata)`
`void`	`setTabLabel(String tabLabel)`
`void`	`setTabLabelMetadata(PropertyMetadata tabLabelMetadata)`
`void`	`setTabOrder(String tabOrder)`
`void`	`setTabOrderMetadata(PropertyMetadata tabOrderMetadata)`
`void`	`setTabType(String tabType)`
`void`	`setTabTypeMetadata(PropertyMetadata tabTypeMetadata)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)`
`void`	`setTooltip(String tooltip)`
`void`	`setToolTipMetadata(PropertyMetadata toolTipMetadata)`
`void`	`setWidth(String width)`
`void`	`setWidthMetadata(PropertyMetadata widthMetadata)`
`void`	`setXPosition(String xPosition)`
`void`	`setXPositionMetadata(PropertyMetadata xPositionMetadata)`
`void`	`setYPosition(String yPosition)`
`void`	`setYPositionMetadata(PropertyMetadata yPositionMetadata)`
`SignerAttachment`	`smartContractInformation(SmartContractInformation smartContractInformation)`
`SignerAttachment`	`source(String source)`
`SignerAttachment`	`status(String status)`
`SignerAttachment`	`statusMetadata(PropertyMetadata statusMetadata)`
`SignerAttachment`	`tabGroupLabels(List<String> tabGroupLabels)`
`SignerAttachment`	`tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)`
`SignerAttachment`	`tabId(String tabId)`
`SignerAttachment`	`tabIdMetadata(PropertyMetadata tabIdMetadata)`
`SignerAttachment`	`tabLabel(String tabLabel)`
`SignerAttachment`	`tabLabelMetadata(PropertyMetadata tabLabelMetadata)`
`SignerAttachment`	`tabOrder(String tabOrder)`
`SignerAttachment`	`tabOrderMetadata(PropertyMetadata tabOrderMetadata)`
`SignerAttachment`	`tabType(String tabType)`
`SignerAttachment`	`tabTypeMetadata(PropertyMetadata tabTypeMetadata)`
`SignerAttachment`	`templateLocked(String templateLocked)`
`SignerAttachment`	`templateLockedMetadata(PropertyMetadata templateLockedMetadata)`
`SignerAttachment`	`templateRequired(String templateRequired)`
`SignerAttachment`	`templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)`
`SignerAttachment`	`tooltip(String tooltip)`
`SignerAttachment`	`toolTipMetadata(PropertyMetadata toolTipMetadata)`
`String`	`toString()`
`SignerAttachment`	`width(String width)`
`SignerAttachment`	`widthMetadata(PropertyMetadata widthMetadata)`
`SignerAttachment`	`xPosition(String xPosition)`
`SignerAttachment`	`xPositionMetadata(PropertyMetadata xPositionMetadata)`
`SignerAttachment`	`yPosition(String yPosition)`
`SignerAttachment`	`yPositionMetadata(PropertyMetadata yPositionMetadata)`

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

Constructor Detail
- SignerAttachment
```
public SignerAttachment()
```

Method Detail

anchorAllowWhiteSpaceInCharacters

public SignerAttachment anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)

getAnchorAllowWhiteSpaceInCharacters
```
public String getAnchorAllowWhiteSpaceInCharacters()
```
Returns:

anchorAllowWhiteSpaceInCharacters

setAnchorAllowWhiteSpaceInCharacters

public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)

anchorAllowWhiteSpaceInCharactersMetadata

public SignerAttachment anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)

getAnchorAllowWhiteSpaceInCharactersMetadata
```
public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
```
Get anchorAllowWhiteSpaceInCharactersMetadata

Returns:

anchorAllowWhiteSpaceInCharactersMetadata

setAnchorAllowWhiteSpaceInCharactersMetadata

public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)

anchorCaseSensitive

public SignerAttachment anchorCaseSensitive(String anchorCaseSensitive)

getAnchorCaseSensitive
```
public String getAnchorCaseSensitive()
```
When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.

Returns:

anchorCaseSensitive

setAnchorCaseSensitive

public void setAnchorCaseSensitive(String anchorCaseSensitive)

anchorCaseSensitiveMetadata

public SignerAttachment anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)

getAnchorCaseSensitiveMetadata
```
public PropertyMetadata getAnchorCaseSensitiveMetadata()
```
Get anchorCaseSensitiveMetadata

Returns:

anchorCaseSensitiveMetadata

setAnchorCaseSensitiveMetadata

public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)

anchorHorizontalAlignment

public SignerAttachment anchorHorizontalAlignment(String anchorHorizontalAlignment)

getAnchorHorizontalAlignment
```
public String getAnchorHorizontalAlignment()
```
Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.

Returns:

anchorHorizontalAlignment

setAnchorHorizontalAlignment

public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)

anchorHorizontalAlignmentMetadata

public SignerAttachment anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)

getAnchorHorizontalAlignmentMetadata
```
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
```
Get anchorHorizontalAlignmentMetadata

Returns:

anchorHorizontalAlignmentMetadata

setAnchorHorizontalAlignmentMetadata

public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)

anchorIgnoreIfNotPresent

public SignerAttachment anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)

getAnchorIgnoreIfNotPresent
```
public String getAnchorIgnoreIfNotPresent()
```
When set to **true**, this tab is ignored if anchorString is not found in the document.

Returns:

anchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)

anchorIgnoreIfNotPresentMetadata

public SignerAttachment anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

getAnchorIgnoreIfNotPresentMetadata
```
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
```
Get anchorIgnoreIfNotPresentMetadata

Returns:

anchorIgnoreIfNotPresentMetadata

setAnchorIgnoreIfNotPresentMetadata

public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

anchorMatchWholeWord

public SignerAttachment anchorMatchWholeWord(String anchorMatchWholeWord)

getAnchorMatchWholeWord
```
public String getAnchorMatchWholeWord()
```
When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.

Returns:

anchorMatchWholeWord

setAnchorMatchWholeWord

public void setAnchorMatchWholeWord(String anchorMatchWholeWord)

anchorMatchWholeWordMetadata

public SignerAttachment anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)

getAnchorMatchWholeWordMetadata
```
public PropertyMetadata getAnchorMatchWholeWordMetadata()
```
Get anchorMatchWholeWordMetadata

Returns:

anchorMatchWholeWordMetadata

setAnchorMatchWholeWordMetadata

public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)

anchorString

public SignerAttachment anchorString(String anchorString)

getAnchorString
```
public String getAnchorString()
```
Anchor text information for a radio button.

Returns:

anchorString

setAnchorString

public void setAnchorString(String anchorString)

anchorStringMetadata

public SignerAttachment anchorStringMetadata(PropertyMetadata anchorStringMetadata)

getAnchorStringMetadata
```
public PropertyMetadata getAnchorStringMetadata()
```
Get anchorStringMetadata

Returns:

anchorStringMetadata

setAnchorStringMetadata

public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)

anchorTabProcessorVersion

public SignerAttachment anchorTabProcessorVersion(String anchorTabProcessorVersion)

getAnchorTabProcessorVersion
```
public String getAnchorTabProcessorVersion()
```
Returns:

anchorTabProcessorVersion

setAnchorTabProcessorVersion

public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)

anchorTabProcessorVersionMetadata

public SignerAttachment anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)

getAnchorTabProcessorVersionMetadata
```
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
```
Get anchorTabProcessorVersionMetadata

Returns:

anchorTabProcessorVersionMetadata

setAnchorTabProcessorVersionMetadata

public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)

anchorUnits

public SignerAttachment anchorUnits(String anchorUnits)

getAnchorUnits
```
public String getAnchorUnits()
```
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

Returns:

anchorUnits

setAnchorUnits

public void setAnchorUnits(String anchorUnits)

anchorUnitsMetadata

public SignerAttachment anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)

getAnchorUnitsMetadata
```
public PropertyMetadata getAnchorUnitsMetadata()
```
Get anchorUnitsMetadata

Returns:

anchorUnitsMetadata

setAnchorUnitsMetadata

public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)

anchorXOffset

public SignerAttachment anchorXOffset(String anchorXOffset)

getAnchorXOffset
```
public String getAnchorXOffset()
```
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.

Returns:

anchorXOffset

setAnchorXOffset

public void setAnchorXOffset(String anchorXOffset)

anchorXOffsetMetadata

public SignerAttachment anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)

getAnchorXOffsetMetadata
```
public PropertyMetadata getAnchorXOffsetMetadata()
```
Get anchorXOffsetMetadata

Returns:

anchorXOffsetMetadata

setAnchorXOffsetMetadata

public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)

anchorYOffset

public SignerAttachment anchorYOffset(String anchorYOffset)

getAnchorYOffset
```
public String getAnchorYOffset()
```
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.

Returns:

anchorYOffset

setAnchorYOffset

public void setAnchorYOffset(String anchorYOffset)

anchorYOffsetMetadata

public SignerAttachment anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)

getAnchorYOffsetMetadata
```
public PropertyMetadata getAnchorYOffsetMetadata()
```
Get anchorYOffsetMetadata

Returns:

anchorYOffsetMetadata

setAnchorYOffsetMetadata

public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)

conditionalParentLabel

public SignerAttachment conditionalParentLabel(String conditionalParentLabel)

getConditionalParentLabel
```
public String getConditionalParentLabel()
```
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

Returns:

conditionalParentLabel

setConditionalParentLabel

public void setConditionalParentLabel(String conditionalParentLabel)

conditionalParentLabelMetadata

public SignerAttachment conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

getConditionalParentLabelMetadata
```
public PropertyMetadata getConditionalParentLabelMetadata()
```
Get conditionalParentLabelMetadata

Returns:

conditionalParentLabelMetadata

setConditionalParentLabelMetadata

public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

conditionalParentValue

public SignerAttachment conditionalParentValue(String conditionalParentValue)

getConditionalParentValue
```
public String getConditionalParentValue()
```
For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.

Returns:

conditionalParentValue

setConditionalParentValue

public void setConditionalParentValue(String conditionalParentValue)

conditionalParentValueMetadata

public SignerAttachment conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

getConditionalParentValueMetadata
```
public PropertyMetadata getConditionalParentValueMetadata()
```
Get conditionalParentValueMetadata

Returns:

conditionalParentValueMetadata

setConditionalParentValueMetadata

public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

customTabId

public SignerAttachment customTabId(String customTabId)

getCustomTabId
```
public String getCustomTabId()
```
The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

Returns:

customTabId

setCustomTabId

public void setCustomTabId(String customTabId)

customTabIdMetadata

public SignerAttachment customTabIdMetadata(PropertyMetadata customTabIdMetadata)

getCustomTabIdMetadata
```
public PropertyMetadata getCustomTabIdMetadata()
```
Get customTabIdMetadata

Returns:

customTabIdMetadata

setCustomTabIdMetadata

public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)

documentId

public SignerAttachment documentId(String documentId)

getDocumentId
```
public String getDocumentId()
```
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

documentIdMetadata

public SignerAttachment documentIdMetadata(PropertyMetadata documentIdMetadata)

getDocumentIdMetadata
```
public PropertyMetadata getDocumentIdMetadata()
```
Get documentIdMetadata

Returns:

documentIdMetadata

setDocumentIdMetadata

public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)

errorDetails

public SignerAttachment errorDetails(ErrorDetails errorDetails)

getErrorDetails
```
public ErrorDetails getErrorDetails()
```
Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

formOrder

public SignerAttachment formOrder(String formOrder)

getFormOrder
```
public String getFormOrder()
```
Returns:

formOrder

setFormOrder

public void setFormOrder(String formOrder)

formOrderMetadata

public SignerAttachment formOrderMetadata(PropertyMetadata formOrderMetadata)

getFormOrderMetadata
```
public PropertyMetadata getFormOrderMetadata()
```
Get formOrderMetadata

Returns:

formOrderMetadata

setFormOrderMetadata

public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)

formPageLabel

public SignerAttachment formPageLabel(String formPageLabel)

getFormPageLabel
```
public String getFormPageLabel()
```
Returns:

formPageLabel

setFormPageLabel

public void setFormPageLabel(String formPageLabel)

formPageLabelMetadata

public SignerAttachment formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)

getFormPageLabelMetadata
```
public PropertyMetadata getFormPageLabelMetadata()
```
Get formPageLabelMetadata

Returns:

formPageLabelMetadata

setFormPageLabelMetadata

public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)

formPageNumber

public SignerAttachment formPageNumber(String formPageNumber)

getFormPageNumber
```
public String getFormPageNumber()
```
Returns:

formPageNumber

setFormPageNumber

public void setFormPageNumber(String formPageNumber)

formPageNumberMetadata

public SignerAttachment formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)

getFormPageNumberMetadata
```
public PropertyMetadata getFormPageNumberMetadata()
```
Get formPageNumberMetadata

Returns:

formPageNumberMetadata

setFormPageNumberMetadata

public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)

height

public SignerAttachment height(String height)

getHeight
```
public String getHeight()
```
Height of the tab in pixels.

Returns:

height

setHeight
```
public void setHeight(String height)
```

heightMetadata

public SignerAttachment heightMetadata(PropertyMetadata heightMetadata)

getHeightMetadata
```
public PropertyMetadata getHeightMetadata()
```
Get heightMetadata

Returns:

heightMetadata

setHeightMetadata

public void setHeightMetadata(PropertyMetadata heightMetadata)

mergeField

public SignerAttachment mergeField(MergeField mergeField)

getMergeField
```
public MergeField getMergeField()
```
Get mergeField

Returns:

mergeField

setMergeField

public void setMergeField(MergeField mergeField)

mergeFieldXml

public SignerAttachment mergeFieldXml(String mergeFieldXml)

getMergeFieldXml
```
public String getMergeFieldXml()
```
Returns:

mergeFieldXml

setMergeFieldXml

public void setMergeFieldXml(String mergeFieldXml)

name

public SignerAttachment name(String name)

getName
```
public String getName()
```
Returns:

name

setName
```
public void setName(String name)
```

nameMetadata

public SignerAttachment nameMetadata(PropertyMetadata nameMetadata)

getNameMetadata
```
public PropertyMetadata getNameMetadata()
```
Get nameMetadata

Returns:

nameMetadata

setNameMetadata

public void setNameMetadata(PropertyMetadata nameMetadata)

optional

public SignerAttachment optional(String optional)

getOptional
```
public String getOptional()
```
Returns:

optional

setOptional

public void setOptional(String optional)

optionalMetadata

public SignerAttachment optionalMetadata(PropertyMetadata optionalMetadata)

getOptionalMetadata
```
public PropertyMetadata getOptionalMetadata()
```
Get optionalMetadata

Returns:

optionalMetadata

setOptionalMetadata

public void setOptionalMetadata(PropertyMetadata optionalMetadata)

pageNumber

public SignerAttachment pageNumber(String pageNumber)

getPageNumber
```
public String getPageNumber()
```
Specifies the page number on which the tab is located.

Returns:

pageNumber

setPageNumber

public void setPageNumber(String pageNumber)

pageNumberMetadata

public SignerAttachment pageNumberMetadata(PropertyMetadata pageNumberMetadata)

getPageNumberMetadata
```
public PropertyMetadata getPageNumberMetadata()
```
Get pageNumberMetadata

Returns:

pageNumberMetadata

setPageNumberMetadata

public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)

recipientId

public SignerAttachment recipientId(String recipientId)

getRecipientId
```
public String getRecipientId()
```
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Returns:

recipientId

setRecipientId

public void setRecipientId(String recipientId)

recipientIdGuid

public SignerAttachment recipientIdGuid(String recipientIdGuid)

getRecipientIdGuid
```
public String getRecipientIdGuid()
```
Returns:

recipientIdGuid

setRecipientIdGuid

public void setRecipientIdGuid(String recipientIdGuid)

recipientIdGuidMetadata

public SignerAttachment recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

getRecipientIdGuidMetadata
```
public PropertyMetadata getRecipientIdGuidMetadata()
```
Get recipientIdGuidMetadata

Returns:

recipientIdGuidMetadata

setRecipientIdGuidMetadata

public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

recipientIdMetadata

public SignerAttachment recipientIdMetadata(PropertyMetadata recipientIdMetadata)

getRecipientIdMetadata
```
public PropertyMetadata getRecipientIdMetadata()
```
Get recipientIdMetadata

Returns:

recipientIdMetadata

setRecipientIdMetadata

public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)

scaleValue

public SignerAttachment scaleValue(String scaleValue)

getScaleValue
```
public String getScaleValue()
```
Returns:

scaleValue

setScaleValue

public void setScaleValue(String scaleValue)

scaleValueMetadata

public SignerAttachment scaleValueMetadata(PropertyMetadata scaleValueMetadata)

getScaleValueMetadata
```
public PropertyMetadata getScaleValueMetadata()
```
Get scaleValueMetadata

Returns:

scaleValueMetadata

setScaleValueMetadata

public void setScaleValueMetadata(PropertyMetadata scaleValueMetadata)

smartContractInformation

public SignerAttachment smartContractInformation(SmartContractInformation smartContractInformation)

getSmartContractInformation
```
public SmartContractInformation getSmartContractInformation()
```
Get smartContractInformation

Returns:

smartContractInformation

setSmartContractInformation

public void setSmartContractInformation(SmartContractInformation smartContractInformation)

source

public SignerAttachment source(String source)

getSource
```
public String getSource()
```
Returns:

source

setSource
```
public void setSource(String source)
```

status

public SignerAttachment status(String status)

getStatus
```
public String getStatus()
```
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.

Returns:

status

setStatus
```
public void setStatus(String status)
```

statusMetadata

public SignerAttachment statusMetadata(PropertyMetadata statusMetadata)

getStatusMetadata
```
public PropertyMetadata getStatusMetadata()
```
Get statusMetadata

Returns:

statusMetadata

setStatusMetadata

public void setStatusMetadata(PropertyMetadata statusMetadata)

tabGroupLabels

public SignerAttachment tabGroupLabels(List<String> tabGroupLabels)

addTabGroupLabelsItem

public SignerAttachment addTabGroupLabelsItem(String tabGroupLabelsItem)

getTabGroupLabels

public List<String> getTabGroupLabels()

Returns:: tabGroupLabels

setTabGroupLabels

public void setTabGroupLabels(List<String> tabGroupLabels)

tabGroupLabelsMetadata

public SignerAttachment tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)

getTabGroupLabelsMetadata
```
public PropertyMetadata getTabGroupLabelsMetadata()
```
Get tabGroupLabelsMetadata

Returns:

tabGroupLabelsMetadata

setTabGroupLabelsMetadata

public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)

tabId

public SignerAttachment tabId(String tabId)

getTabId
```
public String getTabId()
```
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].

Returns:

tabId

setTabId
```
public void setTabId(String tabId)
```

tabIdMetadata

public SignerAttachment tabIdMetadata(PropertyMetadata tabIdMetadata)

getTabIdMetadata
```
public PropertyMetadata getTabIdMetadata()
```
Get tabIdMetadata

Returns:

tabIdMetadata

setTabIdMetadata

public void setTabIdMetadata(PropertyMetadata tabIdMetadata)

tabLabel

public SignerAttachment tabLabel(String tabLabel)

getTabLabel
```
public String getTabLabel()
```
The label string associated with the tab.

Returns:

tabLabel

setTabLabel

public void setTabLabel(String tabLabel)

tabLabelMetadata

public SignerAttachment tabLabelMetadata(PropertyMetadata tabLabelMetadata)

getTabLabelMetadata
```
public PropertyMetadata getTabLabelMetadata()
```
Get tabLabelMetadata

Returns:

tabLabelMetadata

setTabLabelMetadata

public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)

tabOrder

public SignerAttachment tabOrder(String tabOrder)

getTabOrder
```
public String getTabOrder()
```
Returns:

tabOrder

setTabOrder

public void setTabOrder(String tabOrder)

tabOrderMetadata

public SignerAttachment tabOrderMetadata(PropertyMetadata tabOrderMetadata)

getTabOrderMetadata
```
public PropertyMetadata getTabOrderMetadata()
```
Get tabOrderMetadata

Returns:

tabOrderMetadata

setTabOrderMetadata

public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)

tabType

public SignerAttachment tabType(String tabType)

getTabType
```
public String getTabType()
```
Returns:

tabType

setTabType

public void setTabType(String tabType)

tabTypeMetadata

public SignerAttachment tabTypeMetadata(PropertyMetadata tabTypeMetadata)

getTabTypeMetadata
```
public PropertyMetadata getTabTypeMetadata()
```
Get tabTypeMetadata

Returns:

tabTypeMetadata

setTabTypeMetadata

public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)

templateLocked

public SignerAttachment templateLocked(String templateLocked)

getTemplateLocked
```
public String getTemplateLocked()
```
When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

Returns:

templateLocked

setTemplateLocked

public void setTemplateLocked(String templateLocked)

templateLockedMetadata

public SignerAttachment templateLockedMetadata(PropertyMetadata templateLockedMetadata)

getTemplateLockedMetadata
```
public PropertyMetadata getTemplateLockedMetadata()
```
Get templateLockedMetadata

Returns:

templateLockedMetadata

setTemplateLockedMetadata

public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)

templateRequired

public SignerAttachment templateRequired(String templateRequired)

getTemplateRequired
```
public String getTemplateRequired()
```
When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.

Returns:

templateRequired

setTemplateRequired

public void setTemplateRequired(String templateRequired)

templateRequiredMetadata

public SignerAttachment templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

getTemplateRequiredMetadata
```
public PropertyMetadata getTemplateRequiredMetadata()
```
Get templateRequiredMetadata

Returns:

templateRequiredMetadata

setTemplateRequiredMetadata

public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

tooltip

public SignerAttachment tooltip(String tooltip)

getTooltip
```
public String getTooltip()
```
Returns:

tooltip

setTooltip

public void setTooltip(String tooltip)

toolTipMetadata

public SignerAttachment toolTipMetadata(PropertyMetadata toolTipMetadata)

getToolTipMetadata
```
public PropertyMetadata getToolTipMetadata()
```
Get toolTipMetadata

Returns:

toolTipMetadata

setToolTipMetadata

public void setToolTipMetadata(PropertyMetadata toolTipMetadata)

width

public SignerAttachment width(String width)

getWidth
```
public String getWidth()
```
Width of the tab in pixels.

Returns:

width

setWidth
```
public void setWidth(String width)
```

widthMetadata

public SignerAttachment widthMetadata(PropertyMetadata widthMetadata)

getWidthMetadata
```
public PropertyMetadata getWidthMetadata()
```
Get widthMetadata

Returns:

widthMetadata

setWidthMetadata

public void setWidthMetadata(PropertyMetadata widthMetadata)

xPosition

public SignerAttachment xPosition(String xPosition)

getXPosition
```
public String getXPosition()
```
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.

Returns:

xPosition

setXPosition

public void setXPosition(String xPosition)

xPositionMetadata

public SignerAttachment xPositionMetadata(PropertyMetadata xPositionMetadata)

getXPositionMetadata
```
public PropertyMetadata getXPositionMetadata()
```
Get xPositionMetadata

Returns:

xPositionMetadata

setXPositionMetadata

public void setXPositionMetadata(PropertyMetadata xPositionMetadata)

yPosition

public SignerAttachment yPosition(String yPosition)

getYPosition
```
public String getYPosition()
```
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

Returns:

yPosition

setYPosition

public void setYPosition(String yPosition)

yPositionMetadata

public SignerAttachment yPositionMetadata(PropertyMetadata yPositionMetadata)

getYPositionMetadata
```
public PropertyMetadata getYPositionMetadata()
```
Get yPositionMetadata

Returns:

yPositionMetadata

setYPositionMetadata

public void setYPositionMetadata(PropertyMetadata yPositionMetadata)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class SignerAttachment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SignerAttachment

Method Detail

anchorAllowWhiteSpaceInCharacters

getAnchorAllowWhiteSpaceInCharacters

setAnchorAllowWhiteSpaceInCharacters

anchorAllowWhiteSpaceInCharactersMetadata

getAnchorAllowWhiteSpaceInCharactersMetadata

setAnchorAllowWhiteSpaceInCharactersMetadata

anchorCaseSensitive

getAnchorCaseSensitive

setAnchorCaseSensitive

anchorCaseSensitiveMetadata

getAnchorCaseSensitiveMetadata

setAnchorCaseSensitiveMetadata

anchorHorizontalAlignment

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

anchorHorizontalAlignmentMetadata

getAnchorHorizontalAlignmentMetadata

setAnchorHorizontalAlignmentMetadata

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorIgnoreIfNotPresentMetadata

getAnchorIgnoreIfNotPresentMetadata

setAnchorIgnoreIfNotPresentMetadata

anchorMatchWholeWord

getAnchorMatchWholeWord

setAnchorMatchWholeWord

anchorMatchWholeWordMetadata

getAnchorMatchWholeWordMetadata

setAnchorMatchWholeWordMetadata

anchorString

getAnchorString

setAnchorString

anchorStringMetadata

getAnchorStringMetadata

setAnchorStringMetadata

anchorTabProcessorVersion

getAnchorTabProcessorVersion

setAnchorTabProcessorVersion

anchorTabProcessorVersionMetadata

getAnchorTabProcessorVersionMetadata

setAnchorTabProcessorVersionMetadata

anchorUnits

getAnchorUnits

setAnchorUnits

anchorUnitsMetadata

getAnchorUnitsMetadata

setAnchorUnitsMetadata

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorXOffsetMetadata

getAnchorXOffsetMetadata

setAnchorXOffsetMetadata

anchorYOffset

getAnchorYOffset

setAnchorYOffset

anchorYOffsetMetadata

getAnchorYOffsetMetadata

setAnchorYOffsetMetadata

conditionalParentLabel

getConditionalParentLabel

setConditionalParentLabel

conditionalParentLabelMetadata

getConditionalParentLabelMetadata

setConditionalParentLabelMetadata

conditionalParentValue

getConditionalParentValue

setConditionalParentValue

conditionalParentValueMetadata

getConditionalParentValueMetadata

setConditionalParentValueMetadata

customTabId