Class TextCustomField

  • All Implemented Interfaces:
    Serializable

    public class TextCustomField
    extends Object
    implements Serializable
    This object represents a free text custom field where envelope creators and senders can enter custom data..
    See Also:
    Serialized Form
    • Constructor Detail

      • TextCustomField

        public TextCustomField()
    • Method Detail

      • configurationType

        public TextCustomField configurationType​(String configurationType)
        configurationType.
        Returns:
        TextCustomField
      • 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.
      • getErrorDetails

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

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

        public String getFieldId()
        An ID used to specify a custom field..
        Returns:
        fieldId
      • setFieldId

        public void setFieldId​(String fieldId)
        setFieldId.
      • getName

        public String getName()
        The name of the custom field..
        Returns:
        name
      • setName

        public void setName​(String name)
        setName.
      • 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.
      • getShow

        public String getShow()
        A boolean indicating if the value should be displayed..
        Returns:
        show
      • setShow

        public void setShow​(String show)
        setShow.
      • getValue

        public String getValue()
        The value of the custom field..
        Returns:
        value
      • setValue

        public void setValue​(String value)
        setValue.
      • 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