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

public class SignerAttachment
extends Object

SignerAttachment.

Constructor Summary

Constructors
Constructor Description

SignerAttachment()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SignerAttachment`	`addTabGroupLabelsItem(String tabGroupLabelsItem)`	addTabGroupLabelsItem.
`SignerAttachment`	`anchorCaseSensitive(String anchorCaseSensitive)`	anchorCaseSensitive.
`SignerAttachment`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`	anchorHorizontalAlignment.
`SignerAttachment`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`	anchorIgnoreIfNotPresent.
`SignerAttachment`	`anchorMatchWholeWord(String anchorMatchWholeWord)`	anchorMatchWholeWord.
`SignerAttachment`	`anchorString(String anchorString)`	anchorString.
`SignerAttachment`	`anchorUnits(String anchorUnits)`	anchorUnits.
`SignerAttachment`	`anchorXOffset(String anchorXOffset)`	anchorXOffset.
`SignerAttachment`	`anchorYOffset(String anchorYOffset)`	anchorYOffset.
`SignerAttachment`	`conditionalParentLabel(String conditionalParentLabel)`	conditionalParentLabel.
`SignerAttachment`	`conditionalParentValue(String conditionalParentValue)`	conditionalParentValue.
`SignerAttachment`	`customTabId(String customTabId)`	customTabId.
`SignerAttachment`	`documentId(String documentId)`	documentId.
`boolean`	`equals(Object o)`	Compares objects.
`SignerAttachment`	`errorDetails(ErrorDetails errorDetails)`	errorDetails.
`String`	`getAnchorCaseSensitive()`	When set to true, the anchor string does not consider case when matching strings in the document.
`String`	`getAnchorHorizontalAlignment()`	Specifies the alignment of anchor tabs with anchor strings.
`String`	`getAnchorIgnoreIfNotPresent()`	When set to true, this tab is ignored if anchorString is not found in the document..
`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..
`String`	`getAnchorString()`	Anchor text information for a radio button..
`String`	`getAnchorUnits()`	Specifies units of the X and Y offset.
`String`	`getAnchorXOffset()`	Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
`String`	`getAnchorYOffset()`	Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..
`String`	`getConditionalParentLabel()`	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..
`String`	`getConditionalParentValue()`	For conditional fields, this is the value of the parent tab that controls the tab's visibility.
`String`	`getCustomTabId()`	The DocuSign generated custom tab ID for the custom tab to be applied.
`String`	`getDocumentId()`	Specifies the document ID number that the tab is placed on.
`ErrorDetails`	`getErrorDetails()`	Get errorDetails.
`MergeField`	`getMergeField()`	Get mergeField.
`String`	`getName()`	.
`String`	`getOptional()`	.
`String`	`getPageNumber()`	Specifies the page number on which the tab is located..
`String`	`getRecipientId()`	Unique for the recipient.
`String`	`getScaleValue()`	.
`String`	`getStatus()`	Indicates the envelope status.
`List<String>`	`getTabGroupLabels()`	.
`String`	`getTabId()`	The unique identifier for the tab.
`String`	`getTabLabel()`	The label string associated with the tab..
`String`	`getTabOrder()`	.
`String`	`getTemplateLocked()`	When set to true, the sender cannot change any attributes of the recipient.
`String`	`getTemplateRequired()`	When set to true, the sender may not remove the recipient.
`String`	`getTooltip()`	.
`String`	`getXPosition()`	This indicates the horizontal offset of the object on the page.
`String`	`getYPosition()`	This indicates the vertical offset of the object on the page.
`int`	`hashCode()`	Returns the HashCode.
`SignerAttachment`	`mergeField(MergeField mergeField)`	mergeField.
`SignerAttachment`	`name(String name)`	name.
`SignerAttachment`	`optional(String optional)`	optional.
`SignerAttachment`	`pageNumber(String pageNumber)`	pageNumber.
`SignerAttachment`	`recipientId(String recipientId)`	recipientId.
`SignerAttachment`	`scaleValue(String scaleValue)`	scaleValue.
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`	setAnchorCaseSensitive.
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`	setAnchorHorizontalAlignment.
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`	setAnchorIgnoreIfNotPresent.
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`	setAnchorMatchWholeWord.
`void`	`setAnchorString(String anchorString)`	setAnchorString.
`void`	`setAnchorUnits(String anchorUnits)`	setAnchorUnits.
`void`	`setAnchorXOffset(String anchorXOffset)`	setAnchorXOffset.
`void`	`setAnchorYOffset(String anchorYOffset)`	setAnchorYOffset.
`void`	`setConditionalParentLabel(String conditionalParentLabel)`	setConditionalParentLabel.
`void`	`setConditionalParentValue(String conditionalParentValue)`	setConditionalParentValue.
`void`	`setCustomTabId(String customTabId)`	setCustomTabId.
`void`	`setDocumentId(String documentId)`	setDocumentId.
`void`	`setErrorDetails(ErrorDetails errorDetails)`	setErrorDetails.
`void`	`setMergeField(MergeField mergeField)`	setMergeField.
`void`	`setName(String name)`	setName.
`void`	`setOptional(String optional)`	setOptional.
`void`	`setPageNumber(String pageNumber)`	setPageNumber.
`void`	`setRecipientId(String recipientId)`	setRecipientId.
`void`	`setScaleValue(String scaleValue)`	setScaleValue.
`void`	`setStatus(String status)`	setStatus.
`void`	`setTabGroupLabels(List<String> tabGroupLabels)`	setTabGroupLabels.
`void`	`setTabId(String tabId)`	setTabId.
`void`	`setTabLabel(String tabLabel)`	setTabLabel.
`void`	`setTabOrder(String tabOrder)`	setTabOrder.
`void`	`setTemplateLocked(String templateLocked)`	setTemplateLocked.
`void`	`setTemplateRequired(String templateRequired)`	setTemplateRequired.
`void`	`setTooltip(String tooltip)`	setTooltip.
`void`	`setXPosition(String xPosition)`	setXPosition.
`void`	`setYPosition(String yPosition)`	setYPosition.
`SignerAttachment`	`status(String status)`	status.
`SignerAttachment`	`tabGroupLabels(List<String> tabGroupLabels)`	tabGroupLabels.
`SignerAttachment`	`tabId(String tabId)`	tabId.
`SignerAttachment`	`tabLabel(String tabLabel)`	tabLabel.
`SignerAttachment`	`tabOrder(String tabOrder)`	tabOrder.
`SignerAttachment`	`templateLocked(String templateLocked)`	templateLocked.
`SignerAttachment`	`templateRequired(String templateRequired)`	templateRequired.
`SignerAttachment`	`tooltip(String tooltip)`	tooltip.
`String`	`toString()`	Converts the given object to string.
`SignerAttachment`	`xPosition(String xPosition)`	xPosition.
`SignerAttachment`	`yPosition(String yPosition)`	yPosition.

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

