Package com.docusign.esign.model

Class EnvelopeFormData

  • public class EnvelopeFormData
extends Object
    Describes the form data of the envelope..

    • Constructor Detail

      • EnvelopeFormData

        public EnvelopeFormData()

    • Method Detail

      • emailSubject

        public EnvelopeFormData emailSubject​(String emailSubject)
        emailSubject.
        Returns:
        EnvelopeFormData

      • getEmailSubject

        public String getEmailSubject()
        Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject..
        Returns:
        emailSubject

      • setEmailSubject

        public void setEmailSubject​(String emailSubject)
        setEmailSubject.

      • envelopeId

        public EnvelopeFormData envelopeId​(String envelopeId)
        envelopeId.
        Returns:
        EnvelopeFormData

      • getEnvelopeId

        public String getEnvelopeId()
        The envelope ID of the envelope status that failed to post..
        Returns:
        envelopeId

      • setEnvelopeId

        public void setEnvelopeId​(String envelopeId)
        setEnvelopeId.

      • setFormData

        public void setFormData​(List<FormDataItem> formData)
        setFormData.

      • getPrefillFormData

        public PrefillFormData getPrefillFormData()
        An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs). .
        Returns:
        prefillFormData

      • setPrefillFormData

        public void setPrefillFormData​(PrefillFormData prefillFormData)
        setPrefillFormData.

      • addRecipientFormDataItem

        public EnvelopeFormData addRecipientFormDataItem​(RecipientFormData recipientFormDataItem)
        addRecipientFormDataItem.
        Returns:
        EnvelopeFormData

      • getRecipientFormData

        public List<RecipientFormData> getRecipientFormData()
        .
        Returns:
        recipientFormData

      • setRecipientFormData

        public void setRecipientFormData​(List<RecipientFormData> recipientFormData)
        setRecipientFormData.

      • sentDateTime

        public EnvelopeFormData sentDateTime​(String sentDateTime)
        sentDateTime.
        Returns:
        EnvelopeFormData

      • getSentDateTime

        public String getSentDateTime()
        The date and time the envelope was sent..
        Returns:
        sentDateTime

      • setSentDateTime

        public void setSentDateTime​(String sentDateTime)
        setSentDateTime.

      • 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.

      • 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