Package com.docusign.esign.model
Class CommentThread
- java.lang.Object
-
- com.docusign.esign.model.CommentThread
-
public class CommentThread extends Object
CommentThread.
-
-
Constructor Summary
Constructors Constructor Description CommentThread()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CommentThreadaddCommentsItem(Comment commentsItem)addCommentsItem.CommentThreadaddTabGroupLabelsItem(String tabGroupLabelsItem)addTabGroupLabelsItem.CommentThreadanchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)anchorAllowWhiteSpaceInCharacters.CommentThreadanchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)anchorAllowWhiteSpaceInCharactersMetadata.CommentThreadanchorCaseSensitive(String anchorCaseSensitive)anchorCaseSensitive.CommentThreadanchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)anchorCaseSensitiveMetadata.CommentThreadanchorHorizontalAlignment(String anchorHorizontalAlignment)anchorHorizontalAlignment.CommentThreadanchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)anchorHorizontalAlignmentMetadata.CommentThreadanchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)anchorIgnoreIfNotPresent.CommentThreadanchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)anchorIgnoreIfNotPresentMetadata.CommentThreadanchorMatchWholeWord(String anchorMatchWholeWord)anchorMatchWholeWord.CommentThreadanchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)anchorMatchWholeWordMetadata.CommentThreadanchorString(String anchorString)anchorString.CommentThreadanchorStringMetadata(PropertyMetadata anchorStringMetadata)anchorStringMetadata.CommentThreadanchorTabProcessorVersion(String anchorTabProcessorVersion)anchorTabProcessorVersion.CommentThreadanchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)anchorTabProcessorVersionMetadata.CommentThreadanchorUnits(String anchorUnits)anchorUnits.CommentThreadanchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)anchorUnitsMetadata.CommentThreadanchorXOffset(String anchorXOffset)anchorXOffset.CommentThreadanchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)anchorXOffsetMetadata.CommentThreadanchorYOffset(String anchorYOffset)anchorYOffset.CommentThreadanchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)anchorYOffsetMetadata.CommentThreadbold(String bold)bold.CommentThreadboldMetadata(PropertyMetadata boldMetadata)boldMetadata.CommentThreadcaption(String caption)caption.CommentThreadcaptionMetadata(PropertyMetadata captionMetadata)captionMetadata.CommentThreadcomments(List<Comment> comments)comments.CommentThreadconditionalParentLabel(String conditionalParentLabel)conditionalParentLabel.CommentThreadconditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)conditionalParentLabelMetadata.CommentThreadconditionalParentValue(String conditionalParentValue)conditionalParentValue.CommentThreadconditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)conditionalParentValueMetadata.CommentThreadcustomTabId(String customTabId)customTabId.CommentThreadcustomTabIdMetadata(PropertyMetadata customTabIdMetadata)customTabIdMetadata.CommentThreaddocumentId(String documentId)documentId.CommentThreaddocumentIdMetadata(PropertyMetadata documentIdMetadata)documentIdMetadata.booleanequals(Object o)Compares objects.CommentThreaderrorDetails(ErrorDetails errorDetails)errorDetails.CommentThreadfont(String font)font.CommentThreadfontColor(String fontColor)fontColor.CommentThreadfontColorMetadata(PropertyMetadata fontColorMetadata)fontColorMetadata.CommentThreadfontMetadata(PropertyMetadata fontMetadata)fontMetadata.CommentThreadfontSize(String fontSize)fontSize.CommentThreadfontSizeMetadata(PropertyMetadata fontSizeMetadata)fontSizeMetadata.CommentThreadformOrder(String formOrder)formOrder.CommentThreadformOrderMetadata(PropertyMetadata formOrderMetadata)formOrderMetadata.CommentThreadformPageLabel(String formPageLabel)formPageLabel.CommentThreadformPageLabelMetadata(PropertyMetadata formPageLabelMetadata)formPageLabelMetadata.CommentThreadformPageNumber(String formPageNumber)formPageNumber.CommentThreadformPageNumberMetadata(PropertyMetadata formPageNumberMetadata)formPageNumberMetadata.StringgetAnchorAllowWhiteSpaceInCharacters().PropertyMetadatagetAnchorAllowWhiteSpaceInCharactersMetadata()Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..StringgetAnchorCaseSensitive()When set to **true**, the anchor string does not consider case when matching strings in the document.PropertyMetadatagetAnchorCaseSensitiveMetadata()Metadata that indicates whether the `anchorCaseSensitive` property is editable..StringgetAnchorHorizontalAlignment()Specifies the alignment of anchor tabs with anchor strings.PropertyMetadatagetAnchorHorizontalAlignmentMetadata()Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..StringgetAnchorIgnoreIfNotPresent()When set to **true**, this tab is ignored if anchorString is not found in the document..PropertyMetadatagetAnchorIgnoreIfNotPresentMetadata()Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..StringgetAnchorMatchWholeWord()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**..PropertyMetadatagetAnchorMatchWholeWordMetadata()Metadata that indicates whether the `anchorMatchWholeWord` property is editable..StringgetAnchorString()Anchor text information for a radio button..PropertyMetadatagetAnchorStringMetadata()Metadata that indicates whether the `anchorString` property is editable..StringgetAnchorTabProcessorVersion().PropertyMetadatagetAnchorTabProcessorVersionMetadata()Reserved for DocuSign..StringgetAnchorUnits()Specifies units of the X and Y offset.PropertyMetadatagetAnchorUnitsMetadata()Metadata that indicates whether the `anchorUnits` property is editable..StringgetAnchorXOffset()Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadatagetAnchorXOffsetMetadata()Metadata that indicates whether the `anchorXOffset` property is editable..StringgetAnchorYOffset()Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadatagetAnchorYOffsetMetadata()Metadata that indicates whether the `anchorYOffset` property is editable..StringgetBold()When set to **true**, the information in the tab is bold..PropertyMetadatagetBoldMetadata()Metadata that indicates whether the `bold` property is editable..StringgetCaption().PropertyMetadatagetCaptionMetadata()Get captionMetadata.List<Comment>getComments().StringgetConditionalParentLabel()For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..PropertyMetadatagetConditionalParentLabelMetadata()Metadata that indicates whether the `conditionalParentLabel` property is editable..StringgetConditionalParentValue()For conditional fields, this is the value of the parent tab that controls the tab's visibility.PropertyMetadatagetConditionalParentValueMetadata()Metadata that indicates whether the `conditionalParentValue` property is editable..StringgetCustomTabId()The DocuSign generated custom tab ID for the custom tab to be applied.PropertyMetadatagetCustomTabIdMetadata()Metadata that indicates whether the `customTabId` property is editable..StringgetDocumentId()Specifies the document ID number that the tab is placed on.PropertyMetadatagetDocumentIdMetadata()Metadata that indicates whether the `documentId` property is editable..ErrorDetailsgetErrorDetails()This object describes errors that occur.StringgetFont()The font to be used for the tab value.StringgetFontColor()The font color used for the information in the tab.PropertyMetadatagetFontColorMetadata()Metadata that indicates whether the `fontColor` property is editable..PropertyMetadatagetFontMetadata()Metadata that indicates whether the `font` property is editable..StringgetFontSize()The font size used for the information in the tab.PropertyMetadatagetFontSizeMetadata()Metadata that indicates whether the `fontSize` property is editable..StringgetFormOrder().PropertyMetadatagetFormOrderMetadata()Metadata that indicates whether the `formOrder` property is editable..StringgetFormPageLabel().PropertyMetadatagetFormPageLabelMetadata()Metadata that indicates whether the `formPageLabel` property is editable..StringgetFormPageNumber().PropertyMetadatagetFormPageNumberMetadata()Metadata that indicates whether the `fromPageNumber` property is editable..StringgetHeight()Height of the tab in pixels..PropertyMetadatagetHeightMetadata()Metadata that indicates whether the `height` property is editable..StringgetItalic()When set to **true**, the information in the tab is italic..PropertyMetadatagetItalicMetadata()Metadata that indicates whether the `italic` property is editable..LocalePolicyTabgetLocalePolicy()Reserved for DocuSign..MergeFieldgetMergeField()Contains the information necessary to map the tab to a field in SalesForce..StringgetMergeFieldXml().StringgetPageNumber()Specifies the page number on which the tab is located..PropertyMetadatagetPageNumberMetadata()Metadata that indicates whether the `pageNumber` property is editable..StringgetRecipientId()Unique for the recipient.StringgetRecipientIdGuid().PropertyMetadatagetRecipientIdGuidMetadata()Metadata that indicates whether the `recipientIdGuid` property is editable..PropertyMetadatagetRecipientIdMetadata()Metadata that indicates whether the `recipientId` property is editable..SmartContractInformationgetSmartContractInformation()Reserved for DocuSign..StringgetSource().StringgetStatus()Indicates the envelope status.PropertyMetadatagetStatusMetadata()Metadata that indicates whether the `status` property is editable..List<String>getTabGroupLabels().PropertyMetadatagetTabGroupLabelsMetadata()Metadata that indicates whether the `tabGroupLabels` property is editable..StringgetTabId()The unique identifier for the tab.PropertyMetadatagetTabIdMetadata()Metadata that indicates whether the `tabId` property is editable..StringgetTabLabel()The label string associated with the tab..PropertyMetadatagetTabLabelMetadata()Metadata that indicates whether the `tabLabel` property is editable..StringgetTabOrder().PropertyMetadatagetTabOrderMetadata()Metadata that indicates whether the `tabOrder` property is editable..StringgetTabType().PropertyMetadatagetTabTypeMetadata()Metadata that indicates whether the `tabType` property is editable..StringgetTemplateLocked()When set to **true**, the sender cannot change any attributes of the recipient.PropertyMetadatagetTemplateLockedMetadata()Metadata that indicates whether the `templateLocked` property is editable..StringgetTemplateRequired()When set to **true**, the sender may not remove the recipient.PropertyMetadatagetTemplateRequiredMetadata()Metadata that indicates whether the `templateRequired` property is editable..StringgetThreadId().StringgetTooltip().PropertyMetadatagetToolTipMetadata()Metadata that indicates whether the `toolTip` property is editable..StringgetUnderline()When set to **true**, the information in the tab is underlined..PropertyMetadatagetUnderlineMetadata()Metadata that indicates whether the `underline` property is editable..StringgetWidth()Width of the tab in pixels..PropertyMetadatagetWidthMetadata()Metadata that indicates whether the `width` property is editable..StringgetXPosition()This indicates the horizontal offset of the object on the page.PropertyMetadatagetXPositionMetadata()Metadata that indicates whether the `xPosition` property is editable..StringgetYPosition()This indicates the vertical offset of the object on the page.PropertyMetadatagetYPositionMetadata()Metadata that indicates whether the `yPosition` property is editable..inthashCode()Returns the HashCode.CommentThreadheight(String height)height.CommentThreadheightMetadata(PropertyMetadata heightMetadata)heightMetadata.CommentThreaditalic(String italic)italic.CommentThreaditalicMetadata(PropertyMetadata italicMetadata)italicMetadata.CommentThreadlocalePolicy(LocalePolicyTab localePolicy)localePolicy.CommentThreadmergeField(MergeField mergeField)mergeField.CommentThreadmergeFieldXml(String mergeFieldXml)mergeFieldXml.CommentThreadpageNumber(String pageNumber)pageNumber.CommentThreadpageNumberMetadata(PropertyMetadata pageNumberMetadata)pageNumberMetadata.CommentThreadrecipientId(String recipientId)recipientId.CommentThreadrecipientIdGuid(String recipientIdGuid)recipientIdGuid.CommentThreadrecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)recipientIdGuidMetadata.CommentThreadrecipientIdMetadata(PropertyMetadata recipientIdMetadata)recipientIdMetadata.voidsetAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)setAnchorAllowWhiteSpaceInCharacters.voidsetAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)setAnchorAllowWhiteSpaceInCharactersMetadata.voidsetAnchorCaseSensitive(String anchorCaseSensitive)setAnchorCaseSensitive.voidsetAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)setAnchorCaseSensitiveMetadata.voidsetAnchorHorizontalAlignment(String anchorHorizontalAlignment)setAnchorHorizontalAlignment.voidsetAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)setAnchorHorizontalAlignmentMetadata.voidsetAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)setAnchorIgnoreIfNotPresent.voidsetAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)setAnchorIgnoreIfNotPresentMetadata.voidsetAnchorMatchWholeWord(String anchorMatchWholeWord)setAnchorMatchWholeWord.voidsetAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)setAnchorMatchWholeWordMetadata.voidsetAnchorString(String anchorString)setAnchorString.voidsetAnchorStringMetadata(PropertyMetadata anchorStringMetadata)setAnchorStringMetadata.voidsetAnchorTabProcessorVersion(String anchorTabProcessorVersion)setAnchorTabProcessorVersion.voidsetAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)setAnchorTabProcessorVersionMetadata.voidsetAnchorUnits(String anchorUnits)setAnchorUnits.voidsetAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)setAnchorUnitsMetadata.voidsetAnchorXOffset(String anchorXOffset)setAnchorXOffset.voidsetAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)setAnchorXOffsetMetadata.voidsetAnchorYOffset(String anchorYOffset)setAnchorYOffset.voidsetAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)setAnchorYOffsetMetadata.voidsetBold(String bold)setBold.voidsetBoldMetadata(PropertyMetadata boldMetadata)setBoldMetadata.voidsetCaption(String caption)setCaption.voidsetCaptionMetadata(PropertyMetadata captionMetadata)setCaptionMetadata.voidsetComments(List<Comment> comments)setComments.voidsetConditionalParentLabel(String conditionalParentLabel)setConditionalParentLabel.voidsetConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)setConditionalParentLabelMetadata.voidsetConditionalParentValue(String conditionalParentValue)setConditionalParentValue.voidsetConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)setConditionalParentValueMetadata.voidsetCustomTabId(String customTabId)setCustomTabId.voidsetCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)setCustomTabIdMetadata.voidsetDocumentId(String documentId)setDocumentId.voidsetDocumentIdMetadata(PropertyMetadata documentIdMetadata)setDocumentIdMetadata.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetFont(String font)setFont.voidsetFontColor(String fontColor)setFontColor.voidsetFontColorMetadata(PropertyMetadata fontColorMetadata)setFontColorMetadata.voidsetFontMetadata(PropertyMetadata fontMetadata)setFontMetadata.voidsetFontSize(String fontSize)setFontSize.voidsetFontSizeMetadata(PropertyMetadata fontSizeMetadata)setFontSizeMetadata.voidsetFormOrder(String formOrder)setFormOrder.voidsetFormOrderMetadata(PropertyMetadata formOrderMetadata)setFormOrderMetadata.voidsetFormPageLabel(String formPageLabel)setFormPageLabel.voidsetFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)setFormPageLabelMetadata.voidsetFormPageNumber(String formPageNumber)setFormPageNumber.voidsetFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)setFormPageNumberMetadata.voidsetHeight(String height)setHeight.voidsetHeightMetadata(PropertyMetadata heightMetadata)setHeightMetadata.voidsetItalic(String italic)setItalic.voidsetItalicMetadata(PropertyMetadata italicMetadata)setItalicMetadata.voidsetLocalePolicy(LocalePolicyTab localePolicy)setLocalePolicy.voidsetMergeField(MergeField mergeField)setMergeField.voidsetMergeFieldXml(String mergeFieldXml)setMergeFieldXml.voidsetPageNumber(String pageNumber)setPageNumber.voidsetPageNumberMetadata(PropertyMetadata pageNumberMetadata)setPageNumberMetadata.voidsetRecipientId(String recipientId)setRecipientId.voidsetRecipientIdGuid(String recipientIdGuid)setRecipientIdGuid.voidsetRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)setRecipientIdGuidMetadata.voidsetRecipientIdMetadata(PropertyMetadata recipientIdMetadata)setRecipientIdMetadata.voidsetSmartContractInformation(SmartContractInformation smartContractInformation)setSmartContractInformation.voidsetSource(String source)setSource.voidsetStatus(String status)setStatus.voidsetStatusMetadata(PropertyMetadata statusMetadata)setStatusMetadata.voidsetTabGroupLabels(List<String> tabGroupLabels)setTabGroupLabels.voidsetTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)setTabGroupLabelsMetadata.voidsetTabId(String tabId)setTabId.voidsetTabIdMetadata(PropertyMetadata tabIdMetadata)setTabIdMetadata.voidsetTabLabel(String tabLabel)setTabLabel.voidsetTabLabelMetadata(PropertyMetadata tabLabelMetadata)setTabLabelMetadata.voidsetTabOrder(String tabOrder)setTabOrder.voidsetTabOrderMetadata(PropertyMetadata tabOrderMetadata)setTabOrderMetadata.voidsetTabType(String tabType)setTabType.voidsetTabTypeMetadata(PropertyMetadata tabTypeMetadata)setTabTypeMetadata.voidsetTemplateLocked(String templateLocked)setTemplateLocked.voidsetTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)setTemplateLockedMetadata.voidsetTemplateRequired(String templateRequired)setTemplateRequired.voidsetTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)setTemplateRequiredMetadata.voidsetThreadId(String threadId)setThreadId.voidsetTooltip(String tooltip)setTooltip.voidsetToolTipMetadata(PropertyMetadata toolTipMetadata)setToolTipMetadata.voidsetUnderline(String underline)setUnderline.voidsetUnderlineMetadata(PropertyMetadata underlineMetadata)setUnderlineMetadata.voidsetWidth(String width)setWidth.voidsetWidthMetadata(PropertyMetadata widthMetadata)setWidthMetadata.voidsetXPosition(String xPosition)setXPosition.voidsetXPositionMetadata(PropertyMetadata xPositionMetadata)setXPositionMetadata.voidsetYPosition(String yPosition)setYPosition.voidsetYPositionMetadata(PropertyMetadata yPositionMetadata)setYPositionMetadata.CommentThreadsmartContractInformation(SmartContractInformation smartContractInformation)smartContractInformation.CommentThreadsource(String source)source.CommentThreadstatus(String status)status.CommentThreadstatusMetadata(PropertyMetadata statusMetadata)statusMetadata.CommentThreadtabGroupLabels(List<String> tabGroupLabels)tabGroupLabels.CommentThreadtabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)tabGroupLabelsMetadata.CommentThreadtabId(String tabId)tabId.CommentThreadtabIdMetadata(PropertyMetadata tabIdMetadata)tabIdMetadata.CommentThreadtabLabel(String tabLabel)tabLabel.CommentThreadtabLabelMetadata(PropertyMetadata tabLabelMetadata)tabLabelMetadata.CommentThreadtabOrder(String tabOrder)tabOrder.CommentThreadtabOrderMetadata(PropertyMetadata tabOrderMetadata)tabOrderMetadata.CommentThreadtabType(String tabType)tabType.CommentThreadtabTypeMetadata(PropertyMetadata tabTypeMetadata)tabTypeMetadata.CommentThreadtemplateLocked(String templateLocked)templateLocked.CommentThreadtemplateLockedMetadata(PropertyMetadata templateLockedMetadata)templateLockedMetadata.CommentThreadtemplateRequired(String templateRequired)templateRequired.CommentThreadtemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)templateRequiredMetadata.CommentThreadthreadId(String threadId)threadId.CommentThreadtooltip(String tooltip)tooltip.CommentThreadtoolTipMetadata(PropertyMetadata toolTipMetadata)toolTipMetadata.StringtoString()Converts the given object to string.CommentThreadunderline(String underline)underline.CommentThreadunderlineMetadata(PropertyMetadata underlineMetadata)underlineMetadata.CommentThreadwidth(String width)width.CommentThreadwidthMetadata(PropertyMetadata widthMetadata)widthMetadata.CommentThreadxPosition(String xPosition)xPosition.CommentThreadxPositionMetadata(PropertyMetadata xPositionMetadata)xPositionMetadata.CommentThreadyPosition(String yPosition)yPosition.CommentThreadyPositionMetadata(PropertyMetadata yPositionMetadata)yPositionMetadata.
-
-
-
Method Detail
-
anchorAllowWhiteSpaceInCharacters
public CommentThread anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.- Returns:
- CommentThread
-
getAnchorAllowWhiteSpaceInCharacters
public String getAnchorAllowWhiteSpaceInCharacters()
.- Returns:
- anchorAllowWhiteSpaceInCharacters
-
setAnchorAllowWhiteSpaceInCharacters
public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.
-
anchorAllowWhiteSpaceInCharactersMetadata
public CommentThread anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.- Returns:
- CommentThread
-
getAnchorAllowWhiteSpaceInCharactersMetadata
public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..- Returns:
- anchorAllowWhiteSpaceInCharactersMetadata
-
setAnchorAllowWhiteSpaceInCharactersMetadata
public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.
-
anchorCaseSensitive
public CommentThread anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.- Returns:
- CommentThread
-
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 CommentThread anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.- Returns:
- CommentThread
-
getAnchorCaseSensitiveMetadata
public PropertyMetadata getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..- Returns:
- anchorCaseSensitiveMetadata
-
setAnchorCaseSensitiveMetadata
public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.
-
anchorHorizontalAlignment
public CommentThread anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.- Returns:
- CommentThread
-
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 CommentThread anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.- Returns:
- CommentThread
-
getAnchorHorizontalAlignmentMetadata
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..- Returns:
- anchorHorizontalAlignmentMetadata
-
setAnchorHorizontalAlignmentMetadata
public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.
-
anchorIgnoreIfNotPresent
public CommentThread anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.- Returns:
- CommentThread
-
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 CommentThread anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.- Returns:
- CommentThread
-
getAnchorIgnoreIfNotPresentMetadata
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..- Returns:
- anchorIgnoreIfNotPresentMetadata
-
setAnchorIgnoreIfNotPresentMetadata
public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.
-
anchorMatchWholeWord
public CommentThread anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.- Returns:
- CommentThread
-
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 CommentThread anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.- Returns:
- CommentThread
-
getAnchorMatchWholeWordMetadata
public PropertyMetadata getAnchorMatchWholeWordMetadata()
Metadata that indicates whether the `anchorMatchWholeWord` property is editable..- Returns:
- anchorMatchWholeWordMetadata
-
setAnchorMatchWholeWordMetadata
public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
setAnchorMatchWholeWordMetadata.
-
anchorString
public CommentThread anchorString(String anchorString)
anchorString.- Returns:
- CommentThread
-
getAnchorString
public String getAnchorString()
Anchor text information for a radio button..- Returns:
- anchorString
-
setAnchorString
public void setAnchorString(String anchorString)
setAnchorString.
-
anchorStringMetadata
public CommentThread anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.- Returns:
- CommentThread
-
getAnchorStringMetadata
public PropertyMetadata getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..- Returns:
- anchorStringMetadata
-
setAnchorStringMetadata
public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.
-
anchorTabProcessorVersion
public CommentThread anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.- Returns:
- CommentThread
-
getAnchorTabProcessorVersion
public String getAnchorTabProcessorVersion()
.- Returns:
- anchorTabProcessorVersion
-
setAnchorTabProcessorVersion
public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.
-
anchorTabProcessorVersionMetadata
public CommentThread anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.- Returns:
- CommentThread
-
getAnchorTabProcessorVersionMetadata
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
Reserved for DocuSign..- Returns:
- anchorTabProcessorVersionMetadata
-
setAnchorTabProcessorVersionMetadata
public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
setAnchorTabProcessorVersionMetadata.
-
anchorUnits
public CommentThread anchorUnits(String anchorUnits)
anchorUnits.- Returns:
- CommentThread
-
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 CommentThread anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.- Returns:
- CommentThread
-
getAnchorUnitsMetadata
public PropertyMetadata getAnchorUnitsMetadata()
Metadata that indicates whether the `anchorUnits` property is editable..- Returns:
- anchorUnitsMetadata
-
setAnchorUnitsMetadata
public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
setAnchorUnitsMetadata.
-
anchorXOffset
public CommentThread anchorXOffset(String anchorXOffset)
anchorXOffset.- Returns:
- CommentThread
-
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 CommentThread anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.- Returns:
- CommentThread
-
getAnchorXOffsetMetadata
public PropertyMetadata getAnchorXOffsetMetadata()
Metadata that indicates whether the `anchorXOffset` property is editable..- Returns:
- anchorXOffsetMetadata
-
setAnchorXOffsetMetadata
public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
setAnchorXOffsetMetadata.
-
anchorYOffset
public CommentThread anchorYOffset(String anchorYOffset)
anchorYOffset.- Returns:
- CommentThread
-
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 CommentThread anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.- Returns:
- CommentThread
-
getAnchorYOffsetMetadata
public PropertyMetadata getAnchorYOffsetMetadata()
Metadata that indicates whether the `anchorYOffset` property is editable..- Returns:
- anchorYOffsetMetadata
-
setAnchorYOffsetMetadata
public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
setAnchorYOffsetMetadata.
-
bold
public CommentThread bold(String bold)
bold.- Returns:
- CommentThread
-
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 CommentThread boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.- Returns:
- CommentThread
-
getBoldMetadata
public PropertyMetadata getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..- Returns:
- boldMetadata
-
setBoldMetadata
public void setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.
-
caption
public CommentThread caption(String caption)
caption.- Returns:
- CommentThread
-
getCaption
public String getCaption()
.- Returns:
- caption
-
setCaption
public void setCaption(String caption)
setCaption.
-
captionMetadata
public CommentThread captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.- Returns:
- CommentThread
-
getCaptionMetadata
public PropertyMetadata getCaptionMetadata()
Get captionMetadata.- Returns:
- captionMetadata
-
setCaptionMetadata
public void setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.
-
comments
public CommentThread comments(List<Comment> comments)
comments.- Returns:
- CommentThread
-
addCommentsItem
public CommentThread addCommentsItem(Comment commentsItem)
addCommentsItem.- Returns:
- CommentThread
-
conditionalParentLabel
public CommentThread conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.- Returns:
- CommentThread
-
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 CommentThread conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
conditionalParentLabelMetadata.- Returns:
- CommentThread
-
getConditionalParentLabelMetadata
public PropertyMetadata getConditionalParentLabelMetadata()
Metadata that indicates whether the `conditionalParentLabel` property is editable..- Returns:
- conditionalParentLabelMetadata
-
setConditionalParentLabelMetadata
public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
setConditionalParentLabelMetadata.
-
conditionalParentValue
public CommentThread conditionalParentValue(String conditionalParentValue)
conditionalParentValue.- Returns:
- CommentThread
-
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 CommentThread conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
conditionalParentValueMetadata.- Returns:
- CommentThread
-
getConditionalParentValueMetadata
public PropertyMetadata getConditionalParentValueMetadata()
Metadata that indicates whether the `conditionalParentValue` property is editable..- Returns:
- conditionalParentValueMetadata
-
setConditionalParentValueMetadata
public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
setConditionalParentValueMetadata.
-
customTabId
public CommentThread customTabId(String customTabId)
customTabId.- Returns:
- CommentThread
-
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 CommentThread customTabIdMetadata(PropertyMetadata customTabIdMetadata)
customTabIdMetadata.- Returns:
- CommentThread
-
getCustomTabIdMetadata
public PropertyMetadata getCustomTabIdMetadata()
Metadata that indicates whether the `customTabId` property is editable..- Returns:
- customTabIdMetadata
-
setCustomTabIdMetadata
public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)
setCustomTabIdMetadata.
-
documentId
public CommentThread documentId(String documentId)
documentId.- Returns:
- CommentThread
-
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 CommentThread documentIdMetadata(PropertyMetadata documentIdMetadata)
documentIdMetadata.- Returns:
- CommentThread
-
getDocumentIdMetadata
public PropertyMetadata getDocumentIdMetadata()
Metadata that indicates whether the `documentId` property is editable..- Returns:
- documentIdMetadata
-
setDocumentIdMetadata
public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
setDocumentIdMetadata.
-
errorDetails
public CommentThread errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- CommentThread
-
getErrorDetails
public ErrorDetails getErrorDetails()
This object describes errors that occur. It is only valid for responses and ignored in requests..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
font
public CommentThread font(String font)
font.- Returns:
- CommentThread
-
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.
-
fontColor
public CommentThread fontColor(String fontColor)
fontColor.- Returns:
- CommentThread
-
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 CommentThread fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.- Returns:
- CommentThread
-
getFontColorMetadata
public PropertyMetadata getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..- Returns:
- fontColorMetadata
-
setFontColorMetadata
public void setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.
-
fontMetadata
public CommentThread fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.- Returns:
- CommentThread
-
getFontMetadata
public PropertyMetadata getFontMetadata()
Metadata that indicates whether the `font` property is editable..- Returns:
- fontMetadata
-
setFontMetadata
public void setFontMetadata(PropertyMetadata fontMetadata)
setFontMetadata.
-
fontSize
public CommentThread fontSize(String fontSize)
fontSize.- Returns:
- CommentThread
-
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 CommentThread fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.- Returns:
- CommentThread
-
getFontSizeMetadata
public PropertyMetadata getFontSizeMetadata()
Metadata that indicates whether the `fontSize` property is editable..- Returns:
- fontSizeMetadata
-
setFontSizeMetadata
public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
setFontSizeMetadata.
-
formOrder
public CommentThread formOrder(String formOrder)
formOrder.- Returns:
- CommentThread
-
getFormOrder
public String getFormOrder()
.- Returns:
- formOrder
-
setFormOrder
public void setFormOrder(String formOrder)
setFormOrder.
-
formOrderMetadata
public CommentThread formOrderMetadata(PropertyMetadata formOrderMetadata)
formOrderMetadata.- Returns:
- CommentThread
-
getFormOrderMetadata
public PropertyMetadata getFormOrderMetadata()
Metadata that indicates whether the `formOrder` property is editable..- Returns:
- formOrderMetadata
-
setFormOrderMetadata
public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)
setFormOrderMetadata.
-
formPageLabel
public CommentThread formPageLabel(String formPageLabel)
formPageLabel.- Returns:
- CommentThread
-
getFormPageLabel
public String getFormPageLabel()
.- Returns:
- formPageLabel
-
setFormPageLabel
public void setFormPageLabel(String formPageLabel)
setFormPageLabel.
-
formPageLabelMetadata
public CommentThread formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
formPageLabelMetadata.- Returns:
- CommentThread
-
getFormPageLabelMetadata
public PropertyMetadata getFormPageLabelMetadata()
Metadata that indicates whether the `formPageLabel` property is editable..- Returns:
- formPageLabelMetadata
-
setFormPageLabelMetadata
public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
setFormPageLabelMetadata.
-
formPageNumber
public CommentThread formPageNumber(String formPageNumber)
formPageNumber.- Returns:
- CommentThread
-
getFormPageNumber
public String getFormPageNumber()
.- Returns:
- formPageNumber
-
setFormPageNumber
public void setFormPageNumber(String formPageNumber)
setFormPageNumber.
-
formPageNumberMetadata
public CommentThread formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
formPageNumberMetadata.- Returns:
- CommentThread
-
getFormPageNumberMetadata
public PropertyMetadata getFormPageNumberMetadata()
Metadata that indicates whether the `fromPageNumber` property is editable..- Returns:
- formPageNumberMetadata
-
setFormPageNumberMetadata
public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
setFormPageNumberMetadata.
-
height
public CommentThread height(String height)
height.- Returns:
- CommentThread
-
getHeight
public String getHeight()
Height of the tab in pixels..- Returns:
- height
-
setHeight
public void setHeight(String height)
setHeight.
-
heightMetadata
public CommentThread heightMetadata(PropertyMetadata heightMetadata)
heightMetadata.- Returns:
- CommentThread
-
getHeightMetadata
public PropertyMetadata getHeightMetadata()
Metadata that indicates whether the `height` property is editable..- Returns:
- heightMetadata
-
setHeightMetadata
public void setHeightMetadata(PropertyMetadata heightMetadata)
setHeightMetadata.
-
italic
public CommentThread italic(String italic)
italic.- Returns:
- CommentThread
-
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 CommentThread italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.- Returns:
- CommentThread
-
getItalicMetadata
public PropertyMetadata getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..- Returns:
- italicMetadata
-
setItalicMetadata
public void setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.
-
localePolicy
public CommentThread localePolicy(LocalePolicyTab localePolicy)
localePolicy.- Returns:
- CommentThread
-
getLocalePolicy
public LocalePolicyTab getLocalePolicy()
Reserved for DocuSign..- Returns:
- localePolicy
-
setLocalePolicy
public void setLocalePolicy(LocalePolicyTab localePolicy)
setLocalePolicy.
-
mergeField
public CommentThread mergeField(MergeField mergeField)
mergeField.- Returns:
- CommentThread
-
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 CommentThread mergeFieldXml(String mergeFieldXml)
mergeFieldXml.- Returns:
- CommentThread
-
getMergeFieldXml
public String getMergeFieldXml()
.- Returns:
- mergeFieldXml
-
setMergeFieldXml
public void setMergeFieldXml(String mergeFieldXml)
setMergeFieldXml.
-
pageNumber
public CommentThread pageNumber(String pageNumber)
pageNumber.- Returns:
- CommentThread
-
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 CommentThread pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.- Returns:
- CommentThread
-
getPageNumberMetadata
public PropertyMetadata getPageNumberMetadata()
Metadata that indicates whether the `pageNumber` property is editable..- Returns:
- pageNumberMetadata
-
setPageNumberMetadata
public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
setPageNumberMetadata.
-
recipientId
public CommentThread recipientId(String recipientId)
recipientId.- Returns:
- CommentThread
-
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 CommentThread recipientIdGuid(String recipientIdGuid)
recipientIdGuid.- Returns:
- CommentThread
-
getRecipientIdGuid
public String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.
-
recipientIdGuidMetadata
public CommentThread recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
recipientIdGuidMetadata.- Returns:
- CommentThread
-
getRecipientIdGuidMetadata
public PropertyMetadata getRecipientIdGuidMetadata()
Metadata that indicates whether the `recipientIdGuid` property is editable..- Returns:
- recipientIdGuidMetadata
-
setRecipientIdGuidMetadata
public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
setRecipientIdGuidMetadata.
-
recipientIdMetadata
public CommentThread recipientIdMetadata(PropertyMetadata recipientIdMetadata)
recipientIdMetadata.- Returns:
- CommentThread
-
getRecipientIdMetadata
public PropertyMetadata getRecipientIdMetadata()
Metadata that indicates whether the `recipientId` property is editable..- Returns:
- recipientIdMetadata
-
setRecipientIdMetadata
public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
setRecipientIdMetadata.
-
smartContractInformation
public CommentThread smartContractInformation(SmartContractInformation smartContractInformation)
smartContractInformation.- Returns:
- CommentThread
-
getSmartContractInformation
public SmartContractInformation getSmartContractInformation()
Reserved for DocuSign..- Returns:
- smartContractInformation
-
setSmartContractInformation
public void setSmartContractInformation(SmartContractInformation smartContractInformation)
setSmartContractInformation.
-
source
public CommentThread source(String source)
source.- Returns:
- CommentThread
-
getSource
public String getSource()
.- Returns:
- source
-
setSource
public void setSource(String source)
setSource.
-
status
public CommentThread status(String status)
status.- Returns:
- CommentThread
-
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 CommentThread statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.- Returns:
- CommentThread
-
getStatusMetadata
public PropertyMetadata getStatusMetadata()
Metadata that indicates whether the `status` property is editable..- Returns:
- statusMetadata
-
setStatusMetadata
public void setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.
-
tabGroupLabels
public CommentThread tabGroupLabels(List<String> tabGroupLabels)
tabGroupLabels.- Returns:
- CommentThread
-
addTabGroupLabelsItem
public CommentThread addTabGroupLabelsItem(String tabGroupLabelsItem)
addTabGroupLabelsItem.- Returns:
- CommentThread
-
tabGroupLabelsMetadata
public CommentThread tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
tabGroupLabelsMetadata.- Returns:
- CommentThread
-
getTabGroupLabelsMetadata
public PropertyMetadata getTabGroupLabelsMetadata()
Metadata that indicates whether the `tabGroupLabels` property is editable..- Returns:
- tabGroupLabelsMetadata
-
setTabGroupLabelsMetadata
public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
setTabGroupLabelsMetadata.
-
tabId
public CommentThread tabId(String tabId)
tabId.- Returns:
- CommentThread
-
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 CommentThread tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.- Returns:
- CommentThread
-
getTabIdMetadata
public PropertyMetadata getTabIdMetadata()
Metadata that indicates whether the `tabId` property is editable..- Returns:
- tabIdMetadata
-
setTabIdMetadata
public void setTabIdMetadata(PropertyMetadata tabIdMetadata)
setTabIdMetadata.
-
tabLabel
public CommentThread tabLabel(String tabLabel)
tabLabel.- Returns:
- CommentThread
-
getTabLabel
public String getTabLabel()
The label string associated with the tab..- Returns:
- tabLabel
-
setTabLabel
public void setTabLabel(String tabLabel)
setTabLabel.
-
tabLabelMetadata
public CommentThread tabLabelMetadata(PropertyMetadata tabLabelMetadata)
tabLabelMetadata.- Returns:
- CommentThread
-
getTabLabelMetadata
public PropertyMetadata getTabLabelMetadata()
Metadata that indicates whether the `tabLabel` property is editable..- Returns:
- tabLabelMetadata
-
setTabLabelMetadata
public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)
setTabLabelMetadata.
-
tabOrder
public CommentThread tabOrder(String tabOrder)
tabOrder.- Returns:
- CommentThread
-
getTabOrder
public String getTabOrder()
.- Returns:
- tabOrder
-
setTabOrder
public void setTabOrder(String tabOrder)
setTabOrder.
-
tabOrderMetadata
public CommentThread tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.- Returns:
- CommentThread
-
getTabOrderMetadata
public PropertyMetadata getTabOrderMetadata()
Metadata that indicates whether the `tabOrder` property is editable..- Returns:
- tabOrderMetadata
-
setTabOrderMetadata
public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
setTabOrderMetadata.
-
tabType
public CommentThread tabType(String tabType)
tabType.- Returns:
- CommentThread
-
getTabType
public String getTabType()
.- Returns:
- tabType
-
setTabType
public void setTabType(String tabType)
setTabType.
-
tabTypeMetadata
public CommentThread tabTypeMetadata(PropertyMetadata tabTypeMetadata)
tabTypeMetadata.- Returns:
- CommentThread
-
getTabTypeMetadata
public PropertyMetadata getTabTypeMetadata()
Metadata that indicates whether the `tabType` property is editable..- Returns:
- tabTypeMetadata
-
setTabTypeMetadata
public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
setTabTypeMetadata.
-
templateLocked
public CommentThread templateLocked(String templateLocked)
templateLocked.- Returns:
- CommentThread
-
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 CommentThread templateLockedMetadata(PropertyMetadata templateLockedMetadata)
templateLockedMetadata.- Returns:
- CommentThread
-
getTemplateLockedMetadata
public PropertyMetadata getTemplateLockedMetadata()
Metadata that indicates whether the `templateLocked` property is editable..- Returns:
- templateLockedMetadata
-
setTemplateLockedMetadata
public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
setTemplateLockedMetadata.
-
templateRequired
public CommentThread templateRequired(String templateRequired)
templateRequired.- Returns:
- CommentThread
-
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 CommentThread templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
templateRequiredMetadata.- Returns:
- CommentThread
-
getTemplateRequiredMetadata
public PropertyMetadata getTemplateRequiredMetadata()
Metadata that indicates whether the `templateRequired` property is editable..- Returns:
- templateRequiredMetadata
-
setTemplateRequiredMetadata
public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
setTemplateRequiredMetadata.
-
threadId
public CommentThread threadId(String threadId)
threadId.- Returns:
- CommentThread
-
getThreadId
public String getThreadId()
.- Returns:
- threadId
-
setThreadId
public void setThreadId(String threadId)
setThreadId.
-
tooltip
public CommentThread tooltip(String tooltip)
tooltip.- Returns:
- CommentThread
-
getTooltip
public String getTooltip()
.- Returns:
- tooltip
-
setTooltip
public void setTooltip(String tooltip)
setTooltip.
-
toolTipMetadata
public CommentThread toolTipMetadata(PropertyMetadata toolTipMetadata)
toolTipMetadata.- Returns:
- CommentThread
-
getToolTipMetadata
public PropertyMetadata getToolTipMetadata()
Metadata that indicates whether the `toolTip` property is editable..- Returns:
- toolTipMetadata
-
setToolTipMetadata
public void setToolTipMetadata(PropertyMetadata toolTipMetadata)
setToolTipMetadata.
-
underline
public CommentThread underline(String underline)
underline.- Returns:
- CommentThread
-
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 CommentThread underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.- Returns:
- CommentThread
-
getUnderlineMetadata
public PropertyMetadata getUnderlineMetadata()
Metadata that indicates whether the `underline` property is editable..- Returns:
- underlineMetadata
-
setUnderlineMetadata
public void setUnderlineMetadata(PropertyMetadata underlineMetadata)
setUnderlineMetadata.
-
width
public CommentThread width(String width)
width.- Returns:
- CommentThread
-
getWidth
public String getWidth()
Width of the tab in pixels..- Returns:
- width
-
setWidth
public void setWidth(String width)
setWidth.
-
widthMetadata
public CommentThread widthMetadata(PropertyMetadata widthMetadata)
widthMetadata.- Returns:
- CommentThread
-
getWidthMetadata
public PropertyMetadata getWidthMetadata()
Metadata that indicates whether the `width` property is editable..- Returns:
- widthMetadata
-
setWidthMetadata
public void setWidthMetadata(PropertyMetadata widthMetadata)
setWidthMetadata.
-
xPosition
public CommentThread xPosition(String xPosition)
xPosition.- Returns:
- CommentThread
-
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 CommentThread xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.- Returns:
- CommentThread
-
getXPositionMetadata
public PropertyMetadata getXPositionMetadata()
Metadata that indicates whether the `xPosition` property is editable..- Returns:
- xPositionMetadata
-
setXPositionMetadata
public void setXPositionMetadata(PropertyMetadata xPositionMetadata)
setXPositionMetadata.
-
yPosition
public CommentThread yPosition(String yPosition)
yPosition.- Returns:
- CommentThread
-
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 CommentThread yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.- Returns:
- CommentThread
-
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.
-
-