java.lang.Object
- com.docusign.esign.model.TemplateRole

All Implemented Interfaces:

Serializable
```
public class TemplateRole
extends Object
implements Serializable
```
Information about a specific role..

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

TemplateRole()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TemplateRole`	`accessCode(String accessCode)`	accessCode.
`TemplateRole`	`addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)`	addAdditionalNotificationsItem.
`TemplateRole`	`additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)`	additionalNotifications.
`TemplateRole`	`addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)`	addRecipientSignatureProvidersItem.
`TemplateRole`	`clientUserId(String clientUserId)`	clientUserId.
`TemplateRole`	`defaultRecipient(String defaultRecipient)`	defaultRecipient.
`TemplateRole`	`deliveryMethod(String deliveryMethod)`	deliveryMethod.
`TemplateRole`	`email(String email)`	email.
`TemplateRole`	`emailNotification(RecipientEmailNotification emailNotification)`	emailNotification.
`TemplateRole`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)`	embeddedRecipientStartURL.
`boolean`	`equals(Object o)`	Compares objects.
`String`	`getAccessCode()`	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
`List<RecipientAdditionalNotification>`	`getAdditionalNotifications()`	.
`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`	`getDeliveryMethod()`	Reserved: For DocuSign use only..
`String`	`getEmail()`	Specifies the email associated with a role name..
`RecipientEmailNotification`	`getEmailNotification()`	A complex type that contains information sets the language of the recipient's email information.
`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.
`String`	`getName()`	Specifies the recipient's name..
`RecipientPhoneNumber`	`getPhoneNumber()`	Describes the recipient phone number..
`List<RecipientSignatureProvider>`	`getRecipientSignatureProviders()`	.
`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()`	A list of tabs, which are represented graphically as symbols on documents at the time of signing.
`int`	`hashCode()`	Returns the HashCode.
`TemplateRole`	`inPersonSignerName(String inPersonSignerName)`	inPersonSignerName.
`TemplateRole`	`name(String name)`	name.
`TemplateRole`	`phoneNumber(RecipientPhoneNumber phoneNumber)`	phoneNumber.
`TemplateRole`	`recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`	recipientSignatureProviders.
`TemplateRole`	`roleName(String roleName)`	roleName.
`TemplateRole`	`routingOrder(String routingOrder)`	routingOrder.
`void`	`setAccessCode(String accessCode)`	setAccessCode.
`void`	`setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)`	setAdditionalNotifications.
`void`	`setClientUserId(String clientUserId)`	setClientUserId.
`void`	`setDefaultRecipient(String defaultRecipient)`	setDefaultRecipient.
`void`	`setDeliveryMethod(String deliveryMethod)`	setDeliveryMethod.
`void`	`setEmail(String email)`	setEmail.
`void`	`setEmailNotification(RecipientEmailNotification emailNotification)`	setEmailNotification.
`void`	`setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)`	setEmbeddedRecipientStartURL.
`void`	`setInPersonSignerName(String inPersonSignerName)`	setInPersonSignerName.
`void`	`setName(String name)`	setName.
`void`	`setPhoneNumber(RecipientPhoneNumber phoneNumber)`	setPhoneNumber.
`void`	`setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`	setRecipientSignatureProviders.
`void`	`setRoleName(String roleName)`	setRoleName.
`void`	`setRoutingOrder(String routingOrder)`	setRoutingOrder.
`void`	`setSigningGroupId(String signingGroupId)`	setSigningGroupId.
`void`	`setTabs(Tabs tabs)`	setTabs.
`TemplateRole`	`signingGroupId(String signingGroupId)`	signingGroupId.
`TemplateRole`	`tabs(Tabs tabs)`	tabs.
`String`	`toString()`	Converts the given object to string.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 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.
  - additionalNotifications
```
public TemplateRole additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
```
    additionalNotifications.
    
    Returns:
    
    TemplateRole
  - addAdditionalNotificationsItem
```
public TemplateRole addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)
```
    addAdditionalNotificationsItem.
    
    Returns:
    
    TemplateRole
  - getAdditionalNotifications
```
public List<RecipientAdditionalNotification> getAdditionalNotifications()
```
    .
    
    Returns:
    
    additionalNotifications
  - setAdditionalNotifications
```
public void setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
```
    setAdditionalNotifications.
  - 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.
  - deliveryMethod
```
public TemplateRole deliveryMethod(String deliveryMethod)
```
    deliveryMethod.
    
    Returns:
    
    TemplateRole
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveryMethod
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
    setDeliveryMethod.
  - email
```
public TemplateRole email(String email)
```
    email.
    
    Returns:
    
    TemplateRole
  - getEmail
```
public String getEmail()
```
    Specifies the email associated with a role name..
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
    setEmail.
  - emailNotification
```
public TemplateRole emailNotification(RecipientEmailNotification emailNotification)
```
    emailNotification.
    
    Returns:
    
    TemplateRole
  - getEmailNotification
```
public RecipientEmailNotification getEmailNotification()
```
    A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. .
    
    Returns:
    
    emailNotification
  - setEmailNotification
```
public void setEmailNotification(RecipientEmailNotification emailNotification)
```
    setEmailNotification.
  - 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.
  - name
```
public TemplateRole name(String name)
```
    name.
    
    Returns:
    
    TemplateRole
  - getName
```
public String getName()
```
    Specifies the recipient's name..
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    setName.
  - phoneNumber
```
public TemplateRole phoneNumber(RecipientPhoneNumber phoneNumber)
```
    phoneNumber.
    
    Returns:
    
    TemplateRole
  - getPhoneNumber
```
public RecipientPhoneNumber getPhoneNumber()
```
    Describes the recipient phone number..
    
    Returns:
    
    phoneNumber
  - setPhoneNumber
```
public void setPhoneNumber(RecipientPhoneNumber phoneNumber)
```
    setPhoneNumber.
  - recipientSignatureProviders
```
public TemplateRole recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
    recipientSignatureProviders.
    
    Returns:
    
    TemplateRole
  - addRecipientSignatureProvidersItem
```
public TemplateRole addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
```
    addRecipientSignatureProvidersItem.
    
    Returns:
    
    TemplateRole
  - getRecipientSignatureProviders
```
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
```
    .
    
    Returns:
    
    recipientSignatureProviders
  - 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.
  - tabs
```
public TemplateRole tabs(Tabs tabs)
```
    tabs.
    
    Returns:
    
    TemplateRole
  - 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

Class TemplateRole

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateRole

Method Detail

accessCode

getAccessCode

setAccessCode

additionalNotifications

addAdditionalNotificationsItem

getAdditionalNotifications

setAdditionalNotifications

clientUserId

getClientUserId

setClientUserId

defaultRecipient

getDefaultRecipient

setDefaultRecipient

deliveryMethod

getDeliveryMethod

setDeliveryMethod

email

getEmail

setEmail

emailNotification

getEmailNotification

setEmailNotification

embeddedRecipientStartURL

getEmbeddedRecipientStartURL

setEmbeddedRecipientStartURL

inPersonSignerName

getInPersonSignerName

setInPersonSignerName

name

getName

setName

phoneNumber

getPhoneNumber

setPhoneNumber

recipientSignatureProviders

addRecipientSignatureProvidersItem

getRecipientSignatureProviders

setRecipientSignatureProviders

roleName

getRoleName

setRoleName

routingOrder

getRoutingOrder

setRoutingOrder

signingGroupId

getSigningGroupId

setSigningGroupId

tabs

getTabs

setTabs

equals

hashCode

toString