Class MergeField


  • public class MergeField
    extends Object
    Contains information for transfering values between Salesforce data fields and DocuSign Tabs..
    • Constructor Detail

      • MergeField

        public MergeField()
    • Method Detail

      • allowSenderToEdit

        public MergeField allowSenderToEdit​(String allowSenderToEdit)
        allowSenderToEdit.
        Returns:
        MergeField
      • getAllowSenderToEdit

        public String getAllowSenderToEdit()
        When set to **true**, the sender can modify the value of the custom tab during the sending process..
        Returns:
        allowSenderToEdit
      • setAllowSenderToEdit

        public void setAllowSenderToEdit​(String allowSenderToEdit)
        setAllowSenderToEdit.
      • allowSenderToEditMetadata

        public MergeField allowSenderToEditMetadata​(PropertyMetadata allowSenderToEditMetadata)
        allowSenderToEditMetadata.
        Returns:
        MergeField
      • getAllowSenderToEditMetadata

        public PropertyMetadata getAllowSenderToEditMetadata()
        Get allowSenderToEditMetadata.
        Returns:
        allowSenderToEditMetadata
      • setAllowSenderToEditMetadata

        public void setAllowSenderToEditMetadata​(PropertyMetadata allowSenderToEditMetadata)
        setAllowSenderToEditMetadata.
      • configurationType

        public MergeField configurationType​(String configurationType)
        configurationType.
        Returns:
        MergeField
      • getConfigurationType

        public String getConfigurationType()
        If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**..
        Returns:
        configurationType
      • setConfigurationType

        public void setConfigurationType​(String configurationType)
        setConfigurationType.
      • configurationTypeMetadata

        public MergeField configurationTypeMetadata​(PropertyMetadata configurationTypeMetadata)
        configurationTypeMetadata.
        Returns:
        MergeField
      • getConfigurationTypeMetadata

        public PropertyMetadata getConfigurationTypeMetadata()
        Get configurationTypeMetadata.
        Returns:
        configurationTypeMetadata
      • setConfigurationTypeMetadata

        public void setConfigurationTypeMetadata​(PropertyMetadata configurationTypeMetadata)
        setConfigurationTypeMetadata.
      • getPath

        public String getPath()
        Sets the object associated with the custom tab. Currently this is the Salesforce Object..
        Returns:
        path
      • setPath

        public void setPath​(String path)
        setPath.
      • pathExtendedMetadata

        public MergeField pathExtendedMetadata​(PropertyMetadata pathExtendedMetadata)
        pathExtendedMetadata.
        Returns:
        MergeField
      • getPathExtendedMetadata

        public PropertyMetadata getPathExtendedMetadata()
        Get pathExtendedMetadata.
        Returns:
        pathExtendedMetadata
      • setPathExtendedMetadata

        public void setPathExtendedMetadata​(PropertyMetadata pathExtendedMetadata)
        setPathExtendedMetadata.
      • getPathMetadata

        public PropertyMetadata getPathMetadata()
        Get pathMetadata.
        Returns:
        pathMetadata
      • setPathMetadata

        public void setPathMetadata​(PropertyMetadata pathMetadata)
        setPathMetadata.
      • getRow

        public String getRow()
        Specifies the row number in a Salesforce table that the merge field value corresponds to..
        Returns:
        row
      • setRow

        public void setRow​(String row)
        setRow.
      • getRowMetadata

        public PropertyMetadata getRowMetadata()
        Get rowMetadata.
        Returns:
        rowMetadata
      • setRowMetadata

        public void setRowMetadata​(PropertyMetadata rowMetadata)
        setRowMetadata.
      • writeBack

        public MergeField writeBack​(String writeBack)
        writeBack.
        Returns:
        MergeField
      • getWriteBack

        public String getWriteBack()
        When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed..
        Returns:
        writeBack
      • setWriteBack

        public void setWriteBack​(String writeBack)
        setWriteBack.
      • writeBackMetadata

        public MergeField writeBackMetadata​(PropertyMetadata writeBackMetadata)
        writeBackMetadata.
        Returns:
        MergeField
      • getWriteBackMetadata

        public PropertyMetadata getWriteBackMetadata()
        Get writeBackMetadata.
        Returns:
        writeBackMetadata
      • setWriteBackMetadata

        public void setWriteBackMetadata​(PropertyMetadata writeBackMetadata)
        setWriteBackMetadata.
      • 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