com.docusign.esign.model

Class BulkRecipient

java.lang.Object

com.docusign.esign.model.BulkRecipient

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

Constructor Summary

Constructors

Constructor and Description
BulkRecipient()

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	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()
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)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkRecipient

public BulkRecipient()

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)

getEmail

public String getEmail()

Specifies the recipient's email address. \n\nMaximum length: 100 characters.

setEmail

public void setEmail(String email)

getErrorDetails

public List<ErrorDetails> getErrorDetails()

Array or errors.

setErrorDetails

public void setErrorDetails(List<ErrorDetails> errorDetails)

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.\n\nThe acceptable values are:\n\n* KBA: Enables the normal ID check authentication set up for your account.\n* Phone: Enables phone authentication.\n* SMS: Enables SMS authentication.

setIdentification

public void setIdentification(String identification)

getName

public String getName()

Specifies the recipient's name. \n\nMaximum length: 50 characters.

setName

public void setName(String name)

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.\n\nMaximum Length: 1000 characters.

setNote

public void setNote(String note)

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.\n\nIf `usersupplied` is used, the signer supplies his or her own telephone number.

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

getRecipientSignatureProviderInfo

public List<BulkRecipientSignatureProvider> getRecipientSignatureProviderInfo()

setRecipientSignatureProviderInfo

public void setRecipientSignatureProviderInfo(List<BulkRecipientSignatureProvider> recipientSignatureProviderInfo)

getRowNumber

public String getRowNumber()

setRowNumber

public void setRowNumber(String rowNumber)

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.\n\nThe information used in the bulk recipient file header must be the same as the `tabLabel` for the tab.\n\nThe values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row.\n\nNote 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.

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