Package com.docusign.esign.model
Class FirstName
- java.lang.Object
-
- com.docusign.esign.model.FirstName
-
- All Implemented Interfaces:
Serializable
public class FirstName extends Object implements Serializable
A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. .- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description FirstName()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FirstName
addTabGroupLabelsItem(String tabGroupLabelsItem)
addTabGroupLabelsItem.FirstName
agreementAttribute(String agreementAttribute)
agreementAttribute.FirstName
agreementAttributeLocked(String agreementAttributeLocked)
agreementAttributeLocked.FirstName
anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.FirstName
anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.FirstName
anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.FirstName
anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.FirstName
anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.FirstName
anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.FirstName
anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.FirstName
anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.FirstName
anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.FirstName
anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.FirstName
anchorString(String anchorString)
anchorString.FirstName
anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.FirstName
anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.FirstName
anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.FirstName
anchorUnits(String anchorUnits)
anchorUnits.FirstName
anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.FirstName
anchorXOffset(String anchorXOffset)
anchorXOffset.FirstName
anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.FirstName
anchorYOffset(String anchorYOffset)
anchorYOffset.FirstName
anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.FirstName
bold(String bold)
bold.FirstName
boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.FirstName
caption(String caption)
caption.FirstName
captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.FirstName
conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.FirstName
conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
conditionalParentLabelMetadata.FirstName
conditionalParentValue(String conditionalParentValue)
conditionalParentValue.FirstName
conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
conditionalParentValueMetadata.FirstName
connectedObjectDetails(ConnectedObjectDetails connectedObjectDetails)
connectedObjectDetails.FirstName
customTabId(String customTabId)
customTabId.FirstName
customTabIdMetadata(PropertyMetadata customTabIdMetadata)
customTabIdMetadata.FirstName
documentId(String documentId)
documentId.FirstName
documentIdMetadata(PropertyMetadata documentIdMetadata)
documentIdMetadata.boolean
equals(Object o)
Compares objects.FirstName
errorDetails(ErrorDetails errorDetails)
errorDetails.FirstName
extensionData(ExtensionData extensionData)
extensionData.FirstName
font(String font)
font.FirstName
fontColor(String fontColor)
fontColor.FirstName
fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.FirstName
fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.FirstName
fontSize(String fontSize)
fontSize.FirstName
fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.FirstName
formOrder(String formOrder)
formOrder.FirstName
formOrderMetadata(PropertyMetadata formOrderMetadata)
formOrderMetadata.FirstName
formPageLabel(String formPageLabel)
formPageLabel.FirstName
formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
formPageLabelMetadata.FirstName
formPageNumber(String formPageNumber)
formPageNumber.FirstName
formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
formPageNumberMetadata.String
getAgreementAttribute()
.String
getAgreementAttributeLocked()
.String
getAnchorAllowWhiteSpaceInCharacters()
.PropertyMetadata
getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..String
getAnchorCaseSensitive()
When set to **true**, the anchor string does not consider case when matching strings in the document.PropertyMetadata
getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..String
getAnchorHorizontalAlignment()
Specifies the alignment of anchor tabs with anchor strings.PropertyMetadata
getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..String
getAnchorIgnoreIfNotPresent()
When set to **true**, this tab is ignored if anchorString is not found in the document..PropertyMetadata
getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..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()
Metadata that indicates whether the `anchorMatchWholeWord` property is editable..String
getAnchorString()
Anchor text information for a radio button..PropertyMetadata
getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..String
getAnchorTabProcessorVersion()
.PropertyMetadata
getAnchorTabProcessorVersionMetadata()
Reserved for DocuSign..String
getAnchorUnits()
Specifies units of the X and Y offset.PropertyMetadata
getAnchorUnitsMetadata()
Metadata that indicates whether the `anchorUnits` property is editable..String
getAnchorXOffset()
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadata
getAnchorXOffsetMetadata()
Metadata that indicates whether the `anchorXOffset` property is editable..String
getAnchorYOffset()
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadata
getAnchorYOffsetMetadata()
Metadata that indicates whether the `anchorYOffset` property is editable..String
getBold()
When set to **true**, the information in the tab is bold..PropertyMetadata
getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..String
getCaption()
.PropertyMetadata
getCaptionMetadata()
.String
getConditionalParentLabel()
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..PropertyMetadata
getConditionalParentLabelMetadata()
Metadata that indicates whether the `conditionalParentLabel` property is editable..String
getConditionalParentValue()
For conditional fields, this is the value of the parent tab that controls the tab's visibility.PropertyMetadata
getConditionalParentValueMetadata()
Metadata that indicates whether the `conditionalParentValue` property is editable..ConnectedObjectDetails
getConnectedObjectDetails()
.String
getCustomTabId()
The DocuSign generated custom tab ID for the custom tab to be applied.PropertyMetadata
getCustomTabIdMetadata()
Metadata that indicates whether the `customTabId` property is editable..String
getDocumentId()
Specifies the document ID number that the tab is placed on.PropertyMetadata
getDocumentIdMetadata()
Metadata that indicates whether the `documentId` property is editable..ErrorDetails
getErrorDetails()
Array or errors..ExtensionData
getExtensionData()
.String
getFont()
The font to be used for the tab value.String
getFontColor()
The font color used for the information in the tab.PropertyMetadata
getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..PropertyMetadata
getFontMetadata()
Metadata that indicates whether the `font` property is editable..String
getFontSize()
The font size used for the information in the tab.PropertyMetadata
getFontSizeMetadata()
Metadata that indicates whether the `fontSize` property is editable..String
getFormOrder()
.PropertyMetadata
getFormOrderMetadata()
Metadata that indicates whether the `formOrder` property is editable..String
getFormPageLabel()
.PropertyMetadata
getFormPageLabelMetadata()
Metadata that indicates whether the `formPageLabel` property is editable..String
getFormPageNumber()
.PropertyMetadata
getFormPageNumberMetadata()
Metadata that indicates whether the `fromPageNumber` property is editable..String
getHeight()
Height of the tab in pixels..PropertyMetadata
getHeightMetadata()
Metadata that indicates whether the `height` property is editable..String
getItalic()
When set to **true**, the information in the tab is italic..PropertyMetadata
getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..LocalePolicyTab
getLocalePolicy()
Reserved for DocuSign..MergeField
getMergeField()
Contains the information necessary to map the tab to a field in SalesForce..String
getMergeFieldXml()
.String
getName()
.PropertyMetadata
getNameMetadata()
Metadata that indicates whether the `name` property is editable.String
getPageNumber()
Specifies the page number on which the tab is located..PropertyMetadata
getPageNumberMetadata()
Metadata that indicates whether the `pageNumber` property is editable..String
getRecipientId()
Unique for the recipient.String
getRecipientIdGuid()
.PropertyMetadata
getRecipientIdGuidMetadata()
Metadata that indicates whether the `recipientIdGuid` property is editable..PropertyMetadata
getRecipientIdMetadata()
Metadata that indicates whether the `recipientId` property is editable..SmartContractInformation
getSmartContractInformation()
Reserved for DocuSign..String
getSource()
.String
getStatus()
Indicates the envelope status.PropertyMetadata
getStatusMetadata()
Metadata that indicates whether the `status` property is editable..String
getTabFullyQualifiedPath()
.List<String>
getTabGroupLabels()
.PropertyMetadata
getTabGroupLabelsMetadata()
Metadata that indicates whether the `tabGroupLabels` property is editable..String
getTabId()
The unique identifier for the tab.PropertyMetadata
getTabIdMetadata()
Metadata that indicates whether the `tabId` property is editable..String
getTabLabel()
The label string associated with the tab..PropertyMetadata
getTabLabelMetadata()
Metadata that indicates whether the `tabLabel` property is editable..String
getTabOrder()
.PropertyMetadata
getTabOrderMetadata()
Metadata that indicates whether the `tabOrder` property is editable..String
getTabType()
.PropertyMetadata
getTabTypeMetadata()
Metadata that indicates whether the `tabType` property is editable..String
getTemplateLocked()
When set to **true**, the sender cannot change any attributes of the recipient.PropertyMetadata
getTemplateLockedMetadata()
Metadata that indicates whether the `templateLocked` property is editable..String
getTemplateRequired()
When set to **true**, the sender may not remove the recipient.PropertyMetadata
getTemplateRequiredMetadata()
Metadata that indicates whether the `templateRequired` property is editable..String
getTooltip()
.PropertyMetadata
getToolTipMetadata()
Metadata that indicates whether the `toolTip` property is editable..String
getUnderline()
When set to **true**, the information in the tab is underlined..PropertyMetadata
getUnderlineMetadata()
Metadata that indicates whether the `underline` property is editable..String
getValue()
Specifies the value of the tab.PropertyMetadata
getValueMetadata()
Metadata that indicates whether the `value` property is editable..ErrorDetails
getWarningDetails()
.String
getWidth()
Width of the tab in pixels..PropertyMetadata
getWidthMetadata()
Metadata that indicates whether the `width` property is editable..String
getXPosition()
This indicates the horizontal offset of the object on the page.PropertyMetadata
getXPositionMetadata()
Metadata that indicates whether the `xPosition` property is editable..String
getYPosition()
This indicates the vertical offset of the object on the page.PropertyMetadata
getYPositionMetadata()
Metadata that indicates whether the `yPosition` property is editable..int
hashCode()
Returns the HashCode.FirstName
height(String height)
height.FirstName
heightMetadata(PropertyMetadata heightMetadata)
heightMetadata.FirstName
italic(String italic)
italic.FirstName
italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.FirstName
localePolicy(LocalePolicyTab localePolicy)
localePolicy.FirstName
mergeField(MergeField mergeField)
mergeField.FirstName
mergeFieldXml(String mergeFieldXml)
mergeFieldXml.FirstName
name(String name)
name.FirstName
nameMetadata(PropertyMetadata nameMetadata)
nameMetadata.FirstName
pageNumber(String pageNumber)
pageNumber.FirstName
pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.FirstName
recipientId(String recipientId)
recipientId.FirstName
recipientIdGuid(String recipientIdGuid)
recipientIdGuid.FirstName
recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
recipientIdGuidMetadata.FirstName
recipientIdMetadata(PropertyMetadata recipientIdMetadata)
recipientIdMetadata.void
setAgreementAttribute(String agreementAttribute)
setAgreementAttribute.void
setAgreementAttributeLocked(String agreementAttributeLocked)
setAgreementAttributeLocked.void
setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.void
setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.void
setAnchorCaseSensitive(String anchorCaseSensitive)
setAnchorCaseSensitive.void
setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.void
setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
setAnchorHorizontalAlignment.void
setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.void
setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
setAnchorIgnoreIfNotPresent.void
setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.void
setAnchorMatchWholeWord(String anchorMatchWholeWord)
setAnchorMatchWholeWord.void
setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
setAnchorMatchWholeWordMetadata.void
setAnchorString(String anchorString)
setAnchorString.void
setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.void
setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.void
setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
setAnchorTabProcessorVersionMetadata.void
setAnchorUnits(String anchorUnits)
setAnchorUnits.void
setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
setAnchorUnitsMetadata.void
setAnchorXOffset(String anchorXOffset)
setAnchorXOffset.void
setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
setAnchorXOffsetMetadata.void
setAnchorYOffset(String anchorYOffset)
setAnchorYOffset.void
setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
setAnchorYOffsetMetadata.void
setBold(String bold)
setBold.void
setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.void
setCaption(String caption)
setCaption.void
setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.void
setConditionalParentLabel(String conditionalParentLabel)
setConditionalParentLabel.void
setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
setConditionalParentLabelMetadata.void
setConditionalParentValue(String conditionalParentValue)
setConditionalParentValue.void
setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
setConditionalParentValueMetadata.void
setConnectedObjectDetails(ConnectedObjectDetails connectedObjectDetails)
setConnectedObjectDetails.void
setCustomTabId(String customTabId)
setCustomTabId.void
setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)
setCustomTabIdMetadata.void
setDocumentId(String documentId)
setDocumentId.void
setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
setDocumentIdMetadata.void
setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.void
setExtensionData(ExtensionData extensionData)
setExtensionData.void
setFont(String font)
setFont.void
setFontColor(String fontColor)
setFontColor.void
setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.void
setFontMetadata(PropertyMetadata fontMetadata)
setFontMetadata.void
setFontSize(String fontSize)
setFontSize.void
setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
setFontSizeMetadata.void
setFormOrder(String formOrder)
setFormOrder.void
setFormOrderMetadata(PropertyMetadata formOrderMetadata)
setFormOrderMetadata.void
setFormPageLabel(String formPageLabel)
setFormPageLabel.void
setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
setFormPageLabelMetadata.void
setFormPageNumber(String formPageNumber)
setFormPageNumber.void
setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
setFormPageNumberMetadata.void
setHeight(String height)
setHeight.void
setHeightMetadata(PropertyMetadata heightMetadata)
setHeightMetadata.void
setItalic(String italic)
setItalic.void
setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.void
setLocalePolicy(LocalePolicyTab localePolicy)
setLocalePolicy.void
setMergeField(MergeField mergeField)
setMergeField.void
setMergeFieldXml(String mergeFieldXml)
setMergeFieldXml.void
setName(String name)
setName.void
setNameMetadata(PropertyMetadata nameMetadata)
setNameMetadata.void
setPageNumber(String pageNumber)
setPageNumber.void
setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
setPageNumberMetadata.void
setRecipientId(String recipientId)
setRecipientId.void
setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.void
setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
setRecipientIdGuidMetadata.void
setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
setRecipientIdMetadata.void
setSmartContractInformation(SmartContractInformation smartContractInformation)
setSmartContractInformation.void
setSource(String source)
setSource.void
setStatus(String status)
setStatus.void
setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.void
setTabFullyQualifiedPath(String tabFullyQualifiedPath)
setTabFullyQualifiedPath.void
setTabGroupLabels(List<String> tabGroupLabels)
setTabGroupLabels.void
setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
setTabGroupLabelsMetadata.void
setTabId(String tabId)
setTabId.void
setTabIdMetadata(PropertyMetadata tabIdMetadata)
setTabIdMetadata.void
setTabLabel(String tabLabel)
setTabLabel.void
setTabLabelMetadata(PropertyMetadata tabLabelMetadata)
setTabLabelMetadata.void
setTabOrder(String tabOrder)
setTabOrder.void
setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
setTabOrderMetadata.void
setTabType(String tabType)
setTabType.void
setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
setTabTypeMetadata.void
setTemplateLocked(String templateLocked)
setTemplateLocked.void
setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
setTemplateLockedMetadata.void
setTemplateRequired(String templateRequired)
setTemplateRequired.void
setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
setTemplateRequiredMetadata.void
setTooltip(String tooltip)
setTooltip.void
setToolTipMetadata(PropertyMetadata toolTipMetadata)
setToolTipMetadata.void
setUnderline(String underline)
setUnderline.void
setUnderlineMetadata(PropertyMetadata underlineMetadata)
setUnderlineMetadata.void
setValue(String value)
setValue.void
setValueMetadata(PropertyMetadata valueMetadata)
setValueMetadata.void
setWarningDetails(ErrorDetails warningDetails)
setWarningDetails.void
setWidth(String width)
setWidth.void
setWidthMetadata(PropertyMetadata widthMetadata)
setWidthMetadata.void
setXPosition(String xPosition)
setXPosition.void
setXPositionMetadata(PropertyMetadata xPositionMetadata)
setXPositionMetadata.void
setYPosition(String yPosition)
setYPosition.void
setYPositionMetadata(PropertyMetadata yPositionMetadata)
setYPositionMetadata.FirstName
smartContractInformation(SmartContractInformation smartContractInformation)
smartContractInformation.FirstName
source(String source)
source.FirstName
status(String status)
status.FirstName
statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.FirstName
tabFullyQualifiedPath(String tabFullyQualifiedPath)
tabFullyQualifiedPath.FirstName
tabGroupLabels(List<String> tabGroupLabels)
tabGroupLabels.FirstName
tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
tabGroupLabelsMetadata.FirstName
tabId(String tabId)
tabId.FirstName
tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.FirstName
tabLabel(String tabLabel)
tabLabel.FirstName
tabLabelMetadata(PropertyMetadata tabLabelMetadata)
tabLabelMetadata.FirstName
tabOrder(String tabOrder)
tabOrder.FirstName
tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.FirstName
tabType(String tabType)
tabType.FirstName
tabTypeMetadata(PropertyMetadata tabTypeMetadata)
tabTypeMetadata.FirstName
templateLocked(String templateLocked)
templateLocked.FirstName
templateLockedMetadata(PropertyMetadata templateLockedMetadata)
templateLockedMetadata.FirstName
templateRequired(String templateRequired)
templateRequired.FirstName
templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
templateRequiredMetadata.FirstName
tooltip(String tooltip)
tooltip.FirstName
toolTipMetadata(PropertyMetadata toolTipMetadata)
toolTipMetadata.String
toString()
Converts the given object to string.FirstName
underline(String underline)
underline.FirstName
underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.FirstName
value(String value)
value.FirstName
valueMetadata(PropertyMetadata valueMetadata)
valueMetadata.FirstName
warningDetails(ErrorDetails warningDetails)
warningDetails.FirstName
width(String width)
width.FirstName
widthMetadata(PropertyMetadata widthMetadata)
widthMetadata.FirstName
xPosition(String xPosition)
xPosition.FirstName
xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.FirstName
yPosition(String yPosition)
yPosition.FirstName
yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.
-
-
-
Method Detail
-
agreementAttribute
public FirstName agreementAttribute(String agreementAttribute)
agreementAttribute.- Returns:
- FirstName
-
getAgreementAttribute
public String getAgreementAttribute()
.- Returns:
- agreementAttribute
-
setAgreementAttribute
public void setAgreementAttribute(String agreementAttribute)
setAgreementAttribute.
-
agreementAttributeLocked
public FirstName agreementAttributeLocked(String agreementAttributeLocked)
agreementAttributeLocked.- Returns:
- FirstName
-
getAgreementAttributeLocked
public String getAgreementAttributeLocked()
.- Returns:
- agreementAttributeLocked
-
setAgreementAttributeLocked
public void setAgreementAttributeLocked(String agreementAttributeLocked)
setAgreementAttributeLocked.
-
anchorAllowWhiteSpaceInCharacters
public FirstName anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.- Returns:
- FirstName
-
getAnchorAllowWhiteSpaceInCharacters
public String getAnchorAllowWhiteSpaceInCharacters()
.- Returns:
- anchorAllowWhiteSpaceInCharacters
-
setAnchorAllowWhiteSpaceInCharacters
public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.
-
anchorAllowWhiteSpaceInCharactersMetadata
public FirstName anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.- Returns:
- FirstName
-
getAnchorAllowWhiteSpaceInCharactersMetadata
public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..- Returns:
- anchorAllowWhiteSpaceInCharactersMetadata
-
setAnchorAllowWhiteSpaceInCharactersMetadata
public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.
-
anchorCaseSensitive
public FirstName anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.- Returns:
- FirstName
-
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.
-
anchorCaseSensitiveMetadata
public FirstName anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.- Returns:
- FirstName
-
getAnchorCaseSensitiveMetadata
public PropertyMetadata getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..- Returns:
- anchorCaseSensitiveMetadata
-
setAnchorCaseSensitiveMetadata
public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.
-
anchorHorizontalAlignment
public FirstName anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.- Returns:
- FirstName
-
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.
-
anchorHorizontalAlignmentMetadata
public FirstName anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.- Returns:
- FirstName
-
getAnchorHorizontalAlignmentMetadata
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..- Returns:
- anchorHorizontalAlignmentMetadata
-
setAnchorHorizontalAlignmentMetadata
public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.
-
anchorIgnoreIfNotPresent
public FirstName anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.- Returns:
- FirstName
-
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.
-
anchorIgnoreIfNotPresentMetadata
public FirstName anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.- Returns:
- FirstName
-
getAnchorIgnoreIfNotPresentMetadata
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..- Returns:
- anchorIgnoreIfNotPresentMetadata
-
setAnchorIgnoreIfNotPresentMetadata
public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.
-
anchorMatchWholeWord
public FirstName anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.- Returns:
- FirstName
-
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.
-
anchorMatchWholeWordMetadata
public FirstName anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.- Returns:
- FirstName
-
getAnchorMatchWholeWordMetadata
public PropertyMetadata getAnchorMatchWholeWordMetadata()
Metadata that indicates whether the `anchorMatchWholeWord` property is editable..- Returns:
- anchorMatchWholeWordMetadata
-
setAnchorMatchWholeWordMetadata
public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
setAnchorMatchWholeWordMetadata.
-
getAnchorString
public String getAnchorString()
Anchor text information for a radio button..- Returns:
- anchorString
-
setAnchorString
public void setAnchorString(String anchorString)
setAnchorString.
-
anchorStringMetadata
public FirstName anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.- Returns:
- FirstName
-
getAnchorStringMetadata
public PropertyMetadata getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..- Returns:
- anchorStringMetadata
-
setAnchorStringMetadata
public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.
-
anchorTabProcessorVersion
public FirstName anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.- Returns:
- FirstName
-
getAnchorTabProcessorVersion
public String getAnchorTabProcessorVersion()
.- Returns:
- anchorTabProcessorVersion
-
setAnchorTabProcessorVersion
public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.
-
anchorTabProcessorVersionMetadata
public FirstName anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.- Returns:
- FirstName
-
getAnchorTabProcessorVersionMetadata
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
Reserved for DocuSign..- Returns:
- anchorTabProcessorVersionMetadata
-
setAnchorTabProcessorVersionMetadata
public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
setAnchorTabProcessorVersionMetadata.
-
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.
-
anchorUnitsMetadata
public FirstName anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.- Returns:
- FirstName
-
getAnchorUnitsMetadata
public PropertyMetadata getAnchorUnitsMetadata()
Metadata that indicates whether the `anchorUnits` property is editable..- Returns:
- anchorUnitsMetadata
-
setAnchorUnitsMetadata
public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
setAnchorUnitsMetadata.
-
anchorXOffset
public FirstName anchorXOffset(String anchorXOffset)
anchorXOffset.- Returns:
- FirstName
-
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.
-
anchorXOffsetMetadata
public FirstName anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.- Returns:
- FirstName
-
getAnchorXOffsetMetadata
public PropertyMetadata getAnchorXOffsetMetadata()
Metadata that indicates whether the `anchorXOffset` property is editable..- Returns:
- anchorXOffsetMetadata
-
setAnchorXOffsetMetadata
public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
setAnchorXOffsetMetadata.
-
anchorYOffset
public FirstName anchorYOffset(String anchorYOffset)
anchorYOffset.- Returns:
- FirstName
-
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.
-
anchorYOffsetMetadata
public FirstName anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.- Returns:
- FirstName
-
getAnchorYOffsetMetadata
public PropertyMetadata getAnchorYOffsetMetadata()
Metadata that indicates whether the `anchorYOffset` property is editable..- Returns:
- anchorYOffsetMetadata
-
setAnchorYOffsetMetadata
public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
setAnchorYOffsetMetadata.
-
getBold
public String getBold()
When set to **true**, the information in the tab is bold..- Returns:
- bold
-
setBold
public void setBold(String bold)
setBold.
-
boldMetadata
public FirstName boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.- Returns:
- FirstName
-
getBoldMetadata
public PropertyMetadata getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..- Returns:
- boldMetadata
-
setBoldMetadata
public void setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.
-
getCaption
public String getCaption()
.- Returns:
- caption
-
setCaption
public void setCaption(String caption)
setCaption.
-
captionMetadata
public FirstName captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.- Returns:
- FirstName
-
getCaptionMetadata
public PropertyMetadata getCaptionMetadata()
.- Returns:
- captionMetadata
-
setCaptionMetadata
public void setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.
-
conditionalParentLabel
public FirstName conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.- Returns:
- FirstName
-
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.
-
conditionalParentLabelMetadata
public FirstName conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
conditionalParentLabelMetadata.- Returns:
- FirstName
-
getConditionalParentLabelMetadata
public PropertyMetadata getConditionalParentLabelMetadata()
Metadata that indicates whether the `conditionalParentLabel` property is editable..- Returns:
- conditionalParentLabelMetadata
-
setConditionalParentLabelMetadata
public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
setConditionalParentLabelMetadata.
-
conditionalParentValue
public FirstName conditionalParentValue(String conditionalParentValue)
conditionalParentValue.- Returns:
- FirstName
-
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.
-
conditionalParentValueMetadata
public FirstName conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
conditionalParentValueMetadata.- Returns:
- FirstName
-
getConditionalParentValueMetadata
public PropertyMetadata getConditionalParentValueMetadata()
Metadata that indicates whether the `conditionalParentValue` property is editable..- Returns:
- conditionalParentValueMetadata
-
setConditionalParentValueMetadata
public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
setConditionalParentValueMetadata.
-
connectedObjectDetails
public FirstName connectedObjectDetails(ConnectedObjectDetails connectedObjectDetails)
connectedObjectDetails.- Returns:
- FirstName
-
getConnectedObjectDetails
public ConnectedObjectDetails getConnectedObjectDetails()
.- Returns:
- connectedObjectDetails
-
setConnectedObjectDetails
public void setConnectedObjectDetails(ConnectedObjectDetails connectedObjectDetails)
setConnectedObjectDetails.
-
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.
-
customTabIdMetadata
public FirstName customTabIdMetadata(PropertyMetadata customTabIdMetadata)
customTabIdMetadata.- Returns:
- FirstName
-
getCustomTabIdMetadata
public PropertyMetadata getCustomTabIdMetadata()
Metadata that indicates whether the `customTabId` property is editable..- Returns:
- customTabIdMetadata
-
setCustomTabIdMetadata
public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)
setCustomTabIdMetadata.
-
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.
-
documentIdMetadata
public FirstName documentIdMetadata(PropertyMetadata documentIdMetadata)
documentIdMetadata.- Returns:
- FirstName
-
getDocumentIdMetadata
public PropertyMetadata getDocumentIdMetadata()
Metadata that indicates whether the `documentId` property is editable..- Returns:
- documentIdMetadata
-
setDocumentIdMetadata
public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
setDocumentIdMetadata.
-
errorDetails
public FirstName errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- FirstName
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
extensionData
public FirstName extensionData(ExtensionData extensionData)
extensionData.- Returns:
- FirstName
-
getExtensionData
public ExtensionData getExtensionData()
.- Returns:
- extensionData
-
setExtensionData
public void setExtensionData(ExtensionData extensionData)
setExtensionData.
-
getFont
public String getFont()
The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default..- Returns:
- font
-
setFont
public void setFont(String font)
setFont.
-
getFontColor
public String getFontColor()
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White..- Returns:
- fontColor
-
setFontColor
public void setFontColor(String fontColor)
setFontColor.
-
fontColorMetadata
public FirstName fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.- Returns:
- FirstName
-
getFontColorMetadata
public PropertyMetadata getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..- Returns:
- fontColorMetadata
-
setFontColorMetadata
public void setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.
-
fontMetadata
public FirstName fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.- Returns:
- FirstName
-
getFontMetadata
public PropertyMetadata getFontMetadata()
Metadata that indicates whether the `font` property is editable..- Returns:
- fontMetadata
-
setFontMetadata
public void setFontMetadata(PropertyMetadata fontMetadata)
setFontMetadata.
-
getFontSize
public String getFontSize()
The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72..- Returns:
- fontSize
-
setFontSize
public void setFontSize(String fontSize)
setFontSize.
-
fontSizeMetadata
public FirstName fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.- Returns:
- FirstName
-
getFontSizeMetadata
public PropertyMetadata getFontSizeMetadata()
Metadata that indicates whether the `fontSize` property is editable..- Returns:
- fontSizeMetadata
-
setFontSizeMetadata
public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
setFontSizeMetadata.
-
getFormOrder
public String getFormOrder()
.- Returns:
- formOrder
-
setFormOrder
public void setFormOrder(String formOrder)
setFormOrder.
-
formOrderMetadata
public FirstName formOrderMetadata(PropertyMetadata formOrderMetadata)
formOrderMetadata.- Returns:
- FirstName
-
getFormOrderMetadata
public PropertyMetadata getFormOrderMetadata()
Metadata that indicates whether the `formOrder` property is editable..- Returns:
- formOrderMetadata
-
setFormOrderMetadata
public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)
setFormOrderMetadata.
-
formPageLabel
public FirstName formPageLabel(String formPageLabel)
formPageLabel.- Returns:
- FirstName
-
getFormPageLabel
public String getFormPageLabel()
.- Returns:
- formPageLabel
-
setFormPageLabel
public void setFormPageLabel(String formPageLabel)
setFormPageLabel.
-
formPageLabelMetadata
public FirstName formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
formPageLabelMetadata.- Returns:
- FirstName
-
getFormPageLabelMetadata
public PropertyMetadata getFormPageLabelMetadata()
Metadata that indicates whether the `formPageLabel` property is editable..- Returns:
- formPageLabelMetadata
-
setFormPageLabelMetadata
public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
setFormPageLabelMetadata.
-
formPageNumber
public FirstName formPageNumber(String formPageNumber)
formPageNumber.- Returns:
- FirstName
-
getFormPageNumber
public String getFormPageNumber()
.- Returns:
- formPageNumber
-
setFormPageNumber
public void setFormPageNumber(String formPageNumber)
setFormPageNumber.
-
formPageNumberMetadata
public FirstName formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
formPageNumberMetadata.- Returns:
- FirstName
-
getFormPageNumberMetadata
public PropertyMetadata getFormPageNumberMetadata()
Metadata that indicates whether the `fromPageNumber` property is editable..- Returns:
- formPageNumberMetadata
-
setFormPageNumberMetadata
public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
setFormPageNumberMetadata.
-
getHeight
public String getHeight()
Height of the tab in pixels..- Returns:
- height
-
setHeight
public void setHeight(String height)
setHeight.
-
heightMetadata
public FirstName heightMetadata(PropertyMetadata heightMetadata)
heightMetadata.- Returns:
- FirstName
-
getHeightMetadata
public PropertyMetadata getHeightMetadata()
Metadata that indicates whether the `height` property is editable..- Returns:
- heightMetadata
-
setHeightMetadata
public void setHeightMetadata(PropertyMetadata heightMetadata)
setHeightMetadata.
-
getItalic
public String getItalic()
When set to **true**, the information in the tab is italic..- Returns:
- italic
-
setItalic
public void setItalic(String italic)
setItalic.
-
italicMetadata
public FirstName italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.- Returns:
- FirstName
-
getItalicMetadata
public PropertyMetadata getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..- Returns:
- italicMetadata
-
setItalicMetadata
public void setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.
-
localePolicy
public FirstName localePolicy(LocalePolicyTab localePolicy)
localePolicy.- Returns:
- FirstName
-
getLocalePolicy
public LocalePolicyTab getLocalePolicy()
Reserved for DocuSign..- Returns:
- localePolicy
-
setLocalePolicy
public void setLocalePolicy(LocalePolicyTab localePolicy)
setLocalePolicy.
-
mergeField
public FirstName mergeField(MergeField mergeField)
mergeField.- Returns:
- FirstName
-
getMergeField
public MergeField getMergeField()
Contains the information necessary to map the tab to a field in SalesForce..- Returns:
- mergeField
-
setMergeField
public void setMergeField(MergeField mergeField)
setMergeField.
-
mergeFieldXml
public FirstName mergeFieldXml(String mergeFieldXml)
mergeFieldXml.- Returns:
- FirstName
-
getMergeFieldXml
public String getMergeFieldXml()
.- Returns:
- mergeFieldXml
-
setMergeFieldXml
public void setMergeFieldXml(String mergeFieldXml)
setMergeFieldXml.
-
getName
public String getName()
.- Returns:
- name
-
setName
public void setName(String name)
setName.
-
nameMetadata
public FirstName nameMetadata(PropertyMetadata nameMetadata)
nameMetadata.- Returns:
- FirstName
-
getNameMetadata
public PropertyMetadata getNameMetadata()
Metadata that indicates whether the `name` property is editable. This property is read-only..- Returns:
- nameMetadata
-
setNameMetadata
public void setNameMetadata(PropertyMetadata nameMetadata)
setNameMetadata.
-
getPageNumber
public String getPageNumber()
Specifies the page number on which the tab is located..- Returns:
- pageNumber
-
setPageNumber
public void setPageNumber(String pageNumber)
setPageNumber.
-
pageNumberMetadata
public FirstName pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.- Returns:
- FirstName
-
getPageNumberMetadata
public PropertyMetadata getPageNumberMetadata()
Metadata that indicates whether the `pageNumber` property is editable..- Returns:
- pageNumberMetadata
-
setPageNumberMetadata
public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
setPageNumberMetadata.
-
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.
-
recipientIdGuid
public FirstName recipientIdGuid(String recipientIdGuid)
recipientIdGuid.- Returns:
- FirstName
-
getRecipientIdGuid
public String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.
-
recipientIdGuidMetadata
public FirstName recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
recipientIdGuidMetadata.- Returns:
- FirstName
-
getRecipientIdGuidMetadata
public PropertyMetadata getRecipientIdGuidMetadata()
Metadata that indicates whether the `recipientIdGuid` property is editable..- Returns:
- recipientIdGuidMetadata
-
setRecipientIdGuidMetadata
public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
setRecipientIdGuidMetadata.
-
recipientIdMetadata
public FirstName recipientIdMetadata(PropertyMetadata recipientIdMetadata)
recipientIdMetadata.- Returns:
- FirstName
-
getRecipientIdMetadata
public PropertyMetadata getRecipientIdMetadata()
Metadata that indicates whether the `recipientId` property is editable..- Returns:
- recipientIdMetadata
-
setRecipientIdMetadata
public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
setRecipientIdMetadata.
-
smartContractInformation
public FirstName smartContractInformation(SmartContractInformation smartContractInformation)
smartContractInformation.- Returns:
- FirstName
-
getSmartContractInformation
public SmartContractInformation getSmartContractInformation()
Reserved for DocuSign..- Returns:
- smartContractInformation
-
setSmartContractInformation
public void setSmartContractInformation(SmartContractInformation smartContractInformation)
setSmartContractInformation.
-
getSource
public String getSource()
.- Returns:
- source
-
setSource
public void setSource(String source)
setSource.
-
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.
-
statusMetadata
public FirstName statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.- Returns:
- FirstName
-
getStatusMetadata
public PropertyMetadata getStatusMetadata()
Metadata that indicates whether the `status` property is editable..- Returns:
- statusMetadata
-
setStatusMetadata
public void setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.
-
tabFullyQualifiedPath
public FirstName tabFullyQualifiedPath(String tabFullyQualifiedPath)
tabFullyQualifiedPath.- Returns:
- FirstName
-
getTabFullyQualifiedPath
public String getTabFullyQualifiedPath()
.- Returns:
- tabFullyQualifiedPath
-
setTabFullyQualifiedPath
public void setTabFullyQualifiedPath(String tabFullyQualifiedPath)
setTabFullyQualifiedPath.
-
tabGroupLabels
public FirstName tabGroupLabels(List<String> tabGroupLabels)
tabGroupLabels.- Returns:
- FirstName
-
addTabGroupLabelsItem
public FirstName addTabGroupLabelsItem(String tabGroupLabelsItem)
addTabGroupLabelsItem.- Returns:
- FirstName
-
tabGroupLabelsMetadata
public FirstName tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
tabGroupLabelsMetadata.- Returns:
- FirstName
-
getTabGroupLabelsMetadata
public PropertyMetadata getTabGroupLabelsMetadata()
Metadata that indicates whether the `tabGroupLabels` property is editable..- Returns:
- tabGroupLabelsMetadata
-
setTabGroupLabelsMetadata
public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
setTabGroupLabelsMetadata.
-
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.
-
tabIdMetadata
public FirstName tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.- Returns:
- FirstName
-
getTabIdMetadata
public PropertyMetadata getTabIdMetadata()
Metadata that indicates whether the `tabId` property is editable..- Returns:
- tabIdMetadata
-
setTabIdMetadata
public void setTabIdMetadata(PropertyMetadata tabIdMetadata)
setTabIdMetadata.
-
getTabLabel
public String getTabLabel()
The label string associated with the tab..- Returns:
- tabLabel
-
setTabLabel
public void setTabLabel(String tabLabel)
setTabLabel.
-
tabLabelMetadata
public FirstName tabLabelMetadata(PropertyMetadata tabLabelMetadata)
tabLabelMetadata.- Returns:
- FirstName
-
getTabLabelMetadata
public PropertyMetadata getTabLabelMetadata()
Metadata that indicates whether the `tabLabel` property is editable..- Returns:
- tabLabelMetadata
-
setTabLabelMetadata
public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)
setTabLabelMetadata.
-
getTabOrder
public String getTabOrder()
.- Returns:
- tabOrder
-
setTabOrder
public void setTabOrder(String tabOrder)
setTabOrder.
-
tabOrderMetadata
public FirstName tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.- Returns:
- FirstName
-
getTabOrderMetadata
public PropertyMetadata getTabOrderMetadata()
Metadata that indicates whether the `tabOrder` property is editable..- Returns:
- tabOrderMetadata
-
setTabOrderMetadata
public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
setTabOrderMetadata.
-
getTabType
public String getTabType()
.- Returns:
- tabType
-
setTabType
public void setTabType(String tabType)
setTabType.
-
tabTypeMetadata
public FirstName tabTypeMetadata(PropertyMetadata tabTypeMetadata)
tabTypeMetadata.- Returns:
- FirstName
-
getTabTypeMetadata
public PropertyMetadata getTabTypeMetadata()
Metadata that indicates whether the `tabType` property is editable..- Returns:
- tabTypeMetadata
-
setTabTypeMetadata
public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
setTabTypeMetadata.
-
templateLocked
public FirstName templateLocked(String templateLocked)
templateLocked.- Returns:
- FirstName
-
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.
-
templateLockedMetadata
public FirstName templateLockedMetadata(PropertyMetadata templateLockedMetadata)
templateLockedMetadata.- Returns:
- FirstName
-
getTemplateLockedMetadata
public PropertyMetadata getTemplateLockedMetadata()
Metadata that indicates whether the `templateLocked` property is editable..- Returns:
- templateLockedMetadata
-
setTemplateLockedMetadata
public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
setTemplateLockedMetadata.
-
templateRequired
public FirstName templateRequired(String templateRequired)
templateRequired.- Returns:
- FirstName
-
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.
-
templateRequiredMetadata
public FirstName templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
templateRequiredMetadata.- Returns:
- FirstName
-
getTemplateRequiredMetadata
public PropertyMetadata getTemplateRequiredMetadata()
Metadata that indicates whether the `templateRequired` property is editable..- Returns:
- templateRequiredMetadata
-
setTemplateRequiredMetadata
public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
setTemplateRequiredMetadata.
-
getTooltip
public String getTooltip()
.- Returns:
- tooltip
-
setTooltip
public void setTooltip(String tooltip)
setTooltip.
-
toolTipMetadata
public FirstName toolTipMetadata(PropertyMetadata toolTipMetadata)
toolTipMetadata.- Returns:
- FirstName
-
getToolTipMetadata
public PropertyMetadata getToolTipMetadata()
Metadata that indicates whether the `toolTip` property is editable..- Returns:
- toolTipMetadata
-
setToolTipMetadata
public void setToolTipMetadata(PropertyMetadata toolTipMetadata)
setToolTipMetadata.
-
getUnderline
public String getUnderline()
When set to **true**, the information in the tab is underlined..- Returns:
- underline
-
setUnderline
public void setUnderline(String underline)
setUnderline.
-
underlineMetadata
public FirstName underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.- Returns:
- FirstName
-
getUnderlineMetadata
public PropertyMetadata getUnderlineMetadata()
Metadata that indicates whether the `underline` property is editable..- Returns:
- underlineMetadata
-
setUnderlineMetadata
public void setUnderlineMetadata(PropertyMetadata underlineMetadata)
setUnderlineMetadata.
-
getValue
public String getValue()
Specifies the value of the tab. .- Returns:
- value
-
setValue
public void setValue(String value)
setValue.
-
valueMetadata
public FirstName valueMetadata(PropertyMetadata valueMetadata)
valueMetadata.- Returns:
- FirstName
-
getValueMetadata
public PropertyMetadata getValueMetadata()
Metadata that indicates whether the `value` property is editable..- Returns:
- valueMetadata
-
setValueMetadata
public void setValueMetadata(PropertyMetadata valueMetadata)
setValueMetadata.
-
warningDetails
public FirstName warningDetails(ErrorDetails warningDetails)
warningDetails.- Returns:
- FirstName
-
getWarningDetails
public ErrorDetails getWarningDetails()
.- Returns:
- warningDetails
-
setWarningDetails
public void setWarningDetails(ErrorDetails warningDetails)
setWarningDetails.
-
getWidth
public String getWidth()
Width of the tab in pixels..- Returns:
- width
-
setWidth
public void setWidth(String width)
setWidth.
-
widthMetadata
public FirstName widthMetadata(PropertyMetadata widthMetadata)
widthMetadata.- Returns:
- FirstName
-
getWidthMetadata
public PropertyMetadata getWidthMetadata()
Metadata that indicates whether the `width` property is editable..- Returns:
- widthMetadata
-
setWidthMetadata
public void setWidthMetadata(PropertyMetadata widthMetadata)
setWidthMetadata.
-
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.
-
xPositionMetadata
public FirstName xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.- Returns:
- FirstName
-
getXPositionMetadata
public PropertyMetadata getXPositionMetadata()
Metadata that indicates whether the `xPosition` property is editable..- Returns:
- xPositionMetadata
-
setXPositionMetadata
public void setXPositionMetadata(PropertyMetadata xPositionMetadata)
setXPositionMetadata.
-
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.
-
yPositionMetadata
public FirstName yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.- Returns:
- FirstName
-
getYPositionMetadata
public PropertyMetadata getYPositionMetadata()
Metadata that indicates whether the `yPosition` property is editable..- Returns:
- yPositionMetadata
-
setYPositionMetadata
public void setYPositionMetadata(PropertyMetadata yPositionMetadata)
setYPositionMetadata.
-
equals
public boolean equals(Object o)
Compares objects.
-
-