Package com.docusign.esign.model

Class RecipientViewRequest

  • public class RecipientViewRequest
extends java.lang.Object
    RecipientViewRequest.

    • Constructor Detail

      • RecipientViewRequest

        public RecipientViewRequest()

    • Method Detail

      • assertionId

        public RecipientViewRequest assertionId​(java.lang.String assertionId)
        assertionId.
        Returns:
        RecipientViewRequest

      • getAssertionId

        public java.lang.String getAssertionId()
        A unique identifier of the authentication event executed by the client application..
        Returns:
        assertionId

      • setAssertionId

        public void setAssertionId​(java.lang.String assertionId)
        setAssertionId.

      • authenticationInstant

        public RecipientViewRequest authenticationInstant​(java.lang.String authenticationInstant)
        authenticationInstant.
        Returns:
        RecipientViewRequest

      • getAuthenticationInstant

        public java.lang.String getAuthenticationInstant()
        A sender generated value that indicates the date/time that the signer was authenticated..
        Returns:
        authenticationInstant

      • setAuthenticationInstant

        public void setAuthenticationInstant​(java.lang.String authenticationInstant)
        setAuthenticationInstant.

      • authenticationMethod

        public RecipientViewRequest authenticationMethod​(java.lang.String authenticationMethod)
        authenticationMethod.
        Returns:
        RecipientViewRequest

      • getAuthenticationMethod

        public java.lang.String getAuthenticationMethod()
        A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion..
        Returns:
        authenticationMethod

      • setAuthenticationMethod

        public void setAuthenticationMethod​(java.lang.String authenticationMethod)
        setAuthenticationMethod.

      • clientUserId

        public RecipientViewRequest clientUserId​(java.lang.String clientUserId)
        clientUserId.
        Returns:
        RecipientViewRequest

      • getClientUserId

        public java.lang.String getClientUserId()
        A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters..
        Returns:
        clientUserId

      • setClientUserId

        public void setClientUserId​(java.lang.String clientUserId)
        setClientUserId.

      • email

        public RecipientViewRequest email​(java.lang.String email)
        email.
        Returns:
        RecipientViewRequest

      • getEmail

        public java.lang.String getEmail()
        Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient..
        Returns:
        email

      • setEmail

        public void setEmail​(java.lang.String email)
        setEmail.

      • frameAncestors

        public RecipientViewRequest frameAncestors​(java.util.List<java.lang.String> frameAncestors)
        frameAncestors.
        Returns:
        RecipientViewRequest

      • addFrameAncestorsItem

        public RecipientViewRequest addFrameAncestorsItem​(java.lang.String frameAncestorsItem)
        addFrameAncestorsItem.
        Returns:
        RecipientViewRequest

      • getFrameAncestors

        public java.util.List<java.lang.String> getFrameAncestors()
        .
        Returns:
        frameAncestors

      • setFrameAncestors

        public void setFrameAncestors​(java.util.List<java.lang.String> frameAncestors)
        setFrameAncestors.

      • messageOrigins

        public RecipientViewRequest messageOrigins​(java.util.List<java.lang.String> messageOrigins)
        messageOrigins.
        Returns:
        RecipientViewRequest

      • addMessageOriginsItem

        public RecipientViewRequest addMessageOriginsItem​(java.lang.String messageOriginsItem)
        addMessageOriginsItem.
        Returns:
        RecipientViewRequest

      • getMessageOrigins

        public java.util.List<java.lang.String> getMessageOrigins()
        .
        Returns:
        messageOrigins

      • setMessageOrigins

        public void setMessageOrigins​(java.util.List<java.lang.String> messageOrigins)
        setMessageOrigins.

      • pingFrequency

        public RecipientViewRequest pingFrequency​(java.lang.String pingFrequency)
        pingFrequency.
        Returns:
        RecipientViewRequest

      • getPingFrequency

        public java.lang.String getPingFrequency()
        Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds..
        Returns:
        pingFrequency

      • setPingFrequency

        public void setPingFrequency​(java.lang.String pingFrequency)
        setPingFrequency.

      • pingUrl

        public RecipientViewRequest pingUrl​(java.lang.String pingUrl)
        pingUrl.
        Returns:
        RecipientViewRequest

      • getPingUrl

        public java.lang.String getPingUrl()
        A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received..
        Returns:
        pingUrl

      • setPingUrl

        public void setPingUrl​(java.lang.String pingUrl)
        setPingUrl.

      • recipientId

        public RecipientViewRequest recipientId​(java.lang.String recipientId)
        recipientId.
        Returns:
        RecipientViewRequest

      • getRecipientId

        public java.lang.String getRecipientId()
        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
        Returns:
        recipientId

      • setRecipientId

        public void setRecipientId​(java.lang.String recipientId)
        setRecipientId.

      • returnUrl

        public RecipientViewRequest returnUrl​(java.lang.String returnUrl)
        returnUrl.
        Returns:
        RecipientViewRequest

      • getReturnUrl

        public java.lang.String getReturnUrl()
        The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. .
        Returns:
        returnUrl

      • setReturnUrl

        public void setReturnUrl​(java.lang.String returnUrl)
        setReturnUrl.

      • securityDomain

        public RecipientViewRequest securityDomain​(java.lang.String securityDomain)
        securityDomain.
        Returns:
        RecipientViewRequest

      • getSecurityDomain

        public java.lang.String getSecurityDomain()
        The domain in which the user authenticated..
        Returns:
        securityDomain

      • setSecurityDomain

        public void setSecurityDomain​(java.lang.String securityDomain)
        setSecurityDomain.

      • userId

        public RecipientViewRequest userId​(java.lang.String userId)
        userId.
        Returns:
        RecipientViewRequest

      • getUserId

        public java.lang.String getUserId()
        Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user..
        Returns:
        userId

      • setUserId

        public void setUserId​(java.lang.String userId)
        setUserId.

      • userName

        public RecipientViewRequest userName​(java.lang.String userName)
        userName.
        Returns:
        RecipientViewRequest

      • getUserName

        public java.lang.String getUserName()
        Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient..
        Returns:
        userName

      • setUserName

        public void setUserName​(java.lang.String userName)
        setUserName.

      • xFrameOptions

        public RecipientViewRequest xFrameOptions​(java.lang.String xFrameOptions)
        xFrameOptions.
        Returns:
        RecipientViewRequest

      • getXFrameOptions

        public java.lang.String getXFrameOptions()
        .
        Returns:
        xFrameOptions

      • setXFrameOptions

        public void setXFrameOptions​(java.lang.String xFrameOptions)
        setXFrameOptions.

      • xFrameOptionsAllowFromUrl

        public RecipientViewRequest xFrameOptionsAllowFromUrl​(java.lang.String xFrameOptionsAllowFromUrl)
        xFrameOptionsAllowFromUrl.
        Returns:
        RecipientViewRequest

      • getXFrameOptionsAllowFromUrl

        public java.lang.String getXFrameOptionsAllowFromUrl()
        .
        Returns:
        xFrameOptionsAllowFromUrl

      • setXFrameOptionsAllowFromUrl

        public void setXFrameOptionsAllowFromUrl​(java.lang.String xFrameOptionsAllowFromUrl)
        setXFrameOptionsAllowFromUrl.

      • equals

        public boolean equals​(java.lang.Object o)
        Compares objects.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Converts the given object to string.
        Overrides:
        toString in class java.lang.Object