Package com.docusign.esign.model

Class TemplateRole

  • public class TemplateRole
extends Object
    Information about a specific role..

    • Constructor Detail

      • TemplateRole

        public TemplateRole()

    • Method Detail

      • accessCode

        public TemplateRole accessCode​(String accessCode)
        accessCode.
        Returns:
        TemplateRole

      • getAccessCode

        public String getAccessCode()
        If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required..
        Returns:
        accessCode

      • setAccessCode

        public void setAccessCode​(String accessCode)
        setAccessCode.

      • clientUserId

        public TemplateRole clientUserId​(String clientUserId)
        clientUserId.
        Returns:
        TemplateRole

      • getClientUserId

        public String getClientUserId()
        Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. .
        Returns:
        clientUserId

      • setClientUserId

        public void setClientUserId​(String clientUserId)
        setClientUserId.

      • defaultRecipient

        public TemplateRole defaultRecipient​(String defaultRecipient)
        defaultRecipient.
        Returns:
        TemplateRole

      • getDefaultRecipient

        public String getDefaultRecipient()
        When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient..
        Returns:
        defaultRecipient

      • setDefaultRecipient

        public void setDefaultRecipient​(String defaultRecipient)
        setDefaultRecipient.

      • getEmail

        public String getEmail()
        Specifies the email associated with a role name..
        Returns:
        email

      • setEmail

        public void setEmail​(String email)
        setEmail.

      • getEmailNotification

        public RecipientEmailNotification getEmailNotification()
        An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. .
        Returns:
        emailNotification

      • embeddedRecipientStartURL

        public TemplateRole embeddedRecipientStartURL​(String embeddedRecipientStartURL)
        embeddedRecipientStartURL.
        Returns:
        TemplateRole

      • getEmbeddedRecipientStartURL

        public String getEmbeddedRecipientStartURL()
        Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` .
        Returns:
        embeddedRecipientStartURL

      • setEmbeddedRecipientStartURL

        public void setEmbeddedRecipientStartURL​(String embeddedRecipientStartURL)
        setEmbeddedRecipientStartURL.

      • inPersonSignerName

        public TemplateRole inPersonSignerName​(String inPersonSignerName)
        inPersonSignerName.
        Returns:
        TemplateRole

      • getInPersonSignerName

        public String getInPersonSignerName()
        Specifies the full legal name of the signer in person signer template roles. Maximum Length: 100 characters..
        Returns:
        inPersonSignerName

      • setInPersonSignerName

        public void setInPersonSignerName​(String inPersonSignerName)
        setInPersonSignerName.

      • getName

        public String getName()
        Specifies the recipient's name..
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • getPhoneNumber

        public RecipientPhoneNumber getPhoneNumber()
        Describes the recipient phone number..
        Returns:
        phoneNumber

      • addRecipientSignatureProvidersItem

        public TemplateRole addRecipientSignatureProvidersItem​(RecipientSignatureProvider recipientSignatureProvidersItem)
        addRecipientSignatureProvidersItem.
        Returns:
        TemplateRole

      • setRecipientSignatureProviders

        public void setRecipientSignatureProviders​(List<RecipientSignatureProvider> recipientSignatureProviders)
        setRecipientSignatureProviders.

      • roleName

        public TemplateRole roleName​(String roleName)
        roleName.
        Returns:
        TemplateRole

      • getRoleName

        public String getRoleName()
        Optional element. Specifies the role name associated with the recipient.

        This is required when working with template recipients..
        Returns:
        roleName

      • setRoleName

        public void setRoleName​(String roleName)
        setRoleName.

      • routingOrder

        public TemplateRole routingOrder​(String routingOrder)
        routingOrder.
        Returns:
        TemplateRole

      • getRoutingOrder

        public String getRoutingOrder()
        Specifies the routing order of the recipient in the envelope. .
        Returns:
        routingOrder

      • setRoutingOrder

        public void setRoutingOrder​(String routingOrder)
        setRoutingOrder.

      • signingGroupId

        public TemplateRole signingGroupId​(String signingGroupId)
        signingGroupId.
        Returns:
        TemplateRole

      • getSigningGroupId

        public String getSigningGroupId()
        When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..
        Returns:
        signingGroupId

      • setSigningGroupId

        public void setSigningGroupId​(String signingGroupId)
        setSigningGroupId.

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

      • 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