com.docusign.esign.model

Class TemplateRole

java.lang.Object

com.docusign.esign.model.TemplateRole

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-03-06T16:42:36.211-08:00")
public class TemplateRole
extends Object

Constructor Summary

Constructors

Constructor and Description
TemplateRole()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAccessCode() If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
String	getClientUserId() Specifies whether the recipient is embedded or remote.
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.
String	getEmail() Specifies the email associated with a role name.
RecipientEmailNotification	getEmailNotification()
String	getEmbeddedRecipientStartURL() Specifies a sender provided valid URL string for redirecting an embedded recipient.
String	getInPersonSignerName() Specifies the full legal name of the signer in person signer template roles.\n\nMaximum Length: 100 characters.
String	getName() Specifies the recipient's name.
String	getRoleName() Optional element.
String	getRoutingOrder() Specifies the routing order of the recipient in the envelope.
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).
Tabs	getTabs()
int	hashCode()
void	setAccessCode(String accessCode)
void	setClientUserId(String clientUserId)
void	setDefaultRecipient(String defaultRecipient)
void	setEmail(String email)
void	setEmailNotification(RecipientEmailNotification emailNotification)
void	setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)
void	setInPersonSignerName(String inPersonSignerName)
void	setName(String name)
void	setRoleName(String roleName)
void	setRoutingOrder(String routingOrder)
void	setSigningGroupId(String signingGroupId)
void	setTabs(Tabs tabs)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TemplateRole

public TemplateRole()

Method Detail

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. \n\nMaximum Length: 50 characters and it must conform to the account’s access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.

setAccessCode

public void setAccessCode(String accessCode)

getClientUserId

public String getClientUserId()

Specifies whether the recipient is embedded or remote. \n\nIf 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. \n\nMaximum length: 100 characters.

setClientUserId

public void setClientUserId(String clientUserId)

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.

setDefaultRecipient

public void setDefaultRecipient(String defaultRecipient)

getEmail

public String getEmail()

Specifies the email associated with a role name.

setEmail

public void setEmail(String email)

getEmailNotification

public RecipientEmailNotification getEmailNotification()

setEmailNotification

public void setEmailNotification(RecipientEmailNotification emailNotification)

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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`

setEmbeddedRecipientStartURL

public void setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)

getInPersonSignerName

public String getInPersonSignerName()

Specifies the full legal name of the signer in person signer template roles.\n\nMaximum Length: 100 characters.

setInPersonSignerName

public void setInPersonSignerName(String inPersonSignerName)

getName

public String getName()

Specifies the recipient's name.

setName

public void setName(String name)

getRoleName

public String getRoleName()

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

setRoleName

public void setRoleName(String roleName)

getRoutingOrder

public String getRoutingOrder()

Specifies the routing order of the recipient in the envelope.

setRoutingOrder

public void setRoutingOrder(String routingOrder)

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

setSigningGroupId

public void setSigningGroupId(String signingGroupId)

getTabs

public Tabs getTabs()

setTabs

public void setTabs(Tabs tabs)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object