Inheritance diagram for DocuSign.eSign.Model.BulkRecipient:

Public Member Functions
	BulkRecipient (string AccessCode=default(string), string Email=default(string), List< ErrorDetails > ErrorDetails=default(List< ErrorDetails >), string Identification=default(string), string Name=default(string), string Note=default(string), string PhoneNumber=default(string), List< BulkRecipientSignatureProvider > RecipientSignatureProviderInfo=default(List< BulkRecipientSignatureProvider >), string RowNumber=default(string), List< BulkRecipientTabLabel > TabLabels=default(List< BulkRecipientTabLabel >))
	Initializes a new instance of the BulkRecipient class. More...

override string	ToString ()
	Returns the string presentation of the object More...

string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object obj)
	Returns true if objects are equal More...

bool	Equals (BulkRecipient other)
	Returns true if BulkRecipient instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	AccessCode `[get, set]`
	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. More...

string	Email `[get, set]`
	Specifies the recipient's email address. Maximum length: 100 characters. More...

List< ErrorDetails >	ErrorDetails `[get, set]`
	Array or errors. More...

string	Identification `[get, set]`
	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. More...

string	Name `[get, set]`
	Specifies the recipient's name. Maximum length: 50 characters. More...

string	Note `[get, set]`
	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. More...

string	PhoneNumber `[get, set]`
	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. More...

List< BulkRecipientSignatureProvider >	RecipientSignatureProviderInfo `[get, set]`
	Gets or Sets RecipientSignatureProviderInfo More...

string	RowNumber `[get, set]`
	Gets or Sets RowNumber More...

List< BulkRecipientTabLabel >	TabLabels `[get, set]`
	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. More...

Detailed Description

BulkRecipient

Constructor & Destructor Documentation

◆ BulkRecipient()

DocuSign.eSign.Model.BulkRecipient.BulkRecipient	(	string	AccessCode = `default(string)`,
		string	Email = `default(string)`,
		List< ErrorDetails >	ErrorDetails = `default(List<ErrorDetails>)`,
		string	Identification = `default(string)`,
		string	Name = `default(string)`,
		string	Note = `default(string)`,
		string	PhoneNumber = `default(string)`,
		List< BulkRecipientSignatureProvider >	RecipientSignatureProviderInfo = `default(List<BulkRecipientSignatureProvider>)`,
		string	RowNumber = `default(string)`,
		List< BulkRecipientTabLabel >	TabLabels = `default(List<BulkRecipientTabLabel>)`
	)

inline

Initializes a new instance of the BulkRecipient class.

Parameters

AccessCode	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..
Email	Specifies the recipient's email address. Maximum length: 100 characters..
ErrorDetails	Array or errors..
Identification	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..
Name	Specifies the recipient's name. Maximum length: 50 characters..
Note	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..
PhoneNumber	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..
RecipientSignatureProviderInfo	RecipientSignatureProviderInfo.
RowNumber	RowNumber.
TabLabels	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..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.BulkRecipient.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.BulkRecipient.Equals ( BulkRecipient other )

inline

Returns true if BulkRecipient instances are equal

Parameters

other Instance of BulkRecipient to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.BulkRecipient.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.BulkRecipient.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.BulkRecipient.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccessCode

string DocuSign.eSign.Model.BulkRecipient.AccessCode

getset

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.

◆ Email

string DocuSign.eSign.Model.BulkRecipient.Email

getset

Specifies the recipient's email address. Maximum length: 100 characters.

◆ ErrorDetails

List<ErrorDetails> DocuSign.eSign.Model.BulkRecipient.ErrorDetails

getset

Array or errors.

◆ Identification

string DocuSign.eSign.Model.BulkRecipient.Identification

getset

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.

◆ Name

string DocuSign.eSign.Model.BulkRecipient.Name

getset

Specifies the recipient's name. Maximum length: 50 characters.

◆ Note

string DocuSign.eSign.Model.BulkRecipient.Note

getset

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.

◆ PhoneNumber

string DocuSign.eSign.Model.BulkRecipient.PhoneNumber

getset

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.

◆ RecipientSignatureProviderInfo

List<BulkRecipientSignatureProvider> DocuSign.eSign.Model.BulkRecipient.RecipientSignatureProviderInfo

getset

Gets or Sets RecipientSignatureProviderInfo

◆ RowNumber

string DocuSign.eSign.Model.BulkRecipient.RowNumber

getset

Gets or Sets RowNumber

◆ TabLabels

List<BulkRecipientTabLabel> DocuSign.eSign.Model.BulkRecipient.TabLabels

getset

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.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Model/BulkRecipient.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ BulkRecipient()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccessCode

◆ Email

◆ ErrorDetails

◆ Identification

◆ Name

◆ Note

◆ PhoneNumber

◆ RecipientSignatureProviderInfo

◆ RowNumber

◆ TabLabels