Package com.docusign.click.model

Class UserAgreementRequest

  • public class UserAgreementRequest
extends Object
    Data used to create the agreement..

    • Constructor Detail

      • UserAgreementRequest

        public UserAgreementRequest()

    • Method Detail

      • getClientUserId

        public String getClientUserId()
        A unique value that identifies a user. You can use anything that your system uses to identify unique users, such as employee IDs, email addresses, and surrogate keys as the value of `clientUserId`. A clickwrap with a specific `clientUserId` will not appear again once it has been accepted. .
        Returns:
        clientUserId

      • setClientUserId

        public void setClientUserId​(String clientUserId)
        setClientUserId.

      • putDocumentDataItem

        public UserAgreementRequest putDocumentDataItem​(String key,
                                                String documentDataItem)
        putDocumentDataItem.
        Returns:
        UserAgreementRequest

      • getDocumentData

        public Map<String,​String> getDocumentData()
        This property specifies the data used to create a clickwrap with [dynamic content][]. [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content .
        Returns:
        documentData

      • setDocumentData

        public void setDocumentData​(Map<String,​String> documentData)
        setDocumentData.

      • getMetadata

        public String getMetadata()
        A customer-defined string you can use in requests. This string will appear in the corresponding response..
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(String metadata)
        setMetadata.

      • getReturnUrl

        public String getReturnUrl()
        The URL to redirect to after the agreement is complete when the agreement is not rendered in an iframe..
        Returns:
        returnUrl

      • setReturnUrl

        public void setReturnUrl​(String returnUrl)
        setReturnUrl.

      • 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