DocuSign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.BulkRecipientsResponse Class Reference

BulkRecipientsResponse More...

Inheritance diagram for DocuSign.eSign.Model.BulkRecipientsResponse:

Public Member Functions

 BulkRecipientsResponse (List< BulkRecipient > BulkRecipients=default(List< BulkRecipient >), string EndPosition=default(string), string NextUri=default(string), string PreviousUri=default(string), string ResultSetSize=default(string), string StartPosition=default(string), string TotalSetSize=default(string))
 Initializes a new instance of the BulkRecipientsResponse 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 (BulkRecipientsResponse other)
 Returns true if BulkRecipientsResponse instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

List< BulkRecipientBulkRecipients [get, set]
 A complex type containing information about the bulk recipients in the response. More...
 
string EndPosition [get, set]
 The last position in the result set. More...
 
string NextUri [get, set]
 The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. More...
 
string PreviousUri [get, set]
 The postal code for the billing address. More...
 
string ResultSetSize [get, set]
 The number of results returned in this response. More...
 
string StartPosition [get, set]
 Starting position of the current result set. More...
 
string TotalSetSize [get, set]
 The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. More...
 

Detailed Description

BulkRecipientsResponse

Constructor & Destructor Documentation

◆ BulkRecipientsResponse()

DocuSign.eSign.Model.BulkRecipientsResponse.BulkRecipientsResponse ( List< BulkRecipient BulkRecipients = default(List<BulkRecipient>),
string  EndPosition = default(string),
string  NextUri = default(string),
string  PreviousUri = default(string),
string  ResultSetSize = default(string),
string  StartPosition = default(string),
string  TotalSetSize = default(string) 
)
inline

Initializes a new instance of the BulkRecipientsResponse class.

Parameters
BulkRecipientsA complex type containing information about the bulk recipients in the response..
EndPositionThe last position in the result set. .
NextUriThe URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. .
PreviousUriThe postal code for the billing address..
ResultSetSizeThe number of results returned in this response. .
StartPositionStarting position of the current result set..
TotalSetSizeThe total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.BulkRecipientsResponse.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.BulkRecipientsResponse.Equals ( BulkRecipientsResponse  other)
inline

Returns true if BulkRecipientsResponse instances are equal

Parameters
otherInstance of BulkRecipientsResponse to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.BulkRecipientsResponse.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.BulkRecipientsResponse.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.BulkRecipientsResponse.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ BulkRecipients

List<BulkRecipient> DocuSign.eSign.Model.BulkRecipientsResponse.BulkRecipients
getset

A complex type containing information about the bulk recipients in the response.

A complex type containing information about the bulk recipients in the response.

◆ EndPosition

string DocuSign.eSign.Model.BulkRecipientsResponse.EndPosition
getset

The last position in the result set.

The last position in the result set.

◆ NextUri

string DocuSign.eSign.Model.BulkRecipientsResponse.NextUri
getset

The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.

The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.

◆ PreviousUri

string DocuSign.eSign.Model.BulkRecipientsResponse.PreviousUri
getset

The postal code for the billing address.

The postal code for the billing address.

◆ ResultSetSize

string DocuSign.eSign.Model.BulkRecipientsResponse.ResultSetSize
getset

The number of results returned in this response.

The number of results returned in this response.

◆ StartPosition

string DocuSign.eSign.Model.BulkRecipientsResponse.StartPosition
getset

Starting position of the current result set.

Starting position of the current result set.

◆ TotalSetSize

string DocuSign.eSign.Model.BulkRecipientsResponse.TotalSetSize
getset

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.


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