Package com.docusign.esign.model

Class Document

  • public class Document
extends Object
    A document object..

    • Constructor Detail

      • Document

        public Document()

    • Method Detail

      • applyAnchorTabs

        public Document applyAnchorTabs​(String applyAnchorTabs)
        applyAnchorTabs.
        Returns:
        Document

      • getApplyAnchorTabs

        public String getApplyAnchorTabs()
        Reserved: TBD.
        Returns:
        applyAnchorTabs

      • setApplyAnchorTabs

        public void setApplyAnchorTabs​(String applyAnchorTabs)
        setApplyAnchorTabs.

      • assignTabsToRecipientId

        public Document assignTabsToRecipientId​(String assignTabsToRecipientId)
        assignTabsToRecipientId.
        Returns:
        Document

      • getAssignTabsToRecipientId

        public String getAssignTabsToRecipientId()
        .
        Returns:
        assignTabsToRecipientId

      • setAssignTabsToRecipientId

        public void setAssignTabsToRecipientId​(String assignTabsToRecipientId)
        setAssignTabsToRecipientId.

      • display

        public Document display​(String display)
        display.
        Returns:
        Document

      • getDisplay

        public String getDisplay()
        .
        Returns:
        display

      • setDisplay

        public void setDisplay​(String display)
        setDisplay.

      • documentBase64

        public Document documentBase64​(String documentBase64)
        documentBase64.
        Returns:
        Document

      • getDocumentBase64

        public String getDocumentBase64()
        The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding..
        Returns:
        documentBase64

      • setDocumentBase64

        public void setDocumentBase64​(String documentBase64)
        setDocumentBase64.

      • documentFields

        public Document documentFields​(List<NameValue> documentFields)
        documentFields.
        Returns:
        Document

      • addDocumentFieldsItem

        public Document addDocumentFieldsItem​(NameValue documentFieldsItem)
        addDocumentFieldsItem.
        Returns:
        Document

      • getDocumentFields

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

      • setDocumentFields

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

      • documentId

        public Document documentId​(String documentId)
        documentId.
        Returns:
        Document

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

      • encryptedWithKeyManager

        public Document encryptedWithKeyManager​(String encryptedWithKeyManager)
        encryptedWithKeyManager.
        Returns:
        Document

      • getEncryptedWithKeyManager

        public String getEncryptedWithKeyManager()
        When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. .
        Returns:
        encryptedWithKeyManager

      • setEncryptedWithKeyManager

        public void setEncryptedWithKeyManager​(String encryptedWithKeyManager)
        setEncryptedWithKeyManager.

      • fileExtension

        public Document fileExtension​(String fileExtension)
        fileExtension.
        Returns:
        Document

      • getFileExtension

        public String getFileExtension()
        The file extension type of the document. If the document is not a PDF it is converted to a PDF. .
        Returns:
        fileExtension

      • setFileExtension

        public void setFileExtension​(String fileExtension)
        setFileExtension.

      • fileFormatHint

        public Document fileFormatHint​(String fileFormatHint)
        fileFormatHint.
        Returns:
        Document

      • getFileFormatHint

        public String getFileFormatHint()
        .
        Returns:
        fileFormatHint

      • setFileFormatHint

        public void setFileFormatHint​(String fileFormatHint)
        setFileFormatHint.

      • getHtmlDefinition

        public DocumentHtmlDefinition getHtmlDefinition()
        Defines how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/)..
        Returns:
        htmlDefinition

      • setHtmlDefinition

        public void setHtmlDefinition​(DocumentHtmlDefinition htmlDefinition)
        setHtmlDefinition.

      • includeInDownload

        public Document includeInDownload​(String includeInDownload)
        includeInDownload.
        Returns:
        Document

      • getIncludeInDownload

        public String getIncludeInDownload()
        .
        Returns:
        includeInDownload

      • setIncludeInDownload

        public void setIncludeInDownload​(String includeInDownload)
        setIncludeInDownload.

      • matchBoxes

        public Document matchBoxes​(List<MatchBox> matchBoxes)
        matchBoxes.
        Returns:
        Document

      • addMatchBoxesItem

        public Document addMatchBoxesItem​(MatchBox matchBoxesItem)
        addMatchBoxesItem.
        Returns:
        Document

      • getMatchBoxes

        public List<MatchBox> getMatchBoxes()
        Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. .
        Returns:
        matchBoxes

      • setMatchBoxes

        public void setMatchBoxes​(List<MatchBox> matchBoxes)
        setMatchBoxes.

      • name

        public Document name​(String name)
        name.
        Returns:
        Document

      • getName

        public String getName()
        .
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • order

        public Document order​(String order)
        order.
        Returns:
        Document

      • getOrder

        public String getOrder()
        .
        Returns:
        order

      • setOrder

        public void setOrder​(String order)
        setOrder.

      • pages

        public Document pages​(String pages)
        pages.
        Returns:
        Document

      • getPages

        public String getPages()
        .
        Returns:
        pages

      • setPages

        public void setPages​(String pages)
        setPages.

      • password

        public Document password​(String password)
        password.
        Returns:
        Document

      • getPassword

        public String getPassword()
        .
        Returns:
        password

      • setPassword

        public void setPassword​(String password)
        setPassword.

      • pdfFormFieldOption

        public Document pdfFormFieldOption​(String pdfFormFieldOption)
        pdfFormFieldOption.
        Returns:
        Document

      • getPdfFormFieldOption

        public String getPdfFormFieldOption()
        .
        Returns:
        pdfFormFieldOption

      • setPdfFormFieldOption

        public void setPdfFormFieldOption​(String pdfFormFieldOption)
        setPdfFormFieldOption.

      • remoteUrl

        public Document remoteUrl​(String remoteUrl)
        remoteUrl.
        Returns:
        Document

      • getRemoteUrl

        public String getRemoteUrl()
        The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. .
        Returns:
        remoteUrl

      • setRemoteUrl

        public void setRemoteUrl​(String remoteUrl)
        setRemoteUrl.

      • signerMustAcknowledge

        public Document signerMustAcknowledge​(String signerMustAcknowledge)
        signerMustAcknowledge.
        Returns:
        Document

      • getSignerMustAcknowledge

        public String getSignerMustAcknowledge()
        .
        Returns:
        signerMustAcknowledge

      • setSignerMustAcknowledge

        public void setSignerMustAcknowledge​(String signerMustAcknowledge)
        setSignerMustAcknowledge.

      • signerMustAcknowledgeUseAccountDefault

        public Document signerMustAcknowledgeUseAccountDefault​(Boolean signerMustAcknowledgeUseAccountDefault)
        signerMustAcknowledgeUseAccountDefault.
        Returns:
        Document

      • isSignerMustAcknowledgeUseAccountDefault

        public Boolean isSignerMustAcknowledgeUseAccountDefault()
        .
        Returns:
        signerMustAcknowledgeUseAccountDefault

      • setSignerMustAcknowledgeUseAccountDefault

        public void setSignerMustAcknowledgeUseAccountDefault​(Boolean signerMustAcknowledgeUseAccountDefault)
        setSignerMustAcknowledgeUseAccountDefault.

      • tabs

        public Document tabs​(Tabs tabs)
        tabs.
        Returns:
        Document

      • getTabs

        public Tabs getTabs()
        A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients..
        Returns:
        tabs

      • setTabs

        public void setTabs​(Tabs tabs)
        setTabs.

      • templateLocked

        public Document templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        Document

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

      • templateRequired

        public Document templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        Document

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

      • transformPdfFields

        public Document transformPdfFields​(String transformPdfFields)
        transformPdfFields.
        Returns:
        Document

      • getTransformPdfFields

        public String getTransformPdfFields()
        When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. .
        Returns:
        transformPdfFields

      • setTransformPdfFields

        public void setTransformPdfFields​(String transformPdfFields)
        setTransformPdfFields.

      • 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