Package com.docusign.click.model

Class DisplaySettings

  • public class DisplaySettings
extends Object
    Information about how an agreement is displayed..

    • Constructor Detail

      • DisplaySettings

        public DisplaySettings()

    • Method Detail

      • actionButtonAlignment

        public DisplaySettings actionButtonAlignment​(String actionButtonAlignment)
        actionButtonAlignment.
        Returns:
        DisplaySettings

      • getActionButtonAlignment

        public String getActionButtonAlignment()
        Position of the Accept button in the agreement. One of - `right` - `left` .
        Returns:
        actionButtonAlignment

      • setActionButtonAlignment

        public void setActionButtonAlignment​(String actionButtonAlignment)
        setActionButtonAlignment.

      • allowClientOnly

        public DisplaySettings allowClientOnly​(Boolean allowClientOnly)
        allowClientOnly.
        Returns:
        DisplaySettings

      • isAllowClientOnly

        public Boolean isAllowClientOnly()
        When **true,** this agreement can be be used in client-only integrations..
        Returns:
        allowClientOnly

      • setAllowClientOnly

        public void setAllowClientOnly​(Boolean allowClientOnly)
        setAllowClientOnly.

      • addAllowedHostsItem

        public DisplaySettings addAllowedHostsItem​(String allowedHostsItem)
        addAllowedHostsItem.
        Returns:
        DisplaySettings

      • getAllowedHosts

        public List<String> getAllowedHosts()
        Hosts that can host the clickwrap. It is an error if the clickwrap didn't come from one of these hosts. .
        Returns:
        allowedHosts

      • setAllowedHosts

        public void setAllowedHosts​(List<String> allowedHosts)
        setAllowedHosts.

      • getBrandId

        public String getBrandId()
        The signing brand ID..
        Returns:
        brandId

      • setBrandId

        public void setBrandId​(String brandId)
        setBrandId.

      • consentButtonText

        public DisplaySettings consentButtonText​(String consentButtonText)
        consentButtonText.
        Returns:
        DisplaySettings

      • getConsentButtonText

        public String getConsentButtonText()
        Text on the agree button..
        Returns:
        consentButtonText

      • setConsentButtonText

        public void setConsentButtonText​(String consentButtonText)
        setConsentButtonText.

      • consentText

        public DisplaySettings consentText​(String consentText)
        consentText.
        Returns:
        DisplaySettings

      • getConsentText

        public String getConsentText()
        The statement prefixing the Electronic Record and Signature Disclosure agreement..
        Returns:
        consentText

      • setConsentText

        public void setConsentText​(String consentText)
        setConsentText.

      • declineButtonText

        public DisplaySettings declineButtonText​(String declineButtonText)
        declineButtonText.
        Returns:
        DisplaySettings

      • getDeclineButtonText

        public String getDeclineButtonText()
        The text on the decline button..
        Returns:
        declineButtonText

      • setDeclineButtonText

        public void setDeclineButtonText​(String declineButtonText)
        setDeclineButtonText.

      • displayName

        public DisplaySettings displayName​(String displayName)
        displayName.
        Returns:
        DisplaySettings

      • getDisplayName

        public String getDisplayName()
        The display name of the user agreement..
        Returns:
        displayName

      • setDisplayName

        public void setDisplayName​(String displayName)
        setDisplayName.

      • documentDisplay

        public DisplaySettings documentDisplay​(String documentDisplay)
        documentDisplay.
        Returns:
        DisplaySettings

      • getDocumentDisplay

        public String getDocumentDisplay()
        Display type: link, document or pdf.
        Returns:
        documentDisplay

      • setDocumentDisplay

        public void setDocumentDisplay​(String documentDisplay)
        setDocumentDisplay.

      • downloadable

        public DisplaySettings downloadable​(Boolean downloadable)
        downloadable.
        Returns:
        DisplaySettings

      • isDownloadable

        public Boolean isDownloadable()
        **True** if the agreement is downloadable..
        Returns:
        downloadable

      • setDownloadable

        public void setDownloadable​(Boolean downloadable)
        setDownloadable.

      • getFormat

        public String getFormat()
        Display format: inline or modal..
        Returns:
        format

      • setFormat

        public void setFormat​(String format)
        setFormat.

      • hasDeclineButton

        public DisplaySettings hasDeclineButton​(Boolean hasDeclineButton)
        hasDeclineButton.
        Returns:
        DisplaySettings

      • isHasDeclineButton

        public Boolean isHasDeclineButton()
        **True** if the agreement has a decline button..
        Returns:
        hasDeclineButton

      • setHasDeclineButton

        public void setHasDeclineButton​(Boolean hasDeclineButton)
        setHasDeclineButton.

      • isMustRead

        public Boolean isMustRead()
        **True** if the user needs to scroll to the end of the document..
        Returns:
        mustRead

      • setMustRead

        public void setMustRead​(Boolean mustRead)
        setMustRead.

      • isMustView

        public Boolean isMustView()
        **True** if the user must view the document..
        Returns:
        mustView

      • setMustView

        public void setMustView​(Boolean mustView)
        setMustView.

      • recordDeclineResponses

        public DisplaySettings recordDeclineResponses​(Boolean recordDeclineResponses)
        recordDeclineResponses.
        Returns:
        DisplaySettings

      • isRecordDeclineResponses

        public Boolean isRecordDeclineResponses()
        When **true,** this agreement records decline actions..
        Returns:
        recordDeclineResponses

      • setRecordDeclineResponses

        public void setRecordDeclineResponses​(Boolean recordDeclineResponses)
        setRecordDeclineResponses.

      • requireAccept

        public DisplaySettings requireAccept​(Boolean requireAccept)
        requireAccept.
        Returns:
        DisplaySettings

      • isRequireAccept

        public Boolean isRequireAccept()
        **True** if a checkbox is required to accept..
        Returns:
        requireAccept

      • setRequireAccept

        public void setRequireAccept​(Boolean requireAccept)
        setRequireAccept.

      • sendToEmail

        public DisplaySettings sendToEmail​(Boolean sendToEmail)
        sendToEmail.
        Returns:
        DisplaySettings

      • isSendToEmail

        public Boolean isSendToEmail()
        **True** if send to email is applicable..
        Returns:
        sendToEmail

      • setSendToEmail

        public void setSendToEmail​(Boolean sendToEmail)
        setSendToEmail.

      • statementAlignment

        public DisplaySettings statementAlignment​(String statementAlignment)
        statementAlignment.
        Returns:
        DisplaySettings

      • getStatementAlignment

        public String getStatementAlignment()
        Position of the agreement statement. One of - `top` - `bottom` .
        Returns:
        statementAlignment

      • setStatementAlignment

        public void setStatementAlignment​(String statementAlignment)
        setStatementAlignment.

      • 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