BulkRecipient (docusign-esign-java 2.17.0 API)

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

public class BulkRecipient
extends Object

BulkRecipient

Constructor Summary

Constructors
Constructor and Description

BulkRecipient()

Constructors
Constructor and Description
`BulkRecipient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BulkRecipient`	`accessCode(String accessCode)`
`BulkRecipient`	`addErrorDetailsItem(ErrorDetails errorDetailsItem)`
`BulkRecipient`	`addRecipientSignatureProviderInfoItem(BulkRecipientSignatureProvider recipientSignatureProviderInfoItem)`
`BulkRecipient`	`addTabLabelsItem(BulkRecipientTabLabel tabLabelsItem)`
`BulkRecipient`	`email(String email)`
`boolean`	`equals(Object o)`
`BulkRecipient`	`errorDetails(List<ErrorDetails> errorDetails)`
`String`	`getAccessCode()` If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
`String`	`getEmail()` Specifies the recipient's email address.
`List<ErrorDetails>`	`getErrorDetails()` Array or errors.
`String`	`getIdentification()` Specifies the authentication check used for the signer.
`String`	`getName()` Specifies the recipient's name.
`String`	`getNote()` Specifies a note that is unique to this recipient.
`String`	`getPhoneNumber()` This is only used if the Identification field value is Phone or SMS.
`List<BulkRecipientSignatureProvider>`	`getRecipientSignatureProviderInfo()`
`String`	`getRowNumber()`
`List<BulkRecipientTabLabel>`	`getTabLabels()` Specifies values used to populate recipient tabs with information.
`int`	`hashCode()`
`BulkRecipient`	`identification(String identification)`
`BulkRecipient`	`name(String name)`
`BulkRecipient`	`note(String note)`
`BulkRecipient`	`phoneNumber(String phoneNumber)`
`BulkRecipient`	`recipientSignatureProviderInfo(List<BulkRecipientSignatureProvider> recipientSignatureProviderInfo)`
`BulkRecipient`	`rowNumber(String rowNumber)`
`void`	`setAccessCode(String accessCode)`
`void`	`setEmail(String email)`
`void`	`setErrorDetails(List<ErrorDetails> errorDetails)`
`void`	`setIdentification(String identification)`
`void`	`setName(String name)`
`void`	`setNote(String note)`
`void`	`setPhoneNumber(String phoneNumber)`
`void`	`setRecipientSignatureProviderInfo(List<BulkRecipientSignatureProvider> recipientSignatureProviderInfo)`
`void`	`setRowNumber(String rowNumber)`
`void`	`setTabLabels(List<BulkRecipientTabLabel> tabLabels)`
`BulkRecipient`	`tabLabels(List<BulkRecipientTabLabel> tabLabels)`
`String`	`toString()`

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

- Constructor Detail
  - BulkRecipient
```
public BulkRecipient()
```
- Method Detail
  - accessCode
```
public BulkRecipient 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)
```
  - email
```
public BulkRecipient email(String email)
```
  - getEmail
```
public String getEmail()
```
    Specifies the recipient's email address. Maximum length: 100 characters.
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
  - errorDetails
```
public BulkRecipient errorDetails(List<ErrorDetails> errorDetails)
```
  - addErrorDetailsItem
```
public BulkRecipient addErrorDetailsItem(ErrorDetails errorDetailsItem)
```
  - getErrorDetails
```
public List<ErrorDetails> getErrorDetails()
```
    Array or errors.
    
    Returns:
    
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(List<ErrorDetails> errorDetails)
```
  - identification
```
public BulkRecipient identification(String identification)
```
  - getIdentification
```
public String getIdentification()
```
    Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field. The acceptable values are: * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication.
    
    Returns:
    
    identification
  - setIdentification
```
public void setIdentification(String identification)
```
  - name
```
public BulkRecipient name(String name)
```
  - getName
```
public String getName()
```
    Specifies the recipient's name. Maximum length: 50 characters.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - note
```
public BulkRecipient 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)
```
  - phoneNumber
```
public BulkRecipient phoneNumber(String phoneNumber)
```
  - getPhoneNumber
```
public String getPhoneNumber()
```
    This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number. If `usersupplied` is used, the signer supplies his or her own telephone number.
    
    Returns:
    
    phoneNumber
  - setPhoneNumber
```
public void setPhoneNumber(String phoneNumber)
```
  - recipientSignatureProviderInfo
```
public BulkRecipient recipientSignatureProviderInfo(List<BulkRecipientSignatureProvider> recipientSignatureProviderInfo)
```
  - addRecipientSignatureProviderInfoItem
```
public BulkRecipient addRecipientSignatureProviderInfoItem(BulkRecipientSignatureProvider recipientSignatureProviderInfoItem)
```
  - getRecipientSignatureProviderInfo
```
public List<BulkRecipientSignatureProvider> getRecipientSignatureProviderInfo()
```
    Returns:
    
    recipientSignatureProviderInfo
  - setRecipientSignatureProviderInfo
```
public void setRecipientSignatureProviderInfo(List<BulkRecipientSignatureProvider> recipientSignatureProviderInfo)
```
  - rowNumber
```
public BulkRecipient rowNumber(String rowNumber)
```
  - getRowNumber
```
public String getRowNumber()
```
    Returns:
    
    rowNumber
  - setRowNumber
```
public void setRowNumber(String rowNumber)
```
  - tabLabels
```
public BulkRecipient tabLabels(List<BulkRecipientTabLabel> tabLabels)
```
  - addTabLabelsItem
```
public BulkRecipient addTabLabelsItem(BulkRecipientTabLabel tabLabelsItem)
```
  - getTabLabels
```
public List<BulkRecipientTabLabel> getTabLabels()
```
    Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file. The information used in the bulk recipient file header must be the same as the `tabLabel` for the tab. The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row. Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.
    
    Returns:
    
    tabLabels
  - setTabLabels
```
public void setTabLabels(List<BulkRecipientTabLabel> tabLabels)
```
  - 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 BulkRecipient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BulkRecipient

Method Detail

accessCode

getAccessCode

setAccessCode

email

getEmail

setEmail

errorDetails

addErrorDetailsItem

getErrorDetails

setErrorDetails

identification

getIdentification

setIdentification

name

getName

setName

note

getNote

setNote

phoneNumber

getPhoneNumber

setPhoneNumber

recipientSignatureProviderInfo

addRecipientSignatureProviderInfoItem

getRecipientSignatureProviderInfo

setRecipientSignatureProviderInfo

rowNumber

getRowNumber

setRowNumber

tabLabels

addTabLabelsItem

getTabLabels

setTabLabels

equals

hashCode

toString