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

Lists of envelope and transaction IDs to use in the results. If you use this request body with Envelopes: listStatus, you must set one or both of the following query parameters to the special value `request_body`: - `envelope_ids=request_body` - `transaction_ids=request_body` More...

Inheritance diagram for DocuSign.eSign.Model.EnvelopeIdsRequest:

Public Member Functions

 EnvelopeIdsRequest (List< string > EnvelopeIds=default(List< string >), List< string > TransactionIds=default(List< string >))
 Initializes a new instance of the EnvelopeIdsRequest 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 (EnvelopeIdsRequest other)
 Returns true if EnvelopeIdsRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

List< string > EnvelopeIds [get, set]
 Gets or Sets EnvelopeIds More...
 
List< string > TransactionIds [get, set]
 A list of transaction Id&#39;s used to determining the status of envelopes sent asynchronously. See transactionId property on envelopes. More...
 

Detailed Description

Lists of envelope and transaction IDs to use in the results. If you use this request body with Envelopes: listStatus, you must set one or both of the following query parameters to the special value &#x60;request_body&#x60;: - &#x60;envelope_ids&#x3D;request_body&#x60; - &#x60;transaction_ids&#x3D;request_body&#x60;

Constructor & Destructor Documentation

◆ EnvelopeIdsRequest()

DocuSign.eSign.Model.EnvelopeIdsRequest.EnvelopeIdsRequest ( List< string >  EnvelopeIds = default(List<string>),
List< string >  TransactionIds = default(List<string>) 
)
inline

Initializes a new instance of the EnvelopeIdsRequest class.

Parameters
EnvelopeIdsEnvelopeIds.
TransactionIdsA list of transaction Id&#39;s used to determining the status of envelopes sent asynchronously. See transactionId property on envelopes..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if EnvelopeIdsRequest instances are equal

Parameters
otherInstance of EnvelopeIdsRequest to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ EnvelopeIds

List<string> DocuSign.eSign.Model.EnvelopeIdsRequest.EnvelopeIds
getset

Gets or Sets EnvelopeIds

◆ TransactionIds

List<string> DocuSign.eSign.Model.EnvelopeIdsRequest.TransactionIds
getset

A list of transaction Id&#39;s used to determining the status of envelopes sent asynchronously. See transactionId property on envelopes.

A list of transaction Id&#39;s used to determining the status of envelopes sent asynchronously. See transactionId property on envelopes.


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