Class PhoneNumber

  • All Implemented Interfaces:
    Serializable

    public class PhoneNumber
    extends Object
    implements Serializable
    A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/.
    See Also:
    Serialized Form
    • Constructor Detail

      • PhoneNumber

        public PhoneNumber()
    • Method Detail

      • anchorAllowWhiteSpaceInCharacters

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

        public String getAnchorAllowWhiteSpaceInCharacters()
        .
        Returns:
        anchorAllowWhiteSpaceInCharacters
      • setAnchorAllowWhiteSpaceInCharacters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public String getAnchorTabProcessorVersion()
        .
        Returns:
        anchorTabProcessorVersion
      • setAnchorTabProcessorVersion

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

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

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

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

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

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

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

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

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

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

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

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

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

        public String getBold()
        When set to **true**, the information in the tab is bold..
        Returns:
        bold
      • setBold

        public void setBold​(String bold)
        setBold.
      • getBoldMetadata

        public PropertyMetadata getBoldMetadata()
        Metadata that indicates whether the `bold` property is editable..
        Returns:
        boldMetadata
      • setBoldMetadata

        public void setBoldMetadata​(PropertyMetadata boldMetadata)
        setBoldMetadata.
      • caption

        public PhoneNumber caption​(String caption)
        caption.
        Returns:
        PhoneNumber
      • 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.
      • concealValueOnDocument

        public PhoneNumber concealValueOnDocument​(String concealValueOnDocument)
        concealValueOnDocument.
        Returns:
        PhoneNumber
      • getConcealValueOnDocument

        public String getConcealValueOnDocument()
        When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes..
        Returns:
        concealValueOnDocument
      • setConcealValueOnDocument

        public void setConcealValueOnDocument​(String concealValueOnDocument)
        setConcealValueOnDocument.
      • concealValueOnDocumentMetadata

        public PhoneNumber concealValueOnDocumentMetadata​(PropertyMetadata concealValueOnDocumentMetadata)
        concealValueOnDocumentMetadata.
        Returns:
        PhoneNumber
      • getConcealValueOnDocumentMetadata

        public PropertyMetadata getConcealValueOnDocumentMetadata()
        Metadata that indicates whether the `concealValueOnDocument` property is editable..
        Returns:
        concealValueOnDocumentMetadata
      • setConcealValueOnDocumentMetadata

        public void setConcealValueOnDocumentMetadata​(PropertyMetadata concealValueOnDocumentMetadata)
        setConcealValueOnDocumentMetadata.
      • conditionalParentLabel

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

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

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

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

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

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

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

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

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

        public PhoneNumber disableAutoSize​(String disableAutoSize)
        disableAutoSize.
        Returns:
        PhoneNumber
      • getDisableAutoSize

        public String getDisableAutoSize()
        When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes..
        Returns:
        disableAutoSize
      • setDisableAutoSize

        public void setDisableAutoSize​(String disableAutoSize)
        setDisableAutoSize.
      • disableAutoSizeMetadata

        public PhoneNumber disableAutoSizeMetadata​(PropertyMetadata disableAutoSizeMetadata)
        disableAutoSizeMetadata.
        Returns:
        PhoneNumber
      • getDisableAutoSizeMetadata

        public PropertyMetadata getDisableAutoSizeMetadata()
        Metadata that indicates whether the `disableAutoSize` property is editable..
        Returns:
        disableAutoSizeMetadata
      • setDisableAutoSizeMetadata

        public void setDisableAutoSizeMetadata​(PropertyMetadata disableAutoSizeMetadata)
        setDisableAutoSizeMetadata.
      • documentId

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

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

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

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

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.
      • 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 PhoneNumber fontColor​(String fontColor)
        fontColor.
        Returns:
        PhoneNumber
      • 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 PhoneNumber fontColorMetadata​(PropertyMetadata fontColorMetadata)
        fontColorMetadata.
        Returns:
        PhoneNumber
      • getFontColorMetadata

        public PropertyMetadata getFontColorMetadata()
        Metadata that indicates whether the `fontColor` property is editable..
        Returns:
        fontColorMetadata
      • setFontColorMetadata

        public void setFontColorMetadata​(PropertyMetadata fontColorMetadata)
        setFontColorMetadata.
      • getFontMetadata

        public PropertyMetadata getFontMetadata()
        Metadata that indicates whether the `font` property is editable..
        Returns:
        fontMetadata
      • setFontMetadata

        public void setFontMetadata​(PropertyMetadata fontMetadata)
        setFontMetadata.
      • fontSize

        public PhoneNumber fontSize​(String fontSize)
        fontSize.
        Returns:
        PhoneNumber
      • 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.
      • getFontSizeMetadata

        public PropertyMetadata getFontSizeMetadata()
        Metadata that indicates whether the `fontSize` property is editable..
        Returns:
        fontSizeMetadata
      • setFontSizeMetadata

        public void setFontSizeMetadata​(PropertyMetadata fontSizeMetadata)
        setFontSizeMetadata.
      • formOrder

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

        public String getFormOrder()
        .
        Returns:
        formOrder
      • setFormOrder

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

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

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

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

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

        public String getFormPageLabel()
        .
        Returns:
        formPageLabel
      • setFormPageLabel

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

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

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

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

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

        public String getFormPageNumber()
        .
        Returns:
        formPageNumber
      • setFormPageNumber

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

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

        public String getItalic()
        When set to **true**, the information in the tab is italic..
        Returns:
        italic
      • setItalic

        public void setItalic​(String italic)
        setItalic.
      • getItalicMetadata

        public PropertyMetadata getItalicMetadata()
        Metadata that indicates whether the `italic` property is editable..
        Returns:
        italicMetadata
      • setItalicMetadata

        public void setItalicMetadata​(PropertyMetadata italicMetadata)
        setItalicMetadata.
      • getLocalePolicy

        public LocalePolicyTab getLocalePolicy()
        Reserved for DocuSign..
        Returns:
        localePolicy
      • setLocalePolicy

        public void setLocalePolicy​(LocalePolicyTab localePolicy)
        setLocalePolicy.
      • 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.
      • maxLength

        public PhoneNumber maxLength​(String maxLength)
        maxLength.
        Returns:
        PhoneNumber
      • getMaxLength

        public String getMaxLength()
        An optional value that describes the maximum length of the property when the property is a string..
        Returns:
        maxLength
      • setMaxLength

        public void setMaxLength​(String maxLength)
        setMaxLength.
      • maxLengthMetadata

        public PhoneNumber maxLengthMetadata​(PropertyMetadata maxLengthMetadata)
        maxLengthMetadata.
        Returns:
        PhoneNumber
      • getMaxLengthMetadata

        public PropertyMetadata getMaxLengthMetadata()
        Metadata that indicates whether the `maxLength` property is editable..
        Returns:
        maxLengthMetadata
      • setMaxLengthMetadata

        public void setMaxLengthMetadata​(PropertyMetadata maxLengthMetadata)
        setMaxLengthMetadata.
      • 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 PhoneNumber mergeFieldXml​(String mergeFieldXml)
        mergeFieldXml.
        Returns:
        PhoneNumber
      • getMergeFieldXml

        public String getMergeFieldXml()
        .
        Returns:
        mergeFieldXml
      • setMergeFieldXml

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

        public String getName()
        .
        Returns:
        name
      • setName

        public void setName​(String name)
        setName.
      • getNameMetadata

        public PropertyMetadata getNameMetadata()
        Metadata that indicates whether the `name` property is editable. This property is read-only..
        Returns:
        nameMetadata
      • setNameMetadata

        public void setNameMetadata​(PropertyMetadata nameMetadata)
        setNameMetadata.
      • originalValue

        public PhoneNumber originalValue​(String originalValue)
        originalValue.
        Returns:
        PhoneNumber
      • getOriginalValue

        public String getOriginalValue()
        The initial value of the tab when it was sent to the recipient. .
        Returns:
        originalValue
      • setOriginalValue

        public void setOriginalValue​(String originalValue)
        setOriginalValue.
      • originalValueMetadata

        public PhoneNumber originalValueMetadata​(PropertyMetadata originalValueMetadata)
        originalValueMetadata.
        Returns:
        PhoneNumber
      • getOriginalValueMetadata

        public PropertyMetadata getOriginalValueMetadata()
        Metadata that indicates whether the `originalValue` property is editable..
        Returns:
        originalValueMetadata
      • setOriginalValueMetadata

        public void setOriginalValueMetadata​(PropertyMetadata originalValueMetadata)
        setOriginalValueMetadata.
      • pageNumber

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

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

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

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

        public String getRecipientIdGuid()
        .
        Returns:
        recipientIdGuid
      • setRecipientIdGuid

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

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

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

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

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

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

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

        public PhoneNumber required​(String required)
        required.
        Returns:
        PhoneNumber
      • getRequired

        public String getRequired()
        When set to **true**, the signer is required to fill out this tab.
        Returns:
        required
      • setRequired

        public void setRequired​(String required)
        setRequired.
      • getRequiredMetadata

        public PropertyMetadata getRequiredMetadata()
        Metadata that indicates whether the `required` property is editable..
        Returns:
        requiredMetadata
      • setRequiredMetadata

        public void setRequiredMetadata​(PropertyMetadata requiredMetadata)
        setRequiredMetadata.
      • getSmartContractInformation

        public SmartContractInformation getSmartContractInformation()
        Reserved for DocuSign..
        Returns:
        smartContractInformation
      • setSmartContractInformation

        public void setSmartContractInformation​(SmartContractInformation smartContractInformation)
        setSmartContractInformation.
      • getSource

        public String getSource()
        .
        Returns:
        source
      • setSource

        public void setSource​(String source)
        setSource.
      • getStatus

        public String getStatus()
        Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
        Returns:
        status
      • setStatus

        public void setStatus​(String status)
        setStatus.
      • getStatusMetadata

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

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

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

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

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

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

        public PhoneNumber tabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        tabGroupLabelsMetadata.
        Returns:
        PhoneNumber
      • 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 PhoneNumber tabLabel​(String tabLabel)
        tabLabel.
        Returns:
        PhoneNumber
      • getTabLabel

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

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

        public PropertyMetadata getTabLabelMetadata()
        Metadata that indicates whether the `tabLabel` property is editable..
        Returns:
        tabLabelMetadata
      • setTabLabelMetadata

        public void setTabLabelMetadata​(PropertyMetadata tabLabelMetadata)
        setTabLabelMetadata.
      • tabOrder

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

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

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

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

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

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

        public PhoneNumber tooltip​(String tooltip)
        tooltip.
        Returns:
        PhoneNumber
      • 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.
      • underline

        public PhoneNumber underline​(String underline)
        underline.
        Returns:
        PhoneNumber
      • 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 PhoneNumber underlineMetadata​(PropertyMetadata underlineMetadata)
        underlineMetadata.
        Returns:
        PhoneNumber
      • getUnderlineMetadata

        public PropertyMetadata getUnderlineMetadata()
        Metadata that indicates whether the `underline` property is editable..
        Returns:
        underlineMetadata
      • setUnderlineMetadata

        public void setUnderlineMetadata​(PropertyMetadata underlineMetadata)
        setUnderlineMetadata.
      • getValue

        public String getValue()
        Specifies the value of the tab. .
        Returns:
        value
      • setValue

        public void setValue​(String value)
        setValue.
      • getValueMetadata

        public PropertyMetadata getValueMetadata()
        Metadata that indicates whether the `value` property is editable..
        Returns:
        valueMetadata
      • setValueMetadata

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

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

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

        public PhoneNumber yPosition​(String yPosition)
        yPosition.
        Returns:
        PhoneNumber
      • 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 PhoneNumber yPositionMetadata​(PropertyMetadata yPositionMetadata)
        yPositionMetadata.
        Returns:
        PhoneNumber
      • 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