BulkSendingCopyRecipient (docusign-esign-java 3.8.0 API)

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

public class BulkSendingCopyRecipient
extends Object

BulkSendingCopyRecipient

Constructor Summary

Constructors
Constructor and Description

BulkSendingCopyRecipient()

Constructors
Constructor and Description
`BulkSendingCopyRecipient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BulkSendingCopyRecipient`	`accessCode(String accessCode)`
`BulkSendingCopyRecipient`	`addCustomFieldsItem(String customFieldsItem)`
`BulkSendingCopyRecipient`	`addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)`
`BulkSendingCopyRecipient`	`addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)`
`BulkSendingCopyRecipient`	`addTabsItem(BulkSendingCopyTab tabsItem)`
`BulkSendingCopyRecipient`	`clientUserId(String clientUserId)`
`BulkSendingCopyRecipient`	`customFields(List<String> customFields)`
`BulkSendingCopyRecipient`	`deliveryMethod(String deliveryMethod)`
`BulkSendingCopyRecipient`	`email(String email)`
`BulkSendingCopyRecipient`	`emailNotification(RecipientEmailNotification emailNotification)`
`BulkSendingCopyRecipient`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)`
`boolean`	`equals(Object o)`
`BulkSendingCopyRecipient`	`faxNumber(String faxNumber)`
`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.
`List<String>`	`getCustomFields()` An optional array of strings that allows the sender to provide custom data about the recipient.
`String`	`getDeliveryMethod()` Reserved: For DocuSign use only.
`String`	`getEmail()`
`RecipientEmailNotification`	`getEmailNotification()` Get emailNotification
`String`	`getEmbeddedRecipientStartURL()` Specifies a sender provided valid URL string for redirecting an embedded recipient.
`String`	`getFaxNumber()` Reserved:
`String`	`getIdCheckConfigurationName()` Specifies authentication check by name.
`IdCheckInformationInput`	`getIdCheckInformationInput()` Get idCheckInformationInput
`String`	`getIdentificationMethod()`
`String`	`getName()`
`String`	`getNote()` Specifies a note that is unique to this recipient.
`RecipientPhoneAuthentication`	`getPhoneAuthentication()` Get phoneAuthentication
`String`	`getRecipientId()` Unique for the recipient.
`List<RecipientSignatureProvider>`	`getRecipientSignatureProviders()`
`String`	`getRoleName()` Optional element.
`RecipientSMSAuthentication`	`getSmsAuthentication()` Get smsAuthentication
`List<SocialAuthentication>`	`getSocialAuthentications()` Lists the social ID type that can be used for recipient authentication.
`List<BulkSendingCopyTab>`	`getTabs()`
`int`	`hashCode()`
`BulkSendingCopyRecipient`	`idCheckConfigurationName(String idCheckConfigurationName)`
`BulkSendingCopyRecipient`	`idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`BulkSendingCopyRecipient`	`identificationMethod(String identificationMethod)`
`BulkSendingCopyRecipient`	`name(String name)`
`BulkSendingCopyRecipient`	`note(String note)`
`BulkSendingCopyRecipient`	`phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`BulkSendingCopyRecipient`	`recipientId(String recipientId)`
`BulkSendingCopyRecipient`	`recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`
`BulkSendingCopyRecipient`	`roleName(String roleName)`
`void`	`setAccessCode(String accessCode)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setCustomFields(List<String> customFields)`
`void`	`setDeliveryMethod(String deliveryMethod)`
`void`	`setEmail(String email)`
`void`	`setEmailNotification(RecipientEmailNotification emailNotification)`
`void`	`setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)`
`void`	`setFaxNumber(String faxNumber)`
`void`	`setIdCheckConfigurationName(String idCheckConfigurationName)`
`void`	`setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`void`	`setIdentificationMethod(String identificationMethod)`
`void`	`setName(String name)`
`void`	`setNote(String note)`
`void`	`setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`
`void`	`setRoleName(String roleName)`
`void`	`setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`void`	`setSocialAuthentications(List<SocialAuthentication> socialAuthentications)`
`void`	`setTabs(List<BulkSendingCopyTab> tabs)`
`BulkSendingCopyRecipient`	`smsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`BulkSendingCopyRecipient`	`socialAuthentications(List<SocialAuthentication> socialAuthentications)`
`BulkSendingCopyRecipient`	`tabs(List<BulkSendingCopyTab> tabs)`
`String`	`toString()`

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

- Constructor Detail
  - BulkSendingCopyRecipient
```
public BulkSendingCopyRecipient()
```
- Method Detail
  - accessCode
```
public BulkSendingCopyRecipient accessCode(String accessCode)
```
  - 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)
```
  - clientUserId
```
public BulkSendingCopyRecipient clientUserId(String clientUserId)
```
  - 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)
```
  - customFields
```
public BulkSendingCopyRecipient customFields(List<String> customFields)
```
  - addCustomFieldsItem
```
public BulkSendingCopyRecipient addCustomFieldsItem(String customFieldsItem)
```
  - getCustomFields
```
public List<String> getCustomFields()
```
    An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
    
    Returns:
    
    customFields
  - setCustomFields
```
public void setCustomFields(List<String> customFields)
```
  - deliveryMethod
```
public BulkSendingCopyRecipient deliveryMethod(String deliveryMethod)
```
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Reserved: For DocuSign use only.
    
    Returns:
    
    deliveryMethod
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
  - email
```
public BulkSendingCopyRecipient email(String email)
```
  - getEmail
```
public String getEmail()
```
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
  - emailNotification
```
public BulkSendingCopyRecipient emailNotification(RecipientEmailNotification emailNotification)
```
  - getEmailNotification
```
public RecipientEmailNotification getEmailNotification()
```
    Get emailNotification
    
    Returns:
    
    emailNotification
  - setEmailNotification
```
public void setEmailNotification(RecipientEmailNotification emailNotification)
```
  - embeddedRecipientStartURL
```
public BulkSendingCopyRecipient embeddedRecipientStartURL(String embeddedRecipientStartURL)
```
  - 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)
```
  - faxNumber
