Class EnvelopeDocument


  • public class EnvelopeDocument
    extends Object
    EnvelopeDocument.
    • Constructor Detail

      • EnvelopeDocument

        public EnvelopeDocument()
    • Method Detail

      • attachmentTabId

        public EnvelopeDocument attachmentTabId​(String attachmentTabId)
        attachmentTabId.
        Returns:
        EnvelopeDocument
      • getAttachmentTabId

        public String getAttachmentTabId()
        .
        Returns:
        attachmentTabId
      • setAttachmentTabId

        public void setAttachmentTabId​(String attachmentTabId)
        setAttachmentTabId.
      • authoritativeCopy

        public EnvelopeDocument authoritativeCopy​(String authoritativeCopy)
        authoritativeCopy.
        Returns:
        EnvelopeDocument
      • getAuthoritativeCopy

        public String getAuthoritativeCopy()
        Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled..
        Returns:
        authoritativeCopy
      • setAuthoritativeCopy

        public void setAuthoritativeCopy​(String authoritativeCopy)
        setAuthoritativeCopy.
      • availableDocumentTypes

        public EnvelopeDocument availableDocumentTypes​(List<SignatureType> availableDocumentTypes)
        availableDocumentTypes.
        Returns:
        EnvelopeDocument
      • addAvailableDocumentTypesItem

        public EnvelopeDocument addAvailableDocumentTypesItem​(SignatureType availableDocumentTypesItem)
        addAvailableDocumentTypesItem.
        Returns:
        EnvelopeDocument
      • getAvailableDocumentTypes

        public List<SignatureType> getAvailableDocumentTypes()
        .
        Returns:
        availableDocumentTypes
      • setAvailableDocumentTypes

        public void setAvailableDocumentTypes​(List<SignatureType> availableDocumentTypes)
        setAvailableDocumentTypes.
      • containsPdfFormFields

        public EnvelopeDocument containsPdfFormFields​(String containsPdfFormFields)
        containsPdfFormFields.
        Returns:
        EnvelopeDocument
      • getContainsPdfFormFields

        public String getContainsPdfFormFields()
        .
        Returns:
        containsPdfFormFields
      • setContainsPdfFormFields

        public void setContainsPdfFormFields​(String containsPdfFormFields)
        setContainsPdfFormFields.
      • getDisplay

        public String getDisplay()
        .
        Returns:
        display
      • setDisplay

        public void setDisplay​(String display)
        setDisplay.
      • addDocumentFieldsItem

        public EnvelopeDocument addDocumentFieldsItem​(NameValue documentFieldsItem)
        addDocumentFieldsItem.
        Returns:
        EnvelopeDocument
      • getDocumentFields

        public List<NameValue> getDocumentFields()
        .
        Returns:
        documentFields
      • setDocumentFields

        public void setDocumentFields​(List<NameValue> documentFields)
        setDocumentFields.
      • documentId

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

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails
      • setErrorDetails

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

        public EnvelopeDocument includeInDownload​(String includeInDownload)
        includeInDownload.
        Returns:
        EnvelopeDocument
      • getIncludeInDownload

        public String getIncludeInDownload()
        .
        Returns:
        includeInDownload
      • setIncludeInDownload

        public void setIncludeInDownload​(String includeInDownload)
        setIncludeInDownload.
      • getName

        public String getName()
        .
        Returns:
        name
      • setName

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

        public String getOrder()
        .
        Returns:
        order
      • setOrder

        public void setOrder​(String order)
        setOrder.
      • getPages

        public String getPages()
        .
        Returns:
        pages
      • setPages

        public void setPages​(String pages)
        setPages.
      • signerMustAcknowledge

        public EnvelopeDocument signerMustAcknowledge​(String signerMustAcknowledge)
        signerMustAcknowledge.
        Returns:
        EnvelopeDocument
      • getSignerMustAcknowledge

        public String getSignerMustAcknowledge()
        .
        Returns:
        signerMustAcknowledge
      • setSignerMustAcknowledge

        public void setSignerMustAcknowledge​(String signerMustAcknowledge)
        setSignerMustAcknowledge.
      • getSizeBytes

        public String getSizeBytes()
        .
        Returns:
        sizeBytes
      • setSizeBytes

        public void setSizeBytes​(String sizeBytes)
        setSizeBytes.
      • getType

        public String getType()
        .
        Returns:
        type
      • setType

        public void setType​(String type)
        setType.
      • getUri

        public String getUri()
        .
        Returns:
        uri
      • setUri

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