Class SmartSection

    • Constructor Detail

      • SmartSection

        public SmartSection()
    • Method Detail

      • anchorAllowWhiteSpaceInCharacters

        public SmartSection anchorAllowWhiteSpaceInCharacters​(String anchorAllowWhiteSpaceInCharacters)
        anchorAllowWhiteSpaceInCharacters.
        Returns:
        SmartSection
      • getAnchorAllowWhiteSpaceInCharacters

        public String getAnchorAllowWhiteSpaceInCharacters()
        .
        Returns:
        anchorAllowWhiteSpaceInCharacters
      • setAnchorAllowWhiteSpaceInCharacters

        public void setAnchorAllowWhiteSpaceInCharacters​(String anchorAllowWhiteSpaceInCharacters)
        setAnchorAllowWhiteSpaceInCharacters.
      • anchorAllowWhiteSpaceInCharactersMetadata

        public SmartSection anchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        anchorAllowWhiteSpaceInCharactersMetadata.
        Returns:
        SmartSection
      • getAnchorAllowWhiteSpaceInCharactersMetadata

        public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
        Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..
        Returns:
        anchorAllowWhiteSpaceInCharactersMetadata
      • setAnchorAllowWhiteSpaceInCharactersMetadata

        public void setAnchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        setAnchorAllowWhiteSpaceInCharactersMetadata.
      • anchorCaseSensitive

        public SmartSection anchorCaseSensitive​(String anchorCaseSensitive)
        anchorCaseSensitive.
        Returns:
        SmartSection
      • 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 SmartSection anchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        anchorCaseSensitiveMetadata.
        Returns:
        SmartSection
      • getAnchorCaseSensitiveMetadata

        public PropertyMetadata getAnchorCaseSensitiveMetadata()
        Metadata that indicates whether the `anchorCaseSensitive` property is editable..
        Returns:
        anchorCaseSensitiveMetadata
      • setAnchorCaseSensitiveMetadata

        public void setAnchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        setAnchorCaseSensitiveMetadata.
      • anchorHorizontalAlignment

        public SmartSection anchorHorizontalAlignment​(String anchorHorizontalAlignment)
        anchorHorizontalAlignment.
        Returns:
        SmartSection
      • 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 SmartSection anchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        anchorHorizontalAlignmentMetadata.
        Returns:
        SmartSection
      • getAnchorHorizontalAlignmentMetadata

        public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
        Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..
        Returns:
        anchorHorizontalAlignmentMetadata
      • setAnchorHorizontalAlignmentMetadata

        public void setAnchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        setAnchorHorizontalAlignmentMetadata.
      • anchorIgnoreIfNotPresent

        public SmartSection anchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        anchorIgnoreIfNotPresent.
        Returns:
        SmartSection
      • 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 SmartSection anchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        anchorIgnoreIfNotPresentMetadata.
        Returns:
        SmartSection
      • getAnchorIgnoreIfNotPresentMetadata

        public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
        Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..
        Returns:
        anchorIgnoreIfNotPresentMetadata
      • setAnchorIgnoreIfNotPresentMetadata

        public void setAnchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        setAnchorIgnoreIfNotPresentMetadata.
      • anchorMatchWholeWord

        public SmartSection anchorMatchWholeWord​(String anchorMatchWholeWord)
        anchorMatchWholeWord.
        Returns:
        SmartSection
      • 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 SmartSection anchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        anchorMatchWholeWordMetadata.
        Returns:
        SmartSection
      • getAnchorMatchWholeWordMetadata

        public PropertyMetadata getAnchorMatchWholeWordMetadata()
        Metadata that indicates whether the `anchorMatchWholeWord` property is editable..
        Returns:
        anchorMatchWholeWordMetadata
      • setAnchorMatchWholeWordMetadata

        public void setAnchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        setAnchorMatchWholeWordMetadata.
      • anchorString

        public SmartSection anchorString​(String anchorString)
        anchorString.
        Returns:
        SmartSection
      • getAnchorString

        public String getAnchorString()
        Anchor text information for a radio button..
        Returns:
        anchorString
      • setAnchorString

        public void setAnchorString​(String anchorString)
        setAnchorString.
      • anchorStringMetadata

        public SmartSection anchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        anchorStringMetadata.
        Returns:
        SmartSection
      • getAnchorStringMetadata

        public PropertyMetadata getAnchorStringMetadata()
        Metadata that indicates whether the `anchorString` property is editable..
        Returns:
        anchorStringMetadata
      • setAnchorStringMetadata

        public void setAnchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        setAnchorStringMetadata.
      • anchorTabProcessorVersion

        public SmartSection anchorTabProcessorVersion​(String anchorTabProcessorVersion)
        anchorTabProcessorVersion.
        Returns:
        SmartSection
      • getAnchorTabProcessorVersion

        public String getAnchorTabProcessorVersion()
        .
        Returns:
        anchorTabProcessorVersion
      • setAnchorTabProcessorVersion

        public void setAnchorTabProcessorVersion​(String anchorTabProcessorVersion)
        setAnchorTabProcessorVersion.
      • anchorTabProcessorVersionMetadata

        public SmartSection anchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        anchorTabProcessorVersionMetadata.
        Returns:
        SmartSection
      • getAnchorTabProcessorVersionMetadata

        public PropertyMetadata getAnchorTabProcessorVersionMetadata()
        Reserved for DocuSign..
        Returns:
        anchorTabProcessorVersionMetadata
      • setAnchorTabProcessorVersionMetadata

        public void setAnchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        setAnchorTabProcessorVersionMetadata.
      • anchorUnits

        public SmartSection anchorUnits​(String anchorUnits)
        anchorUnits.
        Returns:
        SmartSection
      • 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 SmartSection anchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        anchorUnitsMetadata.
        Returns:
        SmartSection
      • getAnchorUnitsMetadata

        public PropertyMetadata getAnchorUnitsMetadata()
        Metadata that indicates whether the `anchorUnits` property is editable..
        Returns:
        anchorUnitsMetadata
      • setAnchorUnitsMetadata

        public void setAnchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        setAnchorUnitsMetadata.
      • anchorXOffset

        public SmartSection anchorXOffset​(String anchorXOffset)
        anchorXOffset.
        Returns:
        SmartSection
      • 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 SmartSection anchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        anchorXOffsetMetadata.
        Returns:
        SmartSection
      • getAnchorXOffsetMetadata

        public PropertyMetadata getAnchorXOffsetMetadata()
        Metadata that indicates whether the `anchorXOffset` property is editable..
        Returns:
        anchorXOffsetMetadata
      • setAnchorXOffsetMetadata

        public void setAnchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        setAnchorXOffsetMetadata.
      • anchorYOffset

        public SmartSection anchorYOffset​(String anchorYOffset)
        anchorYOffset.
        Returns:
        SmartSection
      • 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 SmartSection anchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        anchorYOffsetMetadata.
        Returns:
        SmartSection
      • getAnchorYOffsetMetadata

        public PropertyMetadata getAnchorYOffsetMetadata()
        Metadata that indicates whether the `anchorYOffset` property is editable..
        Returns:
        anchorYOffsetMetadata
      • setAnchorYOffsetMetadata

        public void setAnchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        setAnchorYOffsetMetadata.
      • caption

        public SmartSection caption​(String caption)
        caption.
        Returns:
        SmartSection
      • getCaption

        public String getCaption()
        .
        Returns:
        caption
      • setCaption

        public void setCaption​(String caption)
        setCaption.
      • getCaptionMetadata

        public PropertyMetadata getCaptionMetadata()
        .
        Returns:
        captionMetadata
      • setCaptionMetadata

        public void setCaptionMetadata​(PropertyMetadata captionMetadata)
        setCaptionMetadata.
      • caseSensitive

        public SmartSection caseSensitive​(Boolean caseSensitive)
        caseSensitive.
        Returns:
        SmartSection
      • isCaseSensitive

        public Boolean isCaseSensitive()
        .
        Returns:
        caseSensitive
      • setCaseSensitive

        public void setCaseSensitive​(Boolean caseSensitive)
        setCaseSensitive.
      • conditionalParentLabel

        public SmartSection conditionalParentLabel​(String conditionalParentLabel)
        conditionalParentLabel.
        Returns:
        SmartSection
      • 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 SmartSection conditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        conditionalParentLabelMetadata.
        Returns:
        SmartSection
      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        Metadata that indicates whether the `conditionalParentLabel` property is editable..
        Returns:
        conditionalParentLabelMetadata
      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        setConditionalParentLabelMetadata.
      • conditionalParentValue

        public SmartSection conditionalParentValue​(String conditionalParentValue)
        conditionalParentValue.
        Returns:
        SmartSection
      • 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 SmartSection conditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        conditionalParentValueMetadata.
        Returns:
        SmartSection
      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        Metadata that indicates whether the `conditionalParentValue` property is editable..
        Returns:
        conditionalParentValueMetadata
      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        setConditionalParentValueMetadata.
      • customTabId

        public SmartSection customTabId​(String customTabId)
        customTabId.
        Returns:
        SmartSection
      • 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 SmartSection customTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        customTabIdMetadata.
        Returns:
        SmartSection
      • getCustomTabIdMetadata

        public PropertyMetadata getCustomTabIdMetadata()
        Metadata that indicates whether the `customTabId` property is editable..
        Returns:
        customTabIdMetadata
      • setCustomTabIdMetadata

        public void setCustomTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        setCustomTabIdMetadata.
      • getDisplaySettings

        public SmartSectionDisplaySettings getDisplaySettings()
        This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays..
        Returns:
        displaySettings
      • documentId

        public SmartSection documentId​(String documentId)
        documentId.
        Returns:
        SmartSection
      • 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 SmartSection documentIdMetadata​(PropertyMetadata documentIdMetadata)
        documentIdMetadata.
        Returns:
        SmartSection
      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        Metadata that indicates whether the `documentId` property is editable..
        Returns:
        documentIdMetadata
      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)
        setDocumentIdMetadata.
      • endAnchor

        public SmartSection endAnchor​(String endAnchor)
        endAnchor.
        Returns:
        SmartSection
      • getEndAnchor

        public String getEndAnchor()
        .
        Returns:
        endAnchor
      • setEndAnchor

        public void setEndAnchor​(String endAnchor)
        setEndAnchor.
      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Array or errors..
        Returns:
        errorDetails
      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.
      • formOrder

        public SmartSection formOrder​(String formOrder)
        formOrder.
        Returns:
        SmartSection
      • getFormOrder

        public String getFormOrder()
        .
        Returns:
        formOrder
      • setFormOrder

        public void setFormOrder​(String formOrder)
        setFormOrder.
      • formOrderMetadata

        public SmartSection formOrderMetadata​(PropertyMetadata formOrderMetadata)
        formOrderMetadata.
        Returns:
        SmartSection
      • getFormOrderMetadata

        public PropertyMetadata getFormOrderMetadata()
        Metadata that indicates whether the `formOrder` property is editable..
        Returns:
        formOrderMetadata
      • setFormOrderMetadata

        public void setFormOrderMetadata​(PropertyMetadata formOrderMetadata)
        setFormOrderMetadata.
      • formPageLabel

        public SmartSection formPageLabel​(String formPageLabel)
        formPageLabel.
        Returns:
        SmartSection
      • getFormPageLabel

        public String getFormPageLabel()
        .
        Returns:
        formPageLabel
      • setFormPageLabel

        public void setFormPageLabel​(String formPageLabel)
        setFormPageLabel.
      • formPageLabelMetadata

        public SmartSection formPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        formPageLabelMetadata.
        Returns:
        SmartSection
      • getFormPageLabelMetadata

        public PropertyMetadata getFormPageLabelMetadata()
        Metadata that indicates whether the `formPageLabel` property is editable..
        Returns:
        formPageLabelMetadata
      • setFormPageLabelMetadata

        public void setFormPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        setFormPageLabelMetadata.
      • formPageNumber

        public SmartSection formPageNumber​(String formPageNumber)
        formPageNumber.
        Returns:
        SmartSection
      • getFormPageNumber

        public String getFormPageNumber()
        .
        Returns:
        formPageNumber
      • setFormPageNumber

        public void setFormPageNumber​(String formPageNumber)
        setFormPageNumber.
      • formPageNumberMetadata

        public SmartSection formPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        formPageNumberMetadata.
        Returns:
        SmartSection
      • 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.
      • getHeightMetadata

        public PropertyMetadata getHeightMetadata()
        Metadata that indicates whether the `height` property is editable..
        Returns:
        heightMetadata
      • setHeightMetadata

        public void setHeightMetadata​(PropertyMetadata heightMetadata)
        setHeightMetadata.
      • getLocked

        public String getLocked()
        When set to **true**, the signer cannot change the data of the custom tab..
        Returns:
        locked
      • setLocked

        public void setLocked​(String locked)
        setLocked.
      • getLockedMetadata

        public PropertyMetadata getLockedMetadata()
        Metadata that indicates whether the `locked` property is editable..
        Returns:
        lockedMetadata
      • setLockedMetadata

        public void setLockedMetadata​(PropertyMetadata lockedMetadata)
        setLockedMetadata.
      • 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 SmartSection mergeFieldXml​(String mergeFieldXml)
        mergeFieldXml.
        Returns:
        SmartSection
      • getMergeFieldXml

        public String getMergeFieldXml()
        .
        Returns:
        mergeFieldXml
      • setMergeFieldXml

        public void setMergeFieldXml​(String mergeFieldXml)
        setMergeFieldXml.
      • overlayType

        public SmartSection overlayType​(String overlayType)
        overlayType.
        Returns:
        SmartSection
      • getOverlayType

        public String getOverlayType()
        .
        Returns:
        overlayType
      • setOverlayType

        public void setOverlayType​(String overlayType)
        setOverlayType.
      • overlayTypeMetadata

        public SmartSection overlayTypeMetadata​(PropertyMetadata overlayTypeMetadata)
        overlayTypeMetadata.
        Returns:
        SmartSection
      • getOverlayTypeMetadata

        public PropertyMetadata getOverlayTypeMetadata()
        Metadata that indicates whether the `overlayType` property is editable..
        Returns:
        overlayTypeMetadata
      • setOverlayTypeMetadata

        public void setOverlayTypeMetadata​(PropertyMetadata overlayTypeMetadata)
        setOverlayTypeMetadata.
      • pageNumber

        public SmartSection pageNumber​(String pageNumber)
        pageNumber.
        Returns:
        SmartSection
      • 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 SmartSection pageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        pageNumberMetadata.
        Returns:
        SmartSection
      • getPageNumberMetadata

        public PropertyMetadata getPageNumberMetadata()
        Metadata that indicates whether the `pageNumber` property is editable..
        Returns:
        pageNumberMetadata
      • setPageNumberMetadata

        public void setPageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        setPageNumberMetadata.
      • recipientId

        public SmartSection recipientId​(String recipientId)
        recipientId.
        Returns:
        SmartSection
      • 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 SmartSection recipientIdGuid​(String recipientIdGuid)
        recipientIdGuid.
        Returns:
        SmartSection
      • getRecipientIdGuid

        public String getRecipientIdGuid()
        .
        Returns:
        recipientIdGuid
      • setRecipientIdGuid

        public void setRecipientIdGuid​(String recipientIdGuid)
        setRecipientIdGuid.
      • recipientIdGuidMetadata

        public SmartSection recipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        recipientIdGuidMetadata.
        Returns:
        SmartSection
      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        Metadata that indicates whether the `recipientIdGuid` property is editable..
        Returns:
        recipientIdGuidMetadata
      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        setRecipientIdGuidMetadata.
      • recipientIdMetadata

        public SmartSection recipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        recipientIdMetadata.
        Returns:
        SmartSection
      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        Metadata that indicates whether the `recipientId` property is editable..
        Returns:
        recipientIdMetadata
      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        setRecipientIdMetadata.
      • removeEndAnchor

        public SmartSection removeEndAnchor​(Boolean removeEndAnchor)
        removeEndAnchor.
        Returns:
        SmartSection
      • isRemoveEndAnchor

        public Boolean isRemoveEndAnchor()
        .
        Returns:
        removeEndAnchor
      • setRemoveEndAnchor

        public void setRemoveEndAnchor​(Boolean removeEndAnchor)
        setRemoveEndAnchor.
      • removeStartAnchor

        public SmartSection removeStartAnchor​(Boolean removeStartAnchor)
        removeStartAnchor.
        Returns:
        SmartSection
      • isRemoveStartAnchor

        public Boolean isRemoveStartAnchor()
        .
        Returns:
        removeStartAnchor
      • setRemoveStartAnchor

        public void setRemoveStartAnchor​(Boolean removeStartAnchor)
        setRemoveStartAnchor.
      • getShared

        public String getShared()
        When set to **true**, this custom tab is shared..
        Returns:
        shared
      • setShared

        public void setShared​(String shared)
        setShared.
      • getSharedMetadata

        public PropertyMetadata getSharedMetadata()
        Metadata that indicates whether the `shared` property is editable..
        Returns:
        sharedMetadata
      • setSharedMetadata

        public void setSharedMetadata​(PropertyMetadata sharedMetadata)
        setSharedMetadata.
      • 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.
      • startAnchor

        public SmartSection startAnchor​(String startAnchor)
        startAnchor.
        Returns:
        SmartSection
      • getStartAnchor

        public String getStartAnchor()
        .
        Returns:
        startAnchor
      • setStartAnchor

        public void setStartAnchor​(String startAnchor)
        setStartAnchor.
      • getStartPosition

        public SmartSectionAnchorPosition getStartPosition()
        Starting position of the current result set..
        Returns:
        startPosition
      • 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.
      • getStatusMetadata

        public PropertyMetadata getStatusMetadata()
        Metadata that indicates whether the `status` property is editable..
        Returns:
        statusMetadata
      • setStatusMetadata

        public void setStatusMetadata​(PropertyMetadata statusMetadata)
        setStatusMetadata.
      • tabGroupLabels

        public SmartSection tabGroupLabels​(List<String> tabGroupLabels)
        tabGroupLabels.
        Returns:
        SmartSection
      • addTabGroupLabelsItem

        public SmartSection addTabGroupLabelsItem​(String tabGroupLabelsItem)
        addTabGroupLabelsItem.
        Returns:
        SmartSection
      • getTabGroupLabels

        public List<String> getTabGroupLabels()
        .
        Returns:
        tabGroupLabels
      • setTabGroupLabels

        public void setTabGroupLabels​(List<String> tabGroupLabels)
        setTabGroupLabels.
      • tabGroupLabelsMetadata

        public SmartSection tabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        tabGroupLabelsMetadata.
        Returns:
        SmartSection
      • 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.
      • getTabIdMetadata

        public PropertyMetadata getTabIdMetadata()
        Metadata that indicates whether the `tabId` property is editable..
        Returns:
        tabIdMetadata
      • setTabIdMetadata

        public void setTabIdMetadata​(PropertyMetadata tabIdMetadata)
        setTabIdMetadata.
      • tabLabel

        public SmartSection tabLabel​(String tabLabel)
        tabLabel.
        Returns:
        SmartSection
      • getTabLabel

        public String getTabLabel()
        The label string associated with the tab..
        Returns:
        tabLabel
      • setTabLabel

        public void setTabLabel​(String tabLabel)
        setTabLabel.
      • tabOrder

        public SmartSection tabOrder​(String tabOrder)
        tabOrder.
        Returns:
        SmartSection
      • getTabOrder

        public String getTabOrder()
        .
        Returns:
        tabOrder
      • setTabOrder

        public void setTabOrder​(String tabOrder)
        setTabOrder.
      • getTabOrderMetadata

        public PropertyMetadata getTabOrderMetadata()
        Metadata that indicates whether the `tabOrder` property is editable..
        Returns:
        tabOrderMetadata
      • setTabOrderMetadata

        public void setTabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        setTabOrderMetadata.
      • tabType

        public SmartSection tabType​(String tabType)
        tabType.
        Returns:
        SmartSection
      • getTabType

        public String getTabType()
        .
        Returns:
        tabType
      • setTabType

        public void setTabType​(String tabType)
        setTabType.
      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        Metadata that indicates whether the `tabType` property is editable..
        Returns:
        tabTypeMetadata
      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        setTabTypeMetadata.
      • templateLocked

        public SmartSection templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        SmartSection
      • 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 SmartSection templateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        templateLockedMetadata.
        Returns:
        SmartSection
      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        Metadata that indicates whether the `templateLocked` property is editable..
        Returns:
        templateLockedMetadata
      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        setTemplateLockedMetadata.
      • templateRequired

        public SmartSection templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        SmartSection
      • 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 SmartSection templateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        templateRequiredMetadata.
        Returns:
        SmartSection
      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        Metadata that indicates whether the `templateRequired` property is editable..
        Returns:
        templateRequiredMetadata
      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        setTemplateRequiredMetadata.
      • tooltip

        public SmartSection tooltip​(String tooltip)
        tooltip.
        Returns:
        SmartSection
      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip
      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.
      • getToolTipMetadata

        public PropertyMetadata getToolTipMetadata()
        Metadata that indicates whether the `toolTip` property is editable..
        Returns:
        toolTipMetadata
      • setToolTipMetadata

        public void setToolTipMetadata​(PropertyMetadata toolTipMetadata)
        setToolTipMetadata.
      • getWidth

        public String getWidth()
        Width of the tab in pixels..
        Returns:
        width
      • setWidth

        public void setWidth​(String width)
        setWidth.
      • getWidthMetadata

        public PropertyMetadata getWidthMetadata()
        Metadata that indicates whether the `width` property is editable..
        Returns:
        widthMetadata
      • setWidthMetadata

        public void setWidthMetadata​(PropertyMetadata widthMetadata)
        setWidthMetadata.
      • xPosition

        public SmartSection xPosition​(String xPosition)
        xPosition.
        Returns:
        SmartSection
      • 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 SmartSection xPositionMetadata​(PropertyMetadata xPositionMetadata)
        xPositionMetadata.
        Returns:
        SmartSection
      • getXPositionMetadata

        public PropertyMetadata getXPositionMetadata()
        Metadata that indicates whether the `xPosition` property is editable..
        Returns:
        xPositionMetadata
      • setXPositionMetadata

        public void setXPositionMetadata​(PropertyMetadata xPositionMetadata)
        setXPositionMetadata.
      • yPosition

        public SmartSection yPosition​(String yPosition)
        yPosition.
        Returns:
        SmartSection
      • 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 SmartSection yPositionMetadata​(PropertyMetadata yPositionMetadata)
        yPositionMetadata.
        Returns:
        SmartSection
      • 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.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.
      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object
      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object