```
public BulkSendingCopyRecipient faxNumber(String faxNumber)
```
  - getFaxNumber
```
public String getFaxNumber()
```
    Reserved:
    
    Returns:
    
    faxNumber
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
  - idCheckConfigurationName
```
public BulkSendingCopyRecipient idCheckConfigurationName(String idCheckConfigurationName)
```
  - getIdCheckConfigurationName
```
public String getIdCheckConfigurationName()
```
    Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
    
    Returns:
    
    idCheckConfigurationName
  - setIdCheckConfigurationName
```
public void setIdCheckConfigurationName(String idCheckConfigurationName)
```
  - idCheckInformationInput
```
public BulkSendingCopyRecipient idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
  - getIdCheckInformationInput
```
public IdCheckInformationInput getIdCheckInformationInput()
```
    Get idCheckInformationInput
    
    Returns:
    
    idCheckInformationInput
  - setIdCheckInformationInput
```
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
  - identificationMethod
```
public BulkSendingCopyRecipient identificationMethod(String identificationMethod)
```
  - getIdentificationMethod
```
public String getIdentificationMethod()
```
    Returns:
    
    identificationMethod
  - setIdentificationMethod
```
public void setIdentificationMethod(String identificationMethod)
```
  - name
```
public BulkSendingCopyRecipient name(String name)
```
  - getName
```
public String getName()
```
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - note
```
public BulkSendingCopyRecipient note(String note)
```
  - getNote
```
public String getNote()
```
    Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
    
    Returns:
    
    note
  - setNote
```
public void setNote(String note)
```
  - phoneAuthentication
```
public BulkSendingCopyRecipient phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
  - getPhoneAuthentication
```
public RecipientPhoneAuthentication getPhoneAuthentication()
```
    Get phoneAuthentication
    
    Returns:
    
    phoneAuthentication
  - setPhoneAuthentication
```
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
  - recipientId
```
public BulkSendingCopyRecipient recipientId(String recipientId)
```
  - getRecipientId
```
public 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(String recipientId)
```
  - recipientSignatureProviders
```
public BulkSendingCopyRecipient recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
  - addRecipientSignatureProvidersItem
```
public BulkSendingCopyRecipient addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
```
  - getRecipientSignatureProviders
```
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
```
    Returns:
    
    recipientSignatureProviders
  - setRecipientSignatureProviders
```
public void setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
  - roleName
```
public BulkSendingCopyRecipient roleName(String roleName)
```
  - 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)
```
  - smsAuthentication
```
public BulkSendingCopyRecipient smsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
  - getSmsAuthentication
```
public RecipientSMSAuthentication getSmsAuthentication()
```
    Get smsAuthentication
    
    Returns:
    
    smsAuthentication
  - setSmsAuthentication
```
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
  - socialAuthentications
```
public BulkSendingCopyRecipient socialAuthentications(List<SocialAuthentication> socialAuthentications)
```
  - addSocialAuthenticationsItem
```
public BulkSendingCopyRecipient addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
```
  - getSocialAuthentications
```
public List<SocialAuthentication> getSocialAuthentications()
```
    Lists the social ID type that can be used for recipient authentication.
    
    Returns:
    
    socialAuthentications
  - setSocialAuthentications
```
public void setSocialAuthentications(List<SocialAuthentication> socialAuthentications)
```
  - tabs
```
public BulkSendingCopyRecipient tabs(List<BulkSendingCopyTab> tabs)
```
  - addTabsItem
```
public BulkSendingCopyRecipient addTabsItem(BulkSendingCopyTab tabsItem)
```
  - getTabs
```
public List<BulkSendingCopyTab> getTabs()
```
    Returns:
    
    tabs
  - setTabs
```
public void setTabs(List<BulkSendingCopyTab> 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

Class BulkSendingCopyRecipient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BulkSendingCopyRecipient

Method Detail

accessCode

getAccessCode

setAccessCode

clientUserId

getClientUserId

setClientUserId

customFields

addCustomFieldsItem

getCustomFields

setCustomFields

deliveryMethod

getDeliveryMethod

setDeliveryMethod

email

getEmail

setEmail

emailNotification

getEmailNotification

setEmailNotification

embeddedRecipientStartURL

getEmbeddedRecipientStartURL

setEmbeddedRecipientStartURL

faxNumber

getFaxNumber

setFaxNumber

idCheckConfigurationName

getIdCheckConfigurationName

setIdCheckConfigurationName

idCheckInformationInput

getIdCheckInformationInput

setIdCheckInformationInput

identificationMethod

getIdentificationMethod

setIdentificationMethod

name

getName

setName

note

getNote

setNote

phoneAuthentication

getPhoneAuthentication

setPhoneAuthentication

recipientId

getRecipientId

setRecipientId

recipientSignatureProviders

addRecipientSignatureProvidersItem

getRecipientSignatureProviders

setRecipientSignatureProviders

roleName

getRoleName

setRoleName

smsAuthentication

getSmsAuthentication

setSmsAuthentication

socialAuthentications

addSocialAuthenticationsItem

getSocialAuthentications

setSocialAuthentications

tabs

addTabsItem

getTabs

setTabs

equals

hashCode

toString