- Constructor Detail
  - SignerAttachment
```
public SignerAttachment()
```
- Method Detail
  - anchorCaseSensitive
```
public SignerAttachment anchorCaseSensitive(String anchorCaseSensitive)
```
    anchorCaseSensitive.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setAnchorCaseSensitive.
  - anchorHorizontalAlignment
```
public SignerAttachment anchorHorizontalAlignment(String anchorHorizontalAlignment)
```
    anchorHorizontalAlignment.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setAnchorHorizontalAlignment.
  - anchorIgnoreIfNotPresent
```
public SignerAttachment anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
    anchorIgnoreIfNotPresent.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setAnchorIgnoreIfNotPresent.
  - anchorMatchWholeWord
```
public SignerAttachment anchorMatchWholeWord(String anchorMatchWholeWord)
```
    anchorMatchWholeWord.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setAnchorMatchWholeWord.
  - anchorString
```
public SignerAttachment anchorString(String anchorString)
```
    anchorString.
    
    Returns:
    
    SignerAttachment
  - getAnchorString
```
public String getAnchorString()
```
    Anchor text information for a radio button..
    
    Returns:
    
    anchorString
  - setAnchorString
```
public void setAnchorString(String anchorString)
```
    setAnchorString.
  - anchorUnits
```
public SignerAttachment anchorUnits(String anchorUnits)
```
    anchorUnits.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setAnchorUnits.
  - anchorXOffset
```
public SignerAttachment anchorXOffset(String anchorXOffset)
```
    anchorXOffset.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setAnchorXOffset.
  - anchorYOffset
```
public SignerAttachment anchorYOffset(String anchorYOffset)
```
    anchorYOffset.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setAnchorYOffset.
  - conditionalParentLabel
```
public SignerAttachment conditionalParentLabel(String conditionalParentLabel)
```
    conditionalParentLabel.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setConditionalParentLabel.
  - conditionalParentValue
```
public SignerAttachment conditionalParentValue(String conditionalParentValue)
```
    conditionalParentValue.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setConditionalParentValue.
  - customTabId
```
public SignerAttachment customTabId(String customTabId)
```
    customTabId.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setCustomTabId.
  - documentId
```
public SignerAttachment documentId(String documentId)
```
    documentId.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setDocumentId.
  - errorDetails
```
public SignerAttachment errorDetails(ErrorDetails errorDetails)
```
    errorDetails.
    
    Returns:
    
    SignerAttachment
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Get errorDetails.
    
    Returns:
    
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
    setErrorDetails.
  - mergeField
```
public SignerAttachment mergeField(MergeField mergeField)
```
    mergeField.
    
    Returns:
    
    SignerAttachment
  - getMergeField
```
public MergeField getMergeField()
```
    Get mergeField.
    
    Returns:
    
    mergeField
  - setMergeField
```
public void setMergeField(MergeField mergeField)
```
    setMergeField.
  - name
```
public SignerAttachment name(String name)
```
    name.
    
    Returns:
    
    SignerAttachment
  - getName
```
public String getName()
```
    .
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    setName.
  - optional
```
public SignerAttachment optional(String optional)
```
    optional.
    
    Returns:
    
    SignerAttachment
  - getOptional
```
public String getOptional()
```
    .
    
    Returns:
    
    optional
  - setOptional
```
public void setOptional(String optional)
```
    setOptional.
  - pageNumber
```
public SignerAttachment pageNumber(String pageNumber)
```
    pageNumber.
    
    Returns:
    
    SignerAttachment
  - getPageNumber
```
public String getPageNumber()
```
    Specifies the page number on which the tab is located..
    
    Returns:
    
    pageNumber
  - setPageNumber
```
public void setPageNumber(String pageNumber)
```
    setPageNumber.
  - recipientId
```
public SignerAttachment recipientId(String recipientId)
```
    recipientId.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setRecipientId.
  - scaleValue
```
public SignerAttachment scaleValue(String scaleValue)
```
    scaleValue.
    
    Returns:
    
    SignerAttachment
  - getScaleValue
```
public String getScaleValue()
```
    .
    
    Returns:
    
    scaleValue
  - setScaleValue
```
public void setScaleValue(String scaleValue)
```
    setScaleValue.
  - status
```
public SignerAttachment status(String status)
```
    status.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setStatus.
  - tabGroupLabels
```
public SignerAttachment tabGroupLabels(List<String> tabGroupLabels)
```
    tabGroupLabels.
    
    Returns:
    
    SignerAttachment
  - addTabGroupLabelsItem
```
public SignerAttachment addTabGroupLabelsItem(String tabGroupLabelsItem)
```
    addTabGroupLabelsItem.
    
    Returns:
    
    SignerAttachment
  - getTabGroupLabels
```
public List<String> getTabGroupLabels()
```
    .
    
    Returns:
    
    tabGroupLabels
  - setTabGroupLabels
```
public void setTabGroupLabels(List<String> tabGroupLabels)
```
    setTabGroupLabels.
  - tabId
```
public SignerAttachment tabId(String tabId)
```
    tabId.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setTabId.
  - tabLabel
```
public SignerAttachment tabLabel(String tabLabel)
```
    tabLabel.
    
    Returns:
    
    SignerAttachment
  - getTabLabel
```
public String getTabLabel()
```
    The label string associated with the tab..
    
    Returns:
    
    tabLabel
  - setTabLabel
```
public void setTabLabel(String tabLabel)
```
    setTabLabel.
  - tabOrder
```
public SignerAttachment tabOrder(String tabOrder)
```
    tabOrder.
    
    Returns:
    
    SignerAttachment
  - getTabOrder
```
public String getTabOrder()
```
    .
    
    Returns:
    
    tabOrder
  - setTabOrder
```
public void setTabOrder(String tabOrder)
```
    setTabOrder.
  - templateLocked
```
public SignerAttachment templateLocked(String templateLocked)
```
    templateLocked.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setTemplateLocked.
  - templateRequired
```
public SignerAttachment templateRequired(String templateRequired)
```
    templateRequired.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setTemplateRequired.
  - tooltip
```
public SignerAttachment tooltip(String tooltip)
```
    tooltip.
    
    Returns:
    
    SignerAttachment
  - getTooltip
```
public String getTooltip()
```
    .
    
    Returns:
    
    tooltip
  - setTooltip
```
public void setTooltip(String tooltip)
```
    setTooltip.
  - xPosition
```
public SignerAttachment xPosition(String xPosition)
```
    xPosition.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setXPosition.
  - yPosition
```
public SignerAttachment yPosition(String yPosition)
```
    yPosition.
    
    Returns:
    
    SignerAttachment
  - 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)
```
    setYPosition.
  - 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 SignerAttachment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SignerAttachment

Method Detail

anchorCaseSensitive

getAnchorCaseSensitive

setAnchorCaseSensitive

anchorHorizontalAlignment

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorMatchWholeWord

getAnchorMatchWholeWord

setAnchorMatchWholeWord

anchorString

getAnchorString

setAnchorString

anchorUnits

getAnchorUnits

setAnchorUnits

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorYOffset

getAnchorYOffset

setAnchorYOffset

conditionalParentLabel

getConditionalParentLabel

setConditionalParentLabel

conditionalParentValue

getConditionalParentValue

setConditionalParentValue

customTabId

getCustomTabId

setCustomTabId

documentId

getDocumentId

setDocumentId

errorDetails

getErrorDetails

setErrorDetails

mergeField

getMergeField

setMergeField

name

getName

setName

optional

getOptional

setOptional

pageNumber

getPageNumber

setPageNumber

recipientId

getRecipientId

setRecipientId

scaleValue

getScaleValue

setScaleValue

status

getStatus

setStatus

tabGroupLabels

addTabGroupLabelsItem

getTabGroupLabels

setTabGroupLabels

tabId

getTabId

setTabId

tabLabel

getTabLabel

setTabLabel

tabOrder

getTabOrder

setTabOrder